blob: f50329c380239cdb7549a334a0ca07f46a2e78c1 [file] [log] [blame]
Willy Tarreau59f98392012-07-06 14:13:49 +02001/*
2 * include/proto/connection.h
3 * This file contains connection function prototypes
4 *
5 * Copyright (C) 2000-2012 Willy Tarreau - w@1wt.eu
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22#ifndef _PROTO_CONNECTION_H
23#define _PROTO_CONNECTION_H
24
25#include <common/config.h>
Willy Tarreauf2943dc2012-10-26 20:10:28 +020026#include <common/memory.h>
Willy Tarreau59f98392012-07-06 14:13:49 +020027#include <types/connection.h>
Willy Tarreaud1d54542012-09-12 22:58:11 +020028#include <types/listener.h>
Willy Tarreau2b199c92012-11-23 17:32:21 +010029#include <proto/fd.h>
Willy Tarreau3fdb3662012-11-12 00:42:33 +010030#include <proto/obj_type.h>
Willy Tarreau59f98392012-07-06 14:13:49 +020031
Willy Tarreauf2943dc2012-10-26 20:10:28 +020032extern struct pool_head *pool2_connection;
33
34/* perform minimal intializations, report 0 in case of error, 1 if OK. */
35int init_connection();
36
Willy Tarreau59f98392012-07-06 14:13:49 +020037/* I/O callback for fd-based connections. It calls the read/write handlers
Willy Tarreau7a798e52016-04-14 11:13:20 +020038 * provided by the connection's sock_ops.
Willy Tarreau59f98392012-07-06 14:13:49 +020039 */
Willy Tarreau7a798e52016-04-14 11:13:20 +020040void conn_fd_handler(int fd);
Willy Tarreau59f98392012-07-06 14:13:49 +020041
Willy Tarreau22cda212012-08-31 17:43:29 +020042/* receive a PROXY protocol header over a connection */
43int conn_recv_proxy(struct connection *conn, int flag);
David Safb76832014-05-08 23:42:08 -040044int make_proxy_line(char *buf, int buf_len, struct server *srv, struct connection *remote);
45int make_proxy_line_v1(char *buf, int buf_len, struct sockaddr_storage *src, struct sockaddr_storage *dst);
46int make_proxy_line_v2(char *buf, int buf_len, struct server *srv, struct connection *remote);
Willy Tarreau22cda212012-08-31 17:43:29 +020047
Willy Tarreauff3e6482015-03-12 23:56:52 +010048/* raw send() directly on the socket */
49int conn_sock_send(struct connection *conn, const void *buf, int len, int flags);
50
Willy Tarreaud85c4852015-03-13 00:40:28 +010051/* drains any pending bytes from the socket */
52int conn_sock_drain(struct connection *conn);
53
Willy Tarreaud02cdd22013-12-15 10:23:20 +010054/* returns true is the transport layer is ready */
Willy Tarreauaad69382014-01-23 14:21:42 +010055static inline int conn_xprt_ready(const struct connection *conn)
Willy Tarreaud02cdd22013-12-15 10:23:20 +010056{
Willy Tarreauaad69382014-01-23 14:21:42 +010057 return (conn->flags & CO_FL_XPRT_READY);
Willy Tarreaud02cdd22013-12-15 10:23:20 +010058}
59
60/* returns true is the control layer is ready */
Willy Tarreau3c728722014-01-23 13:50:42 +010061static inline int conn_ctrl_ready(const struct connection *conn)
Willy Tarreaud02cdd22013-12-15 10:23:20 +010062{
63 return (conn->flags & CO_FL_CTRL_READY);
64}
65
Willy Tarreauf79c8172013-10-21 16:30:56 +020066/* Calls the init() function of the transport layer if any and if not done yet,
67 * and sets the CO_FL_XPRT_READY flag to indicate it was properly initialized.
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020068 * Returns <0 in case of error.
Willy Tarreau15678ef2012-08-31 13:54:11 +020069 */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020070static inline int conn_xprt_init(struct connection *conn)
Willy Tarreau15678ef2012-08-31 13:54:11 +020071{
Willy Tarreauf79c8172013-10-21 16:30:56 +020072 int ret = 0;
73
Willy Tarreauaad69382014-01-23 14:21:42 +010074 if (!conn_xprt_ready(conn) && conn->xprt && conn->xprt->init)
Willy Tarreauf79c8172013-10-21 16:30:56 +020075 ret = conn->xprt->init(conn);
76
77 if (ret >= 0)
78 conn->flags |= CO_FL_XPRT_READY;
79
80 return ret;
Willy Tarreau15678ef2012-08-31 13:54:11 +020081}
82
Willy Tarreauf79c8172013-10-21 16:30:56 +020083/* Calls the close() function of the transport layer if any and if not done
84 * yet, and clears the CO_FL_XPRT_READY flag. However this is not done if the
85 * CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the
86 * transport layer very late if needed.
Willy Tarreau6c03a642012-10-12 17:00:05 +020087 */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020088static inline void conn_xprt_close(struct connection *conn)
Willy Tarreau8b117082012-08-06 15:06:49 +020089{
Willy Tarreauf79c8172013-10-21 16:30:56 +020090 if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_XPRT_TRACKED)) == CO_FL_XPRT_READY) {
Willy Tarreauaad69382014-01-23 14:21:42 +010091 if (conn->xprt->close)
Willy Tarreau6c03a642012-10-12 17:00:05 +020092 conn->xprt->close(conn);
Willy Tarreauf79c8172013-10-21 16:30:56 +020093 conn->flags &= ~CO_FL_XPRT_READY;
94 }
95}
96
97/* Initializes the connection's control layer which essentially consists in
98 * registering the file descriptor for polling and setting the CO_FL_CTRL_READY
Willy Tarreau3c728722014-01-23 13:50:42 +010099 * flag. The caller is responsible for ensuring that the control layer is
100 * already assigned to the connection prior to the call.
Willy Tarreauf79c8172013-10-21 16:30:56 +0200101 */
102static inline void conn_ctrl_init(struct connection *conn)
103{
Willy Tarreau3c728722014-01-23 13:50:42 +0100104 if (!conn_ctrl_ready(conn)) {
Willy Tarreauf79c8172013-10-21 16:30:56 +0200105 int fd = conn->t.sock.fd;
106
107 fd_insert(fd);
Willy Tarreauf817e9f2014-01-10 16:58:45 +0100108 /* mark the fd as ready so as not to needlessly poll at the beginning */
109 fd_may_recv(fd);
110 fd_may_send(fd);
Willy Tarreauf79c8172013-10-21 16:30:56 +0200111 fdtab[fd].owner = conn;
112 fdtab[fd].iocb = conn_fd_handler;
113 conn->flags |= CO_FL_CTRL_READY;
Willy Tarreau6c03a642012-10-12 17:00:05 +0200114 }
Willy Tarreau8b117082012-08-06 15:06:49 +0200115}
116
Willy Tarreauf79c8172013-10-21 16:30:56 +0200117/* Deletes the FD if the transport layer is already gone. Once done,
118 * it then removes the CO_FL_CTRL_READY flag.
119 */
120static inline void conn_ctrl_close(struct connection *conn)
121{
122 if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_CTRL_READY)) == CO_FL_CTRL_READY) {
123 fd_delete(conn->t.sock.fd);
124 conn->flags &= ~CO_FL_CTRL_READY;
125 }
126}
127
Willy Tarreau2b199c92012-11-23 17:32:21 +0100128/* If the connection still has a transport layer, then call its close() function
129 * if any, and delete the file descriptor if a control layer is set. This is
130 * used to close everything at once and atomically. However this is not done if
131 * the CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the
132 * transport layer very late if needed.
133 */
134static inline void conn_full_close(struct connection *conn)
135{
Willy Tarreauf79c8172013-10-21 16:30:56 +0200136 conn_xprt_close(conn);
137 conn_ctrl_close(conn);
138}
139
140/* Force to close the connection whatever the tracking state. This is mainly
Willy Tarreau9471b8c2013-12-15 13:31:35 +0100141 * used on the error path where the tracking does not make sense, or to kill
142 * an idle connection we want to abort immediately.
Willy Tarreauf79c8172013-10-21 16:30:56 +0200143 */
144static inline void conn_force_close(struct connection *conn)
145{
Willy Tarreauaad69382014-01-23 14:21:42 +0100146 if (conn_xprt_ready(conn) && conn->xprt->close)
Willy Tarreauf79c8172013-10-21 16:30:56 +0200147 conn->xprt->close(conn);
148
Willy Tarreau3c728722014-01-23 13:50:42 +0100149 if (conn_ctrl_ready(conn))
Willy Tarreauf79c8172013-10-21 16:30:56 +0200150 fd_delete(conn->t.sock.fd);
151
152 conn->flags &= ~(CO_FL_XPRT_READY|CO_FL_CTRL_READY);
Willy Tarreau2b199c92012-11-23 17:32:21 +0100153}
154
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200155/* 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 Tarreau0ffde2c2012-10-04 22:21:15 +0200159 * operation. Polling is totally disabled if an error was reported.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200160 */
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200161void conn_update_sock_polling(struct connection *c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200162
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200163/* 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
165 * in CO_FL_WAIT_*, and the data layer expectations indicated by CO_FL_DATA_*.
166 * The connection flags are updated with the new flags at the end of the
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200167 * operation. Polling is totally disabled if an error was reported.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200168 */
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200169void conn_update_data_polling(struct connection *c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200170
Willy Tarreau7d281492012-12-16 19:19:13 +0100171/* Refresh the connection's polling flags from its file descriptor status.
172 * This should be called at the beginning of a connection handler.
173 */
174static inline void conn_refresh_polling_flags(struct connection *conn)
175{
Willy Tarreau310987a2014-01-22 19:46:33 +0100176 conn->flags &= ~(CO_FL_WAIT_ROOM | CO_FL_WAIT_DATA);
Willy Tarreau7d281492012-12-16 19:19:13 +0100177
Willy Tarreau3c728722014-01-23 13:50:42 +0100178 if (conn_ctrl_ready(conn)) {
Willy Tarreau7d281492012-12-16 19:19:13 +0100179 unsigned int flags = conn->flags & ~(CO_FL_CURR_RD_ENA | CO_FL_CURR_WR_ENA);
180
Willy Tarreauf817e9f2014-01-10 16:58:45 +0100181 if (fd_recv_active(conn->t.sock.fd))
Willy Tarreau7d281492012-12-16 19:19:13 +0100182 flags |= CO_FL_CURR_RD_ENA;
Willy Tarreauf817e9f2014-01-10 16:58:45 +0100183 if (fd_send_active(conn->t.sock.fd))
Willy Tarreau7d281492012-12-16 19:19:13 +0100184 flags |= CO_FL_CURR_WR_ENA;
185 conn->flags = flags;
186 }
187}
188
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200189/* inspects c->flags and returns non-zero if DATA ENA changes from the CURR ENA
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100190 * or if the WAIT flags are set with their respective ENA flags. Additionally,
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200191 * non-zero is also returned if an error was reported on the connection. This
192 * function is used quite often and is inlined. In order to proceed optimally
193 * with very little code and CPU cycles, the bits are arranged so that a change
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100194 * can be detected by a few left shifts, a xor, and a mask. These operations
195 * detect when W&D are both enabled for either direction, when C&D differ for
196 * either direction and when Error is set. The trick consists in first keeping
197 * only the bits we're interested in, since they don't collide when shifted,
198 * and to perform the AND at the end. In practice, the compiler is able to
199 * replace the last AND with a TEST in boolean conditions. This results in
200 * checks that are done in 4-6 cycles and less than 30 bytes.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200201 */
202static inline unsigned int conn_data_polling_changes(const struct connection *c)
203{
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100204 unsigned int f = c->flags;
205 f &= CO_FL_DATA_WR_ENA | CO_FL_DATA_RD_ENA | CO_FL_CURR_WR_ENA |
Willy Tarreau310987a2014-01-22 19:46:33 +0100206 CO_FL_CURR_RD_ENA | CO_FL_ERROR;
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100207
Willy Tarreau310987a2014-01-22 19:46:33 +0100208 f = (f ^ (f << 1)) & (CO_FL_CURR_WR_ENA|CO_FL_CURR_RD_ENA); /* test C ^ D */
209 return f & (CO_FL_CURR_WR_ENA | CO_FL_CURR_RD_ENA | CO_FL_ERROR);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200210}
211
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200212/* inspects c->flags and returns non-zero if SOCK ENA changes from the CURR ENA
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100213 * or if the WAIT flags are set with their respective ENA flags. Additionally,
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200214 * non-zero is also returned if an error was reported on the connection. This
215 * function is used quite often and is inlined. In order to proceed optimally
216 * with very little code and CPU cycles, the bits are arranged so that a change
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100217 * can be detected by a few left shifts, a xor, and a mask. These operations
218 * detect when W&S are both enabled for either direction, when C&S differ for
219 * either direction and when Error is set. The trick consists in first keeping
220 * only the bits we're interested in, since they don't collide when shifted,
221 * and to perform the AND at the end. In practice, the compiler is able to
222 * replace the last AND with a TEST in boolean conditions. This results in
223 * checks that are done in 4-6 cycles and less than 30 bytes.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200224 */
225static inline unsigned int conn_sock_polling_changes(const struct connection *c)
226{
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100227 unsigned int f = c->flags;
228 f &= CO_FL_SOCK_WR_ENA | CO_FL_SOCK_RD_ENA | CO_FL_CURR_WR_ENA |
Willy Tarreau310987a2014-01-22 19:46:33 +0100229 CO_FL_CURR_RD_ENA | CO_FL_ERROR;
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100230
Willy Tarreau310987a2014-01-22 19:46:33 +0100231 f = (f ^ (f << 2)) & (CO_FL_CURR_WR_ENA|CO_FL_CURR_RD_ENA); /* test C ^ S */
232 return f & (CO_FL_CURR_WR_ENA | CO_FL_CURR_RD_ENA | CO_FL_ERROR);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200233}
234
235/* Automatically updates polling on connection <c> depending on the DATA flags
236 * if no handshake is in progress.
237 */
238static inline void conn_cond_update_data_polling(struct connection *c)
239{
240 if (!(c->flags & CO_FL_POLL_SOCK) && conn_data_polling_changes(c))
241 conn_update_data_polling(c);
242}
243
244/* Automatically updates polling on connection <c> depending on the SOCK flags
245 * if a handshake is in progress.
246 */
247static inline void conn_cond_update_sock_polling(struct connection *c)
248{
249 if ((c->flags & CO_FL_POLL_SOCK) && conn_sock_polling_changes(c))
250 conn_update_sock_polling(c);
251}
252
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100253/* Stop all polling on the fd. This might be used when an error is encountered
254 * for example.
255 */
256static inline void conn_stop_polling(struct connection *c)
257{
258 c->flags &= ~(CO_FL_CURR_RD_ENA | CO_FL_CURR_WR_ENA |
259 CO_FL_SOCK_RD_ENA | CO_FL_SOCK_WR_ENA |
260 CO_FL_DATA_RD_ENA | CO_FL_DATA_WR_ENA);
261 fd_stop_both(c->t.sock.fd);
262}
263
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200264/* Automatically update polling on connection <c> depending on the DATA and
265 * SOCK flags, and on whether a handshake is in progress or not. This may be
266 * called at any moment when there is a doubt about the effectiveness of the
267 * polling state, for instance when entering or leaving the handshake state.
268 */
269static inline void conn_cond_update_polling(struct connection *c)
270{
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100271 if (unlikely(c->flags & CO_FL_ERROR))
272 conn_stop_polling(c);
273 else if (!(c->flags & CO_FL_POLL_SOCK) && conn_data_polling_changes(c))
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200274 conn_update_data_polling(c);
275 else if ((c->flags & CO_FL_POLL_SOCK) && conn_sock_polling_changes(c))
276 conn_update_sock_polling(c);
277}
278
279/***** Event manipulation primitives for use by DATA I/O callbacks *****/
280/* The __conn_* versions do not propagate to lower layers and are only meant
281 * to be used by handlers called by the connection handler. The other ones
282 * may be used anywhere.
283 */
284static inline void __conn_data_want_recv(struct connection *c)
285{
286 c->flags |= CO_FL_DATA_RD_ENA;
287}
288
289static inline void __conn_data_stop_recv(struct connection *c)
290{
291 c->flags &= ~CO_FL_DATA_RD_ENA;
292}
293
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200294static inline void __conn_data_want_send(struct connection *c)
295{
296 c->flags |= CO_FL_DATA_WR_ENA;
297}
298
299static inline void __conn_data_stop_send(struct connection *c)
300{
301 c->flags &= ~CO_FL_DATA_WR_ENA;
302}
303
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200304static inline void __conn_data_stop_both(struct connection *c)
305{
306 c->flags &= ~(CO_FL_DATA_WR_ENA | CO_FL_DATA_RD_ENA);
307}
308
309static inline void conn_data_want_recv(struct connection *c)
310{
311 __conn_data_want_recv(c);
312 conn_cond_update_data_polling(c);
313}
314
315static inline void conn_data_stop_recv(struct connection *c)
316{
317 __conn_data_stop_recv(c);
318 conn_cond_update_data_polling(c);
319}
320
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200321static inline void conn_data_want_send(struct connection *c)
322{
323 __conn_data_want_send(c);
324 conn_cond_update_data_polling(c);
325}
326
327static inline void conn_data_stop_send(struct connection *c)
328{
329 __conn_data_stop_send(c);
330 conn_cond_update_data_polling(c);
331}
332
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200333static inline void conn_data_stop_both(struct connection *c)
334{
335 __conn_data_stop_both(c);
336 conn_cond_update_data_polling(c);
337}
338
339/***** Event manipulation primitives for use by handshake I/O callbacks *****/
340/* The __conn_* versions do not propagate to lower layers and are only meant
341 * to be used by handlers called by the connection handler. The other ones
342 * may be used anywhere.
343 */
344static inline void __conn_sock_want_recv(struct connection *c)
345{
346 c->flags |= CO_FL_SOCK_RD_ENA;
347}
348
349static inline void __conn_sock_stop_recv(struct connection *c)
350{
351 c->flags &= ~CO_FL_SOCK_RD_ENA;
352}
353
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200354static inline void __conn_sock_want_send(struct connection *c)
355{
356 c->flags |= CO_FL_SOCK_WR_ENA;
357}
358
359static inline void __conn_sock_stop_send(struct connection *c)
360{
361 c->flags &= ~CO_FL_SOCK_WR_ENA;
362}
363
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200364static inline void __conn_sock_stop_both(struct connection *c)
365{
366 c->flags &= ~(CO_FL_SOCK_WR_ENA | CO_FL_SOCK_RD_ENA);
367}
368
369static inline void conn_sock_want_recv(struct connection *c)
370{
371 __conn_sock_want_recv(c);
372 conn_cond_update_sock_polling(c);
373}
374
375static inline void conn_sock_stop_recv(struct connection *c)
376{
377 __conn_sock_stop_recv(c);
378 conn_cond_update_sock_polling(c);
379}
380
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200381static inline void conn_sock_want_send(struct connection *c)
382{
383 __conn_sock_want_send(c);
384 conn_cond_update_sock_polling(c);
385}
386
387static inline void conn_sock_stop_send(struct connection *c)
388{
389 __conn_sock_stop_send(c);
390 conn_cond_update_sock_polling(c);
391}
392
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200393static inline void conn_sock_stop_both(struct connection *c)
394{
395 __conn_sock_stop_both(c);
396 conn_cond_update_sock_polling(c);
397}
Willy Tarreau8b117082012-08-06 15:06:49 +0200398
Willy Tarreau3af56a92012-08-20 16:55:48 +0200399/* shutdown management */
400static inline void conn_sock_read0(struct connection *c)
401{
402 c->flags |= CO_FL_SOCK_RD_SH;
403 __conn_sock_stop_recv(c);
Willy Tarreauad38ace2013-12-15 14:19:38 +0100404 /* we don't risk keeping ports unusable if we found the
405 * zero from the other side.
406 */
Willy Tarreau3c728722014-01-23 13:50:42 +0100407 if (conn_ctrl_ready(c))
Willy Tarreauad38ace2013-12-15 14:19:38 +0100408 fdtab[c->t.sock.fd].linger_risk = 0;
Willy Tarreau3af56a92012-08-20 16:55:48 +0200409}
410
411static inline void conn_data_read0(struct connection *c)
412{
413 c->flags |= CO_FL_DATA_RD_SH;
414 __conn_data_stop_recv(c);
415}
416
417static inline void conn_sock_shutw(struct connection *c)
418{
419 c->flags |= CO_FL_SOCK_WR_SH;
420 __conn_sock_stop_send(c);
Willy Tarreaua02e8c92015-03-12 22:42:29 +0100421 if (conn_ctrl_ready(c))
422 shutdown(c->t.sock.fd, SHUT_WR);
Willy Tarreau3af56a92012-08-20 16:55:48 +0200423}
424
425static inline void conn_data_shutw(struct connection *c)
426{
427 c->flags |= CO_FL_DATA_WR_SH;
428 __conn_data_stop_send(c);
Willy Tarreau729c69f2015-03-12 22:51:10 +0100429
430 /* clean data-layer shutdown */
431 if (c->xprt && c->xprt->shutw)
432 c->xprt->shutw(c, 1);
433}
434
435static inline void conn_data_shutw_hard(struct connection *c)
436{
437 c->flags |= CO_FL_DATA_WR_SH;
438 __conn_data_stop_send(c);
439
440 /* unclean data-layer shutdown */
441 if (c->xprt && c->xprt->shutw)
442 c->xprt->shutw(c, 0);
Willy Tarreau3af56a92012-08-20 16:55:48 +0200443}
444
445/* detect sock->data read0 transition */
446static inline int conn_data_read0_pending(struct connection *c)
447{
448 return (c->flags & (CO_FL_DATA_RD_SH | CO_FL_SOCK_RD_SH)) == CO_FL_SOCK_RD_SH;
449}
450
451/* detect data->sock shutw transition */
452static inline int conn_sock_shutw_pending(struct connection *c)
453{
454 return (c->flags & (CO_FL_DATA_WR_SH | CO_FL_SOCK_WR_SH)) == CO_FL_DATA_WR_SH;
455}
456
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200457/* prepares a connection to work with protocol <proto> and transport <xprt>.
458 * The transport's context is initialized as well.
459 */
460static inline void conn_prepare(struct connection *conn, const struct protocol *proto, const struct xprt_ops *xprt)
461{
462 conn->ctrl = proto;
463 conn->xprt = xprt;
464 conn->xprt_st = 0;
465 conn->xprt_ctx = NULL;
466}
467
Willy Tarreaud0155772013-10-14 17:10:08 +0200468/* Initializes all required fields for a new connection. Note that it does the
469 * minimum acceptable initialization for a connection that already exists and
470 * is about to be reused. It also leaves the addresses untouched, which makes
471 * it usable across connection retries to reset a connection to a known state.
472 */
473static inline void conn_init(struct connection *conn)
474{
475 conn->obj_type = OBJ_TYPE_CONN;
476 conn->flags = CO_FL_NONE;
Willy Tarreaud0155772013-10-14 17:10:08 +0200477 conn->data = NULL;
478 conn->owner = NULL;
Willy Tarreaub8020ce2013-10-24 21:10:08 +0200479 conn->send_proxy_ofs = 0;
Willy Tarreaud0155772013-10-14 17:10:08 +0200480 conn->t.sock.fd = -1; /* just to help with debugging */
481 conn->err_code = CO_ER_NONE;
482 conn->target = NULL;
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100483 conn->proxy_netns = NULL;
Willy Tarreaud75d40e2015-08-04 17:25:58 +0200484 LIST_INIT(&conn->list);
Willy Tarreaud0155772013-10-14 17:10:08 +0200485}
486
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200487/* Tries to allocate a new connection and initialized its main fields. The
488 * connection is returned on success, NULL on failure. The connection must
489 * be released using pool_free2() or conn_free().
490 */
491static inline struct connection *conn_new()
492{
493 struct connection *conn;
494
495 conn = pool_alloc2(pool2_connection);
496 if (likely(conn != NULL))
497 conn_init(conn);
498 return conn;
499}
500
501/* Releases a connection previously allocated by conn_new() */
502static inline void conn_free(struct connection *conn)
503{
504 pool_free2(pool2_connection, conn);
505}
506
507
Willy Tarreau986a9d22012-08-30 21:11:38 +0200508/* Retrieves the connection's source address */
509static inline void conn_get_from_addr(struct connection *conn)
510{
511 if (conn->flags & CO_FL_ADDR_FROM_SET)
512 return;
513
Willy Tarreau3c728722014-01-23 13:50:42 +0100514 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_src)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200515 return;
516
517 if (conn->ctrl->get_src(conn->t.sock.fd, (struct sockaddr *)&conn->addr.from,
Willy Tarreau3fdb3662012-11-12 00:42:33 +0100518 sizeof(conn->addr.from),
519 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200520 return;
521 conn->flags |= CO_FL_ADDR_FROM_SET;
522}
523
524/* Retrieves the connection's original destination address */
525static inline void conn_get_to_addr(struct connection *conn)
526{
527 if (conn->flags & CO_FL_ADDR_TO_SET)
528 return;
529
Willy Tarreau3c728722014-01-23 13:50:42 +0100530 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_dst)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200531 return;
532
533 if (conn->ctrl->get_dst(conn->t.sock.fd, (struct sockaddr *)&conn->addr.to,
Willy Tarreau3fdb3662012-11-12 00:42:33 +0100534 sizeof(conn->addr.to),
535 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200536 return;
537 conn->flags |= CO_FL_ADDR_TO_SET;
538}
539
Willy Tarreau7abddb52013-10-24 15:31:04 +0200540/* Attaches a connection to an owner and assigns a data layer */
541static inline void conn_attach(struct connection *conn, void *owner, const struct data_cb *data)
Willy Tarreaudda5e7c2012-09-24 17:15:42 +0200542{
Willy Tarreau74beec32012-10-03 00:41:04 +0200543 conn->data = data;
Willy Tarreaucd379952012-09-27 22:14:33 +0200544 conn->owner = owner;
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200545}
546
Willy Tarreau0af29122012-12-03 15:35:00 +0100547/* returns a human-readable error code for conn->err_code, or NULL if the code
548 * is unknown.
549 */
550static inline const char *conn_err_code_str(struct connection *c)
551{
552 switch (c->err_code) {
553 case CO_ER_NONE: return "Success";
Willy Tarreau45b34e82014-01-24 16:06:50 +0100554
555 case CO_ER_CONF_FDLIM: return "Reached configured maxconn value";
556 case CO_ER_PROC_FDLIM: return "Too many sockets on the process";
557 case CO_ER_SYS_FDLIM: return "Too many sockets on the system";
558 case CO_ER_SYS_MEMLIM: return "Out of system buffers";
559 case CO_ER_NOPROTO: return "Protocol or address family not supported";
560 case CO_ER_SOCK_ERR: return "General socket error";
561 case CO_ER_PORT_RANGE: return "Source port range exhausted";
562 case CO_ER_CANT_BIND: return "Can't bind to source address";
563 case CO_ER_FREE_PORTS: return "Out of local source ports on the system";
564 case CO_ER_ADDR_INUSE: return "Local source address already in use";
565
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100566 case CO_ER_PRX_EMPTY: return "Connection closed while waiting for PROXY protocol header";
567 case CO_ER_PRX_ABORT: return "Connection error while waiting for PROXY protocol header";
Willy Tarreau0af29122012-12-03 15:35:00 +0100568 case CO_ER_PRX_TIMEOUT: return "Timeout while waiting for PROXY protocol header";
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100569 case CO_ER_PRX_TRUNCATED: return "Truncated PROXY protocol header received";
570 case CO_ER_PRX_NOT_HDR: return "Received something which does not look like a PROXY protocol header";
571 case CO_ER_PRX_BAD_HDR: return "Received an invalid PROXY protocol header";
572 case CO_ER_PRX_BAD_PROTO: return "Received an unhandled protocol in the PROXY protocol header";
Willy Tarreau20879a02012-12-03 16:32:10 +0100573 case CO_ER_SSL_EMPTY: return "Connection closed during SSL handshake";
574 case CO_ER_SSL_ABORT: return "Connection error during SSL handshake";
Willy Tarreau0af29122012-12-03 15:35:00 +0100575 case CO_ER_SSL_TIMEOUT: return "Timeout during SSL handshake";
Willy Tarreau20879a02012-12-03 16:32:10 +0100576 case CO_ER_SSL_TOO_MANY: return "Too many SSL connections";
577 case CO_ER_SSL_NO_MEM: return "Out of memory when initializing an SSL connection";
578 case CO_ER_SSL_RENEG: return "Rejected a client-initiated SSL renegociation attempt";
579 case CO_ER_SSL_CA_FAIL: return "SSL client CA chain cannot be verified";
580 case CO_ER_SSL_CRT_FAIL: return "SSL client certificate not trusted";
581 case CO_ER_SSL_HANDSHAKE: return "SSL handshake failure";
Willy Tarreaub3966372014-04-25 18:54:29 +0200582 case CO_ER_SSL_HANDSHAKE_HB: return "SSL handshake failure after heartbeat";
Willy Tarreauf51c6982014-04-25 20:02:39 +0200583 case CO_ER_SSL_KILLED_HB: return "Stopped a TLSv1 heartbeat attack (CVE-2014-0160)";
Willy Tarreau830bf612013-12-01 20:29:58 +0100584 case CO_ER_SSL_NO_TARGET: return "Attempt to use SSL on an unknown target (internal error)";
Willy Tarreau0af29122012-12-03 15:35:00 +0100585 }
586 return NULL;
587}
588
Willy Tarreau59f98392012-07-06 14:13:49 +0200589#endif /* _PROTO_CONNECTION_H */
590
591/*
592 * Local variables:
593 * c-indent-level: 8
594 * c-basic-offset: 8
595 * End:
596 */