blob: 8609f1774c81ad25b51782c5ef8409a8047ef6fb [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 Tarreauafad0e02012-08-09 14:45:22 +020038 * provided by the connection's sock_ops. Returns 0.
Willy Tarreau59f98392012-07-06 14:13:49 +020039 */
40int conn_fd_handler(int fd);
41
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);
Willy Tarreaue1e4a612012-10-05 00:10:55 +020044int make_proxy_line(char *buf, int buf_len, struct sockaddr_storage *src, struct sockaddr_storage *dst);
Willy Tarreau22cda212012-08-31 17:43:29 +020045
Willy Tarreaud02cdd22013-12-15 10:23:20 +010046/* returns true is the transport layer is ready */
Willy Tarreauaad69382014-01-23 14:21:42 +010047static inline int conn_xprt_ready(const struct connection *conn)
Willy Tarreaud02cdd22013-12-15 10:23:20 +010048{
Willy Tarreauaad69382014-01-23 14:21:42 +010049 return (conn->flags & CO_FL_XPRT_READY);
Willy Tarreaud02cdd22013-12-15 10:23:20 +010050}
51
52/* returns true is the control layer is ready */
Willy Tarreau3c728722014-01-23 13:50:42 +010053static inline int conn_ctrl_ready(const struct connection *conn)
Willy Tarreaud02cdd22013-12-15 10:23:20 +010054{
55 return (conn->flags & CO_FL_CTRL_READY);
56}
57
Willy Tarreauf79c8172013-10-21 16:30:56 +020058/* Calls the init() function of the transport layer if any and if not done yet,
59 * and sets the CO_FL_XPRT_READY flag to indicate it was properly initialized.
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020060 * Returns <0 in case of error.
Willy Tarreau15678ef2012-08-31 13:54:11 +020061 */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020062static inline int conn_xprt_init(struct connection *conn)
Willy Tarreau15678ef2012-08-31 13:54:11 +020063{
Willy Tarreauf79c8172013-10-21 16:30:56 +020064 int ret = 0;
65
Willy Tarreauaad69382014-01-23 14:21:42 +010066 if (!conn_xprt_ready(conn) && conn->xprt && conn->xprt->init)
Willy Tarreauf79c8172013-10-21 16:30:56 +020067 ret = conn->xprt->init(conn);
68
69 if (ret >= 0)
70 conn->flags |= CO_FL_XPRT_READY;
71
72 return ret;
Willy Tarreau15678ef2012-08-31 13:54:11 +020073}
74
Willy Tarreauf79c8172013-10-21 16:30:56 +020075/* Calls the close() function of the transport layer if any and if not done
76 * yet, and clears the CO_FL_XPRT_READY flag. However this is not done if the
77 * CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the
78 * transport layer very late if needed.
Willy Tarreau6c03a642012-10-12 17:00:05 +020079 */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020080static inline void conn_xprt_close(struct connection *conn)
Willy Tarreau8b117082012-08-06 15:06:49 +020081{
Willy Tarreauf79c8172013-10-21 16:30:56 +020082 if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_XPRT_TRACKED)) == CO_FL_XPRT_READY) {
Willy Tarreauaad69382014-01-23 14:21:42 +010083 if (conn->xprt->close)
Willy Tarreau6c03a642012-10-12 17:00:05 +020084 conn->xprt->close(conn);
Willy Tarreauf79c8172013-10-21 16:30:56 +020085 conn->flags &= ~CO_FL_XPRT_READY;
86 }
87}
88
89/* Initializes the connection's control layer which essentially consists in
90 * registering the file descriptor for polling and setting the CO_FL_CTRL_READY
Willy Tarreau3c728722014-01-23 13:50:42 +010091 * flag. The caller is responsible for ensuring that the control layer is
92 * already assigned to the connection prior to the call.
Willy Tarreauf79c8172013-10-21 16:30:56 +020093 */
94static inline void conn_ctrl_init(struct connection *conn)
95{
Willy Tarreau3c728722014-01-23 13:50:42 +010096 if (!conn_ctrl_ready(conn)) {
Willy Tarreauf79c8172013-10-21 16:30:56 +020097 int fd = conn->t.sock.fd;
98
99 fd_insert(fd);
Willy Tarreauf817e9f2014-01-10 16:58:45 +0100100 /* mark the fd as ready so as not to needlessly poll at the beginning */
101 fd_may_recv(fd);
102 fd_may_send(fd);
Willy Tarreauf79c8172013-10-21 16:30:56 +0200103 fdtab[fd].owner = conn;
104 fdtab[fd].iocb = conn_fd_handler;
105 conn->flags |= CO_FL_CTRL_READY;
Willy Tarreau6c03a642012-10-12 17:00:05 +0200106 }
Willy Tarreau8b117082012-08-06 15:06:49 +0200107}
108
Willy Tarreauf79c8172013-10-21 16:30:56 +0200109/* Deletes the FD if the transport layer is already gone. Once done,
110 * it then removes the CO_FL_CTRL_READY flag.
111 */
112static inline void conn_ctrl_close(struct connection *conn)
113{
114 if ((conn->flags & (CO_FL_XPRT_READY|CO_FL_CTRL_READY)) == CO_FL_CTRL_READY) {
115 fd_delete(conn->t.sock.fd);
116 conn->flags &= ~CO_FL_CTRL_READY;
117 }
118}
119
Willy Tarreau2b199c92012-11-23 17:32:21 +0100120/* If the connection still has a transport layer, then call its close() function
121 * if any, and delete the file descriptor if a control layer is set. This is
122 * used to close everything at once and atomically. However this is not done if
123 * the CO_FL_XPRT_TRACKED flag is set, which allows logs to take data from the
124 * transport layer very late if needed.
125 */
126static inline void conn_full_close(struct connection *conn)
127{
Willy Tarreauf79c8172013-10-21 16:30:56 +0200128 conn_xprt_close(conn);
129 conn_ctrl_close(conn);
130}
131
132/* Force to close the connection whatever the tracking state. This is mainly
Willy Tarreau9471b8c2013-12-15 13:31:35 +0100133 * used on the error path where the tracking does not make sense, or to kill
134 * an idle connection we want to abort immediately.
Willy Tarreauf79c8172013-10-21 16:30:56 +0200135 */
136static inline void conn_force_close(struct connection *conn)
137{
Willy Tarreauaad69382014-01-23 14:21:42 +0100138 if (conn_xprt_ready(conn) && conn->xprt->close)
Willy Tarreauf79c8172013-10-21 16:30:56 +0200139 conn->xprt->close(conn);
140
Willy Tarreau3c728722014-01-23 13:50:42 +0100141 if (conn_ctrl_ready(conn))
Willy Tarreauf79c8172013-10-21 16:30:56 +0200142 fd_delete(conn->t.sock.fd);
143
144 conn->flags &= ~(CO_FL_XPRT_READY|CO_FL_CTRL_READY);
Willy Tarreau2b199c92012-11-23 17:32:21 +0100145}
146
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200147/* Update polling on connection <c>'s file descriptor depending on its current
148 * state as reported in the connection's CO_FL_CURR_* flags, reports of EAGAIN
149 * in CO_FL_WAIT_*, and the sock layer expectations indicated by CO_FL_SOCK_*.
150 * The connection flags are updated with the new flags at the end of the
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200151 * operation. Polling is totally disabled if an error was reported.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200152 */
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200153void conn_update_sock_polling(struct connection *c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200154
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 data layer expectations indicated by CO_FL_DATA_*.
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_data_polling(struct connection *c);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200162
Willy Tarreau7d281492012-12-16 19:19:13 +0100163/* Refresh the connection's polling flags from its file descriptor status.
164 * This should be called at the beginning of a connection handler.
165 */
166static inline void conn_refresh_polling_flags(struct connection *conn)
167{
Willy Tarreau310987a2014-01-22 19:46:33 +0100168 conn->flags &= ~(CO_FL_WAIT_ROOM | CO_FL_WAIT_DATA);
Willy Tarreau7d281492012-12-16 19:19:13 +0100169
Willy Tarreau3c728722014-01-23 13:50:42 +0100170 if (conn_ctrl_ready(conn)) {
Willy Tarreau7d281492012-12-16 19:19:13 +0100171 unsigned int flags = conn->flags & ~(CO_FL_CURR_RD_ENA | CO_FL_CURR_WR_ENA);
172
Willy Tarreauf817e9f2014-01-10 16:58:45 +0100173 if (fd_recv_active(conn->t.sock.fd))
Willy Tarreau7d281492012-12-16 19:19:13 +0100174 flags |= CO_FL_CURR_RD_ENA;
Willy Tarreauf817e9f2014-01-10 16:58:45 +0100175 if (fd_send_active(conn->t.sock.fd))
Willy Tarreau7d281492012-12-16 19:19:13 +0100176 flags |= CO_FL_CURR_WR_ENA;
177 conn->flags = flags;
178 }
179}
180
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200181/* inspects c->flags and returns non-zero if DATA ENA changes from the CURR ENA
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100182 * or if the WAIT flags are set with their respective ENA flags. Additionally,
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200183 * non-zero is also returned if an error was reported on the connection. This
184 * function is used quite often and is inlined. In order to proceed optimally
185 * with very little code and CPU cycles, the bits are arranged so that a change
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100186 * can be detected by a few left shifts, a xor, and a mask. These operations
187 * detect when W&D are both enabled for either direction, when C&D differ for
188 * either direction and when Error is set. The trick consists in first keeping
189 * only the bits we're interested in, since they don't collide when shifted,
190 * and to perform the AND at the end. In practice, the compiler is able to
191 * replace the last AND with a TEST in boolean conditions. This results in
192 * checks that are done in 4-6 cycles and less than 30 bytes.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200193 */
194static inline unsigned int conn_data_polling_changes(const struct connection *c)
195{
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100196 unsigned int f = c->flags;
197 f &= CO_FL_DATA_WR_ENA | CO_FL_DATA_RD_ENA | CO_FL_CURR_WR_ENA |
Willy Tarreau310987a2014-01-22 19:46:33 +0100198 CO_FL_CURR_RD_ENA | CO_FL_ERROR;
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100199
Willy Tarreau310987a2014-01-22 19:46:33 +0100200 f = (f ^ (f << 1)) & (CO_FL_CURR_WR_ENA|CO_FL_CURR_RD_ENA); /* test C ^ D */
201 return f & (CO_FL_CURR_WR_ENA | CO_FL_CURR_RD_ENA | CO_FL_ERROR);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200202}
203
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200204/* inspects c->flags and returns non-zero if SOCK ENA changes from the CURR ENA
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100205 * or if the WAIT flags are set with their respective ENA flags. Additionally,
Willy Tarreau0ffde2c2012-10-04 22:21:15 +0200206 * non-zero is also returned if an error was reported on the connection. This
207 * function is used quite often and is inlined. In order to proceed optimally
208 * with very little code and CPU cycles, the bits are arranged so that a change
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100209 * can be detected by a few left shifts, a xor, and a mask. These operations
210 * detect when W&S are both enabled for either direction, when C&S differ for
211 * either direction and when Error is set. The trick consists in first keeping
212 * only the bits we're interested in, since they don't collide when shifted,
213 * and to perform the AND at the end. In practice, the compiler is able to
214 * replace the last AND with a TEST in boolean conditions. This results in
215 * checks that are done in 4-6 cycles and less than 30 bytes.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200216 */
217static inline unsigned int conn_sock_polling_changes(const struct connection *c)
218{
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100219 unsigned int f = c->flags;
220 f &= CO_FL_SOCK_WR_ENA | CO_FL_SOCK_RD_ENA | CO_FL_CURR_WR_ENA |
Willy Tarreau310987a2014-01-22 19:46:33 +0100221 CO_FL_CURR_RD_ENA | CO_FL_ERROR;
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100222
Willy Tarreau310987a2014-01-22 19:46:33 +0100223 f = (f ^ (f << 2)) & (CO_FL_CURR_WR_ENA|CO_FL_CURR_RD_ENA); /* test C ^ S */
224 return f & (CO_FL_CURR_WR_ENA | CO_FL_CURR_RD_ENA | CO_FL_ERROR);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200225}
226
227/* Automatically updates polling on connection <c> depending on the DATA flags
228 * if no handshake is in progress.
229 */
230static inline void conn_cond_update_data_polling(struct connection *c)
231{
232 if (!(c->flags & CO_FL_POLL_SOCK) && conn_data_polling_changes(c))
233 conn_update_data_polling(c);
234}
235
236/* Automatically updates polling on connection <c> depending on the SOCK flags
237 * if a handshake is in progress.
238 */
239static inline void conn_cond_update_sock_polling(struct connection *c)
240{
241 if ((c->flags & CO_FL_POLL_SOCK) && conn_sock_polling_changes(c))
242 conn_update_sock_polling(c);
243}
244
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100245/* Stop all polling on the fd. This might be used when an error is encountered
246 * for example.
247 */
248static inline void conn_stop_polling(struct connection *c)
249{
250 c->flags &= ~(CO_FL_CURR_RD_ENA | CO_FL_CURR_WR_ENA |
251 CO_FL_SOCK_RD_ENA | CO_FL_SOCK_WR_ENA |
252 CO_FL_DATA_RD_ENA | CO_FL_DATA_WR_ENA);
253 fd_stop_both(c->t.sock.fd);
254}
255
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200256/* Automatically update polling on connection <c> depending on the DATA and
257 * SOCK flags, and on whether a handshake is in progress or not. This may be
258 * called at any moment when there is a doubt about the effectiveness of the
259 * polling state, for instance when entering or leaving the handshake state.
260 */
261static inline void conn_cond_update_polling(struct connection *c)
262{
Willy Tarreau36fb02c2012-11-24 11:09:07 +0100263 if (unlikely(c->flags & CO_FL_ERROR))
264 conn_stop_polling(c);
265 else if (!(c->flags & CO_FL_POLL_SOCK) && conn_data_polling_changes(c))
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200266 conn_update_data_polling(c);
267 else if ((c->flags & CO_FL_POLL_SOCK) && conn_sock_polling_changes(c))
268 conn_update_sock_polling(c);
269}
270
271/***** Event manipulation primitives for use by DATA I/O callbacks *****/
272/* The __conn_* versions do not propagate to lower layers and are only meant
273 * to be used by handlers called by the connection handler. The other ones
274 * may be used anywhere.
275 */
276static inline void __conn_data_want_recv(struct connection *c)
277{
278 c->flags |= CO_FL_DATA_RD_ENA;
279}
280
281static inline void __conn_data_stop_recv(struct connection *c)
282{
283 c->flags &= ~CO_FL_DATA_RD_ENA;
284}
285
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200286static inline void __conn_data_want_send(struct connection *c)
287{
288 c->flags |= CO_FL_DATA_WR_ENA;
289}
290
291static inline void __conn_data_stop_send(struct connection *c)
292{
293 c->flags &= ~CO_FL_DATA_WR_ENA;
294}
295
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200296static inline void __conn_data_stop_both(struct connection *c)
297{
298 c->flags &= ~(CO_FL_DATA_WR_ENA | CO_FL_DATA_RD_ENA);
299}
300
301static inline void conn_data_want_recv(struct connection *c)
302{
303 __conn_data_want_recv(c);
304 conn_cond_update_data_polling(c);
305}
306
307static inline void conn_data_stop_recv(struct connection *c)
308{
309 __conn_data_stop_recv(c);
310 conn_cond_update_data_polling(c);
311}
312
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200313static inline void conn_data_want_send(struct connection *c)
314{
315 __conn_data_want_send(c);
316 conn_cond_update_data_polling(c);
317}
318
319static inline void conn_data_stop_send(struct connection *c)
320{
321 __conn_data_stop_send(c);
322 conn_cond_update_data_polling(c);
323}
324
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200325static inline void conn_data_stop_both(struct connection *c)
326{
327 __conn_data_stop_both(c);
328 conn_cond_update_data_polling(c);
329}
330
331/***** Event manipulation primitives for use by handshake I/O callbacks *****/
332/* The __conn_* versions do not propagate to lower layers and are only meant
333 * to be used by handlers called by the connection handler. The other ones
334 * may be used anywhere.
335 */
336static inline void __conn_sock_want_recv(struct connection *c)
337{
338 c->flags |= CO_FL_SOCK_RD_ENA;
339}
340
341static inline void __conn_sock_stop_recv(struct connection *c)
342{
343 c->flags &= ~CO_FL_SOCK_RD_ENA;
344}
345
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200346static inline void __conn_sock_want_send(struct connection *c)
347{
348 c->flags |= CO_FL_SOCK_WR_ENA;
349}
350
351static inline void __conn_sock_stop_send(struct connection *c)
352{
353 c->flags &= ~CO_FL_SOCK_WR_ENA;
354}
355
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200356static inline void __conn_sock_stop_both(struct connection *c)
357{
358 c->flags &= ~(CO_FL_SOCK_WR_ENA | CO_FL_SOCK_RD_ENA);
359}
360
361static inline void conn_sock_want_recv(struct connection *c)
362{
363 __conn_sock_want_recv(c);
364 conn_cond_update_sock_polling(c);
365}
366
367static inline void conn_sock_stop_recv(struct connection *c)
368{
369 __conn_sock_stop_recv(c);
370 conn_cond_update_sock_polling(c);
371}
372
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200373static inline void conn_sock_want_send(struct connection *c)
374{
375 __conn_sock_want_send(c);
376 conn_cond_update_sock_polling(c);
377}
378
379static inline void conn_sock_stop_send(struct connection *c)
380{
381 __conn_sock_stop_send(c);
382 conn_cond_update_sock_polling(c);
383}
384
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200385static inline void conn_sock_stop_both(struct connection *c)
386{
387 __conn_sock_stop_both(c);
388 conn_cond_update_sock_polling(c);
389}
Willy Tarreau8b117082012-08-06 15:06:49 +0200390
Willy Tarreau3af56a92012-08-20 16:55:48 +0200391/* shutdown management */
392static inline void conn_sock_read0(struct connection *c)
393{
394 c->flags |= CO_FL_SOCK_RD_SH;
395 __conn_sock_stop_recv(c);
Willy Tarreauad38ace2013-12-15 14:19:38 +0100396 /* we don't risk keeping ports unusable if we found the
397 * zero from the other side.
398 */
Willy Tarreau3c728722014-01-23 13:50:42 +0100399 if (conn_ctrl_ready(c))
Willy Tarreauad38ace2013-12-15 14:19:38 +0100400 fdtab[c->t.sock.fd].linger_risk = 0;
Willy Tarreau3af56a92012-08-20 16:55:48 +0200401}
402
403static inline void conn_data_read0(struct connection *c)
404{
405 c->flags |= CO_FL_DATA_RD_SH;
406 __conn_data_stop_recv(c);
407}
408
409static inline void conn_sock_shutw(struct connection *c)
410{
411 c->flags |= CO_FL_SOCK_WR_SH;
412 __conn_sock_stop_send(c);
413}
414
415static inline void conn_data_shutw(struct connection *c)
416{
417 c->flags |= CO_FL_DATA_WR_SH;
418 __conn_data_stop_send(c);
419}
420
421/* detect sock->data read0 transition */
422static inline int conn_data_read0_pending(struct connection *c)
423{
424 return (c->flags & (CO_FL_DATA_RD_SH | CO_FL_SOCK_RD_SH)) == CO_FL_SOCK_RD_SH;
425}
426
427/* detect data->sock shutw transition */
428static inline int conn_sock_shutw_pending(struct connection *c)
429{
430 return (c->flags & (CO_FL_DATA_WR_SH | CO_FL_SOCK_WR_SH)) == CO_FL_DATA_WR_SH;
431}
432
Willy Tarreau910c6aa2013-10-24 15:08:37 +0200433/* prepares a connection to work with protocol <proto> and transport <xprt>.
434 * The transport's context is initialized as well.
435 */
436static inline void conn_prepare(struct connection *conn, const struct protocol *proto, const struct xprt_ops *xprt)
437{
438 conn->ctrl = proto;
439 conn->xprt = xprt;
440 conn->xprt_st = 0;
441 conn->xprt_ctx = NULL;
442}
443
Willy Tarreaud0155772013-10-14 17:10:08 +0200444/* Initializes all required fields for a new connection. Note that it does the
445 * minimum acceptable initialization for a connection that already exists and
446 * is about to be reused. It also leaves the addresses untouched, which makes
447 * it usable across connection retries to reset a connection to a known state.
448 */
449static inline void conn_init(struct connection *conn)
450{
451 conn->obj_type = OBJ_TYPE_CONN;
452 conn->flags = CO_FL_NONE;
Willy Tarreaud0155772013-10-14 17:10:08 +0200453 conn->data = NULL;
454 conn->owner = NULL;
Willy Tarreaub8020ce2013-10-24 21:10:08 +0200455 conn->send_proxy_ofs = 0;
Willy Tarreaud0155772013-10-14 17:10:08 +0200456 conn->t.sock.fd = -1; /* just to help with debugging */
457 conn->err_code = CO_ER_NONE;
458 conn->target = NULL;
459}
460
Willy Tarreaub97f3b12013-10-20 22:56:45 +0200461/* Tries to allocate a new connection and initialized its main fields. The
462 * connection is returned on success, NULL on failure. The connection must
463 * be released using pool_free2() or conn_free().
464 */
465static inline struct connection *conn_new()
466{
467 struct connection *conn;
468
469 conn = pool_alloc2(pool2_connection);
470 if (likely(conn != NULL))
471 conn_init(conn);
472 return conn;
473}
474
475/* Releases a connection previously allocated by conn_new() */
476static inline void conn_free(struct connection *conn)
477{
478 pool_free2(pool2_connection, conn);
479}
480
481
Willy Tarreau986a9d22012-08-30 21:11:38 +0200482/* Retrieves the connection's source address */
483static inline void conn_get_from_addr(struct connection *conn)
484{
485 if (conn->flags & CO_FL_ADDR_FROM_SET)
486 return;
487
Willy Tarreau3c728722014-01-23 13:50:42 +0100488 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_src)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200489 return;
490
491 if (conn->ctrl->get_src(conn->t.sock.fd, (struct sockaddr *)&conn->addr.from,
Willy Tarreau3fdb3662012-11-12 00:42:33 +0100492 sizeof(conn->addr.from),
493 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200494 return;
495 conn->flags |= CO_FL_ADDR_FROM_SET;
496}
497
498/* Retrieves the connection's original destination address */
499static inline void conn_get_to_addr(struct connection *conn)
500{
501 if (conn->flags & CO_FL_ADDR_TO_SET)
502 return;
503
Willy Tarreau3c728722014-01-23 13:50:42 +0100504 if (!conn_ctrl_ready(conn) || !conn->ctrl->get_dst)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200505 return;
506
507 if (conn->ctrl->get_dst(conn->t.sock.fd, (struct sockaddr *)&conn->addr.to,
Willy Tarreau3fdb3662012-11-12 00:42:33 +0100508 sizeof(conn->addr.to),
509 obj_type(conn->target) != OBJ_TYPE_LISTENER) == -1)
Willy Tarreau986a9d22012-08-30 21:11:38 +0200510 return;
511 conn->flags |= CO_FL_ADDR_TO_SET;
512}
513
Willy Tarreau7abddb52013-10-24 15:31:04 +0200514/* Attaches a connection to an owner and assigns a data layer */
515static inline void conn_attach(struct connection *conn, void *owner, const struct data_cb *data)
Willy Tarreaudda5e7c2012-09-24 17:15:42 +0200516{
Willy Tarreau74beec32012-10-03 00:41:04 +0200517 conn->data = data;
Willy Tarreaucd379952012-09-27 22:14:33 +0200518 conn->owner = owner;
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200519}
520
Willy Tarreau2aefad52014-01-20 11:41:52 +0100521/* Drains possibly pending incoming data on the file descriptor attached to the
522 * connection and update the connection's flags accordingly. This is used to
523 * know whether we need to disable lingering on close. Returns non-zero if it
524 * is safe to close without disabling lingering, otherwise zero. The SOCK_RD_SH
525 * flag may also be updated if the incoming shutdown was reported by the drain()
526 * function.
527 */
528static inline int conn_drain(struct connection *conn)
529{
Willy Tarreau2aefad52014-01-20 11:41:52 +0100530 if (!conn_ctrl_ready(conn))
531 return 1;
532
533 if (conn->flags & CO_FL_SOCK_RD_SH)
534 return 1;
535
Willy Tarreau310987a2014-01-22 19:46:33 +0100536 if (!fd_recv_ready(conn->t.sock.fd))
Willy Tarreau2aefad52014-01-20 11:41:52 +0100537 return 0;
538
539 if (!conn->ctrl->drain)
540 return 0;
541
Willy Tarreaue1f50c42014-01-22 20:02:06 +0100542 if (conn->ctrl->drain(conn->t.sock.fd) <= 0)
Willy Tarreau2aefad52014-01-20 11:41:52 +0100543 return 0;
544
545 conn->flags |= CO_FL_SOCK_RD_SH;
546 return 1;
547}
548
Willy Tarreau0af29122012-12-03 15:35:00 +0100549/* returns a human-readable error code for conn->err_code, or NULL if the code
550 * is unknown.
551 */
552static inline const char *conn_err_code_str(struct connection *c)
553{
554 switch (c->err_code) {
555 case CO_ER_NONE: return "Success";
Willy Tarreau45b34e82014-01-24 16:06:50 +0100556
557 case CO_ER_CONF_FDLIM: return "Reached configured maxconn value";
558 case CO_ER_PROC_FDLIM: return "Too many sockets on the process";
559 case CO_ER_SYS_FDLIM: return "Too many sockets on the system";
560 case CO_ER_SYS_MEMLIM: return "Out of system buffers";
561 case CO_ER_NOPROTO: return "Protocol or address family not supported";
562 case CO_ER_SOCK_ERR: return "General socket error";
563 case CO_ER_PORT_RANGE: return "Source port range exhausted";
564 case CO_ER_CANT_BIND: return "Can't bind to source address";
565 case CO_ER_FREE_PORTS: return "Out of local source ports on the system";
566 case CO_ER_ADDR_INUSE: return "Local source address already in use";
567
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100568 case CO_ER_PRX_EMPTY: return "Connection closed while waiting for PROXY protocol header";
569 case CO_ER_PRX_ABORT: return "Connection error while waiting for PROXY protocol header";
Willy Tarreau0af29122012-12-03 15:35:00 +0100570 case CO_ER_PRX_TIMEOUT: return "Timeout while waiting for PROXY protocol header";
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100571 case CO_ER_PRX_TRUNCATED: return "Truncated PROXY protocol header received";
572 case CO_ER_PRX_NOT_HDR: return "Received something which does not look like a PROXY protocol header";
573 case CO_ER_PRX_BAD_HDR: return "Received an invalid PROXY protocol header";
574 case CO_ER_PRX_BAD_PROTO: return "Received an unhandled protocol in the PROXY protocol header";
Willy Tarreau20879a02012-12-03 16:32:10 +0100575 case CO_ER_SSL_EMPTY: return "Connection closed during SSL handshake";
576 case CO_ER_SSL_ABORT: return "Connection error during SSL handshake";
Willy Tarreau0af29122012-12-03 15:35:00 +0100577 case CO_ER_SSL_TIMEOUT: return "Timeout during SSL handshake";
Willy Tarreau20879a02012-12-03 16:32:10 +0100578 case CO_ER_SSL_TOO_MANY: return "Too many SSL connections";
579 case CO_ER_SSL_NO_MEM: return "Out of memory when initializing an SSL connection";
580 case CO_ER_SSL_RENEG: return "Rejected a client-initiated SSL renegociation attempt";
581 case CO_ER_SSL_CA_FAIL: return "SSL client CA chain cannot be verified";
582 case CO_ER_SSL_CRT_FAIL: return "SSL client certificate not trusted";
583 case CO_ER_SSL_HANDSHAKE: return "SSL handshake failure";
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 */