blob: 061a003b818c89f3aa6456c2fb6c7590393dc5bc [file] [log] [blame]
Christopher Faulet1329f2a2021-12-16 17:32:56 +01001/*
Willy Tarreau4596fe22022-05-17 19:07:51 +02002 * stream connector management functions
Christopher Faulet1329f2a2021-12-16 17:32:56 +01003 *
4 * Copyright 2021 Christopher Faulet <cfaulet@haproxy.com>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
12
13#include <haproxy/api.h>
Christopher Faulet37046632022-04-01 11:36:58 +020014#include <haproxy/applet.h>
Christopher Faulet1329f2a2021-12-16 17:32:56 +010015#include <haproxy/connection.h>
Christopher Faulet5e29b762022-04-04 08:58:34 +020016#include <haproxy/check.h>
17#include <haproxy/http_ana.h>
18#include <haproxy/pipe.h>
Christopher Faulet1329f2a2021-12-16 17:32:56 +010019#include <haproxy/pool.h>
Willy Tarreau5edca2f2022-05-27 09:25:10 +020020#include <haproxy/sc_strm.h>
Willy Tarreaucb086c62022-05-27 09:47:12 +020021#include <haproxy/stconn.h>
Christopher Faulet1329f2a2021-12-16 17:32:56 +010022
Willy Tarreau4596fe22022-05-17 19:07:51 +020023DECLARE_POOL(pool_head_connstream, "stconn", sizeof(struct stconn));
Willy Tarreauea59b022022-05-17 17:53:22 +020024DECLARE_POOL(pool_head_sedesc, "sedesc", sizeof(struct sedesc));
Christopher Faulet1329f2a2021-12-16 17:32:56 +010025
Willy Tarreau3a3f4802022-05-17 18:28:19 +020026/* functions used by default on a detached stream connector */
Willy Tarreau0adb2812022-05-27 10:02:48 +020027static void sc_app_shutr(struct stconn *sc);
28static void sc_app_shutw(struct stconn *sc);
29static void sc_app_chk_rcv(struct stconn *sc);
30static void sc_app_chk_snd(struct stconn *sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +020031
Willy Tarreau3a3f4802022-05-17 18:28:19 +020032/* functions used on a mux-based stream connector */
Willy Tarreau0adb2812022-05-27 10:02:48 +020033static void sc_app_shutr_conn(struct stconn *sc);
34static void sc_app_shutw_conn(struct stconn *sc);
35static void sc_app_chk_rcv_conn(struct stconn *sc);
36static void sc_app_chk_snd_conn(struct stconn *sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +020037
Willy Tarreau3a3f4802022-05-17 18:28:19 +020038/* functions used on an applet-based stream connector */
Willy Tarreau0adb2812022-05-27 10:02:48 +020039static void sc_app_shutr_applet(struct stconn *sc);
40static void sc_app_shutw_applet(struct stconn *sc);
41static void sc_app_chk_rcv_applet(struct stconn *sc);
42static void sc_app_chk_snd_applet(struct stconn *sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +020043
Willy Tarreau0adb2812022-05-27 10:02:48 +020044static int sc_conn_process(struct stconn *sc);
45static int sc_conn_recv(struct stconn *sc);
46static int sc_conn_send(struct stconn *sc);
47static int sc_applet_process(struct stconn *sc);
Willy Tarreau2f2318d2022-05-18 10:17:16 +020048
Willy Tarreau3a3f4802022-05-17 18:28:19 +020049/* stream connector operations for connections */
50struct sc_app_ops sc_app_conn_ops = {
51 .chk_rcv = sc_app_chk_rcv_conn,
52 .chk_snd = sc_app_chk_snd_conn,
53 .shutr = sc_app_shutr_conn,
54 .shutw = sc_app_shutw_conn,
Willy Tarreau462b9892022-05-18 18:06:53 +020055 .wake = sc_conn_process,
Willy Tarreau2f2318d2022-05-18 10:17:16 +020056 .name = "STRM",
Christopher Faulet9ffddd52022-04-01 14:04:29 +020057};
58
Willy Tarreau3a3f4802022-05-17 18:28:19 +020059/* stream connector operations for embedded tasks */
60struct sc_app_ops sc_app_embedded_ops = {
61 .chk_rcv = sc_app_chk_rcv,
62 .chk_snd = sc_app_chk_snd,
63 .shutr = sc_app_shutr,
64 .shutw = sc_app_shutw,
Willy Tarreau2f2318d2022-05-18 10:17:16 +020065 .wake = NULL, /* may never be used */
66 .name = "NONE", /* may never be used */
Christopher Faulet9ffddd52022-04-01 14:04:29 +020067};
68
Willy Tarreau2f2318d2022-05-18 10:17:16 +020069/* stream connector operations for applets */
Willy Tarreau3a3f4802022-05-17 18:28:19 +020070struct sc_app_ops sc_app_applet_ops = {
71 .chk_rcv = sc_app_chk_rcv_applet,
72 .chk_snd = sc_app_chk_snd_applet,
73 .shutr = sc_app_shutr_applet,
74 .shutw = sc_app_shutw_applet,
Willy Tarreau19c65a92022-05-27 08:49:24 +020075 .wake = sc_applet_process,
Christopher Faulet5e29b762022-04-04 08:58:34 +020076 .name = "STRM",
77};
78
Willy Tarreau2f2318d2022-05-18 10:17:16 +020079/* stream connector for health checks on connections */
80struct sc_app_ops sc_app_check_ops = {
81 .chk_rcv = NULL,
82 .chk_snd = NULL,
83 .shutr = NULL,
84 .shutw = NULL,
85 .wake = wake_srv_chk,
86 .name = "CHCK",
87};
Christopher Faulet5e29b762022-04-04 08:58:34 +020088
Christopher Faulet9ed77422022-04-12 08:51:15 +020089/* Initializes an endpoint */
Willy Tarreauea59b022022-05-17 17:53:22 +020090void sedesc_init(struct sedesc *sedesc)
Christopher Fauletdb90f2a2022-03-22 16:06:25 +010091{
Willy Tarreauea59b022022-05-17 17:53:22 +020092 sedesc->se = NULL;
93 sedesc->conn = NULL;
Willy Tarreauc1054922022-05-18 07:43:52 +020094 sedesc->sc = NULL;
Christopher Faulet4c135682023-02-16 11:09:31 +010095 sedesc->lra = TICK_ETERNITY;
96 sedesc->fsb = TICK_ETERNITY;
Willy Tarreauea59b022022-05-17 17:53:22 +020097 se_fl_setall(sedesc, SE_FL_NONE);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +010098}
99
Christopher Faulet9ed77422022-04-12 08:51:15 +0200100/* Tries to alloc an endpoint and initialize it. Returns NULL on failure. */
Willy Tarreauea59b022022-05-17 17:53:22 +0200101struct sedesc *sedesc_new()
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100102{
Willy Tarreauea59b022022-05-17 17:53:22 +0200103 struct sedesc *sedesc;
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100104
Willy Tarreauea59b022022-05-17 17:53:22 +0200105 sedesc = pool_alloc(pool_head_sedesc);
106 if (unlikely(!sedesc))
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100107 return NULL;
108
Willy Tarreauea59b022022-05-17 17:53:22 +0200109 sedesc_init(sedesc);
110 return sedesc;
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100111}
112
Christopher Faulet9ed77422022-04-12 08:51:15 +0200113/* Releases an endpoint. It is the caller responsibility to be sure it is safe
114 * and it is not shared with another entity
115 */
Willy Tarreauea59b022022-05-17 17:53:22 +0200116void sedesc_free(struct sedesc *sedesc)
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100117{
Willy Tarreauea59b022022-05-17 17:53:22 +0200118 pool_free(pool_head_sedesc, sedesc);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100119}
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100120
Willy Tarreau4596fe22022-05-17 19:07:51 +0200121/* Tries to allocate a new stconn and initialize its main fields. On
Christopher Faulet9ed77422022-04-12 08:51:15 +0200122 * failure, nothing is allocated and NULL is returned. It is an internal
Willy Tarreaub605c422022-05-17 17:04:55 +0200123 * function. The caller must, at least, set the SE_FL_ORPHAN or SE_FL_DETACHED
Christopher Faulet9ed77422022-04-12 08:51:15 +0200124 * flag.
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100125 */
Willy Tarreaua0b58b52022-05-27 08:33:53 +0200126static struct stconn *sc_new(struct sedesc *sedesc)
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100127{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200128 struct stconn *sc;
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100129
Willy Tarreau0adb2812022-05-27 10:02:48 +0200130 sc = pool_alloc(pool_head_connstream);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100131
Willy Tarreau0adb2812022-05-27 10:02:48 +0200132 if (unlikely(!sc))
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100133 goto alloc_error;
Christopher Fauletbb772d02022-03-22 15:28:36 +0100134
Willy Tarreau1d2c79a2022-05-27 11:15:19 +0200135 sc->obj_type = OBJ_TYPE_SC;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200136 sc->flags = SC_FL_NONE;
137 sc->state = SC_ST_INI;
Christopher Fauletbe5cc762023-02-20 08:41:55 +0100138 sc->ioto = TICK_ETERNITY;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200139 sc->app = NULL;
140 sc->app_ops = NULL;
141 sc->src = NULL;
142 sc->dst = NULL;
143 sc->wait_event.tasklet = NULL;
144 sc->wait_event.events = 0;
Christopher Faulet2f35e7b2022-03-31 11:09:28 +0200145
Christopher Faulet9ed77422022-04-12 08:51:15 +0200146 /* If there is no endpoint, allocate a new one now */
Willy Tarreauea59b022022-05-17 17:53:22 +0200147 if (!sedesc) {
148 sedesc = sedesc_new();
149 if (unlikely(!sedesc))
Christopher Fauletb669d682022-03-22 18:37:19 +0100150 goto alloc_error;
151 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200152 sc->sedesc = sedesc;
153 sedesc->sc = sc;
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100154
Willy Tarreau0adb2812022-05-27 10:02:48 +0200155 return sc;
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100156
157 alloc_error:
Willy Tarreau0adb2812022-05-27 10:02:48 +0200158 pool_free(pool_head_connstream, sc);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100159 return NULL;
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100160}
161
Willy Tarreau31219282022-05-27 16:21:33 +0200162/* Creates a new stream connector and its associated stream from a mux. <sd> must
163 * be defined. It returns NULL on error. On success, the new stream connector is
Willy Tarreaub605c422022-05-17 17:04:55 +0200164 * returned. In this case, SE_FL_ORPHAN flag is removed.
Christopher Faulet9ed77422022-04-12 08:51:15 +0200165 */
Willy Tarreau31219282022-05-27 16:21:33 +0200166struct stconn *sc_new_from_endp(struct sedesc *sd, struct session *sess, struct buffer *input)
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100167{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200168 struct stconn *sc;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100169
Willy Tarreau31219282022-05-27 16:21:33 +0200170 sc = sc_new(sd);
Willy Tarreau0adb2812022-05-27 10:02:48 +0200171 if (unlikely(!sc))
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100172 return NULL;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200173 if (unlikely(!stream_new(sess, sc, input))) {
Christopher Faulet3ab72c62022-09-27 09:18:20 +0200174 sd->sc = NULL;
Willy Tarreau7a8ca0a2023-03-20 19:53:14 +0100175 if (sc->sedesc != sd) {
176 /* none was provided so sc_new() allocated one */
177 sedesc_free(sc->sedesc);
178 }
179 pool_free(pool_head_connstream, sc);
Christopher Faulet3ab72c62022-09-27 09:18:20 +0200180 se_fl_set(sd, SE_FL_ORPHAN);
181 return NULL;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100182 }
Willy Tarreau31219282022-05-27 16:21:33 +0200183 se_fl_clr(sd, SE_FL_ORPHAN);
Willy Tarreau0adb2812022-05-27 10:02:48 +0200184 return sc;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100185}
186
Willy Tarreau4596fe22022-05-17 19:07:51 +0200187/* Creates a new stream connector from an stream. There is no endpoint here, thus it
Willy Tarreaua0b58b52022-05-27 08:33:53 +0200188 * will be created by sc_new(). So the SE_FL_DETACHED flag is set. It returns
Willy Tarreau4596fe22022-05-17 19:07:51 +0200189 * NULL on error. On success, the new stream connector is returned.
Christopher Faulet9ed77422022-04-12 08:51:15 +0200190 */
Willy Tarreaua0b58b52022-05-27 08:33:53 +0200191struct stconn *sc_new_from_strm(struct stream *strm, unsigned int flags)
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100192{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200193 struct stconn *sc;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100194
Willy Tarreau0adb2812022-05-27 10:02:48 +0200195 sc = sc_new(NULL);
196 if (unlikely(!sc))
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100197 return NULL;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200198 sc->flags |= flags;
199 sc_ep_set(sc, SE_FL_DETACHED);
200 sc->app = &strm->obj_type;
201 sc->app_ops = &sc_app_embedded_ops;
202 return sc;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100203}
204
Willy Tarreau4596fe22022-05-17 19:07:51 +0200205/* Creates a new stream connector from an health-check. There is no endpoint here,
Willy Tarreaua0b58b52022-05-27 08:33:53 +0200206 * thus it will be created by sc_new(). So the SE_FL_DETACHED flag is set. It
Willy Tarreau4596fe22022-05-17 19:07:51 +0200207 * returns NULL on error. On success, the new stream connector is returned.
Christopher Faulet9ed77422022-04-12 08:51:15 +0200208 */
Willy Tarreaua0b58b52022-05-27 08:33:53 +0200209struct stconn *sc_new_from_check(struct check *check, unsigned int flags)
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100210{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200211 struct stconn *sc;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100212
Willy Tarreau0adb2812022-05-27 10:02:48 +0200213 sc = sc_new(NULL);
214 if (unlikely(!sc))
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100215 return NULL;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200216 sc->flags |= flags;
217 sc_ep_set(sc, SE_FL_DETACHED);
218 sc->app = &check->obj_type;
219 sc->app_ops = &sc_app_check_ops;
220 return sc;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100221}
222
Willy Tarreaua0b58b52022-05-27 08:33:53 +0200223/* Releases a stconn previously allocated by sc_new(), as well as its
Christopher Faulet9ed77422022-04-12 08:51:15 +0200224 * endpoint, if it exists. This function is called internally or on error path.
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100225 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200226void sc_free(struct stconn *sc)
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100227{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200228 sockaddr_free(&sc->src);
229 sockaddr_free(&sc->dst);
230 if (sc->sedesc) {
231 BUG_ON(!sc_ep_test(sc, SE_FL_DETACHED));
232 sedesc_free(sc->sedesc);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100233 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200234 if (sc->wait_event.tasklet)
235 tasklet_free(sc->wait_event.tasklet);
236 pool_free(pool_head_connstream, sc);
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100237}
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100238
Willy Tarreau4596fe22022-05-17 19:07:51 +0200239/* Conditionally removes a stream connector if it is detached and if there is no app
Christopher Fauleteb50c012022-04-21 14:22:53 +0200240 * layer defined. Except on error path, this one must be used. if release, the
Willy Tarreaue68bc612022-05-27 11:23:05 +0200241 * pointer on the SC is set to NULL.
Christopher Fauletaa69d8f2022-04-12 18:09:48 +0200242 */
Willy Tarreaue68bc612022-05-27 11:23:05 +0200243static void sc_free_cond(struct stconn **scp)
Christopher Fauletaa69d8f2022-04-12 18:09:48 +0200244{
Willy Tarreaue68bc612022-05-27 11:23:05 +0200245 struct stconn *sc = *scp;
Christopher Fauleteb50c012022-04-21 14:22:53 +0200246
Willy Tarreau0adb2812022-05-27 10:02:48 +0200247 if (!sc->app && (!sc->sedesc || sc_ep_test(sc, SE_FL_DETACHED))) {
248 sc_free(sc);
Willy Tarreaue68bc612022-05-27 11:23:05 +0200249 *scp = NULL;
Christopher Fauleteb50c012022-04-21 14:22:53 +0200250 }
Christopher Fauletaa69d8f2022-04-12 18:09:48 +0200251}
252
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100253
Willy Tarreau4596fe22022-05-17 19:07:51 +0200254/* Attaches a stconn to a mux endpoint and sets the endpoint ctx. Returns
Ilya Shipitsin3b64a282022-07-29 22:26:53 +0500255 * -1 on error and 0 on success. SE_FL_DETACHED flag is removed. This function is
Christopher Faulet9ed77422022-04-12 08:51:15 +0200256 * called from a mux when it is attached to a stream or a health-check.
257 */
Willy Tarreau31219282022-05-27 16:21:33 +0200258int sc_attach_mux(struct stconn *sc, void *sd, void *ctx)
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100259{
Christopher Faulet93882042022-01-19 14:56:50 +0100260 struct connection *conn = ctx;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200261 struct sedesc *sedesc = sc->sedesc;
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100262
Willy Tarreau0adb2812022-05-27 10:02:48 +0200263 if (sc_strm(sc)) {
264 if (!sc->wait_event.tasklet) {
265 sc->wait_event.tasklet = tasklet_new();
266 if (!sc->wait_event.tasklet)
Christopher Faulet2f35e7b2022-03-31 11:09:28 +0200267 return -1;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200268 sc->wait_event.tasklet->process = sc_conn_io_cb;
269 sc->wait_event.tasklet->context = sc;
270 sc->wait_event.events = 0;
Christopher Faulet2f35e7b2022-03-31 11:09:28 +0200271 }
272
Willy Tarreau0adb2812022-05-27 10:02:48 +0200273 sc->app_ops = &sc_app_conn_ops;
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100274 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200275 else if (sc_check(sc)) {
276 if (!sc->wait_event.tasklet) {
277 sc->wait_event.tasklet = tasklet_new();
278 if (!sc->wait_event.tasklet)
Christopher Fauletc95eaef2022-05-18 15:57:15 +0200279 return -1;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200280 sc->wait_event.tasklet->process = srv_chk_io_cb;
281 sc->wait_event.tasklet->context = sc;
282 sc->wait_event.events = 0;
Christopher Fauletc95eaef2022-05-18 15:57:15 +0200283 }
284
Willy Tarreau0adb2812022-05-27 10:02:48 +0200285 sc->app_ops = &sc_app_check_ops;
Christopher Fauletc95eaef2022-05-18 15:57:15 +0200286 }
Willy Tarreaue2f79462023-03-20 19:45:41 +0100287
288 sedesc->se = sd;
289 sedesc->conn = ctx;
290 se_fl_set(sedesc, SE_FL_T_MUX);
291 se_fl_clr(sedesc, SE_FL_DETACHED);
292 if (!conn->ctx)
293 conn->ctx = sc;
Christopher Faulet070b91b2022-03-31 19:27:18 +0200294 return 0;
Christopher Faulet93882042022-01-19 14:56:50 +0100295}
296
Willy Tarreau4596fe22022-05-17 19:07:51 +0200297/* Attaches a stconn to an applet endpoint and sets the endpoint
Ilya Shipitsin3b64a282022-07-29 22:26:53 +0500298 * ctx. Returns -1 on error and 0 on success. SE_FL_DETACHED flag is
Christopher Faulet9ed77422022-04-12 08:51:15 +0200299 * removed. This function is called by a stream when a backend applet is
300 * registered.
301 */
Willy Tarreau31219282022-05-27 16:21:33 +0200302static void sc_attach_applet(struct stconn *sc, void *sd)
Christopher Faulet93882042022-01-19 14:56:50 +0100303{
Willy Tarreau31219282022-05-27 16:21:33 +0200304 sc->sedesc->se = sd;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200305 sc_ep_set(sc, SE_FL_T_APPLET);
306 sc_ep_clr(sc, SE_FL_DETACHED);
307 if (sc_strm(sc))
308 sc->app_ops = &sc_app_applet_ops;
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100309}
310
Willy Tarreau4596fe22022-05-17 19:07:51 +0200311/* Attaches a stconn to a app layer and sets the relevant
Willy Tarreaub605c422022-05-17 17:04:55 +0200312 * callbacks. Returns -1 on error and 0 on success. SE_FL_ORPHAN flag is
Christopher Faulet9ed77422022-04-12 08:51:15 +0200313 * removed. This function is called by a stream when it is created to attach it
Willy Tarreau4596fe22022-05-17 19:07:51 +0200314 * on the stream connector on the client side.
Christopher Faulet9ed77422022-04-12 08:51:15 +0200315 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200316int sc_attach_strm(struct stconn *sc, struct stream *strm)
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100317{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200318 sc->app = &strm->obj_type;
319 sc_ep_clr(sc, SE_FL_ORPHAN);
320 if (sc_ep_test(sc, SE_FL_T_MUX)) {
321 sc->wait_event.tasklet = tasklet_new();
322 if (!sc->wait_event.tasklet)
Christopher Faulet2f35e7b2022-03-31 11:09:28 +0200323 return -1;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200324 sc->wait_event.tasklet->process = sc_conn_io_cb;
325 sc->wait_event.tasklet->context = sc;
326 sc->wait_event.events = 0;
Christopher Faulet2f35e7b2022-03-31 11:09:28 +0200327
Willy Tarreau0adb2812022-05-27 10:02:48 +0200328 sc->app_ops = &sc_app_conn_ops;
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100329 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200330 else if (sc_ep_test(sc, SE_FL_T_APPLET)) {
331 sc->app_ops = &sc_app_applet_ops;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100332 }
333 else {
Willy Tarreau0adb2812022-05-27 10:02:48 +0200334 sc->app_ops = &sc_app_embedded_ops;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100335 }
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100336 return 0;
337}
338
Willy Tarreau4596fe22022-05-17 19:07:51 +0200339/* Detaches the stconn from the endpoint, if any. For a connecrion, if a
Christopher Faulet9ed77422022-04-12 08:51:15 +0200340 * mux owns the connection ->detach() callback is called. Otherwise, it means
Willy Tarreau4596fe22022-05-17 19:07:51 +0200341 * the stream connector owns the connection. In this case the connection is closed
Christopher Faulet9ed77422022-04-12 08:51:15 +0200342 * and released. For an applet, the appctx is released. If still allocated, the
343 * endpoint is reset and flag as detached. If the app layer is also detached,
Willy Tarreau4596fe22022-05-17 19:07:51 +0200344 * the stream connector is released.
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100345 */
Willy Tarreaue68bc612022-05-27 11:23:05 +0200346static void sc_detach_endp(struct stconn **scp)
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100347{
Willy Tarreaue68bc612022-05-27 11:23:05 +0200348 struct stconn *sc = *scp;
Christopher Fauleteb50c012022-04-21 14:22:53 +0200349
Willy Tarreau0adb2812022-05-27 10:02:48 +0200350 if (!sc)
Christopher Fauleteb50c012022-04-21 14:22:53 +0200351 return;
352
Willy Tarreau0adb2812022-05-27 10:02:48 +0200353 if (sc_ep_test(sc, SE_FL_T_MUX)) {
354 struct connection *conn = __sc_conn(sc);
355 struct sedesc *sedesc = sc->sedesc;
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100356
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100357 if (conn->mux) {
Willy Tarreau0adb2812022-05-27 10:02:48 +0200358 if (sc->wait_event.events != 0)
359 conn->mux->unsubscribe(sc, sc->wait_event.events, &sc->wait_event);
Willy Tarreau798465b2022-05-17 18:20:02 +0200360 se_fl_set(sedesc, SE_FL_ORPHAN);
Willy Tarreauc1054922022-05-18 07:43:52 +0200361 sedesc->sc = NULL;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200362 sc->sedesc = NULL;
Willy Tarreau798465b2022-05-17 18:20:02 +0200363 conn->mux->detach(sedesc);
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100364 }
365 else {
366 /* It's too early to have a mux, let's just destroy
367 * the connection
368 */
369 conn_stop_tracking(conn);
370 conn_full_close(conn);
371 if (conn->destroy_cb)
372 conn->destroy_cb(conn);
373 conn_free(conn);
374 }
375 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200376 else if (sc_ep_test(sc, SE_FL_T_APPLET)) {
377 struct appctx *appctx = __sc_appctx(sc);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100378
Willy Tarreau0adb2812022-05-27 10:02:48 +0200379 sc_ep_set(sc, SE_FL_ORPHAN);
380 sc->sedesc->sc = NULL;
381 sc->sedesc = NULL;
Willy Tarreau1c3ead42022-05-10 19:42:22 +0200382 appctx_shut(appctx);
383 appctx_free(appctx);
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100384 }
385
Willy Tarreau0adb2812022-05-27 10:02:48 +0200386 if (sc->sedesc) {
Willy Tarreauda59c892022-05-27 17:03:34 +0200387 /* the SD wasn't used and can be recycled */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200388 sc->sedesc->se = NULL;
389 sc->sedesc->conn = NULL;
Willy Tarreauda59c892022-05-27 17:03:34 +0200390 sc->sedesc->flags = 0;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200391 sc_ep_set(sc, SE_FL_DETACHED);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100392 }
393
Willy Tarreaue68bc612022-05-27 11:23:05 +0200394 /* FIXME: Rest SC for now but must be reviewed. SC flags are only
Christopher Fauletc36de9d2022-01-06 08:44:58 +0100395 * connection related for now but this will evolved
396 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200397 sc->flags &= SC_FL_ISBACK;
398 if (sc_strm(sc))
399 sc->app_ops = &sc_app_embedded_ops;
Willy Tarreau2f2318d2022-05-18 10:17:16 +0200400 else
Willy Tarreau0adb2812022-05-27 10:02:48 +0200401 sc->app_ops = NULL;
Willy Tarreaue68bc612022-05-27 11:23:05 +0200402 sc_free_cond(scp);
Christopher Fauletc36de9d2022-01-06 08:44:58 +0100403}
404
Willy Tarreau4596fe22022-05-17 19:07:51 +0200405/* Detaches the stconn from the app layer. If there is no endpoint attached
406 * to the stconn
Christopher Faulet9ed77422022-04-12 08:51:15 +0200407 */
Willy Tarreaue68bc612022-05-27 11:23:05 +0200408static void sc_detach_app(struct stconn **scp)
Christopher Fauletc36de9d2022-01-06 08:44:58 +0100409{
Willy Tarreaue68bc612022-05-27 11:23:05 +0200410 struct stconn *sc = *scp;
Christopher Fauleteb50c012022-04-21 14:22:53 +0200411
Willy Tarreau0adb2812022-05-27 10:02:48 +0200412 if (!sc)
Christopher Fauleteb50c012022-04-21 14:22:53 +0200413 return;
414
Willy Tarreau0adb2812022-05-27 10:02:48 +0200415 sc->app = NULL;
416 sc->app_ops = NULL;
417 sockaddr_free(&sc->src);
418 sockaddr_free(&sc->dst);
Christopher Faulet2f35e7b2022-03-31 11:09:28 +0200419
Willy Tarreau0adb2812022-05-27 10:02:48 +0200420 if (sc->wait_event.tasklet)
421 tasklet_free(sc->wait_event.tasklet);
422 sc->wait_event.tasklet = NULL;
423 sc->wait_event.events = 0;
Willy Tarreaue68bc612022-05-27 11:23:05 +0200424 sc_free_cond(scp);
Christopher Fauleteb50c012022-04-21 14:22:53 +0200425}
426
Willy Tarreau4596fe22022-05-17 19:07:51 +0200427/* Destroy the stconn. It is detached from its endpoint and its
428 * application. After this call, the stconn must be considered as released.
Christopher Fauleteb50c012022-04-21 14:22:53 +0200429 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200430void sc_destroy(struct stconn *sc)
Christopher Fauleteb50c012022-04-21 14:22:53 +0200431{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200432 sc_detach_endp(&sc);
433 sc_detach_app(&sc);
434 BUG_ON_HOT(sc);
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100435}
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +0100436
Willy Tarreau4596fe22022-05-17 19:07:51 +0200437/* Resets the stream connector endpoint. It happens when the app layer want to renew
Christopher Faulet9ed77422022-04-12 08:51:15 +0200438 * its endpoint. For a connection retry for instance. If a mux or an applet is
Ilya Shipitsin3b64a282022-07-29 22:26:53 +0500439 * attached, a new endpoint is created. Returns -1 on error and 0 on success.
Christopher Fauleta6c4a482022-04-28 18:25:24 +0200440 *
Willy Tarreaub605c422022-05-17 17:04:55 +0200441 * Only SE_FL_ERROR flag is removed on the endpoint. Orther flags are preserved.
Christopher Fauleta6c4a482022-04-28 18:25:24 +0200442 * It is the caller responsibility to remove other flags if needed.
Christopher Faulet9ed77422022-04-12 08:51:15 +0200443 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200444int sc_reset_endp(struct stconn *sc)
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +0100445{
Willy Tarreau31219282022-05-27 16:21:33 +0200446 struct sedesc *new_sd;
Christopher Fauletb041b232022-03-24 10:27:02 +0100447
Willy Tarreau0adb2812022-05-27 10:02:48 +0200448 BUG_ON(!sc->app);
Christopher Fauleta6c4a482022-04-28 18:25:24 +0200449
Willy Tarreau0adb2812022-05-27 10:02:48 +0200450 sc_ep_clr(sc, SE_FL_ERROR);
451 if (!__sc_endp(sc)) {
Christopher Fauletb041b232022-03-24 10:27:02 +0100452 /* endpoint not attached or attached to a mux with no
453 * target. Thus the endpoint will not be release but just
Willy Tarreau0adb2812022-05-27 10:02:48 +0200454 * reset. The app is still attached, the sc will not be
Christopher Fauleteb50c012022-04-21 14:22:53 +0200455 * released.
Christopher Fauletb041b232022-03-24 10:27:02 +0100456 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200457 sc_detach_endp(&sc);
Christopher Fauletb041b232022-03-24 10:27:02 +0100458 return 0;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +0100459 }
Christopher Fauletb041b232022-03-24 10:27:02 +0100460
461 /* allocate the new endpoint first to be able to set error if it
462 * fails */
Willy Tarreau31219282022-05-27 16:21:33 +0200463 new_sd = sedesc_new();
464 if (!unlikely(new_sd)) {
Willy Tarreau0adb2812022-05-27 10:02:48 +0200465 sc_ep_set(sc, SE_FL_ERROR);
Christopher Fauletb041b232022-03-24 10:27:02 +0100466 return -1;
467 }
468
Willy Tarreau0adb2812022-05-27 10:02:48 +0200469 /* The app is still attached, the sc will not be released */
470 sc_detach_endp(&sc);
Willy Tarreau6a378d12022-08-11 13:56:42 +0200471 BUG_ON(!sc);
Willy Tarreau0adb2812022-05-27 10:02:48 +0200472 BUG_ON(sc->sedesc);
Willy Tarreau31219282022-05-27 16:21:33 +0200473 sc->sedesc = new_sd;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200474 sc->sedesc->sc = sc;
475 sc_ep_set(sc, SE_FL_DETACHED);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +0100476 return 0;
477}
Christopher Faulet37046632022-04-01 11:36:58 +0200478
479
Willy Tarreaue68bc612022-05-27 11:23:05 +0200480/* Create an applet to handle a stream connector as a new appctx. The SC will
Christopher Faulet37046632022-04-01 11:36:58 +0200481 * wake it up every time it is solicited. The appctx must be deleted by the task
Willy Tarreau19c65a92022-05-27 08:49:24 +0200482 * handler using sc_detach_endp(), possibly from within the function itself.
Christopher Faulet37046632022-04-01 11:36:58 +0200483 * It also pre-initializes the applet's context and returns it (or NULL in case
484 * it could not be allocated).
485 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200486struct appctx *sc_applet_create(struct stconn *sc, struct applet *app)
Christopher Faulet37046632022-04-01 11:36:58 +0200487{
488 struct appctx *appctx;
489
Willy Tarreau0adb2812022-05-27 10:02:48 +0200490 appctx = appctx_new_here(app, sc->sedesc);
Christopher Faulet37046632022-04-01 11:36:58 +0200491 if (!appctx)
492 return NULL;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200493 sc_attach_applet(sc, appctx);
494 appctx->t->nice = __sc_strm(sc)->task->nice;
Willy Tarreau90e8b452022-05-25 18:21:43 +0200495 applet_need_more_data(appctx);
Christopher Faulet37046632022-04-01 11:36:58 +0200496 appctx_wakeup(appctx);
Christopher Fauleta33ff7a2022-04-21 11:52:07 +0200497
Willy Tarreau0adb2812022-05-27 10:02:48 +0200498 sc->state = SC_ST_RDY;
Christopher Faulet37046632022-04-01 11:36:58 +0200499 return appctx;
500}
501
Ilya Shipitsin07be66d2023-04-01 12:26:42 +0200502/* Conditionally forward the close to the write side. It return 1 if it can be
Christopher Fauleteb3f26d2023-02-08 16:18:48 +0100503 * forwarded. It is the caller responsibility to forward the close to the write
Christopher Faulet87633c32023-04-03 18:32:50 +0200504 * side. Otherwise, 0 is returned. In this case, SC_FL_SHUTW_NOW flag may be set on
505 * the consumer SC if we are only waiting for the outgoing data to be flushed.
Christopher Fauleteb3f26d2023-02-08 16:18:48 +0100506 */
507static inline int sc_cond_forward_shutw(struct stconn *sc)
508{
509 /* The close must not be forwarded */
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200510 if (!(sc->flags & SC_FL_SHUTR) || !(sc->flags & SC_FL_NOHALF))
Christopher Fauleteb3f26d2023-02-08 16:18:48 +0100511 return 0;
512
513 if (!channel_is_empty(sc_ic(sc))) {
514 /* the close to the write side cannot be forwarded now because
515 * we should flush outgoing data first. But instruct the output
516 * channel it should be done ASAP.
517 */
518 channel_shutw_now(sc_oc(sc));
519 return 0;
520 }
521
522 /* the close can be immediately forwarded to the write side */
523 return 1;
524}
525
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200526/*
Willy Tarreau4596fe22022-05-17 19:07:51 +0200527 * This function performs a shutdown-read on a detached stream connector in a
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200528 * connected or init state (it does nothing for other states). It either shuts
529 * the read side or marks itself as closed. The buffer flags are updated to
Willy Tarreaucb041662022-05-17 19:44:42 +0200530 * reflect the new state. If the stream connector has SC_FL_NOHALF, we also
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200531 * forward the close to the write side. The owner task is woken up if it exists.
532 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200533static void sc_app_shutr(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200534{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200535 struct channel *ic = sc_ic(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200536
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200537 if (sc->flags & SC_FL_SHUTR)
Christopher Fauletc665bb52023-04-04 10:06:57 +0200538 return;
Christopher Faulet87633c32023-04-03 18:32:50 +0200539
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200540 sc->flags |= SC_FL_SHUTR;
Christopher Faulet87633c32023-04-03 18:32:50 +0200541 ic->flags |= CF_READ_EVENT;
Christopher Faulet4c135682023-02-16 11:09:31 +0100542 sc_ep_report_read_activity(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200543
Willy Tarreau0adb2812022-05-27 10:02:48 +0200544 if (!sc_state_in(sc->state, SC_SB_CON|SC_SB_RDY|SC_SB_EST))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200545 return;
546
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200547 if (sc->flags & SC_FL_SHUTW) {
Willy Tarreau0adb2812022-05-27 10:02:48 +0200548 sc->state = SC_ST_DIS;
Christopher Fauletca679922022-07-20 13:24:04 +0200549 if (sc->flags & SC_FL_ISBACK)
550 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200551 }
Christopher Fauleteb3f26d2023-02-08 16:18:48 +0100552 else if (sc_cond_forward_shutw(sc))
Willy Tarreau0adb2812022-05-27 10:02:48 +0200553 return sc_app_shutw(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200554
555 /* note that if the task exists, it must unregister itself once it runs */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200556 if (!(sc->flags & SC_FL_DONT_WAKE))
557 task_wakeup(sc_strm_task(sc), TASK_WOKEN_IO);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200558}
559
560/*
Willy Tarreau4596fe22022-05-17 19:07:51 +0200561 * This function performs a shutdown-write on a detached stream connector in a
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200562 * connected or init state (it does nothing for other states). It either shuts
563 * the write side or marks itself as closed. The buffer flags are updated to
Willy Tarreaue68bc612022-05-27 11:23:05 +0200564 * reflect the new state. It does also close everything if the SC was marked as
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200565 * being in error state. The owner task is woken up if it exists.
566 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200567static void sc_app_shutw(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200568{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200569 struct channel *ic = sc_ic(sc);
570 struct channel *oc = sc_oc(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200571
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200572 sc->flags &= ~SC_FL_SHUTW_NOW;
573 if (sc->flags & SC_FL_SHUTW)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200574 return;
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200575 sc->flags |= SC_FL_SHUTW;
Christopher Faulet87633c32023-04-03 18:32:50 +0200576 oc->flags |= CF_WRITE_EVENT;
Christopher Fauletbcdcfad2023-02-20 08:36:53 +0100577 sc_set_hcto(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200578
Willy Tarreau0adb2812022-05-27 10:02:48 +0200579 switch (sc->state) {
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200580 case SC_ST_RDY:
581 case SC_ST_EST:
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200582 /* we have to shut before closing, otherwise some short messages
583 * may never leave the system, especially when there are remaining
584 * unread data in the socket input buffer, or when nolinger is set.
Willy Tarreaucb041662022-05-17 19:44:42 +0200585 * However, if SC_FL_NOLINGER is explicitly set, we know there is
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200586 * no risk so we close both sides immediately.
587 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200588 if (!sc_ep_test(sc, SE_FL_ERROR) && !(sc->flags & SC_FL_NOLINGER) &&
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200589 !(sc->flags & SC_FL_SHUTR) && !(ic->flags & CF_DONT_READ))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200590 return;
591
Willy Tarreau476c2802022-11-14 07:36:42 +0100592 __fallthrough;
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200593 case SC_ST_CON:
594 case SC_ST_CER:
595 case SC_ST_QUE:
596 case SC_ST_TAR:
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200597 /* Note that none of these states may happen with applets */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200598 sc->state = SC_ST_DIS;
Willy Tarreau476c2802022-11-14 07:36:42 +0100599 __fallthrough;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200600 default:
Willy Tarreau0adb2812022-05-27 10:02:48 +0200601 sc->flags &= ~SC_FL_NOLINGER;
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200602 sc->flags |= SC_FL_SHUTR;
Christopher Fauletca679922022-07-20 13:24:04 +0200603 if (sc->flags & SC_FL_ISBACK)
604 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200605 }
606
607 /* note that if the task exists, it must unregister itself once it runs */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200608 if (!(sc->flags & SC_FL_DONT_WAKE))
609 task_wakeup(sc_strm_task(sc), TASK_WOKEN_IO);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200610}
611
612/* default chk_rcv function for scheduled tasks */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200613static void sc_app_chk_rcv(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200614{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200615 struct channel *ic = sc_ic(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200616
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200617 if (ic->pipe) {
618 /* stop reading */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200619 sc_need_room(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200620 }
621 else {
622 /* (re)start reading */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200623 if (!(sc->flags & SC_FL_DONT_WAKE))
624 task_wakeup(sc_strm_task(sc), TASK_WOKEN_IO);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200625 }
626}
627
628/* default chk_snd function for scheduled tasks */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200629static void sc_app_chk_snd(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200630{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200631 struct channel *oc = sc_oc(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200632
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200633 if (unlikely(sc->state != SC_ST_EST || (sc->flags & SC_FL_SHUTW)))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200634 return;
635
Willy Tarreau0adb2812022-05-27 10:02:48 +0200636 if (!sc_ep_test(sc, SE_FL_WAIT_DATA) || /* not waiting for data */
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200637 channel_is_empty(oc)) /* called with nothing to send ! */
638 return;
639
640 /* Otherwise there are remaining data to be sent in the buffer,
641 * so we tell the handler.
642 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200643 sc_ep_clr(sc, SE_FL_WAIT_DATA);
Willy Tarreau0adb2812022-05-27 10:02:48 +0200644 if (!(sc->flags & SC_FL_DONT_WAKE))
645 task_wakeup(sc_strm_task(sc), TASK_WOKEN_IO);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200646}
647
648/*
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200649 * This function performs a shutdown-read on a stream connector attached to
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200650 * a connection in a connected or init state (it does nothing for other
651 * states). It either shuts the read side or marks itself as closed. The buffer
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200652 * flags are updated to reflect the new state. If the stream connector has
Willy Tarreaucb041662022-05-17 19:44:42 +0200653 * SC_FL_NOHALF, we also forward the close to the write side. If a control
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200654 * layer is defined, then it is supposed to be a socket layer and file
655 * descriptors are then shutdown or closed accordingly. The function
656 * automatically disables polling if needed.
657 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200658static void sc_app_shutr_conn(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200659{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200660 struct channel *ic = sc_ic(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200661
Willy Tarreau0adb2812022-05-27 10:02:48 +0200662 BUG_ON(!sc_conn(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200663
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200664 if (sc->flags & SC_FL_SHUTR)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200665 return;
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200666 sc->flags |= SC_FL_SHUTR;
Christopher Faulet87633c32023-04-03 18:32:50 +0200667 ic->flags |= CF_READ_EVENT;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200668
Willy Tarreau0adb2812022-05-27 10:02:48 +0200669 if (!sc_state_in(sc->state, SC_SB_CON|SC_SB_RDY|SC_SB_EST))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200670 return;
671
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200672 if (sc->flags & SC_FL_SHUTW) {
Willy Tarreau0adb2812022-05-27 10:02:48 +0200673 sc_conn_shut(sc);
674 sc->state = SC_ST_DIS;
Christopher Fauletca679922022-07-20 13:24:04 +0200675 if (sc->flags & SC_FL_ISBACK)
676 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200677 }
Christopher Fauleteb3f26d2023-02-08 16:18:48 +0100678 else if (sc_cond_forward_shutw(sc))
Willy Tarreau0adb2812022-05-27 10:02:48 +0200679 return sc_app_shutw_conn(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200680}
681
682/*
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200683 * This function performs a shutdown-write on a stream connector attached to
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200684 * a connection in a connected or init state (it does nothing for other
685 * states). It either shuts the write side or marks itself as closed. The
686 * buffer flags are updated to reflect the new state. It does also close
Willy Tarreaue68bc612022-05-27 11:23:05 +0200687 * everything if the SC was marked as being in error state. If there is a
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200688 * data-layer shutdown, it is called.
689 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200690static void sc_app_shutw_conn(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200691{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200692 struct channel *ic = sc_ic(sc);
693 struct channel *oc = sc_oc(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200694
Willy Tarreau0adb2812022-05-27 10:02:48 +0200695 BUG_ON(!sc_conn(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200696
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200697 sc->flags &= ~SC_FL_SHUTW_NOW;
698 if (sc->flags & SC_FL_SHUTW)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200699 return;
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200700 sc->flags |= SC_FL_SHUTW;
Christopher Faulet87633c32023-04-03 18:32:50 +0200701 oc->flags |= CF_WRITE_EVENT;
Christopher Fauletbcdcfad2023-02-20 08:36:53 +0100702 sc_set_hcto(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200703
Willy Tarreau0adb2812022-05-27 10:02:48 +0200704 switch (sc->state) {
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200705 case SC_ST_RDY:
706 case SC_ST_EST:
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200707 /* we have to shut before closing, otherwise some short messages
708 * may never leave the system, especially when there are remaining
709 * unread data in the socket input buffer, or when nolinger is set.
Willy Tarreaucb041662022-05-17 19:44:42 +0200710 * However, if SC_FL_NOLINGER is explicitly set, we know there is
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200711 * no risk so we close both sides immediately.
712 */
713
Willy Tarreau0adb2812022-05-27 10:02:48 +0200714 if (sc_ep_test(sc, SE_FL_ERROR)) {
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200715 /* quick close, the socket is already shut anyway */
716 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200717 else if (sc->flags & SC_FL_NOLINGER) {
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200718 /* unclean data-layer shutdown, typically an aborted request
719 * or a forwarded shutdown from a client to a server due to
720 * option abortonclose. No need for the TLS layer to try to
721 * emit a shutdown message.
722 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200723 sc_conn_shutw(sc, CO_SHW_SILENT);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200724 }
725 else {
726 /* clean data-layer shutdown. This only happens on the
727 * frontend side, or on the backend side when forwarding
728 * a client close in TCP mode or in HTTP TUNNEL mode
729 * while option abortonclose is set. We want the TLS
730 * layer to try to signal it to the peer before we close.
731 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200732 sc_conn_shutw(sc, CO_SHW_NORMAL);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200733
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200734 if (!(sc->flags & SC_FL_SHUTR) && !(ic->flags & CF_DONT_READ))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200735 return;
736 }
737
Willy Tarreau476c2802022-11-14 07:36:42 +0100738 __fallthrough;
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200739 case SC_ST_CON:
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200740 /* we may have to close a pending connection, and mark the
741 * response buffer as shutr
742 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200743 sc_conn_shut(sc);
Willy Tarreau476c2802022-11-14 07:36:42 +0100744 __fallthrough;
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200745 case SC_ST_CER:
746 case SC_ST_QUE:
747 case SC_ST_TAR:
Willy Tarreau0adb2812022-05-27 10:02:48 +0200748 sc->state = SC_ST_DIS;
Willy Tarreau476c2802022-11-14 07:36:42 +0100749 __fallthrough;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200750 default:
Willy Tarreau0adb2812022-05-27 10:02:48 +0200751 sc->flags &= ~SC_FL_NOLINGER;
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200752 sc->flags |= SC_FL_SHUTR;
Christopher Fauletca679922022-07-20 13:24:04 +0200753 if (sc->flags & SC_FL_ISBACK)
754 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200755 }
756}
757
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200758/* This function is used for inter-stream connector calls. It is called by the
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200759 * consumer to inform the producer side that it may be interested in checking
760 * for free space in the buffer. Note that it intentionally does not update
761 * timeouts, so that we can still check them later at wake-up. This function is
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200762 * dedicated to connection-based stream connectors.
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200763 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200764static void sc_app_chk_rcv_conn(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200765{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200766 BUG_ON(!sc_conn(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200767
768 /* (re)start reading */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200769 if (sc_state_in(sc->state, SC_SB_CON|SC_SB_RDY|SC_SB_EST))
770 tasklet_wakeup(sc->wait_event.tasklet);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200771}
772
773
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200774/* This function is used for inter-stream connector calls. It is called by the
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200775 * producer to inform the consumer side that it may be interested in checking
776 * for data in the buffer. Note that it intentionally does not update timeouts,
777 * so that we can still check them later at wake-up.
778 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200779static void sc_app_chk_snd_conn(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200780{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200781 struct channel *oc = sc_oc(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200782
Willy Tarreau0adb2812022-05-27 10:02:48 +0200783 BUG_ON(!sc_conn(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200784
Willy Tarreau0adb2812022-05-27 10:02:48 +0200785 if (unlikely(!sc_state_in(sc->state, SC_SB_RDY|SC_SB_EST) ||
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200786 (sc->flags & SC_FL_SHUTW)))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200787 return;
788
789 if (unlikely(channel_is_empty(oc))) /* called with nothing to send ! */
790 return;
791
792 if (!oc->pipe && /* spliced data wants to be forwarded ASAP */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200793 !sc_ep_test(sc, SE_FL_WAIT_DATA)) /* not waiting for data */
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200794 return;
795
Willy Tarreau0adb2812022-05-27 10:02:48 +0200796 if (!(sc->wait_event.events & SUB_RETRY_SEND) && !channel_is_empty(sc_oc(sc)))
797 sc_conn_send(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200798
Willy Tarreau0adb2812022-05-27 10:02:48 +0200799 if (sc_ep_test(sc, SE_FL_ERROR | SE_FL_ERR_PENDING) || sc_is_conn_error(sc)) {
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200800 /* Write error on the file descriptor */
Christopher Faulet7f6aa562022-10-17 10:21:19 +0200801 if (sc->state >= SC_ST_CON && sc_ep_test(sc, SE_FL_EOS))
Willy Tarreau0adb2812022-05-27 10:02:48 +0200802 sc_ep_set(sc, SE_FL_ERROR);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200803 goto out_wakeup;
804 }
805
806 /* OK, so now we know that some data might have been sent, and that we may
807 * have to poll first. We have to do that too if the buffer is not empty.
808 */
809 if (channel_is_empty(oc)) {
810 /* the connection is established but we can't write. Either the
811 * buffer is empty, or we just refrain from sending because the
812 * ->o limit was reached. Maybe we just wrote the last
813 * chunk and need to close.
814 */
Christopher Faulet87633c32023-04-03 18:32:50 +0200815 if ((oc->flags & CF_AUTO_CLOSE) &&
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200816 ((sc->flags & (SC_FL_SHUTW|SC_FL_SHUTW_NOW)) == SC_FL_SHUTW_NOW) &&
Willy Tarreau0adb2812022-05-27 10:02:48 +0200817 sc_state_in(sc->state, SC_SB_RDY|SC_SB_EST)) {
818 sc_shutw(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200819 goto out_wakeup;
820 }
821
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200822 if ((sc->flags & (SC_FL_SHUTW|SC_FL_SHUTW_NOW)) == 0)
Willy Tarreau0adb2812022-05-27 10:02:48 +0200823 sc_ep_set(sc, SE_FL_WAIT_DATA);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200824 }
825 else {
826 /* Otherwise there are remaining data to be sent in the buffer,
827 * which means we have to poll before doing so.
828 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200829 sc_ep_clr(sc, SE_FL_WAIT_DATA);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200830 }
831
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200832 /* in case of special condition (error, shutdown, end of write...), we
833 * have to notify the task.
834 */
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200835 if (likely((sc->flags & SC_FL_SHUTW) ||
Christopher Faulet71c486b2023-02-09 14:14:38 +0100836 ((oc->flags & CF_WRITE_EVENT) && sc->state < SC_ST_EST) ||
837 ((oc->flags & CF_WAKE_WRITE) &&
838 ((channel_is_empty(oc) && !oc->to_forward) ||
839 !sc_state_in(sc->state, SC_SB_EST))))) {
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200840 out_wakeup:
Willy Tarreau0adb2812022-05-27 10:02:48 +0200841 if (!(sc->flags & SC_FL_DONT_WAKE))
842 task_wakeup(sc_strm_task(sc), TASK_WOKEN_IO);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200843 }
844}
845
846/*
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200847 * This function performs a shutdown-read on a stream connector attached to an
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200848 * applet in a connected or init state (it does nothing for other states). It
849 * either shuts the read side or marks itself as closed. The buffer flags are
Willy Tarreaucb041662022-05-17 19:44:42 +0200850 * updated to reflect the new state. If the stream connector has SC_FL_NOHALF,
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200851 * we also forward the close to the write side. The owner task is woken up if
852 * it exists.
853 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200854static void sc_app_shutr_applet(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200855{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200856 struct channel *ic = sc_ic(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200857
Willy Tarreau0adb2812022-05-27 10:02:48 +0200858 BUG_ON(!sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200859
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200860 if (sc->flags & SC_FL_SHUTR)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200861 return;
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200862 sc->flags |= SC_FL_SHUTR;
Christopher Faulet87633c32023-04-03 18:32:50 +0200863 ic->flags |= CF_READ_EVENT;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200864
865 /* Note: on shutr, we don't call the applet */
866
Willy Tarreau0adb2812022-05-27 10:02:48 +0200867 if (!sc_state_in(sc->state, SC_SB_CON|SC_SB_RDY|SC_SB_EST))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200868 return;
869
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200870 if (sc->flags & SC_FL_SHUTW) {
Willy Tarreau0adb2812022-05-27 10:02:48 +0200871 appctx_shut(__sc_appctx(sc));
872 sc->state = SC_ST_DIS;
Christopher Fauletca679922022-07-20 13:24:04 +0200873 if (sc->flags & SC_FL_ISBACK)
874 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200875 }
Christopher Fauleteb3f26d2023-02-08 16:18:48 +0100876 else if (sc_cond_forward_shutw(sc))
Willy Tarreau0adb2812022-05-27 10:02:48 +0200877 return sc_app_shutw_applet(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200878}
879
880/*
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200881 * This function performs a shutdown-write on a stream connector attached to an
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200882 * applet in a connected or init state (it does nothing for other states). It
883 * either shuts the write side or marks itself as closed. The buffer flags are
884 * updated to reflect the new state. It does also close everything if the SI
885 * was marked as being in error state. The owner task is woken up if it exists.
886 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200887static void sc_app_shutw_applet(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200888{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200889 struct channel *ic = sc_ic(sc);
890 struct channel *oc = sc_oc(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200891
Willy Tarreau0adb2812022-05-27 10:02:48 +0200892 BUG_ON(!sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200893
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200894 sc->flags &= ~SC_FL_SHUTW_NOW;
895 if (sc->flags & SC_FL_SHUTW)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200896 return;
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200897 sc->flags |= SC_FL_SHUTW;
Christopher Faulet87633c32023-04-03 18:32:50 +0200898 oc->flags |= CF_WRITE_EVENT;
Christopher Fauletbcdcfad2023-02-20 08:36:53 +0100899 sc_set_hcto(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200900
901 /* on shutw we always wake the applet up */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200902 appctx_wakeup(__sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200903
Willy Tarreau0adb2812022-05-27 10:02:48 +0200904 switch (sc->state) {
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200905 case SC_ST_RDY:
906 case SC_ST_EST:
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200907 /* we have to shut before closing, otherwise some short messages
908 * may never leave the system, especially when there are remaining
909 * unread data in the socket input buffer, or when nolinger is set.
Willy Tarreaucb041662022-05-17 19:44:42 +0200910 * However, if SC_FL_NOLINGER is explicitly set, we know there is
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200911 * no risk so we close both sides immediately.
912 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200913 if (!sc_ep_test(sc, SE_FL_ERROR) && !(sc->flags & SC_FL_NOLINGER) &&
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200914 !(sc->flags & SC_FL_SHUTR) &&
Christopher Faulet87633c32023-04-03 18:32:50 +0200915 !(ic->flags & CF_DONT_READ))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200916 return;
917
Willy Tarreau476c2802022-11-14 07:36:42 +0100918 __fallthrough;
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200919 case SC_ST_CON:
920 case SC_ST_CER:
921 case SC_ST_QUE:
922 case SC_ST_TAR:
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200923 /* Note that none of these states may happen with applets */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200924 appctx_shut(__sc_appctx(sc));
925 sc->state = SC_ST_DIS;
Willy Tarreau476c2802022-11-14 07:36:42 +0100926 __fallthrough;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200927 default:
Willy Tarreau0adb2812022-05-27 10:02:48 +0200928 sc->flags &= ~SC_FL_NOLINGER;
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200929 sc->flags |= SC_FL_SHUTR;
Christopher Fauletca679922022-07-20 13:24:04 +0200930 if (sc->flags & SC_FL_ISBACK)
931 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200932 }
933}
934
935/* chk_rcv function for applets */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200936static void sc_app_chk_rcv_applet(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200937{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200938 struct channel *ic = sc_ic(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200939
Willy Tarreau0adb2812022-05-27 10:02:48 +0200940 BUG_ON(!sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200941
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200942 if (!ic->pipe) {
943 /* (re)start reading */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200944 appctx_wakeup(__sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200945 }
946}
947
948/* chk_snd function for applets */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200949static void sc_app_chk_snd_applet(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200950{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200951 struct channel *oc = sc_oc(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200952
Willy Tarreau0adb2812022-05-27 10:02:48 +0200953 BUG_ON(!sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200954
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200955 if (unlikely(sc->state != SC_ST_EST || (sc->flags & SC_FL_SHUTW)))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200956 return;
957
Christopher Faulet04f03e12022-06-01 17:35:34 +0200958 /* we only wake the applet up if it was waiting for some data and is ready to consume it */
959 if (!sc_ep_test(sc, SE_FL_WAIT_DATA) || sc_ep_test(sc, SE_FL_WONT_CONSUME))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200960 return;
961
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200962 if (!channel_is_empty(oc)) {
963 /* (re)start sending */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200964 appctx_wakeup(__sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200965 }
966}
Christopher Faulet13045f02022-04-01 14:23:38 +0200967
968
969/* This function is designed to be called from within the stream handler to
Willy Tarreau4596fe22022-05-17 19:07:51 +0200970 * update the input channel's expiration timer and the stream connector's
Christopher Faulet13045f02022-04-01 14:23:38 +0200971 * Rx flags based on the channel's flags. It needs to be called only once
972 * after the channel's flags have settled down, and before they are cleared,
973 * though it doesn't harm to call it as often as desired (it just slightly
974 * hurts performance). It must not be called from outside of the stream
975 * handler, as what it does will be used to compute the stream task's
976 * expiration.
977 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200978void sc_update_rx(struct stconn *sc)
Christopher Faulet13045f02022-04-01 14:23:38 +0200979{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200980 struct channel *ic = sc_ic(sc);
Christopher Faulet13045f02022-04-01 14:23:38 +0200981
Christopher Faulet7faac7c2023-04-04 10:05:27 +0200982 if (sc->flags & SC_FL_SHUTR)
Christopher Faulet13045f02022-04-01 14:23:38 +0200983 return;
Christopher Faulet13045f02022-04-01 14:23:38 +0200984
985 /* Read not closed, update FD status and timeout for reads */
986 if (ic->flags & CF_DONT_READ)
Willy Tarreau0adb2812022-05-27 10:02:48 +0200987 sc_wont_read(sc);
Christopher Faulet13045f02022-04-01 14:23:38 +0200988 else
Willy Tarreau0adb2812022-05-27 10:02:48 +0200989 sc_will_read(sc);
Christopher Faulet13045f02022-04-01 14:23:38 +0200990
Willy Tarreau0adb2812022-05-27 10:02:48 +0200991 sc_chk_rcv(sc);
Christopher Faulet13045f02022-04-01 14:23:38 +0200992}
993
994/* This function is designed to be called from within the stream handler to
Willy Tarreau4596fe22022-05-17 19:07:51 +0200995 * update the output channel's expiration timer and the stream connector's
Christopher Faulet13045f02022-04-01 14:23:38 +0200996 * Tx flags based on the channel's flags. It needs to be called only once
997 * after the channel's flags have settled down, and before they are cleared,
998 * though it doesn't harm to call it as often as desired (it just slightly
999 * hurts performance). It must not be called from outside of the stream
1000 * handler, as what it does will be used to compute the stream task's
1001 * expiration.
1002 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001003void sc_update_tx(struct stconn *sc)
Christopher Faulet13045f02022-04-01 14:23:38 +02001004{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001005 struct channel *oc = sc_oc(sc);
Christopher Faulet13045f02022-04-01 14:23:38 +02001006
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001007 if (sc->flags & SC_FL_SHUTW)
Christopher Faulet13045f02022-04-01 14:23:38 +02001008 return;
1009
1010 /* Write not closed, update FD status and timeout for writes */
1011 if (channel_is_empty(oc)) {
1012 /* stop writing */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001013 if (!sc_ep_test(sc, SE_FL_WAIT_DATA)) {
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001014 if ((sc->flags & SC_FL_SHUTW_NOW) == 0)
Willy Tarreau0adb2812022-05-27 10:02:48 +02001015 sc_ep_set(sc, SE_FL_WAIT_DATA);
Christopher Faulet13045f02022-04-01 14:23:38 +02001016 }
1017 return;
1018 }
1019
Christopher Faulet15315d62023-02-20 08:23:51 +01001020 /* (re)start writing */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001021 sc_ep_clr(sc, SE_FL_WAIT_DATA);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001022}
1023
Willy Tarreau19c65a92022-05-27 08:49:24 +02001024/* This function is the equivalent to sc_update() except that it's
Christopher Faulet5e29b762022-04-04 08:58:34 +02001025 * designed to be called from outside the stream handlers, typically the lower
1026 * layers (applets, connections) after I/O completion. After updating the stream
1027 * interface and timeouts, it will try to forward what can be forwarded, then to
1028 * wake the associated task up if an important event requires special handling.
Willy Tarreau15252cd2022-05-25 16:36:21 +02001029 * It may update SE_FL_WAIT_DATA and/or SC_FL_NEED_ROOM, that the callers are
Christopher Faulet5e29b762022-04-04 08:58:34 +02001030 * encouraged to watch to take appropriate action.
Willy Tarreau19c65a92022-05-27 08:49:24 +02001031 * It should not be called from within the stream itself, sc_update()
Christopher Faulet5e29b762022-04-04 08:58:34 +02001032 * is designed for this.
1033 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001034static void sc_notify(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001035{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001036 struct channel *ic = sc_ic(sc);
1037 struct channel *oc = sc_oc(sc);
Willy Tarreaue68bc612022-05-27 11:23:05 +02001038 struct stconn *sco = sc_opposite(sc);
Willy Tarreau0adb2812022-05-27 10:02:48 +02001039 struct task *task = sc_strm_task(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001040
1041 /* process consumer side */
1042 if (channel_is_empty(oc)) {
Willy Tarreau0adb2812022-05-27 10:02:48 +02001043 struct connection *conn = sc_conn(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001044
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001045 if (((sc->flags & (SC_FL_SHUTW|SC_FL_SHUTW_NOW)) == SC_FL_SHUTW_NOW) &&
Willy Tarreau0adb2812022-05-27 10:02:48 +02001046 (sc->state == SC_ST_EST) && (!conn || !(conn->flags & (CO_FL_WAIT_XPRT | CO_FL_EARLY_SSL_HS))))
1047 sc_shutw(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001048 }
1049
1050 /* indicate that we may be waiting for data from the output channel or
Christopher Faulet87633c32023-04-03 18:32:50 +02001051 * we're about to close and can't expect more data if SC_FL_SHUTW_NOW is there.
Christopher Faulet5e29b762022-04-04 08:58:34 +02001052 */
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001053 if (!(sc->flags & (SC_FL_SHUTW|SC_FL_SHUTW_NOW)))
Willy Tarreau0adb2812022-05-27 10:02:48 +02001054 sc_ep_set(sc, SE_FL_WAIT_DATA);
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001055 else if ((sc->flags & (SC_FL_SHUTW|SC_FL_SHUTW_NOW)) == SC_FL_SHUTW_NOW)
Willy Tarreau0adb2812022-05-27 10:02:48 +02001056 sc_ep_clr(sc, SE_FL_WAIT_DATA);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001057
Christopher Faulet5e29b762022-04-04 08:58:34 +02001058 if (oc->flags & CF_DONT_READ)
Willy Tarreaue68bc612022-05-27 11:23:05 +02001059 sc_wont_read(sco);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001060 else
Willy Tarreaue68bc612022-05-27 11:23:05 +02001061 sc_will_read(sco);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001062
1063 /* Notify the other side when we've injected data into the IC that
1064 * needs to be forwarded. We can do fast-forwarding as soon as there
1065 * are output data, but we avoid doing this if some of the data are
1066 * not yet scheduled for being forwarded, because it is very likely
1067 * that it will be done again immediately afterwards once the following
Willy Tarreau15252cd2022-05-25 16:36:21 +02001068 * data are parsed (eg: HTTP chunking). We only clear SC_FL_NEED_ROOM
1069 * once we've emptied *some* of the output buffer, and not just when
1070 * there is available room, because applets are often forced to stop
1071 * before the buffer is full. We must not stop based on input data
1072 * alone because an HTTP parser might need more data to complete the
1073 * parsing.
Christopher Faulet5e29b762022-04-04 08:58:34 +02001074 */
1075 if (!channel_is_empty(ic) &&
Willy Tarreaue68bc612022-05-27 11:23:05 +02001076 sc_ep_test(sco, SE_FL_WAIT_DATA) &&
Christopher Faulet84d3ef92023-03-17 15:45:58 +01001077 (!(sc->flags & SC_FL_SND_EXP_MORE) || c_full(ic) || ci_data(ic) == 0 || ic->pipe)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001078 int new_len, last_len;
1079
1080 last_len = co_data(ic);
1081 if (ic->pipe)
1082 last_len += ic->pipe->data;
1083
Willy Tarreaue68bc612022-05-27 11:23:05 +02001084 sc_chk_snd(sco);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001085
1086 new_len = co_data(ic);
1087 if (ic->pipe)
1088 new_len += ic->pipe->data;
1089
1090 /* check if the consumer has freed some space either in the
1091 * buffer or in the pipe.
1092 */
1093 if (new_len < last_len)
Willy Tarreau0adb2812022-05-27 10:02:48 +02001094 sc_have_room(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001095 }
1096
1097 if (!(ic->flags & CF_DONT_READ))
Willy Tarreau0adb2812022-05-27 10:02:48 +02001098 sc_will_read(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001099
Willy Tarreau0adb2812022-05-27 10:02:48 +02001100 sc_chk_rcv(sc);
Willy Tarreaue68bc612022-05-27 11:23:05 +02001101 sc_chk_rcv(sco);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001102
Christopher Faulet5e29b762022-04-04 08:58:34 +02001103 /* wake the task up only when needed */
Christopher Faulet285f7612022-12-12 08:28:55 +01001104 if (/* changes on the production side that must be handled:
Christopher Faulet2e56a732023-01-26 16:18:09 +01001105 * - An error on receipt: SE_FL_ERROR
Christopher Faulet285f7612022-12-12 08:28:55 +01001106 * - A read event: shutdown for reads (CF_READ_EVENT + SHUTR)
Christopher Faulet904763f2023-03-22 14:53:11 +01001107 * end of input (CF_READ_EVENT + SC_FL_EOI)
Christopher Faulet285f7612022-12-12 08:28:55 +01001108 * data received and no fast-forwarding (CF_READ_EVENT + !to_forward)
1109 * read event while consumer side is not established (CF_READ_EVENT + sco->state != SC_ST_EST)
1110 */
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001111 ((ic->flags & CF_READ_EVENT) && ((sc->flags & SC_FL_EOI) || (sc->flags & SC_FL_SHUTR) || !ic->to_forward || sco->state != SC_ST_EST)) ||
Christopher Faulet2e56a732023-01-26 16:18:09 +01001112 sc_ep_test(sc, SE_FL_ERROR) ||
Christopher Faulet5e29b762022-04-04 08:58:34 +02001113
1114 /* changes on the consumption side */
Christopher Faulet2e56a732023-01-26 16:18:09 +01001115 sc_ep_test(sc, SE_FL_ERR_PENDING) ||
Christopher Fauletd8988412022-12-20 18:10:04 +01001116 ((oc->flags & CF_WRITE_EVENT) &&
1117 ((sc->state < SC_ST_EST) ||
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001118 (sc->flags & SC_FL_SHUTW) ||
Christopher Faulet5e29b762022-04-04 08:58:34 +02001119 (((oc->flags & CF_WAKE_WRITE) ||
Christopher Faulet87633c32023-04-03 18:32:50 +02001120 (!(oc->flags & CF_AUTO_CLOSE) &&
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001121 !(sc->flags & (SC_FL_SHUTW_NOW|SC_FL_SHUTW)))) &&
Christopher Faulet87633c32023-04-03 18:32:50 +02001122 (sco->state != SC_ST_EST ||
1123 (channel_is_empty(oc) && !oc->to_forward)))))) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001124 task_wakeup(task, TASK_WOKEN_IO);
1125 }
Christopher Faulet5e29b762022-04-04 08:58:34 +02001126
Christopher Faulet2e56a732023-01-26 16:18:09 +01001127 if (ic->flags & CF_READ_EVENT)
Christopher Faulet9a790f62023-03-16 14:40:03 +01001128 sc->flags &= ~SC_FL_RCV_ONCE;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001129}
1130
1131/*
1132 * This function propagates a null read received on a socket-based connection.
Willy Tarreaucb041662022-05-17 19:44:42 +02001133 * It updates the stream connector. If the stream connector has SC_FL_NOHALF,
Christopher Faulet5e29b762022-04-04 08:58:34 +02001134 * the close is also forwarded to the write side as an abort.
1135 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001136static void sc_conn_read0(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001137{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001138 struct channel *ic = sc_ic(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001139
Willy Tarreau0adb2812022-05-27 10:02:48 +02001140 BUG_ON(!sc_conn(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001141
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001142 if (sc->flags & SC_FL_SHUTR)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001143 return;
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001144 sc->flags |= SC_FL_SHUTR;
Christopher Faulet87633c32023-04-03 18:32:50 +02001145 ic->flags |= CF_READ_EVENT;
Christopher Faulet4c135682023-02-16 11:09:31 +01001146 sc_ep_report_read_activity(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001147
Willy Tarreau0adb2812022-05-27 10:02:48 +02001148 if (!sc_state_in(sc->state, SC_SB_CON|SC_SB_RDY|SC_SB_EST))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001149 return;
1150
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001151 if (sc->flags & SC_FL_SHUTW)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001152 goto do_close;
1153
Christopher Fauleteb3f26d2023-02-08 16:18:48 +01001154 if (sc_cond_forward_shutw(sc)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001155 /* we want to immediately forward this close to the write side */
1156 /* force flag on ssl to keep stream in cache */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001157 sc_conn_shutw(sc, CO_SHW_SILENT);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001158 goto do_close;
1159 }
1160
1161 /* otherwise that's just a normal read shutdown */
1162 return;
1163
1164 do_close:
Willy Tarreauf61dd192022-05-27 09:00:19 +02001165 /* OK we completely close the socket here just as if we went through sc_shut[rw]() */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001166 sc_conn_shut(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001167
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001168 sc->flags &= ~SC_FL_SHUTW_NOW;
1169 sc->flags |= SC_FL_SHUTW;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001170
Willy Tarreau0adb2812022-05-27 10:02:48 +02001171 sc->state = SC_ST_DIS;
Christopher Fauletca679922022-07-20 13:24:04 +02001172 if (sc->flags & SC_FL_ISBACK)
1173 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001174 return;
1175}
1176
1177/*
1178 * This is the callback which is called by the connection layer to receive data
1179 * into the buffer from the connection. It iterates over the mux layer's
1180 * rcv_buf function.
1181 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001182static int sc_conn_recv(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001183{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001184 struct connection *conn = __sc_conn(sc);
1185 struct channel *ic = sc_ic(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001186 int ret, max, cur_read = 0;
1187 int read_poll = MAX_READ_POLL_LOOPS;
1188 int flags = 0;
1189
1190 /* If not established yet, do nothing. */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001191 if (sc->state != SC_ST_EST)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001192 return 0;
1193
Willy Tarreau462b9892022-05-18 18:06:53 +02001194 /* If another call to sc_conn_recv() failed, and we subscribed to
Christopher Faulet5e29b762022-04-04 08:58:34 +02001195 * recv events already, give up now.
1196 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001197 if (sc->wait_event.events & SUB_RETRY_RECV)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001198 return 0;
1199
1200 /* maybe we were called immediately after an asynchronous shutr */
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001201 if (sc->flags & SC_FL_SHUTR)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001202 return 1;
1203
1204 /* we must wait because the mux is not installed yet */
1205 if (!conn->mux)
1206 return 0;
1207
Christopher Faulet5e29b762022-04-04 08:58:34 +02001208 /* stop immediately on errors. Note that we DON'T want to stop on
1209 * POLL_ERR, as the poller might report a write error while there
1210 * are still data available in the recv buffer. This typically
1211 * happens when we send too large a request to a backend server
1212 * which rejects it before reading it all.
1213 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001214 if (!sc_ep_test(sc, SE_FL_RCV_MORE)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001215 if (!conn_xprt_ready(conn))
1216 return 0;
Willy Tarreau0adb2812022-05-27 10:02:48 +02001217 if (sc_ep_test(sc, SE_FL_ERROR))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001218 goto end_recv;
1219 }
1220
1221 /* prepare to detect if the mux needs more room */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001222 sc_ep_clr(sc, SE_FL_WANT_ROOM);
Christopher Faulet341a5782023-02-10 17:37:11 +01001223 BUG_ON(sc_waiting_room(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001224
1225 if ((ic->flags & (CF_STREAMER | CF_STREAMER_FAST)) && !co_data(ic) &&
1226 global.tune.idle_timer &&
1227 (unsigned short)(now_ms - ic->last_read) >= global.tune.idle_timer) {
1228 /* The buffer was empty and nothing was transferred for more
1229 * than one second. This was caused by a pause and not by
1230 * congestion. Reset any streaming mode to reduce latency.
1231 */
1232 ic->xfer_small = 0;
1233 ic->xfer_large = 0;
1234 ic->flags &= ~(CF_STREAMER | CF_STREAMER_FAST);
1235 }
1236
1237 /* First, let's see if we may splice data across the channel without
1238 * using a buffer.
1239 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001240 if (sc_ep_test(sc, SE_FL_MAY_SPLICE) &&
Christopher Faulet5e29b762022-04-04 08:58:34 +02001241 (ic->pipe || ic->to_forward >= MIN_SPLICE_FORWARD) &&
1242 ic->flags & CF_KERN_SPLICING) {
1243 if (c_data(ic)) {
1244 /* We're embarrassed, there are already data pending in
1245 * the buffer and we don't want to have them at two
1246 * locations at a time. Let's indicate we need some
1247 * place and ask the consumer to hurry.
1248 */
1249 flags |= CO_RFL_BUF_FLUSH;
1250 goto abort_splice;
1251 }
1252
1253 if (unlikely(ic->pipe == NULL)) {
1254 if (pipes_used >= global.maxpipes || !(ic->pipe = get_pipe())) {
1255 ic->flags &= ~CF_KERN_SPLICING;
1256 goto abort_splice;
1257 }
1258 }
1259
Willy Tarreau0adb2812022-05-27 10:02:48 +02001260 ret = conn->mux->rcv_pipe(sc, ic->pipe, ic->to_forward);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001261 if (ret < 0) {
1262 /* splice not supported on this end, let's disable it */
1263 ic->flags &= ~CF_KERN_SPLICING;
1264 goto abort_splice;
1265 }
1266
1267 if (ret > 0) {
1268 if (ic->to_forward != CHN_INFINITE_FORWARD)
1269 ic->to_forward -= ret;
1270 ic->total += ret;
1271 cur_read += ret;
Christopher Faulet285f7612022-12-12 08:28:55 +01001272 ic->flags |= CF_READ_EVENT;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001273 }
1274
Willy Tarreau0adb2812022-05-27 10:02:48 +02001275 if (sc_ep_test(sc, SE_FL_EOS | SE_FL_ERROR))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001276 goto end_recv;
1277
1278 if (conn->flags & CO_FL_WAIT_ROOM) {
1279 /* the pipe is full or we have read enough data that it
1280 * could soon be full. Let's stop before needing to poll.
1281 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001282 sc_need_room(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001283 goto done_recv;
1284 }
1285
1286 /* splice not possible (anymore), let's go on on standard copy */
1287 }
1288
1289 abort_splice:
1290 if (ic->pipe && unlikely(!ic->pipe->data)) {
1291 put_pipe(ic->pipe);
1292 ic->pipe = NULL;
1293 }
1294
Willy Tarreau0adb2812022-05-27 10:02:48 +02001295 if (ic->pipe && ic->to_forward && !(flags & CO_RFL_BUF_FLUSH) && sc_ep_test(sc, SE_FL_MAY_SPLICE)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001296 /* don't break splicing by reading, but still call rcv_buf()
1297 * to pass the flag.
1298 */
1299 goto done_recv;
1300 }
1301
1302 /* now we'll need a input buffer for the stream */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001303 if (!sc_alloc_ibuf(sc, &(__sc_strm(sc)->buffer_wait)))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001304 goto end_recv;
1305
1306 /* For an HTX stream, if the buffer is stuck (no output data with some
1307 * input data) and if the HTX message is fragmented or if its free space
1308 * wraps, we force an HTX deframentation. It is a way to have a
1309 * contiguous free space nad to let the mux to copy as much data as
1310 * possible.
1311 *
1312 * NOTE: A possible optim may be to let the mux decides if defrag is
1313 * required or not, depending on amount of data to be xferred.
1314 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001315 if (IS_HTX_STRM(__sc_strm(sc)) && !co_data(ic)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001316 struct htx *htx = htxbuf(&ic->buf);
1317
1318 if (htx_is_not_empty(htx) && ((htx->flags & HTX_FL_FRAGMENTED) || htx_space_wraps(htx)))
1319 htx_defrag(htx, NULL, 0);
1320 }
1321
1322 /* Instruct the mux it must subscribed for read events */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001323 flags |= ((!conn_is_back(conn) && (__sc_strm(sc)->be->options & PR_O_ABRT_CLOSE)) ? CO_RFL_KEEP_RECV : 0);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001324
1325 /* Important note : if we're called with POLL_IN|POLL_HUP, it means the read polling
1326 * was enabled, which implies that the recv buffer was not full. So we have a guarantee
1327 * that if such an event is not handled above in splice, it will be handled here by
1328 * recv().
1329 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001330 while (sc_ep_test(sc, SE_FL_RCV_MORE) ||
Christopher Faulet5e29b762022-04-04 08:58:34 +02001331 (!(conn->flags & CO_FL_HANDSHAKE) &&
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001332 (!sc_ep_test(sc, SE_FL_ERROR | SE_FL_EOS)) && !(sc->flags & SC_FL_SHUTR))) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001333 int cur_flags = flags;
1334
1335 /* Compute transient CO_RFL_* flags */
1336 if (co_data(ic)) {
1337 cur_flags |= (CO_RFL_BUF_WET | CO_RFL_BUF_NOT_STUCK);
1338 }
1339
1340 /* <max> may be null. This is the mux responsibility to set
Willy Tarreaue68bc612022-05-27 11:23:05 +02001341 * SE_FL_RCV_MORE on the SC if more space is needed.
Christopher Faulet5e29b762022-04-04 08:58:34 +02001342 */
1343 max = channel_recv_max(ic);
Willy Tarreau0adb2812022-05-27 10:02:48 +02001344 ret = conn->mux->rcv_buf(sc, &ic->buf, max, cur_flags);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001345
Willy Tarreau0adb2812022-05-27 10:02:48 +02001346 if (sc_ep_test(sc, SE_FL_WANT_ROOM)) {
Willy Tarreaub605c422022-05-17 17:04:55 +02001347 /* SE_FL_WANT_ROOM must not be reported if the channel's
Christopher Faulet5e29b762022-04-04 08:58:34 +02001348 * buffer is empty.
1349 */
1350 BUG_ON(c_empty(ic));
1351
Willy Tarreau0adb2812022-05-27 10:02:48 +02001352 sc_need_room(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001353 /* Add READ_PARTIAL because some data are pending but
1354 * cannot be xferred to the channel
1355 */
Christopher Faulet285f7612022-12-12 08:28:55 +01001356 ic->flags |= CF_READ_EVENT;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001357 }
1358
1359 if (ret <= 0) {
1360 /* if we refrained from reading because we asked for a
1361 * flush to satisfy rcv_pipe(), we must not subscribe
1362 * and instead report that there's not enough room
1363 * here to proceed.
1364 */
1365 if (flags & CO_RFL_BUF_FLUSH)
Willy Tarreau0adb2812022-05-27 10:02:48 +02001366 sc_need_room(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001367 break;
1368 }
1369
1370 cur_read += ret;
1371
1372 /* if we're allowed to directly forward data, we must update ->o */
Christopher Faulet87633c32023-04-03 18:32:50 +02001373 if (ic->to_forward && !(chn_cons(ic)->flags & (SC_FL_SHUTW|SC_FL_SHUTW_NOW))) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001374 unsigned long fwd = ret;
1375 if (ic->to_forward != CHN_INFINITE_FORWARD) {
1376 if (fwd > ic->to_forward)
1377 fwd = ic->to_forward;
1378 ic->to_forward -= fwd;
1379 }
1380 c_adv(ic, fwd);
1381 }
1382
Christopher Faulet285f7612022-12-12 08:28:55 +01001383 ic->flags |= CF_READ_EVENT;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001384 ic->total += ret;
1385
1386 /* End-of-input reached, we can leave. In this case, it is
Willy Tarreaue68bc612022-05-27 11:23:05 +02001387 * important to break the loop to not block the SC because of
Christopher Faulet5e29b762022-04-04 08:58:34 +02001388 * the channel's policies.This way, we are still able to receive
1389 * shutdowns.
1390 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001391 if (sc_ep_test(sc, SE_FL_EOI))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001392 break;
1393
Christopher Faulet9a790f62023-03-16 14:40:03 +01001394 if ((sc->flags & SC_FL_RCV_ONCE) || --read_poll <= 0) {
1395 /* we don't expect to read more data */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001396 sc_wont_read(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001397 break;
1398 }
1399
1400 /* if too many bytes were missing from last read, it means that
1401 * it's pointless trying to read again because the system does
1402 * not have them in buffers.
1403 */
1404 if (ret < max) {
1405 /* if a streamer has read few data, it may be because we
1406 * have exhausted system buffers. It's not worth trying
1407 * again.
1408 */
1409 if (ic->flags & CF_STREAMER) {
1410 /* we're stopped by the channel's policy */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001411 sc_wont_read(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001412 break;
1413 }
1414
1415 /* if we read a large block smaller than what we requested,
1416 * it's almost certain we'll never get anything more.
1417 */
1418 if (ret >= global.tune.recv_enough) {
1419 /* we're stopped by the channel's policy */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001420 sc_wont_read(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001421 break;
1422 }
1423 }
1424
1425 /* if we are waiting for more space, don't try to read more data
1426 * right now.
1427 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001428 if (sc->flags & (SC_FL_WONT_READ|SC_FL_NEED_BUFF|SC_FL_NEED_ROOM))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001429 break;
1430 } /* while !flags */
1431
1432 done_recv:
1433 if (cur_read) {
1434 if ((ic->flags & (CF_STREAMER | CF_STREAMER_FAST)) &&
1435 (cur_read <= ic->buf.size / 2)) {
1436 ic->xfer_large = 0;
1437 ic->xfer_small++;
1438 if (ic->xfer_small >= 3) {
1439 /* we have read less than half of the buffer in
1440 * one pass, and this happened at least 3 times.
1441 * This is definitely not a streamer.
1442 */
1443 ic->flags &= ~(CF_STREAMER | CF_STREAMER_FAST);
1444 }
1445 else if (ic->xfer_small >= 2) {
1446 /* if the buffer has been at least half full twice,
1447 * we receive faster than we send, so at least it
1448 * is not a "fast streamer".
1449 */
1450 ic->flags &= ~CF_STREAMER_FAST;
1451 }
1452 }
1453 else if (!(ic->flags & CF_STREAMER_FAST) &&
1454 (cur_read >= ic->buf.size - global.tune.maxrewrite)) {
1455 /* we read a full buffer at once */
1456 ic->xfer_small = 0;
1457 ic->xfer_large++;
1458 if (ic->xfer_large >= 3) {
1459 /* we call this buffer a fast streamer if it manages
1460 * to be filled in one call 3 consecutive times.
1461 */
1462 ic->flags |= (CF_STREAMER | CF_STREAMER_FAST);
1463 }
1464 }
1465 else {
1466 ic->xfer_small = 0;
1467 ic->xfer_large = 0;
1468 }
1469 ic->last_read = now_ms;
Christopher Faulet4c135682023-02-16 11:09:31 +01001470 sc_ep_report_read_activity(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001471 }
1472
1473 end_recv:
1474 ret = (cur_read != 0);
1475
1476 /* Report EOI on the channel if it was reached from the mux point of
1477 * view. */
Christopher Faulet904763f2023-03-22 14:53:11 +01001478 if (sc_ep_test(sc, SE_FL_EOI) && !(sc->flags & SC_FL_EOI)) {
Christopher Faulet4c135682023-02-16 11:09:31 +01001479 sc_ep_report_read_activity(sc);
Christopher Faulet904763f2023-03-22 14:53:11 +01001480 sc->flags |= SC_FL_EOI;
1481 ic->flags |= CF_READ_EVENT;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001482 ret = 1;
1483 }
1484
Christopher Fauletb208d8c2023-03-21 11:25:21 +01001485 if (sc_ep_test(sc, SE_FL_EOS)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001486 /* we received a shutdown */
Christopher Faulet5e29b762022-04-04 08:58:34 +02001487 if (ic->flags & CF_AUTO_CLOSE)
1488 channel_shutw_now(ic);
Willy Tarreau0adb2812022-05-27 10:02:48 +02001489 sc_conn_read0(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001490 ret = 1;
1491 }
Christopher Fauletb208d8c2023-03-21 11:25:21 +01001492
1493 if (sc_ep_test(sc, SE_FL_ERROR))
1494 ret = 1;
Willy Tarreau0adb2812022-05-27 10:02:48 +02001495 else if (!(sc->flags & (SC_FL_WONT_READ|SC_FL_NEED_BUFF|SC_FL_NEED_ROOM)) &&
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001496 !(sc->flags & SC_FL_SHUTR)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001497 /* Subscribe to receive events if we're blocking on I/O */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001498 conn->mux->subscribe(sc, SUB_RETRY_RECV, &sc->wait_event);
1499 se_have_no_more_data(sc->sedesc);
Christopher Fauletb208d8c2023-03-21 11:25:21 +01001500 }
1501 else {
Willy Tarreau0adb2812022-05-27 10:02:48 +02001502 se_have_more_data(sc->sedesc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001503 ret = 1;
1504 }
1505 return ret;
1506}
1507
Willy Tarreau4596fe22022-05-17 19:07:51 +02001508/* This tries to perform a synchronous receive on the stream connector to
Christopher Faulet5e29b762022-04-04 08:58:34 +02001509 * try to collect last arrived data. In practice it's only implemented on
Willy Tarreau4596fe22022-05-17 19:07:51 +02001510 * stconns. Returns 0 if nothing was done, non-zero if new data or a
Christopher Faulet5e29b762022-04-04 08:58:34 +02001511 * shutdown were collected. This may result on some delayed receive calls
1512 * to be programmed and performed later, though it doesn't provide any
1513 * such guarantee.
1514 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001515int sc_conn_sync_recv(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001516{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001517 if (!sc_state_in(sc->state, SC_SB_RDY|SC_SB_EST))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001518 return 0;
1519
Willy Tarreau0adb2812022-05-27 10:02:48 +02001520 if (!sc_mux_ops(sc))
Willy Tarreau4596fe22022-05-17 19:07:51 +02001521 return 0; // only stconns are supported
Christopher Faulet5e29b762022-04-04 08:58:34 +02001522
Willy Tarreau0adb2812022-05-27 10:02:48 +02001523 if (sc->wait_event.events & SUB_RETRY_RECV)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001524 return 0; // already subscribed
1525
Willy Tarreau0adb2812022-05-27 10:02:48 +02001526 if (!sc_is_recv_allowed(sc))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001527 return 0; // already failed
1528
Willy Tarreau0adb2812022-05-27 10:02:48 +02001529 return sc_conn_recv(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001530}
1531
1532/*
1533 * This function is called to send buffer data to a stream socket.
1534 * It calls the mux layer's snd_buf function. It relies on the
1535 * caller to commit polling changes. The caller should check conn->flags
1536 * for errors.
1537 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001538static int sc_conn_send(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001539{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001540 struct connection *conn = __sc_conn(sc);
Christopher Faulet904763f2023-03-22 14:53:11 +01001541 struct stconn *sco = sc_opposite(sc);
Willy Tarreau0adb2812022-05-27 10:02:48 +02001542 struct stream *s = __sc_strm(sc);
1543 struct channel *oc = sc_oc(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001544 int ret;
1545 int did_send = 0;
1546
Willy Tarreau0adb2812022-05-27 10:02:48 +02001547 if (sc_ep_test(sc, SE_FL_ERROR | SE_FL_ERR_PENDING) || sc_is_conn_error(sc)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001548 /* We're probably there because the tasklet was woken up,
1549 * but process_stream() ran before, detected there were an
Willy Tarreaue68bc612022-05-27 11:23:05 +02001550 * error and put the SC back to SC_ST_TAR. There's still
Christopher Faulet5e29b762022-04-04 08:58:34 +02001551 * CO_FL_ERROR on the connection but we don't want to add
Willy Tarreaub605c422022-05-17 17:04:55 +02001552 * SE_FL_ERROR back, so give up
Christopher Faulet5e29b762022-04-04 08:58:34 +02001553 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001554 if (sc->state < SC_ST_CON)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001555 return 0;
Christopher Faulet7f6aa562022-10-17 10:21:19 +02001556 if (sc_ep_test(sc, SE_FL_EOS))
1557 sc_ep_set(sc, SE_FL_ERROR);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001558 return 1;
1559 }
1560
1561 /* We're already waiting to be able to send, give up */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001562 if (sc->wait_event.events & SUB_RETRY_SEND)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001563 return 0;
1564
1565 /* we might have been called just after an asynchronous shutw */
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001566 if (sc->flags & SC_FL_SHUTW)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001567 return 1;
1568
1569 /* we must wait because the mux is not installed yet */
1570 if (!conn->mux)
1571 return 0;
1572
1573 if (oc->pipe && conn->xprt->snd_pipe && conn->mux->snd_pipe) {
Willy Tarreau0adb2812022-05-27 10:02:48 +02001574 ret = conn->mux->snd_pipe(sc, oc->pipe);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001575 if (ret > 0)
1576 did_send = 1;
1577
1578 if (!oc->pipe->data) {
1579 put_pipe(oc->pipe);
1580 oc->pipe = NULL;
1581 }
1582
1583 if (oc->pipe)
1584 goto end;
1585 }
1586
1587 /* At this point, the pipe is empty, but we may still have data pending
1588 * in the normal buffer.
1589 */
1590 if (co_data(oc)) {
1591 /* when we're here, we already know that there is no spliced
1592 * data left, and that there are sendable buffered data.
1593 */
1594
1595 /* check if we want to inform the kernel that we're interested in
1596 * sending more data after this call. We want this if :
1597 * - we're about to close after this last send and want to merge
1598 * the ongoing FIN with the last segment.
1599 * - we know we can't send everything at once and must get back
1600 * here because of unaligned data
1601 * - there is still a finite amount of data to forward
1602 * The test is arranged so that the most common case does only 2
1603 * tests.
1604 */
1605 unsigned int send_flag = 0;
1606
Christopher Faulet68ef2182023-03-17 15:38:18 +01001607 if ((!(sc->flags & (SC_FL_SND_ASAP|SC_FL_SND_NEVERWAIT)) &&
Christopher Faulet5e29b762022-04-04 08:58:34 +02001608 ((oc->to_forward && oc->to_forward != CHN_INFINITE_FORWARD) ||
Christopher Faulet84d3ef92023-03-17 15:45:58 +01001609 (sc->flags & SC_FL_SND_EXP_MORE) ||
Christopher Faulet5e29b762022-04-04 08:58:34 +02001610 (IS_HTX_STRM(s) &&
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001611 (!(sco->flags & (SC_FL_EOI|SC_FL_SHUTR)) && htx_expect_more(htxbuf(&oc->buf)))))) ||
Christopher Faulet5e29b762022-04-04 08:58:34 +02001612 ((oc->flags & CF_ISRESP) &&
Christopher Faulet87633c32023-04-03 18:32:50 +02001613 (oc->flags & CF_AUTO_CLOSE) &&
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001614 (sc->flags & SC_FL_SHUTW_NOW)))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001615 send_flag |= CO_SFL_MSG_MORE;
1616
1617 if (oc->flags & CF_STREAMER)
1618 send_flag |= CO_SFL_STREAMER;
1619
1620 if (s->txn && s->txn->flags & TX_L7_RETRY && !b_data(&s->txn->l7_buffer)) {
1621 /* If we want to be able to do L7 retries, copy
1622 * the data we're about to send, so that we are able
1623 * to resend them if needed
1624 */
1625 /* Try to allocate a buffer if we had none.
1626 * If it fails, the next test will just
1627 * disable the l7 retries by setting
1628 * l7_conn_retries to 0.
1629 */
1630 if (s->txn->req.msg_state != HTTP_MSG_DONE)
1631 s->txn->flags &= ~TX_L7_RETRY;
1632 else {
1633 if (b_alloc(&s->txn->l7_buffer) == NULL)
1634 s->txn->flags &= ~TX_L7_RETRY;
1635 else {
1636 memcpy(b_orig(&s->txn->l7_buffer),
1637 b_orig(&oc->buf),
1638 b_size(&oc->buf));
1639 s->txn->l7_buffer.head = co_data(oc);
1640 b_add(&s->txn->l7_buffer, co_data(oc));
1641 }
1642
1643 }
1644 }
1645
Willy Tarreau0adb2812022-05-27 10:02:48 +02001646 ret = conn->mux->snd_buf(sc, &oc->buf, co_data(oc), send_flag);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001647 if (ret > 0) {
1648 did_send = 1;
1649 c_rew(oc, ret);
1650 c_realign_if_empty(oc);
1651
1652 if (!co_data(oc)) {
1653 /* Always clear both flags once everything has been sent, they're one-shot */
Christopher Faulet84d3ef92023-03-17 15:45:58 +01001654 sc->flags &= ~(SC_FL_SND_ASAP|SC_FL_SND_EXP_MORE);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001655 }
1656 /* if some data remain in the buffer, it's only because the
1657 * system buffers are full, we will try next time.
1658 */
Christopher Faulet13045f02022-04-01 14:23:38 +02001659 }
1660 }
Christopher Faulet5e29b762022-04-04 08:58:34 +02001661
1662 end:
1663 if (did_send) {
Christopher Fauletd8988412022-12-20 18:10:04 +01001664 oc->flags |= CF_WRITE_EVENT | CF_WROTE_DATA;
Willy Tarreau0adb2812022-05-27 10:02:48 +02001665 if (sc->state == SC_ST_CON)
1666 sc->state = SC_ST_RDY;
Willy Tarreau0adb2812022-05-27 10:02:48 +02001667 sc_have_room(sc_opposite(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001668 }
1669
Willy Tarreau0adb2812022-05-27 10:02:48 +02001670 if (sc_ep_test(sc, SE_FL_ERROR | SE_FL_ERR_PENDING)) {
Christopher Faulet2e56a732023-01-26 16:18:09 +01001671 oc->flags |= CF_WRITE_EVENT;
Christopher Faulet7f6aa562022-10-17 10:21:19 +02001672 if (sc_ep_test(sc, SE_FL_EOS))
Christopher Faulet2e56a732023-01-26 16:18:09 +01001673 sc_ep_set(sc, SE_FL_ERROR);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001674 return 1;
1675 }
1676
Christopher Faulet59b240c2023-02-27 16:38:12 +01001677 if (channel_is_empty(oc))
1678 sc_ep_report_send_activity(sc);
1679 else {
1680 /* We couldn't send all of our data, let the mux know we'd like to send more */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001681 conn->mux->subscribe(sc, SUB_RETRY_SEND, &sc->wait_event);
Christopher Faulet59b240c2023-02-27 16:38:12 +01001682 sc_ep_report_blocked_send(sc);
1683 }
1684
Christopher Faulet5e29b762022-04-04 08:58:34 +02001685 return did_send;
1686}
1687
Christopher Fauletd8988412022-12-20 18:10:04 +01001688/* perform a synchronous send() for the stream connector. The CF_WRITE_EVENT
1689 * flag are cleared prior to the attempt, and will possibly be updated in case
1690 * of success.
Christopher Faulet5e29b762022-04-04 08:58:34 +02001691 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001692void sc_conn_sync_send(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001693{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001694 struct channel *oc = sc_oc(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001695
Christopher Fauletd8988412022-12-20 18:10:04 +01001696 oc->flags &= ~CF_WRITE_EVENT;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001697
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001698 if (sc->flags & SC_FL_SHUTW)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001699 return;
1700
1701 if (channel_is_empty(oc))
1702 return;
1703
Willy Tarreau0adb2812022-05-27 10:02:48 +02001704 if (!sc_state_in(sc->state, SC_SB_CON|SC_SB_RDY|SC_SB_EST))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001705 return;
1706
Willy Tarreau0adb2812022-05-27 10:02:48 +02001707 if (!sc_mux_ops(sc))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001708 return;
1709
Willy Tarreau0adb2812022-05-27 10:02:48 +02001710 sc_conn_send(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001711}
1712
1713/* Called by I/O handlers after completion.. It propagates
Willy Tarreau4596fe22022-05-17 19:07:51 +02001714 * connection flags to the stream connector, updates the stream (which may or
Christopher Faulet5e29b762022-04-04 08:58:34 +02001715 * may not take this opportunity to try to forward data), then update the
Willy Tarreau4596fe22022-05-17 19:07:51 +02001716 * connection's polling based on the channels and stream connector's final
Christopher Faulet5e29b762022-04-04 08:58:34 +02001717 * states. The function always returns 0.
1718 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001719static int sc_conn_process(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001720{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001721 struct connection *conn = __sc_conn(sc);
1722 struct channel *ic = sc_ic(sc);
1723 struct channel *oc = sc_oc(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001724
1725 BUG_ON(!conn);
1726
1727 /* If we have data to send, try it now */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001728 if (!channel_is_empty(oc) && !(sc->wait_event.events & SUB_RETRY_SEND))
1729 sc_conn_send(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001730
Willy Tarreau4596fe22022-05-17 19:07:51 +02001731 /* First step, report to the stream connector what was detected at the
Christopher Faulet5e29b762022-04-04 08:58:34 +02001732 * connection layer : errors and connection establishment.
Willy Tarreaub605c422022-05-17 17:04:55 +02001733 * Only add SE_FL_ERROR if we're connected, or we're attempting to
Christopher Faulet5e29b762022-04-04 08:58:34 +02001734 * connect, we may get there because we got woken up, but only run
1735 * after process_stream() noticed there were an error, and decided
1736 * to retry to connect, the connection may still have CO_FL_ERROR,
Willy Tarreaub605c422022-05-17 17:04:55 +02001737 * and we don't want to add SE_FL_ERROR back
Christopher Faulet5e29b762022-04-04 08:58:34 +02001738 *
Willy Tarreau462b9892022-05-18 18:06:53 +02001739 * Note: This test is only required because sc_conn_process is also the SI
1740 * wake callback. Otherwise sc_conn_recv()/sc_conn_send() already take
Christopher Faulet5e29b762022-04-04 08:58:34 +02001741 * care of it.
1742 */
1743
Willy Tarreau0adb2812022-05-27 10:02:48 +02001744 if (sc->state >= SC_ST_CON) {
1745 if (sc_is_conn_error(sc))
1746 sc_ep_set(sc, SE_FL_ERROR);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001747 }
1748
1749 /* If we had early data, and the handshake ended, then
1750 * we can remove the flag, and attempt to wake the task up,
1751 * in the event there's an analyser waiting for the end of
1752 * the handshake.
1753 */
1754 if (!(conn->flags & (CO_FL_WAIT_XPRT | CO_FL_EARLY_SSL_HS)) &&
Willy Tarreau0adb2812022-05-27 10:02:48 +02001755 sc_ep_test(sc, SE_FL_WAIT_FOR_HS)) {
1756 sc_ep_clr(sc, SE_FL_WAIT_FOR_HS);
1757 task_wakeup(sc_strm_task(sc), TASK_WOKEN_MSG);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001758 }
1759
Willy Tarreau0adb2812022-05-27 10:02:48 +02001760 if (!sc_state_in(sc->state, SC_SB_EST|SC_SB_DIS|SC_SB_CLO) &&
Christopher Faulet5e29b762022-04-04 08:58:34 +02001761 (conn->flags & CO_FL_WAIT_XPRT) == 0) {
Christopher Fauletca679922022-07-20 13:24:04 +02001762 if (sc->flags & SC_FL_ISBACK)
1763 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Fauletb96f2aa2022-12-12 08:11:36 +01001764 oc->flags |= CF_WRITE_EVENT;
Willy Tarreau0adb2812022-05-27 10:02:48 +02001765 if (sc->state == SC_ST_CON)
1766 sc->state = SC_ST_RDY;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001767 }
1768
1769 /* Report EOS on the channel if it was reached from the mux point of
1770 * view.
1771 *
Willy Tarreau462b9892022-05-18 18:06:53 +02001772 * Note: This test is only required because sc_conn_process is also the SI
1773 * wake callback. Otherwise sc_conn_recv()/sc_conn_send() already take
Christopher Faulet5e29b762022-04-04 08:58:34 +02001774 * care of it.
1775 */
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001776 if (sc_ep_test(sc, SE_FL_EOS) && !(sc->flags & SC_FL_SHUTR)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001777 /* we received a shutdown */
Christopher Faulet5e29b762022-04-04 08:58:34 +02001778 if (ic->flags & CF_AUTO_CLOSE)
1779 channel_shutw_now(ic);
Willy Tarreau0adb2812022-05-27 10:02:48 +02001780 sc_conn_read0(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001781 }
1782
1783 /* Report EOI on the channel if it was reached from the mux point of
1784 * view.
1785 *
Willy Tarreau462b9892022-05-18 18:06:53 +02001786 * Note: This test is only required because sc_conn_process is also the SI
1787 * wake callback. Otherwise sc_conn_recv()/sc_conn_send() already take
Christopher Faulet5e29b762022-04-04 08:58:34 +02001788 * care of it.
1789 */
Christopher Faulet904763f2023-03-22 14:53:11 +01001790 if (sc_ep_test(sc, SE_FL_EOI) && !(sc->flags & SC_FL_EOI)) {
1791 sc->flags |= SC_FL_EOI;
1792 ic->flags |= CF_READ_EVENT;
1793 }
Christopher Faulet5e29b762022-04-04 08:58:34 +02001794
Willy Tarreau4596fe22022-05-17 19:07:51 +02001795 /* Second step : update the stream connector and channels, try to forward any
Christopher Faulet5e29b762022-04-04 08:58:34 +02001796 * pending data, then possibly wake the stream up based on the new
Willy Tarreau4596fe22022-05-17 19:07:51 +02001797 * stream connector status.
Christopher Faulet5e29b762022-04-04 08:58:34 +02001798 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001799 sc_notify(sc);
1800 stream_release_buffers(__sc_strm(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001801 return 0;
1802}
1803
Willy Tarreau4596fe22022-05-17 19:07:51 +02001804/* This is the ->process() function for any stream connector's wait_event task.
1805 * It's assigned during the stream connector's initialization, for any type of
1806 * stream connector. Thus it is always safe to perform a tasklet_wakeup() on a
Willy Tarreaue68bc612022-05-27 11:23:05 +02001807 * stream connector, as the presence of the SC is checked there.
Christopher Faulet5e29b762022-04-04 08:58:34 +02001808 */
Willy Tarreau462b9892022-05-18 18:06:53 +02001809struct task *sc_conn_io_cb(struct task *t, void *ctx, unsigned int state)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001810{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001811 struct stconn *sc = ctx;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001812 int ret = 0;
1813
Willy Tarreau0adb2812022-05-27 10:02:48 +02001814 if (!sc_conn(sc))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001815 return t;
1816
Willy Tarreau0adb2812022-05-27 10:02:48 +02001817 if (!(sc->wait_event.events & SUB_RETRY_SEND) && !channel_is_empty(sc_oc(sc)))
1818 ret = sc_conn_send(sc);
1819 if (!(sc->wait_event.events & SUB_RETRY_RECV))
1820 ret |= sc_conn_recv(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001821 if (ret != 0)
Willy Tarreau0adb2812022-05-27 10:02:48 +02001822 sc_conn_process(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001823
Willy Tarreau0adb2812022-05-27 10:02:48 +02001824 stream_release_buffers(__sc_strm(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001825 return t;
1826}
1827
1828/* Callback to be used by applet handlers upon completion. It updates the stream
1829 * (which may or may not take this opportunity to try to forward data), then
Willy Tarreau4596fe22022-05-17 19:07:51 +02001830 * may re-enable the applet's based on the channels and stream connector's final
Christopher Faulet5e29b762022-04-04 08:58:34 +02001831 * states.
1832 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001833static int sc_applet_process(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001834{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001835 struct channel *ic = sc_ic(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001836
Willy Tarreau0adb2812022-05-27 10:02:48 +02001837 BUG_ON(!sc_appctx(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001838
Christopher Fauletf8fbb6d2023-03-21 11:49:21 +01001839 /* Report EOI on the channel if it was reached from the applet point of
1840 * view. */
Christopher Faulet904763f2023-03-22 14:53:11 +01001841 if (sc_ep_test(sc, SE_FL_EOI) && !(sc->flags & SC_FL_EOI)) {
Christopher Fauletf8fbb6d2023-03-21 11:49:21 +01001842 sc_ep_report_read_activity(sc);
Christopher Faulet904763f2023-03-22 14:53:11 +01001843 sc->flags |= SC_FL_EOI;
1844 ic->flags |= CF_READ_EVENT;
Christopher Fauletf8fbb6d2023-03-21 11:49:21 +01001845 }
1846
Christopher Faulet0ffc9d72023-03-21 14:19:08 +01001847 if (sc_ep_test(sc, SE_FL_EOS)) {
1848 /* we received a shutdown */
1849 sc_shutr(sc);
1850 }
1851
Christopher Faulet5e29b762022-04-04 08:58:34 +02001852 /* If the applet wants to write and the channel is closed, it's a
1853 * broken pipe and it must be reported.
1854 */
Christopher Faulet7faac7c2023-04-04 10:05:27 +02001855 if (!sc_ep_test(sc, SE_FL_HAVE_NO_DATA) && (sc->flags & SC_FL_SHUTR))
Willy Tarreau0adb2812022-05-27 10:02:48 +02001856 sc_ep_set(sc, SE_FL_ERROR);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001857
1858 /* automatically mark the applet having data available if it reported
1859 * begin blocked by the channel.
1860 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001861 if ((sc->flags & (SC_FL_WONT_READ|SC_FL_NEED_BUFF|SC_FL_NEED_ROOM)) ||
1862 sc_ep_test(sc, SE_FL_APPLET_NEED_CONN))
1863 applet_have_more_data(__sc_appctx(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001864
Willy Tarreau4596fe22022-05-17 19:07:51 +02001865 /* update the stream connector, channels, and possibly wake the stream up */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001866 sc_notify(sc);
1867 stream_release_buffers(__sc_strm(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001868
Willy Tarreau19c65a92022-05-27 08:49:24 +02001869 /* sc_notify may have passed through chk_snd and released some blocking
Willy Tarreau15252cd2022-05-25 16:36:21 +02001870 * flags. Process_stream will consider those flags to wake up the
Christopher Faulet5e29b762022-04-04 08:58:34 +02001871 * appctx but in the case the task is not in runqueue we may have to
1872 * wakeup the appctx immediately.
1873 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001874 if (sc_is_recv_allowed(sc) || sc_is_send_allowed(sc))
1875 appctx_wakeup(__sc_appctx(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001876 return 0;
Christopher Faulet13045f02022-04-01 14:23:38 +02001877}
Christopher Fauletb68f77d2022-06-16 16:24:16 +02001878
1879
1880/* Prepares an endpoint upgrade. We don't now at this stage if the upgrade will
1881 * succeed or not and if the stconn will be reused by the new endpoint. Thus,
1882 * for now, only pretend the stconn is detached.
1883 */
1884void sc_conn_prepare_endp_upgrade(struct stconn *sc)
1885{
1886 BUG_ON(!sc_conn(sc) || !sc->app);
1887 sc_ep_clr(sc, SE_FL_T_MUX);
1888 sc_ep_set(sc, SE_FL_DETACHED);
1889}
1890
Ilya Shipitsin3b64a282022-07-29 22:26:53 +05001891/* Endpoint upgrade failed. Restore the stconn state. */
Christopher Fauletb68f77d2022-06-16 16:24:16 +02001892void sc_conn_abort_endp_upgrade(struct stconn *sc)
1893{
1894 sc_ep_set(sc, SE_FL_T_MUX);
1895 sc_ep_clr(sc, SE_FL_DETACHED);
1896}
1897
1898/* Commit the endpoint upgrade. If stconn is attached, it means the new endpoint
1899 * use it. So we do nothing. Otherwise, the stconn will be destroy with the
1900 * overlying stream. So, it means we must commit the detach.
1901*/
1902void sc_conn_commit_endp_upgrade(struct stconn *sc)
1903{
1904 if (!sc_ep_test(sc, SE_FL_DETACHED))
1905 return;
1906 sc_detach_endp(&sc);
1907 /* Because it was already set as detached, the sedesc must be preserved */
Willy Tarreau6a378d12022-08-11 13:56:42 +02001908 BUG_ON(!sc);
Christopher Fauletb68f77d2022-06-16 16:24:16 +02001909 BUG_ON(!sc->sedesc);
1910}