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 | 2bb4a96 | 2014-11-28 11:11:05 +0100 | [diff] [blame] | 5 | * Copyright (C) 2000-2014 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 | 323a2d9 | 2015-08-04 19:00:17 +0200 | [diff] [blame] | 28 | #include <types/server.h> |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 29 | #include <types/stream.h> |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 30 | #include <types/stream_interface.h> |
Willy Tarreau | 8a8d83b | 2015-04-13 13:24:54 +0200 | [diff] [blame] | 31 | #include <proto/applet.h> |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 32 | #include <proto/channel.h> |
Willy Tarreau | f9dabec | 2012-08-17 17:33:53 +0200 | [diff] [blame] | 33 | #include <proto/connection.h> |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 34 | |
| 35 | |
| 36 | /* main event functions used to move data between sockets and buffers */ |
Willy Tarreau | 269358d | 2009-09-20 20:14:49 +0200 | [diff] [blame] | 37 | int stream_int_check_timeouts(struct stream_interface *si); |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 38 | void stream_int_report_error(struct stream_interface *si); |
Willy Tarreau | 83061a8 | 2018-07-13 11:56:34 +0200 | [diff] [blame] | 39 | void stream_int_retnclose(struct stream_interface *si, |
| 40 | const struct buffer *msg); |
Willy Tarreau | 2c6be84 | 2012-07-06 17:12:34 +0200 | [diff] [blame] | 41 | int conn_si_send_proxy(struct connection *conn, unsigned int flag); |
Willy Tarreau | 9bf9c14 | 2012-08-20 15:38:41 +0200 | [diff] [blame] | 42 | void stream_sock_read0(struct stream_interface *si); |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 43 | |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 44 | extern struct si_ops si_embedded_ops; |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 45 | extern struct si_ops si_conn_ops; |
Willy Tarreau | d45b9f8 | 2015-04-13 16:30:14 +0200 | [diff] [blame] | 46 | extern struct si_ops si_applet_ops; |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 47 | extern struct data_cb si_conn_cb; |
Willy Tarreau | 2737562 | 2013-12-17 00:00:28 +0100 | [diff] [blame] | 48 | extern struct data_cb si_idle_conn_cb; |
Willy Tarreau | 5c979a9 | 2012-05-07 17:15:39 +0200 | [diff] [blame] | 49 | |
Willy Tarreau | 3057645 | 2015-04-13 13:50:30 +0200 | [diff] [blame] | 50 | struct appctx *stream_int_register_handler(struct stream_interface *si, struct applet *app); |
Willy Tarreau | aa977ba | 2015-09-25 11:45:06 +0200 | [diff] [blame] | 51 | void si_applet_wake_cb(struct stream_interface *si); |
Willy Tarreau | 25f1310 | 2015-09-24 11:32:22 +0200 | [diff] [blame] | 52 | void stream_int_update(struct stream_interface *si); |
Willy Tarreau | cbc3260 | 2015-09-25 11:01:42 +0200 | [diff] [blame] | 53 | void stream_int_update_conn(struct stream_interface *si); |
| 54 | void stream_int_update_applet(struct stream_interface *si); |
Willy Tarreau | 615f28b | 2015-09-23 18:40:09 +0200 | [diff] [blame] | 55 | void stream_int_notify(struct stream_interface *si); |
Olivier Houchard | 0e367bb | 2018-09-14 19:41:13 +0200 | [diff] [blame] | 56 | int si_cs_recv(struct conn_stream *cs); |
| 57 | int si_cs_send(struct conn_stream *cs); |
Olivier Houchard | 91894cb | 2018-08-02 18:06:28 +0200 | [diff] [blame] | 58 | struct task *si_cs_io_cb(struct task *t, void *ctx, unsigned short state); |
Willy Tarreau | fb90d94 | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 59 | |
Willy Tarreau | 2bb4a96 | 2014-11-28 11:11:05 +0100 | [diff] [blame] | 60 | /* returns the channel which receives data from this stream interface (input channel) */ |
| 61 | static inline struct channel *si_ic(struct stream_interface *si) |
| 62 | { |
Willy Tarreau | 0b2fb7f | 2014-11-28 11:50:38 +0100 | [diff] [blame] | 63 | if (si->flags & SI_FL_ISBACK) |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 64 | return &LIST_ELEM(si, struct stream *, si[1])->res; |
Willy Tarreau | 0b2fb7f | 2014-11-28 11:50:38 +0100 | [diff] [blame] | 65 | else |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 66 | return &LIST_ELEM(si, struct stream *, si[0])->req; |
Willy Tarreau | 2bb4a96 | 2014-11-28 11:11:05 +0100 | [diff] [blame] | 67 | } |
| 68 | |
| 69 | /* returns the channel which feeds data to this stream interface (output channel) */ |
| 70 | static inline struct channel *si_oc(struct stream_interface *si) |
| 71 | { |
Willy Tarreau | 0b2fb7f | 2014-11-28 11:50:38 +0100 | [diff] [blame] | 72 | if (si->flags & SI_FL_ISBACK) |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 73 | return &LIST_ELEM(si, struct stream *, si[1])->req; |
Willy Tarreau | 0b2fb7f | 2014-11-28 11:50:38 +0100 | [diff] [blame] | 74 | else |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 75 | return &LIST_ELEM(si, struct stream *, si[0])->res; |
Willy Tarreau | 2bb4a96 | 2014-11-28 11:11:05 +0100 | [diff] [blame] | 76 | } |
| 77 | |
Willy Tarreau | 4e4292b | 2014-11-28 12:18:45 +0100 | [diff] [blame] | 78 | /* returns the buffer which receives data from this stream interface (input channel's buffer) */ |
| 79 | static inline struct buffer *si_ib(struct stream_interface *si) |
| 80 | { |
Willy Tarreau | c9fa048 | 2018-07-10 17:43:27 +0200 | [diff] [blame] | 81 | return &si_ic(si)->buf; |
Willy Tarreau | 4e4292b | 2014-11-28 12:18:45 +0100 | [diff] [blame] | 82 | } |
| 83 | |
| 84 | /* returns the buffer which feeds data to this stream interface (output channel's buffer) */ |
| 85 | static inline struct buffer *si_ob(struct stream_interface *si) |
| 86 | { |
Willy Tarreau | c9fa048 | 2018-07-10 17:43:27 +0200 | [diff] [blame] | 87 | return &si_oc(si)->buf; |
Willy Tarreau | 4e4292b | 2014-11-28 12:18:45 +0100 | [diff] [blame] | 88 | } |
| 89 | |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 90 | /* returns the stream associated to a stream interface */ |
| 91 | static inline struct stream *si_strm(struct stream_interface *si) |
Willy Tarreau | aefd790 | 2014-11-28 12:03:32 +0100 | [diff] [blame] | 92 | { |
| 93 | if (si->flags & SI_FL_ISBACK) |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 94 | return LIST_ELEM(si, struct stream *, si[1]); |
Willy Tarreau | aefd790 | 2014-11-28 12:03:32 +0100 | [diff] [blame] | 95 | else |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 96 | return LIST_ELEM(si, struct stream *, si[0]); |
Willy Tarreau | aefd790 | 2014-11-28 12:03:32 +0100 | [diff] [blame] | 97 | } |
| 98 | |
Willy Tarreau | 07373b8 | 2014-11-28 12:08:47 +0100 | [diff] [blame] | 99 | /* returns the task associated to this stream interface */ |
| 100 | static inline struct task *si_task(struct stream_interface *si) |
| 101 | { |
| 102 | if (si->flags & SI_FL_ISBACK) |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 103 | return LIST_ELEM(si, struct stream *, si[1])->task; |
Willy Tarreau | 07373b8 | 2014-11-28 12:08:47 +0100 | [diff] [blame] | 104 | else |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 105 | return LIST_ELEM(si, struct stream *, si[0])->task; |
Willy Tarreau | 07373b8 | 2014-11-28 12:08:47 +0100 | [diff] [blame] | 106 | } |
| 107 | |
Willy Tarreau | 50fe03b | 2014-11-28 13:59:31 +0100 | [diff] [blame] | 108 | /* returns the stream interface on the other side. Used during forwarding. */ |
| 109 | static inline struct stream_interface *si_opposite(struct stream_interface *si) |
| 110 | { |
| 111 | if (si->flags & SI_FL_ISBACK) |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 112 | return &LIST_ELEM(si, struct stream *, si[1])->si[0]; |
Willy Tarreau | 50fe03b | 2014-11-28 13:59:31 +0100 | [diff] [blame] | 113 | else |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 114 | return &LIST_ELEM(si, struct stream *, si[0])->si[1]; |
Willy Tarreau | 50fe03b | 2014-11-28 13:59:31 +0100 | [diff] [blame] | 115 | } |
| 116 | |
Willy Tarreau | 3ed35ef | 2013-10-24 11:51:38 +0200 | [diff] [blame] | 117 | /* initializes a stream interface in the SI_ST_INI state. It's detached from |
Willy Tarreau | 819d332 | 2014-11-28 12:12:34 +0100 | [diff] [blame] | 118 | * any endpoint and only keeps its side which is expected to have already been |
| 119 | * set. |
Willy Tarreau | 3ed35ef | 2013-10-24 11:51:38 +0200 | [diff] [blame] | 120 | */ |
Olivier Houchard | 8f0b4c6 | 2018-08-02 18:21:38 +0200 | [diff] [blame] | 121 | static inline int si_reset(struct stream_interface *si) |
Willy Tarreau | 3ed35ef | 2013-10-24 11:51:38 +0200 | [diff] [blame] | 122 | { |
Willy Tarreau | 3ed35ef | 2013-10-24 11:51:38 +0200 | [diff] [blame] | 123 | si->err_type = SI_ET_NONE; |
| 124 | si->conn_retries = 0; /* used for logging too */ |
Willy Tarreau | 3ed35ef | 2013-10-24 11:51:38 +0200 | [diff] [blame] | 125 | si->exp = TICK_ETERNITY; |
Willy Tarreau | a5f5d8d | 2014-11-28 11:26:07 +0100 | [diff] [blame] | 126 | si->flags &= SI_FL_ISBACK; |
Willy Tarreau | 3ed35ef | 2013-10-24 11:51:38 +0200 | [diff] [blame] | 127 | si->end = NULL; |
| 128 | si->state = si->prev_state = SI_ST_INI; |
Willy Tarreau | 7365dad | 2015-04-20 01:03:17 +0200 | [diff] [blame] | 129 | si->ops = &si_embedded_ops; |
Olivier Houchard | fa8aa86 | 2018-10-10 18:25:41 +0200 | [diff] [blame] | 130 | si->wait_event.task = tasklet_new(); |
| 131 | if (!si->wait_event.task) |
Olivier Houchard | 8f0b4c6 | 2018-08-02 18:21:38 +0200 | [diff] [blame] | 132 | return -1; |
Olivier Houchard | fa8aa86 | 2018-10-10 18:25:41 +0200 | [diff] [blame] | 133 | si->wait_event.task->process = si_cs_io_cb; |
| 134 | si->wait_event.task->context = si; |
| 135 | si->wait_event.wait_reason = 0; |
Olivier Houchard | 8f0b4c6 | 2018-08-02 18:21:38 +0200 | [diff] [blame] | 136 | return 0; |
Willy Tarreau | 3ed35ef | 2013-10-24 11:51:38 +0200 | [diff] [blame] | 137 | } |
| 138 | |
| 139 | /* sets the current and previous state of a stream interface to <state>. This |
| 140 | * is mainly used to create one in the established state on incoming |
| 141 | * conncetions. |
| 142 | */ |
| 143 | static inline void si_set_state(struct stream_interface *si, int state) |
| 144 | { |
| 145 | si->state = si->prev_state = state; |
| 146 | } |
| 147 | |
Willy Tarreau | 41b09f4 | 2015-08-04 20:44:05 +0200 | [diff] [blame] | 148 | /* only detaches the endpoint from the SI, which means that it's set to |
| 149 | * NULL and that ->ops is mapped to si_embedded_ops. The previous endpoint |
| 150 | * is returned. |
| 151 | */ |
| 152 | static inline enum obj_type *si_detach_endpoint(struct stream_interface *si) |
| 153 | { |
| 154 | enum obj_type *prev = si->end; |
| 155 | |
| 156 | si->end = NULL; |
| 157 | si->ops = &si_embedded_ops; |
| 158 | return prev; |
| 159 | } |
| 160 | |
Willy Tarreau | 0a23bcb | 2013-12-01 11:31:38 +0100 | [diff] [blame] | 161 | /* Release the endpoint if it's a connection or an applet, then nullify it. |
| 162 | * Note: released connections are closed then freed. |
| 163 | */ |
Willy Tarreau | 32e3c6a | 2013-10-11 19:34:20 +0200 | [diff] [blame] | 164 | static inline void si_release_endpoint(struct stream_interface *si) |
Willy Tarreau | 372d670 | 2013-09-29 17:19:56 +0200 | [diff] [blame] | 165 | { |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 166 | struct conn_stream *cs; |
Willy Tarreau | 0a23bcb | 2013-12-01 11:31:38 +0100 | [diff] [blame] | 167 | struct appctx *appctx; |
Willy Tarreau | 32e3c6a | 2013-10-11 19:34:20 +0200 | [diff] [blame] | 168 | |
Willy Tarreau | 0a23bcb | 2013-12-01 11:31:38 +0100 | [diff] [blame] | 169 | if (!si->end) |
| 170 | return; |
| 171 | |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 172 | if ((cs = objt_cs(si->end))) |
| 173 | cs_destroy(cs); |
Willy Tarreau | 0a23bcb | 2013-12-01 11:31:38 +0100 | [diff] [blame] | 174 | else if ((appctx = objt_appctx(si->end))) { |
Willy Tarreau | 958f074 | 2015-09-25 20:24:26 +0200 | [diff] [blame] | 175 | if (appctx->applet->release && si->state < SI_ST_DIS) |
Willy Tarreau | 00a37f0 | 2015-04-13 12:05:19 +0200 | [diff] [blame] | 176 | appctx->applet->release(appctx); |
Willy Tarreau | 0a23bcb | 2013-12-01 11:31:38 +0100 | [diff] [blame] | 177 | appctx_free(appctx); /* we share the connection pool */ |
| 178 | } |
Willy Tarreau | 41b09f4 | 2015-08-04 20:44:05 +0200 | [diff] [blame] | 179 | si_detach_endpoint(si); |
Willy Tarreau | 372d670 | 2013-09-29 17:19:56 +0200 | [diff] [blame] | 180 | } |
| 181 | |
Willy Tarreau | 4320eaa | 2015-08-05 11:08:30 +0200 | [diff] [blame] | 182 | /* Turn an existing connection endpoint of stream interface <si> to idle mode, |
| 183 | * which means that the connection will be polled for incoming events and might |
| 184 | * be killed by the underlying I/O handler. If <pool> is not null, the |
| 185 | * connection will also be added at the head of this list. This connection |
| 186 | * remains assigned to the stream interface it is currently attached to. |
Willy Tarreau | 2737562 | 2013-12-17 00:00:28 +0100 | [diff] [blame] | 187 | */ |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 188 | static inline void si_idle_cs(struct stream_interface *si, struct list *pool) |
Willy Tarreau | 2737562 | 2013-12-17 00:00:28 +0100 | [diff] [blame] | 189 | { |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 190 | struct conn_stream *cs = __objt_cs(si->end); |
| 191 | struct connection *conn = cs->conn; |
Willy Tarreau | 2737562 | 2013-12-17 00:00:28 +0100 | [diff] [blame] | 192 | |
Willy Tarreau | 323a2d9 | 2015-08-04 19:00:17 +0200 | [diff] [blame] | 193 | if (pool) |
| 194 | LIST_ADD(pool, &conn->list); |
| 195 | |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 196 | cs_attach(cs, si, &si_idle_conn_cb); |
| 197 | cs_want_recv(cs); |
Willy Tarreau | 2737562 | 2013-12-17 00:00:28 +0100 | [diff] [blame] | 198 | } |
| 199 | |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 200 | /* Attach conn_stream <cs> to the stream interface <si>. The stream interface |
Willy Tarreau | 2a6e880 | 2013-10-24 15:50:53 +0200 | [diff] [blame] | 201 | * is configured to work with a connection and the connection it configured |
| 202 | * with a stream interface data layer. |
Willy Tarreau | b363a1f | 2013-10-01 10:45:07 +0200 | [diff] [blame] | 203 | */ |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 204 | static inline void si_attach_cs(struct stream_interface *si, struct conn_stream *cs) |
Willy Tarreau | bd99aab | 2012-10-02 20:57:19 +0200 | [diff] [blame] | 205 | { |
| 206 | si->ops = &si_conn_ops; |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 207 | si->end = &cs->obj_type; |
| 208 | cs_attach(cs, si, &si_conn_cb); |
Willy Tarreau | bd99aab | 2012-10-02 20:57:19 +0200 | [diff] [blame] | 209 | } |
| 210 | |
Willy Tarreau | d02cdd2 | 2013-12-15 10:23:20 +0100 | [diff] [blame] | 211 | /* Returns true if a connection is attached to the stream interface <si> and |
| 212 | * if this connection is ready. |
| 213 | */ |
| 214 | static inline int si_conn_ready(struct stream_interface *si) |
| 215 | { |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 216 | struct connection *conn = cs_conn(objt_cs(si->end)); |
Willy Tarreau | d02cdd2 | 2013-12-15 10:23:20 +0100 | [diff] [blame] | 217 | |
| 218 | return conn && conn_ctrl_ready(conn) && conn_xprt_ready(conn); |
| 219 | } |
| 220 | |
Willy Tarreau | 0a23bcb | 2013-12-01 11:31:38 +0100 | [diff] [blame] | 221 | /* Attach appctx <appctx> to the stream interface <si>. The stream interface |
Willy Tarreau | a7513f5 | 2015-04-05 00:15:26 +0200 | [diff] [blame] | 222 | * is configured to work with an applet context. |
Willy Tarreau | 0a23bcb | 2013-12-01 11:31:38 +0100 | [diff] [blame] | 223 | */ |
| 224 | static inline void si_attach_appctx(struct stream_interface *si, struct appctx *appctx) |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 225 | { |
Willy Tarreau | d45b9f8 | 2015-04-13 16:30:14 +0200 | [diff] [blame] | 226 | si->ops = &si_applet_ops; |
Willy Tarreau | 0a23bcb | 2013-12-01 11:31:38 +0100 | [diff] [blame] | 227 | si->end = &appctx->obj_type; |
Willy Tarreau | 19c8161 | 2015-04-13 11:48:16 +0200 | [diff] [blame] | 228 | appctx->owner = si; |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 229 | } |
| 230 | |
Willy Tarreau | 4ae4923 | 2018-09-20 11:08:47 +0200 | [diff] [blame] | 231 | /* returns a pointer to the appctx being run in the SI, which must be valid */ |
Willy Tarreau | 7b4b499 | 2013-12-01 09:15:12 +0100 | [diff] [blame] | 232 | static inline struct appctx *si_appctx(struct stream_interface *si) |
| 233 | { |
Willy Tarreau | 4ae4923 | 2018-09-20 11:08:47 +0200 | [diff] [blame] | 234 | return __objt_appctx(si->end); |
Willy Tarreau | 7b4b499 | 2013-12-01 09:15:12 +0100 | [diff] [blame] | 235 | } |
| 236 | |
Willy Tarreau | 4a59f2f | 2013-10-24 20:10:45 +0200 | [diff] [blame] | 237 | /* call the applet's release function if any. Needs to be called upon close() */ |
| 238 | static inline void si_applet_release(struct stream_interface *si) |
| 239 | { |
Willy Tarreau | 00a37f0 | 2015-04-13 12:05:19 +0200 | [diff] [blame] | 240 | struct appctx *appctx; |
Willy Tarreau | 4a59f2f | 2013-10-24 20:10:45 +0200 | [diff] [blame] | 241 | |
Willy Tarreau | 4ae4923 | 2018-09-20 11:08:47 +0200 | [diff] [blame] | 242 | appctx = objt_appctx(si->end); |
Willy Tarreau | 958f074 | 2015-09-25 20:24:26 +0200 | [diff] [blame] | 243 | if (appctx && appctx->applet->release && si->state < SI_ST_DIS) |
Willy Tarreau | 00a37f0 | 2015-04-13 12:05:19 +0200 | [diff] [blame] | 244 | appctx->applet->release(appctx); |
Willy Tarreau | 4a59f2f | 2013-10-24 20:10:45 +0200 | [diff] [blame] | 245 | } |
| 246 | |
Willy Tarreau | eb406dc | 2015-04-21 18:44:02 +0200 | [diff] [blame] | 247 | /* let an applet indicate that it wants to put some data into the input buffer */ |
| 248 | static inline void si_applet_want_put(struct stream_interface *si) |
| 249 | { |
| 250 | si->flags |= SI_FL_WANT_PUT; |
| 251 | } |
| 252 | |
| 253 | /* let an applet indicate that it wanted to put some data into the input buffer |
| 254 | * but it couldn't. |
| 255 | */ |
| 256 | static inline void si_applet_cant_put(struct stream_interface *si) |
| 257 | { |
| 258 | si->flags |= SI_FL_WANT_PUT | SI_FL_WAIT_ROOM; |
| 259 | } |
| 260 | |
| 261 | /* let an applet indicate that it doesn't want to put data into the input buffer */ |
| 262 | static inline void si_applet_stop_put(struct stream_interface *si) |
| 263 | { |
| 264 | si->flags &= ~SI_FL_WANT_PUT; |
| 265 | } |
| 266 | |
| 267 | /* let an applet indicate that it wants to get some data from the output buffer */ |
| 268 | static inline void si_applet_want_get(struct stream_interface *si) |
| 269 | { |
| 270 | si->flags |= SI_FL_WANT_GET; |
| 271 | } |
| 272 | |
| 273 | /* let an applet indicate that it wanted to get some data from the output buffer |
| 274 | * but it couldn't. |
| 275 | */ |
| 276 | static inline void si_applet_cant_get(struct stream_interface *si) |
| 277 | { |
| 278 | si->flags |= SI_FL_WANT_GET | SI_FL_WAIT_DATA; |
| 279 | } |
| 280 | |
| 281 | /* let an applet indicate that it doesn't want to get data from the input buffer */ |
| 282 | static inline void si_applet_stop_get(struct stream_interface *si) |
| 283 | { |
| 284 | si->flags &= ~SI_FL_WANT_GET; |
| 285 | } |
| 286 | |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 287 | /* Try to allocate a new conn_stream and assign it to the interface. If |
Willy Tarreau | 973a542 | 2015-08-05 21:47:23 +0200 | [diff] [blame] | 288 | * an endpoint was previously allocated, it is released first. The newly |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 289 | * allocated conn_stream is initialized, assigned to the stream interface, |
Willy Tarreau | 973a542 | 2015-08-05 21:47:23 +0200 | [diff] [blame] | 290 | * and returned. |
Willy Tarreau | 9471b8c | 2013-12-15 13:31:35 +0100 | [diff] [blame] | 291 | */ |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 292 | static inline struct conn_stream *si_alloc_cs(struct stream_interface *si, struct connection *conn) |
Willy Tarreau | 32e3c6a | 2013-10-11 19:34:20 +0200 | [diff] [blame] | 293 | { |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 294 | struct conn_stream *cs; |
Willy Tarreau | 32e3c6a | 2013-10-11 19:34:20 +0200 | [diff] [blame] | 295 | |
Willy Tarreau | 973a542 | 2015-08-05 21:47:23 +0200 | [diff] [blame] | 296 | si_release_endpoint(si); |
Willy Tarreau | 32e3c6a | 2013-10-11 19:34:20 +0200 | [diff] [blame] | 297 | |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 298 | cs = cs_new(conn); |
| 299 | if (cs) |
| 300 | si_attach_cs(si, cs); |
Willy Tarreau | 32e3c6a | 2013-10-11 19:34:20 +0200 | [diff] [blame] | 301 | |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 302 | return cs; |
Willy Tarreau | 32e3c6a | 2013-10-11 19:34:20 +0200 | [diff] [blame] | 303 | } |
| 304 | |
Willy Tarreau | 0a23bcb | 2013-12-01 11:31:38 +0100 | [diff] [blame] | 305 | /* Release the interface's existing endpoint (connection or appctx) and |
| 306 | * allocate then initialize a new appctx which is assigned to the interface |
Willy Tarreau | a7513f5 | 2015-04-05 00:15:26 +0200 | [diff] [blame] | 307 | * and returned. NULL may be returned upon memory shortage. Applet <applet> |
| 308 | * is assigned to the appctx, but it may be NULL. |
Willy Tarreau | 0a23bcb | 2013-12-01 11:31:38 +0100 | [diff] [blame] | 309 | */ |
Willy Tarreau | 3057645 | 2015-04-13 13:50:30 +0200 | [diff] [blame] | 310 | static inline struct appctx *si_alloc_appctx(struct stream_interface *si, struct applet *applet) |
Willy Tarreau | 0a23bcb | 2013-12-01 11:31:38 +0100 | [diff] [blame] | 311 | { |
| 312 | struct appctx *appctx; |
| 313 | |
| 314 | si_release_endpoint(si); |
Emeric Brun | 1138fd0 | 2017-06-19 12:38:55 +0200 | [diff] [blame] | 315 | appctx = appctx_new(applet, tid_bit); |
Willy Tarreau | 10d81b8 | 2018-05-31 14:44:25 +0200 | [diff] [blame] | 316 | if (appctx) { |
Willy Tarreau | 0a23bcb | 2013-12-01 11:31:38 +0100 | [diff] [blame] | 317 | si_attach_appctx(si, appctx); |
Willy Tarreau | 10d81b8 | 2018-05-31 14:44:25 +0200 | [diff] [blame] | 318 | appctx->t->nice = si_strm(si)->task->nice; |
| 319 | } |
Willy Tarreau | 0a23bcb | 2013-12-01 11:31:38 +0100 | [diff] [blame] | 320 | |
| 321 | return appctx; |
| 322 | } |
| 323 | |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 324 | /* Sends a shutr to the connection using the data layer */ |
| 325 | static inline void si_shutr(struct stream_interface *si) |
| 326 | { |
Willy Tarreau | 6fe1541 | 2013-09-29 15:16:03 +0200 | [diff] [blame] | 327 | si->ops->shutr(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 328 | } |
| 329 | |
| 330 | /* Sends a shutw to the connection using the data layer */ |
| 331 | static inline void si_shutw(struct stream_interface *si) |
| 332 | { |
Willy Tarreau | 6fe1541 | 2013-09-29 15:16:03 +0200 | [diff] [blame] | 333 | si->ops->shutw(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 334 | } |
| 335 | |
Willy Tarreau | 5d5b2fe | 2015-09-25 10:59:38 +0200 | [diff] [blame] | 336 | /* Updates the stream interface and timers, then updates the data layer below */ |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 337 | static inline void si_update(struct stream_interface *si) |
| 338 | { |
Willy Tarreau | 5d5b2fe | 2015-09-25 10:59:38 +0200 | [diff] [blame] | 339 | stream_int_update(si); |
Willy Tarreau | 3355203 | 2015-09-24 18:05:45 +0200 | [diff] [blame] | 340 | if (si->ops->update) |
| 341 | si->ops->update(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 342 | } |
| 343 | |
| 344 | /* Calls chk_rcv on the connection using the data layer */ |
| 345 | static inline void si_chk_rcv(struct stream_interface *si) |
| 346 | { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 347 | si->ops->chk_rcv(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 348 | } |
| 349 | |
| 350 | /* Calls chk_snd on the connection using the data layer */ |
| 351 | static inline void si_chk_snd(struct stream_interface *si) |
| 352 | { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 353 | si->ops->chk_snd(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 354 | } |
| 355 | |
| 356 | /* Calls chk_snd on the connection using the ctrl layer */ |
| 357 | static inline int si_connect(struct stream_interface *si) |
| 358 | { |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 359 | struct conn_stream *cs = objt_cs(si->end); |
| 360 | struct connection *conn = cs_conn(cs); |
Willy Tarreau | e7dff02 | 2015-04-03 01:14:29 +0200 | [diff] [blame] | 361 | int ret = SF_ERR_NONE; |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 362 | |
Willy Tarreau | b363a1f | 2013-10-01 10:45:07 +0200 | [diff] [blame] | 363 | if (unlikely(!conn || !conn->ctrl || !conn->ctrl->connect)) |
Willy Tarreau | e7dff02 | 2015-04-03 01:14:29 +0200 | [diff] [blame] | 364 | return SF_ERR_INTERNAL; |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 365 | |
Willy Tarreau | b490b4e | 2013-12-15 16:20:50 +0100 | [diff] [blame] | 366 | if (!conn_ctrl_ready(conn) || !conn_xprt_ready(conn)) { |
Willy Tarreau | 2bb4a96 | 2014-11-28 11:11:05 +0100 | [diff] [blame] | 367 | ret = conn->ctrl->connect(conn, !channel_is_empty(si_oc(si)), 0); |
Willy Tarreau | e7dff02 | 2015-04-03 01:14:29 +0200 | [diff] [blame] | 368 | if (ret != SF_ERR_NONE) |
Willy Tarreau | b490b4e | 2013-12-15 16:20:50 +0100 | [diff] [blame] | 369 | return ret; |
Willy Tarreau | 9e5a3aa | 2013-12-31 23:32:12 +0100 | [diff] [blame] | 370 | |
Willy Tarreau | 9e5a3aa | 2013-12-31 23:32:12 +0100 | [diff] [blame] | 371 | /* we're in the process of establishing a connection */ |
| 372 | si->state = SI_ST_CON; |
Willy Tarreau | b490b4e | 2013-12-15 16:20:50 +0100 | [diff] [blame] | 373 | } |
Christopher Faulet | c34d19f | 2015-12-23 09:33:35 +0100 | [diff] [blame] | 374 | else { |
| 375 | /* reuse the existing connection */ |
| 376 | if (!channel_is_empty(si_oc(si))) { |
| 377 | /* we'll have to send a request there. */ |
Olivier Houchard | 9aaf778 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 378 | cs_want_send(cs); |
Christopher Faulet | c34d19f | 2015-12-23 09:33:35 +0100 | [diff] [blame] | 379 | } |
Willy Tarreau | 9e5a3aa | 2013-12-31 23:32:12 +0100 | [diff] [blame] | 380 | |
| 381 | /* the connection is established */ |
| 382 | si->state = SI_ST_EST; |
Willy Tarreau | b490b4e | 2013-12-15 16:20:50 +0100 | [diff] [blame] | 383 | } |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 384 | |
| 385 | /* needs src ip/port for logging */ |
| 386 | if (si->flags & SI_FL_SRC_ADDR) |
Willy Tarreau | b363a1f | 2013-10-01 10:45:07 +0200 | [diff] [blame] | 387 | conn_get_from_addr(conn); |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 388 | |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 389 | return ret; |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 390 | } |
Willy Tarreau | 59b9479 | 2012-05-11 16:16:40 +0200 | [diff] [blame] | 391 | |
Willy Tarreau | 55e4ecd | 2012-12-08 17:48:47 +0100 | [diff] [blame] | 392 | /* for debugging, reports the stream interface state name */ |
| 393 | static inline const char *si_state_str(int state) |
| 394 | { |
| 395 | switch (state) { |
| 396 | case SI_ST_INI: return "INI"; |
| 397 | case SI_ST_REQ: return "REQ"; |
| 398 | case SI_ST_QUE: return "QUE"; |
| 399 | case SI_ST_TAR: return "TAR"; |
| 400 | case SI_ST_ASS: return "ASS"; |
| 401 | case SI_ST_CON: return "CON"; |
| 402 | case SI_ST_CER: return "CER"; |
| 403 | case SI_ST_EST: return "EST"; |
| 404 | case SI_ST_DIS: return "DIS"; |
| 405 | case SI_ST_CLO: return "CLO"; |
| 406 | default: return "???"; |
| 407 | } |
| 408 | } |
| 409 | |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 410 | #endif /* _PROTO_STREAM_INTERFACE_H */ |
| 411 | |
| 412 | /* |
| 413 | * Local variables: |
| 414 | * c-indent-level: 8 |
| 415 | * c-basic-offset: 8 |
| 416 | * End: |
| 417 | */ |