blob: ea6b17b67c986ab18837b736e48b95597bc8c0b9 [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 Tarreau2386be62017-09-21 19:40:52 +020026#include <common/ist.h>
Willy Tarreauf2943dc2012-10-26 20:10:28 +020027#include <common/memory.h>
Willy Tarreau59f98392012-07-06 14:13:49 +020028#include <types/connection.h>
Willy Tarreaud1d54542012-09-12 22:58:11 +020029#include <types/listener.h>
Willy Tarreau2b199c92012-11-23 17:32:21 +010030#include <proto/fd.h>
Willy Tarreau3fdb3662012-11-12 00:42:33 +010031#include <proto/obj_type.h>
Olivier Houchard6ff20392018-07-17 18:46:31 +020032#include <proto/task.h>
Willy Tarreau59f98392012-07-06 14:13:49 +020033
Willy Tarreaubafbe012017-11-24 17:34:44 +010034extern struct pool_head *pool_head_connection;
35extern struct pool_head *pool_head_connstream;
Willy Tarreau13e14102016-12-22 20:25:26 +010036extern struct xprt_ops *registered_xprt[XPRT_ENTRIES];
Christopher Faulet32f61c02018-04-10 14:33:41 +020037extern struct mux_proto_list mux_proto_list;
Willy Tarreauf2943dc2012-10-26 20:10:28 +020038
39/* perform minimal intializations, report 0 in case of error, 1 if OK. */
40int init_connection();
41
Willy Tarreau59f98392012-07-06 14:13:49 +020042/* I/O callback for fd-based connections. It calls the read/write handlers
Willy Tarreau7a798e52016-04-14 11:13:20 +020043 * provided by the connection's sock_ops.
Willy Tarreau59f98392012-07-06 14:13:49 +020044 */
Willy Tarreau7a798e52016-04-14 11:13:20 +020045void conn_fd_handler(int fd);
Willy Tarreau59f98392012-07-06 14:13:49 +020046
Willy Tarreau22cda212012-08-31 17:43:29 +020047/* receive a PROXY protocol header over a connection */
48int conn_recv_proxy(struct connection *conn, int flag);
David Safb76832014-05-08 23:42:08 -040049int make_proxy_line(char *buf, int buf_len, struct server *srv, struct connection *remote);
50int make_proxy_line_v1(char *buf, int buf_len, struct sockaddr_storage *src, struct sockaddr_storage *dst);
51int make_proxy_line_v2(char *buf, int buf_len, struct server *srv, struct connection *remote);
Willy Tarreau22cda212012-08-31 17:43:29 +020052
Olivier Houchard6ff20392018-07-17 18:46:31 +020053int conn_subscribe(struct connection *conn, int event_type, void *param);
Bertrand Jacquin93b227d2016-06-04 15:11:10 +010054/* receive a NetScaler Client IP insertion header over a connection */
55int conn_recv_netscaler_cip(struct connection *conn, int flag);
56
Willy Tarreauff3e6482015-03-12 23:56:52 +010057/* raw send() directly on the socket */
58int conn_sock_send(struct connection *conn, const void *buf, int len, int flags);
59
Willy Tarreaud85c4852015-03-13 00:40:28 +010060/* drains any pending bytes from the socket */
61int conn_sock_drain(struct connection *conn);
62
Willy Tarreaud02cdd22013-12-15 10:23:20 +010063/* returns true is the transport layer is ready */
Willy Tarreauaad69382014-01-23 14:21:42 +010064static inline int conn_xprt_ready(const struct connection *conn)
Willy Tarreaud02cdd22013-12-15 10:23:20 +010065{
Willy Tarreauaad69382014-01-23 14:21:42 +010066 return (conn->flags & CO_FL_XPRT_READY);
Willy Tarreaud02cdd22013-12-15 10:23:20 +010067}
68
69/* returns true is the control layer is ready */
Willy Tarreau3c728722014-01-23 13:50:42 +010070static inline int conn_ctrl_ready(const struct connection *conn)
Willy Tarreaud02cdd22013-12-15 10:23:20 +010071{
72 return (conn->flags & CO_FL_CTRL_READY);
73}
74
Willy Tarreauf79c8172013-10-21 16:30:56 +020075/* Calls the init() function of the transport layer if any and if not done yet,
76 * and sets the CO_FL_XPRT_READY flag to indicate it was properly initialized.
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020077 * Returns <0 in case of error.
Willy Tarreau15678ef2012-08-31 13:54:11 +020078 */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020079static inline int conn_xprt_init(struct connection *conn)
Willy Tarreau15678ef2012-08-31 13:54:11 +020080{
Willy Tarreauf79c8172013-10-21 16:30:56 +020081 int ret = 0;
82
Willy Tarreauaad69382014-01-23 14:21:42 +010083 if (!conn_xprt_ready(conn) && conn->xprt && conn->xprt->init)
Willy Tarreauf79c8172013-10-21 16:30:56 +020084 ret = conn->xprt->init(conn);
85
86 if (ret >= 0)
87 conn->flags |= CO_FL_XPRT_READY;
88
89 return ret;
Willy Tarreau15678ef2012-08-31 13:54:11 +020090}
91
Willy Tarreauf79c8172013-10-21 16:30:56 +020092/* Calls the close() function of the transport layer if any and if not done
93 * yet, and clears the CO_FL_XPRT_READY flag. However this is not done if the
94 * CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the
95 * transport layer very late if needed.
Willy Tarreau6c03a642012-10-12 17:00:05 +020096 */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020097static inline void conn_xprt_close(struct connection *conn)
Willy Tarreau8b117082012-08-06 15:06:49 +020098{
Willy Tarreauf79c8172013-10-21 16:30:56 +020099 if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_XPRT_TRACKED)) == CO_FL_XPRT_READY) {
Willy Tarreauaad69382014-01-23 14:21:42 +0100100 if (conn->xprt->close)
Willy Tarreau6c03a642012-10-12 17:00:05 +0200101 conn->xprt->close(conn);
Willy Tarreauf79c8172013-10-21 16:30:56 +0200102 conn->flags &= ~CO_FL_XPRT_READY;
103 }
104}
105
106/* Initializes the connection's control layer which essentially consists in
107 * registering the file descriptor for polling and setting the CO_FL_CTRL_READY
Willy Tarreau3c728722014-01-23 13:50:42 +0100108 * flag. The caller is responsible for ensuring that the control layer is
109 * already assigned to the connection prior to the call.
Willy Tarreauf79c8172013-10-21 16:30:56 +0200110 */
111static inline void conn_ctrl_init(struct connection *conn)
112{
Willy Tarreau3c728722014-01-23 13:50:42 +0100113 if (!conn_ctrl_ready(conn)) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200114 int fd = conn->handle.fd;
Willy Tarreauf79c8172013-10-21 16:30:56 +0200115
Willy Tarreaua9786b62018-01-25 07:22:13 +0100116 fd_insert(fd, conn, conn_fd_handler, tid_bit);
Willy Tarreauf817e9f2014-01-10 16:58:45 +0100117 /* mark the fd as ready so as not to needlessly poll at the beginning */
118 fd_may_recv(fd);
119 fd_may_send(fd);
Willy Tarreauf79c8172013-10-21 16:30:56 +0200120 conn->flags |= CO_FL_CTRL_READY;
Willy Tarreau6c03a642012-10-12 17:00:05 +0200121 }
Willy Tarreau8b117082012-08-06 15:06:49 +0200122}
123
Willy Tarreauf79c8172013-10-21 16:30:56 +0200124/* Deletes the FD if the transport layer is already gone. Once done,
125 * it then removes the CO_FL_CTRL_READY flag.
126 */
127static inline void conn_ctrl_close(struct connection *conn)
128{
129 if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_CTRL_READY)) == CO_FL_CTRL_READY) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200130 fd_delete(conn->handle.fd);
Willy Tarreau6a0a80a2017-10-05 17:43:39 +0200131 conn->handle.fd = DEAD_FD_MAGIC;
Willy Tarreauf79c8172013-10-21 16:30:56 +0200132 conn->flags &= ~CO_FL_CTRL_READY;
133 }
134}
135
Willy Tarreau2b199c92012-11-23 17:32:21 +0100136/* If the connection still has a transport layer, then call its close() function
137 * if any, and delete the file descriptor if a control layer is set. This is
138 * used to close everything at once and atomically. However this is not done if
139 * the CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the
140 * transport layer very late if needed.
141 */
142static inline void conn_full_close(struct connection *conn)
143{
Willy Tarreauf79c8172013-10-21 16:30:56 +0200144 conn_xprt_close(conn);
145 conn_ctrl_close(conn);
146}
147
Willy Tarreaudc42acd2017-10-05 18:09:20 +0200148/* stop tracking a connection, allowing conn_full_close() to always
149 * succeed.
150 */
151static inline void conn_stop_tracking(struct connection *conn)
152{
153 conn->flags &= ~CO_FL_XPRT_TRACKED;
154}
155
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200156/* Update polling on connection <c>'s file descriptor depending on its current
157 * state as reported in the connection's CO_FL_CURR_* flags, reports of EAGAIN
158 * in CO_FL_WAIT_*, and the sock layer expectations indicated by CO_FL_SOCK_*.
159 * The connection flags are updated with the new flags at the end of the
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200160 * operation. Polling is totally disabled if an error was reported.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200161 */
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200162void conn_update_sock_polling(struct connection *c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200163
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200164/* Update polling on connection <c>'s file descriptor depending on its current
165 * state as reported in the connection's CO_FL_CURR_* flags, reports of EAGAIN
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200166 * in CO_FL_WAIT_*, and the upper layer expectations indicated by CO_FL_XPRT_*.
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200167 * The connection flags are updated with the new flags at the end of the
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200168 * operation. Polling is totally disabled if an error was reported.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200169 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200170void conn_update_xprt_polling(struct connection *c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200171
Willy Tarreau7d281492012-12-16 19:19:13 +0100172/* Refresh the connection's polling flags from its file descriptor status.
Willy Tarreau916e12d2017-10-25 09:22:43 +0200173 * This should be called at the beginning of a connection handler. It does
174 * nothing if CO_FL_WILL_UPDATE is present, indicating that an upper caller
175 * has already done it.
Willy Tarreau7d281492012-12-16 19:19:13 +0100176 */
177static inline void conn_refresh_polling_flags(struct connection *conn)
178{
Willy Tarreau916e12d2017-10-25 09:22:43 +0200179 if (conn_ctrl_ready(conn) && !(conn->flags & CO_FL_WILL_UPDATE)) {
Willy Tarreaubc97cc42017-10-25 10:28:45 +0200180 unsigned int flags = conn->flags;
Willy Tarreau7d281492012-12-16 19:19:13 +0100181
Willy Tarreaubc97cc42017-10-25 10:28:45 +0200182 flags &= ~(CO_FL_CURR_RD_ENA | CO_FL_CURR_WR_ENA | CO_FL_WAIT_ROOM);
Willy Tarreau585744b2017-08-24 14:31:19 +0200183 if (fd_recv_active(conn->handle.fd))
Willy Tarreau7d281492012-12-16 19:19:13 +0100184 flags |= CO_FL_CURR_RD_ENA;
Willy Tarreau585744b2017-08-24 14:31:19 +0200185 if (fd_send_active(conn->handle.fd))
Willy Tarreau7d281492012-12-16 19:19:13 +0100186 flags |= CO_FL_CURR_WR_ENA;
187 conn->flags = flags;
188 }
189}
190
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200191/* inspects c->flags and returns non-zero if XPRT ENA changes from the CURR ENA
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100192 * or if the WAIT flags are set with their respective ENA flags. Additionally,
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200193 * non-zero is also returned if an error was reported on the connection. This
194 * function is used quite often and is inlined. In order to proceed optimally
195 * with very little code and CPU cycles, the bits are arranged so that a change
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100196 * can be detected by a few left shifts, a xor, and a mask. These operations
197 * detect when W&D are both enabled for either direction, when C&D differ for
198 * either direction and when Error is set. The trick consists in first keeping
199 * only the bits we're interested in, since they don't collide when shifted,
200 * and to perform the AND at the end. In practice, the compiler is able to
201 * replace the last AND with a TEST in boolean conditions. This results in
202 * checks that are done in 4-6 cycles and less than 30 bytes.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200203 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200204static inline unsigned int conn_xprt_polling_changes(const struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200205{
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100206 unsigned int f = c->flags;
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200207 f &= CO_FL_XPRT_WR_ENA | CO_FL_XPRT_RD_ENA | CO_FL_CURR_WR_ENA |
Willy Tarreau310987a2014-01-22 19:46:33 +0100208 CO_FL_CURR_RD_ENA | CO_FL_ERROR;
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100209
Willy Tarreau310987a2014-01-22 19:46:33 +0100210 f = (f ^ (f << 1)) & (CO_FL_CURR_WR_ENA|CO_FL_CURR_RD_ENA); /* test C ^ D */
211 return f & (CO_FL_CURR_WR_ENA | CO_FL_CURR_RD_ENA | CO_FL_ERROR);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200212}
213
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200214/* inspects c->flags and returns non-zero if SOCK ENA changes from the CURR ENA
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100215 * or if the WAIT flags are set with their respective ENA flags. Additionally,
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200216 * non-zero is also returned if an error was reported on the connection. This
217 * function is used quite often and is inlined. In order to proceed optimally
218 * with very little code and CPU cycles, the bits are arranged so that a change
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100219 * can be detected by a few left shifts, a xor, and a mask. These operations
220 * detect when W&S are both enabled for either direction, when C&S differ for
221 * either direction and when Error is set. The trick consists in first keeping
222 * only the bits we're interested in, since they don't collide when shifted,
223 * and to perform the AND at the end. In practice, the compiler is able to
224 * replace the last AND with a TEST in boolean conditions. This results in
225 * checks that are done in 4-6 cycles and less than 30 bytes.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200226 */
227static inline unsigned int conn_sock_polling_changes(const struct connection *c)
228{
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100229 unsigned int f = c->flags;
230 f &= CO_FL_SOCK_WR_ENA | CO_FL_SOCK_RD_ENA | CO_FL_CURR_WR_ENA |
Willy Tarreau310987a2014-01-22 19:46:33 +0100231 CO_FL_CURR_RD_ENA | CO_FL_ERROR;
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100232
Willy Tarreau310987a2014-01-22 19:46:33 +0100233 f = (f ^ (f << 2)) & (CO_FL_CURR_WR_ENA|CO_FL_CURR_RD_ENA); /* test C ^ S */
234 return f & (CO_FL_CURR_WR_ENA | CO_FL_CURR_RD_ENA | CO_FL_ERROR);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200235}
236
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200237/* Automatically updates polling on connection <c> depending on the XPRT flags
Willy Tarreau916e12d2017-10-25 09:22:43 +0200238 * if no handshake is in progress. It does nothing if CO_FL_WILL_UPDATE is
239 * present, indicating that an upper caller is going to do it again later.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200240 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200241static inline void conn_cond_update_xprt_polling(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200242{
Willy Tarreau916e12d2017-10-25 09:22:43 +0200243 if (!(c->flags & CO_FL_WILL_UPDATE))
244 if (!(c->flags & CO_FL_POLL_SOCK) && conn_xprt_polling_changes(c))
245 conn_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200246}
247
248/* Automatically updates polling on connection <c> depending on the SOCK flags
Willy Tarreau916e12d2017-10-25 09:22:43 +0200249 * if a handshake is in progress. It does nothing if CO_FL_WILL_UPDATE is
250 * present, indicating that an upper caller is going to do it again later.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200251 */
252static inline void conn_cond_update_sock_polling(struct connection *c)
253{
Willy Tarreau916e12d2017-10-25 09:22:43 +0200254 if (!(c->flags & CO_FL_WILL_UPDATE))
255 if ((c->flags & CO_FL_POLL_SOCK) && conn_sock_polling_changes(c))
256 conn_update_sock_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200257}
258
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100259/* Stop all polling on the fd. This might be used when an error is encountered
Willy Tarreau916e12d2017-10-25 09:22:43 +0200260 * for example. It does not propage the change to the fd layer if
261 * CO_FL_WILL_UPDATE is present, indicating that an upper caller is going to do
262 * it later.
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100263 */
264static inline void conn_stop_polling(struct connection *c)
265{
266 c->flags &= ~(CO_FL_CURR_RD_ENA | CO_FL_CURR_WR_ENA |
267 CO_FL_SOCK_RD_ENA | CO_FL_SOCK_WR_ENA |
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200268 CO_FL_XPRT_RD_ENA | CO_FL_XPRT_WR_ENA);
Willy Tarreau916e12d2017-10-25 09:22:43 +0200269 if (!(c->flags & CO_FL_WILL_UPDATE) && conn_ctrl_ready(c))
Willy Tarreau585744b2017-08-24 14:31:19 +0200270 fd_stop_both(c->handle.fd);
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100271}
272
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200273/* Automatically update polling on connection <c> depending on the XPRT and
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200274 * SOCK flags, and on whether a handshake is in progress or not. This may be
275 * called at any moment when there is a doubt about the effectiveness of the
276 * polling state, for instance when entering or leaving the handshake state.
Willy Tarreau916e12d2017-10-25 09:22:43 +0200277 * It does nothing if CO_FL_WILL_UPDATE is present, indicating that an upper
278 * caller is going to do it again later.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200279 */
280static inline void conn_cond_update_polling(struct connection *c)
281{
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100282 if (unlikely(c->flags & CO_FL_ERROR))
283 conn_stop_polling(c);
Willy Tarreau916e12d2017-10-25 09:22:43 +0200284 else if (!(c->flags & CO_FL_WILL_UPDATE)) {
285 if (!(c->flags & CO_FL_POLL_SOCK) && conn_xprt_polling_changes(c))
286 conn_update_xprt_polling(c);
287 else if ((c->flags & CO_FL_POLL_SOCK) && conn_sock_polling_changes(c))
288 conn_update_sock_polling(c);
289 }
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200290}
291
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200292/* recompute the mux polling flags after updating the current conn_stream and
293 * propagate the result down the transport layer.
294 */
295static inline void cs_update_mux_polling(struct conn_stream *cs)
296{
297 struct connection *conn = cs->conn;
298
299 if (conn->mux && conn->mux->update_poll)
300 conn->mux->update_poll(cs);
301}
302
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200303/***** Event manipulation primitives for use by DATA I/O callbacks *****/
304/* The __conn_* versions do not propagate to lower layers and are only meant
305 * to be used by handlers called by the connection handler. The other ones
306 * may be used anywhere.
307 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200308static inline void __conn_xprt_want_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200309{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200310 c->flags |= CO_FL_XPRT_RD_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200311}
312
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200313static inline void __conn_xprt_stop_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200314{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200315 c->flags &= ~CO_FL_XPRT_RD_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200316}
317
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200318static inline void __cs_want_recv(struct conn_stream *cs)
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200319{
320 cs->flags |= CS_FL_DATA_RD_ENA;
321}
322
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200323static inline void __cs_stop_recv(struct conn_stream *cs)
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200324{
325 cs->flags &= ~CS_FL_DATA_RD_ENA;
326}
327
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200328static inline void cs_want_recv(struct conn_stream *cs)
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200329{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200330 __cs_want_recv(cs);
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200331 cs_update_mux_polling(cs);
332}
333
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200334static inline void cs_stop_recv(struct conn_stream *cs)
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200335{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200336 __cs_stop_recv(cs);
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200337 cs_update_mux_polling(cs);
338}
339
Willy Tarreau796c5b72016-11-29 21:47:02 +0100340/* this one is used only to stop speculative recv(). It doesn't stop it if the
341 * fd is already polled in order to avoid expensive polling status changes.
342 * Since it might require the upper layer to re-enable reading, we'll return 1
343 * if we've really stopped something otherwise zero.
344 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200345static inline int __conn_xprt_done_recv(struct connection *c)
Willy Tarreau796c5b72016-11-29 21:47:02 +0100346{
Willy Tarreau585744b2017-08-24 14:31:19 +0200347 if (!conn_ctrl_ready(c) || !fd_recv_polled(c->handle.fd)) {
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200348 c->flags &= ~CO_FL_XPRT_RD_ENA;
Willy Tarreau796c5b72016-11-29 21:47:02 +0100349 return 1;
350 }
351 return 0;
352}
353
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200354static inline void __conn_xprt_want_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200355{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200356 c->flags |= CO_FL_XPRT_WR_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200357}
358
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200359static inline void __conn_xprt_stop_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200360{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200361 c->flags &= ~CO_FL_XPRT_WR_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200362}
363
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200364static inline void __conn_xprt_stop_both(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200365{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200366 c->flags &= ~(CO_FL_XPRT_WR_ENA | CO_FL_XPRT_RD_ENA);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200367}
368
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200369static inline void __cs_want_send(struct conn_stream *cs)
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200370{
371 cs->flags |= CS_FL_DATA_WR_ENA;
372}
373
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200374static inline void __cs_stop_send(struct conn_stream *cs)
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200375{
376 cs->flags &= ~CS_FL_DATA_WR_ENA;
377}
378
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200379static inline void cs_stop_send(struct conn_stream *cs)
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200380{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200381 __cs_stop_send(cs);
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200382 cs_update_mux_polling(cs);
383}
384
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200385static inline void cs_want_send(struct conn_stream *cs)
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200386{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200387 __cs_want_send(cs);
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200388 cs_update_mux_polling(cs);
389}
390
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200391static inline void __cs_stop_both(struct conn_stream *cs)
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200392{
393 cs->flags &= ~(CS_FL_DATA_WR_ENA | CS_FL_DATA_RD_ENA);
394}
395
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200396static inline void cs_stop_both(struct conn_stream *cs)
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200397{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200398 __cs_stop_both(cs);
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200399 cs_update_mux_polling(cs);
400}
401
402
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200403static inline void conn_xprt_want_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200404{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200405 __conn_xprt_want_recv(c);
406 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200407}
408
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200409static inline void conn_xprt_stop_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200410{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200411 __conn_xprt_stop_recv(c);
412 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200413}
414
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200415static inline void conn_xprt_want_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200416{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200417 __conn_xprt_want_send(c);
418 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200419}
420
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200421static inline void conn_xprt_stop_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200422{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200423 __conn_xprt_stop_send(c);
424 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200425}
426
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200427static inline void conn_xprt_stop_both(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200428{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200429 __conn_xprt_stop_both(c);
430 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200431}
432
433/***** Event manipulation primitives for use by handshake I/O callbacks *****/
434/* The __conn_* versions do not propagate to lower layers and are only meant
435 * to be used by handlers called by the connection handler. The other ones
436 * may be used anywhere.
437 */
438static inline void __conn_sock_want_recv(struct connection *c)
439{
440 c->flags |= CO_FL_SOCK_RD_ENA;
441}
442
443static inline void __conn_sock_stop_recv(struct connection *c)
444{
445 c->flags &= ~CO_FL_SOCK_RD_ENA;
446}
447
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200448static inline void __conn_sock_want_send(struct connection *c)
449{
450 c->flags |= CO_FL_SOCK_WR_ENA;
451}
452
453static inline void __conn_sock_stop_send(struct connection *c)
454{
455 c->flags &= ~CO_FL_SOCK_WR_ENA;
456}
457
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200458static inline void __conn_sock_stop_both(struct connection *c)
459{
460 c->flags &= ~(CO_FL_SOCK_WR_ENA | CO_FL_SOCK_RD_ENA);
461}
462
463static inline void conn_sock_want_recv(struct connection *c)
464{
465 __conn_sock_want_recv(c);
466 conn_cond_update_sock_polling(c);
467}
468
469static inline void conn_sock_stop_recv(struct connection *c)
470{
471 __conn_sock_stop_recv(c);
472 conn_cond_update_sock_polling(c);
473}
474
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200475static inline void conn_sock_want_send(struct connection *c)
476{
477 __conn_sock_want_send(c);
478 conn_cond_update_sock_polling(c);
479}
480
481static inline void conn_sock_stop_send(struct connection *c)
482{
483 __conn_sock_stop_send(c);
484 conn_cond_update_sock_polling(c);
485}
486
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200487static inline void conn_sock_stop_both(struct connection *c)
488{
489 __conn_sock_stop_both(c);
490 conn_cond_update_sock_polling(c);
491}
Willy Tarreau8b117082012-08-06 15:06:49 +0200492
Willy Tarreau7b271b22017-10-25 09:59:22 +0200493/* read shutdown, called from the rcv_buf/rcv_pipe handlers when
494 * detecting an end of connection.
495 */
Willy Tarreau3af56a92012-08-20 16:55:48 +0200496static inline void conn_sock_read0(struct connection *c)
497{
498 c->flags |= CO_FL_SOCK_RD_SH;
499 __conn_sock_stop_recv(c);
Willy Tarreauad38ace2013-12-15 14:19:38 +0100500 /* we don't risk keeping ports unusable if we found the
501 * zero from the other side.
502 */
Willy Tarreau3c728722014-01-23 13:50:42 +0100503 if (conn_ctrl_ready(c))
Willy Tarreau585744b2017-08-24 14:31:19 +0200504 fdtab[c->handle.fd].linger_risk = 0;
Willy Tarreau3af56a92012-08-20 16:55:48 +0200505}
506
Willy Tarreau7b271b22017-10-25 09:59:22 +0200507/* write shutdown, indication that the upper layer is not willing to send
Willy Tarreaua48c1412017-12-22 18:46:33 +0100508 * anything anymore and wants to close after pending data are sent. The
509 * <clean> argument will allow not to perform the socket layer shutdown if
510 * equal to 0.
Willy Tarreau7b271b22017-10-25 09:59:22 +0200511 */
Willy Tarreaua48c1412017-12-22 18:46:33 +0100512static inline void conn_sock_shutw(struct connection *c, int clean)
Willy Tarreau3af56a92012-08-20 16:55:48 +0200513{
514 c->flags |= CO_FL_SOCK_WR_SH;
Willy Tarreau7b271b22017-10-25 09:59:22 +0200515 conn_refresh_polling_flags(c);
Willy Tarreau3af56a92012-08-20 16:55:48 +0200516 __conn_sock_stop_send(c);
Willy Tarreau7b271b22017-10-25 09:59:22 +0200517 conn_cond_update_sock_polling(c);
518
Willy Tarreaua48c1412017-12-22 18:46:33 +0100519 /* don't perform a clean shutdown if we're going to reset or
520 * if the shutr was already received.
521 */
522 if (conn_ctrl_ready(c) && !(c->flags & CO_FL_SOCK_RD_SH) && clean)
Willy Tarreau585744b2017-08-24 14:31:19 +0200523 shutdown(c->handle.fd, SHUT_WR);
Willy Tarreau3af56a92012-08-20 16:55:48 +0200524}
525
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200526static inline void conn_xprt_shutw(struct connection *c)
Willy Tarreau3af56a92012-08-20 16:55:48 +0200527{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200528 __conn_xprt_stop_send(c);
Willy Tarreau729c69f2015-03-12 22:51:10 +0100529
530 /* clean data-layer shutdown */
531 if (c->xprt && c->xprt->shutw)
532 c->xprt->shutw(c, 1);
533}
534
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200535static inline void conn_xprt_shutw_hard(struct connection *c)
Willy Tarreau729c69f2015-03-12 22:51:10 +0100536{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200537 __conn_xprt_stop_send(c);
Willy Tarreau729c69f2015-03-12 22:51:10 +0100538
539 /* unclean data-layer shutdown */
540 if (c->xprt && c->xprt->shutw)
541 c->xprt->shutw(c, 0);
Willy Tarreau3af56a92012-08-20 16:55:48 +0200542}
543
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200544/* shut read */
545static inline void cs_shutr(struct conn_stream *cs, enum cs_shr_mode mode)
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200546{
547 __cs_stop_recv(cs);
548
549 /* clean data-layer shutdown */
550 if (cs->conn->mux && cs->conn->mux->shutr)
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200551 cs->conn->mux->shutr(cs, mode);
552 cs->flags |= (mode == CS_SHR_DRAIN) ? CS_FL_SHRD : CS_FL_SHRR;
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200553}
554
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200555/* shut write */
556static inline void cs_shutw(struct conn_stream *cs, enum cs_shw_mode mode)
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200557{
558 __cs_stop_send(cs);
559
560 /* clean data-layer shutdown */
561 if (cs->conn->mux && cs->conn->mux->shutw)
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200562 cs->conn->mux->shutw(cs, mode);
563 cs->flags |= (mode == CS_SHW_NORMAL) ? CS_FL_SHWN : CS_FL_SHWS;
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200564}
565
Willy Tarreau6978db32017-10-05 18:19:43 +0200566/* completely close a conn_stream (but do not detach it) */
567static inline void cs_close(struct conn_stream *cs)
568{
569 cs_shutw(cs, CS_SHW_SILENT);
570 cs_shutr(cs, CS_SHR_RESET);
571 cs->flags = CS_FL_NONE;
572}
573
Willy Tarreau3af56a92012-08-20 16:55:48 +0200574/* detect sock->data read0 transition */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200575static inline int conn_xprt_read0_pending(struct connection *c)
Willy Tarreau3af56a92012-08-20 16:55:48 +0200576{
Willy Tarreau54e917c2017-08-30 07:35:35 +0200577 return (c->flags & CO_FL_SOCK_RD_SH) != 0;
Willy Tarreau3af56a92012-08-20 16:55:48 +0200578}
579
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200580/* prepares a connection to work with protocol <proto> and transport <xprt>.
Willy Tarreau53a47662017-08-28 10:53:00 +0200581 * The transport's is initialized as well, and the mux and its context are
Willy Tarreaube373152018-09-06 11:45:30 +0200582 * cleared. The target is not reinitialized and it is recommended that it is
583 * set prior to calling this function so that the function may make use of it
584 * in the future to refine the mux choice if needed.
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200585 */
586static inline void conn_prepare(struct connection *conn, const struct protocol *proto, const struct xprt_ops *xprt)
587{
588 conn->ctrl = proto;
589 conn->xprt = xprt;
Willy Tarreau53a47662017-08-28 10:53:00 +0200590 conn->mux = NULL;
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200591 conn->xprt_st = 0;
592 conn->xprt_ctx = NULL;
Willy Tarreau53a47662017-08-28 10:53:00 +0200593 conn->mux_ctx = NULL;
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200594}
595
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200596/*
597 * Initializes all required fields for a new conn_strema.
598 */
599static inline void cs_init(struct conn_stream *cs, struct connection *conn)
600{
601 cs->obj_type = OBJ_TYPE_CS;
602 cs->flags = CS_FL_NONE;
Olivier Houchard910b2bc2018-07-17 18:49:38 +0200603 LIST_INIT(&cs->wait_list.list);
Olivier Houchard6ff20392018-07-17 18:46:31 +0200604 LIST_INIT(&cs->send_wait_list);
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200605 cs->conn = conn;
Olivier Houcharde1c6dbc2018-08-01 17:06:43 +0200606 cs->wait_list.wait_reason = 0;
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200607}
608
Willy Tarreaud0155772013-10-14 17:10:08 +0200609/* Initializes all required fields for a new connection. Note that it does the
610 * minimum acceptable initialization for a connection that already exists and
611 * is about to be reused. It also leaves the addresses untouched, which makes
612 * it usable across connection retries to reset a connection to a known state.
613 */
614static inline void conn_init(struct connection *conn)
615{
616 conn->obj_type = OBJ_TYPE_CONN;
617 conn->flags = CO_FL_NONE;
Olivier Houchardc2aae742017-09-22 18:26:28 +0200618 conn->tmp_early_data = -1;
Olivier Houchard90084a12017-11-23 18:21:29 +0100619 conn->sent_early_data = 0;
Willy Tarreau53a47662017-08-28 10:53:00 +0200620 conn->mux = NULL;
621 conn->mux_ctx = NULL;
Willy Tarreaud0155772013-10-14 17:10:08 +0200622 conn->owner = NULL;
Willy Tarreaub8020ce2013-10-24 21:10:08 +0200623 conn->send_proxy_ofs = 0;
Willy Tarreau585744b2017-08-24 14:31:19 +0200624 conn->handle.fd = DEAD_FD_MAGIC;
Willy Tarreaud0155772013-10-14 17:10:08 +0200625 conn->err_code = CO_ER_NONE;
626 conn->target = NULL;
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200627 conn->xprt_done_cb = NULL;
Willy Tarreau436d3332017-10-08 11:16:46 +0200628 conn->destroy_cb = NULL;
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100629 conn->proxy_netns = NULL;
Willy Tarreaud75d40e2015-08-04 17:25:58 +0200630 LIST_INIT(&conn->list);
Olivier Houchard6ff20392018-07-17 18:46:31 +0200631 LIST_INIT(&conn->send_wait_list);
Willy Tarreaud0155772013-10-14 17:10:08 +0200632}
633
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200634/* sets <owner> as the connection's owner */
Willy Tarreau436d3332017-10-08 11:16:46 +0200635static inline void conn_set_owner(struct connection *conn, void *owner, void (*cb)(struct connection *))
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200636{
637 conn->owner = owner;
Willy Tarreau436d3332017-10-08 11:16:46 +0200638 conn->destroy_cb = cb;
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200639}
640
641/* registers <cb> as a callback to notify for transport's readiness or failure */
642static inline void conn_set_xprt_done_cb(struct connection *conn, int (*cb)(struct connection *))
643{
644 conn->xprt_done_cb = cb;
645}
646
647/* unregisters the callback to notify for transport's readiness or failure */
648static inline void conn_clear_xprt_done_cb(struct connection *conn)
649{
650 conn->xprt_done_cb = NULL;
651}
652
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200653/* Tries to allocate a new connection and initialized its main fields. The
654 * connection is returned on success, NULL on failure. The connection must
Willy Tarreaubafbe012017-11-24 17:34:44 +0100655 * be released using pool_free() or conn_free().
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200656 */
657static inline struct connection *conn_new()
658{
659 struct connection *conn;
660
Willy Tarreaubafbe012017-11-24 17:34:44 +0100661 conn = pool_alloc(pool_head_connection);
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200662 if (likely(conn != NULL))
663 conn_init(conn);
664 return conn;
665}
666
Willy Tarreau5e1cc5e2018-03-02 10:43:58 +0100667/* Releases a conn_stream previously allocated by cs_new(), as well as any
668 * buffer it would still hold.
669 */
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200670static inline void cs_free(struct conn_stream *cs)
671{
Olivier Houchard910b2bc2018-07-17 18:49:38 +0200672 if (cs->wait_list.task)
673 tasklet_free(cs->wait_list.task);
Willy Tarreau5e1cc5e2018-03-02 10:43:58 +0100674
Willy Tarreaubafbe012017-11-24 17:34:44 +0100675 pool_free(pool_head_connstream, cs);
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200676}
677
678/* Tries to allocate a new conn_stream and initialize its main fields. If
679 * <conn> is NULL, then a new connection is allocated on the fly, initialized,
680 * and assigned to cs->conn ; this connection will then have to be released
Willy Tarreaubafbe012017-11-24 17:34:44 +0100681 * using pool_free() or conn_free(). The conn_stream is initialized and added
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200682 * to the mux's stream list on success, then returned. On failure, nothing is
683 * allocated and NULL is returned.
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200684 */
685static inline struct conn_stream *cs_new(struct connection *conn)
686{
687 struct conn_stream *cs;
688
Willy Tarreaubafbe012017-11-24 17:34:44 +0100689 cs = pool_alloc(pool_head_connstream);
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200690 if (!likely(cs))
691 return NULL;
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200692
Olivier Houchard910b2bc2018-07-17 18:49:38 +0200693 cs->wait_list.task = tasklet_new();
694 if (!likely(cs->wait_list.task)) {
695 cs_free(cs);
696 return NULL;
697 }
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200698 if (!conn) {
699 conn = conn_new();
700 if (!likely(conn)) {
701 cs_free(cs);
702 return NULL;
703 }
704 conn_init(conn);
705 }
706
707 cs_init(cs, conn);
708 return cs;
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200709}
710
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200711/* Releases a connection previously allocated by conn_new() */
712static inline void conn_free(struct connection *conn)
713{
Willy Tarreau1b13bfd2018-08-21 18:33:20 +0200714 LIST_DEL(&conn->send_wait_list);
715 LIST_INIT(&conn->send_wait_list);
Willy Tarreaubafbe012017-11-24 17:34:44 +0100716 pool_free(pool_head_connection, conn);
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200717}
718
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200719/* Release a conn_stream, and kill the connection if it was the last one */
720static inline void cs_destroy(struct conn_stream *cs)
721{
Olivier Houchard302f9ef2018-04-13 15:50:27 +0200722 if (cs->conn->mux)
723 cs->conn->mux->detach(cs);
724 else {
725 /* It's too early to have a mux, let's just destroy
726 * the connection
727 */
728 struct connection *conn = cs->conn;
729
730 conn_stop_tracking(conn);
731 conn_full_close(conn);
732 if (conn->destroy_cb)
733 conn->destroy_cb(conn);
734 conn_free(conn);
735 }
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200736 cs_free(cs);
737}
738
Olivier Houcharde2b40b92017-09-13 18:30:23 +0200739/* Returns the conn from a cs. If cs is NULL, returns NULL */
740static inline struct connection *cs_conn(const struct conn_stream *cs)
741{
742 return cs ? cs->conn : NULL;
743}
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200744
Willy Tarreau986a9d22012-08-30 21:11:38 +0200745/* Retrieves the connection's source address */
746static inline void conn_get_from_addr(struct connection *conn)
747{
748 if (conn->flags & CO_FL_ADDR_FROM_SET)
749 return;
750
Willy Tarreau3c728722014-01-23 13:50:42 +0100751 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_src)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200752 return;
753
Willy Tarreau585744b2017-08-24 14:31:19 +0200754 if (conn->ctrl->get_src(conn->handle.fd, (struct sockaddr *)&conn->addr.from,
Willy Tarreau3fdb3662012-11-12 00:42:33 +0100755 sizeof(conn->addr.from),
756 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200757 return;
758 conn->flags |= CO_FL_ADDR_FROM_SET;
759}
760
761/* Retrieves the connection's original destination address */
762static inline void conn_get_to_addr(struct connection *conn)
763{
764 if (conn->flags & CO_FL_ADDR_TO_SET)
765 return;
766
Willy Tarreau3c728722014-01-23 13:50:42 +0100767 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_dst)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200768 return;
769
Willy Tarreau585744b2017-08-24 14:31:19 +0200770 if (conn->ctrl->get_dst(conn->handle.fd, (struct sockaddr *)&conn->addr.to,
Willy Tarreau3fdb3662012-11-12 00:42:33 +0100771 sizeof(conn->addr.to),
772 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200773 return;
774 conn->flags |= CO_FL_ADDR_TO_SET;
775}
776
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200777/* Attaches a conn_stream to a data layer and sets the relevant callbacks */
778static inline void cs_attach(struct conn_stream *cs, void *data, const struct data_cb *data_cb)
Willy Tarreaudda5e7c2012-09-24 17:15:42 +0200779{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200780 cs->data_cb = data_cb;
781 cs->data = data;
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200782}
783
Willy Tarreau83188852018-07-18 08:18:20 +0200784static inline struct wait_list *wl_set_waitcb(struct wait_list *wl, struct task *(*cb)(struct task *, void *, unsigned short), void *ctx)
785{
786 if (!wl->task->process) {
787 wl->task->process = cb;
788 wl->task->context = ctx;
789 }
790 return wl;
791}
792
Willy Tarreau53a47662017-08-28 10:53:00 +0200793/* Installs the connection's mux layer for upper context <ctx>.
794 * Returns < 0 on error.
795 */
796static inline int conn_install_mux(struct connection *conn, const struct mux_ops *mux, void *ctx)
797{
798 conn->mux = mux;
799 conn->mux_ctx = ctx;
800 return mux->init ? mux->init(conn) : 0;
801}
802
Willy Tarreau0af29122012-12-03 15:35:00 +0100803/* returns a human-readable error code for conn->err_code, or NULL if the code
804 * is unknown.
805 */
806static inline const char *conn_err_code_str(struct connection *c)
807{
808 switch (c->err_code) {
809 case CO_ER_NONE: return "Success";
Willy Tarreau45b34e82014-01-24 16:06:50 +0100810
811 case CO_ER_CONF_FDLIM: return "Reached configured maxconn value";
812 case CO_ER_PROC_FDLIM: return "Too many sockets on the process";
813 case CO_ER_SYS_FDLIM: return "Too many sockets on the system";
814 case CO_ER_SYS_MEMLIM: return "Out of system buffers";
815 case CO_ER_NOPROTO: return "Protocol or address family not supported";
816 case CO_ER_SOCK_ERR: return "General socket error";
817 case CO_ER_PORT_RANGE: return "Source port range exhausted";
818 case CO_ER_CANT_BIND: return "Can't bind to source address";
819 case CO_ER_FREE_PORTS: return "Out of local source ports on the system";
820 case CO_ER_ADDR_INUSE: return "Local source address already in use";
821
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100822 case CO_ER_PRX_EMPTY: return "Connection closed while waiting for PROXY protocol header";
823 case CO_ER_PRX_ABORT: return "Connection error while waiting for PROXY protocol header";
Willy Tarreau0af29122012-12-03 15:35:00 +0100824 case CO_ER_PRX_TIMEOUT: return "Timeout while waiting for PROXY protocol header";
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100825 case CO_ER_PRX_TRUNCATED: return "Truncated PROXY protocol header received";
826 case CO_ER_PRX_NOT_HDR: return "Received something which does not look like a PROXY protocol header";
827 case CO_ER_PRX_BAD_HDR: return "Received an invalid PROXY protocol header";
828 case CO_ER_PRX_BAD_PROTO: return "Received an unhandled protocol in the PROXY protocol header";
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100829
830 case CO_ER_CIP_EMPTY: return "Connection closed while waiting for NetScaler Client IP header";
831 case CO_ER_CIP_ABORT: return "Connection error while waiting for NetScaler Client IP header";
832 case CO_ER_CIP_TRUNCATED: return "Truncated NetScaler Client IP header received";
833 case CO_ER_CIP_BAD_MAGIC: return "Received an invalid NetScaler Client IP magic number";
834 case CO_ER_CIP_BAD_PROTO: return "Received an unhandled protocol in the NetScaler Client IP header";
835
Willy Tarreau20879a02012-12-03 16:32:10 +0100836 case CO_ER_SSL_EMPTY: return "Connection closed during SSL handshake";
837 case CO_ER_SSL_ABORT: return "Connection error during SSL handshake";
Willy Tarreau0af29122012-12-03 15:35:00 +0100838 case CO_ER_SSL_TIMEOUT: return "Timeout during SSL handshake";
Willy Tarreau20879a02012-12-03 16:32:10 +0100839 case CO_ER_SSL_TOO_MANY: return "Too many SSL connections";
840 case CO_ER_SSL_NO_MEM: return "Out of memory when initializing an SSL connection";
841 case CO_ER_SSL_RENEG: return "Rejected a client-initiated SSL renegociation attempt";
842 case CO_ER_SSL_CA_FAIL: return "SSL client CA chain cannot be verified";
843 case CO_ER_SSL_CRT_FAIL: return "SSL client certificate not trusted";
Willy Tarreau71d058c2017-07-26 20:09:56 +0200844 case CO_ER_SSL_MISMATCH: return "Server presented an SSL certificate different from the configured one";
845 case CO_ER_SSL_MISMATCH_SNI: return "Server presented an SSL certificate different from the expected one";
Willy Tarreau20879a02012-12-03 16:32:10 +0100846 case CO_ER_SSL_HANDSHAKE: return "SSL handshake failure";
Willy Tarreaub3966372014-04-25 18:54:29 +0200847 case CO_ER_SSL_HANDSHAKE_HB: return "SSL handshake failure after heartbeat";
Willy Tarreauf51c6982014-04-25 20:02:39 +0200848 case CO_ER_SSL_KILLED_HB: return "Stopped a TLSv1 heartbeat attack (CVE-2014-0160)";
Willy Tarreau830bf612013-12-01 20:29:58 +0100849 case CO_ER_SSL_NO_TARGET: return "Attempt to use SSL on an unknown target (internal error)";
Willy Tarreau0af29122012-12-03 15:35:00 +0100850 }
851 return NULL;
852}
853
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100854static inline const char *conn_get_ctrl_name(const struct connection *conn)
855{
856 if (!conn_ctrl_ready(conn))
857 return "NONE";
858 return conn->ctrl->name;
859}
860
861static inline const char *conn_get_xprt_name(const struct connection *conn)
862{
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100863 if (!conn_xprt_ready(conn))
864 return "NONE";
Willy Tarreau8e0bb0a2016-11-24 16:58:12 +0100865 return conn->xprt->name;
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100866}
867
Willy Tarreau53a47662017-08-28 10:53:00 +0200868static inline const char *conn_get_mux_name(const struct connection *conn)
869{
870 if (!conn->mux)
871 return "NONE";
872 return conn->mux->name;
873}
874
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200875static inline const char *cs_get_data_name(const struct conn_stream *cs)
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100876{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200877 if (!cs->data_cb)
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100878 return "NONE";
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200879 return cs->data_cb->name;
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100880}
881
Willy Tarreau13e14102016-12-22 20:25:26 +0100882/* registers pointer to transport layer <id> (XPRT_*) */
883static inline void xprt_register(int id, struct xprt_ops *xprt)
884{
885 if (id >= XPRT_ENTRIES)
886 return;
887 registered_xprt[id] = xprt;
888}
889
890/* returns pointer to transport layer <id> (XPRT_*) or NULL if not registered */
891static inline struct xprt_ops *xprt_get(int id)
892{
893 if (id >= XPRT_ENTRIES)
894 return NULL;
895 return registered_xprt[id];
896}
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100897
Willy Tarreaua9c17412016-12-04 18:42:09 +0100898static inline int conn_get_alpn(const struct connection *conn, const char **str, int *len)
899{
900 if (!conn_xprt_ready(conn) || !conn->xprt->get_alpn)
901 return 0;
902 return conn->xprt->get_alpn(conn, str, len);
903}
904
Christopher Faulet32f61c02018-04-10 14:33:41 +0200905/* registers proto mux list <list>. Modifies the list element! */
906static inline void register_mux_proto(struct mux_proto_list *list)
Willy Tarreau2386be62017-09-21 19:40:52 +0200907{
Christopher Faulet32f61c02018-04-10 14:33:41 +0200908 LIST_ADDQ(&mux_proto_list.list, &list->list);
Willy Tarreau2386be62017-09-21 19:40:52 +0200909}
910
Christopher Faulet32f61c02018-04-10 14:33:41 +0200911/* unregisters proto mux list <list> */
912static inline void unregister_mux_proto(struct mux_proto_list *list)
Willy Tarreau2386be62017-09-21 19:40:52 +0200913{
914 LIST_DEL(&list->list);
915 LIST_INIT(&list->list);
916}
917
Christopher Faulete15c6c42018-08-08 10:21:56 +0200918static inline struct mux_proto_list *get_mux_proto(const struct ist proto)
Christopher Faulet98d9fe22018-04-10 14:37:32 +0200919{
920 struct mux_proto_list *item;
Christopher Faulet98d9fe22018-04-10 14:37:32 +0200921
922 list_for_each_entry(item, &mux_proto_list.list, list) {
923 if (isteq(proto, item->token))
924 return item;
925 }
926 return NULL;
927}
928
929/* Lists the known proto mux on <out> */
930static inline void list_mux_proto(FILE *out)
931{
932 struct mux_proto_list *item;
933 struct ist proto;
934 char *mode, *side;
935
Christopher Faulet9c9ef032018-08-08 10:25:57 +0200936 fprintf(out, "Available multiplexer protocols :\n"
937 "(protocols markes as <default> cannot be specified using 'proto' keyword)\n");
Christopher Faulet98d9fe22018-04-10 14:37:32 +0200938 list_for_each_entry(item, &mux_proto_list.list, list) {
939 proto = item->token;
940
941 if (item->mode == PROTO_MODE_ANY)
942 mode = "TCP|HTTP";
943 else if (item->mode == PROTO_MODE_TCP)
944 mode = "TCP";
945 else if (item->mode == PROTO_MODE_HTTP)
946 mode = "HTTP";
947 else
948 mode = "NONE";
949
950 if (item->side == PROTO_SIDE_BOTH)
951 side = "FE|BE";
952 else if (item->side == PROTO_SIDE_FE)
953 side = "FE";
954 else if (item->side == PROTO_SIDE_BE)
955 side = "BE";
956 else
957 side = "NONE";
958
959 fprintf(out, " %15s : mode=%-10s side=%s\n",
Christopher Faulet9c9ef032018-08-08 10:25:57 +0200960 (proto.len ? proto.ptr : "<default>"), mode, side);
Christopher Faulet98d9fe22018-04-10 14:37:32 +0200961 }
962}
963
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200964/* returns the first mux in the list matching the exact same <mux_proto> and
965 * compatible with the <proto_side> (FE or BE) and the <proto_mode> (TCP or
966 * HTTP). <mux_proto> can be empty. Will fall back to the first compatible mux
967 * with exactly the same <proto_mode> or with an empty name. May return
968 * null if the code improperly registered the default mux to use as a fallback.
Willy Tarreau2386be62017-09-21 19:40:52 +0200969 */
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200970static inline const struct mux_ops *conn_get_best_mux(struct connection *conn,
971 const struct ist mux_proto,
972 int proto_side, int proto_mode)
Willy Tarreau2386be62017-09-21 19:40:52 +0200973{
Christopher Faulet32f61c02018-04-10 14:33:41 +0200974 struct mux_proto_list *item;
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200975 struct mux_proto_list *fallback = NULL;
Willy Tarreau2386be62017-09-21 19:40:52 +0200976
Christopher Faulet32f61c02018-04-10 14:33:41 +0200977 list_for_each_entry(item, &mux_proto_list.list, list) {
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200978 if (!(item->side & proto_side) || !(item->mode & proto_mode))
Willy Tarreau2386be62017-09-21 19:40:52 +0200979 continue;
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200980 if (istlen(mux_proto) && isteq(mux_proto, item->token))
Willy Tarreau2386be62017-09-21 19:40:52 +0200981 return item->mux;
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200982 else if (!istlen(item->token)) {
983 if (!fallback || (item->mode == proto_mode && fallback->mode != proto_mode))
984 fallback = item;
985 }
Willy Tarreau2386be62017-09-21 19:40:52 +0200986 }
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200987 return (fallback ? fallback->mux : NULL);
988
Willy Tarreau2386be62017-09-21 19:40:52 +0200989}
990
Willy Tarreau57f81852018-09-06 14:52:21 +0200991/* returns 0 if the connection is valid and is a frontend connection, otherwise
992 * returns 1 indicating it's a backend connection. And uninitialized connection
993 * also returns 1 to better handle the usage in the middle of initialization.
994 */
995static inline int conn_is_back(const struct connection *conn)
996{
997 return !objt_listener(conn->target);
998}
999
Willy Tarreau6ac98ac2018-09-06 11:48:44 +02001000/* returns a pointer to the proxy associated with this connection. For a front
1001 * connection it returns a pointer to the frontend ; for a back connection, it
1002 * returns a pointer to the backend.
1003 */
1004static inline struct proxy *conn_get_proxy(const struct connection *conn)
1005{
1006 struct listener *l;
1007 struct server *s;
1008
1009 /* check if it's a frontend connection */
1010 l = objt_listener(conn->target);
1011 if (l)
1012 return l->bind_conf->frontend;
1013
1014 /* check if it's a backend connection */
1015 s = objt_server(conn->target);
1016 if (s)
1017 return s->proxy;
1018
1019 return objt_proxy(conn->target);
1020}
1021
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001022/* installs the best mux for incoming connection <conn> using the upper context
1023 * <ctx>. If the mux protocol is forced, we use it to find the best
1024 * mux. Otherwise we use the ALPN name, if any. Returns < 0 on error.
Willy Tarreau2386be62017-09-21 19:40:52 +02001025 */
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001026static inline int conn_install_mux_fe(struct connection *conn, void *ctx)
Willy Tarreau2386be62017-09-21 19:40:52 +02001027{
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001028 struct bind_conf *bind_conf = objt_listener(conn->target)->bind_conf;
1029 const struct mux_ops *mux_ops;
Willy Tarreau2386be62017-09-21 19:40:52 +02001030
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001031 if (bind_conf->mux_proto)
1032 mux_ops = bind_conf->mux_proto->mux;
1033 else {
1034 struct ist mux_proto;
1035 const char *alpn_str = NULL;
1036 int alpn_len = 0;
1037 int mode = (1 << (bind_conf->frontend->mode == PR_MODE_HTTP));
Willy Tarreau2386be62017-09-21 19:40:52 +02001038
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001039 conn_get_alpn(conn, &alpn_str, &alpn_len);
1040 mux_proto = ist2(alpn_str, alpn_len);
1041 mux_ops = conn_get_best_mux(conn, mux_proto, PROTO_SIDE_FE, mode);
1042 if (!mux_ops)
1043 return -1;
1044 }
1045 return conn_install_mux(conn, mux_ops, ctx);
Willy Tarreau2386be62017-09-21 19:40:52 +02001046}
1047
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001048/* installs the best mux for outgoing connection <conn> using the upper context
1049 * <ctx>. If the mux protocol is forced, we use it to find the best mux. Returns
Willy Tarreau2e0b2b52017-09-15 06:59:55 +02001050 * < 0 on error.
Willy Tarreau2386be62017-09-21 19:40:52 +02001051 */
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001052static inline int conn_install_mux_be(struct connection *conn, void *ctx)
Willy Tarreau2386be62017-09-21 19:40:52 +02001053{
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001054 struct server *srv = objt_server(conn->target);
Willy Tarreau287527a2018-08-08 18:40:44 +02001055 struct proxy *prx = objt_proxy(conn->target);
Willy Tarreau2386be62017-09-21 19:40:52 +02001056 const struct mux_ops *mux_ops;
1057
Willy Tarreau287527a2018-08-08 18:40:44 +02001058 if (srv)
1059 prx = srv->proxy;
1060
1061 if (!prx) // target must be either proxy or server
1062 return -1;
1063
1064 if (srv && srv->mux_proto)
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001065 mux_ops = srv->mux_proto->mux;
1066 else {
1067 int mode;
1068
Willy Tarreau287527a2018-08-08 18:40:44 +02001069 mode = (1 << (prx->mode == PR_MODE_HTTP));
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001070 mux_ops = conn_get_best_mux(conn, ist(NULL), PROTO_SIDE_BE, mode);
1071 if (!mux_ops)
1072 return -1;
1073 }
Willy Tarreau2e0b2b52017-09-15 06:59:55 +02001074 return conn_install_mux(conn, mux_ops, ctx);
Willy Tarreau2386be62017-09-21 19:40:52 +02001075}
1076
Willy Tarreau59f98392012-07-06 14:13:49 +02001077#endif /* _PROTO_CONNECTION_H */
1078
1079/*
1080 * Local variables:
1081 * c-indent-level: 8
1082 * c-basic-offset: 8
1083 * End:
1084 */