blob: fb264d2b59d60d797a65dce6069c95cbe835e386 [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 Houchard477902b2020-01-22 18:08:48 +010070/* If we delayed the mux creation because we were waiting for the handshake, do it now */
71int conn_create_mux(struct connection *conn);
72
Olivier Houchard4be71902019-07-11 15:49:00 +020073__decl_hathreads(extern HA_SPINLOCK_T toremove_lock[MAX_THREADS]);
74
Willy Tarreaud02cdd22013-12-15 10:23:20 +010075/* returns true is the transport layer is ready */
Willy Tarreauaad69382014-01-23 14:21:42 +010076static inline int conn_xprt_ready(const struct connection *conn)
Willy Tarreaud02cdd22013-12-15 10:23:20 +010077{
Willy Tarreauaad69382014-01-23 14:21:42 +010078 return (conn->flags & CO_FL_XPRT_READY);
Willy Tarreaud02cdd22013-12-15 10:23:20 +010079}
80
81/* returns true is the control layer is ready */
Willy Tarreau3c728722014-01-23 13:50:42 +010082static inline int conn_ctrl_ready(const struct connection *conn)
Willy Tarreaud02cdd22013-12-15 10:23:20 +010083{
84 return (conn->flags & CO_FL_CTRL_READY);
85}
86
Willy Tarreauf79c8172013-10-21 16:30:56 +020087/* Calls the init() function of the transport layer if any and if not done yet,
88 * and sets the CO_FL_XPRT_READY flag to indicate it was properly initialized.
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020089 * Returns <0 in case of error.
Willy Tarreau15678ef2012-08-31 13:54:11 +020090 */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020091static inline int conn_xprt_init(struct connection *conn)
Willy Tarreau15678ef2012-08-31 13:54:11 +020092{
Willy Tarreauf79c8172013-10-21 16:30:56 +020093 int ret = 0;
94
Willy Tarreauaad69382014-01-23 14:21:42 +010095 if (!conn_xprt_ready(conn) && conn->xprt && conn->xprt->init)
Olivier Houcharde179d0e2019-03-21 18:27:17 +010096 ret = conn->xprt->init(conn, &conn->xprt_ctx);
Willy Tarreauf79c8172013-10-21 16:30:56 +020097
98 if (ret >= 0)
99 conn->flags |= CO_FL_XPRT_READY;
100
101 return ret;
Willy Tarreau15678ef2012-08-31 13:54:11 +0200102}
103
Willy Tarreauf79c8172013-10-21 16:30:56 +0200104/* Calls the close() function of the transport layer if any and if not done
105 * yet, and clears the CO_FL_XPRT_READY flag. However this is not done if the
106 * CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the
107 * transport layer very late if needed.
Willy Tarreau6c03a642012-10-12 17:00:05 +0200108 */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +0200109static inline void conn_xprt_close(struct connection *conn)
Willy Tarreau8b117082012-08-06 15:06:49 +0200110{
Willy Tarreauf79c8172013-10-21 16:30:56 +0200111 if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_XPRT_TRACKED)) == CO_FL_XPRT_READY) {
Willy Tarreauaad69382014-01-23 14:21:42 +0100112 if (conn->xprt->close)
Olivier Houcharde179d0e2019-03-21 18:27:17 +0100113 conn->xprt->close(conn, conn->xprt_ctx);
Olivier Houchard478281f2019-05-13 19:10:46 +0200114 conn->xprt_ctx = NULL;
Willy Tarreauf79c8172013-10-21 16:30:56 +0200115 conn->flags &= ~CO_FL_XPRT_READY;
116 }
117}
118
119/* Initializes the connection's control layer which essentially consists in
120 * registering the file descriptor for polling and setting the CO_FL_CTRL_READY
Willy Tarreau3c728722014-01-23 13:50:42 +0100121 * flag. The caller is responsible for ensuring that the control layer is
122 * already assigned to the connection prior to the call.
Willy Tarreauf79c8172013-10-21 16:30:56 +0200123 */
124static inline void conn_ctrl_init(struct connection *conn)
125{
Willy Tarreau3c728722014-01-23 13:50:42 +0100126 if (!conn_ctrl_ready(conn)) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200127 int fd = conn->handle.fd;
Willy Tarreauf79c8172013-10-21 16:30:56 +0200128
Willy Tarreaua9786b62018-01-25 07:22:13 +0100129 fd_insert(fd, conn, conn_fd_handler, tid_bit);
Willy Tarreauf79c8172013-10-21 16:30:56 +0200130 conn->flags |= CO_FL_CTRL_READY;
Willy Tarreau6c03a642012-10-12 17:00:05 +0200131 }
Willy Tarreau8b117082012-08-06 15:06:49 +0200132}
133
Willy Tarreauf79c8172013-10-21 16:30:56 +0200134/* Deletes the FD if the transport layer is already gone. Once done,
135 * it then removes the CO_FL_CTRL_READY flag.
136 */
137static inline void conn_ctrl_close(struct connection *conn)
138{
139 if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_CTRL_READY)) == CO_FL_CTRL_READY) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200140 fd_delete(conn->handle.fd);
Willy Tarreau6a0a80a2017-10-05 17:43:39 +0200141 conn->handle.fd = DEAD_FD_MAGIC;
Willy Tarreauf79c8172013-10-21 16:30:56 +0200142 conn->flags &= ~CO_FL_CTRL_READY;
143 }
144}
145
Willy Tarreau2b199c92012-11-23 17:32:21 +0100146/* If the connection still has a transport layer, then call its close() function
147 * if any, and delete the file descriptor if a control layer is set. This is
148 * used to close everything at once and atomically. However this is not done if
149 * the CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the
150 * transport layer very late if needed.
151 */
152static inline void conn_full_close(struct connection *conn)
153{
Willy Tarreauf79c8172013-10-21 16:30:56 +0200154 conn_xprt_close(conn);
155 conn_ctrl_close(conn);
156}
157
Willy Tarreaudc42acd2017-10-05 18:09:20 +0200158/* stop tracking a connection, allowing conn_full_close() to always
159 * succeed.
160 */
161static inline void conn_stop_tracking(struct connection *conn)
162{
163 conn->flags &= ~CO_FL_XPRT_TRACKED;
164}
165
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100166/* Stop all polling on the fd. This might be used when an error is encountered
Willy Tarreau19bc2012020-02-21 08:46:19 +0100167 * for example.
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100168 */
169static inline void conn_stop_polling(struct connection *c)
170{
Willy Tarreau19bc2012020-02-21 08:46:19 +0100171 if (conn_ctrl_ready(c))
Willy Tarreau585744b2017-08-24 14:31:19 +0200172 fd_stop_both(c->handle.fd);
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100173}
174
Willy Tarreau19bc2012020-02-21 08:46:19 +0100175/* Stops polling in case of error on the connection. */
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200176static inline void conn_cond_update_polling(struct connection *c)
177{
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100178 if (unlikely(c->flags & CO_FL_ERROR))
179 conn_stop_polling(c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200180}
181
Willy Tarreau7b271b22017-10-25 09:59:22 +0200182/* read shutdown, called from the rcv_buf/rcv_pipe handlers when
183 * detecting an end of connection.
184 */
Willy Tarreau3af56a92012-08-20 16:55:48 +0200185static inline void conn_sock_read0(struct connection *c)
186{
187 c->flags |= CO_FL_SOCK_RD_SH;
Willy Tarreaud1d14c32020-02-21 10:34:19 +0100188 if (conn_ctrl_ready(c)) {
189 fd_stop_recv(c->handle.fd);
190 /* we don't risk keeping ports unusable if we found the
191 * zero from the other side.
192 */
Willy Tarreau585744b2017-08-24 14:31:19 +0200193 fdtab[c->handle.fd].linger_risk = 0;
Willy Tarreaud1d14c32020-02-21 10:34:19 +0100194 }
Willy Tarreau3af56a92012-08-20 16:55:48 +0200195}
196
Willy Tarreau7b271b22017-10-25 09:59:22 +0200197/* write shutdown, indication that the upper layer is not willing to send
Willy Tarreaua48c1412017-12-22 18:46:33 +0100198 * anything anymore and wants to close after pending data are sent. The
199 * <clean> argument will allow not to perform the socket layer shutdown if
200 * equal to 0.
Willy Tarreau7b271b22017-10-25 09:59:22 +0200201 */
Willy Tarreaua48c1412017-12-22 18:46:33 +0100202static inline void conn_sock_shutw(struct connection *c, int clean)
Willy Tarreau3af56a92012-08-20 16:55:48 +0200203{
204 c->flags |= CO_FL_SOCK_WR_SH;
Willy Tarreaud1d14c32020-02-21 10:34:19 +0100205 if (conn_ctrl_ready(c)) {
206 fd_stop_send(c->handle.fd);
207 /* don't perform a clean shutdown if we're going to reset or
208 * if the shutr was already received.
209 */
210 if (!(c->flags & CO_FL_SOCK_RD_SH) && clean)
211 shutdown(c->handle.fd, SHUT_WR);
212 }
Willy Tarreau3af56a92012-08-20 16:55:48 +0200213}
214
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200215static inline void conn_xprt_shutw(struct connection *c)
Willy Tarreau3af56a92012-08-20 16:55:48 +0200216{
Willy Tarreaud1d14c32020-02-21 10:34:19 +0100217 if (conn_ctrl_ready(c))
218 fd_stop_send(c->handle.fd);
Willy Tarreau729c69f2015-03-12 22:51:10 +0100219
220 /* clean data-layer shutdown */
221 if (c->xprt && c->xprt->shutw)
Olivier Houcharde179d0e2019-03-21 18:27:17 +0100222 c->xprt->shutw(c, c->xprt_ctx, 1);
Willy Tarreau729c69f2015-03-12 22:51:10 +0100223}
224
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200225static inline void conn_xprt_shutw_hard(struct connection *c)
Willy Tarreau729c69f2015-03-12 22:51:10 +0100226{
Willy Tarreaud1d14c32020-02-21 10:34:19 +0100227 if (conn_ctrl_ready(c))
228 fd_stop_send(c->handle.fd);
Willy Tarreau729c69f2015-03-12 22:51:10 +0100229
230 /* unclean data-layer shutdown */
231 if (c->xprt && c->xprt->shutw)
Olivier Houcharde179d0e2019-03-21 18:27:17 +0100232 c->xprt->shutw(c, c->xprt_ctx, 0);
Willy Tarreau3af56a92012-08-20 16:55:48 +0200233}
234
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200235/* shut read */
236static inline void cs_shutr(struct conn_stream *cs, enum cs_shr_mode mode)
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200237{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200238
239 /* clean data-layer shutdown */
240 if (cs->conn->mux && cs->conn->mux->shutr)
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200241 cs->conn->mux->shutr(cs, mode);
242 cs->flags |= (mode == CS_SHR_DRAIN) ? CS_FL_SHRD : CS_FL_SHRR;
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200243}
244
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200245/* shut write */
246static inline void cs_shutw(struct conn_stream *cs, enum cs_shw_mode mode)
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200247{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200248
249 /* clean data-layer shutdown */
250 if (cs->conn->mux && cs->conn->mux->shutw)
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200251 cs->conn->mux->shutw(cs, mode);
252 cs->flags |= (mode == CS_SHW_NORMAL) ? CS_FL_SHWN : CS_FL_SHWS;
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200253}
254
Willy Tarreau6978db32017-10-05 18:19:43 +0200255/* completely close a conn_stream (but do not detach it) */
256static inline void cs_close(struct conn_stream *cs)
257{
258 cs_shutw(cs, CS_SHW_SILENT);
259 cs_shutr(cs, CS_SHR_RESET);
260 cs->flags = CS_FL_NONE;
261}
262
Willy Tarreaue9f43012018-12-19 17:59:30 +0100263/* sets CS_FL_ERROR or CS_FL_ERR_PENDING on the cs */
264static inline void cs_set_error(struct conn_stream *cs)
265{
266 if (cs->flags & CS_FL_EOS)
267 cs->flags |= CS_FL_ERROR;
268 else
Willy Tarreau7bb39d72019-06-03 14:23:33 +0200269 cs->flags |= CS_FL_ERR_PENDING;
Willy Tarreaue9f43012018-12-19 17:59:30 +0100270}
271
Willy Tarreau3af56a92012-08-20 16:55:48 +0200272/* detect sock->data read0 transition */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200273static inline int conn_xprt_read0_pending(struct connection *c)
Willy Tarreau3af56a92012-08-20 16:55:48 +0200274{
Willy Tarreau54e917c2017-08-30 07:35:35 +0200275 return (c->flags & CO_FL_SOCK_RD_SH) != 0;
Willy Tarreau3af56a92012-08-20 16:55:48 +0200276}
277
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200278/* prepares a connection to work with protocol <proto> and transport <xprt>.
Willy Tarreau53a47662017-08-28 10:53:00 +0200279 * The transport's is initialized as well, and the mux and its context are
Willy Tarreaube373152018-09-06 11:45:30 +0200280 * cleared. The target is not reinitialized and it is recommended that it is
281 * set prior to calling this function so that the function may make use of it
282 * in the future to refine the mux choice if needed.
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200283 */
284static inline void conn_prepare(struct connection *conn, const struct protocol *proto, const struct xprt_ops *xprt)
285{
286 conn->ctrl = proto;
287 conn->xprt = xprt;
Willy Tarreau53a47662017-08-28 10:53:00 +0200288 conn->mux = NULL;
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200289 conn->xprt_ctx = NULL;
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100290 conn->ctx = NULL;
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200291}
292
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200293/*
294 * Initializes all required fields for a new conn_strema.
295 */
296static inline void cs_init(struct conn_stream *cs, struct connection *conn)
297{
298 cs->obj_type = OBJ_TYPE_CS;
299 cs->flags = CS_FL_NONE;
300 cs->conn = conn;
301}
302
Willy Tarreaud0155772013-10-14 17:10:08 +0200303/* Initializes all required fields for a new connection. Note that it does the
304 * minimum acceptable initialization for a connection that already exists and
305 * is about to be reused. It also leaves the addresses untouched, which makes
306 * it usable across connection retries to reset a connection to a known state.
307 */
308static inline void conn_init(struct connection *conn)
309{
310 conn->obj_type = OBJ_TYPE_CONN;
311 conn->flags = CO_FL_NONE;
Willy Tarreau53a47662017-08-28 10:53:00 +0200312 conn->mux = NULL;
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100313 conn->ctx = NULL;
Willy Tarreaud0155772013-10-14 17:10:08 +0200314 conn->owner = NULL;
Willy Tarreaub8020ce2013-10-24 21:10:08 +0200315 conn->send_proxy_ofs = 0;
Willy Tarreau585744b2017-08-24 14:31:19 +0200316 conn->handle.fd = DEAD_FD_MAGIC;
Willy Tarreaud0155772013-10-14 17:10:08 +0200317 conn->err_code = CO_ER_NONE;
318 conn->target = NULL;
Willy Tarreau436d3332017-10-08 11:16:46 +0200319 conn->destroy_cb = NULL;
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100320 conn->proxy_netns = NULL;
Willy Tarreaud75d40e2015-08-04 17:25:58 +0200321 LIST_INIT(&conn->list);
Olivier Houchard131fd892018-11-13 16:44:31 +0100322 LIST_INIT(&conn->session_list);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100323 conn->subs = NULL;
Olivier Houchard006e3102018-12-10 18:30:32 +0100324 conn->idle_time = 0;
Willy Tarreaue71fca82019-07-17 19:06:58 +0200325 conn->src = NULL;
326 conn->dst = NULL;
Geoff Simmons7185b782019-08-27 18:31:16 +0200327 conn->proxy_authority = NULL;
Willy Tarreaud0155772013-10-14 17:10:08 +0200328}
329
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200330/* sets <owner> as the connection's owner */
Willy Tarreau436d3332017-10-08 11:16:46 +0200331static inline void conn_set_owner(struct connection *conn, void *owner, void (*cb)(struct connection *))
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200332{
333 conn->owner = owner;
Willy Tarreau436d3332017-10-08 11:16:46 +0200334 conn->destroy_cb = cb;
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200335}
336
Willy Tarreauff5d57b2019-07-17 18:37:02 +0200337/* Allocates a struct sockaddr from the pool if needed, assigns it to *sap and
338 * returns it. If <sap> is NULL, the address is always allocated and returned.
339 * if <sap> is non-null, an address will only be allocated if it points to a
340 * non-null pointer. In this case the allocated address will be assigned there.
341 * In both situations the new pointer is returned.
342 */
343static inline struct sockaddr_storage *sockaddr_alloc(struct sockaddr_storage **sap)
344{
345 struct sockaddr_storage *sa;
346
347 if (sap && *sap)
348 return *sap;
349
350 sa = pool_alloc(pool_head_sockaddr);
351 if (sap)
352 *sap = sa;
353 return sa;
354}
355
356/* Releases the struct sockaddr potentially pointed to by <sap> to the pool. It
357 * may be NULL or may point to NULL. If <sap> is not NULL, a NULL is placed
358 * there.
359 */
360static inline void sockaddr_free(struct sockaddr_storage **sap)
361{
362 if (!sap)
363 return;
364 pool_free(pool_head_sockaddr, *sap);
365 *sap = NULL;
366}
367
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200368/* Tries to allocate a new connection and initialized its main fields. The
369 * connection is returned on success, NULL on failure. The connection must
Willy Tarreaubafbe012017-11-24 17:34:44 +0100370 * be released using pool_free() or conn_free().
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200371 */
372static inline struct connection *conn_new()
373{
374 struct connection *conn;
375
Willy Tarreaubafbe012017-11-24 17:34:44 +0100376 conn = pool_alloc(pool_head_connection);
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200377 if (likely(conn != NULL))
378 conn_init(conn);
379 return conn;
380}
381
Willy Tarreau5e1cc5e2018-03-02 10:43:58 +0100382/* Releases a conn_stream previously allocated by cs_new(), as well as any
383 * buffer it would still hold.
384 */
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200385static inline void cs_free(struct conn_stream *cs)
386{
Willy Tarreau5e1cc5e2018-03-02 10:43:58 +0100387
Willy Tarreaubafbe012017-11-24 17:34:44 +0100388 pool_free(pool_head_connstream, cs);
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200389}
390
391/* Tries to allocate a new conn_stream and initialize its main fields. If
392 * <conn> is NULL, then a new connection is allocated on the fly, initialized,
393 * and assigned to cs->conn ; this connection will then have to be released
Willy Tarreaubafbe012017-11-24 17:34:44 +0100394 * using pool_free() or conn_free(). The conn_stream is initialized and added
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200395 * to the mux's stream list on success, then returned. On failure, nothing is
396 * allocated and NULL is returned.
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200397 */
398static inline struct conn_stream *cs_new(struct connection *conn)
399{
400 struct conn_stream *cs;
401
Willy Tarreaubafbe012017-11-24 17:34:44 +0100402 cs = pool_alloc(pool_head_connstream);
Tim Duesterhus927063b2020-02-21 13:02:03 +0100403 if (unlikely(!cs))
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200404 return NULL;
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200405
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200406 if (!conn) {
407 conn = conn_new();
Tim Duesterhus927063b2020-02-21 13:02:03 +0100408 if (unlikely(!conn)) {
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200409 cs_free(cs);
410 return NULL;
411 }
412 conn_init(conn);
413 }
414
415 cs_init(cs, conn);
416 return cs;
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200417}
418
Willy Tarreaufafd3982018-11-18 21:29:20 +0100419/* Retrieves any valid conn_stream from this connection, preferably the first
420 * valid one. The purpose is to be able to figure one other end of a private
421 * connection for purposes like source binding or proxy protocol header
422 * emission. In such cases, any conn_stream is expected to be valid so the
423 * mux is encouraged to return the first one it finds. If the connection has
424 * no mux or the mux has no get_first_cs() method or the mux has no valid
425 * conn_stream, NULL is returned. The output pointer is purposely marked
426 * const to discourage the caller from modifying anything there.
427 */
428static inline const struct conn_stream *cs_get_first(const struct connection *conn)
429{
430 if (!conn || !conn->mux || !conn->mux->get_first_cs)
431 return NULL;
432 return conn->mux->get_first_cs(conn);
433}
434
Olivier Houchard1fddc9b2018-10-21 00:32:01 +0200435static inline void conn_force_unsubscribe(struct connection *conn)
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200436{
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100437 if (!conn->subs)
438 return;
439 conn->subs->events = 0;
440 conn->subs = NULL;
Olivier Houchard1fddc9b2018-10-21 00:32:01 +0200441}
442
443/* Releases a connection previously allocated by conn_new() */
444static inline void conn_free(struct connection *conn)
445{
Olivier Houchard00cf70f2018-11-30 17:24:55 +0100446 /* Remove ourself from the session's connections list, if any. */
Olivier Houcharda4d4fdf2018-12-14 19:27:06 +0100447 if (!LIST_ISEMPTY(&conn->session_list)) {
448 struct session *sess = conn->owner;
Olivier Houcharda2dbeb22018-12-28 18:50:57 +0100449 if (conn->flags & CO_FL_SESS_IDLE)
450 sess->idle_conns--;
Olivier Houchard351411f2018-12-27 17:20:54 +0100451 session_unown_conn(sess, conn);
Olivier Houcharda4d4fdf2018-12-14 19:27:06 +0100452 }
Willy Tarreau94031d32018-12-19 14:36:29 +0100453
Willy Tarreaue71fca82019-07-17 19:06:58 +0200454 sockaddr_free(&conn->src);
455 sockaddr_free(&conn->dst);
456
Geoff Simmons7185b782019-08-27 18:31:16 +0200457 if (conn->proxy_authority != NULL) {
458 pool_free(pool_head_authority, conn->proxy_authority);
459 conn->proxy_authority = NULL;
460 }
461
Willy Tarreau94031d32018-12-19 14:36:29 +0100462 /* By convention we always place a NULL where the ctx points to if the
463 * mux is null. It may have been used to store the connection as a
464 * stream_interface's end point for example.
Olivier Houchard201b9f42018-11-21 00:16:29 +0100465 */
Willy Tarreau94031d32018-12-19 14:36:29 +0100466 if (conn->ctx != NULL && conn->mux == NULL)
467 *(void **)conn->ctx = NULL;
Olivier Houchard201b9f42018-11-21 00:16:29 +0100468
Olivier Houchard006e3102018-12-10 18:30:32 +0100469 /* The connection is currently in the server's idle list, so tell it
470 * there's one less connection available in that list.
471 */
472 if (conn->idle_time > 0) {
473 struct server *srv = __objt_server(conn->target);
Olivier Houchard237985b2019-03-13 18:52:21 +0100474 _HA_ATOMIC_SUB(&srv->curr_idle_conns, 1);
Olivier Houchardf1314812019-02-18 16:41:17 +0100475 srv->curr_idle_thr[tid]--;
Olivier Houchard006e3102018-12-10 18:30:32 +0100476 }
Olivier Houchard201b9f42018-11-21 00:16:29 +0100477
Olivier Houchard1fddc9b2018-10-21 00:32:01 +0200478 conn_force_unsubscribe(conn);
Olivier Houchard4be71902019-07-11 15:49:00 +0200479 HA_SPIN_LOCK(OTHER_LOCK, &toremove_lock[tid]);
Olivier Houchard859dc802019-08-08 15:47:21 +0200480 MT_LIST_DEL((struct mt_list *)&conn->list);
Olivier Houchard4be71902019-07-11 15:49:00 +0200481 HA_SPIN_UNLOCK(OTHER_LOCK, &toremove_lock[tid]);
Willy Tarreaubafbe012017-11-24 17:34:44 +0100482 pool_free(pool_head_connection, conn);
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200483}
484
Olivier Houchard7c6f8b12018-11-13 16:48:36 +0100485/* Release a conn_stream */
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200486static inline void cs_destroy(struct conn_stream *cs)
487{
Olivier Houchard302f9ef2018-04-13 15:50:27 +0200488 if (cs->conn->mux)
489 cs->conn->mux->detach(cs);
490 else {
491 /* It's too early to have a mux, let's just destroy
492 * the connection
493 */
494 struct connection *conn = cs->conn;
495
496 conn_stop_tracking(conn);
497 conn_full_close(conn);
498 if (conn->destroy_cb)
499 conn->destroy_cb(conn);
500 conn_free(conn);
501 }
Willy Tarreau63dd75d2017-10-08 15:16:00 +0200502 cs_free(cs);
503}
504
Olivier Houcharde2b40b92017-09-13 18:30:23 +0200505/* Returns the conn from a cs. If cs is NULL, returns NULL */
506static inline struct connection *cs_conn(const struct conn_stream *cs)
507{
508 return cs ? cs->conn : NULL;
509}
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200510
Willy Tarreau2e34c112019-07-17 10:48:33 +0200511/* Retrieves the connection's original source address. Returns non-zero on
512 * success or zero on failure. The operation is only performed once and the
513 * address is stored in the connection for future use.
514 */
515static inline int conn_get_src(struct connection *conn)
516{
517 if (conn->flags & CO_FL_ADDR_FROM_SET)
518 return 1;
519
520 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_src)
521 return 0;
522
Willy Tarreauca79f592019-07-17 19:04:47 +0200523 if (!sockaddr_alloc(&conn->src))
524 return 0;
525
Willy Tarreau226572f2019-07-17 14:46:00 +0200526 if (conn->ctrl->get_src(conn->handle.fd, (struct sockaddr *)conn->src,
527 sizeof(*conn->src),
Willy Tarreau2e34c112019-07-17 10:48:33 +0200528 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
529 return 0;
530 conn->flags |= CO_FL_ADDR_FROM_SET;
531 return 1;
532}
533
534/* Retrieves the connection's original destination address. Returns non-zero on
535 * success or zero on failure. The operation is only performed once and the
536 * address is stored in the connection for future use.
537 */
538static inline int conn_get_dst(struct connection *conn)
539{
540 if (conn->flags & CO_FL_ADDR_TO_SET)
541 return 1;
542
543 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_dst)
544 return 0;
545
Willy Tarreauca79f592019-07-17 19:04:47 +0200546 if (!sockaddr_alloc(&conn->dst))
547 return 0;
548
Willy Tarreau226572f2019-07-17 14:46:00 +0200549 if (conn->ctrl->get_dst(conn->handle.fd, (struct sockaddr *)conn->dst,
550 sizeof(*conn->dst),
Willy Tarreau2e34c112019-07-17 10:48:33 +0200551 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
552 return 0;
553 conn->flags |= CO_FL_ADDR_TO_SET;
554 return 1;
555}
556
Willy Tarreau1a18b542018-12-11 16:37:42 +0100557/* Sets the TOS header in IPv4 and the traffic class header in IPv6 packets
558 * (as per RFC3260 #4 and BCP37 #4.2 and #5.2). The connection is tested and if
559 * it is null, nothing is done.
560 */
561static inline void conn_set_tos(const struct connection *conn, int tos)
562{
563 if (!conn || !conn_ctrl_ready(conn))
564 return;
565
566#ifdef IP_TOS
Willy Tarreau226572f2019-07-17 14:46:00 +0200567 if (conn->src->ss_family == AF_INET)
Willy Tarreau1a18b542018-12-11 16:37:42 +0100568 setsockopt(conn->handle.fd, IPPROTO_IP, IP_TOS, &tos, sizeof(tos));
569#endif
570#ifdef IPV6_TCLASS
Willy Tarreau226572f2019-07-17 14:46:00 +0200571 if (conn->src->ss_family == AF_INET6) {
572 if (IN6_IS_ADDR_V4MAPPED(&((struct sockaddr_in6 *)conn->src)->sin6_addr))
Willy Tarreau1a18b542018-12-11 16:37:42 +0100573 /* v4-mapped addresses need IP_TOS */
574 setsockopt(conn->handle.fd, IPPROTO_IP, IP_TOS, &tos, sizeof(tos));
575 else
576 setsockopt(conn->handle.fd, IPPROTO_IPV6, IPV6_TCLASS, &tos, sizeof(tos));
577 }
578#endif
579}
580
581/* Sets the netfilter mark on the connection's socket. The connection is tested
582 * and if it is null, nothing is done.
583 */
584static inline void conn_set_mark(const struct connection *conn, int mark)
585{
586 if (!conn || !conn_ctrl_ready(conn))
587 return;
588
589#ifdef SO_MARK
590 setsockopt(conn->handle.fd, SOL_SOCKET, SO_MARK, &mark, sizeof(mark));
591#endif
592}
593
594/* Sets adjust the TCP quick-ack feature on the connection's socket. The
595 * connection is tested and if it is null, nothing is done.
596 */
597static inline void conn_set_quickack(const struct connection *conn, int value)
598{
599 if (!conn || !conn_ctrl_ready(conn))
600 return;
601
602#ifdef TCP_QUICKACK
603 setsockopt(conn->handle.fd, IPPROTO_TCP, TCP_QUICKACK, &value, sizeof(value));
604#endif
605}
606
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200607/* Attaches a conn_stream to a data layer and sets the relevant callbacks */
608static inline void cs_attach(struct conn_stream *cs, void *data, const struct data_cb *data_cb)
Willy Tarreaudda5e7c2012-09-24 17:15:42 +0200609{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200610 cs->data_cb = data_cb;
611 cs->data = data;
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200612}
613
Olivier Houchardfa8aa862018-10-10 18:25:41 +0200614static 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 +0200615{
Willy Tarreau3c39a7d2019-06-14 14:42:29 +0200616 if (!wl->tasklet->process) {
617 wl->tasklet->process = cb;
618 wl->tasklet->context = ctx;
Willy Tarreau83188852018-07-18 08:18:20 +0200619 }
620 return wl;
621}
622
Willy Tarreau53a47662017-08-28 10:53:00 +0200623/* Installs the connection's mux layer for upper context <ctx>.
624 * Returns < 0 on error.
625 */
Willy Tarreau175a2bb2018-09-12 12:02:05 +0200626static inline int conn_install_mux(struct connection *conn, const struct mux_ops *mux,
Olivier Houchardf502aca2018-12-14 19:42:40 +0100627 void *ctx, struct proxy *prx, struct session *sess)
Willy Tarreau53a47662017-08-28 10:53:00 +0200628{
Willy Tarreau762475e2019-01-10 10:33:32 +0100629 int ret;
630
Willy Tarreau53a47662017-08-28 10:53:00 +0200631 conn->mux = mux;
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100632 conn->ctx = ctx;
Christopher Faulet51f73eb2019-04-08 11:22:47 +0200633 ret = mux->init ? mux->init(conn, prx, sess, &BUF_NULL) : 0;
Willy Tarreau762475e2019-01-10 10:33:32 +0100634 if (ret < 0) {
635 conn->mux = NULL;
636 conn->ctx = NULL;
637 }
638 return ret;
Willy Tarreau53a47662017-08-28 10:53:00 +0200639}
640
Willy Tarreau0af29122012-12-03 15:35:00 +0100641/* returns a human-readable error code for conn->err_code, or NULL if the code
642 * is unknown.
643 */
644static inline const char *conn_err_code_str(struct connection *c)
645{
646 switch (c->err_code) {
647 case CO_ER_NONE: return "Success";
Willy Tarreau45b34e82014-01-24 16:06:50 +0100648
649 case CO_ER_CONF_FDLIM: return "Reached configured maxconn value";
650 case CO_ER_PROC_FDLIM: return "Too many sockets on the process";
651 case CO_ER_SYS_FDLIM: return "Too many sockets on the system";
652 case CO_ER_SYS_MEMLIM: return "Out of system buffers";
653 case CO_ER_NOPROTO: return "Protocol or address family not supported";
654 case CO_ER_SOCK_ERR: return "General socket error";
655 case CO_ER_PORT_RANGE: return "Source port range exhausted";
656 case CO_ER_CANT_BIND: return "Can't bind to source address";
657 case CO_ER_FREE_PORTS: return "Out of local source ports on the system";
658 case CO_ER_ADDR_INUSE: return "Local source address already in use";
659
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100660 case CO_ER_PRX_EMPTY: return "Connection closed while waiting for PROXY protocol header";
661 case CO_ER_PRX_ABORT: return "Connection error while waiting for PROXY protocol header";
Willy Tarreau0af29122012-12-03 15:35:00 +0100662 case CO_ER_PRX_TIMEOUT: return "Timeout while waiting for PROXY protocol header";
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100663 case CO_ER_PRX_TRUNCATED: return "Truncated PROXY protocol header received";
664 case CO_ER_PRX_NOT_HDR: return "Received something which does not look like a PROXY protocol header";
665 case CO_ER_PRX_BAD_HDR: return "Received an invalid PROXY protocol header";
666 case CO_ER_PRX_BAD_PROTO: return "Received an unhandled protocol in the PROXY protocol header";
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100667
668 case CO_ER_CIP_EMPTY: return "Connection closed while waiting for NetScaler Client IP header";
669 case CO_ER_CIP_ABORT: return "Connection error while waiting for NetScaler Client IP header";
670 case CO_ER_CIP_TRUNCATED: return "Truncated NetScaler Client IP header received";
671 case CO_ER_CIP_BAD_MAGIC: return "Received an invalid NetScaler Client IP magic number";
672 case CO_ER_CIP_BAD_PROTO: return "Received an unhandled protocol in the NetScaler Client IP header";
673
Willy Tarreau20879a02012-12-03 16:32:10 +0100674 case CO_ER_SSL_EMPTY: return "Connection closed during SSL handshake";
675 case CO_ER_SSL_ABORT: return "Connection error during SSL handshake";
Willy Tarreau0af29122012-12-03 15:35:00 +0100676 case CO_ER_SSL_TIMEOUT: return "Timeout during SSL handshake";
Willy Tarreau20879a02012-12-03 16:32:10 +0100677 case CO_ER_SSL_TOO_MANY: return "Too many SSL connections";
678 case CO_ER_SSL_NO_MEM: return "Out of memory when initializing an SSL connection";
679 case CO_ER_SSL_RENEG: return "Rejected a client-initiated SSL renegociation attempt";
680 case CO_ER_SSL_CA_FAIL: return "SSL client CA chain cannot be verified";
681 case CO_ER_SSL_CRT_FAIL: return "SSL client certificate not trusted";
Willy Tarreau71d058c2017-07-26 20:09:56 +0200682 case CO_ER_SSL_MISMATCH: return "Server presented an SSL certificate different from the configured one";
683 case CO_ER_SSL_MISMATCH_SNI: return "Server presented an SSL certificate different from the expected one";
Willy Tarreau20879a02012-12-03 16:32:10 +0100684 case CO_ER_SSL_HANDSHAKE: return "SSL handshake failure";
Willy Tarreaub3966372014-04-25 18:54:29 +0200685 case CO_ER_SSL_HANDSHAKE_HB: return "SSL handshake failure after heartbeat";
Willy Tarreauf51c6982014-04-25 20:02:39 +0200686 case CO_ER_SSL_KILLED_HB: return "Stopped a TLSv1 heartbeat attack (CVE-2014-0160)";
Willy Tarreau830bf612013-12-01 20:29:58 +0100687 case CO_ER_SSL_NO_TARGET: return "Attempt to use SSL on an unknown target (internal error)";
Alexander Liu2a54bb72019-05-22 19:44:48 +0800688
689 case CO_ER_SOCKS4_SEND: return "SOCKS4 Proxy write error during handshake";
690 case CO_ER_SOCKS4_RECV: return "SOCKS4 Proxy read error during handshake";
691 case CO_ER_SOCKS4_DENY: return "SOCKS4 Proxy deny the request";
692 case CO_ER_SOCKS4_ABORT: return "SOCKS4 Proxy handshake aborted by server";
Willy Tarreau0af29122012-12-03 15:35:00 +0100693 }
694 return NULL;
695}
696
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100697static inline const char *conn_get_ctrl_name(const struct connection *conn)
698{
Willy Tarreau5e6a5b32019-04-25 18:35:49 +0200699 if (!conn || !conn_ctrl_ready(conn))
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100700 return "NONE";
701 return conn->ctrl->name;
702}
703
704static inline const char *conn_get_xprt_name(const struct connection *conn)
705{
Willy Tarreau5e6a5b32019-04-25 18:35:49 +0200706 if (!conn || !conn_xprt_ready(conn))
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100707 return "NONE";
Willy Tarreau8e0bb0a2016-11-24 16:58:12 +0100708 return conn->xprt->name;
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100709}
710
Willy Tarreau53a47662017-08-28 10:53:00 +0200711static inline const char *conn_get_mux_name(const struct connection *conn)
712{
Willy Tarreau5e6a5b32019-04-25 18:35:49 +0200713 if (!conn || !conn->mux)
Willy Tarreau53a47662017-08-28 10:53:00 +0200714 return "NONE";
715 return conn->mux->name;
716}
717
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200718static inline const char *cs_get_data_name(const struct conn_stream *cs)
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100719{
Willy Tarreau5e6a5b32019-04-25 18:35:49 +0200720 if (!cs || !cs->data_cb)
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100721 return "NONE";
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200722 return cs->data_cb->name;
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100723}
724
Willy Tarreau13e14102016-12-22 20:25:26 +0100725/* registers pointer to transport layer <id> (XPRT_*) */
726static inline void xprt_register(int id, struct xprt_ops *xprt)
727{
728 if (id >= XPRT_ENTRIES)
729 return;
730 registered_xprt[id] = xprt;
731}
732
733/* returns pointer to transport layer <id> (XPRT_*) or NULL if not registered */
734static inline struct xprt_ops *xprt_get(int id)
735{
736 if (id >= XPRT_ENTRIES)
737 return NULL;
738 return registered_xprt[id];
739}
Willy Tarreau2dc770c2016-11-23 18:00:08 +0100740
Olivier Houchardfe50bfb2019-05-27 12:09:19 +0200741/* Try to add a handshake pseudo-XPRT. If the connection's first XPRT is
742 * raw_sock, then just use the new XPRT as the connection XPRT, otherwise
743 * call the xprt's add_xprt() method.
744 * Returns 0 on success, or non-zero on failure.
745 */
746static inline int xprt_add_hs(struct connection *conn)
747{
748 void *xprt_ctx = NULL;
749 const struct xprt_ops *ops = xprt_get(XPRT_HANDSHAKE);
750 void *nextxprt_ctx = NULL;
751 const struct xprt_ops *nextxprt_ops = NULL;
752
753 if (conn->flags & CO_FL_ERROR)
754 return -1;
755 if (ops->init(conn, &xprt_ctx) < 0)
756 return -1;
757 if (conn->xprt == xprt_get(XPRT_RAW)) {
758 nextxprt_ctx = conn->xprt_ctx;
759 nextxprt_ops = conn->xprt;
760 conn->xprt_ctx = xprt_ctx;
761 conn->xprt = ops;
762 } else {
763 if (conn->xprt->add_xprt(conn, conn->xprt_ctx, xprt_ctx, ops,
764 &nextxprt_ctx, &nextxprt_ops) != 0) {
765 ops->close(conn, xprt_ctx);
766 return -1;
767 }
768 }
769 if (ops->add_xprt(conn, xprt_ctx, nextxprt_ctx, nextxprt_ops, NULL, NULL) != 0) {
770 ops->close(conn, xprt_ctx);
771 return -1;
772 }
773 return 0;
774}
775
Willy Tarreaua9c17412016-12-04 18:42:09 +0100776static inline int conn_get_alpn(const struct connection *conn, const char **str, int *len)
777{
778 if (!conn_xprt_ready(conn) || !conn->xprt->get_alpn)
779 return 0;
Olivier Houcharde179d0e2019-03-21 18:27:17 +0100780 return conn->xprt->get_alpn(conn, conn->xprt_ctx, str, len);
Willy Tarreaua9c17412016-12-04 18:42:09 +0100781}
782
Christopher Faulet32f61c02018-04-10 14:33:41 +0200783/* registers proto mux list <list>. Modifies the list element! */
784static inline void register_mux_proto(struct mux_proto_list *list)
Willy Tarreau2386be62017-09-21 19:40:52 +0200785{
Christopher Faulet32f61c02018-04-10 14:33:41 +0200786 LIST_ADDQ(&mux_proto_list.list, &list->list);
Willy Tarreau2386be62017-09-21 19:40:52 +0200787}
788
Christopher Faulet32f61c02018-04-10 14:33:41 +0200789/* unregisters proto mux list <list> */
790static inline void unregister_mux_proto(struct mux_proto_list *list)
Willy Tarreau2386be62017-09-21 19:40:52 +0200791{
792 LIST_DEL(&list->list);
793 LIST_INIT(&list->list);
794}
795
Christopher Faulete15c6c42018-08-08 10:21:56 +0200796static inline struct mux_proto_list *get_mux_proto(const struct ist proto)
Christopher Faulet98d9fe22018-04-10 14:37:32 +0200797{
798 struct mux_proto_list *item;
Christopher Faulet98d9fe22018-04-10 14:37:32 +0200799
800 list_for_each_entry(item, &mux_proto_list.list, list) {
801 if (isteq(proto, item->token))
802 return item;
803 }
804 return NULL;
805}
806
807/* Lists the known proto mux on <out> */
808static inline void list_mux_proto(FILE *out)
809{
810 struct mux_proto_list *item;
811 struct ist proto;
812 char *mode, *side;
813
Christopher Faulet9c9ef032018-08-08 10:25:57 +0200814 fprintf(out, "Available multiplexer protocols :\n"
Willy Tarreaud3c49d12018-11-30 16:52:32 +0100815 "(protocols marked as <default> cannot be specified using 'proto' keyword)\n");
Christopher Faulet98d9fe22018-04-10 14:37:32 +0200816 list_for_each_entry(item, &mux_proto_list.list, list) {
817 proto = item->token;
818
819 if (item->mode == PROTO_MODE_ANY)
820 mode = "TCP|HTTP";
821 else if (item->mode == PROTO_MODE_TCP)
822 mode = "TCP";
823 else if (item->mode == PROTO_MODE_HTTP)
824 mode = "HTTP";
825 else
826 mode = "NONE";
827
828 if (item->side == PROTO_SIDE_BOTH)
829 side = "FE|BE";
830 else if (item->side == PROTO_SIDE_FE)
831 side = "FE";
832 else if (item->side == PROTO_SIDE_BE)
833 side = "BE";
834 else
835 side = "NONE";
836
Willy Tarreauca2a3cc2019-05-22 11:44:03 +0200837 fprintf(out, " %15s : mode=%-10s side=%-8s mux=%s\n",
838 (proto.len ? proto.ptr : "<default>"), mode, side, item->mux->name);
Christopher Faulet98d9fe22018-04-10 14:37:32 +0200839 }
840}
841
Willy Tarreau5fc311c2018-12-02 13:04:43 +0100842/* returns the first mux entry in the list matching the exact same <mux_proto>
843 * and compatible with the <proto_side> (FE or BE) and the <proto_mode> (TCP or
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200844 * HTTP). <mux_proto> can be empty. Will fall back to the first compatible mux
845 * with exactly the same <proto_mode> or with an empty name. May return
846 * null if the code improperly registered the default mux to use as a fallback.
Willy Tarreau2386be62017-09-21 19:40:52 +0200847 */
Willy Tarreau5fc311c2018-12-02 13:04:43 +0100848static inline const struct mux_proto_list *conn_get_best_mux_entry(
849 const struct ist mux_proto,
850 int proto_side, int proto_mode)
Willy Tarreau2386be62017-09-21 19:40:52 +0200851{
Christopher Faulet32f61c02018-04-10 14:33:41 +0200852 struct mux_proto_list *item;
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200853 struct mux_proto_list *fallback = NULL;
Willy Tarreau2386be62017-09-21 19:40:52 +0200854
Christopher Faulet32f61c02018-04-10 14:33:41 +0200855 list_for_each_entry(item, &mux_proto_list.list, list) {
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200856 if (!(item->side & proto_side) || !(item->mode & proto_mode))
Willy Tarreau2386be62017-09-21 19:40:52 +0200857 continue;
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200858 if (istlen(mux_proto) && isteq(mux_proto, item->token))
Willy Tarreau5fc311c2018-12-02 13:04:43 +0100859 return item;
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200860 else if (!istlen(item->token)) {
861 if (!fallback || (item->mode == proto_mode && fallback->mode != proto_mode))
862 fallback = item;
863 }
Willy Tarreau2386be62017-09-21 19:40:52 +0200864 }
Willy Tarreau5fc311c2018-12-02 13:04:43 +0100865 return fallback;
866
867}
868
869/* returns the first mux in the list matching the exact same <mux_proto> and
870 * compatible with the <proto_side> (FE or BE) and the <proto_mode> (TCP or
871 * HTTP). <mux_proto> can be empty. Will fall back to the first compatible mux
872 * with exactly the same <proto_mode> or with an empty name. May return
873 * null if the code improperly registered the default mux to use as a fallback.
874 */
875static inline const struct mux_ops *conn_get_best_mux(struct connection *conn,
876 const struct ist mux_proto,
877 int proto_side, int proto_mode)
878{
879 const struct mux_proto_list *item;
880
881 item = conn_get_best_mux_entry(mux_proto, proto_side, proto_mode);
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200882
Willy Tarreau5fc311c2018-12-02 13:04:43 +0100883 return item ? item->mux : NULL;
Willy Tarreau2386be62017-09-21 19:40:52 +0200884}
885
Willy Tarreau57f81852018-09-06 14:52:21 +0200886/* returns 0 if the connection is valid and is a frontend connection, otherwise
887 * returns 1 indicating it's a backend connection. And uninitialized connection
888 * also returns 1 to better handle the usage in the middle of initialization.
889 */
890static inline int conn_is_back(const struct connection *conn)
891{
892 return !objt_listener(conn->target);
893}
894
Willy Tarreau6ac98ac2018-09-06 11:48:44 +0200895/* returns a pointer to the proxy associated with this connection. For a front
896 * connection it returns a pointer to the frontend ; for a back connection, it
897 * returns a pointer to the backend.
898 */
899static inline struct proxy *conn_get_proxy(const struct connection *conn)
900{
901 struct listener *l;
902 struct server *s;
903
904 /* check if it's a frontend connection */
905 l = objt_listener(conn->target);
906 if (l)
907 return l->bind_conf->frontend;
908
909 /* check if it's a backend connection */
910 s = objt_server(conn->target);
911 if (s)
912 return s->proxy;
913
914 return objt_proxy(conn->target);
915}
916
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200917/* installs the best mux for incoming connection <conn> using the upper context
918 * <ctx>. If the mux protocol is forced, we use it to find the best
919 * mux. Otherwise we use the ALPN name, if any. Returns < 0 on error.
Willy Tarreau2386be62017-09-21 19:40:52 +0200920 */
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200921static inline int conn_install_mux_fe(struct connection *conn, void *ctx)
Willy Tarreau2386be62017-09-21 19:40:52 +0200922{
Willy Tarreau55e0da62018-09-20 11:26:52 +0200923 struct bind_conf *bind_conf = __objt_listener(conn->target)->bind_conf;
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200924 const struct mux_ops *mux_ops;
Willy Tarreau2386be62017-09-21 19:40:52 +0200925
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200926 if (bind_conf->mux_proto)
927 mux_ops = bind_conf->mux_proto->mux;
928 else {
929 struct ist mux_proto;
930 const char *alpn_str = NULL;
931 int alpn_len = 0;
Willy Tarreau68ad3a42018-10-22 11:49:15 +0200932 int mode;
933
Christopher Fauletc1918d12019-04-24 15:01:22 +0200934 if (bind_conf->frontend->mode == PR_MODE_HTTP)
Christopher Fauletc985f6c2019-07-15 11:42:52 +0200935 mode = PROTO_MODE_HTTP;
Willy Tarreau68ad3a42018-10-22 11:49:15 +0200936 else
Christopher Fauletc1918d12019-04-24 15:01:22 +0200937 mode = PROTO_MODE_TCP;
Willy Tarreau2386be62017-09-21 19:40:52 +0200938
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200939 conn_get_alpn(conn, &alpn_str, &alpn_len);
940 mux_proto = ist2(alpn_str, alpn_len);
941 mux_ops = conn_get_best_mux(conn, mux_proto, PROTO_SIDE_FE, mode);
942 if (!mux_ops)
943 return -1;
944 }
Olivier Houchardf502aca2018-12-14 19:42:40 +0100945 return conn_install_mux(conn, mux_ops, ctx, bind_conf->frontend, conn->owner);
Willy Tarreau2386be62017-09-21 19:40:52 +0200946}
947
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200948/* installs the best mux for outgoing connection <conn> using the upper context
949 * <ctx>. If the mux protocol is forced, we use it to find the best mux. Returns
Willy Tarreau2e0b2b52017-09-15 06:59:55 +0200950 * < 0 on error.
Willy Tarreau2386be62017-09-21 19:40:52 +0200951 */
Olivier Houchardf502aca2018-12-14 19:42:40 +0100952static inline int conn_install_mux_be(struct connection *conn, void *ctx, struct session *sess)
Willy Tarreau2386be62017-09-21 19:40:52 +0200953{
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200954 struct server *srv = objt_server(conn->target);
Willy Tarreau287527a2018-08-08 18:40:44 +0200955 struct proxy *prx = objt_proxy(conn->target);
Willy Tarreau2386be62017-09-21 19:40:52 +0200956 const struct mux_ops *mux_ops;
957
Willy Tarreau287527a2018-08-08 18:40:44 +0200958 if (srv)
959 prx = srv->proxy;
960
961 if (!prx) // target must be either proxy or server
962 return -1;
963
964 if (srv && srv->mux_proto)
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200965 mux_ops = srv->mux_proto->mux;
966 else {
Olivier Houchard201b9f42018-11-21 00:16:29 +0100967 struct ist mux_proto;
968 const char *alpn_str = NULL;
969 int alpn_len = 0;
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200970 int mode;
971
Christopher Fauletc1918d12019-04-24 15:01:22 +0200972 if (prx->mode == PR_MODE_HTTP)
Christopher Fauletc985f6c2019-07-15 11:42:52 +0200973 mode = PROTO_MODE_HTTP;
Willy Tarreau68ad3a42018-10-22 11:49:15 +0200974 else
Christopher Fauletc1918d12019-04-24 15:01:22 +0200975 mode = PROTO_MODE_TCP;
Willy Tarreau68ad3a42018-10-22 11:49:15 +0200976
Olivier Houchard201b9f42018-11-21 00:16:29 +0100977 conn_get_alpn(conn, &alpn_str, &alpn_len);
978 mux_proto = ist2(alpn_str, alpn_len);
979
980 mux_ops = conn_get_best_mux(conn, mux_proto, PROTO_SIDE_BE, mode);
Christopher Faulet7ce0c892018-04-10 15:01:45 +0200981 if (!mux_ops)
982 return -1;
983 }
Olivier Houchardf502aca2018-12-14 19:42:40 +0100984 return conn_install_mux(conn, mux_ops, ctx, prx, sess);
Willy Tarreau2386be62017-09-21 19:40:52 +0200985}
986
Olivier Houchard2ab3dad2019-07-03 13:08:18 +0200987/* Change the mux for the connection.
988 * The caller should make sure he's not subscribed to the underlying XPRT.
989 */
Christopher Fauletc0016d82019-04-08 10:42:41 +0200990static inline int conn_upgrade_mux_fe(struct connection *conn, void *ctx, struct buffer *buf,
991 struct ist mux_proto, int mode)
992{
993 struct bind_conf *bind_conf = __objt_listener(conn->target)->bind_conf;
994 const struct mux_ops *old_mux, *new_mux;
995 void *old_mux_ctx;
996 const char *alpn_str = NULL;
997 int alpn_len = 0;
998
999 if (!mux_proto.len) {
1000 conn_get_alpn(conn, &alpn_str, &alpn_len);
1001 mux_proto = ist2(alpn_str, alpn_len);
1002 }
1003 new_mux = conn_get_best_mux(conn, mux_proto, PROTO_SIDE_FE, mode);
1004 old_mux = conn->mux;
1005
1006 /* No mux found */
1007 if (!new_mux)
1008 return -1;
1009
1010 /* Same mux, nothing to do */
1011 if (old_mux == new_mux)
1012 return 0;
1013
1014 old_mux_ctx = conn->ctx;
1015 conn->mux = new_mux;
1016 conn->ctx = ctx;
Christopher Fauletc0016d82019-04-08 10:42:41 +02001017 if (new_mux->init(conn, bind_conf->frontend, conn->owner, buf) == -1) {
1018 /* The mux upgrade failed, so restore the old mux */
1019 conn->ctx = old_mux_ctx;
1020 conn->mux = old_mux;
1021 return -1;
1022 }
1023
1024 /* The mux was upgraded, destroy the old one */
1025 *buf = BUF_NULL;
1026 old_mux->destroy(old_mux_ctx);
1027 return 0;
1028}
1029
Willy Tarreau59f98392012-07-06 14:13:49 +02001030#endif /* _PROTO_CONNECTION_H */
1031
1032/*
1033 * Local variables:
1034 * c-indent-level: 8
1035 * c-basic-offset: 8
1036 * End:
1037 */