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 | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 69 | */ |
| 70 | |
Willy Tarreau | 900bc93 | 2012-07-06 09:52:14 +0200 | [diff] [blame] | 71 | /* flags for use in connection->flags */ |
| 72 | enum { |
| 73 | CO_FL_NONE = 0x00000000, |
| 74 | CO_FL_ERROR = 0x00000001, /* a fatal error was reported */ |
Willy Tarreau | c76ae33 | 2012-07-12 15:32:13 +0200 | [diff] [blame] | 75 | CO_FL_CONNECTED = 0x00000002, /* the connection is now established */ |
| 76 | CO_FL_WAIT_L4_CONN = 0x00000004, /* waiting for L4 to be connected */ |
| 77 | CO_FL_WAIT_L6_CONN = 0x00000008, /* waiting for L6 to be connected (eg: SSL) */ |
| 78 | |
Willy Tarreau | 4aa3683 | 2012-10-02 20:07:22 +0200 | [diff] [blame] | 79 | CO_FL_WAKE_DATA = 0x00000010, /* wake-up data layer upon activity at the transport layer */ |
Willy Tarreau | c76ae33 | 2012-07-12 15:32:13 +0200 | [diff] [blame] | 80 | |
Willy Tarreau | 2c6be84 | 2012-07-06 17:12:34 +0200 | [diff] [blame] | 81 | /* flags below are used for connection handshakes */ |
Willy Tarreau | c76ae33 | 2012-07-12 15:32:13 +0200 | [diff] [blame] | 82 | CO_FL_SI_SEND_PROXY = 0x00000020, /* send a valid PROXY protocol header */ |
Emeric Brun | 7dd0e50 | 2012-05-18 15:47:34 +0200 | [diff] [blame] | 83 | CO_FL_SSL_WAIT_HS = 0x00000040, /* wait for an SSL handshake to complete */ |
Willy Tarreau | 22cda21 | 2012-08-31 17:43:29 +0200 | [diff] [blame] | 84 | CO_FL_ACCEPT_PROXY = 0x00000080, /* send a valid PROXY protocol header */ |
Willy Tarreau | c76ae33 | 2012-07-12 15:32:13 +0200 | [diff] [blame] | 85 | |
| 86 | /* below we have all handshake flags grouped into one */ |
Emeric Brun | 7dd0e50 | 2012-05-18 15:47:34 +0200 | [diff] [blame] | 87 | CO_FL_HANDSHAKE = CO_FL_SI_SEND_PROXY | CO_FL_SSL_WAIT_HS | CO_FL_ACCEPT_PROXY, |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 88 | |
Willy Tarreau | 2542b53 | 2012-08-31 16:01:23 +0200 | [diff] [blame] | 89 | CO_FL_INIT_SESS = 0x00000800, /* initialize a session before using data */ |
| 90 | |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 91 | /* when any of these flags is set, polling is defined by socket-layer |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 92 | * operations, as opposed to data-layer. Transport is explicitly not |
| 93 | * mentionned here to avoid any confusion, since it can be the same |
| 94 | * as DATA or SOCK on some implementations. |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 95 | */ |
| 96 | CO_FL_POLL_SOCK = CO_FL_HANDSHAKE | CO_FL_WAIT_L4_CONN | CO_FL_WAIT_L6_CONN, |
| 97 | |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 98 | /* These flags are used to report whether the from/to addresses are set or not */ |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 99 | CO_FL_ADDR_FROM_SET = 0x00004000, /* addr.from is set */ |
| 100 | CO_FL_ADDR_TO_SET = 0x00008000, /* addr.to is set */ |
Willy Tarreau | 2ba4465 | 2012-08-20 17:30:32 +0200 | [diff] [blame] | 101 | |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 102 | /* flags used to remember what shutdown have been performed/reported */ |
| 103 | CO_FL_DATA_RD_SH = 0x00010000, /* DATA layer was notified about shutr/read0 */ |
| 104 | CO_FL_DATA_WR_SH = 0x00020000, /* DATA layer asked for shutw */ |
| 105 | CO_FL_SOCK_RD_SH = 0x00040000, /* SOCK layer was notified about shutr/read0 */ |
| 106 | CO_FL_SOCK_WR_SH = 0x00080000, /* SOCK layer asked for shutw */ |
| 107 | |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 108 | /* NOTE: do not change the values of any of the flags below, they're |
| 109 | * used with masks and bit shifts to quickly detect multiple changes. |
| 110 | */ |
| 111 | |
| 112 | /* These flags are used by data layers to indicate to indicate they had |
| 113 | * to stop sending data because a buffer was empty (WAIT_DATA) or stop |
| 114 | * receiving data because a buffer was full (WAIT_ROOM). The connection |
| 115 | * handler clears them before first calling the I/O and data callbacks. |
| 116 | */ |
| 117 | CO_FL_WAIT_DATA = 0x00100000, /* data source is empty */ |
| 118 | CO_FL_WAIT_ROOM = 0x00200000, /* data sink is full */ |
| 119 | |
| 120 | /* These flags are used by both socket-level and data-level callbacks |
| 121 | * to indicate that they had to stop receiving or sending because a |
| 122 | * socket-level operation returned EAGAIN. While setting these flags |
| 123 | * is not always absolutely mandatory (eg: when a reader estimates that |
| 124 | * trying again soon without polling is OK), it is however forbidden to |
| 125 | * set them without really attempting the I/O operation. |
| 126 | */ |
| 127 | CO_FL_WAIT_RD = 0x00400000, /* receiving needs to poll first */ |
| 128 | CO_FL_WAIT_WR = 0x00800000, /* sending needs to poll first */ |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 129 | |
| 130 | /* flags describing the DATA layer expectations regarding polling */ |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 131 | CO_FL_DATA_RD_ENA = 0x01000000, /* receiving is allowed */ |
| 132 | CO_FL_DATA_WR_ENA = 0x02000000, /* sending is desired */ |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 133 | |
| 134 | /* flags describing the SOCK layer expectations regarding polling */ |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 135 | CO_FL_SOCK_RD_ENA = 0x04000000, /* receiving is allowed */ |
| 136 | CO_FL_SOCK_WR_ENA = 0x08000000, /* sending is desired */ |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 137 | |
| 138 | /* flags storing the current polling state */ |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 139 | CO_FL_CURR_RD_ENA = 0x10000000, /* receiving is allowed */ |
| 140 | CO_FL_CURR_WR_ENA = 0x20000000, /* sending is desired */ |
| 141 | CO_FL_CURR_RD_POL = 0x40000000, /* receiving needs to poll first */ |
| 142 | CO_FL_CURR_WR_POL = 0x80000000, /* sending needs to poll first */ |
Willy Tarreau | 900bc93 | 2012-07-06 09:52:14 +0200 | [diff] [blame] | 143 | }; |
| 144 | |
Willy Tarreau | 3cefd52 | 2012-08-30 15:49:18 +0200 | [diff] [blame] | 145 | /* target types */ |
| 146 | enum { |
| 147 | TARG_TYPE_NONE = 0, /* no target set, pointer is NULL by definition */ |
| 148 | TARG_TYPE_CLIENT, /* target is a client, pointer is NULL by definition */ |
| 149 | TARG_TYPE_PROXY, /* target is a proxy ; use address with the proxy's settings */ |
| 150 | TARG_TYPE_SERVER, /* target is a server ; use address with server's and its proxy's settings */ |
| 151 | TARG_TYPE_APPLET, /* target is an applet ; use only the applet */ |
| 152 | TARG_TYPE_TASK, /* target is a task running an external applet */ |
| 153 | }; |
| 154 | |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 155 | |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 156 | /* xprt_ops describes transport-layer operations for a connection. They |
| 157 | * generally run over a socket-based control layer, but not always. Some |
| 158 | * of them are used for data transfer with the upper layer (rcv_*, snd_*) |
| 159 | * 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] | 160 | */ |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 161 | struct xprt_ops { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 162 | int (*rcv_buf)(struct connection *conn, struct buffer *buf, int count); /* recv callback */ |
| 163 | int (*snd_buf)(struct connection *conn, struct buffer *buf, int flags); /* send callback */ |
| 164 | int (*rcv_pipe)(struct connection *conn, struct pipe *pipe, unsigned int count); /* recv-to-pipe callback */ |
| 165 | int (*snd_pipe)(struct connection *conn, struct pipe *pipe); /* send-to-pipe callback */ |
| 166 | void (*shutr)(struct connection *, int); /* shutr function */ |
| 167 | void (*shutw)(struct connection *, int); /* shutw function */ |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 168 | void (*close)(struct connection *); /* close the transport layer */ |
| 169 | int (*init)(struct connection *conn); /* initialize the transport layer */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 170 | }; |
| 171 | |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 172 | /* 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] | 173 | * when I/O activity was detected after the transport layer is ready. These |
| 174 | * 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] | 175 | * from/to buffers and pipes. The <wake> callback is used to report activity |
| 176 | * 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] | 177 | * data movement. The <init> callback may be called by the connection handler |
| 178 | * at the end of a transport handshake, when it is about to transfer data and |
| 179 | * the data layer is not ready yet. |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 180 | */ |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 181 | struct data_cb { |
| 182 | void (*recv)(struct connection *conn); /* data-layer recv callback */ |
| 183 | void (*send)(struct connection *conn); /* data-layer send callback */ |
Willy Tarreau | 4aa3683 | 2012-10-02 20:07:22 +0200 | [diff] [blame] | 184 | void (*wake)(struct connection *conn); /* data-layer callback to report activity */ |
Willy Tarreau | f4e114f | 2012-10-03 01:12:30 +0200 | [diff] [blame] | 185 | int (*init)(struct connection *conn); /* data-layer initialization */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 186 | }; |
| 187 | |
Willy Tarreau | 3cefd52 | 2012-08-30 15:49:18 +0200 | [diff] [blame] | 188 | /* a target describes what is on the remote side of the connection. */ |
| 189 | struct target { |
| 190 | int type; |
| 191 | union { |
| 192 | void *v; /* pointer value, for any type */ |
| 193 | struct proxy *p; /* when type is TARG_TYPE_PROXY */ |
| 194 | struct server *s; /* when type is TARG_TYPE_SERVER */ |
| 195 | struct si_applet *a; /* when type is TARG_TYPE_APPLET */ |
| 196 | struct task *t; /* when type is TARG_TYPE_TASK */ |
| 197 | struct listener *l; /* when type is TARG_TYPE_CLIENT */ |
| 198 | } ptr; |
| 199 | }; |
| 200 | |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 201 | /* This structure describes a connection with its methods and data. |
| 202 | * A connection may be performed to proxy or server via a local or remote |
| 203 | * 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] | 204 | * several transport schemes (applet, raw, ssl, ...). It can support several |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 205 | * connection control schemes, generally a protocol for socket-oriented |
| 206 | * connections, but other methods for applets. |
| 207 | */ |
| 208 | struct connection { |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 209 | const struct xprt_ops *xprt; /* operations at the transport layer */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 210 | const struct protocol *ctrl; /* operations at the socket layer */ |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 211 | const struct data_cb *data; /* data layer callbacks */ |
Willy Tarreau | cd37995 | 2012-09-27 22:14:33 +0200 | [diff] [blame] | 212 | void *owner; /* pointer to upper layer's entity (eg: stream interface) */ |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 213 | union { /* definitions which depend on connection type */ |
| 214 | struct { /*** information used by socket-based connections ***/ |
| 215 | int fd; /* file descriptor for a stream driver when known */ |
| 216 | } sock; |
| 217 | } t; |
Willy Tarreau | 900bc93 | 2012-07-06 09:52:14 +0200 | [diff] [blame] | 218 | unsigned int flags; /* CO_F_* */ |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 219 | int xprt_st; /* transport layer state, initialized to zero */ |
| 220 | void *xprt_ctx; /* general purpose pointer, initialized to NULL */ |
Willy Tarreau | 3cefd52 | 2012-08-30 15:49:18 +0200 | [diff] [blame] | 221 | struct target target; /* the target to connect to (server, proxy, applet, ...) */ |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 222 | struct { |
| 223 | 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] | 224 | 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] | 225 | } 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] | 226 | }; |
| 227 | |
| 228 | #endif /* _TYPES_CONNECTION_H */ |
| 229 | |
| 230 | /* |
| 231 | * Local variables: |
| 232 | * c-indent-level: 8 |
| 233 | * c-basic-offset: 8 |
| 234 | * End: |
| 235 | */ |