Willy Tarreau | 59f9839 | 2012-07-06 14:13:49 +0200 | [diff] [blame] | 1 | /* |
| 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 Tarreau | 2386be6 | 2017-09-21 19:40:52 +0200 | [diff] [blame] | 26 | #include <common/ist.h> |
Willy Tarreau | f2943dc | 2012-10-26 20:10:28 +0200 | [diff] [blame] | 27 | #include <common/memory.h> |
Willy Tarreau | 59f9839 | 2012-07-06 14:13:49 +0200 | [diff] [blame] | 28 | #include <types/connection.h> |
Willy Tarreau | d1d5454 | 2012-09-12 22:58:11 +0200 | [diff] [blame] | 29 | #include <types/listener.h> |
Willy Tarreau | 2b199c9 | 2012-11-23 17:32:21 +0100 | [diff] [blame] | 30 | #include <proto/fd.h> |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 31 | #include <proto/obj_type.h> |
Willy Tarreau | 59f9839 | 2012-07-06 14:13:49 +0200 | [diff] [blame] | 32 | |
Willy Tarreau | f2943dc | 2012-10-26 20:10:28 +0200 | [diff] [blame] | 33 | extern struct pool_head *pool2_connection; |
Willy Tarreau | 13e1410 | 2016-12-22 20:25:26 +0100 | [diff] [blame] | 34 | extern struct xprt_ops *registered_xprt[XPRT_ENTRIES]; |
Willy Tarreau | 2386be6 | 2017-09-21 19:40:52 +0200 | [diff] [blame] | 35 | extern struct alpn_mux_list alpn_mux_list; |
Willy Tarreau | f2943dc | 2012-10-26 20:10:28 +0200 | [diff] [blame] | 36 | |
| 37 | /* perform minimal intializations, report 0 in case of error, 1 if OK. */ |
| 38 | int init_connection(); |
| 39 | |
Willy Tarreau | 59f9839 | 2012-07-06 14:13:49 +0200 | [diff] [blame] | 40 | /* I/O callback for fd-based connections. It calls the read/write handlers |
Willy Tarreau | 7a798e5 | 2016-04-14 11:13:20 +0200 | [diff] [blame] | 41 | * provided by the connection's sock_ops. |
Willy Tarreau | 59f9839 | 2012-07-06 14:13:49 +0200 | [diff] [blame] | 42 | */ |
Willy Tarreau | 7a798e5 | 2016-04-14 11:13:20 +0200 | [diff] [blame] | 43 | void conn_fd_handler(int fd); |
Willy Tarreau | 59f9839 | 2012-07-06 14:13:49 +0200 | [diff] [blame] | 44 | |
Willy Tarreau | 22cda21 | 2012-08-31 17:43:29 +0200 | [diff] [blame] | 45 | /* receive a PROXY protocol header over a connection */ |
| 46 | int conn_recv_proxy(struct connection *conn, int flag); |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 47 | int make_proxy_line(char *buf, int buf_len, struct server *srv, struct connection *remote); |
| 48 | int make_proxy_line_v1(char *buf, int buf_len, struct sockaddr_storage *src, struct sockaddr_storage *dst); |
| 49 | int make_proxy_line_v2(char *buf, int buf_len, struct server *srv, struct connection *remote); |
Willy Tarreau | 22cda21 | 2012-08-31 17:43:29 +0200 | [diff] [blame] | 50 | |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 51 | /* receive a NetScaler Client IP insertion header over a connection */ |
| 52 | int conn_recv_netscaler_cip(struct connection *conn, int flag); |
| 53 | |
Willy Tarreau | ff3e648 | 2015-03-12 23:56:52 +0100 | [diff] [blame] | 54 | /* raw send() directly on the socket */ |
| 55 | int conn_sock_send(struct connection *conn, const void *buf, int len, int flags); |
| 56 | |
Willy Tarreau | d85c485 | 2015-03-13 00:40:28 +0100 | [diff] [blame] | 57 | /* drains any pending bytes from the socket */ |
| 58 | int conn_sock_drain(struct connection *conn); |
| 59 | |
Willy Tarreau | d02cdd2 | 2013-12-15 10:23:20 +0100 | [diff] [blame] | 60 | /* returns true is the transport layer is ready */ |
Willy Tarreau | aad6938 | 2014-01-23 14:21:42 +0100 | [diff] [blame] | 61 | static inline int conn_xprt_ready(const struct connection *conn) |
Willy Tarreau | d02cdd2 | 2013-12-15 10:23:20 +0100 | [diff] [blame] | 62 | { |
Willy Tarreau | aad6938 | 2014-01-23 14:21:42 +0100 | [diff] [blame] | 63 | return (conn->flags & CO_FL_XPRT_READY); |
Willy Tarreau | d02cdd2 | 2013-12-15 10:23:20 +0100 | [diff] [blame] | 64 | } |
| 65 | |
| 66 | /* returns true is the control layer is ready */ |
Willy Tarreau | 3c72872 | 2014-01-23 13:50:42 +0100 | [diff] [blame] | 67 | static inline int conn_ctrl_ready(const struct connection *conn) |
Willy Tarreau | d02cdd2 | 2013-12-15 10:23:20 +0100 | [diff] [blame] | 68 | { |
| 69 | return (conn->flags & CO_FL_CTRL_READY); |
| 70 | } |
| 71 | |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 72 | /* Calls the init() function of the transport layer if any and if not done yet, |
| 73 | * and sets the CO_FL_XPRT_READY flag to indicate it was properly initialized. |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 74 | * Returns <0 in case of error. |
Willy Tarreau | 15678ef | 2012-08-31 13:54:11 +0200 | [diff] [blame] | 75 | */ |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 76 | static inline int conn_xprt_init(struct connection *conn) |
Willy Tarreau | 15678ef | 2012-08-31 13:54:11 +0200 | [diff] [blame] | 77 | { |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 78 | int ret = 0; |
| 79 | |
Willy Tarreau | aad6938 | 2014-01-23 14:21:42 +0100 | [diff] [blame] | 80 | if (!conn_xprt_ready(conn) && conn->xprt && conn->xprt->init) |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 81 | ret = conn->xprt->init(conn); |
| 82 | |
| 83 | if (ret >= 0) |
| 84 | conn->flags |= CO_FL_XPRT_READY; |
| 85 | |
| 86 | return ret; |
Willy Tarreau | 15678ef | 2012-08-31 13:54:11 +0200 | [diff] [blame] | 87 | } |
| 88 | |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 89 | /* Calls the close() function of the transport layer if any and if not done |
| 90 | * yet, and clears the CO_FL_XPRT_READY flag. However this is not done if the |
| 91 | * CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the |
| 92 | * transport layer very late if needed. |
Willy Tarreau | 6c03a64 | 2012-10-12 17:00:05 +0200 | [diff] [blame] | 93 | */ |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 94 | static inline void conn_xprt_close(struct connection *conn) |
Willy Tarreau | 8b11708 | 2012-08-06 15:06:49 +0200 | [diff] [blame] | 95 | { |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 96 | if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_XPRT_TRACKED)) == CO_FL_XPRT_READY) { |
Willy Tarreau | aad6938 | 2014-01-23 14:21:42 +0100 | [diff] [blame] | 97 | if (conn->xprt->close) |
Willy Tarreau | 6c03a64 | 2012-10-12 17:00:05 +0200 | [diff] [blame] | 98 | conn->xprt->close(conn); |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 99 | conn->flags &= ~CO_FL_XPRT_READY; |
| 100 | } |
| 101 | } |
| 102 | |
| 103 | /* Initializes the connection's control layer which essentially consists in |
| 104 | * registering the file descriptor for polling and setting the CO_FL_CTRL_READY |
Willy Tarreau | 3c72872 | 2014-01-23 13:50:42 +0100 | [diff] [blame] | 105 | * flag. The caller is responsible for ensuring that the control layer is |
| 106 | * already assigned to the connection prior to the call. |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 107 | */ |
| 108 | static inline void conn_ctrl_init(struct connection *conn) |
| 109 | { |
Willy Tarreau | 3c72872 | 2014-01-23 13:50:42 +0100 | [diff] [blame] | 110 | if (!conn_ctrl_ready(conn)) { |
Willy Tarreau | 585744b | 2017-08-24 14:31:19 +0200 | [diff] [blame] | 111 | int fd = conn->handle.fd; |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 112 | |
Christopher Faulet | 576c5aa | 2017-09-05 09:51:57 +0200 | [diff] [blame] | 113 | fdtab[fd].owner = conn; |
| 114 | fdtab[fd].iocb = conn_fd_handler; |
Christopher Faulet | 36716a7 | 2017-05-30 11:07:16 +0200 | [diff] [blame] | 115 | fd_insert(fd, tid_bit); |
Willy Tarreau | f817e9f | 2014-01-10 16:58:45 +0100 | [diff] [blame] | 116 | /* mark the fd as ready so as not to needlessly poll at the beginning */ |
| 117 | fd_may_recv(fd); |
| 118 | fd_may_send(fd); |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 119 | conn->flags |= CO_FL_CTRL_READY; |
Willy Tarreau | 6c03a64 | 2012-10-12 17:00:05 +0200 | [diff] [blame] | 120 | } |
Willy Tarreau | 8b11708 | 2012-08-06 15:06:49 +0200 | [diff] [blame] | 121 | } |
| 122 | |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 123 | /* Deletes the FD if the transport layer is already gone. Once done, |
| 124 | * it then removes the CO_FL_CTRL_READY flag. |
| 125 | */ |
| 126 | static inline void conn_ctrl_close(struct connection *conn) |
| 127 | { |
| 128 | if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_CTRL_READY)) == CO_FL_CTRL_READY) { |
Willy Tarreau | 585744b | 2017-08-24 14:31:19 +0200 | [diff] [blame] | 129 | fd_delete(conn->handle.fd); |
Willy Tarreau | 6a0a80a | 2017-10-05 17:43:39 +0200 | [diff] [blame] | 130 | conn->handle.fd = DEAD_FD_MAGIC; |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 131 | conn->flags &= ~CO_FL_CTRL_READY; |
| 132 | } |
| 133 | } |
| 134 | |
Willy Tarreau | 2b199c9 | 2012-11-23 17:32:21 +0100 | [diff] [blame] | 135 | /* If the connection still has a transport layer, then call its close() function |
| 136 | * if any, and delete the file descriptor if a control layer is set. This is |
| 137 | * used to close everything at once and atomically. However this is not done if |
| 138 | * the CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the |
| 139 | * transport layer very late if needed. |
| 140 | */ |
| 141 | static inline void conn_full_close(struct connection *conn) |
| 142 | { |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 143 | conn_xprt_close(conn); |
| 144 | conn_ctrl_close(conn); |
| 145 | } |
| 146 | |
Willy Tarreau | dc42acd | 2017-10-05 18:09:20 +0200 | [diff] [blame] | 147 | /* stop tracking a connection, allowing conn_full_close() to always |
| 148 | * succeed. |
| 149 | */ |
| 150 | static inline void conn_stop_tracking(struct connection *conn) |
| 151 | { |
| 152 | conn->flags &= ~CO_FL_XPRT_TRACKED; |
| 153 | } |
| 154 | |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 155 | /* Update polling on connection <c>'s file descriptor depending on its current |
| 156 | * state as reported in the connection's CO_FL_CURR_* flags, reports of EAGAIN |
| 157 | * in CO_FL_WAIT_*, and the sock layer expectations indicated by CO_FL_SOCK_*. |
| 158 | * The connection flags are updated with the new flags at the end of the |
Willy Tarreau | 0ffde2c | 2012-10-04 22:21:15 +0200 | [diff] [blame] | 159 | * operation. Polling is totally disabled if an error was reported. |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 160 | */ |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 161 | void conn_update_sock_polling(struct connection *c); |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 162 | |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 163 | /* Update polling on connection <c>'s file descriptor depending on its current |
| 164 | * state as reported in the connection's CO_FL_CURR_* flags, reports of EAGAIN |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 165 | * in CO_FL_WAIT_*, and the upper layer expectations indicated by CO_FL_XPRT_*. |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 166 | * The connection flags are updated with the new flags at the end of the |
Willy Tarreau | 0ffde2c | 2012-10-04 22:21:15 +0200 | [diff] [blame] | 167 | * operation. Polling is totally disabled if an error was reported. |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 168 | */ |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 169 | void conn_update_xprt_polling(struct connection *c); |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 170 | |
Willy Tarreau | 7d28149 | 2012-12-16 19:19:13 +0100 | [diff] [blame] | 171 | /* Refresh the connection's polling flags from its file descriptor status. |
Willy Tarreau | 916e12d | 2017-10-25 09:22:43 +0200 | [diff] [blame] | 172 | * This should be called at the beginning of a connection handler. It does |
| 173 | * nothing if CO_FL_WILL_UPDATE is present, indicating that an upper caller |
| 174 | * has already done it. |
Willy Tarreau | 7d28149 | 2012-12-16 19:19:13 +0100 | [diff] [blame] | 175 | */ |
| 176 | static inline void conn_refresh_polling_flags(struct connection *conn) |
| 177 | { |
Willy Tarreau | 916e12d | 2017-10-25 09:22:43 +0200 | [diff] [blame] | 178 | if (conn_ctrl_ready(conn) && !(conn->flags & CO_FL_WILL_UPDATE)) { |
Willy Tarreau | bc97cc4 | 2017-10-25 10:28:45 +0200 | [diff] [blame] | 179 | unsigned int flags = conn->flags; |
Willy Tarreau | 7d28149 | 2012-12-16 19:19:13 +0100 | [diff] [blame] | 180 | |
Willy Tarreau | bc97cc4 | 2017-10-25 10:28:45 +0200 | [diff] [blame] | 181 | flags &= ~(CO_FL_CURR_RD_ENA | CO_FL_CURR_WR_ENA | CO_FL_WAIT_ROOM); |
Willy Tarreau | 585744b | 2017-08-24 14:31:19 +0200 | [diff] [blame] | 182 | if (fd_recv_active(conn->handle.fd)) |
Willy Tarreau | 7d28149 | 2012-12-16 19:19:13 +0100 | [diff] [blame] | 183 | flags |= CO_FL_CURR_RD_ENA; |
Willy Tarreau | 585744b | 2017-08-24 14:31:19 +0200 | [diff] [blame] | 184 | if (fd_send_active(conn->handle.fd)) |
Willy Tarreau | 7d28149 | 2012-12-16 19:19:13 +0100 | [diff] [blame] | 185 | flags |= CO_FL_CURR_WR_ENA; |
| 186 | conn->flags = flags; |
| 187 | } |
| 188 | } |
| 189 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 190 | /* inspects c->flags and returns non-zero if XPRT ENA changes from the CURR ENA |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 191 | * or if the WAIT flags are set with their respective ENA flags. Additionally, |
Willy Tarreau | 0ffde2c | 2012-10-04 22:21:15 +0200 | [diff] [blame] | 192 | * non-zero is also returned if an error was reported on the connection. This |
| 193 | * function is used quite often and is inlined. In order to proceed optimally |
| 194 | * with very little code and CPU cycles, the bits are arranged so that a change |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 195 | * can be detected by a few left shifts, a xor, and a mask. These operations |
| 196 | * detect when W&D are both enabled for either direction, when C&D differ for |
| 197 | * either direction and when Error is set. The trick consists in first keeping |
| 198 | * only the bits we're interested in, since they don't collide when shifted, |
| 199 | * and to perform the AND at the end. In practice, the compiler is able to |
| 200 | * replace the last AND with a TEST in boolean conditions. This results in |
| 201 | * checks that are done in 4-6 cycles and less than 30 bytes. |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 202 | */ |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 203 | static inline unsigned int conn_xprt_polling_changes(const struct connection *c) |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 204 | { |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 205 | unsigned int f = c->flags; |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 206 | f &= CO_FL_XPRT_WR_ENA | CO_FL_XPRT_RD_ENA | CO_FL_CURR_WR_ENA | |
Willy Tarreau | 310987a | 2014-01-22 19:46:33 +0100 | [diff] [blame] | 207 | CO_FL_CURR_RD_ENA | CO_FL_ERROR; |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 208 | |
Willy Tarreau | 310987a | 2014-01-22 19:46:33 +0100 | [diff] [blame] | 209 | f = (f ^ (f << 1)) & (CO_FL_CURR_WR_ENA|CO_FL_CURR_RD_ENA); /* test C ^ D */ |
| 210 | return f & (CO_FL_CURR_WR_ENA | CO_FL_CURR_RD_ENA | CO_FL_ERROR); |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 211 | } |
| 212 | |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 213 | /* inspects c->flags and returns non-zero if SOCK ENA changes from the CURR ENA |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 214 | * or if the WAIT flags are set with their respective ENA flags. Additionally, |
Willy Tarreau | 0ffde2c | 2012-10-04 22:21:15 +0200 | [diff] [blame] | 215 | * non-zero is also returned if an error was reported on the connection. This |
| 216 | * function is used quite often and is inlined. In order to proceed optimally |
| 217 | * with very little code and CPU cycles, the bits are arranged so that a change |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 218 | * can be detected by a few left shifts, a xor, and a mask. These operations |
| 219 | * detect when W&S are both enabled for either direction, when C&S differ for |
| 220 | * either direction and when Error is set. The trick consists in first keeping |
| 221 | * only the bits we're interested in, since they don't collide when shifted, |
| 222 | * and to perform the AND at the end. In practice, the compiler is able to |
| 223 | * replace the last AND with a TEST in boolean conditions. This results in |
| 224 | * checks that are done in 4-6 cycles and less than 30 bytes. |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 225 | */ |
| 226 | static inline unsigned int conn_sock_polling_changes(const struct connection *c) |
| 227 | { |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 228 | unsigned int f = c->flags; |
| 229 | f &= CO_FL_SOCK_WR_ENA | CO_FL_SOCK_RD_ENA | CO_FL_CURR_WR_ENA | |
Willy Tarreau | 310987a | 2014-01-22 19:46:33 +0100 | [diff] [blame] | 230 | CO_FL_CURR_RD_ENA | CO_FL_ERROR; |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 231 | |
Willy Tarreau | 310987a | 2014-01-22 19:46:33 +0100 | [diff] [blame] | 232 | f = (f ^ (f << 2)) & (CO_FL_CURR_WR_ENA|CO_FL_CURR_RD_ENA); /* test C ^ S */ |
| 233 | return f & (CO_FL_CURR_WR_ENA | CO_FL_CURR_RD_ENA | CO_FL_ERROR); |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 234 | } |
| 235 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 236 | /* Automatically updates polling on connection <c> depending on the XPRT flags |
Willy Tarreau | 916e12d | 2017-10-25 09:22:43 +0200 | [diff] [blame] | 237 | * if no handshake is in progress. It does nothing if CO_FL_WILL_UPDATE is |
| 238 | * present, indicating that an upper caller is going to do it again later. |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 239 | */ |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 240 | static inline void conn_cond_update_xprt_polling(struct connection *c) |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 241 | { |
Willy Tarreau | 916e12d | 2017-10-25 09:22:43 +0200 | [diff] [blame] | 242 | if (!(c->flags & CO_FL_WILL_UPDATE)) |
| 243 | if (!(c->flags & CO_FL_POLL_SOCK) && conn_xprt_polling_changes(c)) |
| 244 | conn_update_xprt_polling(c); |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 245 | } |
| 246 | |
| 247 | /* Automatically updates polling on connection <c> depending on the SOCK flags |
Willy Tarreau | 916e12d | 2017-10-25 09:22:43 +0200 | [diff] [blame] | 248 | * if a handshake is in progress. It does nothing if CO_FL_WILL_UPDATE is |
| 249 | * present, indicating that an upper caller is going to do it again later. |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 250 | */ |
| 251 | static inline void conn_cond_update_sock_polling(struct connection *c) |
| 252 | { |
Willy Tarreau | 916e12d | 2017-10-25 09:22:43 +0200 | [diff] [blame] | 253 | if (!(c->flags & CO_FL_WILL_UPDATE)) |
| 254 | if ((c->flags & CO_FL_POLL_SOCK) && conn_sock_polling_changes(c)) |
| 255 | conn_update_sock_polling(c); |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 256 | } |
| 257 | |
Willy Tarreau | 36fb02c | 2012-11-24 11:09:07 +0100 | [diff] [blame] | 258 | /* Stop all polling on the fd. This might be used when an error is encountered |
Willy Tarreau | 916e12d | 2017-10-25 09:22:43 +0200 | [diff] [blame] | 259 | * for example. It does not propage the change to the fd layer if |
| 260 | * CO_FL_WILL_UPDATE is present, indicating that an upper caller is going to do |
| 261 | * it later. |
Willy Tarreau | 36fb02c | 2012-11-24 11:09:07 +0100 | [diff] [blame] | 262 | */ |
| 263 | static inline void conn_stop_polling(struct connection *c) |
| 264 | { |
| 265 | c->flags &= ~(CO_FL_CURR_RD_ENA | CO_FL_CURR_WR_ENA | |
| 266 | CO_FL_SOCK_RD_ENA | CO_FL_SOCK_WR_ENA | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 267 | CO_FL_XPRT_RD_ENA | CO_FL_XPRT_WR_ENA); |
Willy Tarreau | 916e12d | 2017-10-25 09:22:43 +0200 | [diff] [blame] | 268 | if (!(c->flags & CO_FL_WILL_UPDATE) && conn_ctrl_ready(c)) |
Willy Tarreau | 585744b | 2017-08-24 14:31:19 +0200 | [diff] [blame] | 269 | fd_stop_both(c->handle.fd); |
Willy Tarreau | 36fb02c | 2012-11-24 11:09:07 +0100 | [diff] [blame] | 270 | } |
| 271 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 272 | /* Automatically update polling on connection <c> depending on the XPRT and |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 273 | * SOCK flags, and on whether a handshake is in progress or not. This may be |
| 274 | * called at any moment when there is a doubt about the effectiveness of the |
| 275 | * polling state, for instance when entering or leaving the handshake state. |
Willy Tarreau | 916e12d | 2017-10-25 09:22:43 +0200 | [diff] [blame] | 276 | * It does nothing if CO_FL_WILL_UPDATE is present, indicating that an upper |
| 277 | * caller is going to do it again later. |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 278 | */ |
| 279 | static inline void conn_cond_update_polling(struct connection *c) |
| 280 | { |
Willy Tarreau | 36fb02c | 2012-11-24 11:09:07 +0100 | [diff] [blame] | 281 | if (unlikely(c->flags & CO_FL_ERROR)) |
| 282 | conn_stop_polling(c); |
Willy Tarreau | 916e12d | 2017-10-25 09:22:43 +0200 | [diff] [blame] | 283 | else if (!(c->flags & CO_FL_WILL_UPDATE)) { |
| 284 | if (!(c->flags & CO_FL_POLL_SOCK) && conn_xprt_polling_changes(c)) |
| 285 | conn_update_xprt_polling(c); |
| 286 | else if ((c->flags & CO_FL_POLL_SOCK) && conn_sock_polling_changes(c)) |
| 287 | conn_update_sock_polling(c); |
| 288 | } |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 289 | } |
| 290 | |
| 291 | /***** Event manipulation primitives for use by DATA I/O callbacks *****/ |
| 292 | /* The __conn_* versions do not propagate to lower layers and are only meant |
| 293 | * to be used by handlers called by the connection handler. The other ones |
| 294 | * may be used anywhere. |
| 295 | */ |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 296 | static inline void __conn_xprt_want_recv(struct connection *c) |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 297 | { |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 298 | c->flags |= CO_FL_XPRT_RD_ENA; |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 299 | } |
| 300 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 301 | static inline void __conn_xprt_stop_recv(struct connection *c) |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 302 | { |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 303 | c->flags &= ~CO_FL_XPRT_RD_ENA; |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 304 | } |
| 305 | |
Willy Tarreau | 796c5b7 | 2016-11-29 21:47:02 +0100 | [diff] [blame] | 306 | /* this one is used only to stop speculative recv(). It doesn't stop it if the |
| 307 | * fd is already polled in order to avoid expensive polling status changes. |
| 308 | * Since it might require the upper layer to re-enable reading, we'll return 1 |
| 309 | * if we've really stopped something otherwise zero. |
| 310 | */ |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 311 | static inline int __conn_xprt_done_recv(struct connection *c) |
Willy Tarreau | 796c5b7 | 2016-11-29 21:47:02 +0100 | [diff] [blame] | 312 | { |
Willy Tarreau | 585744b | 2017-08-24 14:31:19 +0200 | [diff] [blame] | 313 | if (!conn_ctrl_ready(c) || !fd_recv_polled(c->handle.fd)) { |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 314 | c->flags &= ~CO_FL_XPRT_RD_ENA; |
Willy Tarreau | 796c5b7 | 2016-11-29 21:47:02 +0100 | [diff] [blame] | 315 | return 1; |
| 316 | } |
| 317 | return 0; |
| 318 | } |
| 319 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 320 | static inline void __conn_xprt_want_send(struct connection *c) |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 321 | { |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 322 | c->flags |= CO_FL_XPRT_WR_ENA; |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 323 | } |
| 324 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 325 | static inline void __conn_xprt_stop_send(struct connection *c) |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 326 | { |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 327 | c->flags &= ~CO_FL_XPRT_WR_ENA; |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 328 | } |
| 329 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 330 | static inline void __conn_xprt_stop_both(struct connection *c) |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 331 | { |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 332 | c->flags &= ~(CO_FL_XPRT_WR_ENA | CO_FL_XPRT_RD_ENA); |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 333 | } |
| 334 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 335 | static inline void conn_xprt_want_recv(struct connection *c) |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 336 | { |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 337 | __conn_xprt_want_recv(c); |
| 338 | conn_cond_update_xprt_polling(c); |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 339 | } |
| 340 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 341 | static inline void conn_xprt_stop_recv(struct connection *c) |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 342 | { |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 343 | __conn_xprt_stop_recv(c); |
| 344 | conn_cond_update_xprt_polling(c); |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 345 | } |
| 346 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 347 | static inline void conn_xprt_want_send(struct connection *c) |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 348 | { |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 349 | __conn_xprt_want_send(c); |
| 350 | conn_cond_update_xprt_polling(c); |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 351 | } |
| 352 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 353 | static inline void conn_xprt_stop_send(struct connection *c) |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 354 | { |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 355 | __conn_xprt_stop_send(c); |
| 356 | conn_cond_update_xprt_polling(c); |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 357 | } |
| 358 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 359 | static inline void conn_xprt_stop_both(struct connection *c) |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 360 | { |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 361 | __conn_xprt_stop_both(c); |
| 362 | conn_cond_update_xprt_polling(c); |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 363 | } |
| 364 | |
| 365 | /***** Event manipulation primitives for use by handshake I/O callbacks *****/ |
| 366 | /* The __conn_* versions do not propagate to lower layers and are only meant |
| 367 | * to be used by handlers called by the connection handler. The other ones |
| 368 | * may be used anywhere. |
| 369 | */ |
| 370 | static inline void __conn_sock_want_recv(struct connection *c) |
| 371 | { |
| 372 | c->flags |= CO_FL_SOCK_RD_ENA; |
| 373 | } |
| 374 | |
| 375 | static inline void __conn_sock_stop_recv(struct connection *c) |
| 376 | { |
| 377 | c->flags &= ~CO_FL_SOCK_RD_ENA; |
| 378 | } |
| 379 | |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 380 | static inline void __conn_sock_want_send(struct connection *c) |
| 381 | { |
| 382 | c->flags |= CO_FL_SOCK_WR_ENA; |
| 383 | } |
| 384 | |
| 385 | static inline void __conn_sock_stop_send(struct connection *c) |
| 386 | { |
| 387 | c->flags &= ~CO_FL_SOCK_WR_ENA; |
| 388 | } |
| 389 | |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 390 | static inline void __conn_sock_stop_both(struct connection *c) |
| 391 | { |
| 392 | c->flags &= ~(CO_FL_SOCK_WR_ENA | CO_FL_SOCK_RD_ENA); |
| 393 | } |
| 394 | |
| 395 | static inline void conn_sock_want_recv(struct connection *c) |
| 396 | { |
| 397 | __conn_sock_want_recv(c); |
| 398 | conn_cond_update_sock_polling(c); |
| 399 | } |
| 400 | |
| 401 | static inline void conn_sock_stop_recv(struct connection *c) |
| 402 | { |
| 403 | __conn_sock_stop_recv(c); |
| 404 | conn_cond_update_sock_polling(c); |
| 405 | } |
| 406 | |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 407 | static inline void conn_sock_want_send(struct connection *c) |
| 408 | { |
| 409 | __conn_sock_want_send(c); |
| 410 | conn_cond_update_sock_polling(c); |
| 411 | } |
| 412 | |
| 413 | static inline void conn_sock_stop_send(struct connection *c) |
| 414 | { |
| 415 | __conn_sock_stop_send(c); |
| 416 | conn_cond_update_sock_polling(c); |
| 417 | } |
| 418 | |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 419 | static inline void conn_sock_stop_both(struct connection *c) |
| 420 | { |
| 421 | __conn_sock_stop_both(c); |
| 422 | conn_cond_update_sock_polling(c); |
| 423 | } |
Willy Tarreau | 8b11708 | 2012-08-06 15:06:49 +0200 | [diff] [blame] | 424 | |
Willy Tarreau | 7b271b2 | 2017-10-25 09:59:22 +0200 | [diff] [blame] | 425 | /* read shutdown, called from the rcv_buf/rcv_pipe handlers when |
| 426 | * detecting an end of connection. |
| 427 | */ |
Willy Tarreau | 3af56a9 | 2012-08-20 16:55:48 +0200 | [diff] [blame] | 428 | static inline void conn_sock_read0(struct connection *c) |
| 429 | { |
| 430 | c->flags |= CO_FL_SOCK_RD_SH; |
| 431 | __conn_sock_stop_recv(c); |
Willy Tarreau | ad38ace | 2013-12-15 14:19:38 +0100 | [diff] [blame] | 432 | /* we don't risk keeping ports unusable if we found the |
| 433 | * zero from the other side. |
| 434 | */ |
Willy Tarreau | 3c72872 | 2014-01-23 13:50:42 +0100 | [diff] [blame] | 435 | if (conn_ctrl_ready(c)) |
Willy Tarreau | 585744b | 2017-08-24 14:31:19 +0200 | [diff] [blame] | 436 | fdtab[c->handle.fd].linger_risk = 0; |
Willy Tarreau | 3af56a9 | 2012-08-20 16:55:48 +0200 | [diff] [blame] | 437 | } |
| 438 | |
Willy Tarreau | 7b271b2 | 2017-10-25 09:59:22 +0200 | [diff] [blame] | 439 | /* write shutdown, indication that the upper layer is not willing to send |
| 440 | * anything anymore and wants to close after pending data are sent. |
| 441 | */ |
Willy Tarreau | 3af56a9 | 2012-08-20 16:55:48 +0200 | [diff] [blame] | 442 | static inline void conn_sock_shutw(struct connection *c) |
| 443 | { |
| 444 | c->flags |= CO_FL_SOCK_WR_SH; |
Willy Tarreau | 7b271b2 | 2017-10-25 09:59:22 +0200 | [diff] [blame] | 445 | conn_refresh_polling_flags(c); |
Willy Tarreau | 3af56a9 | 2012-08-20 16:55:48 +0200 | [diff] [blame] | 446 | __conn_sock_stop_send(c); |
Willy Tarreau | 7b271b2 | 2017-10-25 09:59:22 +0200 | [diff] [blame] | 447 | conn_cond_update_sock_polling(c); |
| 448 | |
Willy Tarreau | f9ce57e | 2017-10-05 17:24:42 +0200 | [diff] [blame] | 449 | /* don't perform a clean shutdown if we're going to reset */ |
| 450 | if (conn_ctrl_ready(c) && !fdtab[c->handle.fd].linger_risk) |
Willy Tarreau | 585744b | 2017-08-24 14:31:19 +0200 | [diff] [blame] | 451 | shutdown(c->handle.fd, SHUT_WR); |
Willy Tarreau | 3af56a9 | 2012-08-20 16:55:48 +0200 | [diff] [blame] | 452 | } |
| 453 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 454 | static inline void conn_xprt_shutw(struct connection *c) |
Willy Tarreau | 3af56a9 | 2012-08-20 16:55:48 +0200 | [diff] [blame] | 455 | { |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 456 | __conn_xprt_stop_send(c); |
Willy Tarreau | 729c69f | 2015-03-12 22:51:10 +0100 | [diff] [blame] | 457 | |
| 458 | /* clean data-layer shutdown */ |
| 459 | if (c->xprt && c->xprt->shutw) |
| 460 | c->xprt->shutw(c, 1); |
| 461 | } |
| 462 | |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 463 | static inline void conn_xprt_shutw_hard(struct connection *c) |
Willy Tarreau | 729c69f | 2015-03-12 22:51:10 +0100 | [diff] [blame] | 464 | { |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 465 | __conn_xprt_stop_send(c); |
Willy Tarreau | 729c69f | 2015-03-12 22:51:10 +0100 | [diff] [blame] | 466 | |
| 467 | /* unclean data-layer shutdown */ |
| 468 | if (c->xprt && c->xprt->shutw) |
| 469 | c->xprt->shutw(c, 0); |
Willy Tarreau | 3af56a9 | 2012-08-20 16:55:48 +0200 | [diff] [blame] | 470 | } |
| 471 | |
| 472 | /* detect sock->data read0 transition */ |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 473 | static inline int conn_xprt_read0_pending(struct connection *c) |
Willy Tarreau | 3af56a9 | 2012-08-20 16:55:48 +0200 | [diff] [blame] | 474 | { |
Willy Tarreau | 54e917c | 2017-08-30 07:35:35 +0200 | [diff] [blame] | 475 | return (c->flags & CO_FL_SOCK_RD_SH) != 0; |
Willy Tarreau | 3af56a9 | 2012-08-20 16:55:48 +0200 | [diff] [blame] | 476 | } |
| 477 | |
Willy Tarreau | 910c6aa | 2013-10-24 15:08:37 +0200 | [diff] [blame] | 478 | /* prepares a connection to work with protocol <proto> and transport <xprt>. |
Willy Tarreau | 53a4766 | 2017-08-28 10:53:00 +0200 | [diff] [blame] | 479 | * The transport's is initialized as well, and the mux and its context are |
| 480 | * cleared. |
Willy Tarreau | 910c6aa | 2013-10-24 15:08:37 +0200 | [diff] [blame] | 481 | */ |
| 482 | static inline void conn_prepare(struct connection *conn, const struct protocol *proto, const struct xprt_ops *xprt) |
| 483 | { |
| 484 | conn->ctrl = proto; |
| 485 | conn->xprt = xprt; |
Willy Tarreau | 53a4766 | 2017-08-28 10:53:00 +0200 | [diff] [blame] | 486 | conn->mux = NULL; |
Willy Tarreau | 910c6aa | 2013-10-24 15:08:37 +0200 | [diff] [blame] | 487 | conn->xprt_st = 0; |
| 488 | conn->xprt_ctx = NULL; |
Willy Tarreau | 53a4766 | 2017-08-28 10:53:00 +0200 | [diff] [blame] | 489 | conn->mux_ctx = NULL; |
Willy Tarreau | 910c6aa | 2013-10-24 15:08:37 +0200 | [diff] [blame] | 490 | } |
| 491 | |
Willy Tarreau | d015577 | 2013-10-14 17:10:08 +0200 | [diff] [blame] | 492 | /* Initializes all required fields for a new connection. Note that it does the |
| 493 | * minimum acceptable initialization for a connection that already exists and |
| 494 | * is about to be reused. It also leaves the addresses untouched, which makes |
| 495 | * it usable across connection retries to reset a connection to a known state. |
| 496 | */ |
| 497 | static inline void conn_init(struct connection *conn) |
| 498 | { |
| 499 | conn->obj_type = OBJ_TYPE_CONN; |
| 500 | conn->flags = CO_FL_NONE; |
Willy Tarreau | d015577 | 2013-10-14 17:10:08 +0200 | [diff] [blame] | 501 | conn->data = NULL; |
Olivier Houchard | c2aae74 | 2017-09-22 18:26:28 +0200 | [diff] [blame] | 502 | conn->tmp_early_data = -1; |
Willy Tarreau | 53a4766 | 2017-08-28 10:53:00 +0200 | [diff] [blame] | 503 | conn->mux = NULL; |
| 504 | conn->mux_ctx = NULL; |
Willy Tarreau | d015577 | 2013-10-14 17:10:08 +0200 | [diff] [blame] | 505 | conn->owner = NULL; |
Willy Tarreau | b8020ce | 2013-10-24 21:10:08 +0200 | [diff] [blame] | 506 | conn->send_proxy_ofs = 0; |
Willy Tarreau | 585744b | 2017-08-24 14:31:19 +0200 | [diff] [blame] | 507 | conn->handle.fd = DEAD_FD_MAGIC; |
Willy Tarreau | d015577 | 2013-10-14 17:10:08 +0200 | [diff] [blame] | 508 | conn->err_code = CO_ER_NONE; |
| 509 | conn->target = NULL; |
Willy Tarreau | 8e3c6ce | 2017-08-28 15:46:01 +0200 | [diff] [blame] | 510 | conn->xprt_done_cb = NULL; |
KOVACS Krisztian | b3e54fe | 2014-11-17 15:11:45 +0100 | [diff] [blame] | 511 | conn->proxy_netns = NULL; |
Willy Tarreau | d75d40e | 2015-08-04 17:25:58 +0200 | [diff] [blame] | 512 | LIST_INIT(&conn->list); |
Willy Tarreau | d015577 | 2013-10-14 17:10:08 +0200 | [diff] [blame] | 513 | } |
| 514 | |
Willy Tarreau | 8e3c6ce | 2017-08-28 15:46:01 +0200 | [diff] [blame] | 515 | /* sets <owner> as the connection's owner */ |
| 516 | static inline void conn_set_owner(struct connection *conn, void *owner) |
| 517 | { |
| 518 | conn->owner = owner; |
| 519 | } |
| 520 | |
| 521 | /* registers <cb> as a callback to notify for transport's readiness or failure */ |
| 522 | static inline void conn_set_xprt_done_cb(struct connection *conn, int (*cb)(struct connection *)) |
| 523 | { |
| 524 | conn->xprt_done_cb = cb; |
| 525 | } |
| 526 | |
| 527 | /* unregisters the callback to notify for transport's readiness or failure */ |
| 528 | static inline void conn_clear_xprt_done_cb(struct connection *conn) |
| 529 | { |
| 530 | conn->xprt_done_cb = NULL; |
| 531 | } |
| 532 | |
Willy Tarreau | b97f3b1 | 2013-10-20 22:56:45 +0200 | [diff] [blame] | 533 | /* Tries to allocate a new connection and initialized its main fields. The |
| 534 | * connection is returned on success, NULL on failure. The connection must |
| 535 | * be released using pool_free2() or conn_free(). |
| 536 | */ |
| 537 | static inline struct connection *conn_new() |
| 538 | { |
| 539 | struct connection *conn; |
| 540 | |
| 541 | conn = pool_alloc2(pool2_connection); |
| 542 | if (likely(conn != NULL)) |
| 543 | conn_init(conn); |
| 544 | return conn; |
| 545 | } |
| 546 | |
| 547 | /* Releases a connection previously allocated by conn_new() */ |
| 548 | static inline void conn_free(struct connection *conn) |
| 549 | { |
Willy Tarreau | 53a4766 | 2017-08-28 10:53:00 +0200 | [diff] [blame] | 550 | if (conn->mux && conn->mux->release) |
| 551 | conn->mux->release(conn); |
Willy Tarreau | b97f3b1 | 2013-10-20 22:56:45 +0200 | [diff] [blame] | 552 | pool_free2(pool2_connection, conn); |
| 553 | } |
| 554 | |
| 555 | |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 556 | /* Retrieves the connection's source address */ |
| 557 | static inline void conn_get_from_addr(struct connection *conn) |
| 558 | { |
| 559 | if (conn->flags & CO_FL_ADDR_FROM_SET) |
| 560 | return; |
| 561 | |
Willy Tarreau | 3c72872 | 2014-01-23 13:50:42 +0100 | [diff] [blame] | 562 | if (!conn_ctrl_ready(conn) || !conn->ctrl->get_src) |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 563 | return; |
| 564 | |
Willy Tarreau | 585744b | 2017-08-24 14:31:19 +0200 | [diff] [blame] | 565 | if (conn->ctrl->get_src(conn->handle.fd, (struct sockaddr *)&conn->addr.from, |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 566 | sizeof(conn->addr.from), |
| 567 | obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1) |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 568 | return; |
| 569 | conn->flags |= CO_FL_ADDR_FROM_SET; |
| 570 | } |
| 571 | |
| 572 | /* Retrieves the connection's original destination address */ |
| 573 | static inline void conn_get_to_addr(struct connection *conn) |
| 574 | { |
| 575 | if (conn->flags & CO_FL_ADDR_TO_SET) |
| 576 | return; |
| 577 | |
Willy Tarreau | 3c72872 | 2014-01-23 13:50:42 +0100 | [diff] [blame] | 578 | if (!conn_ctrl_ready(conn) || !conn->ctrl->get_dst) |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 579 | return; |
| 580 | |
Willy Tarreau | 585744b | 2017-08-24 14:31:19 +0200 | [diff] [blame] | 581 | if (conn->ctrl->get_dst(conn->handle.fd, (struct sockaddr *)&conn->addr.to, |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 582 | sizeof(conn->addr.to), |
| 583 | obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1) |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 584 | return; |
| 585 | conn->flags |= CO_FL_ADDR_TO_SET; |
| 586 | } |
| 587 | |
Willy Tarreau | 7abddb5 | 2013-10-24 15:31:04 +0200 | [diff] [blame] | 588 | /* Attaches a connection to an owner and assigns a data layer */ |
| 589 | static inline void conn_attach(struct connection *conn, void *owner, const struct data_cb *data) |
Willy Tarreau | dda5e7c | 2012-09-24 17:15:42 +0200 | [diff] [blame] | 590 | { |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 591 | conn->data = data; |
Willy Tarreau | cd37995 | 2012-09-27 22:14:33 +0200 | [diff] [blame] | 592 | conn->owner = owner; |
Willy Tarreau | bd99aab | 2012-10-02 20:57:19 +0200 | [diff] [blame] | 593 | } |
| 594 | |
Willy Tarreau | 53a4766 | 2017-08-28 10:53:00 +0200 | [diff] [blame] | 595 | /* Installs the connection's mux layer for upper context <ctx>. |
| 596 | * Returns < 0 on error. |
| 597 | */ |
| 598 | static inline int conn_install_mux(struct connection *conn, const struct mux_ops *mux, void *ctx) |
| 599 | { |
| 600 | conn->mux = mux; |
| 601 | conn->mux_ctx = ctx; |
| 602 | return mux->init ? mux->init(conn) : 0; |
| 603 | } |
| 604 | |
Willy Tarreau | 0af2912 | 2012-12-03 15:35:00 +0100 | [diff] [blame] | 605 | /* returns a human-readable error code for conn->err_code, or NULL if the code |
| 606 | * is unknown. |
| 607 | */ |
| 608 | static inline const char *conn_err_code_str(struct connection *c) |
| 609 | { |
| 610 | switch (c->err_code) { |
| 611 | case CO_ER_NONE: return "Success"; |
Willy Tarreau | 45b34e8 | 2014-01-24 16:06:50 +0100 | [diff] [blame] | 612 | |
| 613 | case CO_ER_CONF_FDLIM: return "Reached configured maxconn value"; |
| 614 | case CO_ER_PROC_FDLIM: return "Too many sockets on the process"; |
| 615 | case CO_ER_SYS_FDLIM: return "Too many sockets on the system"; |
| 616 | case CO_ER_SYS_MEMLIM: return "Out of system buffers"; |
| 617 | case CO_ER_NOPROTO: return "Protocol or address family not supported"; |
| 618 | case CO_ER_SOCK_ERR: return "General socket error"; |
| 619 | case CO_ER_PORT_RANGE: return "Source port range exhausted"; |
| 620 | case CO_ER_CANT_BIND: return "Can't bind to source address"; |
| 621 | case CO_ER_FREE_PORTS: return "Out of local source ports on the system"; |
| 622 | case CO_ER_ADDR_INUSE: return "Local source address already in use"; |
| 623 | |
Willy Tarreau | 8e3bf69 | 2012-12-03 15:41:18 +0100 | [diff] [blame] | 624 | case CO_ER_PRX_EMPTY: return "Connection closed while waiting for PROXY protocol header"; |
| 625 | case CO_ER_PRX_ABORT: return "Connection error while waiting for PROXY protocol header"; |
Willy Tarreau | 0af2912 | 2012-12-03 15:35:00 +0100 | [diff] [blame] | 626 | case CO_ER_PRX_TIMEOUT: return "Timeout while waiting for PROXY protocol header"; |
Willy Tarreau | 8e3bf69 | 2012-12-03 15:41:18 +0100 | [diff] [blame] | 627 | case CO_ER_PRX_TRUNCATED: return "Truncated PROXY protocol header received"; |
| 628 | case CO_ER_PRX_NOT_HDR: return "Received something which does not look like a PROXY protocol header"; |
| 629 | case CO_ER_PRX_BAD_HDR: return "Received an invalid PROXY protocol header"; |
| 630 | case CO_ER_PRX_BAD_PROTO: return "Received an unhandled protocol in the PROXY protocol header"; |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 631 | |
| 632 | case CO_ER_CIP_EMPTY: return "Connection closed while waiting for NetScaler Client IP header"; |
| 633 | case CO_ER_CIP_ABORT: return "Connection error while waiting for NetScaler Client IP header"; |
| 634 | case CO_ER_CIP_TRUNCATED: return "Truncated NetScaler Client IP header received"; |
| 635 | case CO_ER_CIP_BAD_MAGIC: return "Received an invalid NetScaler Client IP magic number"; |
| 636 | case CO_ER_CIP_BAD_PROTO: return "Received an unhandled protocol in the NetScaler Client IP header"; |
| 637 | |
Willy Tarreau | 20879a0 | 2012-12-03 16:32:10 +0100 | [diff] [blame] | 638 | case CO_ER_SSL_EMPTY: return "Connection closed during SSL handshake"; |
| 639 | case CO_ER_SSL_ABORT: return "Connection error during SSL handshake"; |
Willy Tarreau | 0af2912 | 2012-12-03 15:35:00 +0100 | [diff] [blame] | 640 | case CO_ER_SSL_TIMEOUT: return "Timeout during SSL handshake"; |
Willy Tarreau | 20879a0 | 2012-12-03 16:32:10 +0100 | [diff] [blame] | 641 | case CO_ER_SSL_TOO_MANY: return "Too many SSL connections"; |
| 642 | case CO_ER_SSL_NO_MEM: return "Out of memory when initializing an SSL connection"; |
| 643 | case CO_ER_SSL_RENEG: return "Rejected a client-initiated SSL renegociation attempt"; |
| 644 | case CO_ER_SSL_CA_FAIL: return "SSL client CA chain cannot be verified"; |
| 645 | case CO_ER_SSL_CRT_FAIL: return "SSL client certificate not trusted"; |
Willy Tarreau | 71d058c | 2017-07-26 20:09:56 +0200 | [diff] [blame] | 646 | case CO_ER_SSL_MISMATCH: return "Server presented an SSL certificate different from the configured one"; |
| 647 | case CO_ER_SSL_MISMATCH_SNI: return "Server presented an SSL certificate different from the expected one"; |
Willy Tarreau | 20879a0 | 2012-12-03 16:32:10 +0100 | [diff] [blame] | 648 | case CO_ER_SSL_HANDSHAKE: return "SSL handshake failure"; |
Willy Tarreau | b396637 | 2014-04-25 18:54:29 +0200 | [diff] [blame] | 649 | case CO_ER_SSL_HANDSHAKE_HB: return "SSL handshake failure after heartbeat"; |
Willy Tarreau | f51c698 | 2014-04-25 20:02:39 +0200 | [diff] [blame] | 650 | case CO_ER_SSL_KILLED_HB: return "Stopped a TLSv1 heartbeat attack (CVE-2014-0160)"; |
Willy Tarreau | 830bf61 | 2013-12-01 20:29:58 +0100 | [diff] [blame] | 651 | case CO_ER_SSL_NO_TARGET: return "Attempt to use SSL on an unknown target (internal error)"; |
Willy Tarreau | 0af2912 | 2012-12-03 15:35:00 +0100 | [diff] [blame] | 652 | } |
| 653 | return NULL; |
| 654 | } |
| 655 | |
Willy Tarreau | 2dc770c | 2016-11-23 18:00:08 +0100 | [diff] [blame] | 656 | static inline const char *conn_get_ctrl_name(const struct connection *conn) |
| 657 | { |
| 658 | if (!conn_ctrl_ready(conn)) |
| 659 | return "NONE"; |
| 660 | return conn->ctrl->name; |
| 661 | } |
| 662 | |
| 663 | static inline const char *conn_get_xprt_name(const struct connection *conn) |
| 664 | { |
Willy Tarreau | 2dc770c | 2016-11-23 18:00:08 +0100 | [diff] [blame] | 665 | if (!conn_xprt_ready(conn)) |
| 666 | return "NONE"; |
Willy Tarreau | 8e0bb0a | 2016-11-24 16:58:12 +0100 | [diff] [blame] | 667 | return conn->xprt->name; |
Willy Tarreau | 2dc770c | 2016-11-23 18:00:08 +0100 | [diff] [blame] | 668 | } |
| 669 | |
Willy Tarreau | 53a4766 | 2017-08-28 10:53:00 +0200 | [diff] [blame] | 670 | static inline const char *conn_get_mux_name(const struct connection *conn) |
| 671 | { |
| 672 | if (!conn->mux) |
| 673 | return "NONE"; |
| 674 | return conn->mux->name; |
| 675 | } |
| 676 | |
Willy Tarreau | 2dc770c | 2016-11-23 18:00:08 +0100 | [diff] [blame] | 677 | static inline const char *conn_get_data_name(const struct connection *conn) |
| 678 | { |
Willy Tarreau | 2dc770c | 2016-11-23 18:00:08 +0100 | [diff] [blame] | 679 | if (!conn->data) |
| 680 | return "NONE"; |
Willy Tarreau | 8e0bb0a | 2016-11-24 16:58:12 +0100 | [diff] [blame] | 681 | return conn->data->name; |
Willy Tarreau | 2dc770c | 2016-11-23 18:00:08 +0100 | [diff] [blame] | 682 | } |
| 683 | |
Willy Tarreau | 13e1410 | 2016-12-22 20:25:26 +0100 | [diff] [blame] | 684 | /* registers pointer to transport layer <id> (XPRT_*) */ |
| 685 | static inline void xprt_register(int id, struct xprt_ops *xprt) |
| 686 | { |
| 687 | if (id >= XPRT_ENTRIES) |
| 688 | return; |
| 689 | registered_xprt[id] = xprt; |
| 690 | } |
| 691 | |
| 692 | /* returns pointer to transport layer <id> (XPRT_*) or NULL if not registered */ |
| 693 | static inline struct xprt_ops *xprt_get(int id) |
| 694 | { |
| 695 | if (id >= XPRT_ENTRIES) |
| 696 | return NULL; |
| 697 | return registered_xprt[id]; |
| 698 | } |
Willy Tarreau | 2dc770c | 2016-11-23 18:00:08 +0100 | [diff] [blame] | 699 | |
Willy Tarreau | a9c1741 | 2016-12-04 18:42:09 +0100 | [diff] [blame] | 700 | static inline int conn_get_alpn(const struct connection *conn, const char **str, int *len) |
| 701 | { |
| 702 | if (!conn_xprt_ready(conn) || !conn->xprt->get_alpn) |
| 703 | return 0; |
| 704 | return conn->xprt->get_alpn(conn, str, len); |
| 705 | } |
| 706 | |
Willy Tarreau | 2386be6 | 2017-09-21 19:40:52 +0200 | [diff] [blame] | 707 | /* registers alpn mux list <list>. Modifies the list element! */ |
| 708 | static inline void alpn_register_mux(struct alpn_mux_list *list) |
| 709 | { |
| 710 | LIST_ADDQ(&alpn_mux_list.list, &list->list); |
| 711 | } |
| 712 | |
| 713 | /* unregisters alpn mux list <list> */ |
| 714 | static inline void alpn_unregister_mux(struct alpn_mux_list *list) |
| 715 | { |
| 716 | LIST_DEL(&list->list); |
| 717 | LIST_INIT(&list->list); |
| 718 | } |
| 719 | |
| 720 | /* returns the first mux in the list matching the exact same token and |
| 721 | * compatible with the proxy's mode (http or tcp). Mode "health" has to be |
| 722 | * considered as TCP here. Ie passing "px->mode == PR_MODE_HTTP" is fine. Will |
| 723 | * fall back to the first compatible mux with empty ALPN name. May return null |
| 724 | * if the code improperly registered the default mux to use as a fallback. |
| 725 | */ |
| 726 | static inline const struct mux_ops *alpn_get_mux(const struct ist token, int http_mode) |
| 727 | { |
| 728 | struct alpn_mux_list *item; |
| 729 | const struct mux_ops *fallback = NULL; |
| 730 | |
| 731 | http_mode = 1 << !!http_mode; |
| 732 | |
| 733 | list_for_each_entry(item, &alpn_mux_list.list, list) { |
| 734 | if (!(item->mode & http_mode)) |
| 735 | continue; |
| 736 | if (isteq(token, item->token)) |
| 737 | return item->mux; |
| 738 | if (!istlen(item->token)) |
| 739 | fallback = item->mux; |
| 740 | } |
| 741 | return fallback; |
| 742 | } |
| 743 | |
| 744 | /* finds the best mux for incoming connection <conn> and mode <http_mode> for |
| 745 | * the proxy. Null cannot be returned unless there's a serious bug somewhere |
| 746 | * else (no fallback mux registered). |
| 747 | */ |
| 748 | static inline const struct mux_ops *conn_find_best_mux(struct connection *conn, int http_mode) |
| 749 | { |
| 750 | const char *alpn_str; |
| 751 | int alpn_len; |
| 752 | |
| 753 | if (!conn_get_alpn(conn, &alpn_str, &alpn_len)) |
| 754 | alpn_len = 0; |
| 755 | |
| 756 | return alpn_get_mux(ist2(alpn_str, alpn_len), http_mode); |
| 757 | } |
| 758 | |
| 759 | /* finds the best mux for incoming connection <conn>, a proxy in and http mode |
| 760 | * <mode>, and installs it on the connection for direction <dir> (MUX_INBOUND/ |
| 761 | * MUX_OUTBOUND). Returns < 0 on error. |
| 762 | */ |
| 763 | static inline int conn_install_best_mux(struct connection *conn, int mode, enum mux_dir dir) |
| 764 | { |
| 765 | const struct mux_ops *mux_ops; |
| 766 | |
| 767 | mux_ops = conn_find_best_mux(conn, mode); |
| 768 | if (!mux_ops) |
| 769 | return -1; |
| 770 | return conn_install_mux(conn, mux_ops, dir); |
| 771 | } |
| 772 | |
Willy Tarreau | 59f9839 | 2012-07-06 14:13:49 +0200 | [diff] [blame] | 773 | #endif /* _PROTO_CONNECTION_H */ |
| 774 | |
| 775 | /* |
| 776 | * Local variables: |
| 777 | * c-indent-level: 8 |
| 778 | * c-basic-offset: 8 |
| 779 | * End: |
| 780 | */ |