blob: 7fdee7c54f1cd79880e6243f999011cf71f25e13 [file] [log] [blame]
Willy Tarreau59f98392012-07-06 14:13:49 +02001/*
2 * include/proto/connection.h
3 * This file contains connection function prototypes
4 *
5 * Copyright (C) 2000-2012 Willy Tarreau - w@1wt.eu
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22#ifndef _PROTO_CONNECTION_H
23#define _PROTO_CONNECTION_H
24
25#include <common/config.h>
Willy Tarreauf2943dc2012-10-26 20:10:28 +020026#include <common/memory.h>
Willy Tarreau59f98392012-07-06 14:13:49 +020027#include <types/connection.h>
Willy Tarreaud1d54542012-09-12 22:58:11 +020028#include <types/listener.h>
Willy Tarreau2b199c92012-11-23 17:32:21 +010029#include <proto/fd.h>
Willy Tarreau3fdb3662012-11-12 00:42:33 +010030#include <proto/obj_type.h>
Willy Tarreau59f98392012-07-06 14:13:49 +020031
Willy Tarreauf2943dc2012-10-26 20:10:28 +020032extern struct pool_head *pool2_connection;
Willy Tarreau13e14102016-12-22 20:25:26 +010033extern struct xprt_ops *registered_xprt[XPRT_ENTRIES];
Willy Tarreauf2943dc2012-10-26 20:10:28 +020034
35/* perform minimal intializations, report 0 in case of error, 1 if OK. */
36int init_connection();
37
Willy Tarreau59f98392012-07-06 14:13:49 +020038/* I/O callback for fd-based connections. It calls the read/write handlers
Willy Tarreau7a798e52016-04-14 11:13:20 +020039 * provided by the connection's sock_ops.
Willy Tarreau59f98392012-07-06 14:13:49 +020040 */
Willy Tarreau7a798e52016-04-14 11:13:20 +020041void conn_fd_handler(int fd);
Willy Tarreau59f98392012-07-06 14:13:49 +020042
Willy Tarreau22cda212012-08-31 17:43:29 +020043/* receive a PROXY protocol header over a connection */
44int conn_recv_proxy(struct connection *conn, int flag);
David Safb76832014-05-08 23:42:08 -040045int make_proxy_line(char *buf, int buf_len, struct server *srv, struct connection *remote);
46int make_proxy_line_v1(char *buf, int buf_len, struct sockaddr_storage *src, struct sockaddr_storage *dst);
47int make_proxy_line_v2(char *buf, int buf_len, struct server *srv, struct connection *remote);
Willy Tarreau22cda212012-08-31 17:43:29 +020048
Bertrand Jacquin93b227d2016-06-04 15:11:10 +010049/* receive a NetScaler Client IP insertion header over a connection */
50int conn_recv_netscaler_cip(struct connection *conn, int flag);
51
Willy Tarreauff3e6482015-03-12 23:56:52 +010052/* raw send() directly on the socket */
53int conn_sock_send(struct connection *conn, const void *buf, int len, int flags);
54
Willy Tarreaud85c4852015-03-13 00:40:28 +010055/* drains any pending bytes from the socket */
56int conn_sock_drain(struct connection *conn);
57
Willy Tarreaud02cdd22013-12-15 10:23:20 +010058/* returns true is the transport layer is ready */
Willy Tarreauaad69382014-01-23 14:21:42 +010059static inline int conn_xprt_ready(const struct connection *conn)
Willy Tarreaud02cdd22013-12-15 10:23:20 +010060{
Willy Tarreauaad69382014-01-23 14:21:42 +010061 return (conn->flags & CO_FL_XPRT_READY);
Willy Tarreaud02cdd22013-12-15 10:23:20 +010062}
63
64/* returns true is the control layer is ready */
Willy Tarreau3c728722014-01-23 13:50:42 +010065static inline int conn_ctrl_ready(const struct connection *conn)
Willy Tarreaud02cdd22013-12-15 10:23:20 +010066{
67 return (conn->flags & CO_FL_CTRL_READY);
68}
69
Willy Tarreauf79c8172013-10-21 16:30:56 +020070/* Calls the init() function of the transport layer if any and if not done yet,
71 * and sets the CO_FL_XPRT_READY flag to indicate it was properly initialized.
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020072 * Returns <0 in case of error.
Willy Tarreau15678ef2012-08-31 13:54:11 +020073 */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020074static inline int conn_xprt_init(struct connection *conn)
Willy Tarreau15678ef2012-08-31 13:54:11 +020075{
Willy Tarreauf79c8172013-10-21 16:30:56 +020076 int ret = 0;
77
Willy Tarreauaad69382014-01-23 14:21:42 +010078 if (!conn_xprt_ready(conn) && conn->xprt && conn->xprt->init)
Willy Tarreauf79c8172013-10-21 16:30:56 +020079 ret = conn->xprt->init(conn);
80
81 if (ret >= 0)
82 conn->flags |= CO_FL_XPRT_READY;
83
84 return ret;
Willy Tarreau15678ef2012-08-31 13:54:11 +020085}
86
Willy Tarreauf79c8172013-10-21 16:30:56 +020087/* Calls the close() function of the transport layer if any and if not done
88 * yet, and clears the CO_FL_XPRT_READY flag. However this is not done if the
89 * CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the
90 * transport layer very late if needed.
Willy Tarreau6c03a642012-10-12 17:00:05 +020091 */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020092static inline void conn_xprt_close(struct connection *conn)
Willy Tarreau8b117082012-08-06 15:06:49 +020093{
Willy Tarreauf79c8172013-10-21 16:30:56 +020094 if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_XPRT_TRACKED)) == CO_FL_XPRT_READY) {
Willy Tarreauaad69382014-01-23 14:21:42 +010095 if (conn->xprt->close)
Willy Tarreau6c03a642012-10-12 17:00:05 +020096 conn->xprt->close(conn);
Willy Tarreauf79c8172013-10-21 16:30:56 +020097 conn->flags &= ~CO_FL_XPRT_READY;
98 }
99}
100
101/* Initializes the connection's control layer which essentially consists in
102 * registering the file descriptor for polling and setting the CO_FL_CTRL_READY
Willy Tarreau3c728722014-01-23 13:50:42 +0100103 * flag. The caller is responsible for ensuring that the control layer is
104 * already assigned to the connection prior to the call.
Willy Tarreauf79c8172013-10-21 16:30:56 +0200105 */
106static inline void conn_ctrl_init(struct connection *conn)
107{
Willy Tarreau3c728722014-01-23 13:50:42 +0100108 if (!conn_ctrl_ready(conn)) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200109 int fd = conn->handle.fd;
Willy Tarreauf79c8172013-10-21 16:30:56 +0200110
Christopher Faulet576c5aa2017-09-05 09:51:57 +0200111 fdtab[fd].owner = conn;
112 fdtab[fd].iocb = conn_fd_handler;
Willy Tarreauf79c8172013-10-21 16:30:56 +0200113 fd_insert(fd);
Willy Tarreauf817e9f2014-01-10 16:58:45 +0100114 /* mark the fd as ready so as not to needlessly poll at the beginning */
115 fd_may_recv(fd);
116 fd_may_send(fd);
Willy Tarreauf79c8172013-10-21 16:30:56 +0200117 conn->flags |= CO_FL_CTRL_READY;
Willy Tarreau6c03a642012-10-12 17:00:05 +0200118 }
Willy Tarreau8b117082012-08-06 15:06:49 +0200119}
120
Willy Tarreauf79c8172013-10-21 16:30:56 +0200121/* Deletes the FD if the transport layer is already gone. Once done,
122 * it then removes the CO_FL_CTRL_READY flag.
123 */
124static inline void conn_ctrl_close(struct connection *conn)
125{
126 if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_CTRL_READY)) == CO_FL_CTRL_READY) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200127 fd_delete(conn->handle.fd);
Willy Tarreau6a0a80a2017-10-05 17:43:39 +0200128 conn->handle.fd = DEAD_FD_MAGIC;
Willy Tarreauf79c8172013-10-21 16:30:56 +0200129 conn->flags &= ~CO_FL_CTRL_READY;
130 }
131}
132
Willy Tarreau2b199c92012-11-23 17:32:21 +0100133/* If the connection still has a transport layer, then call its close() function
134 * if any, and delete the file descriptor if a control layer is set. This is
135 * used to close everything at once and atomically. However this is not done if
136 * the CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the
137 * transport layer very late if needed.
138 */
139static inline void conn_full_close(struct connection *conn)
140{
Willy Tarreauf79c8172013-10-21 16:30:56 +0200141 conn_xprt_close(conn);
142 conn_ctrl_close(conn);
143}
144
Willy Tarreaudc42acd2017-10-05 18:09:20 +0200145/* stop tracking a connection, allowing conn_full_close() to always
146 * succeed.
147 */
148static inline void conn_stop_tracking(struct connection *conn)
149{
150 conn->flags &= ~CO_FL_XPRT_TRACKED;
151}
152
Willy Tarreauf79c8172013-10-21 16:30:56 +0200153/* Force to close the connection whatever the tracking state. This is mainly
Willy Tarreau9471b8c2013-12-15 13:31:35 +0100154 * used on the error path where the tracking does not make sense, or to kill
155 * an idle connection we want to abort immediately.
Willy Tarreauf79c8172013-10-21 16:30:56 +0200156 */
157static inline void conn_force_close(struct connection *conn)
158{
Willy Tarreauaad69382014-01-23 14:21:42 +0100159 if (conn_xprt_ready(conn) && conn->xprt->close)
Willy Tarreauf79c8172013-10-21 16:30:56 +0200160 conn->xprt->close(conn);
161
Willy Tarreau3c728722014-01-23 13:50:42 +0100162 if (conn_ctrl_ready(conn))
Willy Tarreau585744b2017-08-24 14:31:19 +0200163 fd_delete(conn->handle.fd);
Willy Tarreauf79c8172013-10-21 16:30:56 +0200164
Willy Tarreau585744b2017-08-24 14:31:19 +0200165 conn->handle.fd = DEAD_FD_MAGIC;
Willy Tarreauf79c8172013-10-21 16:30:56 +0200166 conn->flags &= ~(CO_FL_XPRT_READY|CO_FL_CTRL_READY);
Willy Tarreau2b199c92012-11-23 17:32:21 +0100167}
168
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200169/* Update polling on connection <c>'s file descriptor depending on its current
170 * state as reported in the connection's CO_FL_CURR_* flags, reports of EAGAIN
171 * in CO_FL_WAIT_*, and the sock layer expectations indicated by CO_FL_SOCK_*.
172 * The connection flags are updated with the new flags at the end of the
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200173 * operation. Polling is totally disabled if an error was reported.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200174 */
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200175void conn_update_sock_polling(struct connection *c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200176
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200177/* Update polling on connection <c>'s file descriptor depending on its current
178 * state as reported in the connection's CO_FL_CURR_* flags, reports of EAGAIN
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200179 * in CO_FL_WAIT_*, and the upper layer expectations indicated by CO_FL_XPRT_*.
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200180 * The connection flags are updated with the new flags at the end of the
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200181 * operation. Polling is totally disabled if an error was reported.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200182 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200183void conn_update_xprt_polling(struct connection *c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200184
Willy Tarreau7d281492012-12-16 19:19:13 +0100185/* Refresh the connection's polling flags from its file descriptor status.
186 * This should be called at the beginning of a connection handler.
187 */
188static inline void conn_refresh_polling_flags(struct connection *conn)
189{
Willy Tarreau2686dca2017-04-26 16:25:12 +0200190 conn->flags &= ~CO_FL_WAIT_ROOM;
Willy Tarreau7d281492012-12-16 19:19:13 +0100191
Willy Tarreau3c728722014-01-23 13:50:42 +0100192 if (conn_ctrl_ready(conn)) {
Willy Tarreau7d281492012-12-16 19:19:13 +0100193 unsigned int flags = conn->flags & ~(CO_FL_CURR_RD_ENA | CO_FL_CURR_WR_ENA);
194
Willy Tarreau585744b2017-08-24 14:31:19 +0200195 if (fd_recv_active(conn->handle.fd))
Willy Tarreau7d281492012-12-16 19:19:13 +0100196 flags |= CO_FL_CURR_RD_ENA;
Willy Tarreau585744b2017-08-24 14:31:19 +0200197 if (fd_send_active(conn->handle.fd))
Willy Tarreau7d281492012-12-16 19:19:13 +0100198 flags |= CO_FL_CURR_WR_ENA;
199 conn->flags = flags;
200 }
201}
202
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200203/* inspects c->flags and returns non-zero if XPRT ENA changes from the CURR ENA
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100204 * or if the WAIT flags are set with their respective ENA flags. Additionally,
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200205 * non-zero is also returned if an error was reported on the connection. This
206 * function is used quite often and is inlined. In order to proceed optimally
207 * with very little code and CPU cycles, the bits are arranged so that a change
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100208 * can be detected by a few left shifts, a xor, and a mask. These operations
209 * detect when W&D are both enabled for either direction, when C&D differ for
210 * either direction and when Error is set. The trick consists in first keeping
211 * only the bits we're interested in, since they don't collide when shifted,
212 * and to perform the AND at the end. In practice, the compiler is able to
213 * replace the last AND with a TEST in boolean conditions. This results in
214 * checks that are done in 4-6 cycles and less than 30 bytes.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200215 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200216static inline unsigned int conn_xprt_polling_changes(const struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200217{
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100218 unsigned int f = c->flags;
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200219 f &= CO_FL_XPRT_WR_ENA | CO_FL_XPRT_RD_ENA | CO_FL_CURR_WR_ENA |
Willy Tarreau310987a2014-01-22 19:46:33 +0100220 CO_FL_CURR_RD_ENA | CO_FL_ERROR;
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100221
Willy Tarreau310987a2014-01-22 19:46:33 +0100222 f = (f ^ (f << 1)) & (CO_FL_CURR_WR_ENA|CO_FL_CURR_RD_ENA); /* test C ^ D */
223 return f & (CO_FL_CURR_WR_ENA | CO_FL_CURR_RD_ENA | CO_FL_ERROR);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200224}
225
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200226/* inspects c->flags and returns non-zero if SOCK ENA changes from the CURR ENA
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100227 * or if the WAIT flags are set with their respective ENA flags. Additionally,
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200228 * non-zero is also returned if an error was reported on the connection. This
229 * function is used quite often and is inlined. In order to proceed optimally
230 * with very little code and CPU cycles, the bits are arranged so that a change
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100231 * can be detected by a few left shifts, a xor, and a mask. These operations
232 * detect when W&S are both enabled for either direction, when C&S differ for
233 * either direction and when Error is set. The trick consists in first keeping
234 * only the bits we're interested in, since they don't collide when shifted,
235 * and to perform the AND at the end. In practice, the compiler is able to
236 * replace the last AND with a TEST in boolean conditions. This results in
237 * checks that are done in 4-6 cycles and less than 30 bytes.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200238 */
239static inline unsigned int conn_sock_polling_changes(const struct connection *c)
240{
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100241 unsigned int f = c->flags;
242 f &= CO_FL_SOCK_WR_ENA | CO_FL_SOCK_RD_ENA | CO_FL_CURR_WR_ENA |
Willy Tarreau310987a2014-01-22 19:46:33 +0100243 CO_FL_CURR_RD_ENA | CO_FL_ERROR;
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100244
Willy Tarreau310987a2014-01-22 19:46:33 +0100245 f = (f ^ (f << 2)) & (CO_FL_CURR_WR_ENA|CO_FL_CURR_RD_ENA); /* test C ^ S */
246 return f & (CO_FL_CURR_WR_ENA | CO_FL_CURR_RD_ENA | CO_FL_ERROR);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200247}
248
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200249/* Automatically updates polling on connection <c> depending on the XPRT flags
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200250 * if no handshake is in progress.
251 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200252static inline void conn_cond_update_xprt_polling(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200253{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200254 if (!(c->flags & CO_FL_POLL_SOCK) && conn_xprt_polling_changes(c))
255 conn_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200256}
257
258/* Automatically updates polling on connection <c> depending on the SOCK flags
259 * if a handshake is in progress.
260 */
261static inline void conn_cond_update_sock_polling(struct connection *c)
262{
263 if ((c->flags & CO_FL_POLL_SOCK) && conn_sock_polling_changes(c))
264 conn_update_sock_polling(c);
265}
266
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100267/* Stop all polling on the fd. This might be used when an error is encountered
268 * for example.
269 */
270static inline void conn_stop_polling(struct connection *c)
271{
272 c->flags &= ~(CO_FL_CURR_RD_ENA | CO_FL_CURR_WR_ENA |
273 CO_FL_SOCK_RD_ENA | CO_FL_SOCK_WR_ENA |
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200274 CO_FL_XPRT_RD_ENA | CO_FL_XPRT_WR_ENA);
Willy Tarreau350135c2016-11-17 12:05:13 +0100275 if (conn_ctrl_ready(c))
Willy Tarreau585744b2017-08-24 14:31:19 +0200276 fd_stop_both(c->handle.fd);
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100277}
278
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200279/* Automatically update polling on connection <c> depending on the XPRT and
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200280 * SOCK flags, and on whether a handshake is in progress or not. This may be
281 * called at any moment when there is a doubt about the effectiveness of the
282 * polling state, for instance when entering or leaving the handshake state.
283 */
284static inline void conn_cond_update_polling(struct connection *c)
285{
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100286 if (unlikely(c->flags & CO_FL_ERROR))
287 conn_stop_polling(c);
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200288 else if (!(c->flags & CO_FL_POLL_SOCK) && conn_xprt_polling_changes(c))
289 conn_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200290 else if ((c->flags & CO_FL_POLL_SOCK) && conn_sock_polling_changes(c))
291 conn_update_sock_polling(c);
292}
293
294/***** Event manipulation primitives for use by DATA I/O callbacks *****/
295/* The __conn_* versions do not propagate to lower layers and are only meant
296 * to be used by handlers called by the connection handler. The other ones
297 * may be used anywhere.
298 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200299static inline void __conn_xprt_want_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200300{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200301 c->flags |= CO_FL_XPRT_RD_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200302}
303
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200304static inline void __conn_xprt_stop_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200305{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200306 c->flags &= ~CO_FL_XPRT_RD_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200307}
308
Willy Tarreau796c5b72016-11-29 21:47:02 +0100309/* this one is used only to stop speculative recv(). It doesn't stop it if the
310 * fd is already polled in order to avoid expensive polling status changes.
311 * Since it might require the upper layer to re-enable reading, we'll return 1
312 * if we've really stopped something otherwise zero.
313 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200314static inline int __conn_xprt_done_recv(struct connection *c)
Willy Tarreau796c5b72016-11-29 21:47:02 +0100315{
Willy Tarreau585744b2017-08-24 14:31:19 +0200316 if (!conn_ctrl_ready(c) || !fd_recv_polled(c->handle.fd)) {
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200317 c->flags &= ~CO_FL_XPRT_RD_ENA;
Willy Tarreau796c5b72016-11-29 21:47:02 +0100318 return 1;
319 }
320 return 0;
321}
322
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200323static inline void __conn_xprt_want_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200324{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200325 c->flags |= CO_FL_XPRT_WR_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200326}
327
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200328static inline void __conn_xprt_stop_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200329{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200330 c->flags &= ~CO_FL_XPRT_WR_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200331}
332
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200333static inline void __conn_xprt_stop_both(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200334{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200335 c->flags &= ~(CO_FL_XPRT_WR_ENA | CO_FL_XPRT_RD_ENA);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200336}
337
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200338static inline void conn_xprt_want_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200339{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200340 __conn_xprt_want_recv(c);
341 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200342}
343
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200344static inline void conn_xprt_stop_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200345{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200346 __conn_xprt_stop_recv(c);
347 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200348}
349
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200350static inline void conn_xprt_want_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200351{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200352 __conn_xprt_want_send(c);
353 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200354}
355
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200356static inline void conn_xprt_stop_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200357{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200358 __conn_xprt_stop_send(c);
359 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200360}
361
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200362static inline void conn_xprt_stop_both(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200363{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200364 __conn_xprt_stop_both(c);
365 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200366}
367
368/***** Event manipulation primitives for use by handshake I/O callbacks *****/
369/* The __conn_* versions do not propagate to lower layers and are only meant
370 * to be used by handlers called by the connection handler. The other ones
371 * may be used anywhere.
372 */
373static inline void __conn_sock_want_recv(struct connection *c)
374{
375 c->flags |= CO_FL_SOCK_RD_ENA;
376}
377
378static inline void __conn_sock_stop_recv(struct connection *c)
379{
380 c->flags &= ~CO_FL_SOCK_RD_ENA;
381}
382
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200383static inline void __conn_sock_want_send(struct connection *c)
384{
385 c->flags |= CO_FL_SOCK_WR_ENA;
386}
387
388static inline void __conn_sock_stop_send(struct connection *c)
389{
390 c->flags &= ~CO_FL_SOCK_WR_ENA;
391}
392
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200393static inline void __conn_sock_stop_both(struct connection *c)
394{
395 c->flags &= ~(CO_FL_SOCK_WR_ENA | CO_FL_SOCK_RD_ENA);
396}
397
398static inline void conn_sock_want_recv(struct connection *c)
399{
400 __conn_sock_want_recv(c);
401 conn_cond_update_sock_polling(c);
402}
403
404static inline void conn_sock_stop_recv(struct connection *c)
405{
406 __conn_sock_stop_recv(c);
407 conn_cond_update_sock_polling(c);
408}
409
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200410static inline void conn_sock_want_send(struct connection *c)
411{
412 __conn_sock_want_send(c);
413 conn_cond_update_sock_polling(c);
414}
415
416static inline void conn_sock_stop_send(struct connection *c)
417{
418 __conn_sock_stop_send(c);
419 conn_cond_update_sock_polling(c);
420}
421
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200422static inline void conn_sock_stop_both(struct connection *c)
423{
424 __conn_sock_stop_both(c);
425 conn_cond_update_sock_polling(c);
426}
Willy Tarreau8b117082012-08-06 15:06:49 +0200427
Willy Tarreau3af56a92012-08-20 16:55:48 +0200428/* shutdown management */
429static inline void conn_sock_read0(struct connection *c)
430{
431 c->flags |= CO_FL_SOCK_RD_SH;
432 __conn_sock_stop_recv(c);
Willy Tarreauad38ace2013-12-15 14:19:38 +0100433 /* we don't risk keeping ports unusable if we found the
434 * zero from the other side.
435 */
Willy Tarreau3c728722014-01-23 13:50:42 +0100436 if (conn_ctrl_ready(c))
Willy Tarreau585744b2017-08-24 14:31:19 +0200437 fdtab[c->handle.fd].linger_risk = 0;
Willy Tarreau3af56a92012-08-20 16:55:48 +0200438}
439
Willy Tarreau3af56a92012-08-20 16:55:48 +0200440static inline void conn_sock_shutw(struct connection *c)
441{
442 c->flags |= CO_FL_SOCK_WR_SH;
443 __conn_sock_stop_send(c);
Willy Tarreauf9ce57e2017-10-05 17:24:42 +0200444 /* don't perform a clean shutdown if we're going to reset */
445 if (conn_ctrl_ready(c) && !fdtab[c->handle.fd].linger_risk)
Willy Tarreau585744b2017-08-24 14:31:19 +0200446 shutdown(c->handle.fd, SHUT_WR);
Willy Tarreau3af56a92012-08-20 16:55:48 +0200447}
448
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200449static inline void conn_xprt_shutw(struct connection *c)
Willy Tarreau3af56a92012-08-20 16:55:48 +0200450{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200451 __conn_xprt_stop_send(c);
Willy Tarreau729c69f2015-03-12 22:51:10 +0100452
453 /* clean data-layer shutdown */
454 if (c->xprt && c->xprt->shutw)
455 c->xprt->shutw(c, 1);
456}
457
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200458static inline void conn_xprt_shutw_hard(struct connection *c)
Willy Tarreau729c69f2015-03-12 22:51:10 +0100459{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200460 __conn_xprt_stop_send(c);
Willy Tarreau729c69f2015-03-12 22:51:10 +0100461
462 /* unclean data-layer shutdown */
463 if (c->xprt && c->xprt->shutw)
464 c->xprt->shutw(c, 0);
Willy Tarreau3af56a92012-08-20 16:55:48 +0200465}
466
467/* detect sock->data read0 transition */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200468static inline int conn_xprt_read0_pending(struct connection *c)
Willy Tarreau3af56a92012-08-20 16:55:48 +0200469{
Willy Tarreau54e917c2017-08-30 07:35:35 +0200470 return (c->flags & CO_FL_SOCK_RD_SH) != 0;
Willy Tarreau3af56a92012-08-20 16:55:48 +0200471}
472
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200473/* prepares a connection to work with protocol <proto> and transport <xprt>.
474 * The transport's context is initialized as well.
475 */
476static inline void conn_prepare(struct connection *conn, const struct protocol *proto, const struct xprt_ops *xprt)
477{
478 conn->ctrl = proto;
479 conn->xprt = xprt;
480 conn->xprt_st = 0;
481 conn->xprt_ctx = NULL;
482}
483
Willy Tarreaud0155772013-10-14 17:10:08 +0200484/* Initializes all required fields for a new connection. Note that it does the
485 * minimum acceptable initialization for a connection that already exists and
486 * is about to be reused. It also leaves the addresses untouched, which makes
487 * it usable across connection retries to reset a connection to a known state.
488 */
489static inline void conn_init(struct connection *conn)
490{
491 conn->obj_type = OBJ_TYPE_CONN;
492 conn->flags = CO_FL_NONE;
Willy Tarreaud0155772013-10-14 17:10:08 +0200493 conn->data = NULL;
494 conn->owner = NULL;
Willy Tarreaub8020ce2013-10-24 21:10:08 +0200495 conn->send_proxy_ofs = 0;
Willy Tarreau585744b2017-08-24 14:31:19 +0200496 conn->handle.fd = DEAD_FD_MAGIC;
Willy Tarreaud0155772013-10-14 17:10:08 +0200497 conn->err_code = CO_ER_NONE;
498 conn->target = NULL;
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200499 conn->xprt_done_cb = NULL;
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100500 conn->proxy_netns = NULL;
Willy Tarreaud75d40e2015-08-04 17:25:58 +0200501 LIST_INIT(&conn->list);
Willy Tarreaud0155772013-10-14 17:10:08 +0200502}
503
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200504/* sets <owner> as the connection's owner */
505static inline void conn_set_owner(struct connection *conn, void *owner)
506{
507 conn->owner = owner;
508}
509
510/* registers <cb> as a callback to notify for transport's readiness or failure */
511static inline void conn_set_xprt_done_cb(struct connection *conn, int (*cb)(struct connection *))
512{
513 conn->xprt_done_cb = cb;
514}
515
516/* unregisters the callback to notify for transport's readiness or failure */
517static inline void conn_clear_xprt_done_cb(struct connection *conn)
518{
519 conn->xprt_done_cb = NULL;
520}
521
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200522/* Tries to allocate a new connection and initialized its main fields. The
523 * connection is returned on success, NULL on failure. The connection must
524 * be released using pool_free2() or conn_free().
525 */
526static inline struct connection *conn_new()
527{
528 struct connection *conn;
529
530 conn = pool_alloc2(pool2_connection);
531 if (likely(conn != NULL))
532 conn_init(conn);
533 return conn;
534}
535
536/* Releases a connection previously allocated by conn_new() */
537static inline void conn_free(struct connection *conn)
538{
539 pool_free2(pool2_connection, conn);
540}
541
542
Willy Tarreau986a9d22012-08-30 21:11:38 +0200543/* Retrieves the connection's source address */
544static inline void conn_get_from_addr(struct connection *conn)
545{
546 if (conn->flags & CO_FL_ADDR_FROM_SET)
547 return;
548
Willy Tarreau3c728722014-01-23 13:50:42 +0100549 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_src)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200550 return;
551
Willy Tarreau585744b2017-08-24 14:31:19 +0200552 if (conn->ctrl->get_src(conn->handle.fd, (struct sockaddr *)&conn->addr.from,
Willy Tarreau3fdb3662012-11-12 00:42:33 +0100553 sizeof(conn->addr.from),
554 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200555 return;
556 conn->flags |= CO_FL_ADDR_FROM_SET;
557}
558
559/* Retrieves the connection's original destination address */
560static inline void conn_get_to_addr(struct connection *conn)
561{
562 if (conn->flags & CO_FL_ADDR_TO_SET)
563 return;
564
Willy Tarreau3c728722014-01-23 13:50:42 +0100565 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_dst)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200566 return;
567
Willy Tarreau585744b2017-08-24 14:31:19 +0200568 if (conn->ctrl->get_dst(conn->handle.fd, (struct sockaddr *)&conn->addr.to,
Willy Tarreau3fdb3662012-11-12 00:42:33 +0100569 sizeof(conn->addr.to),
570 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200571 return;
572 conn->flags |= CO_FL_ADDR_TO_SET;
573}
574
Willy Tarreau7abddb52013-10-24 15:31:04 +0200575/* Attaches a connection to an owner and assigns a data layer */
576static inline void conn_attach(struct connection *conn, void *owner, const struct data_cb *data)
Willy Tarreaudda5e7c2012-09-24 17:15:42 +0200577{
Willy Tarreau74beec32012-10-03 00:41:04 +0200578 conn->data = data;
Willy Tarreaucd379952012-09-27 22:14:33 +0200579 conn->owner = owner;
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200580}
581
Willy Tarreau0af29122012-12-03 15:35:00 +0100582/* returns a human-readable error code for conn->err_code, or NULL if the code
583 * is unknown.
584 */
585static inline const char *conn_err_code_str(struct connection *c)
586{
587 switch (c->err_code) {
588 case CO_ER_NONE: return "Success";
Willy Tarreau45b34e82014-01-24 16:06:50 +0100589
590 case CO_ER_CONF_FDLIM: return "Reached configured maxconn value";
591 case CO_ER_PROC_FDLIM: return "Too many sockets on the process";
592 case CO_ER_SYS_FDLIM: return "Too many sockets on the system";
593 case CO_ER_SYS_MEMLIM: return "Out of system buffers";
594 case CO_ER_NOPROTO: return "Protocol or address family not supported";
595 case CO_ER_SOCK_ERR: return "General socket error";
596 case CO_ER_PORT_RANGE: return "Source port range exhausted";
597 case CO_ER_CANT_BIND: return "Can't bind to source address";
598 case CO_ER_FREE_PORTS: return "Out of local source ports on the system";
599 case CO_ER_ADDR_INUSE: return "Local source address already in use";
600
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100601 case CO_ER_PRX_EMPTY: return "Connection closed while waiting for PROXY protocol header";
602 case CO_ER_PRX_ABORT: return "Connection error while waiting for PROXY protocol header";
Willy Tarreau0af29122012-12-03 15:35:00 +0100603 case CO_ER_PRX_TIMEOUT: return "Timeout while waiting for PROXY protocol header";
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100604 case CO_ER_PRX_TRUNCATED: return "Truncated PROXY protocol header received";
605 case CO_ER_PRX_NOT_HDR: return "Received something which does not look like a PROXY protocol header";
606 case CO_ER_PRX_BAD_HDR: return "Received an invalid PROXY protocol header";
607 case CO_ER_PRX_BAD_PROTO: return "Received an unhandled protocol in the PROXY protocol header";
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100608
609 case CO_ER_CIP_EMPTY: return "Connection closed while waiting for NetScaler Client IP header";
610 case CO_ER_CIP_ABORT: return "Connection error while waiting for NetScaler Client IP header";
611 case CO_ER_CIP_TRUNCATED: return "Truncated NetScaler Client IP header received";
612 case CO_ER_CIP_BAD_MAGIC: return "Received an invalid NetScaler Client IP magic number";
613 case CO_ER_CIP_BAD_PROTO: return "Received an unhandled protocol in the NetScaler Client IP header";
614
Willy Tarreau20879a02012-12-03 16:32:10 +0100615 case CO_ER_SSL_EMPTY: return "Connection closed during SSL handshake";
616 case CO_ER_SSL_ABORT: return "Connection error during SSL handshake";
Willy Tarreau0af29122012-12-03 15:35:00 +0100617 case CO_ER_SSL_TIMEOUT: return "Timeout during SSL handshake";
Willy Tarreau20879a02012-12-03 16:32:10 +0100618 case CO_ER_SSL_TOO_MANY: return "Too many SSL connections";
619 case CO_ER_SSL_NO_MEM: return "Out of memory when initializing an SSL connection";
620 case CO_ER_SSL_RENEG: return "Rejected a client-initiated SSL renegociation attempt";
621 case CO_ER_SSL_CA_FAIL: return "SSL client CA chain cannot be verified";
622 case CO_ER_SSL_CRT_FAIL: return "SSL client certificate not trusted";
Willy Tarreau71d058c2017-07-26 20:09:56 +0200623 case CO_ER_SSL_MISMATCH: return "Server presented an SSL certificate different from the configured one";
624 case CO_ER_SSL_MISMATCH_SNI: return "Server presented an SSL certificate different from the expected one";
Willy Tarreau20879a02012-12-03 16:32:10 +0100625 case CO_ER_SSL_HANDSHAKE: return "SSL handshake failure";
Willy Tarreaub3966372014-04-25 18:54:29 +0200626 case CO_ER_SSL_HANDSHAKE_HB: return "SSL handshake failure after heartbeat";
Willy Tarreauf51c6982014-04-25 20:02:39 +0200627 case CO_ER_SSL_KILLED_HB: return "Stopped a TLSv1 heartbeat attack (CVE-2014-0160)";
Willy Tarreau830bf612013-12-01 20:29:58 +0100628 case CO_ER_SSL_NO_TARGET: return "Attempt to use SSL on an unknown target (internal error)";
Willy Tarreau0af29122012-12-03 15:35:00 +0100629 }
630 return NULL;
631}
632
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100633static inline const char *conn_get_ctrl_name(const struct connection *conn)
634{
635 if (!conn_ctrl_ready(conn))
636 return "NONE";
637 return conn->ctrl->name;
638}
639
640static inline const char *conn_get_xprt_name(const struct connection *conn)
641{
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100642 if (!conn_xprt_ready(conn))
643 return "NONE";
Willy Tarreau8e0bb0a2016-11-24 16:58:12 +0100644 return conn->xprt->name;
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100645}
646
647static inline const char *conn_get_data_name(const struct connection *conn)
648{
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100649 if (!conn->data)
650 return "NONE";
Willy Tarreau8e0bb0a2016-11-24 16:58:12 +0100651 return conn->data->name;
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100652}
653
Willy Tarreau13e14102016-12-22 20:25:26 +0100654/* registers pointer to transport layer <id> (XPRT_*) */
655static inline void xprt_register(int id, struct xprt_ops *xprt)
656{
657 if (id >= XPRT_ENTRIES)
658 return;
659 registered_xprt[id] = xprt;
660}
661
662/* returns pointer to transport layer <id> (XPRT_*) or NULL if not registered */
663static inline struct xprt_ops *xprt_get(int id)
664{
665 if (id >= XPRT_ENTRIES)
666 return NULL;
667 return registered_xprt[id];
668}
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100669
Willy Tarreaua9c17412016-12-04 18:42:09 +0100670static inline int conn_get_alpn(const struct connection *conn, const char **str, int *len)
671{
672 if (!conn_xprt_ready(conn) || !conn->xprt->get_alpn)
673 return 0;
674 return conn->xprt->get_alpn(conn, str, len);
675}
676
Willy Tarreau59f98392012-07-06 14:13:49 +0200677#endif /* _PROTO_CONNECTION_H */
678
679/*
680 * Local variables:
681 * c-indent-level: 8
682 * c-basic-offset: 8
683 * End:
684 */