blob: 36d19b46fea4821e71d77a49a22b65ee584826d6 [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;
Willy Tarreauea59b022022-05-17 17:53:22 +020095 se_fl_setall(sedesc, SE_FL_NONE);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +010096}
97
Christopher Faulet9ed77422022-04-12 08:51:15 +020098/* Tries to alloc an endpoint and initialize it. Returns NULL on failure. */
Willy Tarreauea59b022022-05-17 17:53:22 +020099struct sedesc *sedesc_new()
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100100{
Willy Tarreauea59b022022-05-17 17:53:22 +0200101 struct sedesc *sedesc;
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100102
Willy Tarreauea59b022022-05-17 17:53:22 +0200103 sedesc = pool_alloc(pool_head_sedesc);
104 if (unlikely(!sedesc))
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100105 return NULL;
106
Willy Tarreauea59b022022-05-17 17:53:22 +0200107 sedesc_init(sedesc);
108 return sedesc;
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100109}
110
Christopher Faulet9ed77422022-04-12 08:51:15 +0200111/* Releases an endpoint. It is the caller responsibility to be sure it is safe
112 * and it is not shared with another entity
113 */
Willy Tarreauea59b022022-05-17 17:53:22 +0200114void sedesc_free(struct sedesc *sedesc)
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100115{
Willy Tarreauea59b022022-05-17 17:53:22 +0200116 pool_free(pool_head_sedesc, sedesc);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100117}
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100118
Willy Tarreau4596fe22022-05-17 19:07:51 +0200119/* Tries to allocate a new stconn and initialize its main fields. On
Christopher Faulet9ed77422022-04-12 08:51:15 +0200120 * failure, nothing is allocated and NULL is returned. It is an internal
Willy Tarreaub605c422022-05-17 17:04:55 +0200121 * function. The caller must, at least, set the SE_FL_ORPHAN or SE_FL_DETACHED
Christopher Faulet9ed77422022-04-12 08:51:15 +0200122 * flag.
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100123 */
Willy Tarreaua0b58b52022-05-27 08:33:53 +0200124static struct stconn *sc_new(struct sedesc *sedesc)
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100125{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200126 struct stconn *sc;
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100127
Willy Tarreau0adb2812022-05-27 10:02:48 +0200128 sc = pool_alloc(pool_head_connstream);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100129
Willy Tarreau0adb2812022-05-27 10:02:48 +0200130 if (unlikely(!sc))
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100131 goto alloc_error;
Christopher Fauletbb772d02022-03-22 15:28:36 +0100132
Willy Tarreau1d2c79a2022-05-27 11:15:19 +0200133 sc->obj_type = OBJ_TYPE_SC;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200134 sc->flags = SC_FL_NONE;
135 sc->state = SC_ST_INI;
136 sc->hcto = TICK_ETERNITY;
137 sc->app = NULL;
138 sc->app_ops = NULL;
139 sc->src = NULL;
140 sc->dst = NULL;
141 sc->wait_event.tasklet = NULL;
142 sc->wait_event.events = 0;
Christopher Faulet2f35e7b2022-03-31 11:09:28 +0200143
Christopher Faulet9ed77422022-04-12 08:51:15 +0200144 /* If there is no endpoint, allocate a new one now */
Willy Tarreauea59b022022-05-17 17:53:22 +0200145 if (!sedesc) {
146 sedesc = sedesc_new();
147 if (unlikely(!sedesc))
Christopher Fauletb669d682022-03-22 18:37:19 +0100148 goto alloc_error;
149 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200150 sc->sedesc = sedesc;
151 sedesc->sc = sc;
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100152
Willy Tarreau0adb2812022-05-27 10:02:48 +0200153 return sc;
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100154
155 alloc_error:
Willy Tarreau0adb2812022-05-27 10:02:48 +0200156 pool_free(pool_head_connstream, sc);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100157 return NULL;
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100158}
159
Willy Tarreau31219282022-05-27 16:21:33 +0200160/* Creates a new stream connector and its associated stream from a mux. <sd> must
161 * be defined. It returns NULL on error. On success, the new stream connector is
Willy Tarreaub605c422022-05-17 17:04:55 +0200162 * returned. In this case, SE_FL_ORPHAN flag is removed.
Christopher Faulet9ed77422022-04-12 08:51:15 +0200163 */
Willy Tarreau31219282022-05-27 16:21:33 +0200164struct stconn *sc_new_from_endp(struct sedesc *sd, struct session *sess, struct buffer *input)
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100165{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200166 struct stconn *sc;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100167
Willy Tarreau31219282022-05-27 16:21:33 +0200168 sc = sc_new(sd);
Willy Tarreau0adb2812022-05-27 10:02:48 +0200169 if (unlikely(!sc))
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100170 return NULL;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200171 if (unlikely(!stream_new(sess, sc, input))) {
172 pool_free(pool_head_connstream, sc);
173 sc = NULL;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100174 }
Willy Tarreau31219282022-05-27 16:21:33 +0200175 se_fl_clr(sd, SE_FL_ORPHAN);
Willy Tarreau0adb2812022-05-27 10:02:48 +0200176 return sc;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100177}
178
Willy Tarreau4596fe22022-05-17 19:07:51 +0200179/* Creates a new stream connector from an stream. There is no endpoint here, thus it
Willy Tarreaua0b58b52022-05-27 08:33:53 +0200180 * will be created by sc_new(). So the SE_FL_DETACHED flag is set. It returns
Willy Tarreau4596fe22022-05-17 19:07:51 +0200181 * NULL on error. On success, the new stream connector is returned.
Christopher Faulet9ed77422022-04-12 08:51:15 +0200182 */
Willy Tarreaua0b58b52022-05-27 08:33:53 +0200183struct stconn *sc_new_from_strm(struct stream *strm, unsigned int flags)
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100184{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200185 struct stconn *sc;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100186
Willy Tarreau0adb2812022-05-27 10:02:48 +0200187 sc = sc_new(NULL);
188 if (unlikely(!sc))
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100189 return NULL;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200190 sc->flags |= flags;
191 sc_ep_set(sc, SE_FL_DETACHED);
192 sc->app = &strm->obj_type;
193 sc->app_ops = &sc_app_embedded_ops;
194 return sc;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100195}
196
Willy Tarreau4596fe22022-05-17 19:07:51 +0200197/* Creates a new stream connector from an health-check. There is no endpoint here,
Willy Tarreaua0b58b52022-05-27 08:33:53 +0200198 * thus it will be created by sc_new(). So the SE_FL_DETACHED flag is set. It
Willy Tarreau4596fe22022-05-17 19:07:51 +0200199 * returns NULL on error. On success, the new stream connector is returned.
Christopher Faulet9ed77422022-04-12 08:51:15 +0200200 */
Willy Tarreaua0b58b52022-05-27 08:33:53 +0200201struct stconn *sc_new_from_check(struct check *check, unsigned int flags)
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100202{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200203 struct stconn *sc;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100204
Willy Tarreau0adb2812022-05-27 10:02:48 +0200205 sc = sc_new(NULL);
206 if (unlikely(!sc))
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100207 return NULL;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200208 sc->flags |= flags;
209 sc_ep_set(sc, SE_FL_DETACHED);
210 sc->app = &check->obj_type;
211 sc->app_ops = &sc_app_check_ops;
212 return sc;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100213}
214
Willy Tarreaua0b58b52022-05-27 08:33:53 +0200215/* Releases a stconn previously allocated by sc_new(), as well as its
Christopher Faulet9ed77422022-04-12 08:51:15 +0200216 * endpoint, if it exists. This function is called internally or on error path.
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100217 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200218void sc_free(struct stconn *sc)
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100219{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200220 sockaddr_free(&sc->src);
221 sockaddr_free(&sc->dst);
222 if (sc->sedesc) {
223 BUG_ON(!sc_ep_test(sc, SE_FL_DETACHED));
224 sedesc_free(sc->sedesc);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100225 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200226 if (sc->wait_event.tasklet)
227 tasklet_free(sc->wait_event.tasklet);
228 pool_free(pool_head_connstream, sc);
Christopher Faulet1329f2a2021-12-16 17:32:56 +0100229}
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100230
Willy Tarreau4596fe22022-05-17 19:07:51 +0200231/* Conditionally removes a stream connector if it is detached and if there is no app
Christopher Fauleteb50c012022-04-21 14:22:53 +0200232 * layer defined. Except on error path, this one must be used. if release, the
Willy Tarreaue68bc612022-05-27 11:23:05 +0200233 * pointer on the SC is set to NULL.
Christopher Fauletaa69d8f2022-04-12 18:09:48 +0200234 */
Willy Tarreaue68bc612022-05-27 11:23:05 +0200235static void sc_free_cond(struct stconn **scp)
Christopher Fauletaa69d8f2022-04-12 18:09:48 +0200236{
Willy Tarreaue68bc612022-05-27 11:23:05 +0200237 struct stconn *sc = *scp;
Christopher Fauleteb50c012022-04-21 14:22:53 +0200238
Willy Tarreau0adb2812022-05-27 10:02:48 +0200239 if (!sc->app && (!sc->sedesc || sc_ep_test(sc, SE_FL_DETACHED))) {
240 sc_free(sc);
Willy Tarreaue68bc612022-05-27 11:23:05 +0200241 *scp = NULL;
Christopher Fauleteb50c012022-04-21 14:22:53 +0200242 }
Christopher Fauletaa69d8f2022-04-12 18:09:48 +0200243}
244
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100245
Willy Tarreau4596fe22022-05-17 19:07:51 +0200246/* Attaches a stconn to a mux endpoint and sets the endpoint ctx. Returns
Ilya Shipitsin3b64a282022-07-29 22:26:53 +0500247 * -1 on error and 0 on success. SE_FL_DETACHED flag is removed. This function is
Christopher Faulet9ed77422022-04-12 08:51:15 +0200248 * called from a mux when it is attached to a stream or a health-check.
249 */
Willy Tarreau31219282022-05-27 16:21:33 +0200250int sc_attach_mux(struct stconn *sc, void *sd, void *ctx)
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100251{
Christopher Faulet93882042022-01-19 14:56:50 +0100252 struct connection *conn = ctx;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200253 struct sedesc *sedesc = sc->sedesc;
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100254
Willy Tarreau31219282022-05-27 16:21:33 +0200255 sedesc->se = sd;
Willy Tarreau798465b2022-05-17 18:20:02 +0200256 sedesc->conn = ctx;
257 se_fl_set(sedesc, SE_FL_T_MUX);
258 se_fl_clr(sedesc, SE_FL_DETACHED);
Christopher Faulet93882042022-01-19 14:56:50 +0100259 if (!conn->ctx)
Willy Tarreau0adb2812022-05-27 10:02:48 +0200260 conn->ctx = sc;
261 if (sc_strm(sc)) {
262 if (!sc->wait_event.tasklet) {
263 sc->wait_event.tasklet = tasklet_new();
264 if (!sc->wait_event.tasklet)
Christopher Faulet2f35e7b2022-03-31 11:09:28 +0200265 return -1;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200266 sc->wait_event.tasklet->process = sc_conn_io_cb;
267 sc->wait_event.tasklet->context = sc;
268 sc->wait_event.events = 0;
Christopher Faulet2f35e7b2022-03-31 11:09:28 +0200269 }
270
Willy Tarreau0adb2812022-05-27 10:02:48 +0200271 sc->app_ops = &sc_app_conn_ops;
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100272 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200273 else if (sc_check(sc)) {
274 if (!sc->wait_event.tasklet) {
275 sc->wait_event.tasklet = tasklet_new();
276 if (!sc->wait_event.tasklet)
Christopher Fauletc95eaef2022-05-18 15:57:15 +0200277 return -1;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200278 sc->wait_event.tasklet->process = srv_chk_io_cb;
279 sc->wait_event.tasklet->context = sc;
280 sc->wait_event.events = 0;
Christopher Fauletc95eaef2022-05-18 15:57:15 +0200281 }
282
Willy Tarreau0adb2812022-05-27 10:02:48 +0200283 sc->app_ops = &sc_app_check_ops;
Christopher Fauletc95eaef2022-05-18 15:57:15 +0200284 }
Christopher Faulet070b91b2022-03-31 19:27:18 +0200285 return 0;
Christopher Faulet93882042022-01-19 14:56:50 +0100286}
287
Willy Tarreau4596fe22022-05-17 19:07:51 +0200288/* Attaches a stconn to an applet endpoint and sets the endpoint
Ilya Shipitsin3b64a282022-07-29 22:26:53 +0500289 * ctx. Returns -1 on error and 0 on success. SE_FL_DETACHED flag is
Christopher Faulet9ed77422022-04-12 08:51:15 +0200290 * removed. This function is called by a stream when a backend applet is
291 * registered.
292 */
Willy Tarreau31219282022-05-27 16:21:33 +0200293static void sc_attach_applet(struct stconn *sc, void *sd)
Christopher Faulet93882042022-01-19 14:56:50 +0100294{
Willy Tarreau31219282022-05-27 16:21:33 +0200295 sc->sedesc->se = sd;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200296 sc_ep_set(sc, SE_FL_T_APPLET);
297 sc_ep_clr(sc, SE_FL_DETACHED);
298 if (sc_strm(sc))
299 sc->app_ops = &sc_app_applet_ops;
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100300}
301
Willy Tarreau4596fe22022-05-17 19:07:51 +0200302/* Attaches a stconn to a app layer and sets the relevant
Willy Tarreaub605c422022-05-17 17:04:55 +0200303 * callbacks. Returns -1 on error and 0 on success. SE_FL_ORPHAN flag is
Christopher Faulet9ed77422022-04-12 08:51:15 +0200304 * removed. This function is called by a stream when it is created to attach it
Willy Tarreau4596fe22022-05-17 19:07:51 +0200305 * on the stream connector on the client side.
Christopher Faulet9ed77422022-04-12 08:51:15 +0200306 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200307int sc_attach_strm(struct stconn *sc, struct stream *strm)
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100308{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200309 sc->app = &strm->obj_type;
310 sc_ep_clr(sc, SE_FL_ORPHAN);
311 if (sc_ep_test(sc, SE_FL_T_MUX)) {
312 sc->wait_event.tasklet = tasklet_new();
313 if (!sc->wait_event.tasklet)
Christopher Faulet2f35e7b2022-03-31 11:09:28 +0200314 return -1;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200315 sc->wait_event.tasklet->process = sc_conn_io_cb;
316 sc->wait_event.tasklet->context = sc;
317 sc->wait_event.events = 0;
Christopher Faulet2f35e7b2022-03-31 11:09:28 +0200318
Willy Tarreau0adb2812022-05-27 10:02:48 +0200319 sc->app_ops = &sc_app_conn_ops;
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100320 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200321 else if (sc_ep_test(sc, SE_FL_T_APPLET)) {
322 sc->app_ops = &sc_app_applet_ops;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100323 }
324 else {
Willy Tarreau0adb2812022-05-27 10:02:48 +0200325 sc->app_ops = &sc_app_embedded_ops;
Christopher Fauleta9e8b392022-03-23 11:01:09 +0100326 }
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100327 return 0;
328}
329
Willy Tarreau4596fe22022-05-17 19:07:51 +0200330/* Detaches the stconn from the endpoint, if any. For a connecrion, if a
Christopher Faulet9ed77422022-04-12 08:51:15 +0200331 * mux owns the connection ->detach() callback is called. Otherwise, it means
Willy Tarreau4596fe22022-05-17 19:07:51 +0200332 * the stream connector owns the connection. In this case the connection is closed
Christopher Faulet9ed77422022-04-12 08:51:15 +0200333 * and released. For an applet, the appctx is released. If still allocated, the
334 * endpoint is reset and flag as detached. If the app layer is also detached,
Willy Tarreau4596fe22022-05-17 19:07:51 +0200335 * the stream connector is released.
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100336 */
Willy Tarreaue68bc612022-05-27 11:23:05 +0200337static void sc_detach_endp(struct stconn **scp)
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100338{
Willy Tarreaue68bc612022-05-27 11:23:05 +0200339 struct stconn *sc = *scp;
Christopher Fauleteb50c012022-04-21 14:22:53 +0200340
Willy Tarreau0adb2812022-05-27 10:02:48 +0200341 if (!sc)
Christopher Fauleteb50c012022-04-21 14:22:53 +0200342 return;
343
Willy Tarreau0adb2812022-05-27 10:02:48 +0200344 if (sc_ep_test(sc, SE_FL_T_MUX)) {
345 struct connection *conn = __sc_conn(sc);
346 struct sedesc *sedesc = sc->sedesc;
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100347
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100348 if (conn->mux) {
Willy Tarreau0adb2812022-05-27 10:02:48 +0200349 if (sc->wait_event.events != 0)
350 conn->mux->unsubscribe(sc, sc->wait_event.events, &sc->wait_event);
Willy Tarreau798465b2022-05-17 18:20:02 +0200351 se_fl_set(sedesc, SE_FL_ORPHAN);
Willy Tarreauc1054922022-05-18 07:43:52 +0200352 sedesc->sc = NULL;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200353 sc->sedesc = NULL;
Willy Tarreau798465b2022-05-17 18:20:02 +0200354 conn->mux->detach(sedesc);
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100355 }
356 else {
357 /* It's too early to have a mux, let's just destroy
358 * the connection
359 */
360 conn_stop_tracking(conn);
361 conn_full_close(conn);
362 if (conn->destroy_cb)
363 conn->destroy_cb(conn);
364 conn_free(conn);
365 }
366 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200367 else if (sc_ep_test(sc, SE_FL_T_APPLET)) {
368 struct appctx *appctx = __sc_appctx(sc);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100369
Willy Tarreau0adb2812022-05-27 10:02:48 +0200370 sc_ep_set(sc, SE_FL_ORPHAN);
371 sc->sedesc->sc = NULL;
372 sc->sedesc = NULL;
Willy Tarreau1c3ead42022-05-10 19:42:22 +0200373 appctx_shut(appctx);
374 appctx_free(appctx);
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100375 }
376
Willy Tarreau0adb2812022-05-27 10:02:48 +0200377 if (sc->sedesc) {
Willy Tarreauda59c892022-05-27 17:03:34 +0200378 /* the SD wasn't used and can be recycled */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200379 sc->sedesc->se = NULL;
380 sc->sedesc->conn = NULL;
Willy Tarreauda59c892022-05-27 17:03:34 +0200381 sc->sedesc->flags = 0;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200382 sc_ep_set(sc, SE_FL_DETACHED);
Christopher Fauletdb90f2a2022-03-22 16:06:25 +0100383 }
384
Willy Tarreaue68bc612022-05-27 11:23:05 +0200385 /* FIXME: Rest SC for now but must be reviewed. SC flags are only
Christopher Fauletc36de9d2022-01-06 08:44:58 +0100386 * connection related for now but this will evolved
387 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200388 sc->flags &= SC_FL_ISBACK;
389 if (sc_strm(sc))
390 sc->app_ops = &sc_app_embedded_ops;
Willy Tarreau2f2318d2022-05-18 10:17:16 +0200391 else
Willy Tarreau0adb2812022-05-27 10:02:48 +0200392 sc->app_ops = NULL;
Willy Tarreaue68bc612022-05-27 11:23:05 +0200393 sc_free_cond(scp);
Christopher Fauletc36de9d2022-01-06 08:44:58 +0100394}
395
Willy Tarreau4596fe22022-05-17 19:07:51 +0200396/* Detaches the stconn from the app layer. If there is no endpoint attached
397 * to the stconn
Christopher Faulet9ed77422022-04-12 08:51:15 +0200398 */
Willy Tarreaue68bc612022-05-27 11:23:05 +0200399static void sc_detach_app(struct stconn **scp)
Christopher Fauletc36de9d2022-01-06 08:44:58 +0100400{
Willy Tarreaue68bc612022-05-27 11:23:05 +0200401 struct stconn *sc = *scp;
Christopher Fauleteb50c012022-04-21 14:22:53 +0200402
Willy Tarreau0adb2812022-05-27 10:02:48 +0200403 if (!sc)
Christopher Fauleteb50c012022-04-21 14:22:53 +0200404 return;
405
Willy Tarreau0adb2812022-05-27 10:02:48 +0200406 sc->app = NULL;
407 sc->app_ops = NULL;
408 sockaddr_free(&sc->src);
409 sockaddr_free(&sc->dst);
Christopher Faulet2f35e7b2022-03-31 11:09:28 +0200410
Willy Tarreau0adb2812022-05-27 10:02:48 +0200411 if (sc->wait_event.tasklet)
412 tasklet_free(sc->wait_event.tasklet);
413 sc->wait_event.tasklet = NULL;
414 sc->wait_event.events = 0;
Willy Tarreaue68bc612022-05-27 11:23:05 +0200415 sc_free_cond(scp);
Christopher Fauleteb50c012022-04-21 14:22:53 +0200416}
417
Willy Tarreau4596fe22022-05-17 19:07:51 +0200418/* Destroy the stconn. It is detached from its endpoint and its
419 * application. After this call, the stconn must be considered as released.
Christopher Fauleteb50c012022-04-21 14:22:53 +0200420 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200421void sc_destroy(struct stconn *sc)
Christopher Fauleteb50c012022-04-21 14:22:53 +0200422{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200423 sc_detach_endp(&sc);
424 sc_detach_app(&sc);
425 BUG_ON_HOT(sc);
Christopher Fauletcda94ac2021-12-23 17:28:17 +0100426}
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +0100427
Willy Tarreau4596fe22022-05-17 19:07:51 +0200428/* Resets the stream connector endpoint. It happens when the app layer want to renew
Christopher Faulet9ed77422022-04-12 08:51:15 +0200429 * its endpoint. For a connection retry for instance. If a mux or an applet is
Ilya Shipitsin3b64a282022-07-29 22:26:53 +0500430 * attached, a new endpoint is created. Returns -1 on error and 0 on success.
Christopher Fauleta6c4a482022-04-28 18:25:24 +0200431 *
Willy Tarreaub605c422022-05-17 17:04:55 +0200432 * Only SE_FL_ERROR flag is removed on the endpoint. Orther flags are preserved.
Christopher Fauleta6c4a482022-04-28 18:25:24 +0200433 * It is the caller responsibility to remove other flags if needed.
Christopher Faulet9ed77422022-04-12 08:51:15 +0200434 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200435int sc_reset_endp(struct stconn *sc)
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +0100436{
Willy Tarreau31219282022-05-27 16:21:33 +0200437 struct sedesc *new_sd;
Christopher Fauletb041b232022-03-24 10:27:02 +0100438
Willy Tarreau0adb2812022-05-27 10:02:48 +0200439 BUG_ON(!sc->app);
Christopher Fauleta6c4a482022-04-28 18:25:24 +0200440
Willy Tarreau0adb2812022-05-27 10:02:48 +0200441 sc_ep_clr(sc, SE_FL_ERROR);
442 if (!__sc_endp(sc)) {
Christopher Fauletb041b232022-03-24 10:27:02 +0100443 /* endpoint not attached or attached to a mux with no
444 * target. Thus the endpoint will not be release but just
Willy Tarreau0adb2812022-05-27 10:02:48 +0200445 * reset. The app is still attached, the sc will not be
Christopher Fauleteb50c012022-04-21 14:22:53 +0200446 * released.
Christopher Fauletb041b232022-03-24 10:27:02 +0100447 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200448 sc_detach_endp(&sc);
Christopher Fauletb041b232022-03-24 10:27:02 +0100449 return 0;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +0100450 }
Christopher Fauletb041b232022-03-24 10:27:02 +0100451
452 /* allocate the new endpoint first to be able to set error if it
453 * fails */
Willy Tarreau31219282022-05-27 16:21:33 +0200454 new_sd = sedesc_new();
455 if (!unlikely(new_sd)) {
Willy Tarreau0adb2812022-05-27 10:02:48 +0200456 sc_ep_set(sc, SE_FL_ERROR);
Christopher Fauletb041b232022-03-24 10:27:02 +0100457 return -1;
458 }
459
Willy Tarreau0adb2812022-05-27 10:02:48 +0200460 /* The app is still attached, the sc will not be released */
461 sc_detach_endp(&sc);
Willy Tarreau6a378d12022-08-11 13:56:42 +0200462 BUG_ON(!sc);
Willy Tarreau0adb2812022-05-27 10:02:48 +0200463 BUG_ON(sc->sedesc);
Willy Tarreau31219282022-05-27 16:21:33 +0200464 sc->sedesc = new_sd;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200465 sc->sedesc->sc = sc;
466 sc_ep_set(sc, SE_FL_DETACHED);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +0100467 return 0;
468}
Christopher Faulet37046632022-04-01 11:36:58 +0200469
470
Willy Tarreaue68bc612022-05-27 11:23:05 +0200471/* Create an applet to handle a stream connector as a new appctx. The SC will
Christopher Faulet37046632022-04-01 11:36:58 +0200472 * wake it up every time it is solicited. The appctx must be deleted by the task
Willy Tarreau19c65a92022-05-27 08:49:24 +0200473 * handler using sc_detach_endp(), possibly from within the function itself.
Christopher Faulet37046632022-04-01 11:36:58 +0200474 * It also pre-initializes the applet's context and returns it (or NULL in case
475 * it could not be allocated).
476 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200477struct appctx *sc_applet_create(struct stconn *sc, struct applet *app)
Christopher Faulet37046632022-04-01 11:36:58 +0200478{
479 struct appctx *appctx;
480
Willy Tarreau0adb2812022-05-27 10:02:48 +0200481 DPRINTF(stderr, "registering handler %p for sc %p (was %p)\n", app, sc, sc_strm_task(sc));
Christopher Faulet37046632022-04-01 11:36:58 +0200482
Willy Tarreau0adb2812022-05-27 10:02:48 +0200483 appctx = appctx_new_here(app, sc->sedesc);
Christopher Faulet37046632022-04-01 11:36:58 +0200484 if (!appctx)
485 return NULL;
Willy Tarreau0adb2812022-05-27 10:02:48 +0200486 sc_attach_applet(sc, appctx);
487 appctx->t->nice = __sc_strm(sc)->task->nice;
Willy Tarreau90e8b452022-05-25 18:21:43 +0200488 applet_need_more_data(appctx);
Christopher Faulet37046632022-04-01 11:36:58 +0200489 appctx_wakeup(appctx);
Christopher Fauleta33ff7a2022-04-21 11:52:07 +0200490
Willy Tarreau0adb2812022-05-27 10:02:48 +0200491 sc->state = SC_ST_RDY;
Christopher Faulet37046632022-04-01 11:36:58 +0200492 return appctx;
493}
494
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200495/*
Willy Tarreau4596fe22022-05-17 19:07:51 +0200496 * This function performs a shutdown-read on a detached stream connector in a
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200497 * connected or init state (it does nothing for other states). It either shuts
498 * the read side or marks itself as closed. The buffer flags are updated to
Willy Tarreaucb041662022-05-17 19:44:42 +0200499 * reflect the new state. If the stream connector has SC_FL_NOHALF, we also
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200500 * forward the close to the write side. The owner task is woken up if it exists.
501 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200502static void sc_app_shutr(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200503{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200504 struct channel *ic = sc_ic(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200505
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200506 if (ic->flags & CF_SHUTR)
507 return;
508 ic->flags |= CF_SHUTR;
509 ic->rex = TICK_ETERNITY;
510
Willy Tarreau0adb2812022-05-27 10:02:48 +0200511 if (!sc_state_in(sc->state, SC_SB_CON|SC_SB_RDY|SC_SB_EST))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200512 return;
513
Willy Tarreau0adb2812022-05-27 10:02:48 +0200514 if (sc_oc(sc)->flags & CF_SHUTW) {
515 sc->state = SC_ST_DIS;
Christopher Fauletca679922022-07-20 13:24:04 +0200516 if (sc->flags & SC_FL_ISBACK)
517 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200518 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200519 else if (sc->flags & SC_FL_NOHALF) {
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200520 /* we want to immediately forward this close to the write side */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200521 return sc_app_shutw(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200522 }
523
524 /* note that if the task exists, it must unregister itself once it runs */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200525 if (!(sc->flags & SC_FL_DONT_WAKE))
526 task_wakeup(sc_strm_task(sc), TASK_WOKEN_IO);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200527}
528
529/*
Willy Tarreau4596fe22022-05-17 19:07:51 +0200530 * This function performs a shutdown-write on a detached stream connector in a
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200531 * connected or init state (it does nothing for other states). It either shuts
532 * the write side or marks itself as closed. The buffer flags are updated to
Willy Tarreaue68bc612022-05-27 11:23:05 +0200533 * reflect the new state. It does also close everything if the SC was marked as
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200534 * being in error state. The owner task is woken up if it exists.
535 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200536static void sc_app_shutw(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200537{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200538 struct channel *ic = sc_ic(sc);
539 struct channel *oc = sc_oc(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200540
541 oc->flags &= ~CF_SHUTW_NOW;
542 if (oc->flags & CF_SHUTW)
543 return;
544 oc->flags |= CF_SHUTW;
545 oc->wex = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200546
Willy Tarreau0adb2812022-05-27 10:02:48 +0200547 if (tick_isset(sc->hcto)) {
548 ic->rto = sc->hcto;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200549 ic->rex = tick_add(now_ms, ic->rto);
550 }
551
Willy Tarreau0adb2812022-05-27 10:02:48 +0200552 switch (sc->state) {
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200553 case SC_ST_RDY:
554 case SC_ST_EST:
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200555 /* we have to shut before closing, otherwise some short messages
556 * may never leave the system, especially when there are remaining
557 * unread data in the socket input buffer, or when nolinger is set.
Willy Tarreaucb041662022-05-17 19:44:42 +0200558 * However, if SC_FL_NOLINGER is explicitly set, we know there is
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200559 * no risk so we close both sides immediately.
560 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200561 if (!sc_ep_test(sc, SE_FL_ERROR) && !(sc->flags & SC_FL_NOLINGER) &&
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200562 !(ic->flags & (CF_SHUTR|CF_DONT_READ)))
563 return;
564
565 /* fall through */
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200566 case SC_ST_CON:
567 case SC_ST_CER:
568 case SC_ST_QUE:
569 case SC_ST_TAR:
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200570 /* Note that none of these states may happen with applets */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200571 sc->state = SC_ST_DIS;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200572 /* fall through */
573 default:
Willy Tarreau0adb2812022-05-27 10:02:48 +0200574 sc->flags &= ~SC_FL_NOLINGER;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200575 ic->flags |= CF_SHUTR;
576 ic->rex = TICK_ETERNITY;
Christopher Fauletca679922022-07-20 13:24:04 +0200577 if (sc->flags & SC_FL_ISBACK)
578 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200579 }
580
581 /* note that if the task exists, it must unregister itself once it runs */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200582 if (!(sc->flags & SC_FL_DONT_WAKE))
583 task_wakeup(sc_strm_task(sc), TASK_WOKEN_IO);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200584}
585
586/* default chk_rcv function for scheduled tasks */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200587static void sc_app_chk_rcv(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200588{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200589 struct channel *ic = sc_ic(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200590
Willy Tarreau0adb2812022-05-27 10:02:48 +0200591 DPRINTF(stderr, "%s: sc=%p, sc->state=%d ic->flags=%08x oc->flags=%08x\n",
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200592 __FUNCTION__,
Willy Tarreau0adb2812022-05-27 10:02:48 +0200593 sc, sc->state, ic->flags, sc_oc(sc)->flags);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200594
595 if (ic->pipe) {
596 /* stop reading */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200597 sc_need_room(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200598 }
599 else {
600 /* (re)start reading */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200601 if (!(sc->flags & SC_FL_DONT_WAKE))
602 task_wakeup(sc_strm_task(sc), TASK_WOKEN_IO);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200603 }
604}
605
606/* default chk_snd function for scheduled tasks */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200607static void sc_app_chk_snd(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200608{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200609 struct channel *oc = sc_oc(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200610
Willy Tarreau0adb2812022-05-27 10:02:48 +0200611 DPRINTF(stderr, "%s: sc=%p, sc->state=%d ic->flags=%08x oc->flags=%08x\n",
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200612 __FUNCTION__,
Willy Tarreau0adb2812022-05-27 10:02:48 +0200613 sc, sc->state, sc_ic(sc)->flags, oc->flags);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200614
Willy Tarreau0adb2812022-05-27 10:02:48 +0200615 if (unlikely(sc->state != SC_ST_EST || (oc->flags & CF_SHUTW)))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200616 return;
617
Willy Tarreau0adb2812022-05-27 10:02:48 +0200618 if (!sc_ep_test(sc, SE_FL_WAIT_DATA) || /* not waiting for data */
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200619 channel_is_empty(oc)) /* called with nothing to send ! */
620 return;
621
622 /* Otherwise there are remaining data to be sent in the buffer,
623 * so we tell the handler.
624 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200625 sc_ep_clr(sc, SE_FL_WAIT_DATA);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200626 if (!tick_isset(oc->wex))
627 oc->wex = tick_add_ifset(now_ms, oc->wto);
628
Willy Tarreau0adb2812022-05-27 10:02:48 +0200629 if (!(sc->flags & SC_FL_DONT_WAKE))
630 task_wakeup(sc_strm_task(sc), TASK_WOKEN_IO);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200631}
632
633/*
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200634 * This function performs a shutdown-read on a stream connector attached to
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200635 * a connection in a connected or init state (it does nothing for other
636 * states). It either shuts the read side or marks itself as closed. The buffer
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200637 * flags are updated to reflect the new state. If the stream connector has
Willy Tarreaucb041662022-05-17 19:44:42 +0200638 * SC_FL_NOHALF, we also forward the close to the write side. If a control
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200639 * layer is defined, then it is supposed to be a socket layer and file
640 * descriptors are then shutdown or closed accordingly. The function
641 * automatically disables polling if needed.
642 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200643static void sc_app_shutr_conn(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200644{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200645 struct channel *ic = sc_ic(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200646
Willy Tarreau0adb2812022-05-27 10:02:48 +0200647 BUG_ON(!sc_conn(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200648
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200649 if (ic->flags & CF_SHUTR)
650 return;
651 ic->flags |= CF_SHUTR;
652 ic->rex = TICK_ETERNITY;
653
Willy Tarreau0adb2812022-05-27 10:02:48 +0200654 if (!sc_state_in(sc->state, SC_SB_CON|SC_SB_RDY|SC_SB_EST))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200655 return;
656
Willy Tarreau0adb2812022-05-27 10:02:48 +0200657 if (sc_oc(sc)->flags & CF_SHUTW) {
658 sc_conn_shut(sc);
659 sc->state = SC_ST_DIS;
Christopher Fauletca679922022-07-20 13:24:04 +0200660 if (sc->flags & SC_FL_ISBACK)
661 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200662 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200663 else if (sc->flags & SC_FL_NOHALF) {
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200664 /* we want to immediately forward this close to the write side */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200665 return sc_app_shutw_conn(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200666 }
667}
668
669/*
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200670 * This function performs a shutdown-write on a stream connector attached to
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200671 * a connection in a connected or init state (it does nothing for other
672 * states). It either shuts the write side or marks itself as closed. The
673 * buffer flags are updated to reflect the new state. It does also close
Willy Tarreaue68bc612022-05-27 11:23:05 +0200674 * everything if the SC was marked as being in error state. If there is a
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200675 * data-layer shutdown, it is called.
676 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200677static void sc_app_shutw_conn(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200678{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200679 struct channel *ic = sc_ic(sc);
680 struct channel *oc = sc_oc(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200681
Willy Tarreau0adb2812022-05-27 10:02:48 +0200682 BUG_ON(!sc_conn(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200683
684 oc->flags &= ~CF_SHUTW_NOW;
685 if (oc->flags & CF_SHUTW)
686 return;
687 oc->flags |= CF_SHUTW;
688 oc->wex = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200689
Willy Tarreau0adb2812022-05-27 10:02:48 +0200690 if (tick_isset(sc->hcto)) {
691 ic->rto = sc->hcto;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200692 ic->rex = tick_add(now_ms, ic->rto);
693 }
694
Willy Tarreau0adb2812022-05-27 10:02:48 +0200695 switch (sc->state) {
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200696 case SC_ST_RDY:
697 case SC_ST_EST:
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200698 /* we have to shut before closing, otherwise some short messages
699 * may never leave the system, especially when there are remaining
700 * unread data in the socket input buffer, or when nolinger is set.
Willy Tarreaucb041662022-05-17 19:44:42 +0200701 * However, if SC_FL_NOLINGER is explicitly set, we know there is
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200702 * no risk so we close both sides immediately.
703 */
704
Willy Tarreau0adb2812022-05-27 10:02:48 +0200705 if (sc_ep_test(sc, SE_FL_ERROR)) {
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200706 /* quick close, the socket is already shut anyway */
707 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200708 else if (sc->flags & SC_FL_NOLINGER) {
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200709 /* unclean data-layer shutdown, typically an aborted request
710 * or a forwarded shutdown from a client to a server due to
711 * option abortonclose. No need for the TLS layer to try to
712 * emit a shutdown message.
713 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200714 sc_conn_shutw(sc, CO_SHW_SILENT);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200715 }
716 else {
717 /* clean data-layer shutdown. This only happens on the
718 * frontend side, or on the backend side when forwarding
719 * a client close in TCP mode or in HTTP TUNNEL mode
720 * while option abortonclose is set. We want the TLS
721 * layer to try to signal it to the peer before we close.
722 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200723 sc_conn_shutw(sc, CO_SHW_NORMAL);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200724
725 if (!(ic->flags & (CF_SHUTR|CF_DONT_READ)))
726 return;
727 }
728
729 /* fall through */
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200730 case SC_ST_CON:
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200731 /* we may have to close a pending connection, and mark the
732 * response buffer as shutr
733 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200734 sc_conn_shut(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200735 /* fall through */
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200736 case SC_ST_CER:
737 case SC_ST_QUE:
738 case SC_ST_TAR:
Willy Tarreau0adb2812022-05-27 10:02:48 +0200739 sc->state = SC_ST_DIS;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200740 /* fall through */
741 default:
Willy Tarreau0adb2812022-05-27 10:02:48 +0200742 sc->flags &= ~SC_FL_NOLINGER;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200743 ic->flags |= CF_SHUTR;
744 ic->rex = TICK_ETERNITY;
Christopher Fauletca679922022-07-20 13:24:04 +0200745 if (sc->flags & SC_FL_ISBACK)
746 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200747 }
748}
749
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200750/* This function is used for inter-stream connector calls. It is called by the
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200751 * consumer to inform the producer side that it may be interested in checking
752 * for free space in the buffer. Note that it intentionally does not update
753 * timeouts, so that we can still check them later at wake-up. This function is
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200754 * dedicated to connection-based stream connectors.
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200755 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200756static void sc_app_chk_rcv_conn(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200757{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200758 BUG_ON(!sc_conn(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200759
760 /* (re)start reading */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200761 if (sc_state_in(sc->state, SC_SB_CON|SC_SB_RDY|SC_SB_EST))
762 tasklet_wakeup(sc->wait_event.tasklet);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200763}
764
765
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200766/* This function is used for inter-stream connector calls. It is called by the
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200767 * producer to inform the consumer side that it may be interested in checking
768 * for data in the buffer. Note that it intentionally does not update timeouts,
769 * so that we can still check them later at wake-up.
770 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200771static void sc_app_chk_snd_conn(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200772{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200773 struct channel *oc = sc_oc(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200774
Willy Tarreau0adb2812022-05-27 10:02:48 +0200775 BUG_ON(!sc_conn(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200776
Willy Tarreau0adb2812022-05-27 10:02:48 +0200777 if (unlikely(!sc_state_in(sc->state, SC_SB_RDY|SC_SB_EST) ||
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200778 (oc->flags & CF_SHUTW)))
779 return;
780
781 if (unlikely(channel_is_empty(oc))) /* called with nothing to send ! */
782 return;
783
784 if (!oc->pipe && /* spliced data wants to be forwarded ASAP */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200785 !sc_ep_test(sc, SE_FL_WAIT_DATA)) /* not waiting for data */
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200786 return;
787
Willy Tarreau0adb2812022-05-27 10:02:48 +0200788 if (!(sc->wait_event.events & SUB_RETRY_SEND) && !channel_is_empty(sc_oc(sc)))
789 sc_conn_send(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200790
Willy Tarreau0adb2812022-05-27 10:02:48 +0200791 if (sc_ep_test(sc, SE_FL_ERROR | SE_FL_ERR_PENDING) || sc_is_conn_error(sc)) {
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200792 /* Write error on the file descriptor */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200793 if (sc->state >= SC_ST_CON)
794 sc_ep_set(sc, SE_FL_ERROR);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200795 goto out_wakeup;
796 }
797
798 /* OK, so now we know that some data might have been sent, and that we may
799 * have to poll first. We have to do that too if the buffer is not empty.
800 */
801 if (channel_is_empty(oc)) {
802 /* the connection is established but we can't write. Either the
803 * buffer is empty, or we just refrain from sending because the
804 * ->o limit was reached. Maybe we just wrote the last
805 * chunk and need to close.
806 */
807 if (((oc->flags & (CF_SHUTW|CF_AUTO_CLOSE|CF_SHUTW_NOW)) ==
808 (CF_AUTO_CLOSE|CF_SHUTW_NOW)) &&
Willy Tarreau0adb2812022-05-27 10:02:48 +0200809 sc_state_in(sc->state, SC_SB_RDY|SC_SB_EST)) {
810 sc_shutw(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200811 goto out_wakeup;
812 }
813
814 if ((oc->flags & (CF_SHUTW|CF_SHUTW_NOW)) == 0)
Willy Tarreau0adb2812022-05-27 10:02:48 +0200815 sc_ep_set(sc, SE_FL_WAIT_DATA);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200816 oc->wex = TICK_ETERNITY;
817 }
818 else {
819 /* Otherwise there are remaining data to be sent in the buffer,
820 * which means we have to poll before doing so.
821 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200822 sc_ep_clr(sc, SE_FL_WAIT_DATA);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200823 if (!tick_isset(oc->wex))
824 oc->wex = tick_add_ifset(now_ms, oc->wto);
825 }
826
827 if (likely(oc->flags & CF_WRITE_ACTIVITY)) {
Willy Tarreau0adb2812022-05-27 10:02:48 +0200828 struct channel *ic = sc_ic(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200829
830 /* update timeout if we have written something */
831 if ((oc->flags & (CF_SHUTW|CF_WRITE_PARTIAL)) == CF_WRITE_PARTIAL &&
832 !channel_is_empty(oc))
833 oc->wex = tick_add_ifset(now_ms, oc->wto);
834
Willy Tarreau0adb2812022-05-27 10:02:48 +0200835 if (tick_isset(ic->rex) && !(sc->flags & SC_FL_INDEP_STR)) {
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200836 /* Note: to prevent the client from expiring read timeouts
837 * during writes, we refresh it. We only do this if the
838 * interface is not configured for "independent streams",
839 * because for some applications it's better not to do this,
840 * for instance when continuously exchanging small amounts
841 * of data which can full the socket buffers long before a
842 * write timeout is detected.
843 */
844 ic->rex = tick_add_ifset(now_ms, ic->rto);
845 }
846 }
847
848 /* in case of special condition (error, shutdown, end of write...), we
849 * have to notify the task.
850 */
851 if (likely((oc->flags & (CF_WRITE_NULL|CF_WRITE_ERROR|CF_SHUTW)) ||
852 ((oc->flags & CF_WAKE_WRITE) &&
853 ((channel_is_empty(oc) && !oc->to_forward) ||
Willy Tarreau0adb2812022-05-27 10:02:48 +0200854 !sc_state_in(sc->state, SC_SB_EST))))) {
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200855 out_wakeup:
Willy Tarreau0adb2812022-05-27 10:02:48 +0200856 if (!(sc->flags & SC_FL_DONT_WAKE))
857 task_wakeup(sc_strm_task(sc), TASK_WOKEN_IO);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200858 }
859}
860
861/*
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200862 * This function performs a shutdown-read on a stream connector attached to an
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200863 * applet in a connected or init state (it does nothing for other states). It
864 * either shuts the read side or marks itself as closed. The buffer flags are
Willy Tarreaucb041662022-05-17 19:44:42 +0200865 * updated to reflect the new state. If the stream connector has SC_FL_NOHALF,
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200866 * we also forward the close to the write side. The owner task is woken up if
867 * it exists.
868 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200869static void sc_app_shutr_applet(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200870{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200871 struct channel *ic = sc_ic(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200872
Willy Tarreau0adb2812022-05-27 10:02:48 +0200873 BUG_ON(!sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200874
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200875 if (ic->flags & CF_SHUTR)
876 return;
877 ic->flags |= CF_SHUTR;
878 ic->rex = TICK_ETERNITY;
879
880 /* Note: on shutr, we don't call the applet */
881
Willy Tarreau0adb2812022-05-27 10:02:48 +0200882 if (!sc_state_in(sc->state, SC_SB_CON|SC_SB_RDY|SC_SB_EST))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200883 return;
884
Willy Tarreau0adb2812022-05-27 10:02:48 +0200885 if (sc_oc(sc)->flags & CF_SHUTW) {
886 appctx_shut(__sc_appctx(sc));
887 sc->state = SC_ST_DIS;
Christopher Fauletca679922022-07-20 13:24:04 +0200888 if (sc->flags & SC_FL_ISBACK)
889 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200890 }
Willy Tarreau0adb2812022-05-27 10:02:48 +0200891 else if (sc->flags & SC_FL_NOHALF) {
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200892 /* we want to immediately forward this close to the write side */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200893 return sc_app_shutw_applet(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200894 }
895}
896
897/*
Willy Tarreau3a3f4802022-05-17 18:28:19 +0200898 * This function performs a shutdown-write on a stream connector attached to an
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200899 * applet in a connected or init state (it does nothing for other states). It
900 * either shuts the write side or marks itself as closed. The buffer flags are
901 * updated to reflect the new state. It does also close everything if the SI
902 * was marked as being in error state. The owner task is woken up if it exists.
903 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200904static void sc_app_shutw_applet(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200905{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200906 struct channel *ic = sc_ic(sc);
907 struct channel *oc = sc_oc(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200908
Willy Tarreau0adb2812022-05-27 10:02:48 +0200909 BUG_ON(!sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200910
911 oc->flags &= ~CF_SHUTW_NOW;
912 if (oc->flags & CF_SHUTW)
913 return;
914 oc->flags |= CF_SHUTW;
915 oc->wex = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200916
Willy Tarreau0adb2812022-05-27 10:02:48 +0200917 if (tick_isset(sc->hcto)) {
918 ic->rto = sc->hcto;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200919 ic->rex = tick_add(now_ms, ic->rto);
920 }
921
922 /* on shutw we always wake the applet up */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200923 appctx_wakeup(__sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200924
Willy Tarreau0adb2812022-05-27 10:02:48 +0200925 switch (sc->state) {
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200926 case SC_ST_RDY:
927 case SC_ST_EST:
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200928 /* we have to shut before closing, otherwise some short messages
929 * may never leave the system, especially when there are remaining
930 * unread data in the socket input buffer, or when nolinger is set.
Willy Tarreaucb041662022-05-17 19:44:42 +0200931 * However, if SC_FL_NOLINGER is explicitly set, we know there is
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200932 * no risk so we close both sides immediately.
933 */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200934 if (!sc_ep_test(sc, SE_FL_ERROR) && !(sc->flags & SC_FL_NOLINGER) &&
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200935 !(ic->flags & (CF_SHUTR|CF_DONT_READ)))
936 return;
937
938 /* fall through */
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200939 case SC_ST_CON:
940 case SC_ST_CER:
941 case SC_ST_QUE:
942 case SC_ST_TAR:
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200943 /* Note that none of these states may happen with applets */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200944 appctx_shut(__sc_appctx(sc));
945 sc->state = SC_ST_DIS;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200946 /* fall through */
947 default:
Willy Tarreau0adb2812022-05-27 10:02:48 +0200948 sc->flags &= ~SC_FL_NOLINGER;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200949 ic->flags |= CF_SHUTR;
950 ic->rex = TICK_ETERNITY;
Christopher Fauletca679922022-07-20 13:24:04 +0200951 if (sc->flags & SC_FL_ISBACK)
952 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200953 }
954}
955
956/* chk_rcv function for applets */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200957static void sc_app_chk_rcv_applet(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200958{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200959 struct channel *ic = sc_ic(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200960
Willy Tarreau0adb2812022-05-27 10:02:48 +0200961 BUG_ON(!sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200962
Willy Tarreau0adb2812022-05-27 10:02:48 +0200963 DPRINTF(stderr, "%s: sc=%p, sc->state=%d ic->flags=%08x oc->flags=%08x\n",
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200964 __FUNCTION__,
Willy Tarreau0adb2812022-05-27 10:02:48 +0200965 sc, sc->state, ic->flags, sc_oc(sc)->flags);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200966
967 if (!ic->pipe) {
968 /* (re)start reading */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200969 appctx_wakeup(__sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200970 }
971}
972
973/* chk_snd function for applets */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200974static void sc_app_chk_snd_applet(struct stconn *sc)
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200975{
Willy Tarreau0adb2812022-05-27 10:02:48 +0200976 struct channel *oc = sc_oc(sc);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200977
Willy Tarreau0adb2812022-05-27 10:02:48 +0200978 BUG_ON(!sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200979
Willy Tarreau0adb2812022-05-27 10:02:48 +0200980 DPRINTF(stderr, "%s: sc=%p, sc->state=%d ic->flags=%08x oc->flags=%08x\n",
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200981 __FUNCTION__,
Willy Tarreau0adb2812022-05-27 10:02:48 +0200982 sc, sc->state, sc_ic(sc)->flags, oc->flags);
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200983
Willy Tarreau0adb2812022-05-27 10:02:48 +0200984 if (unlikely(sc->state != SC_ST_EST || (oc->flags & CF_SHUTW)))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200985 return;
986
Christopher Faulet04f03e12022-06-01 17:35:34 +0200987 /* we only wake the applet up if it was waiting for some data and is ready to consume it */
988 if (!sc_ep_test(sc, SE_FL_WAIT_DATA) || sc_ep_test(sc, SE_FL_WONT_CONSUME))
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200989 return;
990
991 if (!tick_isset(oc->wex))
992 oc->wex = tick_add_ifset(now_ms, oc->wto);
993
994 if (!channel_is_empty(oc)) {
995 /* (re)start sending */
Willy Tarreau0adb2812022-05-27 10:02:48 +0200996 appctx_wakeup(__sc_appctx(sc));
Christopher Faulet9ffddd52022-04-01 14:04:29 +0200997 }
998}
Christopher Faulet13045f02022-04-01 14:23:38 +0200999
1000
1001/* This function is designed to be called from within the stream handler to
Willy Tarreau4596fe22022-05-17 19:07:51 +02001002 * update the input channel's expiration timer and the stream connector's
Christopher Faulet13045f02022-04-01 14:23:38 +02001003 * Rx flags based on the channel's flags. It needs to be called only once
1004 * after the channel's flags have settled down, and before they are cleared,
1005 * though it doesn't harm to call it as often as desired (it just slightly
1006 * hurts performance). It must not be called from outside of the stream
1007 * handler, as what it does will be used to compute the stream task's
1008 * expiration.
1009 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001010void sc_update_rx(struct stconn *sc)
Christopher Faulet13045f02022-04-01 14:23:38 +02001011{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001012 struct channel *ic = sc_ic(sc);
Christopher Faulet13045f02022-04-01 14:23:38 +02001013
Willy Tarreau676c8db2022-05-24 16:22:24 +02001014 if (ic->flags & CF_SHUTR)
Christopher Faulet13045f02022-04-01 14:23:38 +02001015 return;
Christopher Faulet13045f02022-04-01 14:23:38 +02001016
1017 /* Read not closed, update FD status and timeout for reads */
1018 if (ic->flags & CF_DONT_READ)
Willy Tarreau0adb2812022-05-27 10:02:48 +02001019 sc_wont_read(sc);
Christopher Faulet13045f02022-04-01 14:23:38 +02001020 else
Willy Tarreau0adb2812022-05-27 10:02:48 +02001021 sc_will_read(sc);
Christopher Faulet13045f02022-04-01 14:23:38 +02001022
1023 if (!channel_is_empty(ic) || !channel_may_recv(ic)) {
1024 /* stop reading, imposed by channel's policy or contents */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001025 sc_need_room(sc);
Christopher Faulet13045f02022-04-01 14:23:38 +02001026 }
1027 else {
1028 /* (re)start reading and update timeout. Note: we don't recompute the timeout
1029 * every time we get here, otherwise it would risk never to expire. We only
1030 * update it if is was not yet set. The stream socket handler will already
1031 * have updated it if there has been a completed I/O.
1032 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001033 sc_have_room(sc);
Christopher Faulet13045f02022-04-01 14:23:38 +02001034 }
Willy Tarreau0adb2812022-05-27 10:02:48 +02001035 if (sc->flags & (SC_FL_WONT_READ|SC_FL_NEED_BUFF|SC_FL_NEED_ROOM))
Christopher Faulet13045f02022-04-01 14:23:38 +02001036 ic->rex = TICK_ETERNITY;
1037 else if (!(ic->flags & CF_READ_NOEXP) && !tick_isset(ic->rex))
1038 ic->rex = tick_add_ifset(now_ms, ic->rto);
1039
Willy Tarreau0adb2812022-05-27 10:02:48 +02001040 sc_chk_rcv(sc);
Christopher Faulet13045f02022-04-01 14:23:38 +02001041}
1042
1043/* This function is designed to be called from within the stream handler to
Willy Tarreau4596fe22022-05-17 19:07:51 +02001044 * update the output channel's expiration timer and the stream connector's
Christopher Faulet13045f02022-04-01 14:23:38 +02001045 * Tx flags based on the channel's flags. It needs to be called only once
1046 * after the channel's flags have settled down, and before they are cleared,
1047 * though it doesn't harm to call it as often as desired (it just slightly
1048 * hurts performance). It must not be called from outside of the stream
1049 * handler, as what it does will be used to compute the stream task's
1050 * expiration.
1051 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001052void sc_update_tx(struct stconn *sc)
Christopher Faulet13045f02022-04-01 14:23:38 +02001053{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001054 struct channel *oc = sc_oc(sc);
1055 struct channel *ic = sc_ic(sc);
Christopher Faulet13045f02022-04-01 14:23:38 +02001056
1057 if (oc->flags & CF_SHUTW)
1058 return;
1059
1060 /* Write not closed, update FD status and timeout for writes */
1061 if (channel_is_empty(oc)) {
1062 /* stop writing */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001063 if (!sc_ep_test(sc, SE_FL_WAIT_DATA)) {
Christopher Faulet13045f02022-04-01 14:23:38 +02001064 if ((oc->flags & CF_SHUTW_NOW) == 0)
Willy Tarreau0adb2812022-05-27 10:02:48 +02001065 sc_ep_set(sc, SE_FL_WAIT_DATA);
Christopher Faulet13045f02022-04-01 14:23:38 +02001066 oc->wex = TICK_ETERNITY;
1067 }
1068 return;
1069 }
1070
1071 /* (re)start writing and update timeout. Note: we don't recompute the timeout
1072 * every time we get here, otherwise it would risk never to expire. We only
1073 * update it if is was not yet set. The stream socket handler will already
1074 * have updated it if there has been a completed I/O.
1075 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001076 sc_ep_clr(sc, SE_FL_WAIT_DATA);
Christopher Faulet13045f02022-04-01 14:23:38 +02001077 if (!tick_isset(oc->wex)) {
1078 oc->wex = tick_add_ifset(now_ms, oc->wto);
Willy Tarreau0adb2812022-05-27 10:02:48 +02001079 if (tick_isset(ic->rex) && !(sc->flags & SC_FL_INDEP_STR)) {
Christopher Faulet13045f02022-04-01 14:23:38 +02001080 /* Note: depending on the protocol, we don't know if we're waiting
1081 * for incoming data or not. So in order to prevent the socket from
1082 * expiring read timeouts during writes, we refresh the read timeout,
1083 * except if it was already infinite or if we have explicitly setup
1084 * independent streams.
1085 */
1086 ic->rex = tick_add_ifset(now_ms, ic->rto);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001087 }
1088 }
1089}
1090
Willy Tarreau19c65a92022-05-27 08:49:24 +02001091/* This function is the equivalent to sc_update() except that it's
Christopher Faulet5e29b762022-04-04 08:58:34 +02001092 * designed to be called from outside the stream handlers, typically the lower
1093 * layers (applets, connections) after I/O completion. After updating the stream
1094 * interface and timeouts, it will try to forward what can be forwarded, then to
1095 * wake the associated task up if an important event requires special handling.
Willy Tarreau15252cd2022-05-25 16:36:21 +02001096 * It may update SE_FL_WAIT_DATA and/or SC_FL_NEED_ROOM, that the callers are
Christopher Faulet5e29b762022-04-04 08:58:34 +02001097 * encouraged to watch to take appropriate action.
Willy Tarreau19c65a92022-05-27 08:49:24 +02001098 * It should not be called from within the stream itself, sc_update()
Christopher Faulet5e29b762022-04-04 08:58:34 +02001099 * is designed for this.
1100 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001101static void sc_notify(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001102{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001103 struct channel *ic = sc_ic(sc);
1104 struct channel *oc = sc_oc(sc);
Willy Tarreaue68bc612022-05-27 11:23:05 +02001105 struct stconn *sco = sc_opposite(sc);
Willy Tarreau0adb2812022-05-27 10:02:48 +02001106 struct task *task = sc_strm_task(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001107
1108 /* process consumer side */
1109 if (channel_is_empty(oc)) {
Willy Tarreau0adb2812022-05-27 10:02:48 +02001110 struct connection *conn = sc_conn(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001111
1112 if (((oc->flags & (CF_SHUTW|CF_SHUTW_NOW)) == CF_SHUTW_NOW) &&
Willy Tarreau0adb2812022-05-27 10:02:48 +02001113 (sc->state == SC_ST_EST) && (!conn || !(conn->flags & (CO_FL_WAIT_XPRT | CO_FL_EARLY_SSL_HS))))
1114 sc_shutw(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001115 oc->wex = TICK_ETERNITY;
1116 }
1117
1118 /* indicate that we may be waiting for data from the output channel or
1119 * we're about to close and can't expect more data if SHUTW_NOW is there.
1120 */
1121 if (!(oc->flags & (CF_SHUTW|CF_SHUTW_NOW)))
Willy Tarreau0adb2812022-05-27 10:02:48 +02001122 sc_ep_set(sc, SE_FL_WAIT_DATA);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001123 else if ((oc->flags & (CF_SHUTW|CF_SHUTW_NOW)) == CF_SHUTW_NOW)
Willy Tarreau0adb2812022-05-27 10:02:48 +02001124 sc_ep_clr(sc, SE_FL_WAIT_DATA);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001125
1126 /* update OC timeouts and wake the other side up if it's waiting for room */
1127 if (oc->flags & CF_WRITE_ACTIVITY) {
1128 if ((oc->flags & (CF_SHUTW|CF_WRITE_PARTIAL)) == CF_WRITE_PARTIAL &&
1129 !channel_is_empty(oc))
1130 if (tick_isset(oc->wex))
1131 oc->wex = tick_add_ifset(now_ms, oc->wto);
1132
Willy Tarreau0adb2812022-05-27 10:02:48 +02001133 if (!(sc->flags & SC_FL_INDEP_STR))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001134 if (tick_isset(ic->rex))
1135 ic->rex = tick_add_ifset(now_ms, ic->rto);
1136 }
1137
1138 if (oc->flags & CF_DONT_READ)
Willy Tarreaue68bc612022-05-27 11:23:05 +02001139 sc_wont_read(sco);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001140 else
Willy Tarreaue68bc612022-05-27 11:23:05 +02001141 sc_will_read(sco);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001142
1143 /* Notify the other side when we've injected data into the IC that
1144 * needs to be forwarded. We can do fast-forwarding as soon as there
1145 * are output data, but we avoid doing this if some of the data are
1146 * not yet scheduled for being forwarded, because it is very likely
1147 * that it will be done again immediately afterwards once the following
Willy Tarreau15252cd2022-05-25 16:36:21 +02001148 * data are parsed (eg: HTTP chunking). We only clear SC_FL_NEED_ROOM
1149 * once we've emptied *some* of the output buffer, and not just when
1150 * there is available room, because applets are often forced to stop
1151 * before the buffer is full. We must not stop based on input data
1152 * alone because an HTTP parser might need more data to complete the
1153 * parsing.
Christopher Faulet5e29b762022-04-04 08:58:34 +02001154 */
1155 if (!channel_is_empty(ic) &&
Willy Tarreaue68bc612022-05-27 11:23:05 +02001156 sc_ep_test(sco, SE_FL_WAIT_DATA) &&
Christopher Faulet5e29b762022-04-04 08:58:34 +02001157 (!(ic->flags & CF_EXPECT_MORE) || c_full(ic) || ci_data(ic) == 0 || ic->pipe)) {
1158 int new_len, last_len;
1159
1160 last_len = co_data(ic);
1161 if (ic->pipe)
1162 last_len += ic->pipe->data;
1163
Willy Tarreaue68bc612022-05-27 11:23:05 +02001164 sc_chk_snd(sco);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001165
1166 new_len = co_data(ic);
1167 if (ic->pipe)
1168 new_len += ic->pipe->data;
1169
1170 /* check if the consumer has freed some space either in the
1171 * buffer or in the pipe.
1172 */
1173 if (new_len < last_len)
Willy Tarreau0adb2812022-05-27 10:02:48 +02001174 sc_have_room(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001175 }
1176
1177 if (!(ic->flags & CF_DONT_READ))
Willy Tarreau0adb2812022-05-27 10:02:48 +02001178 sc_will_read(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001179
Willy Tarreau0adb2812022-05-27 10:02:48 +02001180 sc_chk_rcv(sc);
Willy Tarreaue68bc612022-05-27 11:23:05 +02001181 sc_chk_rcv(sco);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001182
Willy Tarreau0adb2812022-05-27 10:02:48 +02001183 if (ic->flags & CF_SHUTR || sc_ep_test(sc, SE_FL_APPLET_NEED_CONN) ||
1184 (sc->flags & (SC_FL_WONT_READ|SC_FL_NEED_BUFF|SC_FL_NEED_ROOM))) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001185 ic->rex = TICK_ETERNITY;
1186 }
1187 else if ((ic->flags & (CF_SHUTR|CF_READ_PARTIAL)) == CF_READ_PARTIAL) {
Willy Tarreauf61dd192022-05-27 09:00:19 +02001188 /* we must re-enable reading if sc_chk_snd() has freed some space */
Christopher Faulet5e29b762022-04-04 08:58:34 +02001189 if (!(ic->flags & CF_READ_NOEXP) && tick_isset(ic->rex))
1190 ic->rex = tick_add_ifset(now_ms, ic->rto);
1191 }
1192
1193 /* wake the task up only when needed */
1194 if (/* changes on the production side */
1195 (ic->flags & (CF_READ_NULL|CF_READ_ERROR)) ||
Willy Tarreau0adb2812022-05-27 10:02:48 +02001196 !sc_state_in(sc->state, SC_SB_CON|SC_SB_RDY|SC_SB_EST) ||
1197 sc_ep_test(sc, SE_FL_ERROR) ||
Christopher Faulet5e29b762022-04-04 08:58:34 +02001198 ((ic->flags & CF_READ_PARTIAL) &&
Willy Tarreaue68bc612022-05-27 11:23:05 +02001199 ((ic->flags & CF_EOI) || !ic->to_forward || sco->state != SC_ST_EST)) ||
Christopher Faulet5e29b762022-04-04 08:58:34 +02001200
1201 /* changes on the consumption side */
1202 (oc->flags & (CF_WRITE_NULL|CF_WRITE_ERROR)) ||
1203 ((oc->flags & CF_WRITE_ACTIVITY) &&
1204 ((oc->flags & CF_SHUTW) ||
1205 (((oc->flags & CF_WAKE_WRITE) ||
1206 !(oc->flags & (CF_AUTO_CLOSE|CF_SHUTW_NOW|CF_SHUTW))) &&
Willy Tarreaue68bc612022-05-27 11:23:05 +02001207 (sco->state != SC_ST_EST ||
Christopher Faulet5e29b762022-04-04 08:58:34 +02001208 (channel_is_empty(oc) && !oc->to_forward)))))) {
1209 task_wakeup(task, TASK_WOKEN_IO);
1210 }
1211 else {
1212 /* Update expiration date for the task and requeue it */
1213 task->expire = tick_first((tick_is_expired(task->expire, now_ms) ? 0 : task->expire),
1214 tick_first(tick_first(ic->rex, ic->wex),
1215 tick_first(oc->rex, oc->wex)));
1216
1217 task->expire = tick_first(task->expire, ic->analyse_exp);
1218 task->expire = tick_first(task->expire, oc->analyse_exp);
Willy Tarreau0adb2812022-05-27 10:02:48 +02001219 task->expire = tick_first(task->expire, __sc_strm(sc)->conn_exp);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001220
1221 task_queue(task);
1222 }
1223 if (ic->flags & CF_READ_ACTIVITY)
1224 ic->flags &= ~CF_READ_DONTWAIT;
1225}
1226
1227/*
1228 * This function propagates a null read received on a socket-based connection.
Willy Tarreaucb041662022-05-17 19:44:42 +02001229 * It updates the stream connector. If the stream connector has SC_FL_NOHALF,
Christopher Faulet5e29b762022-04-04 08:58:34 +02001230 * the close is also forwarded to the write side as an abort.
1231 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001232static void sc_conn_read0(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001233{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001234 struct channel *ic = sc_ic(sc);
1235 struct channel *oc = sc_oc(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001236
Willy Tarreau0adb2812022-05-27 10:02:48 +02001237 BUG_ON(!sc_conn(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001238
Christopher Faulet5e29b762022-04-04 08:58:34 +02001239 if (ic->flags & CF_SHUTR)
1240 return;
1241 ic->flags |= CF_SHUTR;
1242 ic->rex = TICK_ETERNITY;
1243
Willy Tarreau0adb2812022-05-27 10:02:48 +02001244 if (!sc_state_in(sc->state, SC_SB_CON|SC_SB_RDY|SC_SB_EST))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001245 return;
1246
1247 if (oc->flags & CF_SHUTW)
1248 goto do_close;
1249
Willy Tarreau0adb2812022-05-27 10:02:48 +02001250 if (sc->flags & SC_FL_NOHALF) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001251 /* we want to immediately forward this close to the write side */
1252 /* force flag on ssl to keep stream in cache */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001253 sc_conn_shutw(sc, CO_SHW_SILENT);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001254 goto do_close;
1255 }
1256
1257 /* otherwise that's just a normal read shutdown */
1258 return;
1259
1260 do_close:
Willy Tarreauf61dd192022-05-27 09:00:19 +02001261 /* OK we completely close the socket here just as if we went through sc_shut[rw]() */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001262 sc_conn_shut(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001263
1264 oc->flags &= ~CF_SHUTW_NOW;
1265 oc->flags |= CF_SHUTW;
1266 oc->wex = TICK_ETERNITY;
1267
Willy Tarreau0adb2812022-05-27 10:02:48 +02001268 sc->state = SC_ST_DIS;
Christopher Fauletca679922022-07-20 13:24:04 +02001269 if (sc->flags & SC_FL_ISBACK)
1270 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001271 return;
1272}
1273
1274/*
1275 * This is the callback which is called by the connection layer to receive data
1276 * into the buffer from the connection. It iterates over the mux layer's
1277 * rcv_buf function.
1278 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001279static int sc_conn_recv(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001280{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001281 struct connection *conn = __sc_conn(sc);
1282 struct channel *ic = sc_ic(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001283 int ret, max, cur_read = 0;
1284 int read_poll = MAX_READ_POLL_LOOPS;
1285 int flags = 0;
1286
1287 /* If not established yet, do nothing. */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001288 if (sc->state != SC_ST_EST)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001289 return 0;
1290
Willy Tarreau462b9892022-05-18 18:06:53 +02001291 /* If another call to sc_conn_recv() failed, and we subscribed to
Christopher Faulet5e29b762022-04-04 08:58:34 +02001292 * recv events already, give up now.
1293 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001294 if (sc->wait_event.events & SUB_RETRY_RECV)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001295 return 0;
1296
1297 /* maybe we were called immediately after an asynchronous shutr */
1298 if (ic->flags & CF_SHUTR)
1299 return 1;
1300
1301 /* we must wait because the mux is not installed yet */
1302 if (!conn->mux)
1303 return 0;
1304
1305 /* stop here if we reached the end of data */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001306 if (sc_ep_test(sc, SE_FL_EOS))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001307 goto end_recv;
1308
1309 /* stop immediately on errors. Note that we DON'T want to stop on
1310 * POLL_ERR, as the poller might report a write error while there
1311 * are still data available in the recv buffer. This typically
1312 * happens when we send too large a request to a backend server
1313 * which rejects it before reading it all.
1314 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001315 if (!sc_ep_test(sc, SE_FL_RCV_MORE)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001316 if (!conn_xprt_ready(conn))
1317 return 0;
Willy Tarreau0adb2812022-05-27 10:02:48 +02001318 if (sc_ep_test(sc, SE_FL_ERROR))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001319 goto end_recv;
1320 }
1321
1322 /* prepare to detect if the mux needs more room */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001323 sc_ep_clr(sc, SE_FL_WANT_ROOM);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001324
1325 if ((ic->flags & (CF_STREAMER | CF_STREAMER_FAST)) && !co_data(ic) &&
1326 global.tune.idle_timer &&
1327 (unsigned short)(now_ms - ic->last_read) >= global.tune.idle_timer) {
1328 /* The buffer was empty and nothing was transferred for more
1329 * than one second. This was caused by a pause and not by
1330 * congestion. Reset any streaming mode to reduce latency.
1331 */
1332 ic->xfer_small = 0;
1333 ic->xfer_large = 0;
1334 ic->flags &= ~(CF_STREAMER | CF_STREAMER_FAST);
1335 }
1336
1337 /* First, let's see if we may splice data across the channel without
1338 * using a buffer.
1339 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001340 if (sc_ep_test(sc, SE_FL_MAY_SPLICE) &&
Christopher Faulet5e29b762022-04-04 08:58:34 +02001341 (ic->pipe || ic->to_forward >= MIN_SPLICE_FORWARD) &&
1342 ic->flags & CF_KERN_SPLICING) {
1343 if (c_data(ic)) {
1344 /* We're embarrassed, there are already data pending in
1345 * the buffer and we don't want to have them at two
1346 * locations at a time. Let's indicate we need some
1347 * place and ask the consumer to hurry.
1348 */
1349 flags |= CO_RFL_BUF_FLUSH;
1350 goto abort_splice;
1351 }
1352
1353 if (unlikely(ic->pipe == NULL)) {
1354 if (pipes_used >= global.maxpipes || !(ic->pipe = get_pipe())) {
1355 ic->flags &= ~CF_KERN_SPLICING;
1356 goto abort_splice;
1357 }
1358 }
1359
Willy Tarreau0adb2812022-05-27 10:02:48 +02001360 ret = conn->mux->rcv_pipe(sc, ic->pipe, ic->to_forward);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001361 if (ret < 0) {
1362 /* splice not supported on this end, let's disable it */
1363 ic->flags &= ~CF_KERN_SPLICING;
1364 goto abort_splice;
1365 }
1366
1367 if (ret > 0) {
1368 if (ic->to_forward != CHN_INFINITE_FORWARD)
1369 ic->to_forward -= ret;
1370 ic->total += ret;
1371 cur_read += ret;
1372 ic->flags |= CF_READ_PARTIAL;
1373 }
1374
Willy Tarreau0adb2812022-05-27 10:02:48 +02001375 if (sc_ep_test(sc, SE_FL_EOS | SE_FL_ERROR))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001376 goto end_recv;
1377
1378 if (conn->flags & CO_FL_WAIT_ROOM) {
1379 /* the pipe is full or we have read enough data that it
1380 * could soon be full. Let's stop before needing to poll.
1381 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001382 sc_need_room(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001383 goto done_recv;
1384 }
1385
1386 /* splice not possible (anymore), let's go on on standard copy */
1387 }
1388
1389 abort_splice:
1390 if (ic->pipe && unlikely(!ic->pipe->data)) {
1391 put_pipe(ic->pipe);
1392 ic->pipe = NULL;
1393 }
1394
Willy Tarreau0adb2812022-05-27 10:02:48 +02001395 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 +02001396 /* don't break splicing by reading, but still call rcv_buf()
1397 * to pass the flag.
1398 */
1399 goto done_recv;
1400 }
1401
1402 /* now we'll need a input buffer for the stream */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001403 if (!sc_alloc_ibuf(sc, &(__sc_strm(sc)->buffer_wait)))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001404 goto end_recv;
1405
1406 /* For an HTX stream, if the buffer is stuck (no output data with some
1407 * input data) and if the HTX message is fragmented or if its free space
1408 * wraps, we force an HTX deframentation. It is a way to have a
1409 * contiguous free space nad to let the mux to copy as much data as
1410 * possible.
1411 *
1412 * NOTE: A possible optim may be to let the mux decides if defrag is
1413 * required or not, depending on amount of data to be xferred.
1414 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001415 if (IS_HTX_STRM(__sc_strm(sc)) && !co_data(ic)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001416 struct htx *htx = htxbuf(&ic->buf);
1417
1418 if (htx_is_not_empty(htx) && ((htx->flags & HTX_FL_FRAGMENTED) || htx_space_wraps(htx)))
1419 htx_defrag(htx, NULL, 0);
1420 }
1421
1422 /* Instruct the mux it must subscribed for read events */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001423 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 +02001424
1425 /* Important note : if we're called with POLL_IN|POLL_HUP, it means the read polling
1426 * was enabled, which implies that the recv buffer was not full. So we have a guarantee
1427 * that if such an event is not handled above in splice, it will be handled here by
1428 * recv().
1429 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001430 while (sc_ep_test(sc, SE_FL_RCV_MORE) ||
Christopher Faulet5e29b762022-04-04 08:58:34 +02001431 (!(conn->flags & CO_FL_HANDSHAKE) &&
Willy Tarreau0adb2812022-05-27 10:02:48 +02001432 (!sc_ep_test(sc, SE_FL_ERROR | SE_FL_EOS)) && !(ic->flags & CF_SHUTR))) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001433 int cur_flags = flags;
1434
1435 /* Compute transient CO_RFL_* flags */
1436 if (co_data(ic)) {
1437 cur_flags |= (CO_RFL_BUF_WET | CO_RFL_BUF_NOT_STUCK);
1438 }
1439
1440 /* <max> may be null. This is the mux responsibility to set
Willy Tarreaue68bc612022-05-27 11:23:05 +02001441 * SE_FL_RCV_MORE on the SC if more space is needed.
Christopher Faulet5e29b762022-04-04 08:58:34 +02001442 */
1443 max = channel_recv_max(ic);
Willy Tarreau0adb2812022-05-27 10:02:48 +02001444 ret = conn->mux->rcv_buf(sc, &ic->buf, max, cur_flags);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001445
Willy Tarreau0adb2812022-05-27 10:02:48 +02001446 if (sc_ep_test(sc, SE_FL_WANT_ROOM)) {
Willy Tarreaub605c422022-05-17 17:04:55 +02001447 /* SE_FL_WANT_ROOM must not be reported if the channel's
Christopher Faulet5e29b762022-04-04 08:58:34 +02001448 * buffer is empty.
1449 */
1450 BUG_ON(c_empty(ic));
1451
Willy Tarreau0adb2812022-05-27 10:02:48 +02001452 sc_need_room(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001453 /* Add READ_PARTIAL because some data are pending but
1454 * cannot be xferred to the channel
1455 */
1456 ic->flags |= CF_READ_PARTIAL;
1457 }
1458
1459 if (ret <= 0) {
1460 /* if we refrained from reading because we asked for a
1461 * flush to satisfy rcv_pipe(), we must not subscribe
1462 * and instead report that there's not enough room
1463 * here to proceed.
1464 */
1465 if (flags & CO_RFL_BUF_FLUSH)
Willy Tarreau0adb2812022-05-27 10:02:48 +02001466 sc_need_room(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001467 break;
1468 }
1469
1470 cur_read += ret;
1471
1472 /* if we're allowed to directly forward data, we must update ->o */
1473 if (ic->to_forward && !(ic->flags & (CF_SHUTW|CF_SHUTW_NOW))) {
1474 unsigned long fwd = ret;
1475 if (ic->to_forward != CHN_INFINITE_FORWARD) {
1476 if (fwd > ic->to_forward)
1477 fwd = ic->to_forward;
1478 ic->to_forward -= fwd;
1479 }
1480 c_adv(ic, fwd);
1481 }
1482
1483 ic->flags |= CF_READ_PARTIAL;
1484 ic->total += ret;
1485
1486 /* End-of-input reached, we can leave. In this case, it is
Willy Tarreaue68bc612022-05-27 11:23:05 +02001487 * important to break the loop to not block the SC because of
Christopher Faulet5e29b762022-04-04 08:58:34 +02001488 * the channel's policies.This way, we are still able to receive
1489 * shutdowns.
1490 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001491 if (sc_ep_test(sc, SE_FL_EOI))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001492 break;
1493
1494 if ((ic->flags & CF_READ_DONTWAIT) || --read_poll <= 0) {
1495 /* we're stopped by the channel's policy */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001496 sc_wont_read(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001497 break;
1498 }
1499
1500 /* if too many bytes were missing from last read, it means that
1501 * it's pointless trying to read again because the system does
1502 * not have them in buffers.
1503 */
1504 if (ret < max) {
1505 /* if a streamer has read few data, it may be because we
1506 * have exhausted system buffers. It's not worth trying
1507 * again.
1508 */
1509 if (ic->flags & CF_STREAMER) {
1510 /* we're stopped by the channel's policy */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001511 sc_wont_read(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001512 break;
1513 }
1514
1515 /* if we read a large block smaller than what we requested,
1516 * it's almost certain we'll never get anything more.
1517 */
1518 if (ret >= global.tune.recv_enough) {
1519 /* we're stopped by the channel's policy */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001520 sc_wont_read(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001521 break;
1522 }
1523 }
1524
1525 /* if we are waiting for more space, don't try to read more data
1526 * right now.
1527 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001528 if (sc->flags & (SC_FL_WONT_READ|SC_FL_NEED_BUFF|SC_FL_NEED_ROOM))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001529 break;
1530 } /* while !flags */
1531
1532 done_recv:
1533 if (cur_read) {
1534 if ((ic->flags & (CF_STREAMER | CF_STREAMER_FAST)) &&
1535 (cur_read <= ic->buf.size / 2)) {
1536 ic->xfer_large = 0;
1537 ic->xfer_small++;
1538 if (ic->xfer_small >= 3) {
1539 /* we have read less than half of the buffer in
1540 * one pass, and this happened at least 3 times.
1541 * This is definitely not a streamer.
1542 */
1543 ic->flags &= ~(CF_STREAMER | CF_STREAMER_FAST);
1544 }
1545 else if (ic->xfer_small >= 2) {
1546 /* if the buffer has been at least half full twice,
1547 * we receive faster than we send, so at least it
1548 * is not a "fast streamer".
1549 */
1550 ic->flags &= ~CF_STREAMER_FAST;
1551 }
1552 }
1553 else if (!(ic->flags & CF_STREAMER_FAST) &&
1554 (cur_read >= ic->buf.size - global.tune.maxrewrite)) {
1555 /* we read a full buffer at once */
1556 ic->xfer_small = 0;
1557 ic->xfer_large++;
1558 if (ic->xfer_large >= 3) {
1559 /* we call this buffer a fast streamer if it manages
1560 * to be filled in one call 3 consecutive times.
1561 */
1562 ic->flags |= (CF_STREAMER | CF_STREAMER_FAST);
1563 }
1564 }
1565 else {
1566 ic->xfer_small = 0;
1567 ic->xfer_large = 0;
1568 }
1569 ic->last_read = now_ms;
1570 }
1571
1572 end_recv:
1573 ret = (cur_read != 0);
1574
1575 /* Report EOI on the channel if it was reached from the mux point of
1576 * view. */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001577 if (sc_ep_test(sc, SE_FL_EOI) && !(ic->flags & CF_EOI)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001578 ic->flags |= (CF_EOI|CF_READ_PARTIAL);
1579 ret = 1;
1580 }
1581
Willy Tarreau0adb2812022-05-27 10:02:48 +02001582 if (sc_ep_test(sc, SE_FL_ERROR))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001583 ret = 1;
Willy Tarreau0adb2812022-05-27 10:02:48 +02001584 else if (sc_ep_test(sc, SE_FL_EOS)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001585 /* we received a shutdown */
1586 ic->flags |= CF_READ_NULL;
1587 if (ic->flags & CF_AUTO_CLOSE)
1588 channel_shutw_now(ic);
Willy Tarreau0adb2812022-05-27 10:02:48 +02001589 sc_conn_read0(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001590 ret = 1;
1591 }
Willy Tarreau0adb2812022-05-27 10:02:48 +02001592 else if (!(sc->flags & (SC_FL_WONT_READ|SC_FL_NEED_BUFF|SC_FL_NEED_ROOM)) &&
Willy Tarreau15252cd2022-05-25 16:36:21 +02001593 !(ic->flags & CF_SHUTR)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001594 /* Subscribe to receive events if we're blocking on I/O */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001595 conn->mux->subscribe(sc, SUB_RETRY_RECV, &sc->wait_event);
1596 se_have_no_more_data(sc->sedesc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001597 } else {
Willy Tarreau0adb2812022-05-27 10:02:48 +02001598 se_have_more_data(sc->sedesc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001599 ret = 1;
1600 }
1601 return ret;
1602}
1603
Willy Tarreau4596fe22022-05-17 19:07:51 +02001604/* This tries to perform a synchronous receive on the stream connector to
Christopher Faulet5e29b762022-04-04 08:58:34 +02001605 * try to collect last arrived data. In practice it's only implemented on
Willy Tarreau4596fe22022-05-17 19:07:51 +02001606 * stconns. Returns 0 if nothing was done, non-zero if new data or a
Christopher Faulet5e29b762022-04-04 08:58:34 +02001607 * shutdown were collected. This may result on some delayed receive calls
1608 * to be programmed and performed later, though it doesn't provide any
1609 * such guarantee.
1610 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001611int sc_conn_sync_recv(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001612{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001613 if (!sc_state_in(sc->state, SC_SB_RDY|SC_SB_EST))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001614 return 0;
1615
Willy Tarreau0adb2812022-05-27 10:02:48 +02001616 if (!sc_mux_ops(sc))
Willy Tarreau4596fe22022-05-17 19:07:51 +02001617 return 0; // only stconns are supported
Christopher Faulet5e29b762022-04-04 08:58:34 +02001618
Willy Tarreau0adb2812022-05-27 10:02:48 +02001619 if (sc->wait_event.events & SUB_RETRY_RECV)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001620 return 0; // already subscribed
1621
Willy Tarreau0adb2812022-05-27 10:02:48 +02001622 if (!sc_is_recv_allowed(sc))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001623 return 0; // already failed
1624
Willy Tarreau0adb2812022-05-27 10:02:48 +02001625 return sc_conn_recv(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001626}
1627
1628/*
1629 * This function is called to send buffer data to a stream socket.
1630 * It calls the mux layer's snd_buf function. It relies on the
1631 * caller to commit polling changes. The caller should check conn->flags
1632 * for errors.
1633 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001634static int sc_conn_send(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001635{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001636 struct connection *conn = __sc_conn(sc);
1637 struct stream *s = __sc_strm(sc);
1638 struct channel *oc = sc_oc(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001639 int ret;
1640 int did_send = 0;
1641
Willy Tarreau0adb2812022-05-27 10:02:48 +02001642 if (sc_ep_test(sc, SE_FL_ERROR | SE_FL_ERR_PENDING) || sc_is_conn_error(sc)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001643 /* We're probably there because the tasklet was woken up,
1644 * but process_stream() ran before, detected there were an
Willy Tarreaue68bc612022-05-27 11:23:05 +02001645 * error and put the SC back to SC_ST_TAR. There's still
Christopher Faulet5e29b762022-04-04 08:58:34 +02001646 * CO_FL_ERROR on the connection but we don't want to add
Willy Tarreaub605c422022-05-17 17:04:55 +02001647 * SE_FL_ERROR back, so give up
Christopher Faulet5e29b762022-04-04 08:58:34 +02001648 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001649 if (sc->state < SC_ST_CON)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001650 return 0;
Willy Tarreau0adb2812022-05-27 10:02:48 +02001651 sc_ep_set(sc, SE_FL_ERROR);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001652 return 1;
1653 }
1654
1655 /* We're already waiting to be able to send, give up */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001656 if (sc->wait_event.events & SUB_RETRY_SEND)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001657 return 0;
1658
1659 /* we might have been called just after an asynchronous shutw */
1660 if (oc->flags & CF_SHUTW)
1661 return 1;
1662
1663 /* we must wait because the mux is not installed yet */
1664 if (!conn->mux)
1665 return 0;
1666
1667 if (oc->pipe && conn->xprt->snd_pipe && conn->mux->snd_pipe) {
Willy Tarreau0adb2812022-05-27 10:02:48 +02001668 ret = conn->mux->snd_pipe(sc, oc->pipe);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001669 if (ret > 0)
1670 did_send = 1;
1671
1672 if (!oc->pipe->data) {
1673 put_pipe(oc->pipe);
1674 oc->pipe = NULL;
1675 }
1676
1677 if (oc->pipe)
1678 goto end;
1679 }
1680
1681 /* At this point, the pipe is empty, but we may still have data pending
1682 * in the normal buffer.
1683 */
1684 if (co_data(oc)) {
1685 /* when we're here, we already know that there is no spliced
1686 * data left, and that there are sendable buffered data.
1687 */
1688
1689 /* check if we want to inform the kernel that we're interested in
1690 * sending more data after this call. We want this if :
1691 * - we're about to close after this last send and want to merge
1692 * the ongoing FIN with the last segment.
1693 * - we know we can't send everything at once and must get back
1694 * here because of unaligned data
1695 * - there is still a finite amount of data to forward
1696 * The test is arranged so that the most common case does only 2
1697 * tests.
1698 */
1699 unsigned int send_flag = 0;
1700
1701 if ((!(oc->flags & (CF_NEVER_WAIT|CF_SEND_DONTWAIT)) &&
1702 ((oc->to_forward && oc->to_forward != CHN_INFINITE_FORWARD) ||
1703 (oc->flags & CF_EXPECT_MORE) ||
1704 (IS_HTX_STRM(s) &&
1705 (!(oc->flags & (CF_EOI|CF_SHUTR)) && htx_expect_more(htxbuf(&oc->buf)))))) ||
1706 ((oc->flags & CF_ISRESP) &&
1707 ((oc->flags & (CF_AUTO_CLOSE|CF_SHUTW_NOW)) == (CF_AUTO_CLOSE|CF_SHUTW_NOW))))
1708 send_flag |= CO_SFL_MSG_MORE;
1709
1710 if (oc->flags & CF_STREAMER)
1711 send_flag |= CO_SFL_STREAMER;
1712
1713 if (s->txn && s->txn->flags & TX_L7_RETRY && !b_data(&s->txn->l7_buffer)) {
1714 /* If we want to be able to do L7 retries, copy
1715 * the data we're about to send, so that we are able
1716 * to resend them if needed
1717 */
1718 /* Try to allocate a buffer if we had none.
1719 * If it fails, the next test will just
1720 * disable the l7 retries by setting
1721 * l7_conn_retries to 0.
1722 */
1723 if (s->txn->req.msg_state != HTTP_MSG_DONE)
1724 s->txn->flags &= ~TX_L7_RETRY;
1725 else {
1726 if (b_alloc(&s->txn->l7_buffer) == NULL)
1727 s->txn->flags &= ~TX_L7_RETRY;
1728 else {
1729 memcpy(b_orig(&s->txn->l7_buffer),
1730 b_orig(&oc->buf),
1731 b_size(&oc->buf));
1732 s->txn->l7_buffer.head = co_data(oc);
1733 b_add(&s->txn->l7_buffer, co_data(oc));
1734 }
1735
1736 }
1737 }
1738
Willy Tarreau0adb2812022-05-27 10:02:48 +02001739 ret = conn->mux->snd_buf(sc, &oc->buf, co_data(oc), send_flag);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001740 if (ret > 0) {
1741 did_send = 1;
1742 c_rew(oc, ret);
1743 c_realign_if_empty(oc);
1744
1745 if (!co_data(oc)) {
1746 /* Always clear both flags once everything has been sent, they're one-shot */
1747 oc->flags &= ~(CF_EXPECT_MORE | CF_SEND_DONTWAIT);
1748 }
1749 /* if some data remain in the buffer, it's only because the
1750 * system buffers are full, we will try next time.
1751 */
Christopher Faulet13045f02022-04-01 14:23:38 +02001752 }
1753 }
Christopher Faulet5e29b762022-04-04 08:58:34 +02001754
1755 end:
1756 if (did_send) {
1757 oc->flags |= CF_WRITE_PARTIAL | CF_WROTE_DATA;
Willy Tarreau0adb2812022-05-27 10:02:48 +02001758 if (sc->state == SC_ST_CON)
1759 sc->state = SC_ST_RDY;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001760
Willy Tarreau0adb2812022-05-27 10:02:48 +02001761 sc_have_room(sc_opposite(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001762 }
1763
Willy Tarreau0adb2812022-05-27 10:02:48 +02001764 if (sc_ep_test(sc, SE_FL_ERROR | SE_FL_ERR_PENDING)) {
1765 sc_ep_set(sc, SE_FL_ERROR);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001766 return 1;
1767 }
1768
1769 /* We couldn't send all of our data, let the mux know we'd like to send more */
1770 if (!channel_is_empty(oc))
Willy Tarreau0adb2812022-05-27 10:02:48 +02001771 conn->mux->subscribe(sc, SUB_RETRY_SEND, &sc->wait_event);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001772 return did_send;
1773}
1774
Willy Tarreau4596fe22022-05-17 19:07:51 +02001775/* perform a synchronous send() for the stream connector. The CF_WRITE_NULL and
Christopher Faulet5e29b762022-04-04 08:58:34 +02001776 * CF_WRITE_PARTIAL flags are cleared prior to the attempt, and will possibly
1777 * be updated in case of success.
1778 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001779void sc_conn_sync_send(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001780{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001781 struct channel *oc = sc_oc(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001782
1783 oc->flags &= ~(CF_WRITE_NULL|CF_WRITE_PARTIAL);
1784
1785 if (oc->flags & CF_SHUTW)
1786 return;
1787
1788 if (channel_is_empty(oc))
1789 return;
1790
Willy Tarreau0adb2812022-05-27 10:02:48 +02001791 if (!sc_state_in(sc->state, SC_SB_CON|SC_SB_RDY|SC_SB_EST))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001792 return;
1793
Willy Tarreau0adb2812022-05-27 10:02:48 +02001794 if (!sc_mux_ops(sc))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001795 return;
1796
Willy Tarreau0adb2812022-05-27 10:02:48 +02001797 sc_conn_send(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001798}
1799
1800/* Called by I/O handlers after completion.. It propagates
Willy Tarreau4596fe22022-05-17 19:07:51 +02001801 * connection flags to the stream connector, updates the stream (which may or
Christopher Faulet5e29b762022-04-04 08:58:34 +02001802 * may not take this opportunity to try to forward data), then update the
Willy Tarreau4596fe22022-05-17 19:07:51 +02001803 * connection's polling based on the channels and stream connector's final
Christopher Faulet5e29b762022-04-04 08:58:34 +02001804 * states. The function always returns 0.
1805 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001806static int sc_conn_process(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001807{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001808 struct connection *conn = __sc_conn(sc);
1809 struct channel *ic = sc_ic(sc);
1810 struct channel *oc = sc_oc(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001811
1812 BUG_ON(!conn);
1813
1814 /* If we have data to send, try it now */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001815 if (!channel_is_empty(oc) && !(sc->wait_event.events & SUB_RETRY_SEND))
1816 sc_conn_send(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001817
Willy Tarreau4596fe22022-05-17 19:07:51 +02001818 /* First step, report to the stream connector what was detected at the
Christopher Faulet5e29b762022-04-04 08:58:34 +02001819 * connection layer : errors and connection establishment.
Willy Tarreaub605c422022-05-17 17:04:55 +02001820 * Only add SE_FL_ERROR if we're connected, or we're attempting to
Christopher Faulet5e29b762022-04-04 08:58:34 +02001821 * connect, we may get there because we got woken up, but only run
1822 * after process_stream() noticed there were an error, and decided
1823 * to retry to connect, the connection may still have CO_FL_ERROR,
Willy Tarreaub605c422022-05-17 17:04:55 +02001824 * and we don't want to add SE_FL_ERROR back
Christopher Faulet5e29b762022-04-04 08:58:34 +02001825 *
Willy Tarreau462b9892022-05-18 18:06:53 +02001826 * Note: This test is only required because sc_conn_process is also the SI
1827 * wake callback. Otherwise sc_conn_recv()/sc_conn_send() already take
Christopher Faulet5e29b762022-04-04 08:58:34 +02001828 * care of it.
1829 */
1830
Willy Tarreau0adb2812022-05-27 10:02:48 +02001831 if (sc->state >= SC_ST_CON) {
1832 if (sc_is_conn_error(sc))
1833 sc_ep_set(sc, SE_FL_ERROR);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001834 }
1835
1836 /* If we had early data, and the handshake ended, then
1837 * we can remove the flag, and attempt to wake the task up,
1838 * in the event there's an analyser waiting for the end of
1839 * the handshake.
1840 */
1841 if (!(conn->flags & (CO_FL_WAIT_XPRT | CO_FL_EARLY_SSL_HS)) &&
Willy Tarreau0adb2812022-05-27 10:02:48 +02001842 sc_ep_test(sc, SE_FL_WAIT_FOR_HS)) {
1843 sc_ep_clr(sc, SE_FL_WAIT_FOR_HS);
1844 task_wakeup(sc_strm_task(sc), TASK_WOKEN_MSG);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001845 }
1846
Willy Tarreau0adb2812022-05-27 10:02:48 +02001847 if (!sc_state_in(sc->state, SC_SB_EST|SC_SB_DIS|SC_SB_CLO) &&
Christopher Faulet5e29b762022-04-04 08:58:34 +02001848 (conn->flags & CO_FL_WAIT_XPRT) == 0) {
Christopher Fauletca679922022-07-20 13:24:04 +02001849 if (sc->flags & SC_FL_ISBACK)
1850 __sc_strm(sc)->conn_exp = TICK_ETERNITY;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001851 oc->flags |= CF_WRITE_NULL;
Willy Tarreau0adb2812022-05-27 10:02:48 +02001852 if (sc->state == SC_ST_CON)
1853 sc->state = SC_ST_RDY;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001854 }
1855
1856 /* Report EOS on the channel if it was reached from the mux point of
1857 * view.
1858 *
Willy Tarreau462b9892022-05-18 18:06:53 +02001859 * Note: This test is only required because sc_conn_process is also the SI
1860 * wake callback. Otherwise sc_conn_recv()/sc_conn_send() already take
Christopher Faulet5e29b762022-04-04 08:58:34 +02001861 * care of it.
1862 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001863 if (sc_ep_test(sc, SE_FL_EOS) && !(ic->flags & CF_SHUTR)) {
Christopher Faulet5e29b762022-04-04 08:58:34 +02001864 /* we received a shutdown */
1865 ic->flags |= CF_READ_NULL;
1866 if (ic->flags & CF_AUTO_CLOSE)
1867 channel_shutw_now(ic);
Willy Tarreau0adb2812022-05-27 10:02:48 +02001868 sc_conn_read0(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001869 }
1870
1871 /* Report EOI on the channel if it was reached from the mux point of
1872 * view.
1873 *
Willy Tarreau462b9892022-05-18 18:06:53 +02001874 * Note: This test is only required because sc_conn_process is also the SI
1875 * wake callback. Otherwise sc_conn_recv()/sc_conn_send() already take
Christopher Faulet5e29b762022-04-04 08:58:34 +02001876 * care of it.
1877 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001878 if (sc_ep_test(sc, SE_FL_EOI) && !(ic->flags & CF_EOI))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001879 ic->flags |= (CF_EOI|CF_READ_PARTIAL);
1880
Willy Tarreau4596fe22022-05-17 19:07:51 +02001881 /* Second step : update the stream connector and channels, try to forward any
Christopher Faulet5e29b762022-04-04 08:58:34 +02001882 * pending data, then possibly wake the stream up based on the new
Willy Tarreau4596fe22022-05-17 19:07:51 +02001883 * stream connector status.
Christopher Faulet5e29b762022-04-04 08:58:34 +02001884 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001885 sc_notify(sc);
1886 stream_release_buffers(__sc_strm(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001887 return 0;
1888}
1889
Willy Tarreau4596fe22022-05-17 19:07:51 +02001890/* This is the ->process() function for any stream connector's wait_event task.
1891 * It's assigned during the stream connector's initialization, for any type of
1892 * stream connector. Thus it is always safe to perform a tasklet_wakeup() on a
Willy Tarreaue68bc612022-05-27 11:23:05 +02001893 * stream connector, as the presence of the SC is checked there.
Christopher Faulet5e29b762022-04-04 08:58:34 +02001894 */
Willy Tarreau462b9892022-05-18 18:06:53 +02001895struct task *sc_conn_io_cb(struct task *t, void *ctx, unsigned int state)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001896{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001897 struct stconn *sc = ctx;
Christopher Faulet5e29b762022-04-04 08:58:34 +02001898 int ret = 0;
1899
Willy Tarreau0adb2812022-05-27 10:02:48 +02001900 if (!sc_conn(sc))
Christopher Faulet5e29b762022-04-04 08:58:34 +02001901 return t;
1902
Willy Tarreau0adb2812022-05-27 10:02:48 +02001903 if (!(sc->wait_event.events & SUB_RETRY_SEND) && !channel_is_empty(sc_oc(sc)))
1904 ret = sc_conn_send(sc);
1905 if (!(sc->wait_event.events & SUB_RETRY_RECV))
1906 ret |= sc_conn_recv(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001907 if (ret != 0)
Willy Tarreau0adb2812022-05-27 10:02:48 +02001908 sc_conn_process(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001909
Willy Tarreau0adb2812022-05-27 10:02:48 +02001910 stream_release_buffers(__sc_strm(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001911 return t;
1912}
1913
1914/* Callback to be used by applet handlers upon completion. It updates the stream
1915 * (which may or may not take this opportunity to try to forward data), then
Willy Tarreau4596fe22022-05-17 19:07:51 +02001916 * may re-enable the applet's based on the channels and stream connector's final
Christopher Faulet5e29b762022-04-04 08:58:34 +02001917 * states.
1918 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001919static int sc_applet_process(struct stconn *sc)
Christopher Faulet5e29b762022-04-04 08:58:34 +02001920{
Willy Tarreau0adb2812022-05-27 10:02:48 +02001921 struct channel *ic = sc_ic(sc);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001922
Willy Tarreau0adb2812022-05-27 10:02:48 +02001923 BUG_ON(!sc_appctx(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001924
1925 /* If the applet wants to write and the channel is closed, it's a
1926 * broken pipe and it must be reported.
1927 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001928 if (!sc_ep_test(sc, SE_FL_HAVE_NO_DATA) && (ic->flags & CF_SHUTR))
1929 sc_ep_set(sc, SE_FL_ERROR);
Christopher Faulet5e29b762022-04-04 08:58:34 +02001930
1931 /* automatically mark the applet having data available if it reported
1932 * begin blocked by the channel.
1933 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001934 if ((sc->flags & (SC_FL_WONT_READ|SC_FL_NEED_BUFF|SC_FL_NEED_ROOM)) ||
1935 sc_ep_test(sc, SE_FL_APPLET_NEED_CONN))
1936 applet_have_more_data(__sc_appctx(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001937
Willy Tarreau4596fe22022-05-17 19:07:51 +02001938 /* update the stream connector, channels, and possibly wake the stream up */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001939 sc_notify(sc);
1940 stream_release_buffers(__sc_strm(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001941
Willy Tarreau19c65a92022-05-27 08:49:24 +02001942 /* sc_notify may have passed through chk_snd and released some blocking
Willy Tarreau15252cd2022-05-25 16:36:21 +02001943 * flags. Process_stream will consider those flags to wake up the
Christopher Faulet5e29b762022-04-04 08:58:34 +02001944 * appctx but in the case the task is not in runqueue we may have to
1945 * wakeup the appctx immediately.
1946 */
Willy Tarreau0adb2812022-05-27 10:02:48 +02001947 if (sc_is_recv_allowed(sc) || sc_is_send_allowed(sc))
1948 appctx_wakeup(__sc_appctx(sc));
Christopher Faulet5e29b762022-04-04 08:58:34 +02001949 return 0;
Christopher Faulet13045f02022-04-01 14:23:38 +02001950}
Christopher Fauletb68f77d2022-06-16 16:24:16 +02001951
1952
1953/* Prepares an endpoint upgrade. We don't now at this stage if the upgrade will
1954 * succeed or not and if the stconn will be reused by the new endpoint. Thus,
1955 * for now, only pretend the stconn is detached.
1956 */
1957void sc_conn_prepare_endp_upgrade(struct stconn *sc)
1958{
1959 BUG_ON(!sc_conn(sc) || !sc->app);
1960 sc_ep_clr(sc, SE_FL_T_MUX);
1961 sc_ep_set(sc, SE_FL_DETACHED);
1962}
1963
Ilya Shipitsin3b64a282022-07-29 22:26:53 +05001964/* Endpoint upgrade failed. Restore the stconn state. */
Christopher Fauletb68f77d2022-06-16 16:24:16 +02001965void sc_conn_abort_endp_upgrade(struct stconn *sc)
1966{
1967 sc_ep_set(sc, SE_FL_T_MUX);
1968 sc_ep_clr(sc, SE_FL_DETACHED);
1969}
1970
1971/* Commit the endpoint upgrade. If stconn is attached, it means the new endpoint
1972 * use it. So we do nothing. Otherwise, the stconn will be destroy with the
1973 * overlying stream. So, it means we must commit the detach.
1974*/
1975void sc_conn_commit_endp_upgrade(struct stconn *sc)
1976{
1977 if (!sc_ep_test(sc, SE_FL_DETACHED))
1978 return;
1979 sc_detach_endp(&sc);
1980 /* Because it was already set as detached, the sedesc must be preserved */
Willy Tarreau6a378d12022-08-11 13:56:42 +02001981 BUG_ON(!sc);
Christopher Fauletb68f77d2022-06-16 16:24:16 +02001982 BUG_ON(!sc->sedesc);
1983}