blob: 2874664f1d018d1e0b4e2fdd3641177caf4a63e3 [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
36/* main event functions used to move data between sockets and buffers */
Willy Tarreau269358d2009-09-20 20:14:49 +020037int stream_int_check_timeouts(struct stream_interface *si);
Willy Tarreaucff64112008-11-03 06:26:53 +010038void stream_int_report_error(struct stream_interface *si);
Willy Tarreau83061a82018-07-13 11:56:34 +020039void stream_int_retnclose(struct stream_interface *si,
40 const struct buffer *msg);
Willy Tarreau2c6be842012-07-06 17:12:34 +020041int conn_si_send_proxy(struct connection *conn, unsigned int flag);
Willy Tarreau9bf9c142012-08-20 15:38:41 +020042void stream_sock_read0(struct stream_interface *si);
Willy Tarreaucff64112008-11-03 06:26:53 +010043
Willy Tarreauc5788912012-08-24 18:12:41 +020044extern struct si_ops si_embedded_ops;
Willy Tarreauc5788912012-08-24 18:12:41 +020045extern struct si_ops si_conn_ops;
Willy Tarreaud45b9f82015-04-13 16:30:14 +020046extern struct si_ops si_applet_ops;
Willy Tarreau74beec32012-10-03 00:41:04 +020047extern struct data_cb si_conn_cb;
Willy Tarreau5c979a92012-05-07 17:15:39 +020048
Willy Tarreau30576452015-04-13 13:50:30 +020049struct appctx *stream_int_register_handler(struct stream_interface *si, struct applet *app);
Willy Tarreauaa977ba2015-09-25 11:45:06 +020050void si_applet_wake_cb(struct stream_interface *si);
Willy Tarreau25f13102015-09-24 11:32:22 +020051void stream_int_update(struct stream_interface *si);
Willy Tarreau615f28b2015-09-23 18:40:09 +020052void stream_int_notify(struct stream_interface *si);
Olivier Houchard0e367bb2018-09-14 19:41:13 +020053int si_cs_recv(struct conn_stream *cs);
54int si_cs_send(struct conn_stream *cs);
Olivier Houchard91894cb2018-08-02 18:06:28 +020055struct task *si_cs_io_cb(struct task *t, void *ctx, unsigned short state);
Willy Tarreaud14844a2018-11-08 18:15:29 +010056void si_update_both(struct stream_interface *si_f, struct stream_interface *si_b);
Willy Tarreaufb90d942009-09-05 20:57:35 +020057
Willy Tarreau2bb4a962014-11-28 11:11:05 +010058/* returns the channel which receives data from this stream interface (input channel) */
59static inline struct channel *si_ic(struct stream_interface *si)
60{
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010061 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020062 return &LIST_ELEM(si, struct stream *, si[1])->res;
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010063 else
Willy Tarreau87b09662015-04-03 00:22:06 +020064 return &LIST_ELEM(si, struct stream *, si[0])->req;
Willy Tarreau2bb4a962014-11-28 11:11:05 +010065}
66
67/* returns the channel which feeds data to this stream interface (output channel) */
68static inline struct channel *si_oc(struct stream_interface *si)
69{
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010070 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020071 return &LIST_ELEM(si, struct stream *, si[1])->req;
Willy Tarreau0b2fb7f2014-11-28 11:50:38 +010072 else
Willy Tarreau87b09662015-04-03 00:22:06 +020073 return &LIST_ELEM(si, struct stream *, si[0])->res;
Willy Tarreau2bb4a962014-11-28 11:11:05 +010074}
75
Willy Tarreau4e4292b2014-11-28 12:18:45 +010076/* returns the buffer which receives data from this stream interface (input channel's buffer) */
77static inline struct buffer *si_ib(struct stream_interface *si)
78{
Willy Tarreauc9fa0482018-07-10 17:43:27 +020079 return &si_ic(si)->buf;
Willy Tarreau4e4292b2014-11-28 12:18:45 +010080}
81
82/* returns the buffer which feeds data to this stream interface (output channel's buffer) */
83static inline struct buffer *si_ob(struct stream_interface *si)
84{
Willy Tarreauc9fa0482018-07-10 17:43:27 +020085 return &si_oc(si)->buf;
Willy Tarreau4e4292b2014-11-28 12:18:45 +010086}
87
Willy Tarreau87b09662015-04-03 00:22:06 +020088/* returns the stream associated to a stream interface */
89static inline struct stream *si_strm(struct stream_interface *si)
Willy Tarreauaefd7902014-11-28 12:03:32 +010090{
91 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +020092 return LIST_ELEM(si, struct stream *, si[1]);
Willy Tarreauaefd7902014-11-28 12:03:32 +010093 else
Willy Tarreau87b09662015-04-03 00:22:06 +020094 return LIST_ELEM(si, struct stream *, si[0]);
Willy Tarreauaefd7902014-11-28 12:03:32 +010095}
96
Willy Tarreau07373b82014-11-28 12:08:47 +010097/* returns the task associated to this stream interface */
98static inline struct task *si_task(struct stream_interface *si)
99{
100 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +0200101 return LIST_ELEM(si, struct stream *, si[1])->task;
Willy Tarreau07373b82014-11-28 12:08:47 +0100102 else
Willy Tarreau87b09662015-04-03 00:22:06 +0200103 return LIST_ELEM(si, struct stream *, si[0])->task;
Willy Tarreau07373b82014-11-28 12:08:47 +0100104}
105
Willy Tarreau50fe03b2014-11-28 13:59:31 +0100106/* returns the stream interface on the other side. Used during forwarding. */
107static inline struct stream_interface *si_opposite(struct stream_interface *si)
108{
109 if (si->flags & SI_FL_ISBACK)
Willy Tarreau87b09662015-04-03 00:22:06 +0200110 return &LIST_ELEM(si, struct stream *, si[1])->si[0];
Willy Tarreau50fe03b2014-11-28 13:59:31 +0100111 else
Willy Tarreau87b09662015-04-03 00:22:06 +0200112 return &LIST_ELEM(si, struct stream *, si[0])->si[1];
Willy Tarreau50fe03b2014-11-28 13:59:31 +0100113}
114
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200115/* initializes a stream interface in the SI_ST_INI state. It's detached from
Willy Tarreau819d3322014-11-28 12:12:34 +0100116 * any endpoint and only keeps its side which is expected to have already been
117 * set.
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200118 */
Olivier Houchard8f0b4c62018-08-02 18:21:38 +0200119static inline int si_reset(struct stream_interface *si)
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200120{
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200121 si->err_type = SI_ET_NONE;
122 si->conn_retries = 0; /* used for logging too */
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200123 si->exp = TICK_ETERNITY;
Willy Tarreaua5f5d8d2014-11-28 11:26:07 +0100124 si->flags &= SI_FL_ISBACK;
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200125 si->end = NULL;
126 si->state = si->prev_state = SI_ST_INI;
Willy Tarreau7365dad2015-04-20 01:03:17 +0200127 si->ops = &si_embedded_ops;
Olivier Houchardfa8aa862018-10-10 18:25:41 +0200128 si->wait_event.task = tasklet_new();
129 if (!si->wait_event.task)
Olivier Houchard8f0b4c62018-08-02 18:21:38 +0200130 return -1;
Olivier Houchardfa8aa862018-10-10 18:25:41 +0200131 si->wait_event.task->process = si_cs_io_cb;
132 si->wait_event.task->context = si;
133 si->wait_event.wait_reason = 0;
Olivier Houchard8f0b4c62018-08-02 18:21:38 +0200134 return 0;
Willy Tarreau3ed35ef2013-10-24 11:51:38 +0200135}
136
137/* sets the current and previous state of a stream interface to <state>. This
138 * is mainly used to create one in the established state on incoming
139 * conncetions.
140 */
141static inline void si_set_state(struct stream_interface *si, int state)
142{
143 si->state = si->prev_state = state;
144}
145
Willy Tarreau41b09f42015-08-04 20:44:05 +0200146/* only detaches the endpoint from the SI, which means that it's set to
147 * NULL and that ->ops is mapped to si_embedded_ops. The previous endpoint
148 * is returned.
149 */
150static inline enum obj_type *si_detach_endpoint(struct stream_interface *si)
151{
152 enum obj_type *prev = si->end;
153
154 si->end = NULL;
155 si->ops = &si_embedded_ops;
156 return prev;
157}
158
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100159/* Release the endpoint if it's a connection or an applet, then nullify it.
160 * Note: released connections are closed then freed.
161 */
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200162static inline void si_release_endpoint(struct stream_interface *si)
Willy Tarreau372d6702013-09-29 17:19:56 +0200163{
Olivier Houchardee23b2a2018-11-23 17:07:04 +0100164 struct connection *conn;
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200165 struct conn_stream *cs;
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100166 struct appctx *appctx;
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200167
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100168 if (!si->end)
169 return;
170
Olivier Houchard4fdec7a2018-10-11 17:09:14 +0200171 if ((cs = objt_cs(si->end))) {
172 if (si->wait_event.wait_reason != 0)
173 cs->conn->mux->unsubscribe(cs, si->wait_event.wait_reason,
174 &si->wait_event);
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200175 cs_destroy(cs);
Olivier Houchard4fdec7a2018-10-11 17:09:14 +0200176 }
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100177 else if ((appctx = objt_appctx(si->end))) {
Willy Tarreau958f0742015-09-25 20:24:26 +0200178 if (appctx->applet->release && si->state < SI_ST_DIS)
Willy Tarreau00a37f02015-04-13 12:05:19 +0200179 appctx->applet->release(appctx);
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100180 appctx_free(appctx); /* we share the connection pool */
Olivier Houchardee23b2a2018-11-23 17:07:04 +0100181 } else if ((conn = objt_conn(si->end)))
182 conn_free(conn);
Willy Tarreau41b09f42015-08-04 20:44:05 +0200183 si_detach_endpoint(si);
Willy Tarreau372d6702013-09-29 17:19:56 +0200184}
185
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200186/* Attach conn_stream <cs> to the stream interface <si>. The stream interface
Willy Tarreau2a6e8802013-10-24 15:50:53 +0200187 * is configured to work with a connection and the connection it configured
188 * with a stream interface data layer.
Willy Tarreaub363a1f2013-10-01 10:45:07 +0200189 */
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200190static inline void si_attach_cs(struct stream_interface *si, struct conn_stream *cs)
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200191{
192 si->ops = &si_conn_ops;
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200193 si->end = &cs->obj_type;
194 cs_attach(cs, si, &si_conn_cb);
Willy Tarreaubd99aab2012-10-02 20:57:19 +0200195}
196
Willy Tarreaud02cdd22013-12-15 10:23:20 +0100197/* Returns true if a connection is attached to the stream interface <si> and
198 * if this connection is ready.
199 */
200static inline int si_conn_ready(struct stream_interface *si)
201{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200202 struct connection *conn = cs_conn(objt_cs(si->end));
Willy Tarreaud02cdd22013-12-15 10:23:20 +0100203
204 return conn && conn_ctrl_ready(conn) && conn_xprt_ready(conn);
205}
206
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100207/* Attach appctx <appctx> to the stream interface <si>. The stream interface
Willy Tarreaua7513f52015-04-05 00:15:26 +0200208 * is configured to work with an applet context.
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100209 */
210static inline void si_attach_appctx(struct stream_interface *si, struct appctx *appctx)
Willy Tarreauc5788912012-08-24 18:12:41 +0200211{
Willy Tarreaud45b9f82015-04-13 16:30:14 +0200212 si->ops = &si_applet_ops;
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100213 si->end = &appctx->obj_type;
Willy Tarreau19c81612015-04-13 11:48:16 +0200214 appctx->owner = si;
Willy Tarreauc5788912012-08-24 18:12:41 +0200215}
216
Willy Tarreau4ae49232018-09-20 11:08:47 +0200217/* returns a pointer to the appctx being run in the SI, which must be valid */
Willy Tarreau7b4b4992013-12-01 09:15:12 +0100218static inline struct appctx *si_appctx(struct stream_interface *si)
219{
Willy Tarreau4ae49232018-09-20 11:08:47 +0200220 return __objt_appctx(si->end);
Willy Tarreau7b4b4992013-12-01 09:15:12 +0100221}
222
Willy Tarreau4a59f2f2013-10-24 20:10:45 +0200223/* call the applet's release function if any. Needs to be called upon close() */
224static inline void si_applet_release(struct stream_interface *si)
225{
Willy Tarreau00a37f02015-04-13 12:05:19 +0200226 struct appctx *appctx;
Willy Tarreau4a59f2f2013-10-24 20:10:45 +0200227
Willy Tarreau4ae49232018-09-20 11:08:47 +0200228 appctx = objt_appctx(si->end);
Willy Tarreau958f0742015-09-25 20:24:26 +0200229 if (appctx && appctx->applet->release && si->state < SI_ST_DIS)
Willy Tarreau00a37f02015-04-13 12:05:19 +0200230 appctx->applet->release(appctx);
Willy Tarreau4a59f2f2013-10-24 20:10:45 +0200231}
232
Willy Tarreau78dcace2018-11-14 14:01:40 +0100233/* Returns non-zero if the stream interface's Rx path is blocked */
234static inline int si_rx_blocked(const struct stream_interface *si)
235{
236 return !!(si->flags & SI_FL_RXBLK_ANY);
237}
238
239/* Returns non-zero if the stream interface's endpoint is ready to receive */
240static inline int si_rx_endp_ready(const struct stream_interface *si)
241{
242 return !(si->flags & SI_FL_RX_WAIT_EP);
243}
244
Willy Tarreau8bb2ffb2018-11-14 17:54:13 +0100245/* The stream interface announces it is ready to try to deliver more data to the input buffer */
246static inline void si_rx_endp_more(struct stream_interface *si)
Willy Tarreau394970c2018-11-06 19:17:31 +0100247{
Willy Tarreau8bb2ffb2018-11-14 17:54:13 +0100248 si->flags &= ~SI_FL_RX_WAIT_EP;
249}
250
251/* The stream interface announces it doesn't have more data for the input buffer */
252static inline void si_rx_endp_done(struct stream_interface *si)
253{
Willy Tarreau05b9b642018-11-14 13:43:35 +0100254 si->flags |= SI_FL_RX_WAIT_EP;
Willy Tarreau394970c2018-11-06 19:17:31 +0100255}
256
Willy Tarreaub26a6f92018-11-14 17:10:36 +0100257/* Tell a stream interface the input channel is OK with it sending it some data */
258static inline void si_rx_chan_rdy(struct stream_interface *si)
259{
260 si->flags &= ~SI_FL_RXBLK_CHAN;
261}
262
263/* Tell a stream interface the input channel is not OK with it sending it some data */
264static inline void si_rx_chan_blk(struct stream_interface *si)
265{
266 si->flags |= SI_FL_RXBLK_CHAN;
267}
268
Willy Tarreaua3b62d32018-12-06 15:24:01 +0100269/* Tell a stream interface the other side is connected */
270static inline void si_rx_conn_rdy(struct stream_interface *si)
271{
272 si->flags &= ~SI_FL_RXBLK_CONN;
273}
274
275/* Tell a stream interface it must wait for the other side to connect */
276static inline void si_rx_conn_blk(struct stream_interface *si)
277{
278 si->flags |= SI_FL_RXBLK_CONN;
279}
280
Willy Tarreau8be7cd72018-11-14 15:12:08 +0100281/* The stream interface just got the input buffer it was waiting for */
282static inline void si_rx_buff_rdy(struct stream_interface *si)
283{
284 si->flags &= ~SI_FL_RXBLK_BUFF;
285}
286
287/* The stream interface failed to get an input buffer and is waiting for it.
288 * Since it indicates a willingness to deliver data to the buffer that will
289 * have to be retried, we automatically clear RXBLK_ENDP to be called again
290 * as soon as RXBLK_BUFF is cleared.
291 */
292static inline void si_rx_buff_blk(struct stream_interface *si)
293{
294 si->flags |= SI_FL_RXBLK_BUFF;
295}
296
Willy Tarreaudb398432018-11-15 11:08:52 +0100297/* Tell a stream interface some room was made in the input buffer */
298static inline void si_rx_room_rdy(struct stream_interface *si)
299{
300 si->flags &= ~SI_FL_RXBLK_ROOM;
301}
302
303/* The stream interface announces it failed to put data into the input buffer
304 * by lack of room. Since it indicates a willingness to deliver data to the
305 * buffer that will have to be retried, we automatically clear RXBLK_ENDP to
306 * be called again as soon as RXBLK_ROOM is cleared.
307 */
308static inline void si_rx_room_blk(struct stream_interface *si)
309{
310 si->flags |= SI_FL_RXBLK_ROOM;
311}
312
Willy Tarreauabb5d422018-11-14 16:58:52 +0100313/* The stream interface announces it will never put new data into the input
314 * buffer and that it's not waiting for its endpoint to deliver anything else.
315 * This function obviously doesn't have a _rdy equivalent.
316 */
317static inline void si_rx_shut_blk(struct stream_interface *si)
318{
319 si->flags |= SI_FL_RXBLK_SHUT;
320}
321
Willy Tarreau78dcace2018-11-14 14:01:40 +0100322/* Returns non-zero if the stream interface's Rx path is blocked */
323static inline int si_tx_blocked(const struct stream_interface *si)
324{
325 return !!(si->flags & SI_FL_WAIT_DATA);
326}
327
328/* Returns non-zero if the stream interface's endpoint is ready to transmit */
329static inline int si_tx_endp_ready(const struct stream_interface *si)
330{
331 return (si->flags & SI_FL_WANT_GET);
332}
333
Willy Tarreau0cd3bd62018-11-06 18:46:37 +0100334/* Report that a stream interface wants to get some data from the output buffer */
335static inline void si_want_get(struct stream_interface *si)
Willy Tarreaueb406dc2015-04-21 18:44:02 +0200336{
337 si->flags |= SI_FL_WANT_GET;
338}
339
Willy Tarreau0cd3bd62018-11-06 18:46:37 +0100340/* Report that a stream interface failed to get some data from the output buffer */
341static inline void si_cant_get(struct stream_interface *si)
Willy Tarreaueb406dc2015-04-21 18:44:02 +0200342{
343 si->flags |= SI_FL_WANT_GET | SI_FL_WAIT_DATA;
344}
345
Willy Tarreau0cd3bd62018-11-06 18:46:37 +0100346/* Report that a stream interface doesn't want to get data from the output buffer */
347static inline void si_stop_get(struct stream_interface *si)
Willy Tarreaueb406dc2015-04-21 18:44:02 +0200348{
349 si->flags &= ~SI_FL_WANT_GET;
350}
351
Willy Tarreau394970c2018-11-06 19:17:31 +0100352/* Report that a stream interface won't get any more data from the output buffer */
353static inline void si_done_get(struct stream_interface *si)
354{
355 si->flags &= ~(SI_FL_WANT_GET | SI_FL_WAIT_DATA);
356}
357
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200358/* Try to allocate a new conn_stream and assign it to the interface. If
Willy Tarreau973a5422015-08-05 21:47:23 +0200359 * an endpoint was previously allocated, it is released first. The newly
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200360 * allocated conn_stream is initialized, assigned to the stream interface,
Willy Tarreau973a5422015-08-05 21:47:23 +0200361 * and returned.
Willy Tarreau9471b8c2013-12-15 13:31:35 +0100362 */
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200363static inline struct conn_stream *si_alloc_cs(struct stream_interface *si, struct connection *conn)
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200364{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200365 struct conn_stream *cs;
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200366
Willy Tarreau973a5422015-08-05 21:47:23 +0200367 si_release_endpoint(si);
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200368
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200369 cs = cs_new(conn);
370 if (cs)
371 si_attach_cs(si, cs);
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200372
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200373 return cs;
Willy Tarreau32e3c6a2013-10-11 19:34:20 +0200374}
375
Willy Tarreau09799162018-10-25 10:16:07 +0200376/* Try to allocate a buffer for the stream-int's input channel. It relies on
Willy Tarreauabf531c2018-11-07 18:53:29 +0100377 * channel_alloc_buffer() for this so it abides by its rules. It returns 0 on
378 * failure, non-zero otherwise. If no buffer is available, the requester,
Willy Tarreau8be7cd72018-11-14 15:12:08 +0100379 * represented by the <wait> pointer, will be added in the list of objects
380 * waiting for an available buffer, and SI_FL_RXBLK_BUFF will be set on the
381 * stream-int and SI_FL_RX_WAIT_EP cleared. The requester will be responsible
382 * for calling this function to try again once woken up.
Willy Tarreau09799162018-10-25 10:16:07 +0200383 */
384static inline int si_alloc_ibuf(struct stream_interface *si, struct buffer_wait *wait)
385{
386 int ret;
387
Willy Tarreau09799162018-10-25 10:16:07 +0200388 ret = channel_alloc_buffer(si_ic(si), wait);
389 if (!ret)
Willy Tarreau8be7cd72018-11-14 15:12:08 +0100390 si_rx_buff_blk(si);
Willy Tarreau09799162018-10-25 10:16:07 +0200391 return ret;
392}
393
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100394/* Release the interface's existing endpoint (connection or appctx) and
395 * allocate then initialize a new appctx which is assigned to the interface
Willy Tarreaua7513f52015-04-05 00:15:26 +0200396 * and returned. NULL may be returned upon memory shortage. Applet <applet>
397 * is assigned to the appctx, but it may be NULL.
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100398 */
Willy Tarreau30576452015-04-13 13:50:30 +0200399static inline struct appctx *si_alloc_appctx(struct stream_interface *si, struct applet *applet)
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100400{
401 struct appctx *appctx;
402
403 si_release_endpoint(si);
Emeric Brun1138fd02017-06-19 12:38:55 +0200404 appctx = appctx_new(applet, tid_bit);
Willy Tarreau10d81b82018-05-31 14:44:25 +0200405 if (appctx) {
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100406 si_attach_appctx(si, appctx);
Willy Tarreau10d81b82018-05-31 14:44:25 +0200407 appctx->t->nice = si_strm(si)->task->nice;
408 }
Willy Tarreau0a23bcb2013-12-01 11:31:38 +0100409
410 return appctx;
411}
412
Willy Tarreau73b013b2012-05-21 16:31:45 +0200413/* Sends a shutr to the connection using the data layer */
414static inline void si_shutr(struct stream_interface *si)
415{
Willy Tarreau6fe15412013-09-29 15:16:03 +0200416 si->ops->shutr(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200417}
418
419/* Sends a shutw to the connection using the data layer */
420static inline void si_shutw(struct stream_interface *si)
421{
Willy Tarreau6fe15412013-09-29 15:16:03 +0200422 si->ops->shutw(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200423}
424
Willy Tarreau96aadd52018-11-07 11:55:54 +0100425/* This is to be used after making some room available in a channel. It will
Willy Tarreau32742fd2018-11-14 14:07:59 +0100426 * return without doing anything if the stream interface's RX path is blocked.
427 * It will automatically mark the stream interface as busy processing the end
428 * point in order to avoid useless repeated wakeups.
Willy Tarreau8fe516f2018-11-09 16:21:43 +0100429 * It will then call ->chk_rcv() to enable receipt of new data.
Willy Tarreau96aadd52018-11-07 11:55:54 +0100430 */
Willy Tarreau73b013b2012-05-21 16:31:45 +0200431static inline void si_chk_rcv(struct stream_interface *si)
432{
Willy Tarreaua3b62d32018-12-06 15:24:01 +0100433 if (si->flags & SI_FL_RXBLK_CONN && (si_opposite(si)->state >= SI_ST_EST))
434 si_rx_conn_rdy(si);
435
Willy Tarreau32742fd2018-11-14 14:07:59 +0100436 if (si_rx_blocked(si) || !si_rx_endp_ready(si))
Willy Tarreau96aadd52018-11-07 11:55:54 +0100437 return;
438
Willy Tarreauadc7f3e2018-12-06 15:25:58 +0100439 if (si->state != SI_ST_EST)
Willy Tarreau1bdb5982018-11-07 14:59:45 +0100440 return;
441
Willy Tarreau05b9b642018-11-14 13:43:35 +0100442 si->flags |= SI_FL_RX_WAIT_EP;
Willy Tarreau57f08bb2018-11-07 11:28:12 +0100443 si->ops->chk_rcv(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200444}
445
Willy Tarreauade64782018-11-17 19:51:07 +0100446/* This tries to perform a synchronous receive on the stream interface to
447 * try to collect last arrived data. In practice it's only implemented on
448 * conn_streams. Returns 0 if nothing was done, non-zero if new data or a
449 * shutdown were collected. This may result on some delayed receive calls
450 * to be programmed and performed later, though it doesn't provide any
451 * such guarantee.
452 */
453static inline int si_sync_recv(struct stream_interface *si)
454{
455 struct conn_stream *cs;
456
457 if (si->state != SI_ST_EST)
458 return 0;
459
460 cs = objt_cs(si->end);
461 if (!cs)
462 return 0; // only conn_streams are supported
463
464 if (si->wait_event.wait_reason & SUB_CAN_RECV)
465 return 0; // already subscribed
466
Willy Tarreau7f494d02018-11-16 14:26:11 +0100467 if (!si_rx_endp_ready(si) || si_rx_blocked(si))
Willy Tarreauade64782018-11-17 19:51:07 +0100468 return 0; // already failed
469
470 return si_cs_recv(cs);
471}
472
Willy Tarreau73b013b2012-05-21 16:31:45 +0200473/* Calls chk_snd on the connection using the data layer */
474static inline void si_chk_snd(struct stream_interface *si)
475{
Willy Tarreau57f08bb2018-11-07 11:28:12 +0100476 si->ops->chk_snd(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200477}
478
479/* Calls chk_snd on the connection using the ctrl layer */
Olivier Houchard201b9f42018-11-21 00:16:29 +0100480static inline int si_connect(struct stream_interface *si, struct connection *conn)
Willy Tarreau73b013b2012-05-21 16:31:45 +0200481{
Willy Tarreaue7dff022015-04-03 01:14:29 +0200482 int ret = SF_ERR_NONE;
Willy Tarreau14f8e862012-08-30 22:23:13 +0200483
Willy Tarreaub363a1f2013-10-01 10:45:07 +0200484 if (unlikely(!conn || !conn->ctrl || !conn->ctrl->connect))
Willy Tarreaue7dff022015-04-03 01:14:29 +0200485 return SF_ERR_INTERNAL;
Willy Tarreau14f8e862012-08-30 22:23:13 +0200486
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100487 if (!conn_ctrl_ready(conn) || !conn_xprt_ready(conn)) {
Willy Tarreau2bb4a962014-11-28 11:11:05 +0100488 ret = conn->ctrl->connect(conn, !channel_is_empty(si_oc(si)), 0);
Willy Tarreaue7dff022015-04-03 01:14:29 +0200489 if (ret != SF_ERR_NONE)
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100490 return ret;
Willy Tarreau9e5a3aa2013-12-31 23:32:12 +0100491
Willy Tarreau9e5a3aa2013-12-31 23:32:12 +0100492 /* we're in the process of establishing a connection */
493 si->state = SI_ST_CON;
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100494 }
Christopher Fauletc34d19f2015-12-23 09:33:35 +0100495 else {
496 /* reuse the existing connection */
Willy Tarreau9e5a3aa2013-12-31 23:32:12 +0100497
498 /* the connection is established */
499 si->state = SI_ST_EST;
Willy Tarreaub490b4e2013-12-15 16:20:50 +0100500 }
Willy Tarreau14f8e862012-08-30 22:23:13 +0200501
502 /* needs src ip/port for logging */
503 if (si->flags & SI_FL_SRC_ADDR)
Willy Tarreaub363a1f2013-10-01 10:45:07 +0200504 conn_get_from_addr(conn);
Willy Tarreau14f8e862012-08-30 22:23:13 +0200505
Willy Tarreau14f8e862012-08-30 22:23:13 +0200506 return ret;
Willy Tarreau73b013b2012-05-21 16:31:45 +0200507}
Willy Tarreau59b94792012-05-11 16:16:40 +0200508
Christopher Faulet3bc1b112018-11-29 11:29:26 +0100509/* Returns info about the conn_stream <cs>, if not NULL. It call the mux layer's
510 * get_cs_info() function, if it exists. On success, it returns a cs_info
511 * structure. Otherwise, on error, if the mux does not implement get_cs_info()
512 * or if conn_stream is NULL, NULL is returned.
513 */
514static inline const struct cs_info *si_get_cs_info(struct conn_stream *cs)
515{
516 if (cs && cs->conn->mux->get_cs_info)
517 return cs->conn->mux->get_cs_info(cs);
518 return NULL;
519}
520
Willy Tarreau55e4ecd2012-12-08 17:48:47 +0100521/* for debugging, reports the stream interface state name */
522static inline const char *si_state_str(int state)
523{
524 switch (state) {
525 case SI_ST_INI: return "INI";
526 case SI_ST_REQ: return "REQ";
527 case SI_ST_QUE: return "QUE";
528 case SI_ST_TAR: return "TAR";
529 case SI_ST_ASS: return "ASS";
530 case SI_ST_CON: return "CON";
531 case SI_ST_CER: return "CER";
532 case SI_ST_EST: return "EST";
533 case SI_ST_DIS: return "DIS";
534 case SI_ST_CLO: return "CLO";
535 default: return "???";
536 }
537}
538
Willy Tarreaucff64112008-11-03 06:26:53 +0100539#endif /* _PROTO_STREAM_INTERFACE_H */
540
541/*
542 * Local variables:
543 * c-indent-level: 8
544 * c-basic-offset: 8
545 * End:
546 */