blob: 6d402cff565cdbdb9e7c34112fb970feb34104f0 [file] [log] [blame]
Willy Tarreau56e9c5e2012-07-06 09:47:57 +02001/*
2 * include/types/connection.h
3 * This file describes the connection struct and associated constants.
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 _TYPES_CONNECTION_H
23#define _TYPES_CONNECTION_H
24
25#include <stdlib.h>
26#include <sys/socket.h>
27
28#include <common/config.h>
29
30/* referenced below */
31struct sock_ops;
32struct protocol;
33
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +020034/* Polling flags that are manipulated by I/O callbacks and handshake callbacks
35 * indicate what they expect from a file descriptor at each layer. For each
36 * direction, we have 2 bits, one stating whether any suspected activity on the
37 * FD induce a call to the iocb, and another one indicating that the FD has
38 * already returned EAGAIN and that polling on it is essential before calling
39 * the iocb again :
40 * POL ENA state
41 * 0 0 STOPPED : any activity on this FD is ignored
42 * 0 1 ENABLED : any (suspected) activity may call the iocb
43 * 1 0 STOPPED : as above
44 * 1 1 POLLED : the FD is being polled for activity
45 *
46 * - Enabling an I/O event consists in ORing with 1.
47 * - Stopping an I/O event consists in ANDing with ~1.
48 * - Polling for an I/O event consists in ORing with ~3.
49 *
50 * The last computed state is remembered in CO_FL_CURR_* so that differential
51 * changes can be applied. For pollers that do not support speculative I/O,
52 * POLLED is the same as ENABLED and the POL flag can safely be ignored.
53 */
54
Willy Tarreau900bc932012-07-06 09:52:14 +020055/* flags for use in connection->flags */
56enum {
57 CO_FL_NONE = 0x00000000,
58 CO_FL_ERROR = 0x00000001, /* a fatal error was reported */
Willy Tarreauc76ae332012-07-12 15:32:13 +020059 CO_FL_CONNECTED = 0x00000002, /* the connection is now established */
60 CO_FL_WAIT_L4_CONN = 0x00000004, /* waiting for L4 to be connected */
61 CO_FL_WAIT_L6_CONN = 0x00000008, /* waiting for L6 to be connected (eg: SSL) */
62
63 CO_FL_NOTIFY_SI = 0x00000010, /* notify stream interface about changes */
64
Willy Tarreau2c6be842012-07-06 17:12:34 +020065 /* flags below are used for connection handshakes */
Willy Tarreauc76ae332012-07-12 15:32:13 +020066 CO_FL_SI_SEND_PROXY = 0x00000020, /* send a valid PROXY protocol header */
67
68 /* below we have all handshake flags grouped into one */
69 CO_FL_HANDSHAKE = CO_FL_SI_SEND_PROXY,
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +020070
71 /* when any of these flags is set, polling is defined by socket-layer
72 * operations, as opposed to data-layer.
73 */
74 CO_FL_POLL_SOCK = CO_FL_HANDSHAKE | CO_FL_WAIT_L4_CONN | CO_FL_WAIT_L6_CONN,
75
Willy Tarreau2ba44652012-08-20 17:30:32 +020076 /* These flags are used by data layers to indicate to their iterators
77 * whether they had to stop due to missing data or missing room. Their
78 * callers must reset them before calling the data layer handlers.
79 */
80 CO_FL_WAIT_DATA = 0x00004000, /* data source is empty */
81 CO_FL_WAIT_ROOM = 0x00008000, /* data sink is full */
82
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +020083 /* flags used to remember what shutdown have been performed/reported */
84 CO_FL_DATA_RD_SH = 0x00010000, /* DATA layer was notified about shutr/read0 */
85 CO_FL_DATA_WR_SH = 0x00020000, /* DATA layer asked for shutw */
86 CO_FL_SOCK_RD_SH = 0x00040000, /* SOCK layer was notified about shutr/read0 */
87 CO_FL_SOCK_WR_SH = 0x00080000, /* SOCK layer asked for shutw */
88
89 /****** NOTE: do not change the values of the flags below ******/
90 CO_FL_RD_ENA = 1, CO_FL_RD_POL = 2, CO_FL_WR_ENA = 4, CO_FL_WR_POL = 8,
91
92 /* flags describing the DATA layer expectations regarding polling */
93 CO_FL_DATA_RD_ENA = CO_FL_RD_ENA << 20, /* receiving is allowed */
94 CO_FL_DATA_RD_POL = CO_FL_RD_POL << 20, /* receiving needs to poll first */
95 CO_FL_DATA_WR_ENA = CO_FL_WR_ENA << 20, /* sending is desired */
96 CO_FL_DATA_WR_POL = CO_FL_WR_POL << 20, /* sending needs to poll first */
97
98 /* flags describing the SOCK layer expectations regarding polling */
99 CO_FL_SOCK_RD_ENA = CO_FL_RD_ENA << 24, /* receiving is allowed */
100 CO_FL_SOCK_RD_POL = CO_FL_RD_POL << 24, /* receiving needs to poll first */
101 CO_FL_SOCK_WR_ENA = CO_FL_WR_ENA << 24, /* sending is desired */
102 CO_FL_SOCK_WR_POL = CO_FL_WR_POL << 24, /* sending needs to poll first */
103
104 /* flags storing the current polling state */
105 CO_FL_CURR_RD_ENA = CO_FL_RD_ENA << 28, /* receiving is allowed */
106 CO_FL_CURR_RD_POL = CO_FL_RD_POL << 28, /* receiving needs to poll first */
107 CO_FL_CURR_WR_ENA = CO_FL_WR_ENA << 28, /* sending is desired */
108 CO_FL_CURR_WR_POL = CO_FL_WR_POL << 28, /* sending needs to poll first */
Willy Tarreau900bc932012-07-06 09:52:14 +0200109};
110
Willy Tarreau56e9c5e2012-07-06 09:47:57 +0200111/* This structure describes a connection with its methods and data.
112 * A connection may be performed to proxy or server via a local or remote
113 * socket, and can also be made to an internal applet. It can support
114 * several data schemes (applet, raw, ssl, ...). It can support several
115 * connection control schemes, generally a protocol for socket-oriented
116 * connections, but other methods for applets.
117 */
118struct connection {
119 const struct sock_ops *data; /* operations at the data layer */
120 const struct protocol *ctrl; /* operations at the control layer, generally a protocol */
121 union { /* definitions which depend on connection type */
122 struct { /*** information used by socket-based connections ***/
123 int fd; /* file descriptor for a stream driver when known */
124 } sock;
125 } t;
Willy Tarreau900bc932012-07-06 09:52:14 +0200126 unsigned int flags; /* CO_F_* */
Willy Tarreau56e9c5e2012-07-06 09:47:57 +0200127 int data_st; /* data layer state, initialized to zero */
128 void *data_ctx; /* general purpose pointer, initialized to NULL */
129 struct sockaddr *peeraddr; /* pointer to peer's network address, or NULL if unset */
130 socklen_t peerlen; /* peer's address length, or 0 if unset */
131};
132
133#endif /* _TYPES_CONNECTION_H */
134
135/*
136 * Local variables:
137 * c-indent-level: 8
138 * c-basic-offset: 8
139 * End:
140 */