blob: 490ee5ebfcd85d826dc68f8dcfb28d2fc8f33536 [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 Tarreau87b09662015-04-03 00:22:06 +020028#include <types/stream.h>
Willy Tarreaucff64112008-11-03 06:26:53 +010029#include <types/stream_interface.h>
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020030#include <proto/applet.h>
Willy Tarreau14f8e862012-08-30 22:23:13 +020031#include <proto/channel.h>
Willy Tarreauf9dabec2012-08-17 17:33:53 +020032#include <proto/connection.h>
Willy Tarreaucff64112008-11-03 06:26:53 +010033
34
Willy Tarreauc5788912012-08-24 18:12:41 +020035extern struct si_ops si_embedded_ops;
Willy Tarreauc5788912012-08-24 18:12:41 +020036extern struct si_ops si_conn_ops;
Willy Tarreaud45b9f82015-04-13 16:30:14 +020037extern struct si_ops si_applet_ops;
Willy Tarreau74beec32012-10-03 00:41:04 +020038extern struct data_cb si_conn_cb;
Willy Tarreau5c979a92012-05-07 17:15:39 +020039
Willy Tarreau14bfe9a2018-12-19 15:19:27 +010040/* main event functions used to move data between sockets and buffers */
41int si_check_timeouts(struct stream_interface *si);
42void si_report_error(struct stream_interface *si);
43void si_retnclose(struct stream_interface *si, const struct buffer *msg);
44int conn_si_send_proxy(struct connection *conn, unsigned int flag);
45struct appctx *si_register_handler(struct stream_interface *si, struct applet *app);
Willy Tarreauaa977ba2015-09-25 11:45:06 +020046void si_applet_wake_cb(struct stream_interface *si);
Willy Tarreau236c4292019-06-06 08:19:20 +020047void si_update_rx(struct stream_interface *si);
48void si_update_tx(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 Tarreau3b285d72019-06-06 08:20:17 +020052void si_sync_send(struct stream_interface *si);
Willy Tarreaufb90d942009-09-05 20:57:35 +020053
Willy Tarreau2bb4a962014-11-28 11:11:05 +010054/* returns the channel which receives data from this stream interface (input channel) */
55static inline struct channel *si_ic(struct stream_interface *si)
56{
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010057 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020058 return &LIST_ELEM(si, struct stream *, si[1])->res;
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010059 else
Willy Tarreau87b09662015-04-03 00:22:06 +020060 return &LIST_ELEM(si, struct stream *, si[0])->req;
Willy Tarreau2bb4a962014-11-28 11:11:05 +010061}
62
63/* returns the channel which feeds data to this stream interface (output channel) */
64static inline struct channel *si_oc(struct stream_interface *si)
65{
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010066 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020067 return &LIST_ELEM(si, struct stream *, si[1])->req;
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010068 else
Willy Tarreau87b09662015-04-03 00:22:06 +020069 return &LIST_ELEM(si, struct stream *, si[0])->res;
Willy Tarreau2bb4a962014-11-28 11:11:05 +010070}
71
Willy Tarreau4e4292b2014-11-28 12:18:45 +010072/* returns the buffer which receives data from this stream interface (input channel's buffer) */
73static inline struct buffer *si_ib(struct stream_interface *si)
74{
Willy Tarreauc9fa0482018-07-10 17:43:27 +020075 return &si_ic(si)->buf;
Willy Tarreau4e4292b2014-11-28 12:18:45 +010076}
77
78/* returns the buffer which feeds data to this stream interface (output channel's buffer) */
79static inline struct buffer *si_ob(struct stream_interface *si)
80{
Willy Tarreauc9fa0482018-07-10 17:43:27 +020081 return &si_oc(si)->buf;
Willy Tarreau4e4292b2014-11-28 12:18:45 +010082}
83
Willy Tarreau87b09662015-04-03 00:22:06 +020084/* returns the stream associated to a stream interface */
85static inline struct stream *si_strm(struct stream_interface *si)
Willy Tarreauaefd7902014-11-28 12:03:32 +010086{
87 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020088 return LIST_ELEM(si, struct stream *, si[1]);
Willy Tarreauaefd7902014-11-28 12:03:32 +010089 else
Willy Tarreau87b09662015-04-03 00:22:06 +020090 return LIST_ELEM(si, struct stream *, si[0]);
Willy Tarreauaefd7902014-11-28 12:03:32 +010091}
92
Willy Tarreau07373b82014-11-28 12:08:47 +010093/* returns the task associated to this stream interface */
94static inline struct task *si_task(struct stream_interface *si)
95{
96 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020097 return LIST_ELEM(si, struct stream *, si[1])->task;
Willy Tarreau07373b82014-11-28 12:08:47 +010098 else
Willy Tarreau87b09662015-04-03 00:22:06 +020099 return LIST_ELEM(si, struct stream *, si[0])->task;
Willy Tarreau07373b82014-11-28 12:08:47 +0100100}
101
Willy Tarreau50fe03b2014-11-28 13:59:31 +0100102/* returns the stream interface on the other side. Used during forwarding. */
103static inline struct stream_interface *si_opposite(struct stream_interface *si)
104{
105 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +0200106 return &LIST_ELEM(si, struct stream *, si[1])->si[0];
Willy Tarreau50fe03b2014-11-28 13:59:31 +0100107 else
Willy Tarreau87b09662015-04-03 00:22:06 +0200108 return &LIST_ELEM(si, struct stream *, si[0])->si[1];
Willy Tarreau50fe03b2014-11-28 13:59:31 +0100109}
110
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200111/* initializes a stream interface in the SI_ST_INI state. It's detached from
Willy Tarreau819d3322014-11-28 12:12:34 +0100112 * any endpoint and only keeps its side which is expected to have already been
113 * set.
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200114 */
Olivier Houchard8f0b4c62018-08-02 18:21:38 +0200115static inline int si_reset(struct stream_interface *si)
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200116{
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200117 si->err_type = SI_ET_NONE;
118 si->conn_retries = 0; /* used for logging too */
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200119 si->exp = TICK_ETERNITY;
Willy Tarreaua5f5d8d2014-11-28 11:26:07 +0100120 si->flags &= SI_FL_ISBACK;
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200121 si->end = NULL;
122 si->state = si->prev_state = SI_ST_INI;
Willy Tarreau7365dad2015-04-20 01:03:17 +0200123 si->ops = &si_embedded_ops;
Willy Tarreau3c39a7d2019-06-14 14:42:29 +0200124 si->wait_event.tasklet = tasklet_new();
125 if (!si->wait_event.tasklet)
Olivier Houchard8f0b4c62018-08-02 18:21:38 +0200126 return -1;
Willy Tarreau3c39a7d2019-06-14 14:42:29 +0200127 si->wait_event.tasklet->process = si_cs_io_cb;
128 si->wait_event.tasklet->context = si;
Willy Tarreau4f6516d2018-12-19 13:59:17 +0100129 si->wait_event.events = 0;
Olivier Houchard8f0b4c62018-08-02 18:21:38 +0200130 return 0;
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200131}
132
133/* sets the current and previous state of a stream interface to <state>. This
134 * is mainly used to create one in the established state on incoming
135 * conncetions.
136 */
137static inline void si_set_state(struct stream_interface *si, int state)
138{
139 si->state = si->prev_state = state;
140}
141
Willy Tarreaubedcd692019-06-05 14:45:06 +0200142/* returns a bit for a stream-int state, to match against SI_SB_* */
143static inline enum si_state_bit si_state_bit(enum si_state state)
144{
Willy Tarreauad660e32019-06-06 16:38:40 +0200145 BUG_ON(state > SI_ST_CLO);
Willy Tarreaubedcd692019-06-05 14:45:06 +0200146 return 1U << state;
147}
148
149/* returns true if <state> matches one of the SI_SB_* bits in <mask> */
150static inline int si_state_in(enum si_state state, enum si_state_bit mask)
151{
152 BUG_ON(mask & ~SI_SB_ALL);
153 return !!(si_state_bit(state) & mask);
154}
155
Willy Tarreau41b09f42015-08-04 20:44:05 +0200156/* only detaches the endpoint from the SI, which means that it's set to
157 * NULL and that ->ops is mapped to si_embedded_ops. The previous endpoint
158 * is returned.
159 */
160static inline enum obj_type *si_detach_endpoint(struct stream_interface *si)
161{
162 enum obj_type *prev = si->end;
163
164 si->end = NULL;
165 si->ops = &si_embedded_ops;
166 return prev;
167}
168
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100169/* Release the endpoint if it's a connection or an applet, then nullify it.
170 * Note: released connections are closed then freed.
171 */
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200172static inline void si_release_endpoint(struct stream_interface *si)
Willy Tarreau372d6702013-09-29 17:19:56 +0200173{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200174 struct conn_stream *cs;
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100175 struct appctx *appctx;
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200176
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100177 if (!si->end)
178 return;
179
Olivier Houchard4fdec7a2018-10-11 17:09:14 +0200180 if ((cs = objt_cs(si->end))) {
Willy Tarreau4f6516d2018-12-19 13:59:17 +0100181 if (si->wait_event.events != 0)
182 cs->conn->mux->unsubscribe(cs, si->wait_event.events,
Olivier Houchard4fdec7a2018-10-11 17:09:14 +0200183 &si->wait_event);
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200184 cs_destroy(cs);
Olivier Houchard4fdec7a2018-10-11 17:09:14 +0200185 }
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100186 else if ((appctx = objt_appctx(si->end))) {
Willy Tarreau7ab22adb2019-06-05 14:53:22 +0200187 if (appctx->applet->release && !si_state_in(si->state, SI_SB_DIS|SI_SB_CLO))
Willy Tarreau00a37f02015-04-13 12:05:19 +0200188 appctx->applet->release(appctx);
Willy Tarreau8280ea92019-07-18 10:41:36 +0200189 appctx_free(appctx);
Olivier Houchard8ab8a6e2018-12-19 23:21:46 +0100190 }
Willy Tarreau41b09f42015-08-04 20:44:05 +0200191 si_detach_endpoint(si);
Willy Tarreau372d6702013-09-29 17:19:56 +0200192}
193
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200194/* Attach conn_stream <cs> to the stream interface <si>. The stream interface
Willy Tarreau2a6e8802013-10-24 15:50:53 +0200195 * is configured to work with a connection and the connection it configured
196 * with a stream interface data layer.
Willy Tarreaub363a1f2013-10-01 10:45:07 +0200197 */
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200198static inline void si_attach_cs(struct stream_interface *si, struct conn_stream *cs)
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200199{
200 si->ops = &si_conn_ops;
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200201 si->end = &cs->obj_type;
202 cs_attach(cs, si, &si_conn_cb);
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200203}
204
Willy Tarreaud02cdd22013-12-15 10:23:20 +0100205/* Returns true if a connection is attached to the stream interface <si> and
206 * if this connection is ready.
207 */
208static inline int si_conn_ready(struct stream_interface *si)
209{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200210 struct connection *conn = cs_conn(objt_cs(si->end));
Willy Tarreaud02cdd22013-12-15 10:23:20 +0100211
212 return conn && conn_ctrl_ready(conn) && conn_xprt_ready(conn);
213}
214
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100215/* Attach appctx <appctx> to the stream interface <si>. The stream interface
Willy Tarreaua7513f52015-04-05 00:15:26 +0200216 * is configured to work with an applet context.
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100217 */
218static inline void si_attach_appctx(struct stream_interface *si, struct appctx *appctx)
Willy Tarreauc5788912012-08-24 18:12:41 +0200219{
Willy Tarreaud45b9f82015-04-13 16:30:14 +0200220 si->ops = &si_applet_ops;
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100221 si->end = &appctx->obj_type;
Willy Tarreau19c81612015-04-13 11:48:16 +0200222 appctx->owner = si;
Willy Tarreauc5788912012-08-24 18:12:41 +0200223}
224
Willy Tarreau4ae49232018-09-20 11:08:47 +0200225/* returns a pointer to the appctx being run in the SI, which must be valid */
Willy Tarreau7b4b4992013-12-01 09:15:12 +0100226static inline struct appctx *si_appctx(struct stream_interface *si)
227{
Willy Tarreau4ae49232018-09-20 11:08:47 +0200228 return __objt_appctx(si->end);
Willy Tarreau7b4b4992013-12-01 09:15:12 +0100229}
230
Willy Tarreau4a59f2f2013-10-24 20:10:45 +0200231/* call the applet's release function if any. Needs to be called upon close() */
232static inline void si_applet_release(struct stream_interface *si)
233{
Willy Tarreau00a37f02015-04-13 12:05:19 +0200234 struct appctx *appctx;
Willy Tarreau4a59f2f2013-10-24 20:10:45 +0200235
Willy Tarreau4ae49232018-09-20 11:08:47 +0200236 appctx = objt_appctx(si->end);
Willy Tarreau7ab22adb2019-06-05 14:53:22 +0200237 if (appctx && appctx->applet->release && !si_state_in(si->state, SI_SB_DIS|SI_SB_CLO))
Willy Tarreau00a37f02015-04-13 12:05:19 +0200238 appctx->applet->release(appctx);
Willy Tarreau4a59f2f2013-10-24 20:10:45 +0200239}
240
Willy Tarreau78dcace2018-11-14 14:01:40 +0100241/* Returns non-zero if the stream interface's Rx path is blocked */
242static inline int si_rx_blocked(const struct stream_interface *si)
243{
244 return !!(si->flags & SI_FL_RXBLK_ANY);
245}
246
247/* Returns non-zero if the stream interface's endpoint is ready to receive */
248static inline int si_rx_endp_ready(const struct stream_interface *si)
249{
250 return !(si->flags & SI_FL_RX_WAIT_EP);
251}
252
Willy Tarreau8bb2ffb2018-11-14 17:54:13 +0100253/* The stream interface announces it is ready to try to deliver more data to the input buffer */
254static inline void si_rx_endp_more(struct stream_interface *si)
Willy Tarreau394970c2018-11-06 19:17:31 +0100255{
Willy Tarreau8bb2ffb2018-11-14 17:54:13 +0100256 si->flags &= ~SI_FL_RX_WAIT_EP;
257}
258
259/* The stream interface announces it doesn't have more data for the input buffer */
260static inline void si_rx_endp_done(struct stream_interface *si)
261{
Willy Tarreau05b9b642018-11-14 13:43:35 +0100262 si->flags |= SI_FL_RX_WAIT_EP;
Willy Tarreau394970c2018-11-06 19:17:31 +0100263}
264
Willy Tarreaub26a6f92018-11-14 17:10:36 +0100265/* Tell a stream interface the input channel is OK with it sending it some data */
266static inline void si_rx_chan_rdy(struct stream_interface *si)
267{
268 si->flags &= ~SI_FL_RXBLK_CHAN;
269}
270
271/* Tell a stream interface the input channel is not OK with it sending it some data */
272static inline void si_rx_chan_blk(struct stream_interface *si)
273{
274 si->flags |= SI_FL_RXBLK_CHAN;
275}
276
Willy Tarreaua3b62d32018-12-06 15:24:01 +0100277/* Tell a stream interface the other side is connected */
278static inline void si_rx_conn_rdy(struct stream_interface *si)
279{
280 si->flags &= ~SI_FL_RXBLK_CONN;
281}
282
283/* Tell a stream interface it must wait for the other side to connect */
284static inline void si_rx_conn_blk(struct stream_interface *si)
285{
286 si->flags |= SI_FL_RXBLK_CONN;
287}
288
Willy Tarreau8be7cd72018-11-14 15:12:08 +0100289/* The stream interface just got the input buffer it was waiting for */
290static inline void si_rx_buff_rdy(struct stream_interface *si)
291{
292 si->flags &= ~SI_FL_RXBLK_BUFF;
293}
294
295/* The stream interface failed to get an input buffer and is waiting for it.
296 * Since it indicates a willingness to deliver data to the buffer that will
297 * have to be retried, we automatically clear RXBLK_ENDP to be called again
298 * as soon as RXBLK_BUFF is cleared.
299 */
300static inline void si_rx_buff_blk(struct stream_interface *si)
301{
302 si->flags |= SI_FL_RXBLK_BUFF;
303}
304
Willy Tarreaudb398432018-11-15 11:08:52 +0100305/* Tell a stream interface some room was made in the input buffer */
306static inline void si_rx_room_rdy(struct stream_interface *si)
307{
308 si->flags &= ~SI_FL_RXBLK_ROOM;
309}
310
311/* The stream interface announces it failed to put data into the input buffer
312 * by lack of room. Since it indicates a willingness to deliver data to the
313 * buffer that will have to be retried, we automatically clear RXBLK_ENDP to
314 * be called again as soon as RXBLK_ROOM is cleared.
315 */
316static inline void si_rx_room_blk(struct stream_interface *si)
317{
318 si->flags |= SI_FL_RXBLK_ROOM;
319}
320
Willy Tarreauabb5d422018-11-14 16:58:52 +0100321/* The stream interface announces it will never put new data into the input
322 * buffer and that it's not waiting for its endpoint to deliver anything else.
323 * This function obviously doesn't have a _rdy equivalent.
324 */
325static inline void si_rx_shut_blk(struct stream_interface *si)
326{
327 si->flags |= SI_FL_RXBLK_SHUT;
328}
329
Willy Tarreau78dcace2018-11-14 14:01:40 +0100330/* Returns non-zero if the stream interface's Rx path is blocked */
331static inline int si_tx_blocked(const struct stream_interface *si)
332{
333 return !!(si->flags & SI_FL_WAIT_DATA);
334}
335
336/* Returns non-zero if the stream interface's endpoint is ready to transmit */
337static inline int si_tx_endp_ready(const struct stream_interface *si)
338{
339 return (si->flags & SI_FL_WANT_GET);
340}
341
Willy Tarreau0cd3bd62018-11-06 18:46:37 +0100342/* Report that a stream interface wants to get some data from the output buffer */
343static inline void si_want_get(struct stream_interface *si)
Willy Tarreaueb406dc2015-04-21 18:44:02 +0200344{
345 si->flags |= SI_FL_WANT_GET;
346}
347
Willy Tarreau0cd3bd62018-11-06 18:46:37 +0100348/* Report that a stream interface failed to get some data from the output buffer */
349static inline void si_cant_get(struct stream_interface *si)
Willy Tarreaueb406dc2015-04-21 18:44:02 +0200350{
351 si->flags |= SI_FL_WANT_GET | SI_FL_WAIT_DATA;
352}
353
Willy Tarreau0cd3bd62018-11-06 18:46:37 +0100354/* Report that a stream interface doesn't want to get data from the output buffer */
355static inline void si_stop_get(struct stream_interface *si)
Willy Tarreaueb406dc2015-04-21 18:44:02 +0200356{
357 si->flags &= ~SI_FL_WANT_GET;
358}
359
Willy Tarreau394970c2018-11-06 19:17:31 +0100360/* Report that a stream interface won't get any more data from the output buffer */
361static inline void si_done_get(struct stream_interface *si)
362{
363 si->flags &= ~(SI_FL_WANT_GET | SI_FL_WAIT_DATA);
364}
365
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200366/* Try to allocate a new conn_stream and assign it to the interface. If
Willy Tarreau973a5422015-08-05 21:47:23 +0200367 * an endpoint was previously allocated, it is released first. The newly
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200368 * allocated conn_stream is initialized, assigned to the stream interface,
Willy Tarreau973a5422015-08-05 21:47:23 +0200369 * and returned.
Willy Tarreau9471b8c2013-12-15 13:31:35 +0100370 */
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200371static inline struct conn_stream *si_alloc_cs(struct stream_interface *si, struct connection *conn)
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200372{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200373 struct conn_stream *cs;
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200374
Willy Tarreau973a5422015-08-05 21:47:23 +0200375 si_release_endpoint(si);
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200376
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200377 cs = cs_new(conn);
378 if (cs)
379 si_attach_cs(si, cs);
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200380
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200381 return cs;
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200382}
383
Willy Tarreau09799162018-10-25 10:16:07 +0200384/* Try to allocate a buffer for the stream-int's input channel. It relies on
Willy Tarreauabf531c2018-11-07 18:53:29 +0100385 * channel_alloc_buffer() for this so it abides by its rules. It returns 0 on
386 * failure, non-zero otherwise. If no buffer is available, the requester,
Willy Tarreau8be7cd72018-11-14 15:12:08 +0100387 * represented by the <wait> pointer, will be added in the list of objects
388 * waiting for an available buffer, and SI_FL_RXBLK_BUFF will be set on the
389 * stream-int and SI_FL_RX_WAIT_EP cleared. The requester will be responsible
390 * for calling this function to try again once woken up.
Willy Tarreau09799162018-10-25 10:16:07 +0200391 */
392static inline int si_alloc_ibuf(struct stream_interface *si, struct buffer_wait *wait)
393{
394 int ret;
395
Willy Tarreau09799162018-10-25 10:16:07 +0200396 ret = channel_alloc_buffer(si_ic(si), wait);
397 if (!ret)
Willy Tarreau8be7cd72018-11-14 15:12:08 +0100398 si_rx_buff_blk(si);
Willy Tarreau09799162018-10-25 10:16:07 +0200399 return ret;
400}
401
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100402/* Release the interface's existing endpoint (connection or appctx) and
403 * allocate then initialize a new appctx which is assigned to the interface
Willy Tarreaua7513f52015-04-05 00:15:26 +0200404 * and returned. NULL may be returned upon memory shortage. Applet <applet>
405 * is assigned to the appctx, but it may be NULL.
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100406 */
Willy Tarreau30576452015-04-13 13:50:30 +0200407static inline struct appctx *si_alloc_appctx(struct stream_interface *si, struct applet *applet)
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100408{
409 struct appctx *appctx;
410
411 si_release_endpoint(si);
Emeric Brun1138fd02017-06-19 12:38:55 +0200412 appctx = appctx_new(applet, tid_bit);
Willy Tarreau10d81b82018-05-31 14:44:25 +0200413 if (appctx) {
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100414 si_attach_appctx(si, appctx);
Willy Tarreau10d81b82018-05-31 14:44:25 +0200415 appctx->t->nice = si_strm(si)->task->nice;
416 }
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100417
418 return appctx;
419}
420
Willy Tarreau73b013b2012-05-21 16:31:45 +0200421/* Sends a shutr to the connection using the data layer */
422static inline void si_shutr(struct stream_interface *si)
423{
Willy Tarreau6fe15412013-09-29 15:16:03 +0200424 si->ops->shutr(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200425}
426
427/* Sends a shutw to the connection using the data layer */
428static inline void si_shutw(struct stream_interface *si)
429{
Willy Tarreau6fe15412013-09-29 15:16:03 +0200430 si->ops->shutw(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200431}
432
Willy Tarreau0f9cd7b2019-01-31 19:02:43 +0100433/* Marks on the stream-interface that next shutw must kill the whole connection */
434static inline void si_must_kill_conn(struct stream_interface *si)
435{
436 si->flags |= SI_FL_KILL_CONN;
437}
438
Willy Tarreau96aadd52018-11-07 11:55:54 +0100439/* This is to be used after making some room available in a channel. It will
Willy Tarreau32742fd2018-11-14 14:07:59 +0100440 * return without doing anything if the stream interface's RX path is blocked.
441 * It will automatically mark the stream interface as busy processing the end
442 * point in order to avoid useless repeated wakeups.
Willy Tarreau8fe516f2018-11-09 16:21:43 +0100443 * It will then call ->chk_rcv() to enable receipt of new data.
Willy Tarreau96aadd52018-11-07 11:55:54 +0100444 */
Willy Tarreau73b013b2012-05-21 16:31:45 +0200445static inline void si_chk_rcv(struct stream_interface *si)
446{
Willy Tarreau4f283fa2019-06-05 14:34:03 +0200447 if (si->flags & SI_FL_RXBLK_CONN && si_state_in(si_opposite(si)->state, SI_SB_RDY|SI_SB_EST|SI_SB_DIS|SI_SB_CLO))
Willy Tarreaua3b62d32018-12-06 15:24:01 +0100448 si_rx_conn_rdy(si);
449
Willy Tarreau32742fd2018-11-14 14:07:59 +0100450 if (si_rx_blocked(si) || !si_rx_endp_ready(si))
Willy Tarreau96aadd52018-11-07 11:55:54 +0100451 return;
452
Willy Tarreau4f283fa2019-06-05 14:34:03 +0200453 if (!si_state_in(si->state, SI_SB_RDY|SI_SB_EST))
Willy Tarreau1bdb5982018-11-07 14:59:45 +0100454 return;
455
Willy Tarreau05b9b642018-11-14 13:43:35 +0100456 si->flags |= SI_FL_RX_WAIT_EP;
Willy Tarreau57f08bb2018-11-07 11:28:12 +0100457 si->ops->chk_rcv(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200458}
459
Willy Tarreauade64782018-11-17 19:51:07 +0100460/* This tries to perform a synchronous receive on the stream interface to
461 * try to collect last arrived data. In practice it's only implemented on
462 * conn_streams. Returns 0 if nothing was done, non-zero if new data or a
463 * shutdown were collected. This may result on some delayed receive calls
464 * to be programmed and performed later, though it doesn't provide any
465 * such guarantee.
466 */
467static inline int si_sync_recv(struct stream_interface *si)
468{
469 struct conn_stream *cs;
470
Willy Tarreau4f283fa2019-06-05 14:34:03 +0200471 if (!si_state_in(si->state, SI_SB_RDY|SI_SB_EST))
Willy Tarreauade64782018-11-17 19:51:07 +0100472 return 0;
473
474 cs = objt_cs(si->end);
Olivier Houchard8af03b32020-01-22 17:34:54 +0100475 if (!cs || !cs->conn->mux)
Willy Tarreauade64782018-11-17 19:51:07 +0100476 return 0; // only conn_streams are supported
477
Willy Tarreau4f6516d2018-12-19 13:59:17 +0100478 if (si->wait_event.events & SUB_RETRY_RECV)
Willy Tarreauade64782018-11-17 19:51:07 +0100479 return 0; // already subscribed
480
Willy Tarreau7f494d02018-11-16 14:26:11 +0100481 if (!si_rx_endp_ready(si) || si_rx_blocked(si))
Willy Tarreauade64782018-11-17 19:51:07 +0100482 return 0; // already failed
483
484 return si_cs_recv(cs);
485}
486
Willy Tarreau73b013b2012-05-21 16:31:45 +0200487/* Calls chk_snd on the connection using the data layer */
488static inline void si_chk_snd(struct stream_interface *si)
489{
Willy Tarreau57f08bb2018-11-07 11:28:12 +0100490 si->ops->chk_snd(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200491}
492
493/* Calls chk_snd on the connection using the ctrl layer */
Olivier Houchard201b9f42018-11-21 00:16:29 +0100494static inline int si_connect(struct stream_interface *si, struct connection *conn)
Willy Tarreau73b013b2012-05-21 16:31:45 +0200495{
Willy Tarreaue7dff022015-04-03 01:14:29 +0200496 int ret = SF_ERR_NONE;
Willy Tarreau034c88c2017-01-23 23:36:45 +0100497 int conn_flags = 0;
Willy Tarreau14f8e862012-08-30 22:23:13 +0200498
Willy Tarreaub363a1f2013-10-01 10:45:07 +0200499 if (unlikely(!conn || !conn->ctrl || !conn->ctrl->connect))
Willy Tarreaue7dff022015-04-03 01:14:29 +0200500 return SF_ERR_INTERNAL;
Willy Tarreau14f8e862012-08-30 22:23:13 +0200501
Willy Tarreau034c88c2017-01-23 23:36:45 +0100502 if (!channel_is_empty(si_oc(si)))
503 conn_flags |= CONNECT_HAS_DATA;
504 if (si->conn_retries == si_strm(si)->be->conn_retries)
505 conn_flags |= CONNECT_CAN_USE_TFO;
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100506 if (!conn_ctrl_ready(conn) || !conn_xprt_ready(conn)) {
Willy Tarreau034c88c2017-01-23 23:36:45 +0100507 ret = conn->ctrl->connect(conn, conn_flags);
Willy Tarreaue7dff022015-04-03 01:14:29 +0200508 if (ret != SF_ERR_NONE)
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100509 return ret;
Willy Tarreau9e5a3aa2013-12-31 23:32:12 +0100510
Willy Tarreau9e5a3aa2013-12-31 23:32:12 +0100511 /* we're in the process of establishing a connection */
512 si->state = SI_ST_CON;
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100513 }
Christopher Fauletc34d19f2015-12-23 09:33:35 +0100514 else {
Willy Tarreaubf66bd12019-01-23 15:15:09 +0100515 /* try to reuse the existing connection, it will be
516 * confirmed once we can send on it.
517 */
Olivier Houchard6e8e2ec2019-10-25 16:25:20 +0200518 /* Is the connection really ready ? */
519 if (conn->mux->ctl(conn, MUX_STATUS, NULL) & MUX_STATUS_READY)
520 si->state = SI_ST_RDY;
521 else
522 si->state = SI_ST_CON;
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100523 }
Willy Tarreau14f8e862012-08-30 22:23:13 +0200524
525 /* needs src ip/port for logging */
526 if (si->flags & SI_FL_SRC_ADDR)
Willy Tarreau3cc01d82019-07-17 11:27:38 +0200527 conn_get_src(conn);
Willy Tarreau14f8e862012-08-30 22:23:13 +0200528
Willy Tarreau14f8e862012-08-30 22:23:13 +0200529 return ret;
Willy Tarreau73b013b2012-05-21 16:31:45 +0200530}
Willy Tarreau59b94792012-05-11 16:16:40 +0200531
Willy Tarreau236c4292019-06-06 08:19:20 +0200532/* Combines both si_update_rx() and si_update_tx() at once */
533static inline void si_update(struct stream_interface *si)
534{
535 si_update_rx(si);
536 si_update_tx(si);
537}
538
Christopher Faulet3bc1b112018-11-29 11:29:26 +0100539/* Returns info about the conn_stream <cs>, if not NULL. It call the mux layer's
540 * get_cs_info() function, if it exists. On success, it returns a cs_info
541 * structure. Otherwise, on error, if the mux does not implement get_cs_info()
542 * or if conn_stream is NULL, NULL is returned.
543 */
544static inline const struct cs_info *si_get_cs_info(struct conn_stream *cs)
545{
546 if (cs && cs->conn->mux->get_cs_info)
547 return cs->conn->mux->get_cs_info(cs);
548 return NULL;
549}
550
Willy Tarreau55e4ecd2012-12-08 17:48:47 +0100551/* for debugging, reports the stream interface state name */
552static inline const char *si_state_str(int state)
553{
554 switch (state) {
555 case SI_ST_INI: return "INI";
556 case SI_ST_REQ: return "REQ";
557 case SI_ST_QUE: return "QUE";
558 case SI_ST_TAR: return "TAR";
559 case SI_ST_ASS: return "ASS";
560 case SI_ST_CON: return "CON";
561 case SI_ST_CER: return "CER";
Willy Tarreau4f283fa2019-06-05 14:34:03 +0200562 case SI_ST_RDY: return "RDY";
Willy Tarreau55e4ecd2012-12-08 17:48:47 +0100563 case SI_ST_EST: return "EST";
564 case SI_ST_DIS: return "DIS";
565 case SI_ST_CLO: return "CLO";
566 default: return "???";
567 }
568}
569
Willy Tarreaucff64112008-11-03 06:26:53 +0100570#endif /* _PROTO_STREAM_INTERFACE_H */
571
572/*
573 * Local variables:
574 * c-indent-level: 8
575 * c-basic-offset: 8
576 * End:
577 */