blob: cdc2245f68ca0d5306df3a2e9ee428e58d80258c [file] [log] [blame]
Willy Tarreaucff64112008-11-03 06:26:53 +01001/*
Willy Tarreau8e89b842009-10-18 23:56:35 +02002 * include/proto/stream_interface.h
3 * This file contains stream_interface function prototypes
4 *
Willy Tarreau2bb4a962014-11-28 11:11:05 +01005 * Copyright (C) 2000-2014 Willy Tarreau - w@1wt.eu
Willy Tarreau8e89b842009-10-18 23:56:35 +02006 *
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 Tarreaucff64112008-11-03 06:26:53 +010021
22#ifndef _PROTO_STREAM_INTERFACE_H
23#define _PROTO_STREAM_INTERFACE_H
24
25#include <stdlib.h>
26
27#include <common/config.h>
Willy Tarreau323a2d92015-08-04 19:00:17 +020028#include <types/server.h>
Willy Tarreau87b09662015-04-03 00:22:06 +020029#include <types/stream.h>
Willy Tarreaucff64112008-11-03 06:26:53 +010030#include <types/stream_interface.h>
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020031#include <proto/applet.h>
Willy Tarreau14f8e862012-08-30 22:23:13 +020032#include <proto/channel.h>
Willy Tarreauf9dabec2012-08-17 17:33:53 +020033#include <proto/connection.h>
Willy Tarreaucff64112008-11-03 06:26:53 +010034
35
Willy Tarreauc5788912012-08-24 18:12:41 +020036extern struct si_ops si_embedded_ops;
Willy Tarreauc5788912012-08-24 18:12:41 +020037extern struct si_ops si_conn_ops;
Willy Tarreaud45b9f82015-04-13 16:30:14 +020038extern struct si_ops si_applet_ops;
Willy Tarreau74beec32012-10-03 00:41:04 +020039extern struct data_cb si_conn_cb;
Willy Tarreau5c979a92012-05-07 17:15:39 +020040
Willy Tarreau14bfe9a2018-12-19 15:19:27 +010041/* main event functions used to move data between sockets and buffers */
42int si_check_timeouts(struct stream_interface *si);
43void si_report_error(struct stream_interface *si);
44void si_retnclose(struct stream_interface *si, const struct buffer *msg);
45int conn_si_send_proxy(struct connection *conn, unsigned int flag);
46struct appctx *si_register_handler(struct stream_interface *si, struct applet *app);
Willy Tarreauaa977ba2015-09-25 11:45:06 +020047void si_applet_wake_cb(struct stream_interface *si);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +010048void si_update(struct stream_interface *si);
Olivier Houchard0e367bb2018-09-14 19:41:13 +020049int si_cs_recv(struct conn_stream *cs);
Olivier Houchard91894cb2018-08-02 18:06:28 +020050struct task *si_cs_io_cb(struct task *t, void *ctx, unsigned short state);
Willy Tarreaud14844a2018-11-08 18:15:29 +010051void si_update_both(struct stream_interface *si_f, struct stream_interface *si_b);
Willy Tarreaufb90d942009-09-05 20:57:35 +020052
Willy Tarreau2bb4a962014-11-28 11:11:05 +010053/* returns the channel which receives data from this stream interface (input channel) */
54static inline struct channel *si_ic(struct stream_interface *si)
55{
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010056 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020057 return &LIST_ELEM(si, struct stream *, si[1])->res;
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010058 else
Willy Tarreau87b09662015-04-03 00:22:06 +020059 return &LIST_ELEM(si, struct stream *, si[0])->req;
Willy Tarreau2bb4a962014-11-28 11:11:05 +010060}
61
62/* returns the channel which feeds data to this stream interface (output channel) */
63static inline struct channel *si_oc(struct stream_interface *si)
64{
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010065 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020066 return &LIST_ELEM(si, struct stream *, si[1])->req;
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010067 else
Willy Tarreau87b09662015-04-03 00:22:06 +020068 return &LIST_ELEM(si, struct stream *, si[0])->res;
Willy Tarreau2bb4a962014-11-28 11:11:05 +010069}
70
Willy Tarreau4e4292b2014-11-28 12:18:45 +010071/* returns the buffer which receives data from this stream interface (input channel's buffer) */
72static inline struct buffer *si_ib(struct stream_interface *si)
73{
Willy Tarreauc9fa0482018-07-10 17:43:27 +020074 return &si_ic(si)->buf;
Willy Tarreau4e4292b2014-11-28 12:18:45 +010075}
76
77/* returns the buffer which feeds data to this stream interface (output channel's buffer) */
78static inline struct buffer *si_ob(struct stream_interface *si)
79{
Willy Tarreauc9fa0482018-07-10 17:43:27 +020080 return &si_oc(si)->buf;
Willy Tarreau4e4292b2014-11-28 12:18:45 +010081}
82
Willy Tarreau87b09662015-04-03 00:22:06 +020083/* returns the stream associated to a stream interface */
84static inline struct stream *si_strm(struct stream_interface *si)
Willy Tarreauaefd7902014-11-28 12:03:32 +010085{
86 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020087 return LIST_ELEM(si, struct stream *, si[1]);
Willy Tarreauaefd7902014-11-28 12:03:32 +010088 else
Willy Tarreau87b09662015-04-03 00:22:06 +020089 return LIST_ELEM(si, struct stream *, si[0]);
Willy Tarreauaefd7902014-11-28 12:03:32 +010090}
91
Willy Tarreau07373b82014-11-28 12:08:47 +010092/* returns the task associated to this stream interface */
93static inline struct task *si_task(struct stream_interface *si)
94{
95 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020096 return LIST_ELEM(si, struct stream *, si[1])->task;
Willy Tarreau07373b82014-11-28 12:08:47 +010097 else
Willy Tarreau87b09662015-04-03 00:22:06 +020098 return LIST_ELEM(si, struct stream *, si[0])->task;
Willy Tarreau07373b82014-11-28 12:08:47 +010099}
100
Willy Tarreau50fe03b2014-11-28 13:59:31 +0100101/* returns the stream interface on the other side. Used during forwarding. */
102static inline struct stream_interface *si_opposite(struct stream_interface *si)
103{
104 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +0200105 return &LIST_ELEM(si, struct stream *, si[1])->si[0];
Willy Tarreau50fe03b2014-11-28 13:59:31 +0100106 else
Willy Tarreau87b09662015-04-03 00:22:06 +0200107 return &LIST_ELEM(si, struct stream *, si[0])->si[1];
Willy Tarreau50fe03b2014-11-28 13:59:31 +0100108}
109
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200110/* initializes a stream interface in the SI_ST_INI state. It's detached from
Willy Tarreau819d3322014-11-28 12:12:34 +0100111 * any endpoint and only keeps its side which is expected to have already been
112 * set.
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200113 */
Olivier Houchard8f0b4c62018-08-02 18:21:38 +0200114static inline int si_reset(struct stream_interface *si)
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200115{
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200116 si->err_type = SI_ET_NONE;
117 si->conn_retries = 0; /* used for logging too */
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200118 si->exp = TICK_ETERNITY;
Willy Tarreaua5f5d8d2014-11-28 11:26:07 +0100119 si->flags &= SI_FL_ISBACK;
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200120 si->end = NULL;
121 si->state = si->prev_state = SI_ST_INI;
Willy Tarreau7365dad2015-04-20 01:03:17 +0200122 si->ops = &si_embedded_ops;
Olivier Houchardfa8aa862018-10-10 18:25:41 +0200123 si->wait_event.task = tasklet_new();
124 if (!si->wait_event.task)
Olivier Houchard8f0b4c62018-08-02 18:21:38 +0200125 return -1;
Olivier Houchardfa8aa862018-10-10 18:25:41 +0200126 si->wait_event.task->process = si_cs_io_cb;
127 si->wait_event.task->context = si;
Willy Tarreau4f6516d2018-12-19 13:59:17 +0100128 si->wait_event.events = 0;
Olivier Houchard8f0b4c62018-08-02 18:21:38 +0200129 return 0;
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200130}
131
132/* sets the current and previous state of a stream interface to <state>. This
133 * is mainly used to create one in the established state on incoming
134 * conncetions.
135 */
136static inline void si_set_state(struct stream_interface *si, int state)
137{
138 si->state = si->prev_state = state;
139}
140
Willy Tarreau41b09f42015-08-04 20:44:05 +0200141/* only detaches the endpoint from the SI, which means that it's set to
142 * NULL and that ->ops is mapped to si_embedded_ops. The previous endpoint
143 * is returned.
144 */
145static inline enum obj_type *si_detach_endpoint(struct stream_interface *si)
146{
147 enum obj_type *prev = si->end;
148
149 si->end = NULL;
150 si->ops = &si_embedded_ops;
151 return prev;
152}
153
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100154/* Release the endpoint if it's a connection or an applet, then nullify it.
155 * Note: released connections are closed then freed.
156 */
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200157static inline void si_release_endpoint(struct stream_interface *si)
Willy Tarreau372d6702013-09-29 17:19:56 +0200158{
Olivier Houchardee23b2a2018-11-23 17:07:04 +0100159 struct connection *conn;
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200160 struct conn_stream *cs;
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100161 struct appctx *appctx;
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200162
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100163 if (!si->end)
164 return;
165
Olivier Houchard4fdec7a2018-10-11 17:09:14 +0200166 if ((cs = objt_cs(si->end))) {
Willy Tarreau4f6516d2018-12-19 13:59:17 +0100167 if (si->wait_event.events != 0)
168 cs->conn->mux->unsubscribe(cs, si->wait_event.events,
Olivier Houchard4fdec7a2018-10-11 17:09:14 +0200169 &si->wait_event);
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200170 cs_destroy(cs);
Olivier Houchard4fdec7a2018-10-11 17:09:14 +0200171 }
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100172 else if ((appctx = objt_appctx(si->end))) {
Willy Tarreau958f0742015-09-25 20:24:26 +0200173 if (appctx->applet->release && si->state < SI_ST_DIS)
Willy Tarreau00a37f02015-04-13 12:05:19 +0200174 appctx->applet->release(appctx);
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100175 appctx_free(appctx); /* we share the connection pool */
Olivier Houchard8ab8a6e2018-12-19 23:21:46 +0100176 } else if ((conn = objt_conn(si->end))) {
177 conn_stop_tracking(conn);
178 conn_full_close(conn);
Olivier Houchardee23b2a2018-11-23 17:07:04 +0100179 conn_free(conn);
Olivier Houchard8ab8a6e2018-12-19 23:21:46 +0100180 }
Willy Tarreau41b09f42015-08-04 20:44:05 +0200181 si_detach_endpoint(si);
Willy Tarreau372d6702013-09-29 17:19:56 +0200182}
183
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200184/* Attach conn_stream <cs> to the stream interface <si>. The stream interface
Willy Tarreau2a6e8802013-10-24 15:50:53 +0200185 * is configured to work with a connection and the connection it configured
186 * with a stream interface data layer.
Willy Tarreaub363a1f2013-10-01 10:45:07 +0200187 */
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200188static inline void si_attach_cs(struct stream_interface *si, struct conn_stream *cs)
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200189{
190 si->ops = &si_conn_ops;
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200191 si->end = &cs->obj_type;
192 cs_attach(cs, si, &si_conn_cb);
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200193}
194
Willy Tarreaud02cdd22013-12-15 10:23:20 +0100195/* Returns true if a connection is attached to the stream interface <si> and
196 * if this connection is ready.
197 */
198static inline int si_conn_ready(struct stream_interface *si)
199{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200200 struct connection *conn = cs_conn(objt_cs(si->end));
Willy Tarreaud02cdd22013-12-15 10:23:20 +0100201
202 return conn && conn_ctrl_ready(conn) && conn_xprt_ready(conn);
203}
204
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100205/* Attach appctx <appctx> to the stream interface <si>. The stream interface
Willy Tarreaua7513f52015-04-05 00:15:26 +0200206 * is configured to work with an applet context.
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100207 */
208static inline void si_attach_appctx(struct stream_interface *si, struct appctx *appctx)
Willy Tarreauc5788912012-08-24 18:12:41 +0200209{
Willy Tarreaud45b9f82015-04-13 16:30:14 +0200210 si->ops = &si_applet_ops;
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100211 si->end = &appctx->obj_type;
Willy Tarreau19c81612015-04-13 11:48:16 +0200212 appctx->owner = si;
Willy Tarreauc5788912012-08-24 18:12:41 +0200213}
214
Willy Tarreau4ae49232018-09-20 11:08:47 +0200215/* returns a pointer to the appctx being run in the SI, which must be valid */
Willy Tarreau7b4b4992013-12-01 09:15:12 +0100216static inline struct appctx *si_appctx(struct stream_interface *si)
217{
Willy Tarreau4ae49232018-09-20 11:08:47 +0200218 return __objt_appctx(si->end);
Willy Tarreau7b4b4992013-12-01 09:15:12 +0100219}
220
Willy Tarreau4a59f2f2013-10-24 20:10:45 +0200221/* call the applet's release function if any. Needs to be called upon close() */
222static inline void si_applet_release(struct stream_interface *si)
223{
Willy Tarreau00a37f02015-04-13 12:05:19 +0200224 struct appctx *appctx;
Willy Tarreau4a59f2f2013-10-24 20:10:45 +0200225
Willy Tarreau4ae49232018-09-20 11:08:47 +0200226 appctx = objt_appctx(si->end);
Willy Tarreau958f0742015-09-25 20:24:26 +0200227 if (appctx && appctx->applet->release && si->state < SI_ST_DIS)
Willy Tarreau00a37f02015-04-13 12:05:19 +0200228 appctx->applet->release(appctx);
Willy Tarreau4a59f2f2013-10-24 20:10:45 +0200229}
230
Willy Tarreau78dcace2018-11-14 14:01:40 +0100231/* Returns non-zero if the stream interface's Rx path is blocked */
232static inline int si_rx_blocked(const struct stream_interface *si)
233{
234 return !!(si->flags & SI_FL_RXBLK_ANY);
235}
236
237/* Returns non-zero if the stream interface's endpoint is ready to receive */
238static inline int si_rx_endp_ready(const struct stream_interface *si)
239{
240 return !(si->flags & SI_FL_RX_WAIT_EP);
241}
242
Willy Tarreau8bb2ffb2018-11-14 17:54:13 +0100243/* The stream interface announces it is ready to try to deliver more data to the input buffer */
244static inline void si_rx_endp_more(struct stream_interface *si)
Willy Tarreau394970c2018-11-06 19:17:31 +0100245{
Willy Tarreau8bb2ffb2018-11-14 17:54:13 +0100246 si->flags &= ~SI_FL_RX_WAIT_EP;
247}
248
249/* The stream interface announces it doesn't have more data for the input buffer */
250static inline void si_rx_endp_done(struct stream_interface *si)
251{
Willy Tarreau05b9b642018-11-14 13:43:35 +0100252 si->flags |= SI_FL_RX_WAIT_EP;
Willy Tarreau394970c2018-11-06 19:17:31 +0100253}
254
Willy Tarreaub26a6f92018-11-14 17:10:36 +0100255/* Tell a stream interface the input channel is OK with it sending it some data */
256static inline void si_rx_chan_rdy(struct stream_interface *si)
257{
258 si->flags &= ~SI_FL_RXBLK_CHAN;
259}
260
261/* Tell a stream interface the input channel is not OK with it sending it some data */
262static inline void si_rx_chan_blk(struct stream_interface *si)
263{
264 si->flags |= SI_FL_RXBLK_CHAN;
265}
266
Willy Tarreaua3b62d32018-12-06 15:24:01 +0100267/* Tell a stream interface the other side is connected */
268static inline void si_rx_conn_rdy(struct stream_interface *si)
269{
270 si->flags &= ~SI_FL_RXBLK_CONN;
271}
272
273/* Tell a stream interface it must wait for the other side to connect */
274static inline void si_rx_conn_blk(struct stream_interface *si)
275{
276 si->flags |= SI_FL_RXBLK_CONN;
277}
278
Willy Tarreau8be7cd72018-11-14 15:12:08 +0100279/* The stream interface just got the input buffer it was waiting for */
280static inline void si_rx_buff_rdy(struct stream_interface *si)
281{
282 si->flags &= ~SI_FL_RXBLK_BUFF;
283}
284
285/* The stream interface failed to get an input buffer and is waiting for it.
286 * Since it indicates a willingness to deliver data to the buffer that will
287 * have to be retried, we automatically clear RXBLK_ENDP to be called again
288 * as soon as RXBLK_BUFF is cleared.
289 */
290static inline void si_rx_buff_blk(struct stream_interface *si)
291{
292 si->flags |= SI_FL_RXBLK_BUFF;
293}
294
Willy Tarreaudb398432018-11-15 11:08:52 +0100295/* Tell a stream interface some room was made in the input buffer */
296static inline void si_rx_room_rdy(struct stream_interface *si)
297{
298 si->flags &= ~SI_FL_RXBLK_ROOM;
299}
300
301/* The stream interface announces it failed to put data into the input buffer
302 * by lack of room. Since it indicates a willingness to deliver data to the
303 * buffer that will have to be retried, we automatically clear RXBLK_ENDP to
304 * be called again as soon as RXBLK_ROOM is cleared.
305 */
306static inline void si_rx_room_blk(struct stream_interface *si)
307{
308 si->flags |= SI_FL_RXBLK_ROOM;
309}
310
Willy Tarreauabb5d422018-11-14 16:58:52 +0100311/* The stream interface announces it will never put new data into the input
312 * buffer and that it's not waiting for its endpoint to deliver anything else.
313 * This function obviously doesn't have a _rdy equivalent.
314 */
315static inline void si_rx_shut_blk(struct stream_interface *si)
316{
317 si->flags |= SI_FL_RXBLK_SHUT;
318}
319
Willy Tarreau78dcace2018-11-14 14:01:40 +0100320/* Returns non-zero if the stream interface's Rx path is blocked */
321static inline int si_tx_blocked(const struct stream_interface *si)
322{
323 return !!(si->flags & SI_FL_WAIT_DATA);
324}
325
326/* Returns non-zero if the stream interface's endpoint is ready to transmit */
327static inline int si_tx_endp_ready(const struct stream_interface *si)
328{
329 return (si->flags & SI_FL_WANT_GET);
330}
331
Willy Tarreau0cd3bd62018-11-06 18:46:37 +0100332/* Report that a stream interface wants to get some data from the output buffer */
333static inline void si_want_get(struct stream_interface *si)
Willy Tarreaueb406dc2015-04-21 18:44:02 +0200334{
335 si->flags |= SI_FL_WANT_GET;
336}
337
Willy Tarreau0cd3bd62018-11-06 18:46:37 +0100338/* Report that a stream interface failed to get some data from the output buffer */
339static inline void si_cant_get(struct stream_interface *si)
Willy Tarreaueb406dc2015-04-21 18:44:02 +0200340{
341 si->flags |= SI_FL_WANT_GET | SI_FL_WAIT_DATA;
342}
343
Willy Tarreau0cd3bd62018-11-06 18:46:37 +0100344/* Report that a stream interface doesn't want to get data from the output buffer */
345static inline void si_stop_get(struct stream_interface *si)
Willy Tarreaueb406dc2015-04-21 18:44:02 +0200346{
347 si->flags &= ~SI_FL_WANT_GET;
348}
349
Willy Tarreau394970c2018-11-06 19:17:31 +0100350/* Report that a stream interface won't get any more data from the output buffer */
351static inline void si_done_get(struct stream_interface *si)
352{
353 si->flags &= ~(SI_FL_WANT_GET | SI_FL_WAIT_DATA);
354}
355
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200356/* Try to allocate a new conn_stream and assign it to the interface. If
Willy Tarreau973a5422015-08-05 21:47:23 +0200357 * an endpoint was previously allocated, it is released first. The newly
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200358 * allocated conn_stream is initialized, assigned to the stream interface,
Willy Tarreau973a5422015-08-05 21:47:23 +0200359 * and returned.
Willy Tarreau9471b8c2013-12-15 13:31:35 +0100360 */
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200361static inline struct conn_stream *si_alloc_cs(struct stream_interface *si, struct connection *conn)
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200362{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200363 struct conn_stream *cs;
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200364
Willy Tarreau973a5422015-08-05 21:47:23 +0200365 si_release_endpoint(si);
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200366
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200367 cs = cs_new(conn);
368 if (cs)
369 si_attach_cs(si, cs);
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200370
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200371 return cs;
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200372}
373
Willy Tarreau09799162018-10-25 10:16:07 +0200374/* Try to allocate a buffer for the stream-int's input channel. It relies on
Willy Tarreauabf531c2018-11-07 18:53:29 +0100375 * channel_alloc_buffer() for this so it abides by its rules. It returns 0 on
376 * failure, non-zero otherwise. If no buffer is available, the requester,
Willy Tarreau8be7cd72018-11-14 15:12:08 +0100377 * represented by the <wait> pointer, will be added in the list of objects
378 * waiting for an available buffer, and SI_FL_RXBLK_BUFF will be set on the
379 * stream-int and SI_FL_RX_WAIT_EP cleared. The requester will be responsible
380 * for calling this function to try again once woken up.
Willy Tarreau09799162018-10-25 10:16:07 +0200381 */
382static inline int si_alloc_ibuf(struct stream_interface *si, struct buffer_wait *wait)
383{
384 int ret;
385
Willy Tarreau09799162018-10-25 10:16:07 +0200386 ret = channel_alloc_buffer(si_ic(si), wait);
387 if (!ret)
Willy Tarreau8be7cd72018-11-14 15:12:08 +0100388 si_rx_buff_blk(si);
Willy Tarreau09799162018-10-25 10:16:07 +0200389 return ret;
390}
391
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100392/* Release the interface's existing endpoint (connection or appctx) and
393 * allocate then initialize a new appctx which is assigned to the interface
Willy Tarreaua7513f52015-04-05 00:15:26 +0200394 * and returned. NULL may be returned upon memory shortage. Applet <applet>
395 * is assigned to the appctx, but it may be NULL.
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100396 */
Willy Tarreau30576452015-04-13 13:50:30 +0200397static inline struct appctx *si_alloc_appctx(struct stream_interface *si, struct applet *applet)
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100398{
399 struct appctx *appctx;
400
401 si_release_endpoint(si);
Emeric Brun1138fd02017-06-19 12:38:55 +0200402 appctx = appctx_new(applet, tid_bit);
Willy Tarreau10d81b82018-05-31 14:44:25 +0200403 if (appctx) {
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100404 si_attach_appctx(si, appctx);
Willy Tarreau10d81b82018-05-31 14:44:25 +0200405 appctx->t->nice = si_strm(si)->task->nice;
406 }
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100407
408 return appctx;
409}
410
Willy Tarreau73b013b2012-05-21 16:31:45 +0200411/* Sends a shutr to the connection using the data layer */
412static inline void si_shutr(struct stream_interface *si)
413{
Willy Tarreau6fe15412013-09-29 15:16:03 +0200414 si->ops->shutr(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200415}
416
417/* Sends a shutw to the connection using the data layer */
418static inline void si_shutw(struct stream_interface *si)
419{
Willy Tarreau6fe15412013-09-29 15:16:03 +0200420 si->ops->shutw(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200421}
422
Willy Tarreau96aadd52018-11-07 11:55:54 +0100423/* This is to be used after making some room available in a channel. It will
Willy Tarreau32742fd2018-11-14 14:07:59 +0100424 * return without doing anything if the stream interface's RX path is blocked.
425 * It will automatically mark the stream interface as busy processing the end
426 * point in order to avoid useless repeated wakeups.
Willy Tarreau8fe516f2018-11-09 16:21:43 +0100427 * It will then call ->chk_rcv() to enable receipt of new data.
Willy Tarreau96aadd52018-11-07 11:55:54 +0100428 */
Willy Tarreau73b013b2012-05-21 16:31:45 +0200429static inline void si_chk_rcv(struct stream_interface *si)
430{
Willy Tarreaua3b62d32018-12-06 15:24:01 +0100431 if (si->flags & SI_FL_RXBLK_CONN && (si_opposite(si)->state >= SI_ST_EST))
432 si_rx_conn_rdy(si);
433
Willy Tarreau32742fd2018-11-14 14:07:59 +0100434 if (si_rx_blocked(si) || !si_rx_endp_ready(si))
Willy Tarreau96aadd52018-11-07 11:55:54 +0100435 return;
436
Willy Tarreauadc7f3e2018-12-06 15:25:58 +0100437 if (si->state != SI_ST_EST)
Willy Tarreau1bdb5982018-11-07 14:59:45 +0100438 return;
439
Willy Tarreau05b9b642018-11-14 13:43:35 +0100440 si->flags |= SI_FL_RX_WAIT_EP;
Willy Tarreau57f08bb2018-11-07 11:28:12 +0100441 si->ops->chk_rcv(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200442}
443
Willy Tarreauade64782018-11-17 19:51:07 +0100444/* This tries to perform a synchronous receive on the stream interface to
445 * try to collect last arrived data. In practice it's only implemented on
446 * conn_streams. Returns 0 if nothing was done, non-zero if new data or a
447 * shutdown were collected. This may result on some delayed receive calls
448 * to be programmed and performed later, though it doesn't provide any
449 * such guarantee.
450 */
451static inline int si_sync_recv(struct stream_interface *si)
452{
453 struct conn_stream *cs;
454
455 if (si->state != SI_ST_EST)
456 return 0;
457
458 cs = objt_cs(si->end);
459 if (!cs)
460 return 0; // only conn_streams are supported
461
Willy Tarreau4f6516d2018-12-19 13:59:17 +0100462 if (si->wait_event.events & SUB_RETRY_RECV)
Willy Tarreauade64782018-11-17 19:51:07 +0100463 return 0; // already subscribed
464
Willy Tarreau7f494d02018-11-16 14:26:11 +0100465 if (!si_rx_endp_ready(si) || si_rx_blocked(si))
Willy Tarreauade64782018-11-17 19:51:07 +0100466 return 0; // already failed
467
468 return si_cs_recv(cs);
469}
470
Willy Tarreau73b013b2012-05-21 16:31:45 +0200471/* Calls chk_snd on the connection using the data layer */
472static inline void si_chk_snd(struct stream_interface *si)
473{
Willy Tarreau57f08bb2018-11-07 11:28:12 +0100474 si->ops->chk_snd(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200475}
476
477/* Calls chk_snd on the connection using the ctrl layer */
Olivier Houchard201b9f42018-11-21 00:16:29 +0100478static inline int si_connect(struct stream_interface *si, struct connection *conn)
Willy Tarreau73b013b2012-05-21 16:31:45 +0200479{
Willy Tarreaue7dff022015-04-03 01:14:29 +0200480 int ret = SF_ERR_NONE;
Willy Tarreau14f8e862012-08-30 22:23:13 +0200481
Willy Tarreaub363a1f2013-10-01 10:45:07 +0200482 if (unlikely(!conn || !conn->ctrl || !conn->ctrl->connect))
Willy Tarreaue7dff022015-04-03 01:14:29 +0200483 return SF_ERR_INTERNAL;
Willy Tarreau14f8e862012-08-30 22:23:13 +0200484
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100485 if (!conn_ctrl_ready(conn) || !conn_xprt_ready(conn)) {
Willy Tarreau2bb4a962014-11-28 11:11:05 +0100486 ret = conn->ctrl->connect(conn, !channel_is_empty(si_oc(si)), 0);
Willy Tarreaue7dff022015-04-03 01:14:29 +0200487 if (ret != SF_ERR_NONE)
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100488 return ret;
Willy Tarreau9e5a3aa2013-12-31 23:32:12 +0100489
Willy Tarreau9e5a3aa2013-12-31 23:32:12 +0100490 /* we're in the process of establishing a connection */
491 si->state = SI_ST_CON;
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100492 }
Christopher Fauletc34d19f2015-12-23 09:33:35 +0100493 else {
494 /* reuse the existing connection */
Willy Tarreau9e5a3aa2013-12-31 23:32:12 +0100495
496 /* the connection is established */
497 si->state = SI_ST_EST;
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100498 }
Willy Tarreau14f8e862012-08-30 22:23:13 +0200499
500 /* needs src ip/port for logging */
501 if (si->flags & SI_FL_SRC_ADDR)
Willy Tarreaub363a1f2013-10-01 10:45:07 +0200502 conn_get_from_addr(conn);
Willy Tarreau14f8e862012-08-30 22:23:13 +0200503
Willy Tarreau14f8e862012-08-30 22:23:13 +0200504 return ret;
Willy Tarreau73b013b2012-05-21 16:31:45 +0200505}
Willy Tarreau59b94792012-05-11 16:16:40 +0200506
Christopher Faulet3bc1b112018-11-29 11:29:26 +0100507/* Returns info about the conn_stream <cs>, if not NULL. It call the mux layer's
508 * get_cs_info() function, if it exists. On success, it returns a cs_info
509 * structure. Otherwise, on error, if the mux does not implement get_cs_info()
510 * or if conn_stream is NULL, NULL is returned.
511 */
512static inline const struct cs_info *si_get_cs_info(struct conn_stream *cs)
513{
514 if (cs && cs->conn->mux->get_cs_info)
515 return cs->conn->mux->get_cs_info(cs);
516 return NULL;
517}
518
Willy Tarreau55e4ecd2012-12-08 17:48:47 +0100519/* for debugging, reports the stream interface state name */
520static inline const char *si_state_str(int state)
521{
522 switch (state) {
523 case SI_ST_INI: return "INI";
524 case SI_ST_REQ: return "REQ";
525 case SI_ST_QUE: return "QUE";
526 case SI_ST_TAR: return "TAR";
527 case SI_ST_ASS: return "ASS";
528 case SI_ST_CON: return "CON";
529 case SI_ST_CER: return "CER";
530 case SI_ST_EST: return "EST";
531 case SI_ST_DIS: return "DIS";
532 case SI_ST_CLO: return "CLO";
533 default: return "???";
534 }
535}
536
Willy Tarreaucff64112008-11-03 06:26:53 +0100537#endif /* _PROTO_STREAM_INTERFACE_H */
538
539/*
540 * Local variables:
541 * c-indent-level: 8
542 * c-basic-offset: 8
543 * End:
544 */