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