Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 1 | /* |
Willy Tarreau | 8e89b84 | 2009-10-18 23:56:35 +0200 | [diff] [blame] | 2 | * include/proto/stream_interface.h |
| 3 | * This file contains stream_interface function prototypes |
| 4 | * |
Willy Tarreau | f873d75 | 2012-05-11 17:47:17 +0200 | [diff] [blame] | 5 | * Copyright (C) 2000-2012 Willy Tarreau - w@1wt.eu |
Willy Tarreau | 8e89b84 | 2009-10-18 23:56:35 +0200 | [diff] [blame] | 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 | */ |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 21 | |
| 22 | #ifndef _PROTO_STREAM_INTERFACE_H |
| 23 | #define _PROTO_STREAM_INTERFACE_H |
| 24 | |
| 25 | #include <stdlib.h> |
| 26 | |
| 27 | #include <common/config.h> |
Willy Tarreau | 2c6be84 | 2012-07-06 17:12:34 +0200 | [diff] [blame] | 28 | #include <types/session.h> |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 29 | #include <types/stream_interface.h> |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 30 | #include <proto/channel.h> |
Willy Tarreau | f9dabec | 2012-08-17 17:33:53 +0200 | [diff] [blame] | 31 | #include <proto/connection.h> |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 32 | |
| 33 | |
| 34 | /* main event functions used to move data between sockets and buffers */ |
Willy Tarreau | 269358d | 2009-09-20 20:14:49 +0200 | [diff] [blame] | 35 | int stream_int_check_timeouts(struct stream_interface *si); |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 36 | void stream_int_report_error(struct stream_interface *si); |
Willy Tarreau | dded32d | 2008-11-30 19:48:07 +0100 | [diff] [blame] | 37 | void stream_int_retnclose(struct stream_interface *si, const struct chunk *msg); |
Willy Tarreau | 2c6be84 | 2012-07-06 17:12:34 +0200 | [diff] [blame] | 38 | int conn_si_send_proxy(struct connection *conn, unsigned int flag); |
Willy Tarreau | 9bf9c14 | 2012-08-20 15:38:41 +0200 | [diff] [blame] | 39 | void stream_sock_read0(struct stream_interface *si); |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 40 | |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 41 | extern struct si_ops si_embedded_ops; |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 42 | extern struct si_ops si_conn_ops; |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 43 | extern struct data_cb si_conn_cb; |
Willy Tarreau | 5c979a9 | 2012-05-07 17:15:39 +0200 | [diff] [blame] | 44 | |
Willy Tarreau | fb90d94 | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 45 | struct task *stream_int_register_handler(struct stream_interface *si, |
Willy Tarreau | b24281b | 2011-02-13 13:16:36 +0100 | [diff] [blame] | 46 | struct si_applet *app); |
Willy Tarreau | fb90d94 | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 47 | void stream_int_unregister_handler(struct stream_interface *si); |
| 48 | |
Willy Tarreau | 3ed35ef | 2013-10-24 11:51:38 +0200 | [diff] [blame] | 49 | /* initializes a stream interface in the SI_ST_INI state. It's detached from |
| 50 | * any endpoint and is only attached to an owner (generally a task). |
| 51 | */ |
| 52 | static inline void si_reset(struct stream_interface *si, void *owner) |
| 53 | { |
| 54 | si->owner = owner; |
| 55 | si->err_type = SI_ET_NONE; |
| 56 | si->conn_retries = 0; /* used for logging too */ |
Willy Tarreau | 3ed35ef | 2013-10-24 11:51:38 +0200 | [diff] [blame] | 57 | si->exp = TICK_ETERNITY; |
| 58 | si->flags = SI_FL_NONE; |
| 59 | si->end = NULL; |
| 60 | si->state = si->prev_state = SI_ST_INI; |
| 61 | } |
| 62 | |
| 63 | /* sets the current and previous state of a stream interface to <state>. This |
| 64 | * is mainly used to create one in the established state on incoming |
| 65 | * conncetions. |
| 66 | */ |
| 67 | static inline void si_set_state(struct stream_interface *si, int state) |
| 68 | { |
| 69 | si->state = si->prev_state = state; |
| 70 | } |
| 71 | |
Willy Tarreau | 32e3c6a | 2013-10-11 19:34:20 +0200 | [diff] [blame] | 72 | /* release the endpoint if it's a connection, then nullify it */ |
| 73 | static inline void si_release_endpoint(struct stream_interface *si) |
Willy Tarreau | 372d670 | 2013-09-29 17:19:56 +0200 | [diff] [blame] | 74 | { |
Willy Tarreau | 32e3c6a | 2013-10-11 19:34:20 +0200 | [diff] [blame] | 75 | struct connection *conn; |
| 76 | |
| 77 | conn = objt_conn(si->end); |
| 78 | if (conn) |
| 79 | pool_free2(pool2_connection, conn); |
Willy Tarreau | 7d67d7b | 2013-09-29 16:05:22 +0200 | [diff] [blame] | 80 | si->end = NULL; |
Willy Tarreau | 48099c7 | 2013-10-24 20:03:27 +0200 | [diff] [blame] | 81 | si->appctx.applet = NULL; |
Willy Tarreau | 372d670 | 2013-09-29 17:19:56 +0200 | [diff] [blame] | 82 | } |
| 83 | |
Willy Tarreau | 32e3c6a | 2013-10-11 19:34:20 +0200 | [diff] [blame] | 84 | static inline void si_detach(struct stream_interface *si) |
| 85 | { |
| 86 | si_release_endpoint(si); |
| 87 | si->ops = &si_embedded_ops; |
| 88 | } |
| 89 | |
Willy Tarreau | 2a6e880 | 2013-10-24 15:50:53 +0200 | [diff] [blame] | 90 | /* Attach connection <conn> to the stream interface <si>. The stream interface |
| 91 | * is configured to work with a connection and the connection it configured |
| 92 | * with a stream interface data layer. |
Willy Tarreau | b363a1f | 2013-10-01 10:45:07 +0200 | [diff] [blame] | 93 | */ |
Willy Tarreau | 2a6e880 | 2013-10-24 15:50:53 +0200 | [diff] [blame] | 94 | static inline void si_attach_conn(struct stream_interface *si, struct connection *conn) |
Willy Tarreau | bd99aab | 2012-10-02 20:57:19 +0200 | [diff] [blame] | 95 | { |
| 96 | si->ops = &si_conn_ops; |
Willy Tarreau | b363a1f | 2013-10-01 10:45:07 +0200 | [diff] [blame] | 97 | si->end = &conn->obj_type; |
Willy Tarreau | 7abddb5 | 2013-10-24 15:31:04 +0200 | [diff] [blame] | 98 | conn_attach(conn, si, &si_conn_cb); |
Willy Tarreau | bd99aab | 2012-10-02 20:57:19 +0200 | [diff] [blame] | 99 | } |
| 100 | |
Willy Tarreau | 2a6e880 | 2013-10-24 15:50:53 +0200 | [diff] [blame] | 101 | static inline void si_attach_applet(struct stream_interface *si, struct si_applet *applet) |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 102 | { |
Willy Tarreau | 32e3c6a | 2013-10-11 19:34:20 +0200 | [diff] [blame] | 103 | si_release_endpoint(si); |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 104 | si->ops = &si_embedded_ops; |
Willy Tarreau | 48099c7 | 2013-10-24 20:03:27 +0200 | [diff] [blame] | 105 | si->appctx.applet = applet; |
Willy Tarreau | cf644ed | 2013-09-29 17:19:56 +0200 | [diff] [blame] | 106 | si->appctx.obj_type = OBJ_TYPE_APPCTX; |
| 107 | si->end = &si->appctx.obj_type; |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 108 | } |
| 109 | |
Willy Tarreau | 4a59f2f | 2013-10-24 20:10:45 +0200 | [diff] [blame] | 110 | /* returns a pointer to the applet being run in the SI or NULL if none */ |
| 111 | static inline const struct si_applet *si_applet(struct stream_interface *si) |
| 112 | { |
Willy Tarreau | cf644ed | 2013-09-29 17:19:56 +0200 | [diff] [blame] | 113 | if (objt_appctx(si->end)) |
| 114 | return si->appctx.applet; |
| 115 | return NULL; |
| 116 | } |
| 117 | |
| 118 | /* Call the applet's main function when an appctx is attached to the stream |
| 119 | * interface. Returns zero if no call was made, or non-zero if a call was made. |
| 120 | */ |
| 121 | static inline int si_applet_call(struct stream_interface *si) |
| 122 | { |
| 123 | const struct si_applet *applet; |
| 124 | |
| 125 | applet = si_applet(si); |
| 126 | if (applet) { |
| 127 | applet->fct(si); |
| 128 | return 1; |
| 129 | } |
| 130 | return 0; |
Willy Tarreau | 4a59f2f | 2013-10-24 20:10:45 +0200 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | /* call the applet's release function if any. Needs to be called upon close() */ |
| 134 | static inline void si_applet_release(struct stream_interface *si) |
| 135 | { |
| 136 | const struct si_applet *applet; |
| 137 | |
| 138 | applet = si_applet(si); |
| 139 | if (applet && applet->release) |
| 140 | applet->release(si); |
| 141 | } |
| 142 | |
Willy Tarreau | 32e3c6a | 2013-10-11 19:34:20 +0200 | [diff] [blame] | 143 | /* Returns the stream interface's existing connection if one such already |
| 144 | * exists, or tries to allocate and initialize a new one which is then |
| 145 | * assigned to the stream interface. |
| 146 | */ |
| 147 | static inline struct connection *si_alloc_conn(struct stream_interface *si) |
| 148 | { |
| 149 | struct connection *conn; |
| 150 | |
| 151 | /* we return the connection whether it's a real connection or NULL |
| 152 | * in case another entity (an applet) is registered instead. |
| 153 | */ |
| 154 | conn = objt_conn(si->end); |
| 155 | if (si->end) |
| 156 | return conn; |
| 157 | |
| 158 | conn = conn_new(); |
| 159 | if (conn) |
| 160 | si_attach_conn(si, conn); |
| 161 | |
| 162 | return conn; |
| 163 | } |
| 164 | |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 165 | /* Sends a shutr to the connection using the data layer */ |
| 166 | static inline void si_shutr(struct stream_interface *si) |
| 167 | { |
Willy Tarreau | 6fe1541 | 2013-09-29 15:16:03 +0200 | [diff] [blame] | 168 | si->ops->shutr(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 169 | } |
| 170 | |
| 171 | /* Sends a shutw to the connection using the data layer */ |
| 172 | static inline void si_shutw(struct stream_interface *si) |
| 173 | { |
Willy Tarreau | 6fe1541 | 2013-09-29 15:16:03 +0200 | [diff] [blame] | 174 | si->ops->shutw(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 175 | } |
| 176 | |
| 177 | /* Calls the data state update on the stream interfaace */ |
| 178 | static inline void si_update(struct stream_interface *si) |
| 179 | { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 180 | si->ops->update(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 181 | } |
| 182 | |
| 183 | /* Calls chk_rcv on the connection using the data layer */ |
| 184 | static inline void si_chk_rcv(struct stream_interface *si) |
| 185 | { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 186 | si->ops->chk_rcv(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 187 | } |
| 188 | |
| 189 | /* Calls chk_snd on the connection using the data layer */ |
| 190 | static inline void si_chk_snd(struct stream_interface *si) |
| 191 | { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 192 | si->ops->chk_snd(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 193 | } |
| 194 | |
| 195 | /* Calls chk_snd on the connection using the ctrl layer */ |
| 196 | static inline int si_connect(struct stream_interface *si) |
| 197 | { |
Willy Tarreau | b363a1f | 2013-10-01 10:45:07 +0200 | [diff] [blame] | 198 | struct connection *conn = objt_conn(si->end); |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 199 | int ret; |
| 200 | |
Willy Tarreau | b363a1f | 2013-10-01 10:45:07 +0200 | [diff] [blame] | 201 | if (unlikely(!conn || !conn->ctrl || !conn->ctrl->connect)) |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 202 | return SN_ERR_INTERNAL; |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 203 | |
Willy Tarreau | b8020ce | 2013-10-24 21:10:08 +0200 | [diff] [blame^] | 204 | ret = conn->ctrl->connect(conn, !channel_is_empty(si->ob), !!conn->send_proxy_ofs); |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 205 | if (ret != SN_ERR_NONE) |
| 206 | return ret; |
| 207 | |
| 208 | /* needs src ip/port for logging */ |
| 209 | if (si->flags & SI_FL_SRC_ADDR) |
Willy Tarreau | b363a1f | 2013-10-01 10:45:07 +0200 | [diff] [blame] | 210 | conn_get_from_addr(conn); |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 211 | |
| 212 | /* Prepare to send a few handshakes related to the on-wire protocol. */ |
Willy Tarreau | b8020ce | 2013-10-24 21:10:08 +0200 | [diff] [blame^] | 213 | if (conn->send_proxy_ofs) |
Willy Tarreau | b363a1f | 2013-10-01 10:45:07 +0200 | [diff] [blame] | 214 | conn->flags |= CO_FL_SI_SEND_PROXY; |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 215 | |
| 216 | /* we need to be notified about connection establishment */ |
Willy Tarreau | b363a1f | 2013-10-01 10:45:07 +0200 | [diff] [blame] | 217 | conn->flags |= CO_FL_WAKE_DATA; |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 218 | |
| 219 | /* we're in the process of establishing a connection */ |
| 220 | si->state = SI_ST_CON; |
| 221 | |
| 222 | return ret; |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 223 | } |
Willy Tarreau | 59b9479 | 2012-05-11 16:16:40 +0200 | [diff] [blame] | 224 | |
Willy Tarreau | 55e4ecd | 2012-12-08 17:48:47 +0100 | [diff] [blame] | 225 | /* for debugging, reports the stream interface state name */ |
| 226 | static inline const char *si_state_str(int state) |
| 227 | { |
| 228 | switch (state) { |
| 229 | case SI_ST_INI: return "INI"; |
| 230 | case SI_ST_REQ: return "REQ"; |
| 231 | case SI_ST_QUE: return "QUE"; |
| 232 | case SI_ST_TAR: return "TAR"; |
| 233 | case SI_ST_ASS: return "ASS"; |
| 234 | case SI_ST_CON: return "CON"; |
| 235 | case SI_ST_CER: return "CER"; |
| 236 | case SI_ST_EST: return "EST"; |
| 237 | case SI_ST_DIS: return "DIS"; |
| 238 | case SI_ST_CLO: return "CLO"; |
| 239 | default: return "???"; |
| 240 | } |
| 241 | } |
| 242 | |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 243 | #endif /* _PROTO_STREAM_INTERFACE_H */ |
| 244 | |
| 245 | /* |
| 246 | * Local variables: |
| 247 | * c-indent-level: 8 |
| 248 | * c-basic-offset: 8 |
| 249 | * End: |
| 250 | */ |