Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 1 | /* |
| 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 | |
Willy Tarreau | d1d5454 | 2012-09-12 22:58:11 +0200 | [diff] [blame] | 30 | #include <types/listener.h> |
| 31 | #include <types/protocol.h> |
| 32 | |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 33 | /* referenced below */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 34 | struct connection; |
| 35 | struct buffer; |
| 36 | struct pipe; |
Willy Tarreau | 3cefd52 | 2012-08-30 15:49:18 +0200 | [diff] [blame] | 37 | struct server; |
| 38 | struct proxy; |
| 39 | struct si_applet; |
| 40 | struct task; |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 41 | |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 42 | /* Polling flags that are manipulated by I/O callbacks and handshake callbacks |
| 43 | * indicate what they expect from a file descriptor at each layer. For each |
| 44 | * direction, we have 2 bits, one stating whether any suspected activity on the |
| 45 | * FD induce a call to the iocb, and another one indicating that the FD has |
| 46 | * already returned EAGAIN and that polling on it is essential before calling |
| 47 | * the iocb again : |
| 48 | * POL ENA state |
| 49 | * 0 0 STOPPED : any activity on this FD is ignored |
| 50 | * 0 1 ENABLED : any (suspected) activity may call the iocb |
| 51 | * 1 0 STOPPED : as above |
| 52 | * 1 1 POLLED : the FD is being polled for activity |
| 53 | * |
| 54 | * - Enabling an I/O event consists in ORing with 1. |
| 55 | * - Stopping an I/O event consists in ANDing with ~1. |
| 56 | * - Polling for an I/O event consists in ORing with ~3. |
| 57 | * |
| 58 | * The last computed state is remembered in CO_FL_CURR_* so that differential |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 59 | * changes can be applied. After bits are applied, the POLL status bits are |
| 60 | * cleared so that it is possible to detect when an EAGAIN was encountered. For |
| 61 | * pollers that do not support speculative I/O, POLLED is the same as ENABLED |
| 62 | * and the POL flag can safely be ignored. However it makes a difference for |
| 63 | * the connection handler. |
| 64 | * |
| 65 | * The ENA flags are per-layer (one pair for SOCK, another one for DATA). |
| 66 | * The POL flags are only for the socket layer since they indicate that EAGAIN |
| 67 | * was encountered. Thus, the DATA layer uses its own ENA flag and the socket |
| 68 | * layer's POL flag. |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 69 | * |
| 70 | * The bits are arranged so that it is possible to detect a change by performing |
| 71 | * only a left shift followed by a xor and applying a mask to the result. The |
| 72 | * principle is that depending on what we want to check (data polling changes or |
| 73 | * sock polling changes), we mask different bits. The bits are arranged this way : |
| 74 | * |
| 75 | * S(ock) - W(ait) - C(urr) - P(oll) - D(ata) |
| 76 | * |
| 77 | * SOCK changes are reported when (S != C) || (W != P) => (S:W) != (C:P) |
| 78 | * DATA changes are reported when (D != C) || (W != P) => (W:C) != (P:D) |
| 79 | * The R and W bits are split apart so that we never shift more than 2 bits at |
| 80 | * a time, allowing move+shift to be done as a single operation on x86. |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 81 | */ |
| 82 | |
Willy Tarreau | 900bc93 | 2012-07-06 09:52:14 +0200 | [diff] [blame] | 83 | /* flags for use in connection->flags */ |
| 84 | enum { |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 85 | CO_FL_NONE = 0x00000000, /* Just for initialization purposes */ |
Willy Tarreau | c76ae33 | 2012-07-12 15:32:13 +0200 | [diff] [blame] | 86 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 87 | /* Do not change these values without updating conn_*_poll_changes() ! */ |
| 88 | CO_FL_DATA_RD_ENA = 0x00000001, /* receiving data is allowed */ |
| 89 | CO_FL_CURR_RD_POL = 0x00000002, /* receiving needs to poll first */ |
| 90 | CO_FL_CURR_RD_ENA = 0x00000004, /* receiving is currently allowed */ |
| 91 | CO_FL_WAIT_RD = 0x00000008, /* receiving needs to poll first */ |
| 92 | CO_FL_SOCK_RD_ENA = 0x00000010, /* receiving handshakes is allowed */ |
| 93 | CO_FL_DATA_WR_ENA = 0x00000020, /* sending data is desired */ |
| 94 | CO_FL_CURR_WR_POL = 0x00000040, /* sending needs to poll first */ |
| 95 | CO_FL_CURR_WR_ENA = 0x00000080, /* sending is currently desired */ |
| 96 | CO_FL_WAIT_WR = 0x00000100, /* sending needs to poll first */ |
| 97 | CO_FL_SOCK_WR_ENA = 0x00000200, /* sending handshakes is desired */ |
Willy Tarreau | c76ae33 | 2012-07-12 15:32:13 +0200 | [diff] [blame] | 98 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 99 | /* These flags are used by data layers to indicate they had to stop |
| 100 | * sending data because a buffer was empty (WAIT_DATA) or stop receiving |
| 101 | * data because a buffer was full (WAIT_ROOM). The connection handler |
| 102 | * clears them before first calling the I/O and data callbacks. |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 103 | */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 104 | CO_FL_WAIT_DATA = 0x00000400, /* data source is empty */ |
| 105 | CO_FL_WAIT_ROOM = 0x00000800, /* data sink is full */ |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 106 | |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 107 | /* These flags are used to report whether the from/to addresses are set or not */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 108 | CO_FL_ADDR_FROM_SET = 0x00001000, /* addr.from is set */ |
| 109 | CO_FL_ADDR_TO_SET = 0x00002000, /* addr.to is set */ |
| 110 | |
| 111 | /* flags indicating what event type the data layer is interested in */ |
| 112 | CO_FL_INIT_DATA = 0x00004000, /* initialize the data layer before using it */ |
| 113 | CO_FL_WAKE_DATA = 0x00008000, /* wake-up data layer upon activity at the transport layer */ |
Willy Tarreau | 2ba4465 | 2012-08-20 17:30:32 +0200 | [diff] [blame] | 114 | |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 115 | /* flags used to remember what shutdown have been performed/reported */ |
| 116 | CO_FL_DATA_RD_SH = 0x00010000, /* DATA layer was notified about shutr/read0 */ |
| 117 | CO_FL_DATA_WR_SH = 0x00020000, /* DATA layer asked for shutw */ |
| 118 | CO_FL_SOCK_RD_SH = 0x00040000, /* SOCK layer was notified about shutr/read0 */ |
| 119 | CO_FL_SOCK_WR_SH = 0x00080000, /* SOCK layer asked for shutw */ |
| 120 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 121 | /* flags used to report connection status and errors */ |
| 122 | CO_FL_ERROR = 0x00100000, /* a fatal error was reported */ |
| 123 | CO_FL_CONNECTED = 0x00200000, /* the connection is now established */ |
| 124 | CO_FL_WAIT_L4_CONN = 0x00400000, /* waiting for L4 to be connected */ |
| 125 | CO_FL_WAIT_L6_CONN = 0x00800000, /* waiting for L6 to be connected (eg: SSL) */ |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 126 | |
Willy Tarreau | 9e272bf | 2012-10-03 21:04:48 +0200 | [diff] [blame] | 127 | /* synthesis of the flags above */ |
| 128 | CO_FL_CONN_STATE = 0x00FF0000, /* all shut/connected flags */ |
| 129 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 130 | /*** All the flags below are used for connection handshakes. Any new |
| 131 | * handshake should be added after this point, and CO_FL_HANDSHAKE |
| 132 | * should be updated. |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 133 | */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 134 | CO_FL_SI_SEND_PROXY = 0x01000000, /* send a valid PROXY protocol header */ |
| 135 | CO_FL_SSL_WAIT_HS = 0x02000000, /* wait for an SSL handshake to complete */ |
Willy Tarreau | 5f1504f | 2012-10-04 23:55:57 +0200 | [diff] [blame] | 136 | CO_FL_ACCEPT_PROXY = 0x04000000, /* receive a valid PROXY protocol header */ |
| 137 | CO_FL_LOCAL_SPROXY = 0x08000000, /* send a valid local PROXY protocol header */ |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 138 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 139 | /* below we have all handshake flags grouped into one */ |
Willy Tarreau | 5f1504f | 2012-10-04 23:55:57 +0200 | [diff] [blame] | 140 | CO_FL_HANDSHAKE = CO_FL_SI_SEND_PROXY | CO_FL_SSL_WAIT_HS | CO_FL_ACCEPT_PROXY | CO_FL_LOCAL_SPROXY, |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 141 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 142 | /* when any of these flags is set, polling is defined by socket-layer |
| 143 | * operations, as opposed to data-layer. Transport is explicitly not |
| 144 | * mentionned here to avoid any confusion, since it can be the same |
| 145 | * as DATA or SOCK on some implementations. |
| 146 | */ |
| 147 | CO_FL_POLL_SOCK = CO_FL_HANDSHAKE | CO_FL_WAIT_L4_CONN | CO_FL_WAIT_L6_CONN, |
Willy Tarreau | 1e95491 | 2012-10-12 17:50:05 +0200 | [diff] [blame] | 148 | |
| 149 | /* This last flag indicates that the transport layer is used (for instance |
| 150 | * by logs) and must not be cleared yet. The last call to conn_xprt_close() |
| 151 | * must be done after clearing this flag. |
| 152 | */ |
| 153 | CO_FL_XPRT_TRACKED = 0x80000000, |
Willy Tarreau | 900bc93 | 2012-07-06 09:52:14 +0200 | [diff] [blame] | 154 | }; |
| 155 | |
Willy Tarreau | 3cefd52 | 2012-08-30 15:49:18 +0200 | [diff] [blame] | 156 | /* target types */ |
| 157 | enum { |
| 158 | TARG_TYPE_NONE = 0, /* no target set, pointer is NULL by definition */ |
| 159 | TARG_TYPE_CLIENT, /* target is a client, pointer is NULL by definition */ |
| 160 | TARG_TYPE_PROXY, /* target is a proxy ; use address with the proxy's settings */ |
| 161 | TARG_TYPE_SERVER, /* target is a server ; use address with server's and its proxy's settings */ |
| 162 | TARG_TYPE_APPLET, /* target is an applet ; use only the applet */ |
| 163 | TARG_TYPE_TASK, /* target is a task running an external applet */ |
| 164 | }; |
| 165 | |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 166 | |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 167 | /* xprt_ops describes transport-layer operations for a connection. They |
| 168 | * generally run over a socket-based control layer, but not always. Some |
| 169 | * of them are used for data transfer with the upper layer (rcv_*, snd_*) |
| 170 | * and the other ones are used to setup and release the transport layer. |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 171 | */ |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 172 | struct xprt_ops { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 173 | int (*rcv_buf)(struct connection *conn, struct buffer *buf, int count); /* recv callback */ |
| 174 | int (*snd_buf)(struct connection *conn, struct buffer *buf, int flags); /* send callback */ |
| 175 | int (*rcv_pipe)(struct connection *conn, struct pipe *pipe, unsigned int count); /* recv-to-pipe callback */ |
| 176 | int (*snd_pipe)(struct connection *conn, struct pipe *pipe); /* send-to-pipe callback */ |
| 177 | void (*shutr)(struct connection *, int); /* shutr function */ |
| 178 | void (*shutw)(struct connection *, int); /* shutw function */ |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 179 | void (*close)(struct connection *); /* close the transport layer */ |
| 180 | int (*init)(struct connection *conn); /* initialize the transport layer */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 181 | }; |
| 182 | |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 183 | /* data_cb describes the data layer's recv and send callbacks which are called |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 184 | * when I/O activity was detected after the transport layer is ready. These |
| 185 | * callbacks are supposed to make use of the xprt_ops above to exchange data |
Willy Tarreau | 4aa3683 | 2012-10-02 20:07:22 +0200 | [diff] [blame] | 186 | * from/to buffers and pipes. The <wake> callback is used to report activity |
| 187 | * at the transport layer, which can be a connection opening/close, or any |
Willy Tarreau | f4e114f | 2012-10-03 01:12:30 +0200 | [diff] [blame] | 188 | * data movement. The <init> callback may be called by the connection handler |
| 189 | * at the end of a transport handshake, when it is about to transfer data and |
Willy Tarreau | 2396c1c | 2012-10-03 21:12:16 +0200 | [diff] [blame] | 190 | * the data layer is not ready yet. Both <wake> and <init> may abort a connection |
| 191 | * by returning < 0. |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 192 | */ |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 193 | struct data_cb { |
| 194 | void (*recv)(struct connection *conn); /* data-layer recv callback */ |
| 195 | void (*send)(struct connection *conn); /* data-layer send callback */ |
Willy Tarreau | 2396c1c | 2012-10-03 21:12:16 +0200 | [diff] [blame] | 196 | int (*wake)(struct connection *conn); /* data-layer callback to report activity */ |
Willy Tarreau | f4e114f | 2012-10-03 01:12:30 +0200 | [diff] [blame] | 197 | int (*init)(struct connection *conn); /* data-layer initialization */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 198 | }; |
| 199 | |
Willy Tarreau | 3cefd52 | 2012-08-30 15:49:18 +0200 | [diff] [blame] | 200 | /* a target describes what is on the remote side of the connection. */ |
| 201 | struct target { |
| 202 | int type; |
| 203 | union { |
| 204 | void *v; /* pointer value, for any type */ |
| 205 | struct proxy *p; /* when type is TARG_TYPE_PROXY */ |
| 206 | struct server *s; /* when type is TARG_TYPE_SERVER */ |
| 207 | struct si_applet *a; /* when type is TARG_TYPE_APPLET */ |
| 208 | struct task *t; /* when type is TARG_TYPE_TASK */ |
| 209 | struct listener *l; /* when type is TARG_TYPE_CLIENT */ |
| 210 | } ptr; |
| 211 | }; |
| 212 | |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 213 | /* This structure describes a connection with its methods and data. |
| 214 | * A connection may be performed to proxy or server via a local or remote |
| 215 | * socket, and can also be made to an internal applet. It can support |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 216 | * several transport schemes (applet, raw, ssl, ...). It can support several |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 217 | * connection control schemes, generally a protocol for socket-oriented |
| 218 | * connections, but other methods for applets. |
| 219 | */ |
| 220 | struct connection { |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 221 | const struct xprt_ops *xprt; /* operations at the transport layer */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 222 | const struct protocol *ctrl; /* operations at the socket layer */ |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 223 | const struct data_cb *data; /* data layer callbacks */ |
Willy Tarreau | cd37995 | 2012-09-27 22:14:33 +0200 | [diff] [blame] | 224 | void *owner; /* pointer to upper layer's entity (eg: stream interface) */ |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 225 | union { /* definitions which depend on connection type */ |
| 226 | struct { /*** information used by socket-based connections ***/ |
| 227 | int fd; /* file descriptor for a stream driver when known */ |
| 228 | } sock; |
| 229 | } t; |
Willy Tarreau | 900bc93 | 2012-07-06 09:52:14 +0200 | [diff] [blame] | 230 | unsigned int flags; /* CO_F_* */ |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 231 | int xprt_st; /* transport layer state, initialized to zero */ |
| 232 | void *xprt_ctx; /* general purpose pointer, initialized to NULL */ |
Willy Tarreau | 3cefd52 | 2012-08-30 15:49:18 +0200 | [diff] [blame] | 233 | struct target target; /* the target to connect to (server, proxy, applet, ...) */ |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 234 | struct { |
| 235 | struct sockaddr_storage from; /* client address, or address to spoof when connecting to the server */ |
Willy Tarreau | cd37995 | 2012-09-27 22:14:33 +0200 | [diff] [blame] | 236 | struct sockaddr_storage to; /* address reached by the client, or address to connect to */ |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 237 | } addr; /* addresses of the remote side, client for producer and server for consumer */ |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 238 | }; |
| 239 | |
| 240 | #endif /* _TYPES_CONNECTION_H */ |
| 241 | |
| 242 | /* |
| 243 | * Local variables: |
| 244 | * c-indent-level: 8 |
| 245 | * c-basic-offset: 8 |
| 246 | * End: |
| 247 | */ |