blob: defdefe9618d0472d99915a77bbb4f97bf7fd2a4 [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 Tarreauf79c8172013-10-21 16:30:56 +0200128 conn->flags &= ~CO_FL_CTRL_READY;
129 }
130}
131
Willy Tarreau2b199c92012-11-23 17:32:21 +0100132/* If the connection still has a transport layer, then call its close() function
133 * if any, and delete the file descriptor if a control layer is set. This is
134 * used to close everything at once and atomically. However this is not done if
135 * the CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the
136 * transport layer very late if needed.
137 */
138static inline void conn_full_close(struct connection *conn)
139{
Willy Tarreauf79c8172013-10-21 16:30:56 +0200140 conn_xprt_close(conn);
141 conn_ctrl_close(conn);
142}
143
144/* Force to close the connection whatever the tracking state. This is mainly
Willy Tarreau9471b8c2013-12-15 13:31:35 +0100145 * used on the error path where the tracking does not make sense, or to kill
146 * an idle connection we want to abort immediately.
Willy Tarreauf79c8172013-10-21 16:30:56 +0200147 */
148static inline void conn_force_close(struct connection *conn)
149{
Willy Tarreauaad69382014-01-23 14:21:42 +0100150 if (conn_xprt_ready(conn) && conn->xprt->close)
Willy Tarreauf79c8172013-10-21 16:30:56 +0200151 conn->xprt->close(conn);
152
Willy Tarreau3c728722014-01-23 13:50:42 +0100153 if (conn_ctrl_ready(conn))
Willy Tarreau585744b2017-08-24 14:31:19 +0200154 fd_delete(conn->handle.fd);
Willy Tarreauf79c8172013-10-21 16:30:56 +0200155
Willy Tarreau585744b2017-08-24 14:31:19 +0200156 conn->handle.fd = DEAD_FD_MAGIC;
Willy Tarreauf79c8172013-10-21 16:30:56 +0200157 conn->flags &= ~(CO_FL_XPRT_READY|CO_FL_CTRL_READY);
Willy Tarreau2b199c92012-11-23 17:32:21 +0100158}
159
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200160/* Update polling on connection <c>'s file descriptor depending on its current
161 * state as reported in the connection's CO_FL_CURR_* flags, reports of EAGAIN
162 * in CO_FL_WAIT_*, and the sock layer expectations indicated by CO_FL_SOCK_*.
163 * The connection flags are updated with the new flags at the end of the
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200164 * operation. Polling is totally disabled if an error was reported.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200165 */
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200166void conn_update_sock_polling(struct connection *c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200167
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200168/* Update polling on connection <c>'s file descriptor depending on its current
169 * state as reported in the connection's CO_FL_CURR_* flags, reports of EAGAIN
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200170 * in CO_FL_WAIT_*, and the upper layer expectations indicated by CO_FL_XPRT_*.
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200171 * The connection flags are updated with the new flags at the end of the
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200172 * operation. Polling is totally disabled if an error was reported.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200173 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200174void conn_update_xprt_polling(struct connection *c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200175
Willy Tarreau7d281492012-12-16 19:19:13 +0100176/* Refresh the connection's polling flags from its file descriptor status.
177 * This should be called at the beginning of a connection handler.
178 */
179static inline void conn_refresh_polling_flags(struct connection *conn)
180{
Willy Tarreau2686dca2017-04-26 16:25:12 +0200181 conn->flags &= ~CO_FL_WAIT_ROOM;
Willy Tarreau7d281492012-12-16 19:19:13 +0100182
Willy Tarreau3c728722014-01-23 13:50:42 +0100183 if (conn_ctrl_ready(conn)) {
Willy Tarreau7d281492012-12-16 19:19:13 +0100184 unsigned int flags = conn->flags & ~(CO_FL_CURR_RD_ENA | CO_FL_CURR_WR_ENA);
185
Willy Tarreau585744b2017-08-24 14:31:19 +0200186 if (fd_recv_active(conn->handle.fd))
Willy Tarreau7d281492012-12-16 19:19:13 +0100187 flags |= CO_FL_CURR_RD_ENA;
Willy Tarreau585744b2017-08-24 14:31:19 +0200188 if (fd_send_active(conn->handle.fd))
Willy Tarreau7d281492012-12-16 19:19:13 +0100189 flags |= CO_FL_CURR_WR_ENA;
190 conn->flags = flags;
191 }
192}
193
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200194/* inspects c->flags and returns non-zero if XPRT ENA changes from the CURR ENA
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100195 * or if the WAIT flags are set with their respective ENA flags. Additionally,
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200196 * non-zero is also returned if an error was reported on the connection. This
197 * function is used quite often and is inlined. In order to proceed optimally
198 * with very little code and CPU cycles, the bits are arranged so that a change
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100199 * can be detected by a few left shifts, a xor, and a mask. These operations
200 * detect when W&D are both enabled for either direction, when C&D differ for
201 * either direction and when Error is set. The trick consists in first keeping
202 * only the bits we're interested in, since they don't collide when shifted,
203 * and to perform the AND at the end. In practice, the compiler is able to
204 * replace the last AND with a TEST in boolean conditions. This results in
205 * checks that are done in 4-6 cycles and less than 30 bytes.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200206 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200207static inline unsigned int conn_xprt_polling_changes(const struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200208{
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100209 unsigned int f = c->flags;
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200210 f &= CO_FL_XPRT_WR_ENA | CO_FL_XPRT_RD_ENA | CO_FL_CURR_WR_ENA |
Willy Tarreau310987a2014-01-22 19:46:33 +0100211 CO_FL_CURR_RD_ENA | CO_FL_ERROR;
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100212
Willy Tarreau310987a2014-01-22 19:46:33 +0100213 f = (f ^ (f << 1)) & (CO_FL_CURR_WR_ENA|CO_FL_CURR_RD_ENA); /* test C ^ D */
214 return f & (CO_FL_CURR_WR_ENA | CO_FL_CURR_RD_ENA | CO_FL_ERROR);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200215}
216
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200217/* inspects c->flags and returns non-zero if SOCK ENA changes from the CURR ENA
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100218 * or if the WAIT flags are set with their respective ENA flags. Additionally,
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200219 * non-zero is also returned if an error was reported on the connection. This
220 * function is used quite often and is inlined. In order to proceed optimally
221 * with very little code and CPU cycles, the bits are arranged so that a change
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100222 * can be detected by a few left shifts, a xor, and a mask. These operations
223 * detect when W&S are both enabled for either direction, when C&S differ for
224 * either direction and when Error is set. The trick consists in first keeping
225 * only the bits we're interested in, since they don't collide when shifted,
226 * and to perform the AND at the end. In practice, the compiler is able to
227 * replace the last AND with a TEST in boolean conditions. This results in
228 * checks that are done in 4-6 cycles and less than 30 bytes.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200229 */
230static inline unsigned int conn_sock_polling_changes(const struct connection *c)
231{
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100232 unsigned int f = c->flags;
233 f &= CO_FL_SOCK_WR_ENA | CO_FL_SOCK_RD_ENA | CO_FL_CURR_WR_ENA |
Willy Tarreau310987a2014-01-22 19:46:33 +0100234 CO_FL_CURR_RD_ENA | CO_FL_ERROR;
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100235
Willy Tarreau310987a2014-01-22 19:46:33 +0100236 f = (f ^ (f << 2)) & (CO_FL_CURR_WR_ENA|CO_FL_CURR_RD_ENA); /* test C ^ S */
237 return f & (CO_FL_CURR_WR_ENA | CO_FL_CURR_RD_ENA | CO_FL_ERROR);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200238}
239
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200240/* Automatically updates polling on connection <c> depending on the XPRT flags
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200241 * if no handshake is in progress.
242 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200243static inline void conn_cond_update_xprt_polling(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200244{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200245 if (!(c->flags & CO_FL_POLL_SOCK) && conn_xprt_polling_changes(c))
246 conn_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200247}
248
249/* Automatically updates polling on connection <c> depending on the SOCK flags
250 * if a handshake is in progress.
251 */
252static inline void conn_cond_update_sock_polling(struct connection *c)
253{
254 if ((c->flags & CO_FL_POLL_SOCK) && conn_sock_polling_changes(c))
255 conn_update_sock_polling(c);
256}
257
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100258/* Stop all polling on the fd. This might be used when an error is encountered
259 * for example.
260 */
261static inline void conn_stop_polling(struct connection *c)
262{
263 c->flags &= ~(CO_FL_CURR_RD_ENA | CO_FL_CURR_WR_ENA |
264 CO_FL_SOCK_RD_ENA | CO_FL_SOCK_WR_ENA |
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200265 CO_FL_XPRT_RD_ENA | CO_FL_XPRT_WR_ENA);
Willy Tarreau350135c2016-11-17 12:05:13 +0100266 if (conn_ctrl_ready(c))
Willy Tarreau585744b2017-08-24 14:31:19 +0200267 fd_stop_both(c->handle.fd);
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100268}
269
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200270/* Automatically update polling on connection <c> depending on the XPRT and
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200271 * SOCK flags, and on whether a handshake is in progress or not. This may be
272 * called at any moment when there is a doubt about the effectiveness of the
273 * polling state, for instance when entering or leaving the handshake state.
274 */
275static inline void conn_cond_update_polling(struct connection *c)
276{
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100277 if (unlikely(c->flags & CO_FL_ERROR))
278 conn_stop_polling(c);
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200279 else if (!(c->flags & CO_FL_POLL_SOCK) && conn_xprt_polling_changes(c))
280 conn_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200281 else if ((c->flags & CO_FL_POLL_SOCK) && conn_sock_polling_changes(c))
282 conn_update_sock_polling(c);
283}
284
285/***** Event manipulation primitives for use by DATA I/O callbacks *****/
286/* The __conn_* versions do not propagate to lower layers and are only meant
287 * to be used by handlers called by the connection handler. The other ones
288 * may be used anywhere.
289 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200290static inline void __conn_xprt_want_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200291{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200292 c->flags |= CO_FL_XPRT_RD_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200293}
294
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200295static inline void __conn_xprt_stop_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200296{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200297 c->flags &= ~CO_FL_XPRT_RD_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200298}
299
Willy Tarreau796c5b72016-11-29 21:47:02 +0100300/* this one is used only to stop speculative recv(). It doesn't stop it if the
301 * fd is already polled in order to avoid expensive polling status changes.
302 * Since it might require the upper layer to re-enable reading, we'll return 1
303 * if we've really stopped something otherwise zero.
304 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200305static inline int __conn_xprt_done_recv(struct connection *c)
Willy Tarreau796c5b72016-11-29 21:47:02 +0100306{
Willy Tarreau585744b2017-08-24 14:31:19 +0200307 if (!conn_ctrl_ready(c) || !fd_recv_polled(c->handle.fd)) {
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200308 c->flags &= ~CO_FL_XPRT_RD_ENA;
Willy Tarreau796c5b72016-11-29 21:47:02 +0100309 return 1;
310 }
311 return 0;
312}
313
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200314static inline void __conn_xprt_want_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200315{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200316 c->flags |= CO_FL_XPRT_WR_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200317}
318
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200319static inline void __conn_xprt_stop_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200320{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200321 c->flags &= ~CO_FL_XPRT_WR_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200322}
323
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200324static inline void __conn_xprt_stop_both(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200325{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200326 c->flags &= ~(CO_FL_XPRT_WR_ENA | CO_FL_XPRT_RD_ENA);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200327}
328
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200329static inline void conn_xprt_want_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200330{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200331 __conn_xprt_want_recv(c);
332 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200333}
334
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200335static inline void conn_xprt_stop_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200336{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200337 __conn_xprt_stop_recv(c);
338 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200339}
340
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200341static inline void conn_xprt_want_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200342{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200343 __conn_xprt_want_send(c);
344 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200345}
346
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200347static inline void conn_xprt_stop_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200348{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200349 __conn_xprt_stop_send(c);
350 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200351}
352
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200353static inline void conn_xprt_stop_both(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200354{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200355 __conn_xprt_stop_both(c);
356 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200357}
358
359/***** Event manipulation primitives for use by handshake I/O callbacks *****/
360/* The __conn_* versions do not propagate to lower layers and are only meant
361 * to be used by handlers called by the connection handler. The other ones
362 * may be used anywhere.
363 */
364static inline void __conn_sock_want_recv(struct connection *c)
365{
366 c->flags |= CO_FL_SOCK_RD_ENA;
367}
368
369static inline void __conn_sock_stop_recv(struct connection *c)
370{
371 c->flags &= ~CO_FL_SOCK_RD_ENA;
372}
373
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200374static inline void __conn_sock_want_send(struct connection *c)
375{
376 c->flags |= CO_FL_SOCK_WR_ENA;
377}
378
379static inline void __conn_sock_stop_send(struct connection *c)
380{
381 c->flags &= ~CO_FL_SOCK_WR_ENA;
382}
383
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200384static inline void __conn_sock_stop_both(struct connection *c)
385{
386 c->flags &= ~(CO_FL_SOCK_WR_ENA | CO_FL_SOCK_RD_ENA);
387}
388
389static inline void conn_sock_want_recv(struct connection *c)
390{
391 __conn_sock_want_recv(c);
392 conn_cond_update_sock_polling(c);
393}
394
395static inline void conn_sock_stop_recv(struct connection *c)
396{
397 __conn_sock_stop_recv(c);
398 conn_cond_update_sock_polling(c);
399}
400
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200401static inline void conn_sock_want_send(struct connection *c)
402{
403 __conn_sock_want_send(c);
404 conn_cond_update_sock_polling(c);
405}
406
407static inline void conn_sock_stop_send(struct connection *c)
408{
409 __conn_sock_stop_send(c);
410 conn_cond_update_sock_polling(c);
411}
412
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200413static inline void conn_sock_stop_both(struct connection *c)
414{
415 __conn_sock_stop_both(c);
416 conn_cond_update_sock_polling(c);
417}
Willy Tarreau8b117082012-08-06 15:06:49 +0200418
Willy Tarreau3af56a92012-08-20 16:55:48 +0200419/* shutdown management */
420static inline void conn_sock_read0(struct connection *c)
421{
422 c->flags |= CO_FL_SOCK_RD_SH;
423 __conn_sock_stop_recv(c);
Willy Tarreauad38ace2013-12-15 14:19:38 +0100424 /* we don't risk keeping ports unusable if we found the
425 * zero from the other side.
426 */
Willy Tarreau3c728722014-01-23 13:50:42 +0100427 if (conn_ctrl_ready(c))
Willy Tarreau585744b2017-08-24 14:31:19 +0200428 fdtab[c->handle.fd].linger_risk = 0;
Willy Tarreau3af56a92012-08-20 16:55:48 +0200429}
430
Willy Tarreau3af56a92012-08-20 16:55:48 +0200431static inline void conn_sock_shutw(struct connection *c)
432{
433 c->flags |= CO_FL_SOCK_WR_SH;
434 __conn_sock_stop_send(c);
Willy Tarreauf9ce57e2017-10-05 17:24:42 +0200435 /* don't perform a clean shutdown if we're going to reset */
436 if (conn_ctrl_ready(c) && !fdtab[c->handle.fd].linger_risk)
Willy Tarreau585744b2017-08-24 14:31:19 +0200437 shutdown(c->handle.fd, SHUT_WR);
Willy Tarreau3af56a92012-08-20 16:55:48 +0200438}
439
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200440static inline void conn_xprt_shutw(struct connection *c)
Willy Tarreau3af56a92012-08-20 16:55:48 +0200441{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200442 __conn_xprt_stop_send(c);
Willy Tarreau729c69f2015-03-12 22:51:10 +0100443
444 /* clean data-layer shutdown */
445 if (c->xprt && c->xprt->shutw)
446 c->xprt->shutw(c, 1);
447}
448
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200449static inline void conn_xprt_shutw_hard(struct connection *c)
Willy Tarreau729c69f2015-03-12 22:51:10 +0100450{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200451 __conn_xprt_stop_send(c);
Willy Tarreau729c69f2015-03-12 22:51:10 +0100452
453 /* unclean data-layer shutdown */
454 if (c->xprt && c->xprt->shutw)
455 c->xprt->shutw(c, 0);
Willy Tarreau3af56a92012-08-20 16:55:48 +0200456}
457
458/* detect sock->data read0 transition */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200459static inline int conn_xprt_read0_pending(struct connection *c)
Willy Tarreau3af56a92012-08-20 16:55:48 +0200460{
Willy Tarreau54e917c2017-08-30 07:35:35 +0200461 return (c->flags & CO_FL_SOCK_RD_SH) != 0;
Willy Tarreau3af56a92012-08-20 16:55:48 +0200462}
463
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200464/* prepares a connection to work with protocol <proto> and transport <xprt>.
465 * The transport's context is initialized as well.
466 */
467static inline void conn_prepare(struct connection *conn, const struct protocol *proto, const struct xprt_ops *xprt)
468{
469 conn->ctrl = proto;
470 conn->xprt = xprt;
471 conn->xprt_st = 0;
472 conn->xprt_ctx = NULL;
473}
474
Willy Tarreaud0155772013-10-14 17:10:08 +0200475/* Initializes all required fields for a new connection. Note that it does the
476 * minimum acceptable initialization for a connection that already exists and
477 * is about to be reused. It also leaves the addresses untouched, which makes
478 * it usable across connection retries to reset a connection to a known state.
479 */
480static inline void conn_init(struct connection *conn)
481{
482 conn->obj_type = OBJ_TYPE_CONN;
483 conn->flags = CO_FL_NONE;
Willy Tarreaud0155772013-10-14 17:10:08 +0200484 conn->data = NULL;
485 conn->owner = NULL;
Willy Tarreaub8020ce2013-10-24 21:10:08 +0200486 conn->send_proxy_ofs = 0;
Willy Tarreau585744b2017-08-24 14:31:19 +0200487 conn->handle.fd = DEAD_FD_MAGIC;
Willy Tarreaud0155772013-10-14 17:10:08 +0200488 conn->err_code = CO_ER_NONE;
489 conn->target = NULL;
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200490 conn->xprt_done_cb = NULL;
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100491 conn->proxy_netns = NULL;
Willy Tarreaud75d40e2015-08-04 17:25:58 +0200492 LIST_INIT(&conn->list);
Willy Tarreaud0155772013-10-14 17:10:08 +0200493}
494
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200495/* sets <owner> as the connection's owner */
496static inline void conn_set_owner(struct connection *conn, void *owner)
497{
498 conn->owner = owner;
499}
500
501/* registers <cb> as a callback to notify for transport's readiness or failure */
502static inline void conn_set_xprt_done_cb(struct connection *conn, int (*cb)(struct connection *))
503{
504 conn->xprt_done_cb = cb;
505}
506
507/* unregisters the callback to notify for transport's readiness or failure */
508static inline void conn_clear_xprt_done_cb(struct connection *conn)
509{
510 conn->xprt_done_cb = NULL;
511}
512
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200513/* Tries to allocate a new connection and initialized its main fields. The
514 * connection is returned on success, NULL on failure. The connection must
515 * be released using pool_free2() or conn_free().
516 */
517static inline struct connection *conn_new()
518{
519 struct connection *conn;
520
521 conn = pool_alloc2(pool2_connection);
522 if (likely(conn != NULL))
523 conn_init(conn);
524 return conn;
525}
526
527/* Releases a connection previously allocated by conn_new() */
528static inline void conn_free(struct connection *conn)
529{
530 pool_free2(pool2_connection, conn);
531}
532
533
Willy Tarreau986a9d22012-08-30 21:11:38 +0200534/* Retrieves the connection's source address */
535static inline void conn_get_from_addr(struct connection *conn)
536{
537 if (conn->flags & CO_FL_ADDR_FROM_SET)
538 return;
539
Willy Tarreau3c728722014-01-23 13:50:42 +0100540 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_src)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200541 return;
542
Willy Tarreau585744b2017-08-24 14:31:19 +0200543 if (conn->ctrl->get_src(conn->handle.fd, (struct sockaddr *)&conn->addr.from,
Willy Tarreau3fdb3662012-11-12 00:42:33 +0100544 sizeof(conn->addr.from),
545 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200546 return;
547 conn->flags |= CO_FL_ADDR_FROM_SET;
548}
549
550/* Retrieves the connection's original destination address */
551static inline void conn_get_to_addr(struct connection *conn)
552{
553 if (conn->flags & CO_FL_ADDR_TO_SET)
554 return;
555
Willy Tarreau3c728722014-01-23 13:50:42 +0100556 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_dst)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200557 return;
558
Willy Tarreau585744b2017-08-24 14:31:19 +0200559 if (conn->ctrl->get_dst(conn->handle.fd, (struct sockaddr *)&conn->addr.to,
Willy Tarreau3fdb3662012-11-12 00:42:33 +0100560 sizeof(conn->addr.to),
561 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200562 return;
563 conn->flags |= CO_FL_ADDR_TO_SET;
564}
565
Willy Tarreau7abddb52013-10-24 15:31:04 +0200566/* Attaches a connection to an owner and assigns a data layer */
567static inline void conn_attach(struct connection *conn, void *owner, const struct data_cb *data)
Willy Tarreaudda5e7c2012-09-24 17:15:42 +0200568{
Willy Tarreau74beec32012-10-03 00:41:04 +0200569 conn->data = data;
Willy Tarreaucd379952012-09-27 22:14:33 +0200570 conn->owner = owner;
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200571}
572
Willy Tarreau0af29122012-12-03 15:35:00 +0100573/* returns a human-readable error code for conn->err_code, or NULL if the code
574 * is unknown.
575 */
576static inline const char *conn_err_code_str(struct connection *c)
577{
578 switch (c->err_code) {
579 case CO_ER_NONE: return "Success";
Willy Tarreau45b34e82014-01-24 16:06:50 +0100580
581 case CO_ER_CONF_FDLIM: return "Reached configured maxconn value";
582 case CO_ER_PROC_FDLIM: return "Too many sockets on the process";
583 case CO_ER_SYS_FDLIM: return "Too many sockets on the system";
584 case CO_ER_SYS_MEMLIM: return "Out of system buffers";
585 case CO_ER_NOPROTO: return "Protocol or address family not supported";
586 case CO_ER_SOCK_ERR: return "General socket error";
587 case CO_ER_PORT_RANGE: return "Source port range exhausted";
588 case CO_ER_CANT_BIND: return "Can't bind to source address";
589 case CO_ER_FREE_PORTS: return "Out of local source ports on the system";
590 case CO_ER_ADDR_INUSE: return "Local source address already in use";
591
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100592 case CO_ER_PRX_EMPTY: return "Connection closed while waiting for PROXY protocol header";
593 case CO_ER_PRX_ABORT: return "Connection error while waiting for PROXY protocol header";
Willy Tarreau0af29122012-12-03 15:35:00 +0100594 case CO_ER_PRX_TIMEOUT: return "Timeout while waiting for PROXY protocol header";
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100595 case CO_ER_PRX_TRUNCATED: return "Truncated PROXY protocol header received";
596 case CO_ER_PRX_NOT_HDR: return "Received something which does not look like a PROXY protocol header";
597 case CO_ER_PRX_BAD_HDR: return "Received an invalid PROXY protocol header";
598 case CO_ER_PRX_BAD_PROTO: return "Received an unhandled protocol in the PROXY protocol header";
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100599
600 case CO_ER_CIP_EMPTY: return "Connection closed while waiting for NetScaler Client IP header";
601 case CO_ER_CIP_ABORT: return "Connection error while waiting for NetScaler Client IP header";
602 case CO_ER_CIP_TRUNCATED: return "Truncated NetScaler Client IP header received";
603 case CO_ER_CIP_BAD_MAGIC: return "Received an invalid NetScaler Client IP magic number";
604 case CO_ER_CIP_BAD_PROTO: return "Received an unhandled protocol in the NetScaler Client IP header";
605
Willy Tarreau20879a02012-12-03 16:32:10 +0100606 case CO_ER_SSL_EMPTY: return "Connection closed during SSL handshake";
607 case CO_ER_SSL_ABORT: return "Connection error during SSL handshake";
Willy Tarreau0af29122012-12-03 15:35:00 +0100608 case CO_ER_SSL_TIMEOUT: return "Timeout during SSL handshake";
Willy Tarreau20879a02012-12-03 16:32:10 +0100609 case CO_ER_SSL_TOO_MANY: return "Too many SSL connections";
610 case CO_ER_SSL_NO_MEM: return "Out of memory when initializing an SSL connection";
611 case CO_ER_SSL_RENEG: return "Rejected a client-initiated SSL renegociation attempt";
612 case CO_ER_SSL_CA_FAIL: return "SSL client CA chain cannot be verified";
613 case CO_ER_SSL_CRT_FAIL: return "SSL client certificate not trusted";
Willy Tarreau71d058c2017-07-26 20:09:56 +0200614 case CO_ER_SSL_MISMATCH: return "Server presented an SSL certificate different from the configured one";
615 case CO_ER_SSL_MISMATCH_SNI: return "Server presented an SSL certificate different from the expected one";
Willy Tarreau20879a02012-12-03 16:32:10 +0100616 case CO_ER_SSL_HANDSHAKE: return "SSL handshake failure";
Willy Tarreaub3966372014-04-25 18:54:29 +0200617 case CO_ER_SSL_HANDSHAKE_HB: return "SSL handshake failure after heartbeat";
Willy Tarreauf51c6982014-04-25 20:02:39 +0200618 case CO_ER_SSL_KILLED_HB: return "Stopped a TLSv1 heartbeat attack (CVE-2014-0160)";
Willy Tarreau830bf612013-12-01 20:29:58 +0100619 case CO_ER_SSL_NO_TARGET: return "Attempt to use SSL on an unknown target (internal error)";
Willy Tarreau0af29122012-12-03 15:35:00 +0100620 }
621 return NULL;
622}
623
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100624static inline const char *conn_get_ctrl_name(const struct connection *conn)
625{
626 if (!conn_ctrl_ready(conn))
627 return "NONE";
628 return conn->ctrl->name;
629}
630
631static inline const char *conn_get_xprt_name(const struct connection *conn)
632{
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100633 if (!conn_xprt_ready(conn))
634 return "NONE";
Willy Tarreau8e0bb0a2016-11-24 16:58:12 +0100635 return conn->xprt->name;
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100636}
637
638static inline const char *conn_get_data_name(const struct connection *conn)
639{
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100640 if (!conn->data)
641 return "NONE";
Willy Tarreau8e0bb0a2016-11-24 16:58:12 +0100642 return conn->data->name;
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100643}
644
Willy Tarreau13e14102016-12-22 20:25:26 +0100645/* registers pointer to transport layer <id> (XPRT_*) */
646static inline void xprt_register(int id, struct xprt_ops *xprt)
647{
648 if (id >= XPRT_ENTRIES)
649 return;
650 registered_xprt[id] = xprt;
651}
652
653/* returns pointer to transport layer <id> (XPRT_*) or NULL if not registered */
654static inline struct xprt_ops *xprt_get(int id)
655{
656 if (id >= XPRT_ENTRIES)
657 return NULL;
658 return registered_xprt[id];
659}
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100660
Willy Tarreaua9c17412016-12-04 18:42:09 +0100661static inline int conn_get_alpn(const struct connection *conn, const char **str, int *len)
662{
663 if (!conn_xprt_ready(conn) || !conn->xprt->get_alpn)
664 return 0;
665 return conn->xprt->get_alpn(conn, str, len);
666}
667
Willy Tarreau59f98392012-07-06 14:13:49 +0200668#endif /* _PROTO_CONNECTION_H */
669
670/*
671 * Local variables:
672 * c-indent-level: 8
673 * c-basic-offset: 8
674 * End:
675 */