blob: b0771cbf9db8f8577d43de56316078e9215fd5e1 [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 Houchard351411f2018-12-27 17:20:54 +010032#include <proto/session.h>
Olivier Houchard6ff20392018-07-17 18:46:31 +020033#include <proto/task.h>
Willy Tarreau59f98392012-07-06 14:13:49 +020034
Willy Tarreaubafbe012017-11-24 17:34:44 +010035extern struct pool_head *pool_head_connection;
36extern struct pool_head *pool_head_connstream;
Willy Tarreauff5d57b2019-07-17 18:37:02 +020037extern struct pool_head *pool_head_sockaddr;
Geoff Simmons7185b782019-08-27 18:31:16 +020038extern struct pool_head *pool_head_authority;
Willy Tarreau13e14102016-12-22 20:25:26 +010039extern struct xprt_ops *registered_xprt[XPRT_ENTRIES];
Christopher Faulet32f61c02018-04-10 14:33:41 +020040extern struct mux_proto_list mux_proto_list;
Willy Tarreauf2943dc2012-10-26 20:10:28 +020041
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 Tarreau4970e5a2019-12-27 10:40:21 +010046int conn_fd_check(struct connection *conn);
Willy Tarreau59f98392012-07-06 14:13:49 +020047
Willy Tarreau22cda212012-08-31 17:43:29 +020048/* receive a PROXY protocol header over a connection */
49int conn_recv_proxy(struct connection *conn, int flag);
David Safb76832014-05-08 23:42:08 -040050int make_proxy_line(char *buf, int buf_len, struct server *srv, struct connection *remote);
51int make_proxy_line_v1(char *buf, int buf_len, struct sockaddr_storage *src, struct sockaddr_storage *dst);
52int make_proxy_line_v2(char *buf, int buf_len, struct server *srv, struct connection *remote);
Willy Tarreau22cda212012-08-31 17:43:29 +020053
Willy Tarreauee1a6fc2020-01-17 07:52:13 +010054int conn_subscribe(struct connection *conn, void *xprt_ctx, int event_type, struct wait_event *es);
55int conn_unsubscribe(struct connection *conn, void *xprt_ctx, int event_type, struct wait_event *es);
Olivier Houchard83a0cd82018-09-28 17:57:58 +020056
Bertrand Jacquin93b227d2016-06-04 15:11:10 +010057/* receive a NetScaler Client IP insertion header over a connection */
58int conn_recv_netscaler_cip(struct connection *conn, int flag);
59
Willy Tarreauff3e6482015-03-12 23:56:52 +010060/* raw send() directly on the socket */
61int conn_sock_send(struct connection *conn, const void *buf, int len, int flags);
62
Willy Tarreaud85c4852015-03-13 00:40:28 +010063/* drains any pending bytes from the socket */
64int conn_sock_drain(struct connection *conn);
65
Alexander Liu2a54bb72019-05-22 19:44:48 +080066/* scoks4 proxy handshake */
67int conn_send_socks4_proxy_request(struct connection *conn);
68int conn_recv_socks4_proxy_response(struct connection *conn);
69
Olivier Houchard4be71902019-07-11 15:49:00 +020070__decl_hathreads(extern HA_SPINLOCK_T toremove_lock[MAX_THREADS]);
71
Willy Tarreaud02cdd22013-12-15 10:23:20 +010072/* returns true is the transport layer is ready */
Willy Tarreauaad69382014-01-23 14:21:42 +010073static inline int conn_xprt_ready(const struct connection *conn)
Willy Tarreaud02cdd22013-12-15 10:23:20 +010074{
Willy Tarreauaad69382014-01-23 14:21:42 +010075 return (conn->flags & CO_FL_XPRT_READY);
Willy Tarreaud02cdd22013-12-15 10:23:20 +010076}
77
78/* returns true is the control layer is ready */
Willy Tarreau3c728722014-01-23 13:50:42 +010079static inline int conn_ctrl_ready(const struct connection *conn)
Willy Tarreaud02cdd22013-12-15 10:23:20 +010080{
81 return (conn->flags & CO_FL_CTRL_READY);
82}
83
Willy Tarreauf79c8172013-10-21 16:30:56 +020084/* Calls the init() function of the transport layer if any and if not done yet,
85 * and sets the CO_FL_XPRT_READY flag to indicate it was properly initialized.
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020086 * Returns <0 in case of error.
Willy Tarreau15678ef2012-08-31 13:54:11 +020087 */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020088static inline int conn_xprt_init(struct connection *conn)
Willy Tarreau15678ef2012-08-31 13:54:11 +020089{
Willy Tarreauf79c8172013-10-21 16:30:56 +020090 int ret = 0;
91
Willy Tarreauaad69382014-01-23 14:21:42 +010092 if (!conn_xprt_ready(conn) && conn->xprt && conn->xprt->init)
Olivier Houcharde179d0e2019-03-21 18:27:17 +010093 ret = conn->xprt->init(conn, &conn->xprt_ctx);
Willy Tarreauf79c8172013-10-21 16:30:56 +020094
95 if (ret >= 0)
96 conn->flags |= CO_FL_XPRT_READY;
97
98 return ret;
Willy Tarreau15678ef2012-08-31 13:54:11 +020099}
100
Willy Tarreauf79c8172013-10-21 16:30:56 +0200101/* Calls the close() function of the transport layer if any and if not done
102 * yet, and clears the CO_FL_XPRT_READY flag. However this is not done if the
103 * CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the
104 * transport layer very late if needed.
Willy Tarreau6c03a642012-10-12 17:00:05 +0200105 */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +0200106static inline void conn_xprt_close(struct connection *conn)
Willy Tarreau8b117082012-08-06 15:06:49 +0200107{
Willy Tarreauf79c8172013-10-21 16:30:56 +0200108 if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_XPRT_TRACKED)) == CO_FL_XPRT_READY) {
Willy Tarreauaad69382014-01-23 14:21:42 +0100109 if (conn->xprt->close)
Olivier Houcharde179d0e2019-03-21 18:27:17 +0100110 conn->xprt->close(conn, conn->xprt_ctx);
Olivier Houchard478281f2019-05-13 19:10:46 +0200111 conn->xprt_ctx = NULL;
Willy Tarreauf79c8172013-10-21 16:30:56 +0200112 conn->flags &= ~CO_FL_XPRT_READY;
113 }
114}
115
116/* Initializes the connection's control layer which essentially consists in
117 * registering the file descriptor for polling and setting the CO_FL_CTRL_READY
Willy Tarreau3c728722014-01-23 13:50:42 +0100118 * flag. The caller is responsible for ensuring that the control layer is
119 * already assigned to the connection prior to the call.
Willy Tarreauf79c8172013-10-21 16:30:56 +0200120 */
121static inline void conn_ctrl_init(struct connection *conn)
122{
Willy Tarreau3c728722014-01-23 13:50:42 +0100123 if (!conn_ctrl_ready(conn)) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200124 int fd = conn->handle.fd;
Willy Tarreauf79c8172013-10-21 16:30:56 +0200125
Willy Tarreaua9786b62018-01-25 07:22:13 +0100126 fd_insert(fd, conn, conn_fd_handler, tid_bit);
Willy Tarreauf79c8172013-10-21 16:30:56 +0200127 conn->flags |= CO_FL_CTRL_READY;
Willy Tarreau6c03a642012-10-12 17:00:05 +0200128 }
Willy Tarreau8b117082012-08-06 15:06:49 +0200129}
130
Willy Tarreauf79c8172013-10-21 16:30:56 +0200131/* Deletes the FD if the transport layer is already gone. Once done,
132 * it then removes the CO_FL_CTRL_READY flag.
133 */
134static inline void conn_ctrl_close(struct connection *conn)
135{
136 if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_CTRL_READY)) == CO_FL_CTRL_READY) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200137 fd_delete(conn->handle.fd);
Willy Tarreau6a0a80a2017-10-05 17:43:39 +0200138 conn->handle.fd = DEAD_FD_MAGIC;
Willy Tarreauf79c8172013-10-21 16:30:56 +0200139 conn->flags &= ~CO_FL_CTRL_READY;
140 }
141}
142
Willy Tarreau2b199c92012-11-23 17:32:21 +0100143/* If the connection still has a transport layer, then call its close() function
144 * if any, and delete the file descriptor if a control layer is set. This is
145 * used to close everything at once and atomically. However this is not done if
146 * the CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the
147 * transport layer very late if needed.
148 */
149static inline void conn_full_close(struct connection *conn)
150{
Willy Tarreauf79c8172013-10-21 16:30:56 +0200151 conn_xprt_close(conn);
152 conn_ctrl_close(conn);
153}
154
Willy Tarreaudc42acd2017-10-05 18:09:20 +0200155/* stop tracking a connection, allowing conn_full_close() to always
156 * succeed.
157 */
158static inline void conn_stop_tracking(struct connection *conn)
159{
160 conn->flags &= ~CO_FL_XPRT_TRACKED;
161}
162
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200163/* Update polling on connection <c>'s file descriptor depending on its current
Willy Tarreau3381bf82020-01-17 17:39:35 +0100164 * state as reported in the connection's CO_FL_XPRT_* flags. The connection
165 * flags are updated with the new flags at the end of the operation. Polling
166 * is totally disabled if an error was reported.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200167 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200168void conn_update_xprt_polling(struct connection *c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200169
Olivier Houchard03abf2d2019-05-28 10:12:02 +0200170/* Automatically updates polling on connection <c> depending on the XPRT flags.
171 * It does nothing if CO_FL_WILL_UPDATE is present, indicating that an upper
172 * caller is going to do it again later.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200173 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200174static inline void conn_cond_update_xprt_polling(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200175{
Willy Tarreau916e12d2017-10-25 09:22:43 +0200176 if (!(c->flags & CO_FL_WILL_UPDATE))
Willy Tarreau3381bf82020-01-17 17:39:35 +0100177 conn_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200178}
179
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100180/* Stop all polling on the fd. This might be used when an error is encountered
Willy Tarreau916e12d2017-10-25 09:22:43 +0200181 * for example. It does not propage the change to the fd layer if
182 * CO_FL_WILL_UPDATE is present, indicating that an upper caller is going to do
183 * it later.
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100184 */
185static inline void conn_stop_polling(struct connection *c)
186{
Willy Tarreau3381bf82020-01-17 17:39:35 +0100187 c->flags &= ~(CO_FL_XPRT_RD_ENA | CO_FL_XPRT_WR_ENA);
Willy Tarreau916e12d2017-10-25 09:22:43 +0200188 if (!(c->flags & CO_FL_WILL_UPDATE) && conn_ctrl_ready(c))
Willy Tarreau585744b2017-08-24 14:31:19 +0200189 fd_stop_both(c->handle.fd);
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100190}
191
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200192/* Automatically update polling on connection <c> depending on the XPRT and
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200193 * SOCK flags, and on whether a handshake is in progress or not. This may be
194 * called at any moment when there is a doubt about the effectiveness of the
195 * polling state, for instance when entering or leaving the handshake state.
Willy Tarreau916e12d2017-10-25 09:22:43 +0200196 * It does nothing if CO_FL_WILL_UPDATE is present, indicating that an upper
197 * caller is going to do it again later.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200198 */
199static inline void conn_cond_update_polling(struct connection *c)
200{
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100201 if (unlikely(c->flags & CO_FL_ERROR))
202 conn_stop_polling(c);
Willy Tarreau3381bf82020-01-17 17:39:35 +0100203 else if (!(c->flags & CO_FL_WILL_UPDATE))
204 conn_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200205}
206
207/***** Event manipulation primitives for use by DATA I/O callbacks *****/
208/* The __conn_* versions do not propagate to lower layers and are only meant
209 * to be used by handlers called by the connection handler. The other ones
210 * may be used anywhere.
211 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200212static inline void __conn_xprt_want_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200213{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200214 c->flags |= CO_FL_XPRT_RD_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200215}
216
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200217static inline void __conn_xprt_stop_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200218{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200219 c->flags &= ~CO_FL_XPRT_RD_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200220}
221
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200222static inline void __conn_xprt_want_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200223{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200224 c->flags |= CO_FL_XPRT_WR_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200225}
226
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200227static inline void __conn_xprt_stop_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200228{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200229 c->flags &= ~CO_FL_XPRT_WR_ENA;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200230}
231
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200232static inline void __conn_xprt_stop_both(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200233{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200234 c->flags &= ~(CO_FL_XPRT_WR_ENA | CO_FL_XPRT_RD_ENA);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200235}
236
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200237static inline void conn_xprt_want_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200238{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200239 __conn_xprt_want_recv(c);
240 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200241}
242
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200243static inline void conn_xprt_stop_recv(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200244{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200245 __conn_xprt_stop_recv(c);
246 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200247}
248
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200249static inline void conn_xprt_want_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200250{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200251 __conn_xprt_want_send(c);
252 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200253}
254
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200255static inline void conn_xprt_stop_send(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200256{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200257 __conn_xprt_stop_send(c);
258 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200259}
260
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200261static inline void conn_xprt_stop_both(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200262{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200263 __conn_xprt_stop_both(c);
264 conn_cond_update_xprt_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200265}
266
Willy Tarreau7b271b22017-10-25 09:59:22 +0200267/* read shutdown, called from the rcv_buf/rcv_pipe handlers when
268 * detecting an end of connection.
269 */
Willy Tarreau3af56a92012-08-20 16:55:48 +0200270static inline void conn_sock_read0(struct connection *c)
271{
272 c->flags |= CO_FL_SOCK_RD_SH;
Olivier Houchard03abf2d2019-05-28 10:12:02 +0200273 __conn_xprt_stop_recv(c);
Willy Tarreauad38ace2013-12-15 14:19:38 +0100274 /* we don't risk keeping ports unusable if we found the
275 * zero from the other side.
276 */
Willy Tarreau3c728722014-01-23 13:50:42 +0100277 if (conn_ctrl_ready(c))
Willy Tarreau585744b2017-08-24 14:31:19 +0200278 fdtab[c->handle.fd].linger_risk = 0;
Willy Tarreau3af56a92012-08-20 16:55:48 +0200279}
280
Willy Tarreau7b271b22017-10-25 09:59:22 +0200281/* write shutdown, indication that the upper layer is not willing to send
Willy Tarreaua48c1412017-12-22 18:46:33 +0100282 * anything anymore and wants to close after pending data are sent. The
283 * <clean> argument will allow not to perform the socket layer shutdown if
284 * equal to 0.
Willy Tarreau7b271b22017-10-25 09:59:22 +0200285 */
Willy Tarreaua48c1412017-12-22 18:46:33 +0100286static inline void conn_sock_shutw(struct connection *c, int clean)
Willy Tarreau3af56a92012-08-20 16:55:48 +0200287{
288 c->flags |= CO_FL_SOCK_WR_SH;
Olivier Houchard03abf2d2019-05-28 10:12:02 +0200289 __conn_xprt_stop_send(c);
290 conn_cond_update_xprt_polling(c);
Willy Tarreau7b271b22017-10-25 09:59:22 +0200291
Willy Tarreaua48c1412017-12-22 18:46:33 +0100292 /* don't perform a clean shutdown if we're going to reset or
293 * if the shutr was already received.
294 */
Olivier Houchard6c7e96a2019-07-02 16:35:18 +0200295 if (conn_ctrl_ready(c) && !(c->flags & CO_FL_SOCK_RD_SH) && clean)
Willy Tarreau585744b2017-08-24 14:31:19 +0200296 shutdown(c->handle.fd, SHUT_WR);
Willy Tarreau3af56a92012-08-20 16:55:48 +0200297}
298
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200299static inline void conn_xprt_shutw(struct connection *c)
Willy Tarreau3af56a92012-08-20 16:55:48 +0200300{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200301 __conn_xprt_stop_send(c);
Willy Tarreau729c69f2015-03-12 22:51:10 +0100302
303 /* clean data-layer shutdown */
304 if (c->xprt && c->xprt->shutw)
Olivier Houcharde179d0e2019-03-21 18:27:17 +0100305 c->xprt->shutw(c, c->xprt_ctx, 1);
Willy Tarreau729c69f2015-03-12 22:51:10 +0100306}
307
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200308static inline void conn_xprt_shutw_hard(struct connection *c)
Willy Tarreau729c69f2015-03-12 22:51:10 +0100309{
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200310 __conn_xprt_stop_send(c);
Willy Tarreau729c69f2015-03-12 22:51:10 +0100311
312 /* unclean data-layer shutdown */
313 if (c->xprt && c->xprt->shutw)
Olivier Houcharde179d0e2019-03-21 18:27:17 +0100314 c->xprt->shutw(c, c->xprt_ctx, 0);
Willy Tarreau3af56a92012-08-20 16:55:48 +0200315}
316
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200317/* shut read */
318static inline void cs_shutr(struct conn_stream *cs, enum cs_shr_mode mode)
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200319{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200320
321 /* clean data-layer shutdown */
322 if (cs->conn->mux && cs->conn->mux->shutr)
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200323 cs->conn->mux->shutr(cs, mode);
324 cs->flags |= (mode == CS_SHR_DRAIN) ? CS_FL_SHRD : CS_FL_SHRR;
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200325}
326
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200327/* shut write */
328static inline void cs_shutw(struct conn_stream *cs, enum cs_shw_mode mode)
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200329{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200330
331 /* clean data-layer shutdown */
332 if (cs->conn->mux && cs->conn->mux->shutw)
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200333 cs->conn->mux->shutw(cs, mode);
334 cs->flags |= (mode == CS_SHW_NORMAL) ? CS_FL_SHWN : CS_FL_SHWS;
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200335}
336
Willy Tarreau6978db32017-10-05 18:19:43 +0200337/* completely close a conn_stream (but do not detach it) */
338static inline void cs_close(struct conn_stream *cs)
339{
340 cs_shutw(cs, CS_SHW_SILENT);
341 cs_shutr(cs, CS_SHR_RESET);
342 cs->flags = CS_FL_NONE;
343}
344
Willy Tarreaue9f43012018-12-19 17:59:30 +0100345/* sets CS_FL_ERROR or CS_FL_ERR_PENDING on the cs */
346static inline void cs_set_error(struct conn_stream *cs)
347{
348 if (cs->flags & CS_FL_EOS)
349 cs->flags |= CS_FL_ERROR;
350 else
Willy Tarreau7bb39d72019-06-03 14:23:33 +0200351 cs->flags |= CS_FL_ERR_PENDING;
Willy Tarreaue9f43012018-12-19 17:59:30 +0100352}
353
Willy Tarreau3af56a92012-08-20 16:55:48 +0200354/* detect sock->data read0 transition */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200355static inline int conn_xprt_read0_pending(struct connection *c)
Willy Tarreau3af56a92012-08-20 16:55:48 +0200356{
Willy Tarreau54e917c2017-08-30 07:35:35 +0200357 return (c->flags & CO_FL_SOCK_RD_SH) != 0;
Willy Tarreau3af56a92012-08-20 16:55:48 +0200358}
359
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200360/* prepares a connection to work with protocol <proto> and transport <xprt>.
Willy Tarreau53a47662017-08-28 10:53:00 +0200361 * The transport's is initialized as well, and the mux and its context are
Willy Tarreaube373152018-09-06 11:45:30 +0200362 * cleared. The target is not reinitialized and it is recommended that it is
363 * set prior to calling this function so that the function may make use of it
364 * in the future to refine the mux choice if needed.
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200365 */
366static inline void conn_prepare(struct connection *conn, const struct protocol *proto, const struct xprt_ops *xprt)
367{
368 conn->ctrl = proto;
369 conn->xprt = xprt;
Willy Tarreau53a47662017-08-28 10:53:00 +0200370 conn->mux = NULL;
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200371 conn->xprt_ctx = NULL;
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100372 conn->ctx = NULL;
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200373}
374
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200375/*
376 * Initializes all required fields for a new conn_strema.
377 */
378static inline void cs_init(struct conn_stream *cs, struct connection *conn)
379{
380 cs->obj_type = OBJ_TYPE_CS;
381 cs->flags = CS_FL_NONE;
382 cs->conn = conn;
383}
384
Willy Tarreaud0155772013-10-14 17:10:08 +0200385/* Initializes all required fields for a new connection. Note that it does the
386 * minimum acceptable initialization for a connection that already exists and
387 * is about to be reused. It also leaves the addresses untouched, which makes
388 * it usable across connection retries to reset a connection to a known state.
389 */
390static inline void conn_init(struct connection *conn)
391{
392 conn->obj_type = OBJ_TYPE_CONN;
393 conn->flags = CO_FL_NONE;
Willy Tarreau53a47662017-08-28 10:53:00 +0200394 conn->mux = NULL;
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100395 conn->ctx = NULL;
Willy Tarreaud0155772013-10-14 17:10:08 +0200396 conn->owner = NULL;
Willy Tarreaub8020ce2013-10-24 21:10:08 +0200397 conn->send_proxy_ofs = 0;
Willy Tarreau585744b2017-08-24 14:31:19 +0200398 conn->handle.fd = DEAD_FD_MAGIC;
Willy Tarreaud0155772013-10-14 17:10:08 +0200399 conn->err_code = CO_ER_NONE;
400 conn->target = NULL;
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200401 conn->xprt_done_cb = NULL;
Willy Tarreau436d3332017-10-08 11:16:46 +0200402 conn->destroy_cb = NULL;
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100403 conn->proxy_netns = NULL;
Willy Tarreaud75d40e2015-08-04 17:25:58 +0200404 LIST_INIT(&conn->list);
Olivier Houchard131fd892018-11-13 16:44:31 +0100405 LIST_INIT(&conn->session_list);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100406 conn->subs = NULL;
Olivier Houchard006e3102018-12-10 18:30:32 +0100407 conn->idle_time = 0;
Willy Tarreaue71fca82019-07-17 19:06:58 +0200408 conn->src = NULL;
409 conn->dst = NULL;
Geoff Simmons7185b782019-08-27 18:31:16 +0200410 conn->proxy_authority = NULL;
Willy Tarreaud0155772013-10-14 17:10:08 +0200411}
412
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200413/* sets <owner> as the connection's owner */
Willy Tarreau436d3332017-10-08 11:16:46 +0200414static inline void conn_set_owner(struct connection *conn, void *owner, void (*cb)(struct connection *))
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200415{
416 conn->owner = owner;
Willy Tarreau436d3332017-10-08 11:16:46 +0200417 conn->destroy_cb = cb;
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200418}
419
420/* registers <cb> as a callback to notify for transport's readiness or failure */
421static inline void conn_set_xprt_done_cb(struct connection *conn, int (*cb)(struct connection *))
422{
423 conn->xprt_done_cb = cb;
424}
425
426/* unregisters the callback to notify for transport's readiness or failure */
427static inline void conn_clear_xprt_done_cb(struct connection *conn)
428{
429 conn->xprt_done_cb = NULL;
430}
431
Willy Tarreauff5d57b2019-07-17 18:37:02 +0200432/* Allocates a struct sockaddr from the pool if needed, assigns it to *sap and
433 * returns it. If <sap> is NULL, the address is always allocated and returned.
434 * if <sap> is non-null, an address will only be allocated if it points to a
435 * non-null pointer. In this case the allocated address will be assigned there.
436 * In both situations the new pointer is returned.
437 */
438static inline struct sockaddr_storage *sockaddr_alloc(struct sockaddr_storage **sap)
439{
440 struct sockaddr_storage *sa;
441
442 if (sap && *sap)
443 return *sap;
444
445 sa = pool_alloc(pool_head_sockaddr);
446 if (sap)
447 *sap = sa;
448 return sa;
449}
450
451/* Releases the struct sockaddr potentially pointed to by <sap> to the pool. It
452 * may be NULL or may point to NULL. If <sap> is not NULL, a NULL is placed
453 * there.
454 */
455static inline void sockaddr_free(struct sockaddr_storage **sap)
456{
457 if (!sap)
458 return;
459 pool_free(pool_head_sockaddr, *sap);
460 *sap = NULL;
461}
462
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200463/* Tries to allocate a new connection and initialized its main fields. The
464 * connection is returned on success, NULL on failure. The connection must
Willy Tarreaubafbe012017-11-24 17:34:44 +0100465 * be released using pool_free() or conn_free().
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200466 */
467static inline struct connection *conn_new()
468{
469 struct connection *conn;
470
Willy Tarreaubafbe012017-11-24 17:34:44 +0100471 conn = pool_alloc(pool_head_connection);
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200472 if (likely(conn != NULL))
473 conn_init(conn);
474 return conn;
475}
476
Willy Tarreau5e1cc5e2018-03-02 10:43:58 +0100477/* Releases a conn_stream previously allocated by cs_new(), as well as any
478 * buffer it would still hold.
479 */
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200480static inline void cs_free(struct conn_stream *cs)
481{
Willy Tarreau5e1cc5e2018-03-02 10:43:58 +0100482
Willy Tarreaubafbe012017-11-24 17:34:44 +0100483 pool_free(pool_head_connstream, cs);
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200484}
485
486/* Tries to allocate a new conn_stream and initialize its main fields. If
487 * <conn> is NULL, then a new connection is allocated on the fly, initialized,
488 * and assigned to cs->conn ; this connection will then have to be released
Willy Tarreaubafbe012017-11-24 17:34:44 +0100489 * using pool_free() or conn_free(). The conn_stream is initialized and added
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200490 * to the mux's stream list on success, then returned. On failure, nothing is
491 * allocated and NULL is returned.
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200492 */
493static inline struct conn_stream *cs_new(struct connection *conn)
494{
495 struct conn_stream *cs;
496
Willy Tarreaubafbe012017-11-24 17:34:44 +0100497 cs = pool_alloc(pool_head_connstream);
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200498 if (!likely(cs))
499 return NULL;
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200500
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200501 if (!conn) {
502 conn = conn_new();
503 if (!likely(conn)) {
504 cs_free(cs);
505 return NULL;
506 }
507 conn_init(conn);
508 }
509
510 cs_init(cs, conn);
511 return cs;
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200512}
513
Willy Tarreaufafd3982018-11-18 21:29:20 +0100514/* Retrieves any valid conn_stream from this connection, preferably the first
515 * valid one. The purpose is to be able to figure one other end of a private
516 * connection for purposes like source binding or proxy protocol header
517 * emission. In such cases, any conn_stream is expected to be valid so the
518 * mux is encouraged to return the first one it finds. If the connection has
519 * no mux or the mux has no get_first_cs() method or the mux has no valid
520 * conn_stream, NULL is returned. The output pointer is purposely marked
521 * const to discourage the caller from modifying anything there.
522 */
523static inline const struct conn_stream *cs_get_first(const struct connection *conn)
524{
525 if (!conn || !conn->mux || !conn->mux->get_first_cs)
526 return NULL;
527 return conn->mux->get_first_cs(conn);
528}
529
Olivier Houchard1fddc9b2018-10-21 00:32:01 +0200530static inline void conn_force_unsubscribe(struct connection *conn)
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200531{
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100532 if (!conn->subs)
533 return;
534 conn->subs->events = 0;
535 conn->subs = NULL;
Olivier Houchard1fddc9b2018-10-21 00:32:01 +0200536}
537
538/* Releases a connection previously allocated by conn_new() */
539static inline void conn_free(struct connection *conn)
540{
Olivier Houchard00cf70f2018-11-30 17:24:55 +0100541 /* Remove ourself from the session's connections list, if any. */
Olivier Houcharda4d4fdf2018-12-14 19:27:06 +0100542 if (!LIST_ISEMPTY(&conn->session_list)) {
543 struct session *sess = conn->owner;
Olivier Houcharda2dbeb22018-12-28 18:50:57 +0100544 if (conn->flags & CO_FL_SESS_IDLE)
545 sess->idle_conns--;
Olivier Houchard351411f2018-12-27 17:20:54 +0100546 session_unown_conn(sess, conn);
Olivier Houcharda4d4fdf2018-12-14 19:27:06 +0100547 }
Willy Tarreau94031d32018-12-19 14:36:29 +0100548
Willy Tarreaue71fca82019-07-17 19:06:58 +0200549 sockaddr_free(&conn->src);
550 sockaddr_free(&conn->dst);
551
Geoff Simmons7185b782019-08-27 18:31:16 +0200552 if (conn->proxy_authority != NULL) {
553 pool_free(pool_head_authority, conn->proxy_authority);
554 conn->proxy_authority = NULL;
555 }
556
Willy Tarreau94031d32018-12-19 14:36:29 +0100557 /* By convention we always place a NULL where the ctx points to if the
558 * mux is null. It may have been used to store the connection as a
559 * stream_interface's end point for example.
Olivier Houchard201b9f42018-11-21 00:16:29 +0100560 */
Willy Tarreau94031d32018-12-19 14:36:29 +0100561 if (conn->ctx != NULL && conn->mux == NULL)
562 *(void **)conn->ctx = NULL;
Olivier Houchard201b9f42018-11-21 00:16:29 +0100563
Olivier Houchard006e3102018-12-10 18:30:32 +0100564 /* The connection is currently in the server's idle list, so tell it
565 * there's one less connection available in that list.
566 */
567 if (conn->idle_time > 0) {
568 struct server *srv = __objt_server(conn->target);
Olivier Houchard237985b2019-03-13 18:52:21 +0100569 _HA_ATOMIC_SUB(&srv->curr_idle_conns, 1);
Olivier Houchardf1314812019-02-18 16:41:17 +0100570 srv->curr_idle_thr[tid]--;
Olivier Houchard006e3102018-12-10 18:30:32 +0100571 }
Olivier Houchard201b9f42018-11-21 00:16:29 +0100572
Olivier Houchard1fddc9b2018-10-21 00:32:01 +0200573 conn_force_unsubscribe(conn);
Olivier Houchard4be71902019-07-11 15:49:00 +0200574 HA_SPIN_LOCK(OTHER_LOCK, &toremove_lock[tid]);
Olivier Houchard859dc802019-08-08 15:47:21 +0200575 MT_LIST_DEL((struct mt_list *)&conn->list);
Olivier Houchard4be71902019-07-11 15:49:00 +0200576 HA_SPIN_UNLOCK(OTHER_LOCK, &toremove_lock[tid]);
Willy Tarreaubafbe012017-11-24 17:34:44 +0100577 pool_free(pool_head_connection, conn);
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200578}
579
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100580/* Release a conn_stream */
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200581static inline void cs_destroy(struct conn_stream *cs)
582{
Olivier Houchard302f9ef2018-04-13 15:50:27 +0200583 if (cs->conn->mux)
584 cs->conn->mux->detach(cs);
585 else {
586 /* It's too early to have a mux, let's just destroy
587 * the connection
588 */
589 struct connection *conn = cs->conn;
590
591 conn_stop_tracking(conn);
592 conn_full_close(conn);
593 if (conn->destroy_cb)
594 conn->destroy_cb(conn);
595 conn_free(conn);
596 }
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200597 cs_free(cs);
598}
599
Olivier Houcharde2b40b92017-09-13 18:30:23 +0200600/* Returns the conn from a cs. If cs is NULL, returns NULL */
601static inline struct connection *cs_conn(const struct conn_stream *cs)
602{
603 return cs ? cs->conn : NULL;
604}
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200605
Willy Tarreau2e34c112019-07-17 10:48:33 +0200606/* Retrieves the connection's original source address. Returns non-zero on
607 * success or zero on failure. The operation is only performed once and the
608 * address is stored in the connection for future use.
609 */
610static inline int conn_get_src(struct connection *conn)
611{
612 if (conn->flags & CO_FL_ADDR_FROM_SET)
613 return 1;
614
615 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_src)
616 return 0;
617
Willy Tarreauca79f592019-07-17 19:04:47 +0200618 if (!sockaddr_alloc(&conn->src))
619 return 0;
620
Willy Tarreau226572f2019-07-17 14:46:00 +0200621 if (conn->ctrl->get_src(conn->handle.fd, (struct sockaddr *)conn->src,
622 sizeof(*conn->src),
Willy Tarreau2e34c112019-07-17 10:48:33 +0200623 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
624 return 0;
625 conn->flags |= CO_FL_ADDR_FROM_SET;
626 return 1;
627}
628
629/* Retrieves the connection's original destination address. Returns non-zero on
630 * success or zero on failure. The operation is only performed once and the
631 * address is stored in the connection for future use.
632 */
633static inline int conn_get_dst(struct connection *conn)
634{
635 if (conn->flags & CO_FL_ADDR_TO_SET)
636 return 1;
637
638 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_dst)
639 return 0;
640
Willy Tarreauca79f592019-07-17 19:04:47 +0200641 if (!sockaddr_alloc(&conn->dst))
642 return 0;
643
Willy Tarreau226572f2019-07-17 14:46:00 +0200644 if (conn->ctrl->get_dst(conn->handle.fd, (struct sockaddr *)conn->dst,
645 sizeof(*conn->dst),
Willy Tarreau2e34c112019-07-17 10:48:33 +0200646 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
647 return 0;
648 conn->flags |= CO_FL_ADDR_TO_SET;
649 return 1;
650}
651
Willy Tarreau1a18b542018-12-11 16:37:42 +0100652/* Sets the TOS header in IPv4 and the traffic class header in IPv6 packets
653 * (as per RFC3260 #4 and BCP37 #4.2 and #5.2). The connection is tested and if
654 * it is null, nothing is done.
655 */
656static inline void conn_set_tos(const struct connection *conn, int tos)
657{
658 if (!conn || !conn_ctrl_ready(conn))
659 return;
660
661#ifdef IP_TOS
Willy Tarreau226572f2019-07-17 14:46:00 +0200662 if (conn->src->ss_family == AF_INET)
Willy Tarreau1a18b542018-12-11 16:37:42 +0100663 setsockopt(conn->handle.fd, IPPROTO_IP, IP_TOS, &tos, sizeof(tos));
664#endif
665#ifdef IPV6_TCLASS
Willy Tarreau226572f2019-07-17 14:46:00 +0200666 if (conn->src->ss_family == AF_INET6) {
667 if (IN6_IS_ADDR_V4MAPPED(&((struct sockaddr_in6 *)conn->src)->sin6_addr))
Willy Tarreau1a18b542018-12-11 16:37:42 +0100668 /* v4-mapped addresses need IP_TOS */
669 setsockopt(conn->handle.fd, IPPROTO_IP, IP_TOS, &tos, sizeof(tos));
670 else
671 setsockopt(conn->handle.fd, IPPROTO_IPV6, IPV6_TCLASS, &tos, sizeof(tos));
672 }
673#endif
674}
675
676/* Sets the netfilter mark on the connection's socket. The connection is tested
677 * and if it is null, nothing is done.
678 */
679static inline void conn_set_mark(const struct connection *conn, int mark)
680{
681 if (!conn || !conn_ctrl_ready(conn))
682 return;
683
684#ifdef SO_MARK
685 setsockopt(conn->handle.fd, SOL_SOCKET, SO_MARK, &mark, sizeof(mark));
686#endif
687}
688
689/* Sets adjust the TCP quick-ack feature on the connection's socket. The
690 * connection is tested and if it is null, nothing is done.
691 */
692static inline void conn_set_quickack(const struct connection *conn, int value)
693{
694 if (!conn || !conn_ctrl_ready(conn))
695 return;
696
697#ifdef TCP_QUICKACK
698 setsockopt(conn->handle.fd, IPPROTO_TCP, TCP_QUICKACK, &value, sizeof(value));
699#endif
700}
701
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200702/* Attaches a conn_stream to a data layer and sets the relevant callbacks */
703static inline void cs_attach(struct conn_stream *cs, void *data, const struct data_cb *data_cb)
Willy Tarreaudda5e7c2012-09-24 17:15:42 +0200704{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200705 cs->data_cb = data_cb;
706 cs->data = data;
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200707}
708
Olivier Houchardfa8aa862018-10-10 18:25:41 +0200709static inline struct wait_event *wl_set_waitcb(struct wait_event *wl, struct task *(*cb)(struct task *, void *, unsigned short), void *ctx)
Willy Tarreau83188852018-07-18 08:18:20 +0200710{
Willy Tarreau3c39a7d2019-06-14 14:42:29 +0200711 if (!wl->tasklet->process) {
712 wl->tasklet->process = cb;
713 wl->tasklet->context = ctx;
Willy Tarreau83188852018-07-18 08:18:20 +0200714 }
715 return wl;
716}
717
Willy Tarreau53a47662017-08-28 10:53:00 +0200718/* Installs the connection's mux layer for upper context <ctx>.
719 * Returns < 0 on error.
720 */
Willy Tarreau175a2bb2018-09-12 12:02:05 +0200721static inline int conn_install_mux(struct connection *conn, const struct mux_ops *mux,
Olivier Houchardf502aca2018-12-14 19:42:40 +0100722 void *ctx, struct proxy *prx, struct session *sess)
Willy Tarreau53a47662017-08-28 10:53:00 +0200723{
Willy Tarreau762475e2019-01-10 10:33:32 +0100724 int ret;
725
Willy Tarreau53a47662017-08-28 10:53:00 +0200726 conn->mux = mux;
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100727 conn->ctx = ctx;
Christopher Faulet51f73eb2019-04-08 11:22:47 +0200728 ret = mux->init ? mux->init(conn, prx, sess, &BUF_NULL) : 0;
Willy Tarreau762475e2019-01-10 10:33:32 +0100729 if (ret < 0) {
730 conn->mux = NULL;
731 conn->ctx = NULL;
732 }
733 return ret;
Willy Tarreau53a47662017-08-28 10:53:00 +0200734}
735
Willy Tarreau0af29122012-12-03 15:35:00 +0100736/* returns a human-readable error code for conn->err_code, or NULL if the code
737 * is unknown.
738 */
739static inline const char *conn_err_code_str(struct connection *c)
740{
741 switch (c->err_code) {
742 case CO_ER_NONE: return "Success";
Willy Tarreau45b34e82014-01-24 16:06:50 +0100743
744 case CO_ER_CONF_FDLIM: return "Reached configured maxconn value";
745 case CO_ER_PROC_FDLIM: return "Too many sockets on the process";
746 case CO_ER_SYS_FDLIM: return "Too many sockets on the system";
747 case CO_ER_SYS_MEMLIM: return "Out of system buffers";
748 case CO_ER_NOPROTO: return "Protocol or address family not supported";
749 case CO_ER_SOCK_ERR: return "General socket error";
750 case CO_ER_PORT_RANGE: return "Source port range exhausted";
751 case CO_ER_CANT_BIND: return "Can't bind to source address";
752 case CO_ER_FREE_PORTS: return "Out of local source ports on the system";
753 case CO_ER_ADDR_INUSE: return "Local source address already in use";
754
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100755 case CO_ER_PRX_EMPTY: return "Connection closed while waiting for PROXY protocol header";
756 case CO_ER_PRX_ABORT: return "Connection error while waiting for PROXY protocol header";
Willy Tarreau0af29122012-12-03 15:35:00 +0100757 case CO_ER_PRX_TIMEOUT: return "Timeout while waiting for PROXY protocol header";
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100758 case CO_ER_PRX_TRUNCATED: return "Truncated PROXY protocol header received";
759 case CO_ER_PRX_NOT_HDR: return "Received something which does not look like a PROXY protocol header";
760 case CO_ER_PRX_BAD_HDR: return "Received an invalid PROXY protocol header";
761 case CO_ER_PRX_BAD_PROTO: return "Received an unhandled protocol in the PROXY protocol header";
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100762
763 case CO_ER_CIP_EMPTY: return "Connection closed while waiting for NetScaler Client IP header";
764 case CO_ER_CIP_ABORT: return "Connection error while waiting for NetScaler Client IP header";
765 case CO_ER_CIP_TRUNCATED: return "Truncated NetScaler Client IP header received";
766 case CO_ER_CIP_BAD_MAGIC: return "Received an invalid NetScaler Client IP magic number";
767 case CO_ER_CIP_BAD_PROTO: return "Received an unhandled protocol in the NetScaler Client IP header";
768
Willy Tarreau20879a02012-12-03 16:32:10 +0100769 case CO_ER_SSL_EMPTY: return "Connection closed during SSL handshake";
770 case CO_ER_SSL_ABORT: return "Connection error during SSL handshake";
Willy Tarreau0af29122012-12-03 15:35:00 +0100771 case CO_ER_SSL_TIMEOUT: return "Timeout during SSL handshake";
Willy Tarreau20879a02012-12-03 16:32:10 +0100772 case CO_ER_SSL_TOO_MANY: return "Too many SSL connections";
773 case CO_ER_SSL_NO_MEM: return "Out of memory when initializing an SSL connection";
774 case CO_ER_SSL_RENEG: return "Rejected a client-initiated SSL renegociation attempt";
775 case CO_ER_SSL_CA_FAIL: return "SSL client CA chain cannot be verified";
776 case CO_ER_SSL_CRT_FAIL: return "SSL client certificate not trusted";
Willy Tarreau71d058c2017-07-26 20:09:56 +0200777 case CO_ER_SSL_MISMATCH: return "Server presented an SSL certificate different from the configured one";
778 case CO_ER_SSL_MISMATCH_SNI: return "Server presented an SSL certificate different from the expected one";
Willy Tarreau20879a02012-12-03 16:32:10 +0100779 case CO_ER_SSL_HANDSHAKE: return "SSL handshake failure";
Willy Tarreaub3966372014-04-25 18:54:29 +0200780 case CO_ER_SSL_HANDSHAKE_HB: return "SSL handshake failure after heartbeat";
Willy Tarreauf51c6982014-04-25 20:02:39 +0200781 case CO_ER_SSL_KILLED_HB: return "Stopped a TLSv1 heartbeat attack (CVE-2014-0160)";
Willy Tarreau830bf612013-12-01 20:29:58 +0100782 case CO_ER_SSL_NO_TARGET: return "Attempt to use SSL on an unknown target (internal error)";
Alexander Liu2a54bb72019-05-22 19:44:48 +0800783
784 case CO_ER_SOCKS4_SEND: return "SOCKS4 Proxy write error during handshake";
785 case CO_ER_SOCKS4_RECV: return "SOCKS4 Proxy read error during handshake";
786 case CO_ER_SOCKS4_DENY: return "SOCKS4 Proxy deny the request";
787 case CO_ER_SOCKS4_ABORT: return "SOCKS4 Proxy handshake aborted by server";
Willy Tarreau0af29122012-12-03 15:35:00 +0100788 }
789 return NULL;
790}
791
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100792static inline const char *conn_get_ctrl_name(const struct connection *conn)
793{
Willy Tarreau5e6a5b32019-04-25 18:35:49 +0200794 if (!conn || !conn_ctrl_ready(conn))
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100795 return "NONE";
796 return conn->ctrl->name;
797}
798
799static inline const char *conn_get_xprt_name(const struct connection *conn)
800{
Willy Tarreau5e6a5b32019-04-25 18:35:49 +0200801 if (!conn || !conn_xprt_ready(conn))
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100802 return "NONE";
Willy Tarreau8e0bb0a2016-11-24 16:58:12 +0100803 return conn->xprt->name;
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100804}
805
Willy Tarreau53a47662017-08-28 10:53:00 +0200806static inline const char *conn_get_mux_name(const struct connection *conn)
807{
Willy Tarreau5e6a5b32019-04-25 18:35:49 +0200808 if (!conn || !conn->mux)
Willy Tarreau53a47662017-08-28 10:53:00 +0200809 return "NONE";
810 return conn->mux->name;
811}
812
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200813static inline const char *cs_get_data_name(const struct conn_stream *cs)
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100814{
Willy Tarreau5e6a5b32019-04-25 18:35:49 +0200815 if (!cs || !cs->data_cb)
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100816 return "NONE";
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200817 return cs->data_cb->name;
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100818}
819
Willy Tarreau13e14102016-12-22 20:25:26 +0100820/* registers pointer to transport layer <id> (XPRT_*) */
821static inline void xprt_register(int id, struct xprt_ops *xprt)
822{
823 if (id >= XPRT_ENTRIES)
824 return;
825 registered_xprt[id] = xprt;
826}
827
828/* returns pointer to transport layer <id> (XPRT_*) or NULL if not registered */
829static inline struct xprt_ops *xprt_get(int id)
830{
831 if (id >= XPRT_ENTRIES)
832 return NULL;
833 return registered_xprt[id];
834}
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100835
Olivier Houchardfe50bfb2019-05-27 12:09:19 +0200836/* Try to add a handshake pseudo-XPRT. If the connection's first XPRT is
837 * raw_sock, then just use the new XPRT as the connection XPRT, otherwise
838 * call the xprt's add_xprt() method.
839 * Returns 0 on success, or non-zero on failure.
840 */
841static inline int xprt_add_hs(struct connection *conn)
842{
843 void *xprt_ctx = NULL;
844 const struct xprt_ops *ops = xprt_get(XPRT_HANDSHAKE);
845 void *nextxprt_ctx = NULL;
846 const struct xprt_ops *nextxprt_ops = NULL;
847
848 if (conn->flags & CO_FL_ERROR)
849 return -1;
850 if (ops->init(conn, &xprt_ctx) < 0)
851 return -1;
852 if (conn->xprt == xprt_get(XPRT_RAW)) {
853 nextxprt_ctx = conn->xprt_ctx;
854 nextxprt_ops = conn->xprt;
855 conn->xprt_ctx = xprt_ctx;
856 conn->xprt = ops;
857 } else {
858 if (conn->xprt->add_xprt(conn, conn->xprt_ctx, xprt_ctx, ops,
859 &nextxprt_ctx, &nextxprt_ops) != 0) {
860 ops->close(conn, xprt_ctx);
861 return -1;
862 }
863 }
864 if (ops->add_xprt(conn, xprt_ctx, nextxprt_ctx, nextxprt_ops, NULL, NULL) != 0) {
865 ops->close(conn, xprt_ctx);
866 return -1;
867 }
868 return 0;
869}
870
Willy Tarreaua9c17412016-12-04 18:42:09 +0100871static inline int conn_get_alpn(const struct connection *conn, const char **str, int *len)
872{
873 if (!conn_xprt_ready(conn) || !conn->xprt->get_alpn)
874 return 0;
Olivier Houcharde179d0e2019-03-21 18:27:17 +0100875 return conn->xprt->get_alpn(conn, conn->xprt_ctx, str, len);
Willy Tarreaua9c17412016-12-04 18:42:09 +0100876}
877
Christopher Faulet32f61c02018-04-10 14:33:41 +0200878/* registers proto mux list <list>. Modifies the list element! */
879static inline void register_mux_proto(struct mux_proto_list *list)
Willy Tarreau2386be62017-09-21 19:40:52 +0200880{
Christopher Faulet32f61c02018-04-10 14:33:41 +0200881 LIST_ADDQ(&mux_proto_list.list, &list->list);
Willy Tarreau2386be62017-09-21 19:40:52 +0200882}
883
Christopher Faulet32f61c02018-04-10 14:33:41 +0200884/* unregisters proto mux list <list> */
885static inline void unregister_mux_proto(struct mux_proto_list *list)
Willy Tarreau2386be62017-09-21 19:40:52 +0200886{
887 LIST_DEL(&list->list);
888 LIST_INIT(&list->list);
889}
890
Christopher Faulete15c6c42018-08-08 10:21:56 +0200891static inline struct mux_proto_list *get_mux_proto(const struct ist proto)
Christopher Faulet98d9fe22018-04-10 14:37:32 +0200892{
893 struct mux_proto_list *item;
Christopher Faulet98d9fe22018-04-10 14:37:32 +0200894
895 list_for_each_entry(item, &mux_proto_list.list, list) {
896 if (isteq(proto, item->token))
897 return item;
898 }
899 return NULL;
900}
901
902/* Lists the known proto mux on <out> */
903static inline void list_mux_proto(FILE *out)
904{
905 struct mux_proto_list *item;
906 struct ist proto;
907 char *mode, *side;
908
Christopher Faulet9c9ef032018-08-08 10:25:57 +0200909 fprintf(out, "Available multiplexer protocols :\n"
Willy Tarreaud3c49d12018-11-30 16:52:32 +0100910 "(protocols marked as <default> cannot be specified using 'proto' keyword)\n");
Christopher Faulet98d9fe22018-04-10 14:37:32 +0200911 list_for_each_entry(item, &mux_proto_list.list, list) {
912 proto = item->token;
913
914 if (item->mode == PROTO_MODE_ANY)
915 mode = "TCP|HTTP";
916 else if (item->mode == PROTO_MODE_TCP)
917 mode = "TCP";
918 else if (item->mode == PROTO_MODE_HTTP)
919 mode = "HTTP";
920 else
921 mode = "NONE";
922
923 if (item->side == PROTO_SIDE_BOTH)
924 side = "FE|BE";
925 else if (item->side == PROTO_SIDE_FE)
926 side = "FE";
927 else if (item->side == PROTO_SIDE_BE)
928 side = "BE";
929 else
930 side = "NONE";
931
Willy Tarreauca2a3cc2019-05-22 11:44:03 +0200932 fprintf(out, " %15s : mode=%-10s side=%-8s mux=%s\n",
933 (proto.len ? proto.ptr : "<default>"), mode, side, item->mux->name);
Christopher Faulet98d9fe22018-04-10 14:37:32 +0200934 }
935}
936
Willy Tarreau5fc311c2018-12-02 13:04:43 +0100937/* returns the first mux entry in the list matching the exact same <mux_proto>
938 * and compatible with the <proto_side> (FE or BE) and the <proto_mode> (TCP or
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200939 * HTTP). <mux_proto> can be empty. Will fall back to the first compatible mux
940 * with exactly the same <proto_mode> or with an empty name. May return
941 * null if the code improperly registered the default mux to use as a fallback.
Willy Tarreau2386be62017-09-21 19:40:52 +0200942 */
Willy Tarreau5fc311c2018-12-02 13:04:43 +0100943static inline const struct mux_proto_list *conn_get_best_mux_entry(
944 const struct ist mux_proto,
945 int proto_side, int proto_mode)
Willy Tarreau2386be62017-09-21 19:40:52 +0200946{
Christopher Faulet32f61c02018-04-10 14:33:41 +0200947 struct mux_proto_list *item;
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200948 struct mux_proto_list *fallback = NULL;
Willy Tarreau2386be62017-09-21 19:40:52 +0200949
Christopher Faulet32f61c02018-04-10 14:33:41 +0200950 list_for_each_entry(item, &mux_proto_list.list, list) {
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200951 if (!(item->side & proto_side) || !(item->mode & proto_mode))
Willy Tarreau2386be62017-09-21 19:40:52 +0200952 continue;
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200953 if (istlen(mux_proto) && isteq(mux_proto, item->token))
Willy Tarreau5fc311c2018-12-02 13:04:43 +0100954 return item;
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200955 else if (!istlen(item->token)) {
956 if (!fallback || (item->mode == proto_mode && fallback->mode != proto_mode))
957 fallback = item;
958 }
Willy Tarreau2386be62017-09-21 19:40:52 +0200959 }
Willy Tarreau5fc311c2018-12-02 13:04:43 +0100960 return fallback;
961
962}
963
964/* 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.
969 */
970static 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)
973{
974 const struct mux_proto_list *item;
975
976 item = conn_get_best_mux_entry(mux_proto, proto_side, proto_mode);
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200977
Willy Tarreau5fc311c2018-12-02 13:04:43 +0100978 return item ? item->mux : NULL;
Willy Tarreau2386be62017-09-21 19:40:52 +0200979}
980
Willy Tarreau57f81852018-09-06 14:52:21 +0200981/* returns 0 if the connection is valid and is a frontend connection, otherwise
982 * returns 1 indicating it's a backend connection. And uninitialized connection
983 * also returns 1 to better handle the usage in the middle of initialization.
984 */
985static inline int conn_is_back(const struct connection *conn)
986{
987 return !objt_listener(conn->target);
988}
989
Willy Tarreau6ac98ac2018-09-06 11:48:44 +0200990/* returns a pointer to the proxy associated with this connection. For a front
991 * connection it returns a pointer to the frontend ; for a back connection, it
992 * returns a pointer to the backend.
993 */
994static inline struct proxy *conn_get_proxy(const struct connection *conn)
995{
996 struct listener *l;
997 struct server *s;
998
999 /* check if it's a frontend connection */
1000 l = objt_listener(conn->target);
1001 if (l)
1002 return l->bind_conf->frontend;
1003
1004 /* check if it's a backend connection */
1005 s = objt_server(conn->target);
1006 if (s)
1007 return s->proxy;
1008
1009 return objt_proxy(conn->target);
1010}
1011
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001012/* installs the best mux for incoming connection <conn> using the upper context
1013 * <ctx>. If the mux protocol is forced, we use it to find the best
1014 * mux. Otherwise we use the ALPN name, if any. Returns < 0 on error.
Willy Tarreau2386be62017-09-21 19:40:52 +02001015 */
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001016static inline int conn_install_mux_fe(struct connection *conn, void *ctx)
Willy Tarreau2386be62017-09-21 19:40:52 +02001017{
Willy Tarreau55e0da62018-09-20 11:26:52 +02001018 struct bind_conf *bind_conf = __objt_listener(conn->target)->bind_conf;
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001019 const struct mux_ops *mux_ops;
Willy Tarreau2386be62017-09-21 19:40:52 +02001020
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001021 if (bind_conf->mux_proto)
1022 mux_ops = bind_conf->mux_proto->mux;
1023 else {
1024 struct ist mux_proto;
1025 const char *alpn_str = NULL;
1026 int alpn_len = 0;
Willy Tarreau68ad3a42018-10-22 11:49:15 +02001027 int mode;
1028
Christopher Fauletc1918d12019-04-24 15:01:22 +02001029 if (bind_conf->frontend->mode == PR_MODE_HTTP)
Christopher Fauletc985f6c2019-07-15 11:42:52 +02001030 mode = PROTO_MODE_HTTP;
Willy Tarreau68ad3a42018-10-22 11:49:15 +02001031 else
Christopher Fauletc1918d12019-04-24 15:01:22 +02001032 mode = PROTO_MODE_TCP;
Willy Tarreau2386be62017-09-21 19:40:52 +02001033
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001034 conn_get_alpn(conn, &alpn_str, &alpn_len);
1035 mux_proto = ist2(alpn_str, alpn_len);
1036 mux_ops = conn_get_best_mux(conn, mux_proto, PROTO_SIDE_FE, mode);
1037 if (!mux_ops)
1038 return -1;
1039 }
Olivier Houchardf502aca2018-12-14 19:42:40 +01001040 return conn_install_mux(conn, mux_ops, ctx, bind_conf->frontend, conn->owner);
Willy Tarreau2386be62017-09-21 19:40:52 +02001041}
1042
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001043/* installs the best mux for outgoing connection <conn> using the upper context
1044 * <ctx>. If the mux protocol is forced, we use it to find the best mux. Returns
Willy Tarreau2e0b2b52017-09-15 06:59:55 +02001045 * < 0 on error.
Willy Tarreau2386be62017-09-21 19:40:52 +02001046 */
Olivier Houchardf502aca2018-12-14 19:42:40 +01001047static inline int conn_install_mux_be(struct connection *conn, void *ctx, struct session *sess)
Willy Tarreau2386be62017-09-21 19:40:52 +02001048{
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001049 struct server *srv = objt_server(conn->target);
Willy Tarreau287527a2018-08-08 18:40:44 +02001050 struct proxy *prx = objt_proxy(conn->target);
Willy Tarreau2386be62017-09-21 19:40:52 +02001051 const struct mux_ops *mux_ops;
1052
Willy Tarreau287527a2018-08-08 18:40:44 +02001053 if (srv)
1054 prx = srv->proxy;
1055
1056 if (!prx) // target must be either proxy or server
1057 return -1;
1058
1059 if (srv && srv->mux_proto)
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001060 mux_ops = srv->mux_proto->mux;
1061 else {
Olivier Houchard201b9f42018-11-21 00:16:29 +01001062 struct ist mux_proto;
1063 const char *alpn_str = NULL;
1064 int alpn_len = 0;
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001065 int mode;
1066
Christopher Fauletc1918d12019-04-24 15:01:22 +02001067 if (prx->mode == PR_MODE_HTTP)
Christopher Fauletc985f6c2019-07-15 11:42:52 +02001068 mode = PROTO_MODE_HTTP;
Willy Tarreau68ad3a42018-10-22 11:49:15 +02001069 else
Christopher Fauletc1918d12019-04-24 15:01:22 +02001070 mode = PROTO_MODE_TCP;
Willy Tarreau68ad3a42018-10-22 11:49:15 +02001071
Olivier Houchard201b9f42018-11-21 00:16:29 +01001072 conn_get_alpn(conn, &alpn_str, &alpn_len);
1073 mux_proto = ist2(alpn_str, alpn_len);
1074
1075 mux_ops = conn_get_best_mux(conn, mux_proto, PROTO_SIDE_BE, mode);
Christopher Faulet7ce0c892018-04-10 15:01:45 +02001076 if (!mux_ops)
1077 return -1;
1078 }
Olivier Houchardf502aca2018-12-14 19:42:40 +01001079 return conn_install_mux(conn, mux_ops, ctx, prx, sess);
Willy Tarreau2386be62017-09-21 19:40:52 +02001080}
1081
Olivier Houchard2ab3dad2019-07-03 13:08:18 +02001082/* Change the mux for the connection.
1083 * The caller should make sure he's not subscribed to the underlying XPRT.
1084 */
Christopher Fauletc0016d82019-04-08 10:42:41 +02001085static inline int conn_upgrade_mux_fe(struct connection *conn, void *ctx, struct buffer *buf,
1086 struct ist mux_proto, int mode)
1087{
1088 struct bind_conf *bind_conf = __objt_listener(conn->target)->bind_conf;
1089 const struct mux_ops *old_mux, *new_mux;
1090 void *old_mux_ctx;
1091 const char *alpn_str = NULL;
1092 int alpn_len = 0;
1093
1094 if (!mux_proto.len) {
1095 conn_get_alpn(conn, &alpn_str, &alpn_len);
1096 mux_proto = ist2(alpn_str, alpn_len);
1097 }
1098 new_mux = conn_get_best_mux(conn, mux_proto, PROTO_SIDE_FE, mode);
1099 old_mux = conn->mux;
1100
1101 /* No mux found */
1102 if (!new_mux)
1103 return -1;
1104
1105 /* Same mux, nothing to do */
1106 if (old_mux == new_mux)
1107 return 0;
1108
1109 old_mux_ctx = conn->ctx;
1110 conn->mux = new_mux;
1111 conn->ctx = ctx;
Christopher Fauletc0016d82019-04-08 10:42:41 +02001112 if (new_mux->init(conn, bind_conf->frontend, conn->owner, buf) == -1) {
1113 /* The mux upgrade failed, so restore the old mux */
1114 conn->ctx = old_mux_ctx;
1115 conn->mux = old_mux;
1116 return -1;
1117 }
1118
1119 /* The mux was upgraded, destroy the old one */
1120 *buf = BUF_NULL;
1121 old_mux->destroy(old_mux_ctx);
1122 return 0;
1123}
1124
Willy Tarreau59f98392012-07-06 14:13:49 +02001125#endif /* _PROTO_CONNECTION_H */
1126
1127/*
1128 * Local variables:
1129 * c-indent-level: 8
1130 * c-basic-offset: 8
1131 * End:
1132 */