blob: 33b69a2e294d6d780965f0ef298684a3c176d23c [file] [log] [blame]
Christopher Faulet99eff652019-08-11 23:11:30 +02001/*
2 * FastCGI mux-demux for connections
3 *
4 * Copyright (C) 2019 HAProxy Technologies, 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
Willy Tarreaub2551052020-06-09 09:07:15 +020013#include <import/ist.h>
Willy Tarreau63617db2021-10-06 18:23:40 +020014#include <import/eb32tree.h>
15#include <import/ebmbtree.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020016
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020017#include <haproxy/api.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020018#include <haproxy/cfgparse.h>
Willy Tarreau7ea393d2020-06-04 18:02:10 +020019#include <haproxy/connection.h>
Christopher Faulet1329f2a2021-12-16 17:32:56 +010020#include <haproxy/conn_stream.h>
Christopher Faulet908628c2022-03-25 16:43:49 +010021#include <haproxy/cs_utils.h>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020022#include <haproxy/dynbuf.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020023#include <haproxy/errors.h>
Willy Tarreauc6599682020-06-04 21:33:21 +020024#include <haproxy/fcgi-app.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020025#include <haproxy/fcgi.h>
Willy Tarreau5413a872020-06-02 19:33:08 +020026#include <haproxy/h1.h>
Willy Tarreauc6fe8842020-06-04 09:00:02 +020027#include <haproxy/h1_htx.h>
Willy Tarreau87735332020-06-04 09:08:41 +020028#include <haproxy/http_htx.h>
Willy Tarreau16f958c2020-06-03 08:44:35 +020029#include <haproxy/htx.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020030#include <haproxy/list.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020031#include <haproxy/log.h>
Willy Tarreau6131d6a2020-06-02 16:48:09 +020032#include <haproxy/net_helper.h>
Willy Tarreauc5396bd2021-05-08 20:28:54 +020033#include <haproxy/proxy.h>
Willy Tarreau7cd8b6e2020-06-02 17:32:26 +020034#include <haproxy/regex.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020035#include <haproxy/session-t.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020036#include <haproxy/stream.h>
Willy Tarreauc6d61d72020-06-04 19:02:42 +020037#include <haproxy/trace.h>
Christopher Faulet5cd0e522021-06-11 13:34:42 +020038#include <haproxy/version.h>
Christopher Faulet99eff652019-08-11 23:11:30 +020039
Willy Tarreaub2551052020-06-09 09:07:15 +020040
Christopher Faulet99eff652019-08-11 23:11:30 +020041/* FCGI Connection flags (32 bits) */
42#define FCGI_CF_NONE 0x00000000
43
44/* Flags indicating why writing to the mux is blockes */
45#define FCGI_CF_MUX_MALLOC 0x00000001 /* mux is blocked on lack connection's mux buffer */
46#define FCGI_CF_MUX_MFULL 0x00000002 /* mux is blocked on connection's mux buffer full */
47#define FCGI_CF_MUX_BLOCK_ANY 0x00000003 /* mux is blocked on connection's mux buffer full */
48
49/* Flags indicating why writing to the demux is blocked.
50 * The first two ones directly affect the ability for the mux to receive data
51 * from the connection. The other ones affect the mux's ability to demux
52 * received data.
53 */
54#define FCGI_CF_DEM_DALLOC 0x00000004 /* demux blocked on lack of connection's demux buffer */
55#define FCGI_CF_DEM_DFULL 0x00000008 /* demux blocked on connection's demux buffer full */
56#define FCGI_CF_DEM_MROOM 0x00000010 /* demux blocked on lack of room in mux buffer */
57#define FCGI_CF_DEM_SALLOC 0x00000020 /* demux blocked on lack of stream's rx buffer */
58#define FCGI_CF_DEM_SFULL 0x00000040 /* demux blocked on stream request buffer full */
59#define FCGI_CF_DEM_TOOMANY 0x00000080 /* demux blocked waiting for some conn_streams to leave */
60#define FCGI_CF_DEM_BLOCK_ANY 0x000000F0 /* aggregate of the demux flags above except DALLOC/DFULL */
61
62/* Other flags */
63#define FCGI_CF_MPXS_CONNS 0x00000100 /* connection multiplexing is supported */
64#define FCGI_CF_ABRTS_SENT 0x00000200 /* a record ABORT was successfully sent to all active streams */
65#define FCGI_CF_ABRTS_FAILED 0x00000400 /* failed to abort processing of all streams */
66#define FCGI_CF_WAIT_FOR_HS 0x00000800 /* We did check that at least a stream was waiting for handshake */
Willy Tarreau714f3452021-05-09 06:47:26 +020067#define FCGI_CF_KEEP_CONN 0x00001000 /* HAProxy is responsible to close the connection */
Christopher Faulet99eff652019-08-11 23:11:30 +020068#define FCGI_CF_GET_VALUES 0x00002000 /* retrieve settings */
69
70/* FCGI connection state (fcgi_conn->state) */
71enum fcgi_conn_st {
72 FCGI_CS_INIT = 0, /* init done, waiting for sending GET_VALUES record */
73 FCGI_CS_SETTINGS, /* GET_VALUES sent, waiting for the GET_VALUES_RESULT record */
74 FCGI_CS_RECORD_H, /* GET_VALUES_RESULT received, waiting for a record header */
75 FCGI_CS_RECORD_D, /* Record header OK, waiting for a record data */
76 FCGI_CS_RECORD_P, /* Record processed, remains the padding */
77 FCGI_CS_CLOSED, /* abort requests if necessary and close the connection ASAP */
78 FCGI_CS_ENTRIES
79} __attribute__((packed));
80
81/* 32 buffers: one for the ring's root, rest for the mbuf itself */
82#define FCGI_C_MBUF_CNT 32
83
Christopher Fauletd1ac2b92020-12-02 19:12:22 +010084/* Size for a record header (also size of empty record) */
85#define FCGI_RECORD_HEADER_SZ 8
86
Christopher Faulet99eff652019-08-11 23:11:30 +020087/* FCGI connection descriptor */
88struct fcgi_conn {
89 struct connection *conn;
90
91 enum fcgi_conn_st state; /* FCGI connection state */
92 int16_t max_id; /* highest ID known on this connection, <0 before mgmt records */
93 uint32_t streams_limit; /* maximum number of concurrent streams the peer supports */
94 uint32_t flags; /* Connection flags: FCGI_CF_* */
95
96 int16_t dsi; /* dmux stream ID (<0 = idle ) */
97 uint16_t drl; /* demux record length (if dsi >= 0) */
98 uint8_t drt; /* demux record type (if dsi >= 0) */
99 uint8_t drp; /* demux record padding (if dsi >= 0) */
100
101 struct buffer dbuf; /* demux buffer */
102 struct buffer mbuf[FCGI_C_MBUF_CNT]; /* mux buffers (ring) */
103
104 int timeout; /* idle timeout duration in ticks */
105 int shut_timeout; /* idle timeout duration in ticks after shutdown */
106 unsigned int nb_streams; /* number of streams in the tree */
107 unsigned int nb_cs; /* number of attached conn_streams */
108 unsigned int nb_reserved; /* number of reserved streams */
109 unsigned int stream_cnt; /* total number of streams seen */
110
111 struct proxy *proxy; /* the proxy this connection was created for */
112 struct fcgi_app *app; /* FCGI application used by this mux */
113 struct task *task; /* timeout management task */
114 struct eb_root streams_by_id; /* all active streams by their ID */
115
116 struct list send_list; /* list of blocked streams requesting to send */
Christopher Faulet99eff652019-08-11 23:11:30 +0200117
118 struct buffer_wait buf_wait; /* Wait list for buffer allocation */
119 struct wait_event wait_event; /* To be used if we're waiting for I/Os */
120};
121
122
123/* FCGI stream state, in fcgi_strm->state */
124enum fcgi_strm_st {
125 FCGI_SS_IDLE = 0,
126 FCGI_SS_OPEN,
127 FCGI_SS_HREM, // half-closed(remote)
128 FCGI_SS_HLOC, // half-closed(local)
129 FCGI_SS_ERROR,
130 FCGI_SS_CLOSED,
131 FCGI_SS_ENTRIES
132} __attribute__((packed));
133
134
135/* FCGI stream flags (32 bits) */
136#define FCGI_SF_NONE 0x00000000
137#define FCGI_SF_ES_RCVD 0x00000001 /* end-of-stream received (empty STDOUT or EDN_REQUEST record) */
Christopher Fauletd1ac2b92020-12-02 19:12:22 +0100138#define FCGI_SF_ES_SENT 0x00000002 /* end-of-stream sent (empty STDIN record) */
139#define FCGI_SF_EP_SENT 0x00000004 /* end-of-param sent (empty PARAMS record) */
140#define FCGI_SF_ABRT_SENT 0x00000008 /* abort sent (ABORT_REQUEST record) */
Christopher Faulet99eff652019-08-11 23:11:30 +0200141
142/* Stream flags indicating the reason the stream is blocked */
143#define FCGI_SF_BLK_MBUSY 0x00000010 /* blocked waiting for mux access (transient) */
144#define FCGI_SF_BLK_MROOM 0x00000020 /* blocked waiting for room in the mux */
145#define FCGI_SF_BLK_ANY 0x00000030 /* any of the reasons above */
146
147#define FCGI_SF_BEGIN_SENT 0x00000100 /* a BEGIN_REQUEST record was sent for this stream */
148#define FCGI_SF_OUTGOING_DATA 0x00000200 /* set whenever we've seen outgoing data */
Willy Tarreauf11be0e2020-01-16 16:59:45 +0100149#define FCGI_SF_NOTIFIED 0x00000400 /* a paused stream was notified to try to send again */
Christopher Faulet99eff652019-08-11 23:11:30 +0200150
151#define FCGI_SF_WANT_SHUTR 0x00001000 /* a stream couldn't shutr() (mux full/busy) */
152#define FCGI_SF_WANT_SHUTW 0x00002000 /* a stream couldn't shutw() (mux full/busy) */
Christopher Faulet99eff652019-08-11 23:11:30 +0200153
Christopher Faulet99eff652019-08-11 23:11:30 +0200154
155/* FCGI stream descriptor */
156struct fcgi_strm {
157 struct conn_stream *cs;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +0100158 struct cs_endpoint *endp;
Christopher Faulet99eff652019-08-11 23:11:30 +0200159 struct session *sess;
160 struct fcgi_conn *fconn;
161
162 int32_t id; /* stream ID */
163
164 uint32_t flags; /* Connection flags: FCGI_SF_* */
165 enum fcgi_strm_st state; /* FCGI stream state */
166 int proto_status; /* FCGI_PS_* */
167
168 struct h1m h1m; /* response parser state for H1 */
169
170 struct buffer rxbuf; /* receive buffer, always valid (buf_empty or real buffer) */
171
172 struct eb32_node by_id; /* place in fcgi_conn's streams_by_id */
Willy Tarreau8907e4d2020-01-16 17:55:37 +0100173 struct wait_event *subs; /* Address of the wait_event the conn_stream associated is waiting on */
Christopher Faulet99eff652019-08-11 23:11:30 +0200174 struct list send_list; /* To be used when adding in fcgi_conn->send_list */
Willy Tarreau7aad7032020-01-16 17:20:57 +0100175 struct tasklet *shut_tl; /* deferred shutdown tasklet, to retry to close after we failed to by lack of space */
Christopher Faulet99eff652019-08-11 23:11:30 +0200176};
177
178/* Flags representing all default FCGI parameters */
179#define FCGI_SP_CGI_GATEWAY 0x00000001
180#define FCGI_SP_DOC_ROOT 0x00000002
181#define FCGI_SP_SCRIPT_NAME 0x00000004
182#define FCGI_SP_PATH_INFO 0x00000008
183#define FCGI_SP_REQ_URI 0x00000010
184#define FCGI_SP_REQ_METH 0x00000020
185#define FCGI_SP_REQ_QS 0x00000040
186#define FCGI_SP_SRV_PORT 0x00000080
187#define FCGI_SP_SRV_PROTO 0x00000100
188#define FCGI_SP_SRV_NAME 0x00000200
189#define FCGI_SP_REM_ADDR 0x00000400
190#define FCGI_SP_REM_PORT 0x00000800
191#define FCGI_SP_SCRIPT_FILE 0x00001000
192#define FCGI_SP_PATH_TRANS 0x00002000
193#define FCGI_SP_CONT_LEN 0x00004000
194#define FCGI_SP_HTTPS 0x00008000
Christopher Faulet5cd0e522021-06-11 13:34:42 +0200195#define FCGI_SP_SRV_SOFT 0x00010000
196#define FCGI_SP_MASK 0x0001FFFF
Christopher Faulet99eff652019-08-11 23:11:30 +0200197#define FCGI_SP_URI_MASK (FCGI_SP_SCRIPT_NAME|FCGI_SP_PATH_INFO|FCGI_SP_REQ_QS)
198
199/* FCGI parameters used when PARAMS record is sent */
200struct fcgi_strm_params {
201 uint32_t mask;
202 struct ist docroot;
203 struct ist scriptname;
204 struct ist pathinfo;
205 struct ist meth;
206 struct ist uri;
207 struct ist vsn;
208 struct ist qs;
209 struct ist srv_name;
210 struct ist srv_port;
211 struct ist rem_addr;
212 struct ist rem_port;
213 struct ist cont_len;
Christopher Faulet5cd0e522021-06-11 13:34:42 +0200214 struct ist srv_soft;
Christopher Faulet99eff652019-08-11 23:11:30 +0200215 int https;
216 struct buffer *p;
217};
218
219/* Maximum amount of data we're OK with re-aligning for buffer optimizations */
220#define MAX_DATA_REALIGN 1024
221
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200222/* trace source and events */
223static void fcgi_trace(enum trace_level level, uint64_t mask,
224 const struct trace_source *src,
225 const struct ist where, const struct ist func,
226 const void *a1, const void *a2, const void *a3, const void *a4);
227
228/* The event representation is split like this :
229 * fconn - internal FCGI connection
230 * fstrm - internal FCGI stream
231 * strm - application layer
232 * rx - data receipt
233 * tx - data transmission
234 * rsp - response parsing
235 */
236static const struct trace_event fcgi_trace_events[] = {
237#define FCGI_EV_FCONN_NEW (1ULL << 0)
238 { .mask = FCGI_EV_FCONN_NEW, .name = "fconn_new", .desc = "new FCGI connection" },
239#define FCGI_EV_FCONN_RECV (1ULL << 1)
240 { .mask = FCGI_EV_FCONN_RECV, .name = "fconn_recv", .desc = "Rx on FCGI connection" },
241#define FCGI_EV_FCONN_SEND (1ULL << 2)
242 { .mask = FCGI_EV_FCONN_SEND, .name = "fconn_send", .desc = "Tx on FCGI connection" },
243#define FCGI_EV_FCONN_BLK (1ULL << 3)
244 { .mask = FCGI_EV_FCONN_BLK, .name = "fconn_blk", .desc = "FCGI connection blocked" },
245#define FCGI_EV_FCONN_WAKE (1ULL << 4)
246 { .mask = FCGI_EV_FCONN_WAKE, .name = "fconn_wake", .desc = "FCGI connection woken up" },
247#define FCGI_EV_FCONN_END (1ULL << 5)
248 { .mask = FCGI_EV_FCONN_END, .name = "fconn_end", .desc = "FCGI connection terminated" },
249#define FCGI_EV_FCONN_ERR (1ULL << 6)
250 { .mask = FCGI_EV_FCONN_ERR, .name = "fconn_err", .desc = "error on FCGI connection" },
251
252#define FCGI_EV_RX_FHDR (1ULL << 7)
253 { .mask = FCGI_EV_RX_FHDR, .name = "rx_fhdr", .desc = "FCGI record header received" },
254#define FCGI_EV_RX_RECORD (1ULL << 8)
255 { .mask = FCGI_EV_RX_RECORD, .name = "rx_record", .desc = "receipt of any FCGI record" },
256#define FCGI_EV_RX_EOI (1ULL << 9)
257 { .mask = FCGI_EV_RX_EOI, .name = "rx_eoi", .desc = "receipt of end of FCGI input" },
258#define FCGI_EV_RX_GETVAL (1ULL << 10)
259 { .mask = FCGI_EV_RX_GETVAL, .name = "rx_get_values", .desc = "receipt of FCGI GET_VALUES_RESULT record" },
260#define FCGI_EV_RX_STDOUT (1ULL << 11)
261 { .mask = FCGI_EV_RX_STDOUT, .name = "rx_stdout", .desc = "receipt of FCGI STDOUT record" },
262#define FCGI_EV_RX_STDERR (1ULL << 12)
263 { .mask = FCGI_EV_RX_STDERR, .name = "rx_stderr", .desc = "receipt of FCGI STDERR record" },
264#define FCGI_EV_RX_ENDREQ (1ULL << 13)
265 { .mask = FCGI_EV_RX_ENDREQ, .name = "rx_end_req", .desc = "receipt of FCGI END_REQUEST record" },
266
267#define FCGI_EV_TX_RECORD (1ULL << 14)
268 { .mask = FCGI_EV_TX_RECORD, .name = "tx_record", .desc = "transmission of any FCGI record" },
269#define FCGI_EV_TX_EOI (1ULL << 15)
270 { .mask = FCGI_EV_TX_EOI, .name = "tx_eoi", .desc = "transmission of FCGI end of input" },
271#define FCGI_EV_TX_BEGREQ (1ULL << 16)
272 { .mask = FCGI_EV_TX_BEGREQ, .name = "tx_begin_request", .desc = "transmission of FCGI BEGIN_REQUEST record" },
273#define FCGI_EV_TX_GETVAL (1ULL << 17)
274 { .mask = FCGI_EV_TX_GETVAL, .name = "tx_get_values", .desc = "transmission of FCGI GET_VALUES record" },
275#define FCGI_EV_TX_PARAMS (1ULL << 18)
276 { .mask = FCGI_EV_TX_PARAMS, .name = "tx_params", .desc = "transmission of FCGI PARAMS record" },
277#define FCGI_EV_TX_STDIN (1ULL << 19)
278 { .mask = FCGI_EV_TX_STDIN, .name = "tx_stding", .desc = "transmission of FCGI STDIN record" },
279#define FCGI_EV_TX_ABORT (1ULL << 20)
280 { .mask = FCGI_EV_TX_ABORT, .name = "tx_abort", .desc = "transmission of FCGI ABORT record" },
281
282#define FCGI_EV_RSP_DATA (1ULL << 21)
283 { .mask = FCGI_EV_RSP_DATA, .name = "rsp_data", .desc = "parse any data of H1 response" },
284#define FCGI_EV_RSP_EOM (1ULL << 22)
285 { .mask = FCGI_EV_RSP_EOM, .name = "rsp_eom", .desc = "reach the end of message of H1 response" },
286#define FCGI_EV_RSP_HDRS (1ULL << 23)
287 { .mask = FCGI_EV_RSP_HDRS, .name = "rsp_headers", .desc = "parse headers of H1 response" },
288#define FCGI_EV_RSP_BODY (1ULL << 24)
289 { .mask = FCGI_EV_RSP_BODY, .name = "rsp_body", .desc = "parse body part of H1 response" },
290#define FCGI_EV_RSP_TLRS (1ULL << 25)
291 { .mask = FCGI_EV_RSP_TLRS, .name = "rsp_trailerus", .desc = "parse trailers of H1 response" },
292
293#define FCGI_EV_FSTRM_NEW (1ULL << 26)
294 { .mask = FCGI_EV_FSTRM_NEW, .name = "fstrm_new", .desc = "new FCGI stream" },
295#define FCGI_EV_FSTRM_BLK (1ULL << 27)
296 { .mask = FCGI_EV_FSTRM_BLK, .name = "fstrm_blk", .desc = "FCGI stream blocked" },
297#define FCGI_EV_FSTRM_END (1ULL << 28)
298 { .mask = FCGI_EV_FSTRM_END, .name = "fstrm_end", .desc = "FCGI stream terminated" },
299#define FCGI_EV_FSTRM_ERR (1ULL << 29)
300 { .mask = FCGI_EV_FSTRM_ERR, .name = "fstrm_err", .desc = "error on FCGI stream" },
301
302#define FCGI_EV_STRM_NEW (1ULL << 30)
303 { .mask = FCGI_EV_STRM_NEW, .name = "strm_new", .desc = "app-layer stream creation" },
304#define FCGI_EV_STRM_RECV (1ULL << 31)
305 { .mask = FCGI_EV_STRM_RECV, .name = "strm_recv", .desc = "receiving data for stream" },
306#define FCGI_EV_STRM_SEND (1ULL << 32)
307 { .mask = FCGI_EV_STRM_SEND, .name = "strm_send", .desc = "sending data for stream" },
308#define FCGI_EV_STRM_FULL (1ULL << 33)
309 { .mask = FCGI_EV_STRM_FULL, .name = "strm_full", .desc = "stream buffer full" },
310#define FCGI_EV_STRM_WAKE (1ULL << 34)
311 { .mask = FCGI_EV_STRM_WAKE, .name = "strm_wake", .desc = "stream woken up" },
312#define FCGI_EV_STRM_SHUT (1ULL << 35)
313 { .mask = FCGI_EV_STRM_SHUT, .name = "strm_shut", .desc = "stream shutdown" },
314#define FCGI_EV_STRM_END (1ULL << 36)
315 { .mask = FCGI_EV_STRM_END, .name = "strm_end", .desc = "detaching app-layer stream" },
316#define FCGI_EV_STRM_ERR (1ULL << 37)
317 { .mask = FCGI_EV_STRM_ERR, .name = "strm_err", .desc = "stream error" },
318
319 { }
320};
321
322static const struct name_desc fcgi_trace_lockon_args[4] = {
323 /* arg1 */ { /* already used by the connection */ },
324 /* arg2 */ { .name="fstrm", .desc="FCGI stream" },
325 /* arg3 */ { },
326 /* arg4 */ { }
327};
328
329
330static const struct name_desc fcgi_trace_decoding[] = {
331#define FCGI_VERB_CLEAN 1
332 { .name="clean", .desc="only user-friendly stuff, generally suitable for level \"user\"" },
333#define FCGI_VERB_MINIMAL 2
334 { .name="minimal", .desc="report only fconn/fstrm state and flags, no real decoding" },
335#define FCGI_VERB_SIMPLE 3
336 { .name="simple", .desc="add request/response status line or htx info when available" },
337#define FCGI_VERB_ADVANCED 4
338 { .name="advanced", .desc="add header fields or record decoding when available" },
339#define FCGI_VERB_COMPLETE 5
340 { .name="complete", .desc="add full data dump when available" },
341 { /* end */ }
342};
343
Willy Tarreau6eb3d372021-04-10 19:29:26 +0200344static struct trace_source trace_fcgi __read_mostly = {
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200345 .name = IST("fcgi"),
346 .desc = "FastCGI multiplexer",
347 .arg_def = TRC_ARG1_CONN, // TRACE()'s first argument is always a connection
348 .default_cb = fcgi_trace,
349 .known_events = fcgi_trace_events,
350 .lockon_args = fcgi_trace_lockon_args,
351 .decoding = fcgi_trace_decoding,
352 .report_events = ~0, // report everything by default
353};
354
355#define TRACE_SOURCE &trace_fcgi
356INITCALL1(STG_REGISTER, trace_register_source, TRACE_SOURCE);
357
Christopher Faulet99eff652019-08-11 23:11:30 +0200358/* FCGI connection and stream pools */
359DECLARE_STATIC_POOL(pool_head_fcgi_conn, "fcgi_conn", sizeof(struct fcgi_conn));
360DECLARE_STATIC_POOL(pool_head_fcgi_strm, "fcgi_strm", sizeof(struct fcgi_strm));
361
Willy Tarreau144f84a2021-03-02 16:09:26 +0100362struct task *fcgi_timeout_task(struct task *t, void *context, unsigned int state);
Christopher Faulet99eff652019-08-11 23:11:30 +0200363static int fcgi_process(struct fcgi_conn *fconn);
Willy Tarreau691d5032021-01-20 14:55:01 +0100364/* fcgi_io_cb is exported to see it resolved in "show fd" */
Willy Tarreau144f84a2021-03-02 16:09:26 +0100365struct task *fcgi_io_cb(struct task *t, void *ctx, unsigned int state);
Christopher Faulet99eff652019-08-11 23:11:30 +0200366static inline struct fcgi_strm *fcgi_conn_st_by_id(struct fcgi_conn *fconn, int id);
Willy Tarreau144f84a2021-03-02 16:09:26 +0100367struct task *fcgi_deferred_shut(struct task *t, void *ctx, unsigned int state);
Christopher Faulet99eff652019-08-11 23:11:30 +0200368static struct fcgi_strm *fcgi_conn_stream_new(struct fcgi_conn *fconn, struct conn_stream *cs, struct session *sess);
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200369static void fcgi_strm_notify_recv(struct fcgi_strm *fstrm);
370static void fcgi_strm_notify_send(struct fcgi_strm *fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +0200371static void fcgi_strm_alert(struct fcgi_strm *fstrm);
372static int fcgi_strm_send_abort(struct fcgi_conn *fconn, struct fcgi_strm *fstrm);
373
374/* a dmumy management stream */
375static const struct fcgi_strm *fcgi_mgmt_stream = &(const struct fcgi_strm){
376 .cs = NULL,
377 .fconn = NULL,
378 .state = FCGI_SS_CLOSED,
379 .flags = FCGI_SF_NONE,
380 .id = 0,
381};
382
383/* and a dummy idle stream for use with any unknown stream */
384static const struct fcgi_strm *fcgi_unknown_stream = &(const struct fcgi_strm){
385 .cs = NULL,
386 .fconn = NULL,
387 .state = FCGI_SS_IDLE,
388 .flags = FCGI_SF_NONE,
389 .id = 0,
390};
391
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200392/* returns a fconn state as an abbreviated 3-letter string, or "???" if unknown */
393static inline const char *fconn_st_to_str(enum fcgi_conn_st st)
394{
395 switch (st) {
396 case FCGI_CS_INIT : return "INI";
397 case FCGI_CS_SETTINGS : return "STG";
398 case FCGI_CS_RECORD_H : return "RDH";
399 case FCGI_CS_RECORD_D : return "RDD";
400 case FCGI_CS_RECORD_P : return "RDP";
401 case FCGI_CS_CLOSED : return "CLO";
402 default : return "???";
403 }
404}
405
406/* returns a fstrm state as an abbreviated 3-letter string, or "???" if unknown */
407static inline const char *fstrm_st_to_str(enum fcgi_strm_st st)
408{
409 switch (st) {
410 case FCGI_SS_IDLE : return "IDL";
411 case FCGI_SS_OPEN : return "OPN";
412 case FCGI_SS_HREM : return "RCL";
413 case FCGI_SS_HLOC : return "HCL";
414 case FCGI_SS_ERROR : return "ERR";
415 case FCGI_SS_CLOSED : return "CLO";
416 default : return "???";
417 }
418}
419
420
421/* the FCGI traces always expect that arg1, if non-null, is of type connection
422 * (from which we can derive fconn), that arg2, if non-null, is of type fstrm,
423 * and that arg3, if non-null, is a htx for rx/tx headers.
424 */
425static void fcgi_trace(enum trace_level level, uint64_t mask, const struct trace_source *src,
426 const struct ist where, const struct ist func,
427 const void *a1, const void *a2, const void *a3, const void *a4)
428{
429 const struct connection *conn = a1;
Willy Tarreau31a83062022-01-28 09:36:35 +0100430 struct fcgi_conn *fconn = conn ? conn->ctx : NULL;
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200431 const struct fcgi_strm *fstrm = a2;
432 const struct htx *htx = a3;
433 const size_t *val = a4;
434
435 if (!fconn)
436 fconn = (fstrm ? fstrm->fconn : NULL);
437
438 if (!fconn || src->verbosity < FCGI_VERB_CLEAN)
439 return;
440
441 /* Display the response state if fstrm is defined */
442 if (fstrm)
443 chunk_appendf(&trace_buf, " [rsp:%s]", h1m_state_str(fstrm->h1m.state));
444
445 if (src->verbosity == FCGI_VERB_CLEAN)
446 return;
447
448 /* Display the value to the 4th argument (level > STATE) */
449 if (src->level > TRACE_LEVEL_STATE && val)
Willy Tarreaue18f53e2019-11-27 15:41:31 +0100450 chunk_appendf(&trace_buf, " - VAL=%lu", (long)*val);
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200451
452 /* Display status-line if possible (verbosity > MINIMAL) */
453 if (src->verbosity > FCGI_VERB_MINIMAL && htx && htx_nbblks(htx)) {
454 const struct htx_blk *blk = htx_get_head_blk(htx);
455 const struct htx_sl *sl = htx_get_blk_ptr(htx, blk);
456 enum htx_blk_type type = htx_get_blk_type(blk);
457
458 if (type == HTX_BLK_REQ_SL || type == HTX_BLK_RES_SL)
459 chunk_appendf(&trace_buf, " - \"%.*s %.*s %.*s\"",
460 HTX_SL_P1_LEN(sl), HTX_SL_P1_PTR(sl),
461 HTX_SL_P2_LEN(sl), HTX_SL_P2_PTR(sl),
462 HTX_SL_P3_LEN(sl), HTX_SL_P3_PTR(sl));
463 }
464
465 /* Display fconn info and, if defined, fstrm info */
466 chunk_appendf(&trace_buf, " - fconn=%p(%s,0x%08x)", fconn, fconn_st_to_str(fconn->state), fconn->flags);
467 if (fstrm)
468 chunk_appendf(&trace_buf, " fstrm=%p(%d,%s,0x%08x)", fstrm, fstrm->id, fstrm_st_to_str(fstrm->state), fstrm->flags);
469
470 if (!fstrm || fstrm->id <= 0)
471 chunk_appendf(&trace_buf, " dsi=%d", fconn->dsi);
472 if (fconn->dsi >= 0 && (mask & FCGI_EV_RX_FHDR))
473 chunk_appendf(&trace_buf, " drt=%s", fcgi_rt_str(fconn->drt));
474
475 if (src->verbosity == FCGI_VERB_MINIMAL)
476 return;
477
478 /* Display mbuf and dbuf info (level > USER & verbosity > SIMPLE) */
479 if (src->level > TRACE_LEVEL_USER) {
480 if (src->verbosity == FCGI_VERB_COMPLETE ||
481 (src->verbosity == FCGI_VERB_ADVANCED && (mask & (FCGI_EV_FCONN_RECV|FCGI_EV_RX_RECORD))))
482 chunk_appendf(&trace_buf, " dbuf=%u@%p+%u/%u",
483 (unsigned int)b_data(&fconn->dbuf), b_orig(&fconn->dbuf),
484 (unsigned int)b_head_ofs(&fconn->dbuf), (unsigned int)b_size(&fconn->dbuf));
485 if (src->verbosity == FCGI_VERB_COMPLETE ||
486 (src->verbosity == FCGI_VERB_ADVANCED && (mask & (FCGI_EV_FCONN_SEND|FCGI_EV_TX_RECORD)))) {
Willy Tarreau31a83062022-01-28 09:36:35 +0100487 struct buffer *hmbuf = br_head(fconn->mbuf);
488 struct buffer *tmbuf = br_tail(fconn->mbuf);
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200489
490 chunk_appendf(&trace_buf, " .mbuf=[%u..%u|%u],h=[%u@%p+%u/%u],t=[%u@%p+%u/%u]",
491 br_head_idx(fconn->mbuf), br_tail_idx(fconn->mbuf), br_size(fconn->mbuf),
492 (unsigned int)b_data(hmbuf), b_orig(hmbuf),
493 (unsigned int)b_head_ofs(hmbuf), (unsigned int)b_size(hmbuf),
494 (unsigned int)b_data(tmbuf), b_orig(tmbuf),
495 (unsigned int)b_head_ofs(tmbuf), (unsigned int)b_size(tmbuf));
496 }
497
498 if (fstrm && (src->verbosity == FCGI_VERB_COMPLETE ||
499 (src->verbosity == FCGI_VERB_ADVANCED && (mask & (FCGI_EV_STRM_RECV|FCGI_EV_RSP_DATA)))))
500 chunk_appendf(&trace_buf, " rxbuf=%u@%p+%u/%u",
501 (unsigned int)b_data(&fstrm->rxbuf), b_orig(&fstrm->rxbuf),
502 (unsigned int)b_head_ofs(&fstrm->rxbuf), (unsigned int)b_size(&fstrm->rxbuf));
503 }
504
505 /* Display htx info if defined (level > USER) */
506 if (src->level > TRACE_LEVEL_USER && htx) {
507 int full = 0;
508
509 /* Full htx info (level > STATE && verbosity > SIMPLE) */
510 if (src->level > TRACE_LEVEL_STATE) {
511 if (src->verbosity == FCGI_VERB_COMPLETE)
512 full = 1;
513 else if (src->verbosity == FCGI_VERB_ADVANCED && (mask & (FCGI_EV_RSP_HDRS|FCGI_EV_TX_PARAMS)))
514 full = 1;
515 }
516
517 chunk_memcat(&trace_buf, "\n\t", 2);
518 htx_dump(&trace_buf, htx, full);
519 }
520}
Christopher Faulet99eff652019-08-11 23:11:30 +0200521
522/*****************************************************/
523/* functions below are for dynamic buffer management */
524/*****************************************************/
525
526/* Indicates whether or not the we may call the fcgi_recv() function to attempt
527 * to receive data into the buffer and/or demux pending data. The condition is
528 * a bit complex due to some API limits for now. The rules are the following :
529 * - if an error or a shutdown was detected on the connection and the buffer
530 * is empty, we must not attempt to receive
531 * - if the demux buf failed to be allocated, we must not try to receive and
532 * we know there is nothing pending
533 * - if no flag indicates a blocking condition, we may attempt to receive,
534 * regardless of whether the demux buffer is full or not, so that only
535 * de demux part decides whether or not to block. This is needed because
536 * the connection API indeed prevents us from re-enabling receipt that is
537 * already enabled in a polled state, so we must always immediately stop
538 * as soon as the demux can't proceed so as never to hit an end of read
539 * with data pending in the buffers.
540 * - otherwise must may not attempt
541 */
542static inline int fcgi_recv_allowed(const struct fcgi_conn *fconn)
543{
544 if (b_data(&fconn->dbuf) == 0 &&
545 (fconn->state == FCGI_CS_CLOSED ||
546 fconn->conn->flags & CO_FL_ERROR ||
547 conn_xprt_read0_pending(fconn->conn)))
548 return 0;
549
550 if (!(fconn->flags & FCGI_CF_DEM_DALLOC) &&
551 !(fconn->flags & FCGI_CF_DEM_BLOCK_ANY))
552 return 1;
553
554 return 0;
555}
556
557/* Restarts reading on the connection if it was not enabled */
558static inline void fcgi_conn_restart_reading(const struct fcgi_conn *fconn, int consider_buffer)
559{
560 if (!fcgi_recv_allowed(fconn))
561 return;
562 if ((!consider_buffer || !b_data(&fconn->dbuf)) &&
563 (fconn->wait_event.events & SUB_RETRY_RECV))
564 return;
565 tasklet_wakeup(fconn->wait_event.tasklet);
566}
567
568
569/* Tries to grab a buffer and to re-enable processing on mux <target>. The
570 * fcgi_conn flags are used to figure what buffer was requested. It returns 1 if
571 * the allocation succeeds, in which case the connection is woken up, or 0 if
572 * it's impossible to wake up and we prefer to be woken up later.
573 */
574static int fcgi_buf_available(void *target)
575{
576 struct fcgi_conn *fconn = target;
577 struct fcgi_strm *fstrm;
578
Willy Tarreaud68d4f12021-03-22 14:44:31 +0100579 if ((fconn->flags & FCGI_CF_DEM_DALLOC) && b_alloc(&fconn->dbuf)) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200580 TRACE_STATE("unblocking fconn, dbuf allocated", FCGI_EV_FCONN_RECV|FCGI_EV_FCONN_BLK|FCGI_EV_FCONN_WAKE, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +0200581 fconn->flags &= ~FCGI_CF_DEM_DALLOC;
582 fcgi_conn_restart_reading(fconn, 1);
583 return 1;
584 }
585
Willy Tarreaud68d4f12021-03-22 14:44:31 +0100586 if ((fconn->flags & FCGI_CF_MUX_MALLOC) && b_alloc(br_tail(fconn->mbuf))) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200587 TRACE_STATE("unblocking fconn, mbuf allocated", FCGI_EV_FCONN_SEND|FCGI_EV_FCONN_BLK|FCGI_EV_FCONN_WAKE, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +0200588 fconn->flags &= ~FCGI_CF_MUX_MALLOC;
Christopher Faulet99eff652019-08-11 23:11:30 +0200589 if (fconn->flags & FCGI_CF_DEM_MROOM) {
590 fconn->flags &= ~FCGI_CF_DEM_MROOM;
591 fcgi_conn_restart_reading(fconn, 1);
592 }
593 return 1;
594 }
595
596 if ((fconn->flags & FCGI_CF_DEM_SALLOC) &&
597 (fstrm = fcgi_conn_st_by_id(fconn, fconn->dsi)) && fstrm->cs &&
Willy Tarreaud68d4f12021-03-22 14:44:31 +0100598 b_alloc(&fstrm->rxbuf)) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200599 TRACE_STATE("unblocking fstrm, rxbuf allocated", FCGI_EV_STRM_RECV|FCGI_EV_FSTRM_BLK|FCGI_EV_STRM_WAKE, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +0200600 fconn->flags &= ~FCGI_CF_DEM_SALLOC;
601 fcgi_conn_restart_reading(fconn, 1);
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200602 fcgi_strm_notify_recv(fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +0200603 return 1;
604 }
605
606 return 0;
607}
608
609static inline struct buffer *fcgi_get_buf(struct fcgi_conn *fconn, struct buffer *bptr)
610{
611 struct buffer *buf = NULL;
612
Willy Tarreau2b718102021-04-21 07:32:39 +0200613 if (likely(!LIST_INLIST(&fconn->buf_wait.list)) &&
Willy Tarreaud68d4f12021-03-22 14:44:31 +0100614 unlikely((buf = b_alloc(bptr)) == NULL)) {
Christopher Faulet99eff652019-08-11 23:11:30 +0200615 fconn->buf_wait.target = fconn;
616 fconn->buf_wait.wakeup_cb = fcgi_buf_available;
Willy Tarreaub4e34762021-09-30 19:02:18 +0200617 LIST_APPEND(&th_ctx->buffer_wq, &fconn->buf_wait.list);
Christopher Faulet99eff652019-08-11 23:11:30 +0200618 }
619 return buf;
620}
621
622static inline void fcgi_release_buf(struct fcgi_conn *fconn, struct buffer *bptr)
623{
624 if (bptr->size) {
625 b_free(bptr);
Willy Tarreau4d77bbf2021-02-20 12:02:46 +0100626 offer_buffers(NULL, 1);
Christopher Faulet99eff652019-08-11 23:11:30 +0200627 }
628}
629
630static inline void fcgi_release_mbuf(struct fcgi_conn *fconn)
631{
632 struct buffer *buf;
633 unsigned int count = 0;
634
635 while (b_size(buf = br_head_pick(fconn->mbuf))) {
636 b_free(buf);
637 count++;
638 }
639 if (count)
Willy Tarreau4d77bbf2021-02-20 12:02:46 +0100640 offer_buffers(NULL, count);
Christopher Faulet99eff652019-08-11 23:11:30 +0200641}
642
643/* Returns the number of allocatable outgoing streams for the connection taking
644 * the number reserved streams into account.
645 */
646static inline int fcgi_streams_left(const struct fcgi_conn *fconn)
647{
648 int ret;
649
650 ret = (unsigned int)(0x7FFF - fconn->max_id) - fconn->nb_reserved - 1;
651 if (ret < 0)
652 ret = 0;
653 return ret;
654}
655
656/* Returns the number of streams in use on a connection to figure if it's
657 * idle or not. We check nb_cs and not nb_streams as the caller will want
658 * to know if it was the last one after a detach().
659 */
660static int fcgi_used_streams(struct connection *conn)
661{
662 struct fcgi_conn *fconn = conn->ctx;
663
664 return fconn->nb_cs;
665}
666
667/* Returns the number of concurrent streams available on the connection */
668static int fcgi_avail_streams(struct connection *conn)
669{
670 struct server *srv = objt_server(conn->target);
671 struct fcgi_conn *fconn = conn->ctx;
672 int ret1, ret2;
673
674 /* Don't open new stream if the connection is closed */
675 if (fconn->state == FCGI_CS_CLOSED)
676 return 0;
677
678 /* May be negative if this setting has changed */
679 ret1 = (fconn->streams_limit - fconn->nb_streams);
680
681 /* we must also consider the limit imposed by stream IDs */
682 ret2 = fcgi_streams_left(fconn);
683 ret1 = MIN(ret1, ret2);
684 if (ret1 > 0 && srv && srv->max_reuse >= 0) {
685 ret2 = ((fconn->stream_cnt <= srv->max_reuse) ? srv->max_reuse - fconn->stream_cnt + 1: 0);
686 ret1 = MIN(ret1, ret2);
687 }
688 return ret1;
689}
690
691/*****************************************************************/
692/* functions below are dedicated to the mux setup and management */
693/*****************************************************************/
694
695/* Initializes the mux once it's attached. Only outgoing connections are
696 * supported. So the context is already initialized before installing the
697 * mux. <input> is always used as Input buffer and may contain data. It is the
698 * caller responsibility to not reuse it anymore. Returns < 0 on error.
699 */
700static int fcgi_init(struct connection *conn, struct proxy *px, struct session *sess,
701 struct buffer *input)
702{
703 struct fcgi_conn *fconn;
704 struct fcgi_strm *fstrm;
705 struct fcgi_app *app = get_px_fcgi_app(px);
706 struct task *t = NULL;
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200707 void *conn_ctx = conn->ctx;
708
709 TRACE_ENTER(FCGI_EV_FSTRM_NEW);
Christopher Faulet99eff652019-08-11 23:11:30 +0200710
Christopher Faulet73518be2021-01-27 12:06:54 +0100711 if (!app) {
712 TRACE_ERROR("No FCGI app found, don't create fconn", FCGI_EV_FCONN_NEW|FCGI_EV_FCONN_END|FCGI_EV_FCONN_ERR);
Christopher Faulet99eff652019-08-11 23:11:30 +0200713 goto fail_conn;
Christopher Faulet73518be2021-01-27 12:06:54 +0100714 }
Christopher Faulet99eff652019-08-11 23:11:30 +0200715
716 fconn = pool_alloc(pool_head_fcgi_conn);
Christopher Faulet73518be2021-01-27 12:06:54 +0100717 if (!fconn) {
718 TRACE_ERROR("fconn allocation failure", FCGI_EV_FCONN_NEW|FCGI_EV_FCONN_END|FCGI_EV_FCONN_ERR);
Christopher Faulet99eff652019-08-11 23:11:30 +0200719 goto fail_conn;
Christopher Faulet73518be2021-01-27 12:06:54 +0100720 }
Christopher Faulet99eff652019-08-11 23:11:30 +0200721
722 fconn->shut_timeout = fconn->timeout = px->timeout.server;
723 if (tick_isset(px->timeout.serverfin))
724 fconn->shut_timeout = px->timeout.serverfin;
725
726 fconn->flags = FCGI_CF_NONE;
727
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500728 /* Retrieve useful info from the FCGI app */
Christopher Faulet99eff652019-08-11 23:11:30 +0200729 if (app->flags & FCGI_APP_FL_KEEP_CONN)
730 fconn->flags |= FCGI_CF_KEEP_CONN;
731 if (app->flags & FCGI_APP_FL_GET_VALUES)
732 fconn->flags |= FCGI_CF_GET_VALUES;
733 if (app->flags & FCGI_APP_FL_MPXS_CONNS)
734 fconn->flags |= FCGI_CF_MPXS_CONNS;
735
736 fconn->proxy = px;
737 fconn->app = app;
738 fconn->task = NULL;
739 if (tick_isset(fconn->timeout)) {
Willy Tarreaubeeabf52021-10-01 18:23:30 +0200740 t = task_new_here();
Christopher Faulet73518be2021-01-27 12:06:54 +0100741 if (!t) {
742 TRACE_ERROR("fconn task allocation failure", FCGI_EV_FCONN_NEW|FCGI_EV_FCONN_END|FCGI_EV_FCONN_ERR);
Christopher Faulet99eff652019-08-11 23:11:30 +0200743 goto fail;
Christopher Faulet73518be2021-01-27 12:06:54 +0100744 }
Christopher Faulet99eff652019-08-11 23:11:30 +0200745
746 fconn->task = t;
747 t->process = fcgi_timeout_task;
748 t->context = fconn;
749 t->expire = tick_add(now_ms, fconn->timeout);
750 }
751
752 fconn->wait_event.tasklet = tasklet_new();
753 if (!fconn->wait_event.tasklet)
754 goto fail;
755 fconn->wait_event.tasklet->process = fcgi_io_cb;
756 fconn->wait_event.tasklet->context = fconn;
757 fconn->wait_event.events = 0;
758
759 /* Initialise the context. */
760 fconn->state = FCGI_CS_INIT;
761 fconn->conn = conn;
762 fconn->streams_limit = app->maxreqs;
763 fconn->max_id = -1;
764 fconn->nb_streams = 0;
765 fconn->nb_cs = 0;
766 fconn->nb_reserved = 0;
767 fconn->stream_cnt = 0;
768
769 fconn->dbuf = *input;
770 fconn->dsi = -1;
771
772 br_init(fconn->mbuf, sizeof(fconn->mbuf) / sizeof(fconn->mbuf[0]));
773 fconn->streams_by_id = EB_ROOT;
774 LIST_INIT(&fconn->send_list);
Willy Tarreau90f366b2021-02-20 11:49:49 +0100775 LIST_INIT(&fconn->buf_wait.list);
Christopher Faulet99eff652019-08-11 23:11:30 +0200776
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200777 conn->ctx = fconn;
778
Christopher Faulet99eff652019-08-11 23:11:30 +0200779 if (t)
780 task_queue(t);
781
782 /* FIXME: this is temporary, for outgoing connections we need to
783 * immediately allocate a stream until the code is modified so that the
784 * caller calls ->attach(). For now the outgoing cs is stored as
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200785 * conn->ctx by the caller and saved in conn_ctx.
Christopher Faulet99eff652019-08-11 23:11:30 +0200786 */
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200787 fstrm = fcgi_conn_stream_new(fconn, conn_ctx, sess);
Christopher Faulet99eff652019-08-11 23:11:30 +0200788 if (!fstrm)
789 goto fail;
790
Christopher Faulet99eff652019-08-11 23:11:30 +0200791
792 /* Repare to read something */
793 fcgi_conn_restart_reading(fconn, 1);
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200794 TRACE_LEAVE(FCGI_EV_FCONN_NEW, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +0200795 return 0;
796
797 fail:
798 task_destroy(t);
799 if (fconn->wait_event.tasklet)
800 tasklet_free(fconn->wait_event.tasklet);
801 pool_free(pool_head_fcgi_conn, fconn);
802 fail_conn:
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200803 conn->ctx = conn_ctx; // restore saved ctx
804 TRACE_DEVEL("leaving in error", FCGI_EV_FCONN_NEW|FCGI_EV_FCONN_END|FCGI_EV_FCONN_ERR);
Christopher Faulet99eff652019-08-11 23:11:30 +0200805 return -1;
806}
807
808/* Returns the next allocatable outgoing stream ID for the FCGI connection, or
809 * -1 if no more is allocatable.
810 */
811static inline int32_t fcgi_conn_get_next_sid(const struct fcgi_conn *fconn)
812{
813 int32_t id = (fconn->max_id + 1) | 1;
814
815 if ((id & 0x80000000U))
816 id = -1;
817 return id;
818}
819
820/* Returns the stream associated with id <id> or NULL if not found */
821static inline struct fcgi_strm *fcgi_conn_st_by_id(struct fcgi_conn *fconn, int id)
822{
823 struct eb32_node *node;
824
825 if (id == 0)
826 return (struct fcgi_strm *)fcgi_mgmt_stream;
827
828 if (id > fconn->max_id)
829 return (struct fcgi_strm *)fcgi_unknown_stream;
830
831 node = eb32_lookup(&fconn->streams_by_id, id);
832 if (!node)
833 return (struct fcgi_strm *)fcgi_unknown_stream;
834 return container_of(node, struct fcgi_strm, by_id);
835}
836
837
838/* Release function. This one should be called to free all resources allocated
839 * to the mux.
840 */
841static void fcgi_release(struct fcgi_conn *fconn)
842{
William Dauchy477757c2020-08-07 22:19:23 +0200843 struct connection *conn = NULL;
Christopher Faulet99eff652019-08-11 23:11:30 +0200844
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200845 TRACE_POINT(FCGI_EV_FCONN_END);
846
Christopher Faulet99eff652019-08-11 23:11:30 +0200847 if (fconn) {
848 /* The connection must be attached to this mux to be released */
849 if (fconn->conn && fconn->conn->ctx == fconn)
850 conn = fconn->conn;
851
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200852 TRACE_DEVEL("freeing fconn", FCGI_EV_FCONN_END, conn);
853
Willy Tarreau2b718102021-04-21 07:32:39 +0200854 if (LIST_INLIST(&fconn->buf_wait.list))
Willy Tarreau90f366b2021-02-20 11:49:49 +0100855 LIST_DEL_INIT(&fconn->buf_wait.list);
Christopher Faulet99eff652019-08-11 23:11:30 +0200856
857 fcgi_release_buf(fconn, &fconn->dbuf);
858 fcgi_release_mbuf(fconn);
859
860 if (fconn->task) {
861 fconn->task->context = NULL;
862 task_wakeup(fconn->task, TASK_WOKEN_OTHER);
863 fconn->task = NULL;
864 }
865 if (fconn->wait_event.tasklet)
866 tasklet_free(fconn->wait_event.tasklet);
Christopher Fauleta99db932019-09-18 11:11:46 +0200867 if (conn && fconn->wait_event.events != 0)
Christopher Faulet99eff652019-08-11 23:11:30 +0200868 conn->xprt->unsubscribe(conn, conn->xprt_ctx, fconn->wait_event.events,
869 &fconn->wait_event);
Christopher Faulet8694f252020-05-02 09:17:52 +0200870
871 pool_free(pool_head_fcgi_conn, fconn);
Christopher Faulet99eff652019-08-11 23:11:30 +0200872 }
873
874 if (conn) {
875 conn->mux = NULL;
876 conn->ctx = NULL;
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200877 TRACE_DEVEL("freeing conn", FCGI_EV_FCONN_END, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +0200878
879 conn_stop_tracking(conn);
880 conn_full_close(conn);
881 if (conn->destroy_cb)
882 conn->destroy_cb(conn);
883 conn_free(conn);
884 }
885}
886
Christopher Faulet6670e3e2020-10-08 15:26:33 +0200887/* Detect a pending read0 for a FCGI connection. It happens if a read0 is
888 * pending on the connection AND if there is no more data in the demux
889 * buffer. The function returns 1 to report a read0 or 0 otherwise.
890 */
891static int fcgi_conn_read0_pending(struct fcgi_conn *fconn)
892{
893 if (conn_xprt_read0_pending(fconn->conn) && !b_data(&fconn->dbuf))
894 return 1;
895 return 0;
896}
897
Christopher Faulet99eff652019-08-11 23:11:30 +0200898
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500899/* Returns true if the FCGI connection must be release */
Christopher Faulet99eff652019-08-11 23:11:30 +0200900static inline int fcgi_conn_is_dead(struct fcgi_conn *fconn)
901{
902 if (eb_is_empty(&fconn->streams_by_id) && /* don't close if streams exist */
903 (!(fconn->flags & FCGI_CF_KEEP_CONN) || /* don't keep the connection alive */
904 (fconn->conn->flags & CO_FL_ERROR) || /* errors close immediately */
905 (fconn->state == FCGI_CS_CLOSED && !fconn->task) ||/* a timeout stroke earlier */
906 (!(fconn->conn->owner)) || /* Nobody's left to take care of the connection, drop it now */
907 (!br_data(fconn->mbuf) && /* mux buffer empty, also process clean events below */
908 conn_xprt_read0_pending(fconn->conn))))
909 return 1;
910 return 0;
911}
912
913
914/********************************************************/
915/* functions below are for the FCGI protocol processing */
916/********************************************************/
917
Christopher Faulet99eff652019-08-11 23:11:30 +0200918/* Marks an error on the stream. */
919static inline void fcgi_strm_error(struct fcgi_strm *fstrm)
920{
921 if (fstrm->id && fstrm->state != FCGI_SS_ERROR) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200922 TRACE_POINT(FCGI_EV_FSTRM_ERR, fstrm->fconn->conn, fstrm);
923 if (fstrm->state < FCGI_SS_ERROR) {
Christopher Faulet99eff652019-08-11 23:11:30 +0200924 fstrm->state = FCGI_SS_ERROR;
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200925 TRACE_STATE("switching to ERROR", FCGI_EV_FSTRM_ERR, fstrm->fconn->conn, fstrm);
926 }
Christopher Faulet99eff652019-08-11 23:11:30 +0200927 if (fstrm->cs)
928 cs_set_error(fstrm->cs);
929 }
930}
931
932/* Attempts to notify the data layer of recv availability */
933static void fcgi_strm_notify_recv(struct fcgi_strm *fstrm)
934{
Willy Tarreau8907e4d2020-01-16 17:55:37 +0100935 if (fstrm->subs && (fstrm->subs->events & SUB_RETRY_RECV)) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200936 TRACE_POINT(FCGI_EV_STRM_WAKE, fstrm->fconn->conn, fstrm);
Willy Tarreau8907e4d2020-01-16 17:55:37 +0100937 tasklet_wakeup(fstrm->subs->tasklet);
938 fstrm->subs->events &= ~SUB_RETRY_RECV;
939 if (!fstrm->subs->events)
940 fstrm->subs = NULL;
Christopher Faulet99eff652019-08-11 23:11:30 +0200941 }
942}
943
944/* Attempts to notify the data layer of send availability */
945static void fcgi_strm_notify_send(struct fcgi_strm *fstrm)
946{
Willy Tarreau8907e4d2020-01-16 17:55:37 +0100947 if (fstrm->subs && (fstrm->subs->events & SUB_RETRY_SEND)) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200948 TRACE_POINT(FCGI_EV_STRM_WAKE, fstrm->fconn->conn, fstrm);
Willy Tarreauf11be0e2020-01-16 16:59:45 +0100949 fstrm->flags |= FCGI_SF_NOTIFIED;
Willy Tarreau8907e4d2020-01-16 17:55:37 +0100950 tasklet_wakeup(fstrm->subs->tasklet);
951 fstrm->subs->events &= ~SUB_RETRY_SEND;
952 if (!fstrm->subs->events)
953 fstrm->subs = NULL;
Christopher Faulet99eff652019-08-11 23:11:30 +0200954 }
Willy Tarreau7aad7032020-01-16 17:20:57 +0100955 else if (fstrm->flags & (FCGI_SF_WANT_SHUTR | FCGI_SF_WANT_SHUTW)) {
956 TRACE_POINT(FCGI_EV_STRM_WAKE, fstrm->fconn->conn, fstrm);
957 tasklet_wakeup(fstrm->shut_tl);
958 }
Christopher Faulet99eff652019-08-11 23:11:30 +0200959}
960
961/* Alerts the data layer, trying to wake it up by all means, following
962 * this sequence :
963 * - if the fcgi stream' data layer is subscribed to recv, then it's woken up
964 * for recv
965 * - if its subscribed to send, then it's woken up for send
966 * - if it was subscribed to neither, its ->wake() callback is called
967 * It is safe to call this function with a closed stream which doesn't have a
968 * conn_stream anymore.
969 */
970static void fcgi_strm_alert(struct fcgi_strm *fstrm)
971{
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200972 TRACE_POINT(FCGI_EV_STRM_WAKE, fstrm->fconn->conn, fstrm);
Willy Tarreau8907e4d2020-01-16 17:55:37 +0100973 if (fstrm->subs ||
Willy Tarreau7aad7032020-01-16 17:20:57 +0100974 (fstrm->flags & (FCGI_SF_WANT_SHUTR|FCGI_SF_WANT_SHUTW))) {
Christopher Faulet99eff652019-08-11 23:11:30 +0200975 fcgi_strm_notify_recv(fstrm);
976 fcgi_strm_notify_send(fstrm);
977 }
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200978 else if (fstrm->cs && fstrm->cs->data_cb->wake != NULL) {
979 TRACE_POINT(FCGI_EV_STRM_WAKE, fstrm->fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +0200980 fstrm->cs->data_cb->wake(fstrm->cs);
Christopher Faulet5c0f8592019-10-04 15:21:17 +0200981 }
Christopher Faulet99eff652019-08-11 23:11:30 +0200982}
983
984/* Writes the 16-bit record size <len> at address <record> */
985static inline void fcgi_set_record_size(void *record, uint16_t len)
986{
987 uint8_t *out = (record + 4);
988
989 *out = (len >> 8);
990 *(out + 1) = (len & 0xff);
991}
992
993/* Writes the 16-bit stream id <id> at address <record> */
994static inline void fcgi_set_record_id(void *record, uint16_t id)
995{
996 uint8_t *out = (record + 2);
997
998 *out = (id >> 8);
999 *(out + 1) = (id & 0xff);
1000}
1001
1002/* Marks a FCGI stream as CLOSED and decrement the number of active streams for
1003 * its connection if the stream was not yet closed. Please use this exclusively
1004 * before closing a stream to ensure stream count is well maintained.
1005 */
1006static inline void fcgi_strm_close(struct fcgi_strm *fstrm)
1007{
1008 if (fstrm->state != FCGI_SS_CLOSED) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001009 TRACE_ENTER(FCGI_EV_FSTRM_END, fstrm->fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02001010 fstrm->fconn->nb_streams--;
1011 if (!fstrm->id)
1012 fstrm->fconn->nb_reserved--;
1013 if (fstrm->cs) {
Christopher Fauletb041b232022-03-24 10:27:02 +01001014 if (!(fstrm->endp->flags & CS_EP_EOS) && !b_data(&fstrm->rxbuf))
Christopher Faulet99eff652019-08-11 23:11:30 +02001015 fcgi_strm_notify_recv(fstrm);
1016 }
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001017 fstrm->state = FCGI_SS_CLOSED;
1018 TRACE_STATE("switching to CLOSED", FCGI_EV_FSTRM_END, fstrm->fconn->conn, fstrm);
1019 TRACE_LEAVE(FCGI_EV_FSTRM_END, fstrm->fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02001020 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001021}
1022
1023/* Detaches a FCGI stream from its FCGI connection and releases it to the
1024 * fcgi_strm pool.
1025 */
1026static void fcgi_strm_destroy(struct fcgi_strm *fstrm)
1027{
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001028 struct connection *conn = fstrm->fconn->conn;
1029
1030 TRACE_ENTER(FCGI_EV_FSTRM_END, conn, fstrm);
1031
Christopher Faulet99eff652019-08-11 23:11:30 +02001032 fcgi_strm_close(fstrm);
1033 eb32_delete(&fstrm->by_id);
1034 if (b_size(&fstrm->rxbuf)) {
1035 b_free(&fstrm->rxbuf);
Willy Tarreau4d77bbf2021-02-20 12:02:46 +01001036 offer_buffers(NULL, 1);
Christopher Faulet99eff652019-08-11 23:11:30 +02001037 }
Willy Tarreau8907e4d2020-01-16 17:55:37 +01001038 if (fstrm->subs)
1039 fstrm->subs->events = 0;
Christopher Faulet99eff652019-08-11 23:11:30 +02001040 /* There's no need to explicitly call unsubscribe here, the only
1041 * reference left would be in the fconn send_list/fctl_list, and if
1042 * we're in it, we're getting out anyway
1043 */
1044 LIST_DEL_INIT(&fstrm->send_list);
Willy Tarreau7aad7032020-01-16 17:20:57 +01001045 tasklet_free(fstrm->shut_tl);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01001046 BUG_ON(fstrm->endp && !(fstrm->endp->flags & CS_EP_ORPHAN));
1047 cs_endpoint_free(fstrm->endp);
Christopher Faulet99eff652019-08-11 23:11:30 +02001048 pool_free(pool_head_fcgi_strm, fstrm);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001049
1050 TRACE_LEAVE(FCGI_EV_FSTRM_END, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001051}
1052
1053/* Allocates a new stream <id> for connection <fconn> and adds it into fconn's
1054 * stream tree. In case of error, nothing is added and NULL is returned. The
1055 * causes of errors can be any failed memory allocation. The caller is
1056 * responsible for checking if the connection may support an extra stream prior
1057 * to calling this function.
1058 */
1059static struct fcgi_strm *fcgi_strm_new(struct fcgi_conn *fconn, int id)
1060{
1061 struct fcgi_strm *fstrm;
1062
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001063 TRACE_ENTER(FCGI_EV_FSTRM_NEW, fconn->conn);
1064
Christopher Faulet99eff652019-08-11 23:11:30 +02001065 fstrm = pool_alloc(pool_head_fcgi_strm);
Christopher Faulet73518be2021-01-27 12:06:54 +01001066 if (!fstrm) {
1067 TRACE_ERROR("fstrm allocation failure", FCGI_EV_FSTRM_NEW|FCGI_EV_FSTRM_ERR|FCGI_EV_FSTRM_END, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001068 goto out;
Christopher Faulet73518be2021-01-27 12:06:54 +01001069 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001070
Willy Tarreau7aad7032020-01-16 17:20:57 +01001071 fstrm->shut_tl = tasklet_new();
1072 if (!fstrm->shut_tl) {
Christopher Faulet73518be2021-01-27 12:06:54 +01001073 TRACE_ERROR("fstrm shut tasklet allocation failure", FCGI_EV_FSTRM_NEW|FCGI_EV_FSTRM_ERR|FCGI_EV_FSTRM_END, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001074 pool_free(pool_head_fcgi_strm, fstrm);
1075 goto out;
1076 }
Willy Tarreau8907e4d2020-01-16 17:55:37 +01001077 fstrm->subs = NULL;
Willy Tarreau7aad7032020-01-16 17:20:57 +01001078 fstrm->shut_tl->process = fcgi_deferred_shut;
1079 fstrm->shut_tl->context = fstrm;
Christopher Faulet99eff652019-08-11 23:11:30 +02001080 LIST_INIT(&fstrm->send_list);
Christopher Faulet99eff652019-08-11 23:11:30 +02001081 fstrm->fconn = fconn;
1082 fstrm->cs = NULL;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01001083 fstrm->endp = NULL;
Christopher Faulet99eff652019-08-11 23:11:30 +02001084 fstrm->flags = FCGI_SF_NONE;
1085 fstrm->proto_status = 0;
1086 fstrm->state = FCGI_SS_IDLE;
1087 fstrm->rxbuf = BUF_NULL;
1088
1089 h1m_init_res(&fstrm->h1m);
1090 fstrm->h1m.err_pos = -1; // don't care about errors on the request path
1091 fstrm->h1m.flags |= (H1_MF_NO_PHDR|H1_MF_CLEAN_CONN_HDR);
1092
1093 fstrm->by_id.key = fstrm->id = id;
1094 if (id > 0)
1095 fconn->max_id = id;
1096 else
1097 fconn->nb_reserved++;
1098
1099 eb32_insert(&fconn->streams_by_id, &fstrm->by_id);
1100 fconn->nb_streams++;
1101 fconn->stream_cnt++;
1102
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001103 TRACE_LEAVE(FCGI_EV_FSTRM_NEW, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02001104 return fstrm;
1105
1106 out:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001107 TRACE_DEVEL("leaving in error", FCGI_EV_FSTRM_NEW|FCGI_EV_FSTRM_ERR|FCGI_EV_FSTRM_END, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001108 return NULL;
1109}
1110
1111/* Allocates a new stream associated to conn_stream <cs> on the FCGI connection
1112 * <fconn> and returns it, or NULL in case of memory allocation error or if the
1113 * highest possible stream ID was reached.
1114 */
1115static struct fcgi_strm *fcgi_conn_stream_new(struct fcgi_conn *fconn, struct conn_stream *cs,
1116 struct session *sess)
1117{
1118 struct fcgi_strm *fstrm = NULL;
1119
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001120 TRACE_ENTER(FCGI_EV_FSTRM_NEW, fconn->conn);
1121 if (fconn->nb_streams >= fconn->streams_limit) {
Christopher Faulet73518be2021-01-27 12:06:54 +01001122 TRACE_ERROR("streams_limit reached", FCGI_EV_FSTRM_NEW|FCGI_EV_FSTRM_END|FCGI_EV_FSTRM_ERR, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001123 goto out;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001124 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001125
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001126 if (fcgi_streams_left(fconn) < 1) {
Christopher Faulet73518be2021-01-27 12:06:54 +01001127 TRACE_ERROR("!streams_left", FCGI_EV_FSTRM_NEW|FCGI_EV_FSTRM_END|FCGI_EV_FSTRM_ERR, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001128 goto out;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001129 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001130
1131 /* Defer choosing the ID until we send the first message to create the stream */
1132 fstrm = fcgi_strm_new(fconn, 0);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001133 if (!fstrm) {
Christopher Faulet73518be2021-01-27 12:06:54 +01001134 TRACE_ERROR("fstream allocation failure", FCGI_EV_FSTRM_NEW|FCGI_EV_FSTRM_END|FCGI_EV_FSTRM_ERR, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001135 goto out;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001136 }
Christopher Faulet070b91b2022-03-31 19:27:18 +02001137 if (cs_attach_mux(cs, fstrm, fconn->conn) < 0)
1138 goto out;
Christopher Faulet99eff652019-08-11 23:11:30 +02001139 fstrm->cs = cs;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01001140 fstrm->endp = cs->endp;
Christopher Faulet99eff652019-08-11 23:11:30 +02001141 fstrm->sess = sess;
Christopher Faulet99eff652019-08-11 23:11:30 +02001142 fconn->nb_cs++;
1143
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001144 TRACE_LEAVE(FCGI_EV_FSTRM_NEW, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02001145 return fstrm;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001146
1147 out:
Christopher Faulet73518be2021-01-27 12:06:54 +01001148 TRACE_DEVEL("leaving on error", FCGI_EV_FSTRM_NEW|FCGI_EV_FSTRM_END|FCGI_EV_FSTRM_ERR, fconn->conn);
Christopher Faulet070b91b2022-03-31 19:27:18 +02001149 fcgi_strm_destroy(fstrm);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001150 return NULL;
Christopher Faulet99eff652019-08-11 23:11:30 +02001151}
1152
Christopher Fauletb041b232022-03-24 10:27:02 +01001153/* Wakes a specific stream and assign its conn_stream some CS_EP_* flags among
1154 * CS_EP_ERR_PENDING and CS_EP_ERROR if needed. The stream's state is
Christopher Faulet99eff652019-08-11 23:11:30 +02001155 * automatically updated accordingly. If the stream is orphaned, it is
1156 * destroyed.
1157 */
1158static void fcgi_strm_wake_one_stream(struct fcgi_strm *fstrm)
1159{
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001160 struct fcgi_conn *fconn = fstrm->fconn;
1161
1162 TRACE_ENTER(FCGI_EV_STRM_WAKE, fconn->conn, fstrm);
1163
Christopher Faulet99eff652019-08-11 23:11:30 +02001164 if (!fstrm->cs) {
1165 /* this stream was already orphaned */
1166 fcgi_strm_destroy(fstrm);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001167 TRACE_DEVEL("leaving with no fstrm", FCGI_EV_STRM_WAKE, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001168 return;
1169 }
1170
Christopher Faulet6670e3e2020-10-08 15:26:33 +02001171 if (fcgi_conn_read0_pending(fconn)) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001172 if (fstrm->state == FCGI_SS_OPEN) {
Christopher Faulet99eff652019-08-11 23:11:30 +02001173 fstrm->state = FCGI_SS_HREM;
Ilya Shipitsinf38a0182020-12-21 01:16:17 +05001174 TRACE_STATE("switching to HREM", FCGI_EV_STRM_WAKE|FCGI_EV_FSTRM_END, fconn->conn, fstrm);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001175 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001176 else if (fstrm->state == FCGI_SS_HLOC)
1177 fcgi_strm_close(fstrm);
1178 }
1179
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001180 if ((fconn->state == FCGI_CS_CLOSED || fconn->conn->flags & CO_FL_ERROR)) {
Christopher Fauletb041b232022-03-24 10:27:02 +01001181 fstrm->endp->flags |= CS_EP_ERR_PENDING;
1182 if (fstrm->endp->flags & CS_EP_EOS)
1183 fstrm->endp->flags |= CS_EP_ERROR;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001184
1185 if (fstrm->state < FCGI_SS_ERROR) {
Christopher Faulet99eff652019-08-11 23:11:30 +02001186 fstrm->state = FCGI_SS_ERROR;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001187 TRACE_STATE("switching to ERROR", FCGI_EV_STRM_WAKE|FCGI_EV_FSTRM_END, fconn->conn, fstrm);
1188 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001189 }
1190
1191 fcgi_strm_alert(fstrm);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001192
1193 TRACE_LEAVE(FCGI_EV_STRM_WAKE, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02001194}
1195
1196/* Wakes unassigned streams (ID == 0) attached to the connection. */
1197static void fcgi_wake_unassigned_streams(struct fcgi_conn *fconn)
1198{
1199 struct eb32_node *node;
1200 struct fcgi_strm *fstrm;
1201
1202 node = eb32_lookup(&fconn->streams_by_id, 0);
1203 while (node) {
1204 fstrm = container_of(node, struct fcgi_strm, by_id);
1205 if (fstrm->id > 0)
1206 break;
1207 node = eb32_next(node);
1208 fcgi_strm_wake_one_stream(fstrm);
1209 }
1210}
1211
1212/* Wakes the streams attached to the connection, whose id is greater than <last>
1213 * or unassigned.
1214 */
1215static void fcgi_wake_some_streams(struct fcgi_conn *fconn, int last)
1216{
1217 struct eb32_node *node;
1218 struct fcgi_strm *fstrm;
1219
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001220 TRACE_ENTER(FCGI_EV_STRM_WAKE, fconn->conn);
1221
Christopher Faulet99eff652019-08-11 23:11:30 +02001222 /* Wake all streams with ID > last */
1223 node = eb32_lookup_ge(&fconn->streams_by_id, last + 1);
1224 while (node) {
1225 fstrm = container_of(node, struct fcgi_strm, by_id);
1226 node = eb32_next(node);
1227 fcgi_strm_wake_one_stream(fstrm);
1228 }
1229 fcgi_wake_unassigned_streams(fconn);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001230
1231 TRACE_LEAVE(FCGI_EV_STRM_WAKE, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001232}
1233
1234static int fcgi_set_default_param(struct fcgi_conn *fconn, struct fcgi_strm *fstrm,
1235 struct htx *htx, struct htx_sl *sl,
1236 struct fcgi_strm_params *params)
1237{
1238 struct connection *cli_conn = objt_conn(fstrm->sess->origin);
Christopher Faulet8da67aa2022-03-29 17:53:09 +02001239 const struct sockaddr_storage *src = (cs_check(fstrm->cs) ? conn_src(fconn->conn) : cs_src(cs_opposite(fstrm->cs)));
1240 const struct sockaddr_storage *dst = (cs_check(fstrm->cs) ? conn_dst(fconn->conn) : cs_dst(cs_opposite(fstrm->cs)));
Christopher Faulet99eff652019-08-11 23:11:30 +02001241 struct ist p;
1242
1243 if (!sl)
1244 goto error;
1245
1246 if (!(params->mask & FCGI_SP_DOC_ROOT))
1247 params->docroot = fconn->app->docroot;
1248
1249 if (!(params->mask & FCGI_SP_REQ_METH)) {
1250 p = htx_sl_req_meth(sl);
1251 params->meth = ist2(b_tail(params->p), p.len);
Tim Duesterhus9f7ed8a2021-11-08 09:05:04 +01001252 chunk_istcat(params->p, p);
Christopher Faulet99eff652019-08-11 23:11:30 +02001253 }
1254 if (!(params->mask & FCGI_SP_REQ_URI)) {
Christopher Fauletfb38c912021-04-26 09:38:55 +02001255 p = h1_get_uri(sl);
Christopher Faulet99eff652019-08-11 23:11:30 +02001256 params->uri = ist2(b_tail(params->p), p.len);
Tim Duesterhus9f7ed8a2021-11-08 09:05:04 +01001257 chunk_istcat(params->p, p);
Christopher Faulet99eff652019-08-11 23:11:30 +02001258 }
1259 if (!(params->mask & FCGI_SP_SRV_PROTO)) {
1260 p = htx_sl_req_vsn(sl);
1261 params->vsn = ist2(b_tail(params->p), p.len);
Tim Duesterhus9f7ed8a2021-11-08 09:05:04 +01001262 chunk_istcat(params->p, p);
Christopher Faulet99eff652019-08-11 23:11:30 +02001263 }
1264 if (!(params->mask & FCGI_SP_SRV_PORT)) {
1265 char *end;
1266 int port = 0;
Christopher Faulet568008d2021-10-25 07:56:51 +02001267 if (dst)
1268 port = get_host_port(dst);
Christopher Faulet99eff652019-08-11 23:11:30 +02001269 end = ultoa_o(port, b_tail(params->p), b_room(params->p));
1270 if (!end)
1271 goto error;
1272 params->srv_port = ist2(b_tail(params->p), end - b_tail(params->p));
1273 params->p->data += params->srv_port.len;
1274 }
1275 if (!(params->mask & FCGI_SP_SRV_NAME)) {
1276 /* If no Host header found, use the server address to fill
1277 * srv_name */
1278 if (!istlen(params->srv_name)) {
1279 char *ptr = NULL;
1280
Christopher Faulet568008d2021-10-25 07:56:51 +02001281 if (dst)
1282 if (addr_to_str(dst, b_tail(params->p), b_room(params->p)) != -1)
Christopher Faulet99eff652019-08-11 23:11:30 +02001283 ptr = b_tail(params->p);
1284 if (ptr) {
Tim Duesterhusdcf753a2021-03-04 17:31:47 +01001285 params->srv_name = ist(ptr);
Christopher Faulet99eff652019-08-11 23:11:30 +02001286 params->p->data += params->srv_name.len;
1287 }
1288 }
1289 }
1290 if (!(params->mask & FCGI_SP_REM_ADDR)) {
1291 char *ptr = NULL;
1292
Christopher Faulet568008d2021-10-25 07:56:51 +02001293 if (src)
1294 if (addr_to_str(src, b_tail(params->p), b_room(params->p)) != -1)
Christopher Faulet99eff652019-08-11 23:11:30 +02001295 ptr = b_tail(params->p);
1296 if (ptr) {
Tim Duesterhusdcf753a2021-03-04 17:31:47 +01001297 params->rem_addr = ist(ptr);
Christopher Faulet99eff652019-08-11 23:11:30 +02001298 params->p->data += params->rem_addr.len;
1299 }
1300 }
1301 if (!(params->mask & FCGI_SP_REM_PORT)) {
1302 char *end;
1303 int port = 0;
Christopher Faulet568008d2021-10-25 07:56:51 +02001304 if (src)
1305 port = get_host_port(src);
Christopher Faulet99eff652019-08-11 23:11:30 +02001306 end = ultoa_o(port, b_tail(params->p), b_room(params->p));
1307 if (!end)
1308 goto error;
1309 params->rem_port = ist2(b_tail(params->p), end - b_tail(params->p));
1310 params->p->data += params->rem_port.len;
1311 }
1312 if (!(params->mask & FCGI_SP_CONT_LEN)) {
1313 struct htx_blk *blk;
1314 enum htx_blk_type type;
1315 char *end;
1316 size_t len = 0;
1317
1318 for (blk = htx_get_head_blk(htx); blk; blk = htx_get_next_blk(htx, blk)) {
1319 type = htx_get_blk_type(blk);
1320
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001321 if (type == HTX_BLK_TLR || type == HTX_BLK_EOT)
Christopher Faulet99eff652019-08-11 23:11:30 +02001322 break;
1323 if (type == HTX_BLK_DATA)
1324 len += htx_get_blksz(blk);
1325 }
1326 end = ultoa_o(len, b_tail(params->p), b_room(params->p));
1327 if (!end)
1328 goto error;
1329 params->cont_len = ist2(b_tail(params->p), end - b_tail(params->p));
1330 params->p->data += params->cont_len.len;
1331 }
Willy Tarreaud2ae3852021-10-06 11:40:11 +02001332
Christopher Faulet99eff652019-08-11 23:11:30 +02001333 if (!(params->mask & FCGI_SP_HTTPS)) {
Christopher Fauletbb86a0f2020-04-24 07:19:04 +02001334 if (cli_conn)
Willy Tarreau1057bee2021-10-06 11:38:44 +02001335 params->https = conn_is_ssl(cli_conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001336 }
Willy Tarreaud2ae3852021-10-06 11:40:11 +02001337
Christopher Faulet99eff652019-08-11 23:11:30 +02001338 if ((params->mask & FCGI_SP_URI_MASK) != FCGI_SP_URI_MASK) {
1339 /* one of scriptname, pathinfo or query_string is no set */
Amaury Denoyellec453f952021-07-06 11:40:12 +02001340 struct http_uri_parser parser = http_uri_parser_init(params->uri);
1341 struct ist path = http_parse_path(&parser);
Christopher Faulet99eff652019-08-11 23:11:30 +02001342 int len;
1343
Christopher Faulet99eff652019-08-11 23:11:30 +02001344 /* No scrit_name set but no valid path ==> error */
1345 if (!(params->mask & FCGI_SP_SCRIPT_NAME) && !istlen(path))
1346 goto error;
1347
Christopher Faulet99eff652019-08-11 23:11:30 +02001348 /* If there is a query-string, Set it if not already set */
Christopher Faulet0f17a442020-07-23 15:44:37 +02001349 if (!(params->mask & FCGI_SP_REQ_QS)) {
1350 struct ist qs = istfind(path, '?');
1351
1352 /* Update the path length */
1353 path.len -= qs.len;
1354
1355 /* Set the query-string skipping the '?', if any */
1356 if (istlen(qs))
1357 params->qs = istnext(qs);
1358 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001359
1360 /* If the script_name is set, don't try to deduce the path_info
1361 * too. The opposite is not true.
1362 */
1363 if (params->mask & FCGI_SP_SCRIPT_NAME) {
1364 params->mask |= FCGI_SP_PATH_INFO;
1365 goto end;
1366 }
1367
Christopher Faulet0f17a442020-07-23 15:44:37 +02001368 /* Decode the path. it must first be copied to keep the URI
1369 * untouched.
1370 */
Tim Duesterhus9f7ed8a2021-11-08 09:05:04 +01001371 chunk_istcat(params->p, path);
Christopher Faulet0f17a442020-07-23 15:44:37 +02001372 path.ptr = b_tail(params->p) - path.len;
1373 len = url_decode(ist0(path), 0);
1374 if (len < 0)
1375 goto error;
1376 path.len = len;
1377
Christopher Faulet99eff652019-08-11 23:11:30 +02001378 /* script_name not set, preset it with the path for now */
Christopher Faulet0f17a442020-07-23 15:44:37 +02001379 params->scriptname = path;
Christopher Faulet99eff652019-08-11 23:11:30 +02001380
1381 /* If there is no regex to match the pathinfo, just to the last
1382 * part and see if the index must be used.
1383 */
1384 if (!fconn->app->pathinfo_re)
1385 goto check_index;
1386
Christopher Faulet28cb3662020-02-14 14:47:37 +01001387 /* If some special characters are found in the decoded path (\n
Ilya Shipitsin01881082021-08-07 14:41:56 +05001388 * or \0), the PATH_INFO regex cannot match. This is theoretically
Christopher Faulet28cb3662020-02-14 14:47:37 +01001389 * valid, but probably unexpected, to have such characters. So,
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +05001390 * to avoid any surprises, an error is triggered in this
Christopher Faulet28cb3662020-02-14 14:47:37 +01001391 * case.
1392 */
1393 if (istchr(path, '\n') || istchr(path, '\0'))
1394 goto error;
1395
Christopher Faulet99eff652019-08-11 23:11:30 +02001396 /* The regex does not match, just to the last part and see if
1397 * the index must be used.
1398 */
1399 if (!regex_exec_match2(fconn->app->pathinfo_re, path.ptr, len, MAX_MATCH, pmatch, 0))
1400 goto check_index;
1401
Christopher Faulet6c57f2d2020-02-14 16:55:52 +01001402 /* We must have at least 1 capture for the script name,
1403 * otherwise we do nothing and jump to the last part.
Christopher Faulet99eff652019-08-11 23:11:30 +02001404 */
Christopher Faulet6c57f2d2020-02-14 16:55:52 +01001405 if (pmatch[1].rm_so == -1 || pmatch[1].rm_eo == -1)
Christopher Faulet99eff652019-08-11 23:11:30 +02001406 goto check_index;
1407
Christopher Faulet6c57f2d2020-02-14 16:55:52 +01001408 /* Finally we can set the script_name and the path_info. The
1409 * path_info is set if not already defined, and if it was
1410 * captured
1411 */
Christopher Faulet99eff652019-08-11 23:11:30 +02001412 params->scriptname = ist2(path.ptr + pmatch[1].rm_so, pmatch[1].rm_eo - pmatch[1].rm_so);
Christopher Faulet6c57f2d2020-02-14 16:55:52 +01001413 if (!(params->mask & FCGI_SP_PATH_INFO) && (pmatch[2].rm_so == -1 || pmatch[2].rm_eo == -1))
1414 params->pathinfo = ist2(path.ptr + pmatch[2].rm_so, pmatch[2].rm_eo - pmatch[2].rm_so);
Christopher Faulet99eff652019-08-11 23:11:30 +02001415
1416 check_index:
1417 len = params->scriptname.len;
1418 /* the script_name if finished by a '/' so we can add the index
1419 * part, if any.
1420 */
1421 if (istlen(fconn->app->index) && params->scriptname.ptr[len-1] == '/') {
1422 struct ist sn = params->scriptname;
1423
1424 params->scriptname = ist2(b_tail(params->p), len+fconn->app->index.len);
Tim Duesterhus9f7ed8a2021-11-08 09:05:04 +01001425 chunk_istcat(params->p, sn);
Tim Duesterhus77508502022-03-15 13:11:06 +01001426 chunk_istcat(params->p, fconn->app->index);
Christopher Faulet99eff652019-08-11 23:11:30 +02001427 }
1428 }
1429
Christopher Faulet5cd0e522021-06-11 13:34:42 +02001430 if (!(params->mask & FCGI_SP_SRV_SOFT)) {
1431 params->srv_soft = ist2(b_tail(params->p), 0);
1432 chunk_appendf(params->p, "HAProxy %s", haproxy_version);
1433 params->srv_soft.len = b_tail(params->p) - params->srv_soft.ptr;
1434 }
1435
Christopher Faulet99eff652019-08-11 23:11:30 +02001436 end:
1437 return 1;
1438 error:
1439 return 0;
1440}
1441
1442static int fcgi_encode_default_param(struct fcgi_conn *fconn, struct fcgi_strm *fstrm,
1443 struct fcgi_strm_params *params, struct buffer *outbuf, int flag)
1444{
1445 struct fcgi_param p;
1446
1447 if (params->mask & flag)
1448 return 1;
1449
1450 chunk_reset(&trash);
1451
1452 switch (flag) {
1453 case FCGI_SP_CGI_GATEWAY:
1454 p.n = ist("GATEWAY_INTERFACE");
1455 p.v = ist("CGI/1.1");
1456 goto encode;
1457 case FCGI_SP_DOC_ROOT:
1458 p.n = ist("DOCUMENT_ROOT");
1459 p.v = params->docroot;
1460 goto encode;
1461 case FCGI_SP_SCRIPT_NAME:
1462 p.n = ist("SCRIPT_NAME");
1463 p.v = params->scriptname;
1464 goto encode;
1465 case FCGI_SP_PATH_INFO:
1466 p.n = ist("PATH_INFO");
1467 p.v = params->pathinfo;
1468 goto encode;
1469 case FCGI_SP_REQ_URI:
1470 p.n = ist("REQUEST_URI");
1471 p.v = params->uri;
1472 goto encode;
1473 case FCGI_SP_REQ_METH:
1474 p.n = ist("REQUEST_METHOD");
1475 p.v = params->meth;
1476 goto encode;
1477 case FCGI_SP_REQ_QS:
1478 p.n = ist("QUERY_STRING");
1479 p.v = params->qs;
1480 goto encode;
1481 case FCGI_SP_SRV_NAME:
1482 p.n = ist("SERVER_NAME");
1483 p.v = params->srv_name;
1484 goto encode;
1485 case FCGI_SP_SRV_PORT:
1486 p.n = ist("SERVER_PORT");
1487 p.v = params->srv_port;
1488 goto encode;
1489 case FCGI_SP_SRV_PROTO:
1490 p.n = ist("SERVER_PROTOCOL");
1491 p.v = params->vsn;
1492 goto encode;
1493 case FCGI_SP_REM_ADDR:
1494 p.n = ist("REMOTE_ADDR");
1495 p.v = params->rem_addr;
1496 goto encode;
1497 case FCGI_SP_REM_PORT:
1498 p.n = ist("REMOTE_PORT");
1499 p.v = params->rem_port;
1500 goto encode;
1501 case FCGI_SP_SCRIPT_FILE:
1502 p.n = ist("SCRIPT_FILENAME");
Tim Duesterhus77508502022-03-15 13:11:06 +01001503 chunk_istcat(&trash, params->docroot);
1504 chunk_istcat(&trash, params->scriptname);
Christopher Faulet99eff652019-08-11 23:11:30 +02001505 p.v = ist2(b_head(&trash), b_data(&trash));
1506 goto encode;
1507 case FCGI_SP_PATH_TRANS:
1508 if (!istlen(params->pathinfo))
1509 goto skip;
1510 p.n = ist("PATH_TRANSLATED");
Tim Duesterhus77508502022-03-15 13:11:06 +01001511 chunk_istcat(&trash, params->docroot);
1512 chunk_istcat(&trash, params->pathinfo);
Christopher Faulet99eff652019-08-11 23:11:30 +02001513 p.v = ist2(b_head(&trash), b_data(&trash));
1514 goto encode;
1515 case FCGI_SP_CONT_LEN:
1516 p.n = ist("CONTENT_LENGTH");
1517 p.v = params->cont_len;
1518 goto encode;
1519 case FCGI_SP_HTTPS:
1520 if (!params->https)
1521 goto skip;
1522 p.n = ist("HTTPS");
1523 p.v = ist("on");
1524 goto encode;
Christopher Faulet5cd0e522021-06-11 13:34:42 +02001525 case FCGI_SP_SRV_SOFT:
1526 p.n = ist("SERVER_SOFTWARE");
1527 p.v = params->srv_soft;
1528 goto encode;
Christopher Faulet99eff652019-08-11 23:11:30 +02001529 default:
1530 goto skip;
1531 }
1532
1533 encode:
1534 if (!istlen(p.v))
1535 goto skip;
1536 if (!fcgi_encode_param(outbuf, &p))
1537 return 0;
1538 skip:
1539 params->mask |= flag;
1540 return 1;
1541}
1542
1543/* Sends a GET_VALUES record. Returns > 0 on success, 0 if it couldn't do
1544 * anything. It is highly unexpected, but if the record is larger than a buffer
1545 * and cannot be encoded in one time, an error is triggered and the connection is
1546 * closed. GET_VALUES record cannot be split.
1547 */
1548static int fcgi_conn_send_get_values(struct fcgi_conn *fconn)
1549{
1550 struct buffer outbuf;
1551 struct buffer *mbuf;
1552 struct fcgi_param max_reqs = { .n = ist("FCGI_MAX_REQS"), .v = ist("")};
1553 struct fcgi_param mpxs_conns = { .n = ist("FCGI_MPXS_CONNS"), .v = ist("")};
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001554 int ret = 0;
1555
1556 TRACE_ENTER(FCGI_EV_TX_RECORD|FCGI_EV_TX_GETVAL, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001557
1558 mbuf = br_tail(fconn->mbuf);
1559 retry:
1560 if (!fcgi_get_buf(fconn, mbuf)) {
1561 fconn->flags |= FCGI_CF_MUX_MALLOC;
1562 fconn->flags |= FCGI_CF_DEM_MROOM;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001563 TRACE_STATE("waiting for fconn mbuf ring allocation", FCGI_EV_TX_RECORD|FCGI_EV_FCONN_BLK, fconn->conn);
1564 ret = 0;
1565 goto end;
Christopher Faulet99eff652019-08-11 23:11:30 +02001566 }
1567
1568 while (1) {
1569 outbuf = b_make(b_tail(mbuf), b_contig_space(mbuf), 0, 0);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001570 if (outbuf.size >= FCGI_RECORD_HEADER_SZ || !b_space_wraps(mbuf))
Christopher Faulet99eff652019-08-11 23:11:30 +02001571 break;
1572 realign_again:
1573 b_slow_realign(mbuf, trash.area, b_data(mbuf));
1574 }
1575
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001576 if (outbuf.size < FCGI_RECORD_HEADER_SZ)
Christopher Faulet99eff652019-08-11 23:11:30 +02001577 goto full;
1578
1579 /* vsn: 1(FCGI_VERSION), type: (9)FCGI_GET_VALUES, id: 0x0000,
1580 * len: 0x0000 (fill later), padding: 0x00, rsv: 0x00 */
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001581 memcpy(outbuf.area, "\x01\x09\x00\x00\x00\x00\x00\x00", FCGI_RECORD_HEADER_SZ);
1582 outbuf.data = FCGI_RECORD_HEADER_SZ;
Christopher Faulet99eff652019-08-11 23:11:30 +02001583
1584 /* Note: Don't send the param FCGI_MAX_CONNS because its value cannot be
1585 * handled by HAProxy.
1586 */
1587 if (!fcgi_encode_param(&outbuf, &max_reqs) || !fcgi_encode_param(&outbuf, &mpxs_conns))
1588 goto full;
1589
1590 /* update the record's size now */
Willy Tarreau022e5e52020-09-10 09:33:15 +02001591 TRACE_PROTO("FCGI GET_VALUES record xferred", FCGI_EV_TX_RECORD|FCGI_EV_TX_GETVAL, fconn->conn, 0, 0, (size_t[]){outbuf.data-8});
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001592 fcgi_set_record_size(outbuf.area, outbuf.data - FCGI_RECORD_HEADER_SZ);
Christopher Faulet99eff652019-08-11 23:11:30 +02001593 b_add(mbuf, outbuf.data);
1594 ret = 1;
1595
1596 end:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001597 TRACE_LEAVE(FCGI_EV_TX_RECORD|FCGI_EV_TX_GETVAL, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001598 return ret;
1599 full:
1600 /* Too large to be encoded. For GET_VALUES records, it is an error */
Christopher Faulet73518be2021-01-27 12:06:54 +01001601 if (!b_data(mbuf)) {
1602 TRACE_ERROR("GET_VALUES record too large", FCGI_EV_TX_RECORD|FCGI_EV_TX_GETVAL|FCGI_EV_FCONN_ERR, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001603 goto fail;
Christopher Faulet73518be2021-01-27 12:06:54 +01001604 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001605
1606 if ((mbuf = br_tail_add(fconn->mbuf)) != NULL)
1607 goto retry;
1608 fconn->flags |= FCGI_CF_MUX_MFULL;
1609 fconn->flags |= FCGI_CF_DEM_MROOM;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001610 TRACE_STATE("mbuf ring full", FCGI_EV_TX_RECORD|FCGI_EV_FCONN_BLK, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001611 ret = 0;
1612 goto end;
1613 fail:
1614 fconn->state = FCGI_CS_CLOSED;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001615 TRACE_STATE("switching to CLOSED", FCGI_EV_TX_RECORD|FCGI_EV_TX_GETVAL|FCGI_EV_FCONN_END, fconn->conn);
1616 TRACE_DEVEL("leaving on error", FCGI_EV_TX_RECORD|FCGI_EV_TX_GETVAL|FCGI_EV_FCONN_ERR, fconn->conn);
1617 return 0;
Christopher Faulet99eff652019-08-11 23:11:30 +02001618}
1619
1620/* Processes a GET_VALUES_RESULT record. Returns > 0 on success, 0 if it
1621 * couldn't do anything. It is highly unexpected, but if the record is larger
1622 * than a buffer and cannot be decoded in one time, an error is triggered and
1623 * the connection is closed. GET_VALUES_RESULT record cannot be split.
1624 */
1625static int fcgi_conn_handle_values_result(struct fcgi_conn *fconn)
1626{
1627 struct buffer inbuf;
1628 struct buffer *dbuf;
1629 size_t offset;
1630
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001631 TRACE_ENTER(FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL, fconn->conn);
1632
Christopher Faulet99eff652019-08-11 23:11:30 +02001633 dbuf = &fconn->dbuf;
1634
1635 /* Record too large to be fully decoded */
1636 if (b_size(dbuf) < (fconn->drl + fconn->drp))
1637 goto fail;
1638
1639 /* process full record only */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001640 if (b_data(dbuf) < (fconn->drl + fconn->drp)) {
1641 TRACE_DEVEL("leaving on missing data", FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001642 return 0;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001643 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001644
1645 if (unlikely(b_contig_data(dbuf, b_head_ofs(dbuf)) < fconn->drl)) {
1646 /* Realign the dmux buffer if the record wraps. It is unexpected
1647 * at this stage because it should be the first record received
1648 * from the FCGI application.
1649 */
Christopher Faulet00d7cde2021-02-04 11:01:51 +01001650 b_slow_realign_ofs(dbuf, trash.area, 0);
Christopher Faulet99eff652019-08-11 23:11:30 +02001651 }
1652
1653 inbuf = b_make(b_head(dbuf), b_data(dbuf), 0, fconn->drl);
1654
1655 for (offset = 0; offset < b_data(&inbuf); ) {
1656 struct fcgi_param p;
1657 size_t ret;
1658
1659 ret = fcgi_aligned_decode_param(&inbuf, offset, &p);
1660 if (!ret) {
1661 /* name or value too large to be decoded at once */
Christopher Faulet73518be2021-01-27 12:06:54 +01001662 TRACE_ERROR("error decoding GET_VALUES_RESULT param", FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL|FCGI_EV_FCONN_ERR, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001663 goto fail;
1664 }
1665 offset += ret;
1666
1667 if (isteqi(p.n, ist("FCGI_MPXS_CONNS"))) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001668 if (isteq(p.v, ist("1"))) {
Willy Tarreau022e5e52020-09-10 09:33:15 +02001669 TRACE_STATE("set mpxs param", FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL, fconn->conn, 0, 0, (size_t[]){1});
Christopher Faulet99eff652019-08-11 23:11:30 +02001670 fconn->flags |= FCGI_CF_MPXS_CONNS;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001671 }
1672 else {
Willy Tarreau022e5e52020-09-10 09:33:15 +02001673 TRACE_STATE("set mpxs param", FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL, fconn->conn, 0, 0, (size_t[]){0});
Christopher Faulet99eff652019-08-11 23:11:30 +02001674 fconn->flags &= ~FCGI_CF_MPXS_CONNS;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001675 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001676 }
1677 else if (isteqi(p.n, ist("FCGI_MAX_REQS"))) {
1678 fconn->streams_limit = strl2ui(p.v.ptr, p.v.len);
Willy Tarreau022e5e52020-09-10 09:33:15 +02001679 TRACE_STATE("set streams_limit", FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL, fconn->conn, 0, 0, (size_t[]){fconn->streams_limit});
Christopher Faulet99eff652019-08-11 23:11:30 +02001680 }
1681 /*
1682 * Ignore all other params
1683 */
1684 }
1685
1686 /* Reset the number of concurrent streams supported if the FCGI
1687 * application does not support connection multiplexing
1688 */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001689 if (!(fconn->flags & FCGI_CF_MPXS_CONNS)) {
Christopher Faulet99eff652019-08-11 23:11:30 +02001690 fconn->streams_limit = 1;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001691 TRACE_STATE("no mpxs for streams_limit to 1", FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL, fconn->conn);
1692 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001693
1694 /* We must be sure to have read exactly the announced record length, no
1695 * more no less
1696 */
Christopher Faulet73518be2021-01-27 12:06:54 +01001697 if (offset != fconn->drl) {
1698 TRACE_ERROR("invalid GET_VALUES_RESULT record length", FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL|FCGI_EV_FCONN_ERR, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001699 goto fail;
Christopher Faulet73518be2021-01-27 12:06:54 +01001700 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001701
Willy Tarreau022e5e52020-09-10 09:33:15 +02001702 TRACE_PROTO("FCGI GET_VALUES_RESULT record rcvd", FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL, fconn->conn, 0, 0, (size_t[]){fconn->drl});
Christopher Faulet99eff652019-08-11 23:11:30 +02001703 b_del(&fconn->dbuf, fconn->drl + fconn->drp);
1704 fconn->drl = 0;
1705 fconn->drp = 0;
1706 fconn->state = FCGI_CS_RECORD_H;
1707 fcgi_wake_unassigned_streams(fconn);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001708 TRACE_STATE("switching to RECORD_H", FCGI_EV_RX_RECORD|FCGI_EV_RX_FHDR, fconn->conn);
1709 TRACE_LEAVE(FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001710 return 1;
1711 fail:
1712 fconn->state = FCGI_CS_CLOSED;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001713 TRACE_STATE("switching to CLOSED", FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL, fconn->conn);
1714 TRACE_DEVEL("leaving on error", FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL|FCGI_EV_FCONN_ERR, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001715 return 0;
1716}
1717
1718/* Sends an ABORT_REQUEST record for each active streams. Closed streams are
1719 * excluded, as the streams which already received the end-of-stream. It returns
1720 * > 0 if the record was sent tp all streams. Otherwise it returns 0.
1721 */
1722static int fcgi_conn_send_aborts(struct fcgi_conn *fconn)
1723{
1724 struct eb32_node *node;
1725 struct fcgi_strm *fstrm;
1726
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001727 TRACE_ENTER(FCGI_EV_TX_RECORD, fconn->conn);
1728
Christopher Faulet99eff652019-08-11 23:11:30 +02001729 node = eb32_lookup_ge(&fconn->streams_by_id, 1);
1730 while (node) {
1731 fstrm = container_of(node, struct fcgi_strm, by_id);
1732 node = eb32_next(node);
1733 if (fstrm->state != FCGI_SS_CLOSED &&
1734 !(fstrm->flags & (FCGI_SF_ES_RCVD|FCGI_SF_ABRT_SENT)) &&
1735 !fcgi_strm_send_abort(fconn, fstrm))
1736 return 0;
1737 }
1738 fconn->flags |= FCGI_CF_ABRTS_SENT;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001739 TRACE_STATE("aborts sent to all fstrms", FCGI_EV_TX_RECORD, fconn->conn);
1740 TRACE_LEAVE(FCGI_EV_TX_RECORD, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001741 return 1;
1742}
1743
1744/* Sends a BEGIN_REQUEST record. It returns > 0 on success, 0 if it couldn't do
1745 * anything. BEGIN_REQUEST record cannot be split. So we wait to have enough
1746 * space to proceed. It is small enough to be encoded in an empty buffer.
1747 */
1748static int fcgi_strm_send_begin_request(struct fcgi_conn *fconn, struct fcgi_strm *fstrm)
1749{
1750 struct buffer outbuf;
1751 struct buffer *mbuf;
1752 struct fcgi_begin_request rec = { .role = FCGI_RESPONDER, .flags = 0};
1753 int ret;
1754
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001755 TRACE_ENTER(FCGI_EV_TX_RECORD|FCGI_EV_TX_BEGREQ, fconn->conn, fstrm);
1756
Christopher Faulet99eff652019-08-11 23:11:30 +02001757 mbuf = br_tail(fconn->mbuf);
1758 retry:
1759 if (!fcgi_get_buf(fconn, mbuf)) {
1760 fconn->flags |= FCGI_CF_MUX_MALLOC;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001761 fstrm->flags |= FCGI_SF_BLK_MROOM;
1762 TRACE_STATE("waiting for fconn mbuf ring allocation", FCGI_EV_TX_RECORD|FCGI_EV_FSTRM_BLK|FCGI_EV_FCONN_BLK, fconn->conn, fstrm);
1763 ret = 0;
1764 goto end;
Christopher Faulet99eff652019-08-11 23:11:30 +02001765 }
1766
1767 while (1) {
1768 outbuf = b_make(b_tail(mbuf), b_contig_space(mbuf), 0, 0);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001769 if (outbuf.size >= FCGI_RECORD_HEADER_SZ || !b_space_wraps(mbuf))
Christopher Faulet99eff652019-08-11 23:11:30 +02001770 break;
1771 realign_again:
1772 b_slow_realign(mbuf, trash.area, b_data(mbuf));
1773 }
1774
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001775 if (outbuf.size < FCGI_RECORD_HEADER_SZ)
Christopher Faulet99eff652019-08-11 23:11:30 +02001776 goto full;
1777
1778 /* vsn: 1(FCGI_VERSION), type: (1)FCGI_BEGIN_REQUEST, id: fstrm->id,
1779 * len: 0x0008, padding: 0x00, rsv: 0x00 */
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001780 memcpy(outbuf.area, "\x01\x01\x00\x00\x00\x08\x00\x00", FCGI_RECORD_HEADER_SZ);
Christopher Faulet99eff652019-08-11 23:11:30 +02001781 fcgi_set_record_id(outbuf.area, fstrm->id);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001782 outbuf.data = FCGI_RECORD_HEADER_SZ;
Christopher Faulet99eff652019-08-11 23:11:30 +02001783
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001784 if (fconn->flags & FCGI_CF_KEEP_CONN) {
1785 TRACE_STATE("keep connection opened", FCGI_EV_TX_RECORD|FCGI_EV_TX_BEGREQ, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02001786 rec.flags |= FCGI_KEEP_CONN;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001787 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001788 if (!fcgi_encode_begin_request(&outbuf, &rec))
1789 goto full;
1790
1791 /* commit the record */
Willy Tarreau022e5e52020-09-10 09:33:15 +02001792 TRACE_PROTO("FCGI BEGIN_REQUEST record xferred", FCGI_EV_TX_RECORD|FCGI_EV_TX_BEGREQ, fconn->conn, fstrm, 0, (size_t[]){0});
Christopher Faulet99eff652019-08-11 23:11:30 +02001793 b_add(mbuf, outbuf.data);
1794 fstrm->flags |= FCGI_SF_BEGIN_SENT;
1795 fstrm->state = FCGI_SS_OPEN;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001796 TRACE_STATE("switching to OPEN", FCGI_EV_TX_RECORD|FCGI_EV_TX_BEGREQ, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02001797 ret = 1;
1798
1799 end:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001800 TRACE_LEAVE(FCGI_EV_TX_RECORD|FCGI_EV_TX_BEGREQ, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02001801 return ret;
1802 full:
1803 if ((mbuf = br_tail_add(fconn->mbuf)) != NULL)
1804 goto retry;
1805 fconn->flags |= FCGI_CF_MUX_MFULL;
1806 fstrm->flags |= FCGI_SF_BLK_MROOM;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001807 TRACE_STATE("mbuf ring full", FCGI_EV_TX_RECORD|FCGI_EV_FSTRM_BLK|FCGI_EV_FCONN_BLK, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02001808 ret = 0;
1809 goto end;
1810}
1811
1812/* Sends an empty record of type <rtype>. It returns > 0 on success, 0 if it
1813 * couldn't do anything. Empty record cannot be split. So we wait to have enough
1814 * space to proceed. It is small enough to be encoded in an empty buffer.
1815 */
1816static int fcgi_strm_send_empty_record(struct fcgi_conn *fconn, struct fcgi_strm *fstrm,
1817 enum fcgi_record_type rtype)
1818{
1819 struct buffer outbuf;
1820 struct buffer *mbuf;
1821 int ret;
1822
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001823 TRACE_ENTER(FCGI_EV_TX_RECORD, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02001824 mbuf = br_tail(fconn->mbuf);
1825 retry:
1826 if (!fcgi_get_buf(fconn, mbuf)) {
1827 fconn->flags |= FCGI_CF_MUX_MALLOC;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001828 fstrm->flags |= FCGI_SF_BLK_MROOM;
1829 TRACE_STATE("waiting for fconn mbuf ring allocation", FCGI_EV_TX_RECORD|FCGI_EV_FSTRM_BLK|FCGI_EV_FCONN_BLK, fconn->conn, fstrm);
1830 ret = 0;
1831 goto end;
Christopher Faulet99eff652019-08-11 23:11:30 +02001832 }
1833
1834 while (1) {
1835 outbuf = b_make(b_tail(mbuf), b_contig_space(mbuf), 0, 0);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001836 if (outbuf.size >= FCGI_RECORD_HEADER_SZ || !b_space_wraps(mbuf))
Christopher Faulet99eff652019-08-11 23:11:30 +02001837 break;
1838 realign_again:
1839 b_slow_realign(mbuf, trash.area, b_data(mbuf));
1840 }
1841
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001842 if (outbuf.size < FCGI_RECORD_HEADER_SZ)
Christopher Faulet99eff652019-08-11 23:11:30 +02001843 goto full;
1844
1845 /* vsn: 1(FCGI_VERSION), type: rtype, id: fstrm->id,
1846 * len: 0x0000, padding: 0x00, rsv: 0x00 */
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001847 memcpy(outbuf.area, "\x01\x05\x00\x00\x00\x00\x00\x00", FCGI_RECORD_HEADER_SZ);
Christopher Faulet99eff652019-08-11 23:11:30 +02001848 outbuf.area[1] = rtype;
1849 fcgi_set_record_id(outbuf.area, fstrm->id);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001850 outbuf.data = FCGI_RECORD_HEADER_SZ;
Christopher Faulet99eff652019-08-11 23:11:30 +02001851
1852 /* commit the record */
1853 b_add(mbuf, outbuf.data);
1854 ret = 1;
1855
1856 end:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001857 TRACE_LEAVE(FCGI_EV_TX_RECORD, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02001858 return ret;
1859 full:
1860 if ((mbuf = br_tail_add(fconn->mbuf)) != NULL)
1861 goto retry;
1862 fconn->flags |= FCGI_CF_MUX_MFULL;
1863 fstrm->flags |= FCGI_SF_BLK_MROOM;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001864 TRACE_STATE("mbuf ring full", FCGI_EV_TX_RECORD|FCGI_EV_FSTRM_BLK|FCGI_EV_FCONN_BLK, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02001865 ret = 0;
1866 goto end;
1867}
1868
1869
1870/* Sends an empty PARAMS record. It relies on fcgi_strm_send_empty_record(). It
1871 * marks the end of params.
1872 */
1873static int fcgi_strm_send_empty_params(struct fcgi_conn *fconn, struct fcgi_strm *fstrm)
1874{
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001875 int ret;
1876
1877 TRACE_POINT(FCGI_EV_TX_RECORD|FCGI_EV_TX_PARAMS, fconn->conn, fstrm);
1878 ret = fcgi_strm_send_empty_record(fconn, fstrm, FCGI_PARAMS);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001879 if (ret) {
1880 fstrm->flags |= FCGI_SF_EP_SENT;
Willy Tarreau022e5e52020-09-10 09:33:15 +02001881 TRACE_PROTO("FCGI PARAMS record xferred", FCGI_EV_TX_RECORD|FCGI_EV_TX_STDIN, fconn->conn, fstrm, 0, (size_t[]){0});
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001882 }
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001883 return ret;
Christopher Faulet99eff652019-08-11 23:11:30 +02001884}
1885
1886/* Sends an empty STDIN record. It relies on fcgi_strm_send_empty_record(). It
1887 * marks the end of input. On success, all the request was successfully sent.
1888 */
1889static int fcgi_strm_send_empty_stdin(struct fcgi_conn *fconn, struct fcgi_strm *fstrm)
1890{
1891 int ret;
1892
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001893 TRACE_POINT(FCGI_EV_TX_RECORD|FCGI_EV_TX_STDIN|FCGI_EV_TX_EOI, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02001894 ret = fcgi_strm_send_empty_record(fconn, fstrm, FCGI_STDIN);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001895 if (ret) {
Christopher Faulet99eff652019-08-11 23:11:30 +02001896 fstrm->flags |= FCGI_SF_ES_SENT;
Willy Tarreau022e5e52020-09-10 09:33:15 +02001897 TRACE_PROTO("FCGI STDIN record xferred", FCGI_EV_TX_RECORD|FCGI_EV_TX_STDIN, fconn->conn, fstrm, 0, (size_t[]){0});
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001898 TRACE_USER("FCGI request fully xferred", FCGI_EV_TX_RECORD|FCGI_EV_TX_STDIN|FCGI_EV_TX_EOI, fconn->conn, fstrm);
1899 TRACE_STATE("stdin data fully sent", FCGI_EV_TX_RECORD|FCGI_EV_TX_STDIN|FCGI_EV_TX_EOI, fconn->conn, fstrm);
1900 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001901 return ret;
1902}
1903
1904/* Sends an ABORT_REQUEST record. It relies on fcgi_strm_send_empty_record(). It
1905 * stops the request processing.
1906 */
1907static int fcgi_strm_send_abort(struct fcgi_conn *fconn, struct fcgi_strm *fstrm)
1908{
1909 int ret;
1910
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001911 TRACE_POINT(FCGI_EV_TX_RECORD|FCGI_EV_TX_ABORT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02001912 ret = fcgi_strm_send_empty_record(fconn, fstrm, FCGI_ABORT_REQUEST);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001913 if (ret) {
Christopher Faulet99eff652019-08-11 23:11:30 +02001914 fstrm->flags |= FCGI_SF_ABRT_SENT;
Willy Tarreau022e5e52020-09-10 09:33:15 +02001915 TRACE_PROTO("FCGI ABORT record xferred", FCGI_EV_TX_RECORD|FCGI_EV_TX_ABORT, fconn->conn, fstrm, 0, (size_t[]){0});
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001916 TRACE_USER("FCGI request aborted", FCGI_EV_TX_RECORD|FCGI_EV_TX_ABORT, fconn->conn, fstrm);
1917 TRACE_STATE("abort sent", FCGI_EV_TX_RECORD|FCGI_EV_TX_ABORT, fconn->conn, fstrm);
1918 }
Christopher Faulet99eff652019-08-11 23:11:30 +02001919 return ret;
1920}
1921
1922/* Sends a PARAMS record. Returns > 0 on success, 0 if it couldn't do
1923 * anything. If there are too much K/V params to be encoded in a PARAMS record,
1924 * several records are sent. However, a K/V param cannot be split between 2
1925 * records.
1926 */
1927static size_t fcgi_strm_send_params(struct fcgi_conn *fconn, struct fcgi_strm *fstrm,
1928 struct htx *htx)
1929{
1930 struct buffer outbuf;
1931 struct buffer *mbuf;
1932 struct htx_blk *blk;
1933 struct htx_sl *sl = NULL;
1934 struct fcgi_strm_params params;
1935 size_t total = 0;
1936
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001937 TRACE_ENTER(FCGI_EV_TX_RECORD|FCGI_EV_TX_PARAMS, fconn->conn, fstrm, htx);
1938
Christopher Faulet99eff652019-08-11 23:11:30 +02001939 memset(&params, 0, sizeof(params));
1940 params.p = get_trash_chunk();
1941
1942 mbuf = br_tail(fconn->mbuf);
1943 retry:
1944 if (!fcgi_get_buf(fconn, mbuf)) {
1945 fconn->flags |= FCGI_CF_MUX_MALLOC;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02001946 fstrm->flags |= FCGI_SF_BLK_MROOM;
1947 TRACE_STATE("waiting for fconn mbuf ring allocation", FCGI_EV_TX_RECORD|FCGI_EV_FSTRM_BLK|FCGI_EV_FCONN_BLK, fconn->conn, fstrm);
1948 goto end;
Christopher Faulet99eff652019-08-11 23:11:30 +02001949 }
1950
1951 while (1) {
1952 outbuf = b_make(b_tail(mbuf), b_contig_space(mbuf), 0, 0);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001953 if (outbuf.size >= FCGI_RECORD_HEADER_SZ || !b_space_wraps(mbuf))
Christopher Faulet99eff652019-08-11 23:11:30 +02001954 break;
1955 realign_again:
1956 b_slow_realign(mbuf, trash.area, b_data(mbuf));
1957 }
1958
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001959 if (outbuf.size < FCGI_RECORD_HEADER_SZ)
Christopher Faulet99eff652019-08-11 23:11:30 +02001960 goto full;
1961
1962 /* vsn: 1(FCGI_VERSION), type: (4)FCGI_PARAMS, id: fstrm->id,
1963 * len: 0x0000 (fill later), padding: 0x00, rsv: 0x00 */
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001964 memcpy(outbuf.area, "\x01\x04\x00\x00\x00\x00\x00\x00", FCGI_RECORD_HEADER_SZ);
Christopher Faulet99eff652019-08-11 23:11:30 +02001965 fcgi_set_record_id(outbuf.area, fstrm->id);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001966 outbuf.data = FCGI_RECORD_HEADER_SZ;
Christopher Faulet99eff652019-08-11 23:11:30 +02001967
1968 blk = htx_get_head_blk(htx);
1969 while (blk) {
1970 enum htx_blk_type type;
1971 uint32_t size = htx_get_blksz(blk);
1972 struct fcgi_param p;
1973
1974 type = htx_get_blk_type(blk);
1975 switch (type) {
1976 case HTX_BLK_REQ_SL:
1977 sl = htx_get_blk_ptr(htx, blk);
1978 if (sl->info.req.meth == HTTP_METH_HEAD)
1979 fstrm->h1m.flags |= H1_MF_METH_HEAD;
1980 if (sl->flags & HTX_SL_F_VER_11)
1981 fstrm->h1m.flags |= H1_MF_VER_11;
1982 break;
1983
1984 case HTX_BLK_HDR:
1985 p.n = htx_get_blk_name(htx, blk);
1986 p.v = htx_get_blk_value(htx, blk);
1987
1988 if (istmatch(p.n, ist(":fcgi-"))) {
Tim Duesterhusa6a32792022-03-05 00:52:45 +01001989 p.n = istadv(p.n, 6);
Christopher Faulet99eff652019-08-11 23:11:30 +02001990 if (isteq(p.n, ist("gateway_interface")))
1991 params.mask |= FCGI_SP_CGI_GATEWAY;
1992 else if (isteq(p.n, ist("document_root"))) {
1993 params.mask |= FCGI_SP_DOC_ROOT;
1994 params.docroot = p.v;
1995 }
1996 else if (isteq(p.n, ist("script_name"))) {
1997 params.mask |= FCGI_SP_SCRIPT_NAME;
1998 params.scriptname = p.v;
1999 }
2000 else if (isteq(p.n, ist("path_info"))) {
2001 params.mask |= FCGI_SP_PATH_INFO;
2002 params.pathinfo = p.v;
2003 }
2004 else if (isteq(p.n, ist("request_uri"))) {
2005 params.mask |= FCGI_SP_REQ_URI;
2006 params.uri = p.v;
2007 }
2008 else if (isteq(p.n, ist("request_meth")))
2009 params.mask |= FCGI_SP_REQ_METH;
2010 else if (isteq(p.n, ist("query_string")))
2011 params.mask |= FCGI_SP_REQ_QS;
2012 else if (isteq(p.n, ist("server_name")))
2013 params.mask |= FCGI_SP_SRV_NAME;
2014 else if (isteq(p.n, ist("server_port")))
2015 params.mask |= FCGI_SP_SRV_PORT;
2016 else if (isteq(p.n, ist("server_protocol")))
2017 params.mask |= FCGI_SP_SRV_PROTO;
2018 else if (isteq(p.n, ist("remote_addr")))
2019 params.mask |= FCGI_SP_REM_ADDR;
2020 else if (isteq(p.n, ist("remote_port")))
2021 params.mask |= FCGI_SP_REM_PORT;
2022 else if (isteq(p.n, ist("script_filename")))
2023 params.mask |= FCGI_SP_SCRIPT_FILE;
2024 else if (isteq(p.n, ist("path_translated")))
2025 params.mask |= FCGI_SP_PATH_TRANS;
2026 else if (isteq(p.n, ist("https")))
2027 params.mask |= FCGI_SP_HTTPS;
Christopher Faulet5cd0e522021-06-11 13:34:42 +02002028 else if (isteq(p.n, ist("server_software")))
2029 params.mask |= FCGI_SP_SRV_SOFT;
Christopher Faulet99eff652019-08-11 23:11:30 +02002030 }
2031 else if (isteq(p.n, ist("content-length"))) {
2032 p.n = ist("CONTENT_LENGTH");
2033 params.mask |= FCGI_SP_CONT_LEN;
2034 }
2035 else if (isteq(p.n, ist("content-type")))
2036 p.n = ist("CONTENT_TYPE");
2037 else {
Tim Duesterhus98f05f62022-03-05 00:52:44 +01002038 struct ist n;
2039
Christopher Faulet99eff652019-08-11 23:11:30 +02002040 if (isteq(p.n, ist("host")))
2041 params.srv_name = p.v;
Christopher Fauletf56e8462021-09-28 10:56:36 +02002042 else if (isteq(p.n, ist("te"))) {
2043 /* "te" may only be sent with "trailers" if this value
2044 * is present, otherwise it must be deleted.
2045 */
2046 p.v = istist(p.v, ist("trailers"));
2047 if (!isttest(p.v) || (p.v.len > 8 && p.v.ptr[8] != ','))
2048 break;
2049 p.v = ist("trailers");
2050 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002051
Christopher Faulet67d58092019-10-02 10:51:38 +02002052 /* Skip header if same name is used to add the server name */
Tim Duesterhusb4b03772022-03-05 00:52:43 +01002053 if (isttest(fconn->proxy->server_id_hdr_name) && isteq(p.n, fconn->proxy->server_id_hdr_name))
Christopher Faulet67d58092019-10-02 10:51:38 +02002054 break;
2055
Tim Duesterhus98f05f62022-03-05 00:52:44 +01002056 n = ist2(trash.area, 0);
2057 istcat(&n, ist("http_"), trash.size);
2058 istcat(&n, p.n, trash.size);
2059 p.n = n;
Christopher Faulet99eff652019-08-11 23:11:30 +02002060 }
2061
2062 if (!fcgi_encode_param(&outbuf, &p)) {
2063 if (b_space_wraps(mbuf))
2064 goto realign_again;
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002065 if (outbuf.data == FCGI_RECORD_HEADER_SZ)
Christopher Faulet99eff652019-08-11 23:11:30 +02002066 goto full;
2067 goto done;
2068 }
2069 break;
2070
2071 case HTX_BLK_EOH:
Tim Duesterhusb4b03772022-03-05 00:52:43 +01002072 if (isttest(fconn->proxy->server_id_hdr_name)) {
Christopher Faulet72ba6cd2019-09-24 16:20:05 +02002073 struct server *srv = objt_server(fconn->conn->target);
2074
2075 if (!srv)
2076 goto done;
2077
Tim Duesterhusb4b03772022-03-05 00:52:43 +01002078 p.n = ist2(trash.area, 0);
2079 istcat(&p.n, ist("http_"), trash.size);
2080 istcat(&p.n, fconn->proxy->server_id_hdr_name, trash.size);
Christopher Faulet72ba6cd2019-09-24 16:20:05 +02002081 p.v = ist(srv->id);
2082
2083 if (!fcgi_encode_param(&outbuf, &p)) {
2084 if (b_space_wraps(mbuf))
2085 goto realign_again;
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002086 if (outbuf.data == FCGI_RECORD_HEADER_SZ)
Christopher Faulet72ba6cd2019-09-24 16:20:05 +02002087 goto full;
2088 }
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002089 TRACE_STATE("add server name header", FCGI_EV_TX_RECORD|FCGI_EV_TX_PARAMS, fconn->conn, fstrm);
Christopher Faulet72ba6cd2019-09-24 16:20:05 +02002090 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002091 goto done;
2092
2093 default:
2094 break;
2095 }
2096 total += size;
2097 blk = htx_remove_blk(htx, blk);
2098 }
2099
2100 done:
Christopher Faulet73518be2021-01-27 12:06:54 +01002101 if (!fcgi_set_default_param(fconn, fstrm, htx, sl, &params)) {
2102 TRACE_ERROR("error setting default params", FCGI_EV_TX_RECORD|FCGI_EV_STRM_ERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002103 goto error;
Christopher Faulet73518be2021-01-27 12:06:54 +01002104 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002105
2106 if (!fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_CGI_GATEWAY) ||
2107 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_DOC_ROOT) ||
2108 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_SCRIPT_NAME) ||
2109 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_PATH_INFO) ||
2110 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_REQ_URI) ||
2111 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_REQ_METH) ||
2112 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_REQ_QS) ||
2113 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_SRV_NAME) ||
2114 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_SRV_PORT) ||
2115 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_SRV_PROTO) ||
2116 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_REM_ADDR) ||
2117 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_REM_PORT) ||
2118 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_SCRIPT_FILE) ||
2119 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_PATH_TRANS) ||
2120 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_CONT_LEN) ||
Christopher Faulet5cd0e522021-06-11 13:34:42 +02002121 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_SRV_SOFT) ||
Christopher Faulet73518be2021-01-27 12:06:54 +01002122 !fcgi_encode_default_param(fconn, fstrm, &params, &outbuf, FCGI_SP_HTTPS)) {
2123 TRACE_ERROR("error encoding default params", FCGI_EV_TX_RECORD|FCGI_EV_STRM_ERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002124 goto error;
Christopher Faulet73518be2021-01-27 12:06:54 +01002125 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002126
2127 /* update the record's size */
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002128 TRACE_PROTO("FCGI PARAMS record xferred", FCGI_EV_TX_RECORD|FCGI_EV_TX_PARAMS, fconn->conn, fstrm, 0, (size_t[]){outbuf.data - FCGI_RECORD_HEADER_SZ});
2129 fcgi_set_record_size(outbuf.area, outbuf.data - FCGI_RECORD_HEADER_SZ);
Christopher Faulet99eff652019-08-11 23:11:30 +02002130 b_add(mbuf, outbuf.data);
2131
2132 end:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002133 TRACE_LEAVE(FCGI_EV_TX_RECORD|FCGI_EV_TX_PARAMS, fconn->conn, fstrm, htx, (size_t[]){total});
Christopher Faulet99eff652019-08-11 23:11:30 +02002134 return total;
2135 full:
2136 if ((mbuf = br_tail_add(fconn->mbuf)) != NULL)
2137 goto retry;
2138 fconn->flags |= FCGI_CF_MUX_MFULL;
2139 fstrm->flags |= FCGI_SF_BLK_MROOM;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002140 TRACE_STATE("mbuf ring full", FCGI_EV_TX_RECORD|FCGI_EV_FSTRM_BLK|FCGI_EV_FCONN_BLK, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002141 if (total)
2142 goto error;
2143 goto end;
2144
2145 error:
2146 htx->flags |= HTX_FL_PROCESSING_ERROR;
Christopher Faulet73518be2021-01-27 12:06:54 +01002147 TRACE_ERROR("processing error sending PARAMS record", FCGI_EV_TX_RECORD|FCGI_EV_STRM_ERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002148 fcgi_strm_error(fstrm);
2149 goto end;
2150}
2151
2152/* Sends a STDIN record. Returns > 0 on success, 0 if it couldn't do
2153 * anything. STDIN records contain the request body.
2154 */
2155static size_t fcgi_strm_send_stdin(struct fcgi_conn *fconn, struct fcgi_strm *fstrm,
2156 struct htx *htx, size_t count, struct buffer *buf)
2157{
2158 struct buffer outbuf;
2159 struct buffer *mbuf;
2160 struct htx_blk *blk;
2161 enum htx_blk_type type;
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002162 uint32_t size, extra_bytes;
Christopher Faulet99eff652019-08-11 23:11:30 +02002163 size_t total = 0;
2164
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002165 extra_bytes = 0;
2166
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002167 TRACE_ENTER(FCGI_EV_TX_RECORD|FCGI_EV_TX_STDIN, fconn->conn, fstrm, htx, (size_t[]){count});
Christopher Faulet99eff652019-08-11 23:11:30 +02002168 if (!count)
2169 goto end;
2170
2171 mbuf = br_tail(fconn->mbuf);
2172 retry:
2173 if (!fcgi_get_buf(fconn, mbuf)) {
2174 fconn->flags |= FCGI_CF_MUX_MALLOC;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002175 fstrm->flags |= FCGI_SF_BLK_MROOM;
2176 TRACE_STATE("waiting for fconn mbuf ring allocation", FCGI_EV_TX_RECORD|FCGI_EV_FSTRM_BLK|FCGI_EV_FCONN_BLK, fconn->conn, fstrm);
2177 goto end;
Christopher Faulet99eff652019-08-11 23:11:30 +02002178 }
2179
2180 /* Perform some optimizations to reduce the number of buffer copies.
2181 * First, if the mux's buffer is empty and the htx area contains exactly
2182 * one data block of the same size as the requested count, and this
2183 * count fits within the record size, then it's possible to simply swap
2184 * the caller's buffer with the mux's output buffer and adjust offsets
2185 * and length to match the entire DATA HTX block in the middle. In this
2186 * case we perform a true zero-copy operation from end-to-end. This is
2187 * the situation that happens all the time with large files. Second, if
2188 * this is not possible, but the mux's output buffer is empty, we still
2189 * have an opportunity to avoid the copy to the intermediary buffer, by
2190 * making the intermediary buffer's area point to the output buffer's
2191 * area. In this case we want to skip the HTX header to make sure that
2192 * copies remain aligned and that this operation remains possible all
2193 * the time. This goes for headers, data blocks and any data extracted
2194 * from the HTX blocks.
2195 */
2196 blk = htx_get_head_blk(htx);
2197 if (!blk)
2198 goto end;
2199 type = htx_get_blk_type(blk);
2200 size = htx_get_blksz(blk);
2201 if (unlikely(size == count && htx_nbblks(htx) == 1 && type == HTX_BLK_DATA)) {
2202 void *old_area = mbuf->area;
2203
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002204 /* Last block of the message: Reserve the size for the empty stdin record */
2205 if (htx->flags & HTX_FL_EOM)
2206 extra_bytes = FCGI_RECORD_HEADER_SZ;
2207
Christopher Faulet99eff652019-08-11 23:11:30 +02002208 if (b_data(mbuf)) {
2209 /* Too bad there are data left there. We're willing to memcpy/memmove
2210 * up to 1/4 of the buffer, which means that it's OK to copy a large
2211 * record into a buffer containing few data if it needs to be realigned,
2212 * and that it's also OK to copy few data without realigning. Otherwise
2213 * we'll pretend the mbuf is full and wait for it to become empty.
2214 */
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002215 if (size + FCGI_RECORD_HEADER_SZ + extra_bytes <= b_room(mbuf) &&
Christopher Faulet99eff652019-08-11 23:11:30 +02002216 (b_data(mbuf) <= b_size(mbuf) / 4 ||
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002217 (size <= b_size(mbuf) / 4 && size + FCGI_RECORD_HEADER_SZ + extra_bytes <= b_contig_space(mbuf))))
Christopher Faulet99eff652019-08-11 23:11:30 +02002218 goto copy;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002219 goto full;
Christopher Faulet99eff652019-08-11 23:11:30 +02002220 }
2221
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002222 TRACE_PROTO("sending stding data (zero-copy)", FCGI_EV_TX_RECORD|FCGI_EV_TX_STDIN, fconn->conn, fstrm, htx, (size_t[]){size});
Christopher Faulet99eff652019-08-11 23:11:30 +02002223 /* map a FCGI record to the HTX block so that we can put the
2224 * record header there.
2225 */
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002226 *mbuf = b_make(buf->area, buf->size, sizeof(struct htx) + blk->addr - FCGI_RECORD_HEADER_SZ, size + FCGI_RECORD_HEADER_SZ);
Christopher Faulet99eff652019-08-11 23:11:30 +02002227 outbuf.area = b_head(mbuf);
2228
2229 /* prepend a FCGI record header just before the DATA block */
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002230 memcpy(outbuf.area, "\x01\x05\x00\x00\x00\x00\x00\x00", FCGI_RECORD_HEADER_SZ);
Christopher Faulet99eff652019-08-11 23:11:30 +02002231 fcgi_set_record_id(outbuf.area, fstrm->id);
2232 fcgi_set_record_size(outbuf.area, size);
2233
2234 /* and exchange with our old area */
2235 buf->area = old_area;
2236 buf->data = buf->head = 0;
2237 total += size;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002238
2239 htx = (struct htx *)buf->area;
2240 htx_reset(htx);
Christopher Faulet99eff652019-08-11 23:11:30 +02002241 goto end;
2242 }
2243
2244 copy:
2245 while (1) {
2246 outbuf = b_make(b_tail(mbuf), b_contig_space(mbuf), 0, 0);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002247 if (outbuf.size >= FCGI_RECORD_HEADER_SZ + extra_bytes || !b_space_wraps(mbuf))
Christopher Faulet99eff652019-08-11 23:11:30 +02002248 break;
2249 realign_again:
2250 b_slow_realign(mbuf, trash.area, b_data(mbuf));
2251 }
2252
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002253 if (outbuf.size < FCGI_RECORD_HEADER_SZ + extra_bytes)
Christopher Faulet99eff652019-08-11 23:11:30 +02002254 goto full;
2255
2256 /* vsn: 1(FCGI_VERSION), type: (5)FCGI_STDIN, id: fstrm->id,
2257 * len: 0x0000 (fill later), padding: 0x00, rsv: 0x00 */
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002258 memcpy(outbuf.area, "\x01\x05\x00\x00\x00\x00\x00\x00", FCGI_RECORD_HEADER_SZ);
Christopher Faulet99eff652019-08-11 23:11:30 +02002259 fcgi_set_record_id(outbuf.area, fstrm->id);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002260 outbuf.data = FCGI_RECORD_HEADER_SZ;
Christopher Faulet99eff652019-08-11 23:11:30 +02002261
2262 blk = htx_get_head_blk(htx);
2263 while (blk && count) {
2264 enum htx_blk_type type = htx_get_blk_type(blk);
2265 uint32_t size = htx_get_blksz(blk);
2266 struct ist v;
2267
2268 switch (type) {
2269 case HTX_BLK_DATA:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002270 TRACE_PROTO("sending stding data", FCGI_EV_TX_RECORD|FCGI_EV_TX_STDIN, fconn->conn, fstrm, htx, (size_t[]){size});
Christopher Faulet99eff652019-08-11 23:11:30 +02002271 v = htx_get_blk_value(htx, blk);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002272
2273 if (htx_is_unique_blk(htx, blk) && (htx->flags & HTX_FL_EOM))
2274 extra_bytes = FCGI_RECORD_HEADER_SZ; /* Last block of the message */
2275
2276 if (v.len > count) {
Christopher Faulet99eff652019-08-11 23:11:30 +02002277 v.len = count;
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002278 extra_bytes = 0;
2279 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002280
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002281 if (v.len + FCGI_RECORD_HEADER_SZ + extra_bytes > b_room(&outbuf)) {
Christopher Faulet99eff652019-08-11 23:11:30 +02002282 /* It doesn't fit at once. If it at least fits once split and
2283 * the amount of data to move is low, let's defragment the
2284 * buffer now.
2285 */
2286 if (b_space_wraps(mbuf) &&
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002287 b_data(&outbuf) + v.len + extra_bytes <= b_room(mbuf) &&
Christopher Faulet99eff652019-08-11 23:11:30 +02002288 b_data(mbuf) <= MAX_DATA_REALIGN)
2289 goto realign_again;
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002290 v.len = b_room(&outbuf) - FCGI_RECORD_HEADER_SZ - extra_bytes;
Christopher Faulet99eff652019-08-11 23:11:30 +02002291 }
2292 if (!v.len || !chunk_memcat(&outbuf, v.ptr, v.len)) {
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002293 if (outbuf.data == FCGI_RECORD_HEADER_SZ)
Christopher Faulet99eff652019-08-11 23:11:30 +02002294 goto full;
2295 goto done;
2296 }
2297 if (v.len != size) {
2298 total += v.len;
2299 count -= v.len;
2300 htx_cut_data_blk(htx, blk, v.len);
2301 goto done;
2302 }
2303 break;
2304
Christopher Faulet99eff652019-08-11 23:11:30 +02002305 default:
2306 break;
2307 }
2308 total += size;
2309 count -= size;
2310 blk = htx_remove_blk(htx, blk);
2311 }
2312
2313 done:
2314 /* update the record's size */
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002315 TRACE_PROTO("FCGI STDIN record xferred", FCGI_EV_TX_RECORD|FCGI_EV_TX_STDIN, fconn->conn, fstrm, 0, (size_t[]){outbuf.data - FCGI_RECORD_HEADER_SZ});
2316 fcgi_set_record_size(outbuf.area, outbuf.data - FCGI_RECORD_HEADER_SZ);
Christopher Faulet99eff652019-08-11 23:11:30 +02002317 b_add(mbuf, outbuf.data);
2318
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002319 /* Send the empty stding here to finish the message */
2320 if (htx_is_empty(htx) && (htx->flags & HTX_FL_EOM)) {
2321 TRACE_PROTO("sending FCGI STDIN record", FCGI_EV_TX_RECORD|FCGI_EV_TX_STDIN, fconn->conn, fstrm, htx);
2322 if (!fcgi_strm_send_empty_stdin(fconn, fstrm)) {
2323 /* bytes already reserved for this record. It should not fail */
2324 htx->flags |= HTX_FL_PROCESSING_ERROR;
Christopher Faulet73518be2021-01-27 12:06:54 +01002325 TRACE_ERROR("processing error sending empty STDIN record", FCGI_EV_TX_RECORD|FCGI_EV_STRM_ERR, fconn->conn, fstrm);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002326 fcgi_strm_error(fstrm);
2327 }
2328 }
2329
Christopher Faulet99eff652019-08-11 23:11:30 +02002330 end:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002331 TRACE_LEAVE(FCGI_EV_TX_RECORD|FCGI_EV_TX_STDIN, fconn->conn, fstrm, htx, (size_t[]){total});
Christopher Faulet99eff652019-08-11 23:11:30 +02002332 return total;
2333 full:
2334 if ((mbuf = br_tail_add(fconn->mbuf)) != NULL)
2335 goto retry;
2336 fconn->flags |= FCGI_CF_MUX_MFULL;
2337 fstrm->flags |= FCGI_SF_BLK_MROOM;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002338 TRACE_STATE("mbuf ring full", FCGI_EV_TX_RECORD|FCGI_EV_FSTRM_BLK|FCGI_EV_FCONN_BLK, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002339 goto end;
2340}
2341
2342/* Processes a STDOUT record. Returns > 0 on success, 0 if it couldn't do
2343 * anything. STDOUT records contain the entire response. All the content is
2344 * copied in the stream's rxbuf. The parsing will be handled in fcgi_rcv_buf().
2345 */
2346static int fcgi_strm_handle_stdout(struct fcgi_conn *fconn, struct fcgi_strm *fstrm)
2347{
2348 struct buffer *dbuf;
2349 size_t ret;
2350 size_t max;
2351
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002352 TRACE_ENTER(FCGI_EV_RX_RECORD|FCGI_EV_RX_STDOUT, fconn->conn, fstrm);
2353
Christopher Faulet99eff652019-08-11 23:11:30 +02002354 dbuf = &fconn->dbuf;
2355
2356 /* Only padding remains */
2357 if (fconn->state == FCGI_CS_RECORD_P)
2358 goto end_transfer;
2359
2360 if (b_data(dbuf) < (fconn->drl + fconn->drp) &&
2361 b_size(dbuf) > (fconn->drl + fconn->drp) &&
2362 buf_room_for_htx_data(dbuf))
2363 goto fail; // incomplete record
2364
2365 if (!fcgi_get_buf(fconn, &fstrm->rxbuf)) {
2366 fconn->flags |= FCGI_CF_DEM_SALLOC;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002367 TRACE_STATE("waiting for fstrm rxbuf allocation", FCGI_EV_RX_RECORD|FCGI_EV_FSTRM_BLK, fconn->conn, fstrm);
2368 goto fail;
Christopher Faulet99eff652019-08-11 23:11:30 +02002369 }
2370
2371 /*max = MIN(b_room(&fstrm->rxbuf), fconn->drl);*/
2372 max = buf_room_for_htx_data(&fstrm->rxbuf);
2373 if (!b_data(&fstrm->rxbuf))
2374 fstrm->rxbuf.head = sizeof(struct htx);
2375 if (max > fconn->drl)
2376 max = fconn->drl;
2377
2378 ret = b_xfer(&fstrm->rxbuf, dbuf, max);
2379 if (!ret)
2380 goto fail;
2381 fconn->drl -= ret;
Willy Tarreau022e5e52020-09-10 09:33:15 +02002382 TRACE_DATA("move some data to fstrm rxbuf", FCGI_EV_RX_RECORD|FCGI_EV_RX_STDOUT, fconn->conn, fstrm, 0, (size_t[]){ret});
2383 TRACE_PROTO("FCGI STDOUT record rcvd", FCGI_EV_RX_RECORD|FCGI_EV_RX_STDOUT, fconn->conn, fstrm, 0, (size_t[]){ret});
Christopher Faulet99eff652019-08-11 23:11:30 +02002384
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002385 if (!buf_room_for_htx_data(&fstrm->rxbuf)) {
Christopher Faulet99eff652019-08-11 23:11:30 +02002386 fconn->flags |= FCGI_CF_DEM_SFULL;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002387 TRACE_STATE("fstrm rxbuf full", FCGI_EV_RX_RECORD|FCGI_EV_FSTRM_BLK, fconn->conn, fstrm);
2388 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002389
2390 if (fconn->drl)
2391 goto fail;
2392
2393 end_transfer:
Christopher Faulet6c99d3b2020-07-15 15:55:52 +02002394 fconn->state = FCGI_CS_RECORD_P;
Christopher Faulet99eff652019-08-11 23:11:30 +02002395 fconn->drl += fconn->drp;
2396 fconn->drp = 0;
2397 ret = MIN(b_data(&fconn->dbuf), fconn->drl);
2398 b_del(&fconn->dbuf, ret);
2399 fconn->drl -= ret;
2400 if (fconn->drl)
2401 goto fail;
2402
2403 fconn->state = FCGI_CS_RECORD_H;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002404 TRACE_STATE("switching to RECORD_H", FCGI_EV_RX_RECORD|FCGI_EV_RX_FHDR, fconn->conn, fstrm);
2405 TRACE_LEAVE(FCGI_EV_RX_RECORD|FCGI_EV_RX_STDOUT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002406 return 1;
2407 fail:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002408 TRACE_DEVEL("leaving on missing data or error", FCGI_EV_RX_RECORD|FCGI_EV_RX_STDOUT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002409 return 0;
2410}
2411
2412
2413/* Processes an empty STDOUT. Returns > 0 on success, 0 if it couldn't do
2414 * anything. It only skip the padding in fact, there is no payload for such
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +05002415 * records. It marks the end of the response.
Christopher Faulet99eff652019-08-11 23:11:30 +02002416 */
2417static int fcgi_strm_handle_empty_stdout(struct fcgi_conn *fconn, struct fcgi_strm *fstrm)
2418{
2419 int ret;
2420
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002421 TRACE_ENTER(FCGI_EV_RX_RECORD|FCGI_EV_RX_STDOUT, fconn->conn, fstrm);
2422
Christopher Faulet99eff652019-08-11 23:11:30 +02002423 fconn->state = FCGI_CS_RECORD_P;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002424 TRACE_STATE("switching to RECORD_P", FCGI_EV_RX_RECORD|FCGI_EV_RX_STDOUT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002425 fconn->drl += fconn->drp;
2426 fconn->drp = 0;
2427 ret = MIN(b_data(&fconn->dbuf), fconn->drl);
2428 b_del(&fconn->dbuf, ret);
2429 fconn->drl -= ret;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002430 if (fconn->drl) {
2431 TRACE_DEVEL("leaving on missing data or error", FCGI_EV_RX_RECORD|FCGI_EV_RX_STDOUT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002432 return 0;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002433 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002434 fconn->state = FCGI_CS_RECORD_H;
Christopher Faulet3b3096e2020-07-15 16:04:49 +02002435 fstrm->flags |= FCGI_SF_ES_RCVD;
Willy Tarreau022e5e52020-09-10 09:33:15 +02002436 TRACE_PROTO("FCGI STDOUT record rcvd", FCGI_EV_RX_RECORD|FCGI_EV_RX_STDOUT, fconn->conn, fstrm, 0, (size_t[]){0});
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002437 TRACE_STATE("stdout data fully send, switching to RECORD_H", FCGI_EV_RX_RECORD|FCGI_EV_RX_FHDR|FCGI_EV_RX_EOI, fconn->conn, fstrm);
2438 TRACE_LEAVE(FCGI_EV_RX_RECORD|FCGI_EV_RX_STDOUT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002439 return 1;
2440}
2441
2442/* Processes a STDERR record. Returns > 0 on success, 0 if it couldn't do
2443 * anything.
2444 */
2445static int fcgi_strm_handle_stderr(struct fcgi_conn *fconn, struct fcgi_strm *fstrm)
2446{
2447 struct buffer *dbuf;
2448 struct buffer tag;
2449 size_t ret;
2450
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002451 TRACE_ENTER(FCGI_EV_RX_RECORD|FCGI_EV_RX_STDERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002452 dbuf = &fconn->dbuf;
2453
2454 /* Only padding remains */
Christopher Faulet7f854332020-07-15 15:46:30 +02002455 if (fconn->state == FCGI_CS_RECORD_P || !fconn->drl)
Christopher Faulet99eff652019-08-11 23:11:30 +02002456 goto end_transfer;
2457
2458 if (b_data(dbuf) < (fconn->drl + fconn->drp) &&
2459 b_size(dbuf) > (fconn->drl + fconn->drp) &&
2460 buf_room_for_htx_data(dbuf))
2461 goto fail; // incomplete record
2462
2463 chunk_reset(&trash);
2464 ret = b_xfer(&trash, dbuf, MIN(b_room(&trash), fconn->drl));
2465 if (!ret)
2466 goto fail;
2467 fconn->drl -= ret;
Willy Tarreau022e5e52020-09-10 09:33:15 +02002468 TRACE_PROTO("FCGI STDERR record rcvd", FCGI_EV_RX_RECORD|FCGI_EV_RX_STDERR, fconn->conn, fstrm, 0, (size_t[]){ret});
Christopher Faulet99eff652019-08-11 23:11:30 +02002469
2470 trash.area[ret] = '\n';
2471 trash.area[ret+1] = '\0';
2472 tag.area = fconn->app->name; tag.data = strlen(fconn->app->name);
Christopher Fauletc45791a2019-09-24 14:30:46 +02002473 app_log(&fconn->app->logsrvs, &tag, LOG_ERR, "%s", trash.area);
Christopher Faulet99eff652019-08-11 23:11:30 +02002474
2475 if (fconn->drl)
2476 goto fail;
2477
2478 end_transfer:
Christopher Faulet6c99d3b2020-07-15 15:55:52 +02002479 fconn->state = FCGI_CS_RECORD_P;
Christopher Faulet99eff652019-08-11 23:11:30 +02002480 fconn->drl += fconn->drp;
2481 fconn->drp = 0;
2482 ret = MIN(b_data(&fconn->dbuf), fconn->drl);
2483 b_del(&fconn->dbuf, ret);
2484 fconn->drl -= ret;
2485 if (fconn->drl)
2486 goto fail;
2487 fconn->state = FCGI_CS_RECORD_H;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002488 TRACE_STATE("switching to RECORD_H", FCGI_EV_RX_RECORD|FCGI_EV_RX_FHDR, fconn->conn, fstrm);
2489 TRACE_LEAVE(FCGI_EV_RX_RECORD|FCGI_EV_RX_STDERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002490 return 1;
2491 fail:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002492 TRACE_DEVEL("leaving on missing data or error", FCGI_EV_RX_RECORD|FCGI_EV_RX_STDERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002493 return 0;
2494}
2495
2496/* Processes an END_REQUEST record. Returns > 0 on success, 0 if it couldn't do
2497 * anything. If the empty STDOUT record is not already received, this one marks
2498 * the end of the response. It is highly unexpected, but if the record is larger
2499 * than a buffer and cannot be decoded in one time, an error is triggered and
2500 * the connection is closed. END_REQUEST record cannot be split.
2501 */
2502static int fcgi_strm_handle_end_request(struct fcgi_conn *fconn, struct fcgi_strm *fstrm)
2503{
2504 struct buffer inbuf;
2505 struct buffer *dbuf;
2506 struct fcgi_end_request endreq;
2507
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002508 TRACE_ENTER(FCGI_EV_RX_RECORD|FCGI_EV_RX_ENDREQ, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002509 dbuf = &fconn->dbuf;
2510
2511 /* Record too large to be fully decoded */
Christopher Faulet73518be2021-01-27 12:06:54 +01002512 if (b_size(dbuf) < (fconn->drl + fconn->drp)) {
2513 TRACE_ERROR("END_REQUEST record too large", FCGI_EV_RX_RECORD|FCGI_EV_RX_ENDREQ|FCGI_EV_FSTRM_ERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002514 goto fail;
Christopher Faulet73518be2021-01-27 12:06:54 +01002515 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002516
2517 /* process full record only */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002518 if (b_data(dbuf) < (fconn->drl + fconn->drp)) {
2519 TRACE_DEVEL("leaving on missing data", FCGI_EV_RX_RECORD|FCGI_EV_RX_ENDREQ, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002520 return 0;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002521 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002522
2523 if (unlikely(b_contig_data(dbuf, b_head_ofs(dbuf)) < fconn->drl)) {
2524 /* Realign the dmux buffer if the record wraps. It is unexpected
2525 * at this stage because it should be the first record received
2526 * from the FCGI application.
2527 */
Christopher Faulet00d7cde2021-02-04 11:01:51 +01002528 b_slow_realign_ofs(dbuf, trash.area, 0);
Christopher Faulet99eff652019-08-11 23:11:30 +02002529 }
2530
2531 inbuf = b_make(b_head(dbuf), b_data(dbuf), 0, fconn->drl);
2532
Christopher Faulet73518be2021-01-27 12:06:54 +01002533 if (!fcgi_decode_end_request(&inbuf, 0, &endreq)) {
2534 TRACE_ERROR("END_REQUEST record decoding failure", FCGI_EV_RX_RECORD|FCGI_EV_RX_ENDREQ|FCGI_EV_FSTRM_ERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002535 goto fail;
Christopher Faulet73518be2021-01-27 12:06:54 +01002536 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002537
2538 fstrm->flags |= FCGI_SF_ES_RCVD;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002539 TRACE_STATE("end of script reported", FCGI_EV_RX_RECORD|FCGI_EV_RX_ENDREQ|FCGI_EV_RX_EOI, fconn->conn, fstrm);
Willy Tarreau022e5e52020-09-10 09:33:15 +02002540 TRACE_PROTO("FCGI END_REQUEST record rcvd", FCGI_EV_RX_RECORD|FCGI_EV_RX_ENDREQ, fconn->conn, fstrm, 0, (size_t[]){fconn->drl});
Christopher Faulet99eff652019-08-11 23:11:30 +02002541 fstrm->proto_status = endreq.errcode;
2542 fcgi_strm_close(fstrm);
2543
2544 b_del(&fconn->dbuf, fconn->drl + fconn->drp);
2545 fconn->drl = 0;
2546 fconn->drp = 0;
2547 fconn->state = FCGI_CS_RECORD_H;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002548 TRACE_STATE("switching to RECORD_H", FCGI_EV_RX_RECORD|FCGI_EV_RX_FHDR, fconn->conn, fstrm);
2549 TRACE_LEAVE(FCGI_EV_RX_RECORD|FCGI_EV_RX_ENDREQ, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002550 return 1;
2551
2552 fail:
2553 fcgi_strm_error(fstrm);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002554 TRACE_DEVEL("leaving on error", FCGI_EV_RX_RECORD|FCGI_EV_RX_ENDREQ|FCGI_EV_FSTRM_ERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002555 return 0;
2556}
2557
2558/* process Rx records to be demultiplexed */
2559static void fcgi_process_demux(struct fcgi_conn *fconn)
2560{
2561 struct fcgi_strm *fstrm = NULL, *tmp_fstrm;
2562 struct fcgi_header hdr;
2563 int ret;
2564
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002565 TRACE_ENTER(FCGI_EV_FCONN_WAKE, fconn->conn);
2566
Christopher Faulet99eff652019-08-11 23:11:30 +02002567 if (fconn->state == FCGI_CS_CLOSED)
2568 return;
2569
2570 if (unlikely(fconn->state < FCGI_CS_RECORD_H)) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002571 if (fconn->state == FCGI_CS_INIT) {
2572 TRACE_STATE("waiting FCGI GET_VALUES to be sent", FCGI_EV_RX_RECORD|FCGI_EV_RX_FHDR|FCGI_EV_RX_GETVAL, fconn->conn);
2573 return;
2574 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002575 if (fconn->state == FCGI_CS_SETTINGS) {
2576 /* ensure that what is pending is a valid GET_VALUES_RESULT record. */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002577 TRACE_STATE("receiving FCGI record header", FCGI_EV_RX_RECORD|FCGI_EV_RX_FHDR, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002578 ret = fcgi_decode_record_hdr(&fconn->dbuf, 0, &hdr);
Christopher Faulet73518be2021-01-27 12:06:54 +01002579 if (!ret) {
2580 TRACE_ERROR("header record decoding failure", FCGI_EV_RX_RECORD|FCGI_EV_RX_ENDREQ|FCGI_EV_FSTRM_ERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002581 goto fail;
Christopher Faulet73518be2021-01-27 12:06:54 +01002582 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002583 b_del(&fconn->dbuf, ret);
2584
2585 if (hdr.id || (hdr.type != FCGI_GET_VALUES_RESULT && hdr.type != FCGI_UNKNOWN_TYPE)) {
2586 fconn->state = FCGI_CS_CLOSED;
Christopher Faulet73518be2021-01-27 12:06:54 +01002587 TRACE_ERROR("unexpected record type or flags", FCGI_EV_RX_RECORD|FCGI_EV_RX_FHDR|FCGI_EV_RX_GETVAL|FCGI_EV_FCONN_ERR, fconn->conn);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002588 TRACE_STATE("switching to CLOSED", FCGI_EV_RX_RECORD|FCGI_EV_RX_FHDR|FCGI_EV_RX_GETVAL|FCGI_EV_FCONN_ERR, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002589 goto fail;
2590 }
2591 goto new_record;
2592 }
2593 }
2594
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002595 /* process as many incoming records as possible below */
2596 while (1) {
2597 if (!b_data(&fconn->dbuf)) {
2598 TRACE_DEVEL("no more Rx data", FCGI_EV_RX_RECORD, fconn->conn);
2599 break;
2600 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002601
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002602 if (fconn->state == FCGI_CS_CLOSED) {
2603 TRACE_STATE("end of connection reported", FCGI_EV_RX_RECORD|FCGI_EV_RX_EOI, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002604 break;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002605 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002606
2607 if (fconn->state == FCGI_CS_RECORD_H) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002608 TRACE_PROTO("receiving FCGI record header", FCGI_EV_RX_RECORD|FCGI_EV_RX_FHDR, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002609 ret = fcgi_decode_record_hdr(&fconn->dbuf, 0, &hdr);
2610 if (!ret)
2611 break;
2612 b_del(&fconn->dbuf, ret);
2613
2614 new_record:
2615 fconn->dsi = hdr.id;
2616 fconn->drt = hdr.type;
2617 fconn->drl = hdr.len;
2618 fconn->drp = hdr.padding;
2619 fconn->state = FCGI_CS_RECORD_D;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002620 TRACE_STATE("FCGI record header rcvd, switching to RECORD_D", FCGI_EV_RX_RECORD|FCGI_EV_RX_FHDR, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002621 }
2622
2623 /* Only FCGI_CS_RECORD_D or FCGI_CS_RECORD_P */
2624 tmp_fstrm = fcgi_conn_st_by_id(fconn, fconn->dsi);
2625
2626 if (tmp_fstrm != fstrm && fstrm && fstrm->cs &&
2627 (b_data(&fstrm->rxbuf) ||
Christopher Faulet6670e3e2020-10-08 15:26:33 +02002628 fcgi_conn_read0_pending(fconn) ||
Christopher Faulet99eff652019-08-11 23:11:30 +02002629 fstrm->state == FCGI_SS_CLOSED ||
2630 (fstrm->flags & FCGI_SF_ES_RCVD) ||
Christopher Fauletb041b232022-03-24 10:27:02 +01002631 (fstrm->endp->flags & (CS_EP_ERROR|CS_EP_ERR_PENDING|CS_EP_EOS)))) {
Christopher Faulet99eff652019-08-11 23:11:30 +02002632 /* we may have to signal the upper layers */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002633 TRACE_DEVEL("notifying stream before switching SID", FCGI_EV_RX_RECORD|FCGI_EV_STRM_WAKE, fconn->conn, fstrm);
Christopher Fauletb041b232022-03-24 10:27:02 +01002634 fstrm->endp->flags |= CS_EP_RCV_MORE;
Christopher Faulet99eff652019-08-11 23:11:30 +02002635 fcgi_strm_notify_recv(fstrm);
2636 }
2637 fstrm = tmp_fstrm;
2638
2639 if (fstrm->state == FCGI_SS_CLOSED && fconn->dsi != 0) {
2640 /* ignore all record for closed streams */
2641 goto ignore_record;
2642 }
2643 if (fstrm->state == FCGI_SS_IDLE) {
2644 /* ignore all record for unknown streams */
2645 goto ignore_record;
2646 }
2647
2648 switch (fconn->drt) {
2649 case FCGI_GET_VALUES_RESULT:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002650 TRACE_PROTO("receiving FCGI GET_VALUES_RESULT record", FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002651 ret = fcgi_conn_handle_values_result(fconn);
2652 break;
2653
2654 case FCGI_STDOUT:
2655 if (fstrm->flags & FCGI_SF_ES_RCVD)
2656 goto ignore_record;
2657
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002658 TRACE_PROTO("receiving FCGI STDOUT record", FCGI_EV_RX_RECORD|FCGI_EV_RX_STDOUT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002659 if (fconn->drl)
2660 ret = fcgi_strm_handle_stdout(fconn, fstrm);
2661 else
2662 ret = fcgi_strm_handle_empty_stdout(fconn, fstrm);
2663 break;
2664
2665 case FCGI_STDERR:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002666 TRACE_PROTO("receiving FCGI STDERR record", FCGI_EV_RX_RECORD|FCGI_EV_RX_STDERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002667 ret = fcgi_strm_handle_stderr(fconn, fstrm);
2668 break;
2669
2670 case FCGI_END_REQUEST:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002671 TRACE_PROTO("receiving FCGI END_REQUEST record", FCGI_EV_RX_RECORD|FCGI_EV_RX_ENDREQ, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002672 ret = fcgi_strm_handle_end_request(fconn, fstrm);
2673 break;
2674
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002675 /* implement all extra record types here */
Christopher Faulet99eff652019-08-11 23:11:30 +02002676 default:
2677 ignore_record:
2678 /* drop records that we ignore. They may be
2679 * larger than the buffer so we drain all of
2680 * their contents until we reach the end.
2681 */
2682 fconn->state = FCGI_CS_RECORD_P;
2683 fconn->drl += fconn->drp;
2684 fconn->drp = 0;
2685 ret = MIN(b_data(&fconn->dbuf), fconn->drl);
Willy Tarreau022e5e52020-09-10 09:33:15 +02002686 TRACE_PROTO("receiving FCGI ignored record", FCGI_EV_RX_RECORD, fconn->conn, fstrm, 0, (size_t[]){ret});
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002687 TRACE_STATE("switching to RECORD_P", FCGI_EV_RX_RECORD, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002688 b_del(&fconn->dbuf, ret);
2689 fconn->drl -= ret;
2690 ret = (fconn->drl == 0);
2691 }
2692
2693 /* error or missing data condition met above ? */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002694 if (ret <= 0) {
2695 TRACE_DEVEL("insufficient data to proceed", FCGI_EV_RX_RECORD, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02002696 break;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002697 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002698
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002699 if (fconn->state != FCGI_CS_RECORD_H && !(fconn->drl+fconn->drp)) {
Christopher Faulet99eff652019-08-11 23:11:30 +02002700 fconn->state = FCGI_CS_RECORD_H;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002701 TRACE_STATE("switching to RECORD_H", FCGI_EV_RX_RECORD|FCGI_EV_RX_FHDR, fconn->conn);
2702 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002703 }
2704
2705 fail:
2706 /* we can go here on missing data, blocked response or error */
2707 if (fstrm && fstrm->cs &&
2708 (b_data(&fstrm->rxbuf) ||
Christopher Faulet6670e3e2020-10-08 15:26:33 +02002709 fcgi_conn_read0_pending(fconn) ||
Christopher Faulet99eff652019-08-11 23:11:30 +02002710 fstrm->state == FCGI_SS_CLOSED ||
2711 (fstrm->flags & FCGI_SF_ES_RCVD) ||
Christopher Fauletb041b232022-03-24 10:27:02 +01002712 (fstrm->endp->flags & (CS_EP_ERROR|CS_EP_ERR_PENDING|CS_EP_EOS)))) {
Christopher Faulet99eff652019-08-11 23:11:30 +02002713 /* we may have to signal the upper layers */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002714 TRACE_DEVEL("notifying stream before switching SID", FCGI_EV_RX_RECORD|FCGI_EV_STRM_WAKE, fconn->conn, fstrm);
Christopher Fauletb041b232022-03-24 10:27:02 +01002715 fstrm->endp->flags |= CS_EP_RCV_MORE;
Christopher Faulet99eff652019-08-11 23:11:30 +02002716 fcgi_strm_notify_recv(fstrm);
2717 }
2718
2719 fcgi_conn_restart_reading(fconn, 0);
2720}
2721
2722/* process Tx records from streams to be multiplexed. Returns > 0 if it reached
2723 * the end.
2724 */
2725static int fcgi_process_mux(struct fcgi_conn *fconn)
2726{
2727 struct fcgi_strm *fstrm, *fstrm_back;
2728
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002729 TRACE_ENTER(FCGI_EV_FCONN_WAKE, fconn->conn);
2730
Christopher Faulet99eff652019-08-11 23:11:30 +02002731 if (unlikely(fconn->state < FCGI_CS_RECORD_H)) {
2732 if (unlikely(fconn->state == FCGI_CS_INIT)) {
2733 if (!(fconn->flags & FCGI_CF_GET_VALUES)) {
2734 fconn->state = FCGI_CS_RECORD_H;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002735 TRACE_STATE("switching to RECORD_H", FCGI_EV_TX_RECORD|FCGI_EV_RX_RECORD|FCGI_EV_RX_FHDR, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002736 fcgi_wake_unassigned_streams(fconn);
2737 goto mux;
2738 }
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002739 TRACE_PROTO("sending FCGI GET_VALUES record", FCGI_EV_TX_RECORD|FCGI_EV_TX_GETVAL, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002740 if (unlikely(!fcgi_conn_send_get_values(fconn)))
2741 goto fail;
2742 fconn->state = FCGI_CS_SETTINGS;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002743 TRACE_STATE("switching to SETTINGS", FCGI_EV_TX_RECORD|FCGI_EV_RX_RECORD|FCGI_EV_RX_GETVAL, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002744 }
2745 /* need to wait for the other side */
2746 if (fconn->state < FCGI_CS_RECORD_H)
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002747 goto done;
Christopher Faulet99eff652019-08-11 23:11:30 +02002748 }
2749
2750 mux:
2751 list_for_each_entry_safe(fstrm, fstrm_back, &fconn->send_list, send_list) {
2752 if (fconn->state == FCGI_CS_CLOSED || fconn->flags & FCGI_CF_MUX_BLOCK_ANY)
2753 break;
2754
Willy Tarreauf11be0e2020-01-16 16:59:45 +01002755 if (fstrm->flags & FCGI_SF_NOTIFIED)
Christopher Faulet99eff652019-08-11 23:11:30 +02002756 continue;
2757
Willy Tarreau7aad7032020-01-16 17:20:57 +01002758 /* If the sender changed his mind and unsubscribed, let's just
2759 * remove the stream from the send_list.
Christopher Faulet99eff652019-08-11 23:11:30 +02002760 */
Willy Tarreau8907e4d2020-01-16 17:55:37 +01002761 if (!(fstrm->flags & (FCGI_SF_WANT_SHUTR|FCGI_SF_WANT_SHUTW)) &&
2762 (!fstrm->subs || !(fstrm->subs->events & SUB_RETRY_SEND))) {
Christopher Faulet99eff652019-08-11 23:11:30 +02002763 LIST_DEL_INIT(&fstrm->send_list);
2764 continue;
2765 }
Willy Tarreau8907e4d2020-01-16 17:55:37 +01002766
2767 if (fstrm->subs && fstrm->subs->events & SUB_RETRY_SEND) {
Willy Tarreau7aad7032020-01-16 17:20:57 +01002768 TRACE_POINT(FCGI_EV_STRM_WAKE, fconn->conn, fstrm);
2769 fstrm->flags &= ~FCGI_SF_BLK_ANY;
Willy Tarreau7aad7032020-01-16 17:20:57 +01002770 fstrm->flags |= FCGI_SF_NOTIFIED;
Willy Tarreau8907e4d2020-01-16 17:55:37 +01002771 tasklet_wakeup(fstrm->subs->tasklet);
2772 fstrm->subs->events &= ~SUB_RETRY_SEND;
2773 if (!fstrm->subs->events)
2774 fstrm->subs = NULL;
Willy Tarreau7aad7032020-01-16 17:20:57 +01002775 } else {
2776 /* it's the shut request that was queued */
2777 TRACE_POINT(FCGI_EV_STRM_WAKE, fconn->conn, fstrm);
2778 tasklet_wakeup(fstrm->shut_tl);
2779 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002780 }
2781
2782 fail:
2783 if (fconn->state == FCGI_CS_CLOSED) {
2784 if (fconn->stream_cnt - fconn->nb_reserved > 0) {
2785 fcgi_conn_send_aborts(fconn);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002786 if (fconn->flags & FCGI_CF_MUX_BLOCK_ANY) {
2787 TRACE_DEVEL("leaving in blocked situation", FCGI_EV_FCONN_WAKE|FCGI_EV_FCONN_BLK, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002788 return 0;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002789 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002790 }
2791 }
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002792
2793 done:
2794 TRACE_LEAVE(FCGI_EV_FCONN_WAKE, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002795 return 1;
2796}
2797
2798
2799/* Attempt to read data, and subscribe if none available.
2800 * The function returns 1 if data has been received, otherwise zero.
2801 */
2802static int fcgi_recv(struct fcgi_conn *fconn)
2803{
2804 struct connection *conn = fconn->conn;
2805 struct buffer *buf;
2806 int max;
2807 size_t ret;
2808
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002809 TRACE_ENTER(FCGI_EV_FCONN_RECV, conn);
2810
2811 if (fconn->wait_event.events & SUB_RETRY_RECV) {
2812 TRACE_DEVEL("leaving on sub_recv", FCGI_EV_FCONN_RECV, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002813 return (b_data(&fconn->dbuf));
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002814 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002815
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002816 if (!fcgi_recv_allowed(fconn)) {
2817 TRACE_DEVEL("leaving on !recv_allowed", FCGI_EV_FCONN_RECV, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002818 return 1;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002819 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002820
2821 buf = fcgi_get_buf(fconn, &fconn->dbuf);
2822 if (!buf) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002823 TRACE_DEVEL("waiting for fconn dbuf allocation", FCGI_EV_FCONN_RECV|FCGI_EV_FCONN_BLK, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002824 fconn->flags |= FCGI_CF_DEM_DALLOC;
2825 return 0;
2826 }
2827
Christopher Faulet99eff652019-08-11 23:11:30 +02002828 if (!b_data(buf)) {
2829 /* try to pre-align the buffer like the
2830 * rxbufs will be to optimize memory copies. We'll make
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002831 * sure that the record header lands at the end of the
Christopher Faulet99eff652019-08-11 23:11:30 +02002832 * HTX block to alias it upon recv. We cannot use the
2833 * head because rcv_buf() will realign the buffer if
2834 * it's empty. Thus we cheat and pretend we already
2835 * have a few bytes there.
2836 */
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01002837 max = buf_room_for_htx_data(buf) + (fconn->state == FCGI_CS_RECORD_H ? FCGI_RECORD_HEADER_SZ : 0);
2838 buf->head = sizeof(struct htx) - (fconn->state == FCGI_CS_RECORD_H ? FCGI_RECORD_HEADER_SZ : 0);
Christopher Faulet99eff652019-08-11 23:11:30 +02002839 }
2840 else
2841 max = buf_room_for_htx_data(buf);
2842
2843 ret = max ? conn->xprt->rcv_buf(conn, conn->xprt_ctx, buf, max, 0) : 0;
2844
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002845 if (max && !ret && fcgi_recv_allowed(fconn)) {
2846 TRACE_DATA("failed to receive data, subscribing", FCGI_EV_FCONN_RECV, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002847 conn->xprt->subscribe(conn, conn->xprt_ctx, SUB_RETRY_RECV, &fconn->wait_event);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002848 }
2849 else
Willy Tarreau022e5e52020-09-10 09:33:15 +02002850 TRACE_DATA("recv data", FCGI_EV_FCONN_RECV, conn, 0, 0, (size_t[]){ret});
Christopher Faulet99eff652019-08-11 23:11:30 +02002851
2852 if (!b_data(buf)) {
2853 fcgi_release_buf(fconn, &fconn->dbuf);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002854 TRACE_LEAVE(FCGI_EV_FCONN_RECV, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002855 return (conn->flags & CO_FL_ERROR || conn_xprt_read0_pending(conn));
2856 }
2857
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002858 if (ret == max) {
2859 TRACE_DEVEL("fconn dbuf full", FCGI_EV_FCONN_RECV|FCGI_EV_FCONN_BLK, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002860 fconn->flags |= FCGI_CF_DEM_DFULL;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002861 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002862
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002863 TRACE_LEAVE(FCGI_EV_FCONN_RECV, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002864 return !!ret || (conn->flags & CO_FL_ERROR) || conn_xprt_read0_pending(conn);
2865}
2866
2867
2868/* Try to send data if possible.
2869 * The function returns 1 if data have been sent, otherwise zero.
2870 */
2871static int fcgi_send(struct fcgi_conn *fconn)
2872{
2873 struct connection *conn = fconn->conn;
2874 int done;
2875 int sent = 0;
2876
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002877 TRACE_ENTER(FCGI_EV_FCONN_SEND, conn);
2878
2879 if (conn->flags & CO_FL_ERROR) {
2880 TRACE_DEVEL("leaving on connection error", FCGI_EV_FCONN_SEND, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002881 return 1;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002882 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002883
2884
Willy Tarreau911db9b2020-01-23 16:27:54 +01002885 if (conn->flags & CO_FL_WAIT_XPRT) {
Christopher Faulet99eff652019-08-11 23:11:30 +02002886 /* a handshake was requested */
2887 goto schedule;
2888 }
2889
2890 /* This loop is quite simple : it tries to fill as much as it can from
2891 * pending streams into the existing buffer until it's reportedly full
2892 * or the end of send requests is reached. Then it tries to send this
2893 * buffer's contents out, marks it not full if at least one byte could
2894 * be sent, and tries again.
2895 *
2896 * The snd_buf() function normally takes a "flags" argument which may
2897 * be made of a combination of CO_SFL_MSG_MORE to indicate that more
2898 * data immediately comes and CO_SFL_STREAMER to indicate that the
2899 * connection is streaming lots of data (used to increase TLS record
2900 * size at the expense of latency). The former can be sent any time
2901 * there's a buffer full flag, as it indicates at least one stream
2902 * attempted to send and failed so there are pending data. An
2903 * alternative would be to set it as long as there's an active stream
2904 * but that would be problematic for ACKs until we have an absolute
2905 * guarantee that all waiters have at least one byte to send. The
2906 * latter should possibly not be set for now.
2907 */
2908
2909 done = 0;
2910 while (!done) {
2911 unsigned int flags = 0;
2912 unsigned int released = 0;
2913 struct buffer *buf;
2914
2915 /* fill as much as we can into the current buffer */
2916 while (((fconn->flags & (FCGI_CF_MUX_MFULL|FCGI_CF_MUX_MALLOC)) == 0) && !done)
2917 done = fcgi_process_mux(fconn);
2918
2919 if (fconn->flags & FCGI_CF_MUX_MALLOC)
2920 done = 1; // we won't go further without extra buffers
2921
2922 if (conn->flags & CO_FL_ERROR)
2923 break;
2924
2925 if (fconn->flags & (FCGI_CF_MUX_MFULL | FCGI_CF_DEM_MROOM))
2926 flags |= CO_SFL_MSG_MORE;
2927
2928 for (buf = br_head(fconn->mbuf); b_size(buf); buf = br_del_head(fconn->mbuf)) {
2929 if (b_data(buf)) {
2930 int ret;
2931
2932 ret = conn->xprt->snd_buf(conn, conn->xprt_ctx, buf, b_data(buf), flags);
2933 if (!ret) {
2934 done = 1;
2935 break;
2936 }
2937 sent = 1;
Willy Tarreau022e5e52020-09-10 09:33:15 +02002938 TRACE_DATA("send data", FCGI_EV_FCONN_SEND, conn, 0, 0, (size_t[]){ret});
Christopher Faulet99eff652019-08-11 23:11:30 +02002939 b_del(buf, ret);
2940 if (b_data(buf)) {
2941 done = 1;
2942 break;
2943 }
2944 }
2945 b_free(buf);
2946 released++;
2947 }
2948
2949 if (released)
Willy Tarreau4d77bbf2021-02-20 12:02:46 +01002950 offer_buffers(NULL, released);
Christopher Faulet99eff652019-08-11 23:11:30 +02002951
2952 /* wrote at least one byte, the buffer is not full anymore */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002953 if (fconn->flags & (FCGI_CF_MUX_MFULL | FCGI_CF_DEM_MROOM))
2954 TRACE_STATE("fconn mbuf ring not fill anymore", FCGI_EV_FCONN_SEND|FCGI_EV_FCONN_BLK, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02002955 fconn->flags &= ~(FCGI_CF_MUX_MFULL | FCGI_CF_DEM_MROOM);
2956 }
2957
2958 if (conn->flags & CO_FL_SOCK_WR_SH) {
2959 /* output closed, nothing to send, clear the buffer to release it */
2960 b_reset(br_tail(fconn->mbuf));
2961 }
2962 /* We're not full anymore, so we can wake any task that are waiting
2963 * for us.
2964 */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02002965 if (!(fconn->flags & (FCGI_CF_MUX_MFULL | FCGI_CF_DEM_MROOM)) && fconn->state >= FCGI_CS_RECORD_H) {
Christopher Faulet99eff652019-08-11 23:11:30 +02002966 struct fcgi_strm *fstrm;
2967
2968 list_for_each_entry(fstrm, &fconn->send_list, send_list) {
2969 if (fconn->state == FCGI_CS_CLOSED || fconn->flags & FCGI_CF_MUX_BLOCK_ANY)
2970 break;
2971
Willy Tarreauf11be0e2020-01-16 16:59:45 +01002972 if (fstrm->flags & FCGI_SF_NOTIFIED)
Christopher Faulet99eff652019-08-11 23:11:30 +02002973 continue;
2974
Willy Tarreau7aad7032020-01-16 17:20:57 +01002975 /* If the sender changed his mind and unsubscribed, let's just
2976 * remove the stream from the send_list.
Christopher Faulet99eff652019-08-11 23:11:30 +02002977 */
Willy Tarreau8907e4d2020-01-16 17:55:37 +01002978 if (!(fstrm->flags & (FCGI_SF_WANT_SHUTR|FCGI_SF_WANT_SHUTW)) &&
2979 (!fstrm->subs || !(fstrm->subs->events & SUB_RETRY_SEND))) {
Christopher Faulet99eff652019-08-11 23:11:30 +02002980 LIST_DEL_INIT(&fstrm->send_list);
2981 continue;
2982 }
Willy Tarreau8907e4d2020-01-16 17:55:37 +01002983
2984 if (fstrm->subs && fstrm->subs->events & SUB_RETRY_SEND) {
Willy Tarreau7aad7032020-01-16 17:20:57 +01002985 TRACE_DEVEL("waking up pending stream", FCGI_EV_FCONN_SEND|FCGI_EV_STRM_WAKE, conn, fstrm);
Willy Tarreau8907e4d2020-01-16 17:55:37 +01002986 fstrm->flags &= ~FCGI_SF_BLK_ANY;
Willy Tarreau7aad7032020-01-16 17:20:57 +01002987 fstrm->flags |= FCGI_SF_NOTIFIED;
Willy Tarreau8907e4d2020-01-16 17:55:37 +01002988 tasklet_wakeup(fstrm->subs->tasklet);
2989 fstrm->subs->events &= ~SUB_RETRY_SEND;
2990 if (!fstrm->subs->events)
2991 fstrm->subs = NULL;
Willy Tarreau7aad7032020-01-16 17:20:57 +01002992 } else {
2993 /* it's the shut request that was queued */
2994 TRACE_POINT(FCGI_EV_STRM_WAKE, fconn->conn, fstrm);
2995 tasklet_wakeup(fstrm->shut_tl);
2996 }
Christopher Faulet99eff652019-08-11 23:11:30 +02002997 }
2998 }
2999 /* We're done, no more to send */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003000 if (!br_data(fconn->mbuf)) {
3001 TRACE_DEVEL("leaving with everything sent", FCGI_EV_FCONN_SEND, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02003002 return sent;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003003 }
Christopher Faulet99eff652019-08-11 23:11:30 +02003004schedule:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003005 if (!(conn->flags & CO_FL_ERROR) && !(fconn->wait_event.events & SUB_RETRY_SEND)) {
3006 TRACE_STATE("more data to send, subscribing", FCGI_EV_FCONN_SEND, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02003007 conn->xprt->subscribe(conn, conn->xprt_ctx, SUB_RETRY_SEND, &fconn->wait_event);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003008 }
Christopher Faulet99eff652019-08-11 23:11:30 +02003009
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003010 TRACE_DEVEL("leaving with some data left to send", FCGI_EV_FCONN_SEND, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02003011 return sent;
3012}
3013
3014/* this is the tasklet referenced in fconn->wait_event.tasklet */
Willy Tarreaue388f2f2021-03-02 16:51:09 +01003015struct task *fcgi_io_cb(struct task *t, void *ctx, unsigned int state)
Christopher Faulet99eff652019-08-11 23:11:30 +02003016{
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01003017 struct connection *conn;
Willy Tarreaue388f2f2021-03-02 16:51:09 +01003018 struct fcgi_conn *fconn = ctx;
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01003019 struct tasklet *tl = (struct tasklet *)t;
3020 int conn_in_list;
Christopher Faulet99eff652019-08-11 23:11:30 +02003021 int ret = 0;
3022
Willy Tarreaue388f2f2021-03-02 16:51:09 +01003023 if (state & TASK_F_USR1) {
3024 /* the tasklet was idling on an idle connection, it might have
3025 * been stolen, let's be careful!
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01003026 */
Willy Tarreaue388f2f2021-03-02 16:51:09 +01003027 HA_SPIN_LOCK(IDLE_CONNS_LOCK, &idle_conns[tid].idle_conns_lock);
3028 if (tl->context == NULL) {
3029 /* The connection has been taken over by another thread,
3030 * we're no longer responsible for it, so just free the
3031 * tasklet, and do nothing.
3032 */
3033 HA_SPIN_UNLOCK(IDLE_CONNS_LOCK, &idle_conns[tid].idle_conns_lock);
3034 tasklet_free(tl);
3035 return NULL;
3036 }
3037 conn = fconn->conn;
3038 TRACE_POINT(FCGI_EV_FCONN_WAKE, conn);
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01003039
Willy Tarreaue388f2f2021-03-02 16:51:09 +01003040 conn_in_list = conn->flags & CO_FL_LIST_MASK;
3041 if (conn_in_list)
3042 conn_delete_from_tree(&conn->hash_node->node);
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01003043
Willy Tarreaue388f2f2021-03-02 16:51:09 +01003044 HA_SPIN_UNLOCK(IDLE_CONNS_LOCK, &idle_conns[tid].idle_conns_lock);
3045 } else {
3046 /* we're certain the connection was not in an idle list */
3047 conn = fconn->conn;
3048 TRACE_ENTER(FCGI_EV_FCONN_WAKE, conn);
3049 conn_in_list = 0;
3050 }
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003051
Christopher Faulet99eff652019-08-11 23:11:30 +02003052 if (!(fconn->wait_event.events & SUB_RETRY_SEND))
3053 ret = fcgi_send(fconn);
3054 if (!(fconn->wait_event.events & SUB_RETRY_RECV))
3055 ret |= fcgi_recv(fconn);
3056 if (ret || b_data(&fconn->dbuf))
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01003057 ret = fcgi_process(fconn);
3058
3059 /* If we were in an idle list, we want to add it back into it,
3060 * unless fcgi_process() returned -1, which mean it has destroyed
3061 * the connection (testing !ret is enough, if fcgi_process() wasn't
3062 * called then ret will be 0 anyway.
3063 */
Willy Tarreau74163142021-03-13 11:30:19 +01003064 if (ret < 0)
3065 t = NULL;
3066
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01003067 if (!ret && conn_in_list) {
3068 struct server *srv = objt_server(conn->target);
3069
Amaury Denoyelle5c7086f2021-01-11 09:21:52 +01003070 HA_SPIN_LOCK(IDLE_CONNS_LOCK, &idle_conns[tid].idle_conns_lock);
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01003071 if (conn_in_list == CO_FL_SAFE_LIST)
Willy Tarreau430bf4a2021-03-04 09:45:32 +01003072 ebmb_insert(&srv->per_thr[tid].safe_conns, &conn->hash_node->node, sizeof(conn->hash_node->hash));
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01003073 else
Willy Tarreau430bf4a2021-03-04 09:45:32 +01003074 ebmb_insert(&srv->per_thr[tid].idle_conns, &conn->hash_node->node, sizeof(conn->hash_node->hash));
Amaury Denoyelle5c7086f2021-01-11 09:21:52 +01003075 HA_SPIN_UNLOCK(IDLE_CONNS_LOCK, &idle_conns[tid].idle_conns_lock);
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01003076 }
Willy Tarreau74163142021-03-13 11:30:19 +01003077 return t;
Christopher Faulet99eff652019-08-11 23:11:30 +02003078}
3079
3080/* callback called on any event by the connection handler.
3081 * It applies changes and returns zero, or < 0 if it wants immediate
3082 * destruction of the connection (which normally doesn not happen in FCGI).
3083 */
3084static int fcgi_process(struct fcgi_conn *fconn)
3085{
3086 struct connection *conn = fconn->conn;
3087
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003088 TRACE_POINT(FCGI_EV_FCONN_WAKE, conn);
3089
Christopher Faulet99eff652019-08-11 23:11:30 +02003090 if (b_data(&fconn->dbuf) && !(fconn->flags & FCGI_CF_DEM_BLOCK_ANY)) {
3091 fcgi_process_demux(fconn);
3092
3093 if (fconn->state == FCGI_CS_CLOSED || conn->flags & CO_FL_ERROR)
3094 b_reset(&fconn->dbuf);
3095
3096 if (buf_room_for_htx_data(&fconn->dbuf))
3097 fconn->flags &= ~FCGI_CF_DEM_DFULL;
3098 }
3099 fcgi_send(fconn);
3100
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02003101 if (unlikely(fconn->proxy->flags & (PR_FL_DISABLED|PR_FL_STOPPED))) {
Christopher Faulet99eff652019-08-11 23:11:30 +02003102 /* frontend is stopping, reload likely in progress, let's try
3103 * to announce a graceful shutdown if not yet done. We don't
3104 * care if it fails, it will be tried again later.
3105 */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003106 TRACE_STATE("proxy stopped, sending ABORT to all streams", FCGI_EV_FCONN_WAKE|FCGI_EV_TX_RECORD, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02003107 if (!(fconn->flags & (FCGI_CF_ABRTS_SENT|FCGI_CF_ABRTS_FAILED))) {
3108 if (fconn->stream_cnt - fconn->nb_reserved > 0)
3109 fcgi_conn_send_aborts(fconn);
3110 }
3111 }
3112
3113 /*
3114 * If we received early data, and the handshake is done, wake
3115 * any stream that was waiting for it.
3116 */
3117 if (!(fconn->flags & FCGI_CF_WAIT_FOR_HS) &&
Willy Tarreau911db9b2020-01-23 16:27:54 +01003118 (conn->flags & (CO_FL_EARLY_SSL_HS | CO_FL_WAIT_XPRT | CO_FL_EARLY_DATA)) == CO_FL_EARLY_DATA) {
Christopher Faulet99eff652019-08-11 23:11:30 +02003119 struct eb32_node *node;
3120 struct fcgi_strm *fstrm;
3121
3122 fconn->flags |= FCGI_CF_WAIT_FOR_HS;
3123 node = eb32_lookup_ge(&fconn->streams_by_id, 1);
3124
3125 while (node) {
3126 fstrm = container_of(node, struct fcgi_strm, by_id);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01003127 if (fstrm->cs && fstrm->endp->flags & CS_EP_WAIT_FOR_HS)
Christopher Faulet99eff652019-08-11 23:11:30 +02003128 fcgi_strm_notify_recv(fstrm);
3129 node = eb32_next(node);
3130 }
3131 }
3132
Christopher Faulet6670e3e2020-10-08 15:26:33 +02003133 if ((conn->flags & CO_FL_ERROR) || fcgi_conn_read0_pending(fconn) ||
Christopher Faulet99eff652019-08-11 23:11:30 +02003134 fconn->state == FCGI_CS_CLOSED || (fconn->flags & FCGI_CF_ABRTS_FAILED) ||
3135 eb_is_empty(&fconn->streams_by_id)) {
3136 fcgi_wake_some_streams(fconn, 0);
3137
3138 if (eb_is_empty(&fconn->streams_by_id)) {
3139 /* no more stream, kill the connection now */
3140 fcgi_release(fconn);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003141 TRACE_DEVEL("leaving after releasing the connection", FCGI_EV_FCONN_WAKE);
Christopher Faulet99eff652019-08-11 23:11:30 +02003142 return -1;
3143 }
3144 }
3145
3146 if (!b_data(&fconn->dbuf))
3147 fcgi_release_buf(fconn, &fconn->dbuf);
3148
3149 if ((conn->flags & CO_FL_SOCK_WR_SH) ||
3150 fconn->state == FCGI_CS_CLOSED || (fconn->flags & FCGI_CF_ABRTS_FAILED) ||
3151 (!br_data(fconn->mbuf) && ((fconn->flags & FCGI_CF_MUX_BLOCK_ANY) || LIST_ISEMPTY(&fconn->send_list))))
3152 fcgi_release_mbuf(fconn);
3153
3154 if (fconn->task) {
3155 fconn->task->expire = tick_add(now_ms, (fconn->state == FCGI_CS_CLOSED ? fconn->shut_timeout : fconn->timeout));
3156 task_queue(fconn->task);
3157 }
3158
3159 fcgi_send(fconn);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003160 TRACE_LEAVE(FCGI_EV_FCONN_WAKE, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02003161 return 0;
3162}
3163
3164
3165/* wake-up function called by the connection layer (mux_ops.wake) */
3166static int fcgi_wake(struct connection *conn)
3167{
3168 struct fcgi_conn *fconn = conn->ctx;
3169
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003170 TRACE_POINT(FCGI_EV_FCONN_WAKE, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02003171 return (fcgi_process(fconn));
3172}
3173
Olivier Houchard9b8e11e2019-10-25 16:19:26 +02003174
3175static int fcgi_ctl(struct connection *conn, enum mux_ctl_type mux_ctl, void *output)
3176{
3177 int ret = 0;
3178 switch (mux_ctl) {
3179 case MUX_STATUS:
Willy Tarreau911db9b2020-01-23 16:27:54 +01003180 if (!(conn->flags & CO_FL_WAIT_XPRT))
Olivier Houchard9b8e11e2019-10-25 16:19:26 +02003181 ret |= MUX_STATUS_READY;
3182 return ret;
Christopher Faulet4c8ad842020-10-06 14:59:17 +02003183 case MUX_EXIT_STATUS:
3184 return MUX_ES_UNKNOWN;
Olivier Houchard9b8e11e2019-10-25 16:19:26 +02003185 default:
3186 return -1;
3187 }
3188}
3189
Christopher Faulet99eff652019-08-11 23:11:30 +02003190/* Connection timeout management. The principle is that if there's no receipt
3191 * nor sending for a certain amount of time, the connection is closed. If the
3192 * MUX buffer still has lying data or is not allocatable, the connection is
3193 * immediately killed. If it's allocatable and empty, we attempt to send a
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003194 * ABORT records.
Christopher Faulet99eff652019-08-11 23:11:30 +02003195 */
Willy Tarreau144f84a2021-03-02 16:09:26 +01003196struct task *fcgi_timeout_task(struct task *t, void *context, unsigned int state)
Christopher Faulet99eff652019-08-11 23:11:30 +02003197{
3198 struct fcgi_conn *fconn = context;
3199 int expired = tick_is_expired(t->expire, now_ms);
3200
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003201 TRACE_ENTER(FCGI_EV_FCONN_WAKE, (fconn ? fconn->conn : NULL));
3202
Willy Tarreau60814ff2020-06-30 11:19:23 +02003203 if (fconn) {
Amaury Denoyelle5c7086f2021-01-11 09:21:52 +01003204 HA_SPIN_LOCK(IDLE_CONNS_LOCK, &idle_conns[tid].idle_conns_lock);
Olivier Houchard48ce6a32020-07-02 11:58:05 +02003205
3206 /* Somebody already stole the connection from us, so we should not
3207 * free it, we just have to free the task.
3208 */
3209 if (!t->context) {
Amaury Denoyelle5c7086f2021-01-11 09:21:52 +01003210 HA_SPIN_UNLOCK(IDLE_CONNS_LOCK, &idle_conns[tid].idle_conns_lock);
Olivier Houchard48ce6a32020-07-02 11:58:05 +02003211 fconn = NULL;
3212 goto do_leave;
3213 }
3214
Willy Tarreau60814ff2020-06-30 11:19:23 +02003215 if (!expired) {
Amaury Denoyelle5c7086f2021-01-11 09:21:52 +01003216 HA_SPIN_UNLOCK(IDLE_CONNS_LOCK, &idle_conns[tid].idle_conns_lock);
Willy Tarreau60814ff2020-06-30 11:19:23 +02003217 TRACE_DEVEL("leaving (not expired)", FCGI_EV_FCONN_WAKE, fconn->conn);
3218 return t;
3219 }
Christopher Faulet99eff652019-08-11 23:11:30 +02003220
Willy Tarreau60814ff2020-06-30 11:19:23 +02003221 /* We're about to destroy the connection, so make sure nobody attempts
3222 * to steal it from us.
3223 */
Willy Tarreau60814ff2020-06-30 11:19:23 +02003224 if (fconn->conn->flags & CO_FL_LIST_MASK)
Amaury Denoyelle8990b012021-02-19 15:29:16 +01003225 conn_delete_from_tree(&fconn->conn->hash_node->node);
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01003226
Amaury Denoyelle5c7086f2021-01-11 09:21:52 +01003227 HA_SPIN_UNLOCK(IDLE_CONNS_LOCK, &idle_conns[tid].idle_conns_lock);
Willy Tarreau60814ff2020-06-30 11:19:23 +02003228 }
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01003229
Olivier Houchard48ce6a32020-07-02 11:58:05 +02003230do_leave:
Christopher Faulet99eff652019-08-11 23:11:30 +02003231 task_destroy(t);
3232
3233 if (!fconn) {
3234 /* resources were already deleted */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003235 TRACE_DEVEL("leaving (not more fconn)", FCGI_EV_FCONN_WAKE);
Christopher Faulet99eff652019-08-11 23:11:30 +02003236 return NULL;
3237 }
3238
3239 fconn->task = NULL;
3240 fconn->state = FCGI_CS_CLOSED;
3241 fcgi_wake_some_streams(fconn, 0);
3242
3243 if (br_data(fconn->mbuf)) {
3244 /* don't even try to send aborts, the buffer is stuck */
3245 fconn->flags |= FCGI_CF_ABRTS_FAILED;
3246 goto end;
3247 }
3248
3249 /* try to send but no need to insist */
3250 if (!fcgi_conn_send_aborts(fconn))
3251 fconn->flags |= FCGI_CF_ABRTS_FAILED;
3252
3253 if (br_data(fconn->mbuf) && !(fconn->flags & FCGI_CF_ABRTS_FAILED) &&
3254 conn_xprt_ready(fconn->conn)) {
3255 unsigned int released = 0;
3256 struct buffer *buf;
3257
3258 for (buf = br_head(fconn->mbuf); b_size(buf); buf = br_del_head(fconn->mbuf)) {
3259 if (b_data(buf)) {
3260 int ret = fconn->conn->xprt->snd_buf(fconn->conn, fconn->conn->xprt_ctx,
3261 buf, b_data(buf), 0);
3262 if (!ret)
3263 break;
3264 b_del(buf, ret);
3265 if (b_data(buf))
3266 break;
3267 b_free(buf);
3268 released++;
3269 }
3270 }
3271
3272 if (released)
Willy Tarreau4d77bbf2021-02-20 12:02:46 +01003273 offer_buffers(NULL, released);
Christopher Faulet99eff652019-08-11 23:11:30 +02003274 }
3275
3276 end:
3277 /* either we can release everything now or it will be done later once
3278 * the last stream closes.
3279 */
3280 if (eb_is_empty(&fconn->streams_by_id))
3281 fcgi_release(fconn);
3282
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003283 TRACE_LEAVE(FCGI_EV_FCONN_WAKE);
Christopher Faulet99eff652019-08-11 23:11:30 +02003284 return NULL;
3285}
3286
3287
3288/*******************************************/
3289/* functions below are used by the streams */
3290/*******************************************/
3291
3292/* Append the description of what is present in error snapshot <es> into <out>.
3293 * The description must be small enough to always fit in a buffer. The output
3294 * buffer may be the trash so the trash must not be used inside this function.
3295 */
3296static void fcgi_show_error_snapshot(struct buffer *out, const struct error_snapshot *es)
3297{
3298 chunk_appendf(out,
3299 " FCGI connection flags 0x%08x, FCGI stream flags 0x%08x\n"
3300 " H1 msg state %s(%d), H1 msg flags 0x%08x\n"
3301 " H1 chunk len %lld bytes, H1 body len %lld bytes :\n",
3302 es->ctx.h1.c_flags, es->ctx.h1.s_flags,
3303 h1m_state_str(es->ctx.h1.state), es->ctx.h1.state,
3304 es->ctx.h1.m_flags, es->ctx.h1.m_clen, es->ctx.h1.m_blen);
3305}
3306/*
3307 * Capture a bad response and archive it in the proxy's structure. By default
3308 * it tries to report the error position as h1m->err_pos. However if this one is
3309 * not set, it will then report h1m->next, which is the last known parsing
3310 * point. The function is able to deal with wrapping buffers. It always displays
3311 * buffers as a contiguous area starting at buf->p. The direction is determined
3312 * thanks to the h1m's flags.
3313 */
3314static void fcgi_strm_capture_bad_message(struct fcgi_conn *fconn, struct fcgi_strm *fstrm,
3315 struct h1m *h1m, struct buffer *buf)
3316{
3317 struct session *sess = fstrm->sess;
3318 struct proxy *proxy = fconn->proxy;
Olivier Houchardbdb00c52020-03-12 15:30:17 +01003319 struct proxy *other_end;
Christopher Faulet99eff652019-08-11 23:11:30 +02003320 union error_snapshot_ctx ctx;
3321
Christopher Fauletf835dea2021-12-21 14:35:17 +01003322 if (fstrm->cs && cs_strm(fstrm->cs)) {
Olivier Houchardbdb00c52020-03-12 15:30:17 +01003323 if (sess == NULL)
Christopher Faulet693b23b2022-02-28 09:09:05 +01003324 sess = __cs_strm(fstrm->cs)->sess;
Olivier Houchardbdb00c52020-03-12 15:30:17 +01003325 if (!(h1m->flags & H1_MF_RESP))
Christopher Faulet693b23b2022-02-28 09:09:05 +01003326 other_end = __cs_strm(fstrm->cs)->be;
Olivier Houchardbdb00c52020-03-12 15:30:17 +01003327 else
3328 other_end = sess->fe;
3329 } else
3330 other_end = NULL;
Christopher Faulet99eff652019-08-11 23:11:30 +02003331 /* http-specific part now */
3332 ctx.h1.state = h1m->state;
3333 ctx.h1.c_flags = fconn->flags;
3334 ctx.h1.s_flags = fstrm->flags;
3335 ctx.h1.m_flags = h1m->flags;
3336 ctx.h1.m_clen = h1m->curr_len;
3337 ctx.h1.m_blen = h1m->body_len;
3338
3339 proxy_capture_error(proxy, 1, other_end, fconn->conn->target, sess, buf, 0, 0,
3340 (h1m->err_pos >= 0) ? h1m->err_pos : h1m->next,
3341 &ctx, fcgi_show_error_snapshot);
3342}
3343
3344static size_t fcgi_strm_parse_headers(struct fcgi_strm *fstrm, struct h1m *h1m, struct htx *htx,
3345 struct buffer *buf, size_t *ofs, size_t max)
3346{
Christopher Fauletd9fc1282022-03-28 15:37:01 +02003347 int ret;
Christopher Faulet99eff652019-08-11 23:11:30 +02003348
Willy Tarreau022e5e52020-09-10 09:33:15 +02003349 TRACE_ENTER(FCGI_EV_RSP_DATA|FCGI_EV_RSP_HDRS, fstrm->fconn->conn, fstrm, 0, (size_t[]){max});
Christopher Faulet99eff652019-08-11 23:11:30 +02003350 ret = h1_parse_msg_hdrs(h1m, NULL, htx, buf, *ofs, max);
Christopher Fauletd9fc1282022-03-28 15:37:01 +02003351 if (ret <= 0) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003352 TRACE_DEVEL("leaving on missing data or error", FCGI_EV_RSP_DATA|FCGI_EV_RSP_HDRS, fstrm->fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003353 if (htx->flags & HTX_FL_PARSING_ERROR) {
Christopher Faulet73518be2021-01-27 12:06:54 +01003354 TRACE_ERROR("parsing error, reject H1 response", FCGI_EV_RSP_DATA|FCGI_EV_RSP_HDRS|FCGI_EV_FSTRM_ERR, fstrm->fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003355 fcgi_strm_error(fstrm);
3356 fcgi_strm_capture_bad_message(fstrm->fconn, fstrm, h1m, buf);
3357 }
Christopher Fauletd9fc1282022-03-28 15:37:01 +02003358 ret = 0;
Christopher Faulet99eff652019-08-11 23:11:30 +02003359 goto end;
3360 }
3361
Christopher Fauletda3adeb2021-09-28 09:50:07 +02003362 /* Reject any message with an unknown transfer-encoding. In fact if any
3363 * encoding other than "chunked". A 422-Unprocessable-Content is
3364 * returned for an invalid request, a 502-Bad-Gateway for an invalid
3365 * response.
3366 */
3367 if (h1m->flags & H1_MF_TE_OTHER) {
3368 htx->flags |= HTX_FL_PARSING_ERROR;
3369 TRACE_ERROR("Unknown transfer-encoding", FCGI_EV_RSP_DATA|FCGI_EV_RSP_HDRS|FCGI_EV_FSTRM_ERR, fstrm->fconn->conn, fstrm);
3370 fcgi_strm_error(fstrm);
3371 fcgi_strm_capture_bad_message(fstrm->fconn, fstrm, h1m, buf);
3372 ret = 0;
3373 goto end;
3374 }
3375
Christopher Faulet99eff652019-08-11 23:11:30 +02003376 *ofs += ret;
3377 end:
Willy Tarreau022e5e52020-09-10 09:33:15 +02003378 TRACE_LEAVE(FCGI_EV_RSP_DATA|FCGI_EV_RSP_HDRS, fstrm->fconn->conn, fstrm, 0, (size_t[]){ret});
Christopher Faulet99eff652019-08-11 23:11:30 +02003379 return ret;
3380
3381}
3382
Christopher Fauletaf542632019-10-01 21:52:49 +02003383static size_t fcgi_strm_parse_data(struct fcgi_strm *fstrm, struct h1m *h1m, struct htx **htx,
Christopher Faulet99eff652019-08-11 23:11:30 +02003384 struct buffer *buf, size_t *ofs, size_t max, struct buffer *htxbuf)
3385{
Christopher Fauletde471a42021-02-01 16:37:28 +01003386 size_t ret;
Christopher Faulet99eff652019-08-11 23:11:30 +02003387
Willy Tarreau022e5e52020-09-10 09:33:15 +02003388 TRACE_ENTER(FCGI_EV_RSP_DATA|FCGI_EV_RSP_BODY, fstrm->fconn->conn, fstrm, 0, (size_t[]){max});
Christopher Faulet99eff652019-08-11 23:11:30 +02003389 ret = h1_parse_msg_data(h1m, htx, buf, *ofs, max, htxbuf);
Christopher Faulet76014fd2019-12-10 11:47:22 +01003390 if (!ret) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003391 TRACE_DEVEL("leaving on missing data or error", FCGI_EV_RSP_DATA|FCGI_EV_RSP_BODY, fstrm->fconn->conn, fstrm);
Christopher Fauletaf542632019-10-01 21:52:49 +02003392 if ((*htx)->flags & HTX_FL_PARSING_ERROR) {
Christopher Faulet73518be2021-01-27 12:06:54 +01003393 TRACE_ERROR("parsing error, reject H1 response", FCGI_EV_RSP_DATA|FCGI_EV_RSP_BODY|FCGI_EV_FSTRM_ERR, fstrm->fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003394 fcgi_strm_error(fstrm);
3395 fcgi_strm_capture_bad_message(fstrm->fconn, fstrm, h1m, buf);
3396 }
3397 goto end;
3398 }
3399 *ofs += ret;
3400 end:
Willy Tarreau022e5e52020-09-10 09:33:15 +02003401 TRACE_LEAVE(FCGI_EV_RSP_DATA|FCGI_EV_RSP_BODY, fstrm->fconn->conn, fstrm, 0, (size_t[]){ret});
Christopher Faulet99eff652019-08-11 23:11:30 +02003402 return ret;
3403}
3404
3405static size_t fcgi_strm_parse_trailers(struct fcgi_strm *fstrm, struct h1m *h1m, struct htx *htx,
3406 struct buffer *buf, size_t *ofs, size_t max)
3407{
Christopher Fauletd9fc1282022-03-28 15:37:01 +02003408 int ret;
Christopher Faulet99eff652019-08-11 23:11:30 +02003409
Willy Tarreau022e5e52020-09-10 09:33:15 +02003410 TRACE_ENTER(FCGI_EV_RSP_DATA|FCGI_EV_RSP_TLRS, fstrm->fconn->conn, fstrm, 0, (size_t[]){max});
Christopher Faulet99eff652019-08-11 23:11:30 +02003411 ret = h1_parse_msg_tlrs(h1m, htx, buf, *ofs, max);
Christopher Fauletd9fc1282022-03-28 15:37:01 +02003412 if (ret <= 0) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003413 TRACE_DEVEL("leaving on missing data or error", FCGI_EV_RSP_DATA|FCGI_EV_RSP_TLRS, fstrm->fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003414 if (htx->flags & HTX_FL_PARSING_ERROR) {
Christopher Faulet73518be2021-01-27 12:06:54 +01003415 TRACE_ERROR("parsing error, reject H1 response", FCGI_EV_RSP_DATA|FCGI_EV_RSP_TLRS|FCGI_EV_FSTRM_ERR, fstrm->fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003416 fcgi_strm_error(fstrm);
3417 fcgi_strm_capture_bad_message(fstrm->fconn, fstrm, h1m, buf);
3418 }
Christopher Fauletd9fc1282022-03-28 15:37:01 +02003419 ret = 0;
Christopher Faulet99eff652019-08-11 23:11:30 +02003420 goto end;
3421 }
3422 *ofs += ret;
Christopher Faulet99eff652019-08-11 23:11:30 +02003423 end:
Willy Tarreau022e5e52020-09-10 09:33:15 +02003424 TRACE_LEAVE(FCGI_EV_RSP_DATA|FCGI_EV_RSP_TLRS, fstrm->fconn->conn, fstrm, 0, (size_t[]){ret});
Christopher Faulet99eff652019-08-11 23:11:30 +02003425 return ret;
3426}
3427
Christopher Faulet99eff652019-08-11 23:11:30 +02003428static size_t fcgi_strm_parse_response(struct fcgi_strm *fstrm, struct buffer *buf, size_t count)
3429{
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003430 struct fcgi_conn *fconn = fstrm->fconn;
Christopher Faulet99eff652019-08-11 23:11:30 +02003431 struct htx *htx;
3432 struct h1m *h1m = &fstrm->h1m;
3433 size_t ret, data, total = 0;
3434
3435 htx = htx_from_buf(buf);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003436 TRACE_ENTER(FCGI_EV_RSP_DATA, fconn->conn, fstrm, htx, (size_t[]){count});
3437
Christopher Faulet99eff652019-08-11 23:11:30 +02003438 data = htx->data;
3439 if (fstrm->state == FCGI_SS_ERROR)
3440 goto end;
3441
3442 do {
3443 size_t used = htx_used_space(htx);
3444
3445 if (h1m->state <= H1_MSG_LAST_LF) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003446 TRACE_PROTO("parsing response headers", FCGI_EV_RSP_DATA|FCGI_EV_RSP_HDRS, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003447 ret = fcgi_strm_parse_headers(fstrm, h1m, htx, &fstrm->rxbuf, &total, count);
3448 if (!ret)
3449 break;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003450
3451 TRACE_USER("rcvd H1 response headers", FCGI_EV_RSP_DATA|FCGI_EV_RSP_HDRS, fconn->conn, fstrm, htx);
3452
Christopher Faulet99eff652019-08-11 23:11:30 +02003453 if ((h1m->flags & (H1_MF_VER_11|H1_MF_XFER_LEN)) == H1_MF_VER_11) {
3454 struct htx_blk *blk = htx_get_head_blk(htx);
3455 struct htx_sl *sl;
3456
3457 if (!blk)
3458 break;
3459 sl = htx_get_blk_ptr(htx, blk);
3460 sl->flags |= HTX_SL_F_XFER_LEN;
3461 htx->extra = 0;
3462 }
3463 }
3464 else if (h1m->state < H1_MSG_TRAILERS) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003465 TRACE_PROTO("parsing response payload", FCGI_EV_RSP_DATA|FCGI_EV_RSP_BODY, fconn->conn, fstrm);
Christopher Fauletbf774302021-06-02 12:04:40 +02003466 fcgi_strm_parse_data(fstrm, h1m, &htx, &fstrm->rxbuf, &total, count, buf);
Christopher Faulet1e857782020-12-08 10:38:22 +01003467
3468 if (!(h1m->flags & H1_MF_XFER_LEN) && fstrm->state != FCGI_SS_ERROR &&
3469 (fstrm->flags & FCGI_SF_ES_RCVD) && b_data(&fstrm->rxbuf) == total) {
3470 TRACE_DEVEL("end of data", FCGI_EV_RSP_DATA, fconn->conn, fstrm);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01003471 htx->flags |= HTX_FL_EOM;
Christopher Faulet1e857782020-12-08 10:38:22 +01003472 h1m->state = H1_MSG_DONE;
3473 TRACE_USER("H1 response fully rcvd", FCGI_EV_RSP_DATA|FCGI_EV_RSP_EOM, fconn->conn, fstrm, htx);
3474 }
3475
Christopher Faulet16a524c2021-02-02 21:16:03 +01003476 if (h1m->state < H1_MSG_TRAILERS)
Christopher Faulet99eff652019-08-11 23:11:30 +02003477 break;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003478
3479 TRACE_PROTO("rcvd response payload data", FCGI_EV_RSP_DATA|FCGI_EV_RSP_BODY, fconn->conn, fstrm, htx);
Christopher Faulet99eff652019-08-11 23:11:30 +02003480 }
3481 else if (h1m->state == H1_MSG_TRAILERS) {
Christopher Faulet76014fd2019-12-10 11:47:22 +01003482 TRACE_PROTO("parsing response trailers", FCGI_EV_RSP_DATA|FCGI_EV_RSP_TLRS, fconn->conn, fstrm);
Christopher Fauletbf774302021-06-02 12:04:40 +02003483 fcgi_strm_parse_trailers(fstrm, h1m, htx, &fstrm->rxbuf, &total, count);
Christopher Faulet16a524c2021-02-02 21:16:03 +01003484 if (h1m->state != H1_MSG_DONE)
Christopher Faulet99eff652019-08-11 23:11:30 +02003485 break;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003486
Christopher Faulet76014fd2019-12-10 11:47:22 +01003487 TRACE_PROTO("rcvd H1 response trailers", FCGI_EV_RSP_DATA|FCGI_EV_RSP_TLRS, fconn->conn, fstrm, htx);
Christopher Faulet99eff652019-08-11 23:11:30 +02003488 }
3489 else if (h1m->state == H1_MSG_DONE) {
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01003490 TRACE_USER("H1 response fully rcvd", FCGI_EV_RSP_DATA|FCGI_EV_RSP_EOM, fconn->conn, fstrm, htx);
Christopher Faulet99eff652019-08-11 23:11:30 +02003491 if (b_data(&fstrm->rxbuf) > total) {
3492 htx->flags |= HTX_FL_PARSING_ERROR;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003493 TRACE_PROTO("too much data, parsing error", FCGI_EV_RSP_DATA, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003494 fcgi_strm_error(fstrm);
3495 }
3496 break;
3497 }
Christopher Faulet99eff652019-08-11 23:11:30 +02003498 else {
3499 htx->flags |= HTX_FL_PROCESSING_ERROR;
Christopher Faulet73518be2021-01-27 12:06:54 +01003500 TRACE_ERROR("unexpected processing error", FCGI_EV_RSP_DATA|FCGI_EV_STRM_ERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003501 fcgi_strm_error(fstrm);
3502 break;
3503 }
3504
3505 count -= htx_used_space(htx) - used;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003506 } while (fstrm->state != FCGI_SS_ERROR);
Christopher Faulet99eff652019-08-11 23:11:30 +02003507
3508 if (fstrm->state == FCGI_SS_ERROR) {
3509 b_reset(&fstrm->rxbuf);
3510 htx_to_buf(htx, buf);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003511 TRACE_DEVEL("leaving on error", FCGI_EV_RSP_DATA|FCGI_EV_STRM_ERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003512 return 0;
3513 }
3514
3515 b_del(&fstrm->rxbuf, total);
3516
3517 end:
3518 htx_to_buf(htx, buf);
3519 ret = htx->data - data;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003520 TRACE_LEAVE(FCGI_EV_RSP_DATA, fconn->conn, fstrm, htx, (size_t[]){ret});
Christopher Faulet99eff652019-08-11 23:11:30 +02003521 return ret;
3522}
3523
3524/*
3525 * Attach a new stream to a connection
3526 * (Used for outgoing connections)
3527 */
Christopher Faulete00ad352021-12-16 14:44:31 +01003528static int fcgi_attach(struct connection *conn, struct conn_stream *cs, struct session *sess)
Christopher Faulet99eff652019-08-11 23:11:30 +02003529{
Christopher Faulet99eff652019-08-11 23:11:30 +02003530 struct fcgi_strm *fstrm;
3531 struct fcgi_conn *fconn = conn->ctx;
3532
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003533 TRACE_ENTER(FCGI_EV_FSTRM_NEW, conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02003534 fstrm = fcgi_conn_stream_new(fconn, cs, sess);
Christopher Faulete00ad352021-12-16 14:44:31 +01003535 if (!fstrm)
Christopher Faulet73518be2021-01-27 12:06:54 +01003536 goto err;
Willy Tarreaue388f2f2021-03-02 16:51:09 +01003537
3538 /* the connection is not idle anymore, let's mark this */
3539 HA_ATOMIC_AND(&fconn->wait_event.tasklet->state, ~TASK_F_USR1);
Willy Tarreau4f8cd432021-03-02 17:27:58 +01003540 xprt_set_used(conn, conn->xprt, conn->xprt_ctx);
Willy Tarreaue388f2f2021-03-02 16:51:09 +01003541
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003542 TRACE_LEAVE(FCGI_EV_FSTRM_NEW, conn, fstrm);
Christopher Faulete00ad352021-12-16 14:44:31 +01003543 return 0;
Christopher Faulet73518be2021-01-27 12:06:54 +01003544
3545 err:
3546 TRACE_DEVEL("leaving on error", FCGI_EV_FSTRM_NEW|FCGI_EV_FSTRM_ERR, conn);
Christopher Faulete00ad352021-12-16 14:44:31 +01003547 return -1;
Christopher Faulet99eff652019-08-11 23:11:30 +02003548}
3549
3550/* Retrieves the first valid conn_stream from this connection, or returns NULL.
3551 * We have to scan because we may have some orphan streams. It might be
3552 * beneficial to scan backwards from the end to reduce the likeliness to find
3553 * orphans.
3554 */
Christopher Faulet64b8d332022-04-01 13:21:41 +02003555static struct conn_stream *fcgi_get_first_cs(const struct connection *conn)
Christopher Faulet99eff652019-08-11 23:11:30 +02003556{
3557 struct fcgi_conn *fconn = conn->ctx;
3558 struct fcgi_strm *fstrm;
3559 struct eb32_node *node;
3560
3561 node = eb32_first(&fconn->streams_by_id);
3562 while (node) {
3563 fstrm = container_of(node, struct fcgi_strm, by_id);
3564 if (fstrm->cs)
3565 return fstrm->cs;
3566 node = eb32_next(node);
3567 }
3568 return NULL;
3569}
3570
3571/*
3572 * Destroy the mux and the associated connection, if it is no longer used
3573 */
3574static void fcgi_destroy(void *ctx)
3575{
3576 struct fcgi_conn *fconn = ctx;
3577
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003578 TRACE_POINT(FCGI_EV_FCONN_END, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02003579 if (eb_is_empty(&fconn->streams_by_id) || !fconn->conn || fconn->conn->ctx != fconn)
3580 fcgi_release(fconn);
3581}
3582
3583/*
3584 * Detach the stream from the connection and possibly release the connection.
3585 */
3586static void fcgi_detach(struct conn_stream *cs)
3587{
Christopher Fauletdb90f2a2022-03-22 16:06:25 +01003588 struct fcgi_strm *fstrm = __cs_mux(cs);
Christopher Faulet99eff652019-08-11 23:11:30 +02003589 struct fcgi_conn *fconn;
3590 struct session *sess;
3591
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003592 TRACE_ENTER(FCGI_EV_STRM_END, (fstrm ? fstrm->fconn->conn : NULL), fstrm);
3593
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003594 if (!fstrm) {
3595 TRACE_LEAVE(FCGI_EV_STRM_END);
Christopher Faulet99eff652019-08-11 23:11:30 +02003596 return;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003597 }
Christopher Faulet99eff652019-08-11 23:11:30 +02003598
Willy Tarreauf11be0e2020-01-16 16:59:45 +01003599 /* there's no txbuf so we're certain no to be able to send anything */
3600 fstrm->flags &= ~FCGI_SF_NOTIFIED;
Christopher Faulet99eff652019-08-11 23:11:30 +02003601
3602 sess = fstrm->sess;
3603 fconn = fstrm->fconn;
3604 fstrm->cs = NULL;
3605 fconn->nb_cs--;
3606
3607 if (fstrm->proto_status == FCGI_PS_CANT_MPX_CONN) {
3608 fconn->flags &= ~FCGI_CF_MPXS_CONNS;
3609 fconn->streams_limit = 1;
3610 }
3611 else if (fstrm->proto_status == FCGI_PS_OVERLOADED ||
3612 fstrm->proto_status == FCGI_PS_UNKNOWN_ROLE) {
3613 fconn->flags &= ~FCGI_CF_KEEP_CONN;
3614 fconn->state = FCGI_CS_CLOSED;
3615 }
3616
3617 /* this stream may be blocked waiting for some data to leave, so orphan
3618 * it in this case.
3619 */
Christopher Faulet897d6122021-12-17 17:28:35 +01003620 if (!(fconn->conn->flags & CO_FL_ERROR) &&
Christopher Faulet99eff652019-08-11 23:11:30 +02003621 (fconn->state != FCGI_CS_CLOSED) &&
Willy Tarreau7aad7032020-01-16 17:20:57 +01003622 (fstrm->flags & (FCGI_SF_BLK_MBUSY|FCGI_SF_BLK_MROOM)) &&
Willy Tarreau8907e4d2020-01-16 17:55:37 +01003623 (fstrm->subs || (fstrm->flags & (FCGI_SF_WANT_SHUTR|FCGI_SF_WANT_SHUTW)))) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003624 TRACE_DEVEL("leaving on stream blocked", FCGI_EV_STRM_END|FCGI_EV_FSTRM_BLK, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003625 return;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003626 }
Christopher Faulet99eff652019-08-11 23:11:30 +02003627
3628 if ((fconn->flags & FCGI_CF_DEM_BLOCK_ANY && fstrm->id == fconn->dsi)) {
3629 /* unblock the connection if it was blocked on this stream. */
3630 fconn->flags &= ~FCGI_CF_DEM_BLOCK_ANY;
3631 fcgi_conn_restart_reading(fconn, 1);
3632 }
3633
3634 fcgi_strm_destroy(fstrm);
3635
3636 if (!(fconn->conn->flags & (CO_FL_ERROR|CO_FL_SOCK_RD_SH|CO_FL_SOCK_WR_SH)) &&
Christopher Faulet9bcd9732020-05-02 09:21:24 +02003637 (fconn->flags & FCGI_CF_KEEP_CONN)) {
Christopher Faulet29ae7ff2020-07-01 15:51:46 +02003638 if (fconn->conn->flags & CO_FL_PRIVATE) {
Christopher Faulet08016ab2020-07-01 16:10:06 +02003639 /* Add the connection in the session serverlist, if not already done */
3640 if (!session_add_conn(sess, fconn->conn, fconn->conn->target)) {
3641 fconn->conn->owner = NULL;
3642 if (eb_is_empty(&fconn->streams_by_id)) {
3643 /* let's kill the connection right away */
3644 fconn->conn->mux->destroy(fconn);
3645 TRACE_DEVEL("outgoing connection killed", FCGI_EV_STRM_END|FCGI_EV_FCONN_ERR);
3646 return;
Christopher Faulet29ae7ff2020-07-01 15:51:46 +02003647 }
3648 }
Christopher Faulet08016ab2020-07-01 16:10:06 +02003649 if (eb_is_empty(&fconn->streams_by_id)) {
Christopher Faulet29ae7ff2020-07-01 15:51:46 +02003650 if (session_check_idle_conn(fconn->conn->owner, fconn->conn) != 0) {
3651 /* The connection is destroyed, let's leave */
Olivier Houchard2444aa52020-01-20 13:56:01 +01003652 TRACE_DEVEL("outgoing connection killed", FCGI_EV_STRM_END|FCGI_EV_FCONN_ERR);
Christopher Faulet66cd57e2020-05-02 09:08:54 +02003653 return;
Christopher Faulet99eff652019-08-11 23:11:30 +02003654 }
3655 }
3656 }
Christopher Faulet29ae7ff2020-07-01 15:51:46 +02003657 else {
3658 if (eb_is_empty(&fconn->streams_by_id)) {
Amaury Denoyelle46f041d2020-10-14 18:17:11 +02003659 /* If the connection is owned by the session, first remove it
3660 * from its list
3661 */
3662 if (fconn->conn->owner) {
3663 session_unown_conn(fconn->conn->owner, fconn->conn);
3664 fconn->conn->owner = NULL;
3665 }
3666
Willy Tarreaue388f2f2021-03-02 16:51:09 +01003667 /* mark that the tasklet may lose its context to another thread and
3668 * that the handler needs to check it under the idle conns lock.
3669 */
3670 HA_ATOMIC_OR(&fconn->wait_event.tasklet->state, TASK_F_USR1);
Willy Tarreau4f8cd432021-03-02 17:27:58 +01003671 xprt_set_idle(fconn->conn, fconn->conn->xprt, fconn->conn->xprt_ctx);
3672
Olivier Houcharddc2f2752020-02-13 19:12:07 +01003673 if (!srv_add_to_idle_list(objt_server(fconn->conn->target), fconn->conn, 1)) {
Olivier Houchard2444aa52020-01-20 13:56:01 +01003674 /* The server doesn't want it, let's kill the connection right away */
3675 fconn->conn->mux->destroy(fconn);
3676 TRACE_DEVEL("outgoing connection killed", FCGI_EV_STRM_END|FCGI_EV_FCONN_ERR);
3677 return;
3678 }
Olivier Houchard199d4fa2020-03-22 23:25:51 +01003679 /* At this point, the connection has been added to the
3680 * server idle list, so another thread may already have
3681 * hijacked it, so we can't do anything with it.
3682 */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003683 TRACE_DEVEL("reusable idle connection", FCGI_EV_STRM_END, fconn->conn);
3684 return;
3685 }
Amaury Denoyelle8990b012021-02-19 15:29:16 +01003686 else if (!fconn->conn->hash_node->node.node.leaf_p &&
Amaury Denoyelle46f041d2020-10-14 18:17:11 +02003687 fcgi_avail_streams(fconn->conn) > 0 && objt_server(fconn->conn->target) &&
Willy Tarreau2b718102021-04-21 07:32:39 +02003688 !LIST_INLIST(&fconn->conn->session_list)) {
Willy Tarreau430bf4a2021-03-04 09:45:32 +01003689 ebmb_insert(&__objt_server(fconn->conn->target)->per_thr[tid].avail_conns,
Amaury Denoyelle8990b012021-02-19 15:29:16 +01003690 &fconn->conn->hash_node->node,
3691 sizeof(fconn->conn->hash_node->hash));
Olivier Houcharddc2f2752020-02-13 19:12:07 +01003692 }
Christopher Faulet29ae7ff2020-07-01 15:51:46 +02003693 }
Christopher Faulet99eff652019-08-11 23:11:30 +02003694 }
3695
3696 /* We don't want to close right now unless we're removing the last
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003697 * stream and the connection is in error.
Christopher Faulet99eff652019-08-11 23:11:30 +02003698 */
3699 if (fcgi_conn_is_dead(fconn)) {
3700 /* no more stream will come, kill it now */
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003701 TRACE_DEVEL("leaving, killing dead connection", FCGI_EV_STRM_END, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02003702 fcgi_release(fconn);
3703 }
3704 else if (fconn->task) {
3705 fconn->task->expire = tick_add(now_ms, (fconn->state == FCGI_CS_CLOSED ? fconn->shut_timeout : fconn->timeout));
3706 task_queue(fconn->task);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003707 TRACE_DEVEL("leaving, refreshing connection's timeout", FCGI_EV_STRM_END, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02003708 }
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003709 else
3710 TRACE_DEVEL("leaving", FCGI_EV_STRM_END, fconn->conn);
Christopher Faulet99eff652019-08-11 23:11:30 +02003711}
3712
3713
3714/* Performs a synchronous or asynchronous shutr(). */
3715static void fcgi_do_shutr(struct fcgi_strm *fstrm)
3716{
3717 struct fcgi_conn *fconn = fstrm->fconn;
Christopher Faulet99eff652019-08-11 23:11:30 +02003718
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003719 TRACE_ENTER(FCGI_EV_STRM_SHUT, fconn->conn, fstrm);
3720
Christopher Faulet99eff652019-08-11 23:11:30 +02003721 if (fstrm->state == FCGI_SS_CLOSED)
3722 goto done;
3723
3724 /* a connstream may require us to immediately kill the whole connection
3725 * for example because of a "tcp-request content reject" rule that is
3726 * normally used to limit abuse.
3727 */
Christopher Fauletca2b5272022-03-30 14:48:10 +02003728 if ((fstrm->endp->flags & CS_EP_KILL_CONN) &&
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003729 !(fconn->flags & (FCGI_CF_ABRTS_SENT|FCGI_CF_ABRTS_FAILED))) {
3730 TRACE_STATE("stream wants to kill the connection", FCGI_EV_STRM_SHUT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003731 fconn->state = FCGI_CS_CLOSED;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003732 }
Christopher Faulet99eff652019-08-11 23:11:30 +02003733 else if (fstrm->flags & FCGI_SF_BEGIN_SENT) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003734 TRACE_STATE("no headers sent yet, trying a retryable abort", FCGI_EV_STRM_SHUT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003735 if (!(fstrm->flags & (FCGI_SF_ES_SENT|FCGI_SF_ABRT_SENT)) &&
3736 !fcgi_strm_send_abort(fconn, fstrm))
3737 goto add_to_list;
3738 }
3739
3740 fcgi_strm_close(fstrm);
3741
3742 if (!(fconn->wait_event.events & SUB_RETRY_SEND))
3743 tasklet_wakeup(fconn->wait_event.tasklet);
3744 done:
3745 fstrm->flags &= ~FCGI_SF_WANT_SHUTR;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003746 TRACE_LEAVE(FCGI_EV_STRM_SHUT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003747 return;
3748
3749 add_to_list:
Willy Tarreau7aad7032020-01-16 17:20:57 +01003750 /* Let the handler know we want to shutr, and add ourselves to the
3751 * send list if not yet done. fcgi_deferred_shut() will be
3752 * automatically called via the shut_tl tasklet when there's room
3753 * again.
3754 */
Willy Tarreau2b718102021-04-21 07:32:39 +02003755 if (!LIST_INLIST(&fstrm->send_list)) {
Christopher Faulet99eff652019-08-11 23:11:30 +02003756 if (fstrm->flags & (FCGI_SF_BLK_MBUSY|FCGI_SF_BLK_MROOM)) {
Willy Tarreau2b718102021-04-21 07:32:39 +02003757 LIST_APPEND(&fconn->send_list, &fstrm->send_list);
Christopher Faulet99eff652019-08-11 23:11:30 +02003758 }
3759 }
Christopher Faulet99eff652019-08-11 23:11:30 +02003760 fstrm->flags |= FCGI_SF_WANT_SHUTR;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003761 TRACE_LEAVE(FCGI_EV_STRM_SHUT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003762 return;
3763}
3764
3765/* Performs a synchronous or asynchronous shutw(). */
3766static void fcgi_do_shutw(struct fcgi_strm *fstrm)
3767{
3768 struct fcgi_conn *fconn = fstrm->fconn;
Christopher Faulet99eff652019-08-11 23:11:30 +02003769
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003770 TRACE_ENTER(FCGI_EV_STRM_SHUT, fconn->conn, fstrm);
3771
Christopher Faulet99eff652019-08-11 23:11:30 +02003772 if (fstrm->state != FCGI_SS_HLOC || fstrm->state == FCGI_SS_CLOSED)
3773 goto done;
3774
3775 if (fstrm->state != FCGI_SS_ERROR && (fstrm->flags & FCGI_SF_BEGIN_SENT)) {
3776 if (!(fstrm->flags & (FCGI_SF_ES_SENT|FCGI_SF_ABRT_SENT)) &&
3777 !fcgi_strm_send_abort(fconn, fstrm))
3778 goto add_to_list;
3779
3780 if (fstrm->state == FCGI_SS_HREM)
3781 fcgi_strm_close(fstrm);
3782 else
3783 fstrm->state = FCGI_SS_HLOC;
3784 } else {
3785 /* a connstream may require us to immediately kill the whole connection
3786 * for example because of a "tcp-request content reject" rule that is
3787 * normally used to limit abuse.
3788 */
Christopher Fauletca2b5272022-03-30 14:48:10 +02003789 if ((fstrm->endp->flags & CS_EP_KILL_CONN) &&
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003790 !(fconn->flags & (FCGI_CF_ABRTS_SENT|FCGI_CF_ABRTS_FAILED))) {
3791 TRACE_STATE("stream wants to kill the connection", FCGI_EV_STRM_SHUT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003792 fconn->state = FCGI_CS_CLOSED;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003793 }
Christopher Faulet99eff652019-08-11 23:11:30 +02003794
3795 fcgi_strm_close(fstrm);
3796 }
3797
3798 if (!(fconn->wait_event.events & SUB_RETRY_SEND))
3799 tasklet_wakeup(fconn->wait_event.tasklet);
3800 done:
3801 fstrm->flags &= ~FCGI_SF_WANT_SHUTW;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003802 TRACE_LEAVE(FCGI_EV_STRM_SHUT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003803 return;
3804
3805 add_to_list:
Willy Tarreau7aad7032020-01-16 17:20:57 +01003806 /* Let the handler know we want to shutr, and add ourselves to the
3807 * send list if not yet done. fcgi_deferred_shut() will be
3808 * automatically called via the shut_tl tasklet when there's room
3809 * again.
3810 */
Willy Tarreau2b718102021-04-21 07:32:39 +02003811 if (!LIST_INLIST(&fstrm->send_list)) {
Christopher Faulet99eff652019-08-11 23:11:30 +02003812 if (fstrm->flags & (FCGI_SF_BLK_MBUSY|FCGI_SF_BLK_MROOM)) {
Willy Tarreau2b718102021-04-21 07:32:39 +02003813 LIST_APPEND(&fconn->send_list, &fstrm->send_list);
Christopher Faulet99eff652019-08-11 23:11:30 +02003814 }
3815 }
Christopher Faulet99eff652019-08-11 23:11:30 +02003816 fstrm->flags |= FCGI_SF_WANT_SHUTW;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003817 TRACE_LEAVE(FCGI_EV_STRM_SHUT, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003818 return;
3819}
3820
Willy Tarreau7aad7032020-01-16 17:20:57 +01003821/* This is the tasklet referenced in fstrm->shut_tl, it is used for
Christopher Faulet99eff652019-08-11 23:11:30 +02003822 * deferred shutdowns when the fcgi_detach() was done but the mux buffer was full
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003823 * and prevented the last record from being emitted.
Christopher Faulet99eff652019-08-11 23:11:30 +02003824 */
Willy Tarreau144f84a2021-03-02 16:09:26 +01003825struct task *fcgi_deferred_shut(struct task *t, void *ctx, unsigned int state)
Christopher Faulet99eff652019-08-11 23:11:30 +02003826{
3827 struct fcgi_strm *fstrm = ctx;
3828 struct fcgi_conn *fconn = fstrm->fconn;
3829
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003830 TRACE_ENTER(FCGI_EV_STRM_SHUT, fconn->conn, fstrm);
3831
Willy Tarreau7aad7032020-01-16 17:20:57 +01003832 if (fstrm->flags & FCGI_SF_NOTIFIED) {
3833 /* some data processing remains to be done first */
3834 goto end;
3835 }
3836
Christopher Faulet99eff652019-08-11 23:11:30 +02003837 if (fstrm->flags & FCGI_SF_WANT_SHUTW)
3838 fcgi_do_shutw(fstrm);
3839
3840 if (fstrm->flags & FCGI_SF_WANT_SHUTR)
3841 fcgi_do_shutr(fstrm);
3842
3843 if (!(fstrm->flags & (FCGI_SF_WANT_SHUTR|FCGI_SF_WANT_SHUTW))) {
3844 /* We're done trying to send, remove ourself from the send_list */
3845 LIST_DEL_INIT(&fstrm->send_list);
3846
3847 if (!fstrm->cs) {
3848 fcgi_strm_destroy(fstrm);
3849 if (fcgi_conn_is_dead(fconn))
3850 fcgi_release(fconn);
3851 }
3852 }
Willy Tarreau7aad7032020-01-16 17:20:57 +01003853 end:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003854 TRACE_LEAVE(FCGI_EV_STRM_SHUT);
Christopher Faulet99eff652019-08-11 23:11:30 +02003855 return NULL;
3856}
3857
3858/* shutr() called by the conn_stream (mux_ops.shutr) */
Christopher Faulet07976562022-03-31 11:05:05 +02003859static void fcgi_shutr(struct conn_stream *cs, enum co_shr_mode mode)
Christopher Faulet99eff652019-08-11 23:11:30 +02003860{
Christopher Fauletdb90f2a2022-03-22 16:06:25 +01003861 struct fcgi_strm *fstrm = __cs_mux(cs);
Christopher Faulet99eff652019-08-11 23:11:30 +02003862
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003863 TRACE_POINT(FCGI_EV_STRM_SHUT, fstrm->fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003864 if (!mode)
3865 return;
Christopher Faulet99eff652019-08-11 23:11:30 +02003866 fcgi_do_shutr(fstrm);
3867}
3868
3869/* shutw() called by the conn_stream (mux_ops.shutw) */
Christopher Faulet07976562022-03-31 11:05:05 +02003870static void fcgi_shutw(struct conn_stream *cs, enum co_shw_mode mode)
Christopher Faulet99eff652019-08-11 23:11:30 +02003871{
Christopher Fauletdb90f2a2022-03-22 16:06:25 +01003872 struct fcgi_strm *fstrm = __cs_mux(cs);
Christopher Faulet99eff652019-08-11 23:11:30 +02003873
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003874 TRACE_POINT(FCGI_EV_STRM_SHUT, fstrm->fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003875 fcgi_do_shutw(fstrm);
3876}
3877
Willy Tarreauee1a6fc2020-01-17 07:52:13 +01003878/* Called from the upper layer, to subscribe <es> to events <event_type>. The
3879 * event subscriber <es> is not allowed to change from a previous call as long
3880 * as at least one event is still subscribed. The <event_type> must only be a
3881 * combination of SUB_RETRY_RECV and SUB_RETRY_SEND. It always returns 0.
Christopher Faulet99eff652019-08-11 23:11:30 +02003882 */
Willy Tarreauee1a6fc2020-01-17 07:52:13 +01003883static int fcgi_subscribe(struct conn_stream *cs, int event_type, struct wait_event *es)
Christopher Faulet99eff652019-08-11 23:11:30 +02003884{
Christopher Fauletdb90f2a2022-03-22 16:06:25 +01003885 struct fcgi_strm *fstrm = __cs_mux(cs);
Christopher Faulet99eff652019-08-11 23:11:30 +02003886 struct fcgi_conn *fconn = fstrm->fconn;
3887
Willy Tarreau8907e4d2020-01-16 17:55:37 +01003888 BUG_ON(event_type & ~(SUB_RETRY_SEND|SUB_RETRY_RECV));
Willy Tarreauee1a6fc2020-01-17 07:52:13 +01003889 BUG_ON(fstrm->subs && fstrm->subs != es);
Willy Tarreau8907e4d2020-01-16 17:55:37 +01003890
Willy Tarreauee1a6fc2020-01-17 07:52:13 +01003891 es->events |= event_type;
3892 fstrm->subs = es;
Willy Tarreau8907e4d2020-01-16 17:55:37 +01003893
3894 if (event_type & SUB_RETRY_RECV)
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003895 TRACE_DEVEL("unsubscribe(recv)", FCGI_EV_STRM_RECV, fconn->conn, fstrm);
Willy Tarreau8907e4d2020-01-16 17:55:37 +01003896
Christopher Faulet99eff652019-08-11 23:11:30 +02003897 if (event_type & SUB_RETRY_SEND) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003898 TRACE_DEVEL("unsubscribe(send)", FCGI_EV_STRM_SEND, fconn->conn, fstrm);
Willy Tarreau2b718102021-04-21 07:32:39 +02003899 if (!LIST_INLIST(&fstrm->send_list))
3900 LIST_APPEND(&fconn->send_list, &fstrm->send_list);
Christopher Faulet99eff652019-08-11 23:11:30 +02003901 }
Christopher Faulet99eff652019-08-11 23:11:30 +02003902 return 0;
3903}
3904
Willy Tarreauee1a6fc2020-01-17 07:52:13 +01003905/* Called from the upper layer, to unsubscribe <es> from events <event_type>
3906 * (undo fcgi_subscribe). The <es> pointer is not allowed to differ from the one
3907 * passed to the subscribe() call. It always returns zero.
Christopher Faulet99eff652019-08-11 23:11:30 +02003908 */
Willy Tarreauee1a6fc2020-01-17 07:52:13 +01003909static int fcgi_unsubscribe(struct conn_stream *cs, int event_type, struct wait_event *es)
Christopher Faulet99eff652019-08-11 23:11:30 +02003910{
Christopher Fauletdb90f2a2022-03-22 16:06:25 +01003911 struct fcgi_strm *fstrm = __cs_mux(cs);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003912 struct fcgi_conn *fconn = fstrm->fconn;
Christopher Faulet99eff652019-08-11 23:11:30 +02003913
Willy Tarreau8907e4d2020-01-16 17:55:37 +01003914 BUG_ON(event_type & ~(SUB_RETRY_SEND|SUB_RETRY_RECV));
Willy Tarreauee1a6fc2020-01-17 07:52:13 +01003915 BUG_ON(fstrm->subs && fstrm->subs != es);
Willy Tarreau8907e4d2020-01-16 17:55:37 +01003916
Willy Tarreauee1a6fc2020-01-17 07:52:13 +01003917 es->events &= ~event_type;
3918 if (!es->events)
Willy Tarreau8907e4d2020-01-16 17:55:37 +01003919 fstrm->subs = NULL;
3920
3921 if (event_type & SUB_RETRY_RECV)
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003922 TRACE_DEVEL("subscribe(recv)", FCGI_EV_STRM_RECV, fconn->conn, fstrm);
Willy Tarreau8907e4d2020-01-16 17:55:37 +01003923
Christopher Faulet99eff652019-08-11 23:11:30 +02003924 if (event_type & SUB_RETRY_SEND) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003925 TRACE_DEVEL("subscribe(send)", FCGI_EV_STRM_SEND, fconn->conn, fstrm);
Willy Tarreau8907e4d2020-01-16 17:55:37 +01003926 fstrm->flags &= ~FCGI_SF_NOTIFIED;
Willy Tarreau7aad7032020-01-16 17:20:57 +01003927 if (!(fstrm->flags & (FCGI_SF_WANT_SHUTR|FCGI_SF_WANT_SHUTW)))
3928 LIST_DEL_INIT(&fstrm->send_list);
Christopher Faulet99eff652019-08-11 23:11:30 +02003929 }
3930 return 0;
3931}
3932
Christopher Faulet564e39c2021-09-21 15:50:55 +02003933/* Called from the upper layer, to receive data
3934 *
3935 * The caller is responsible for defragmenting <buf> if necessary. But <flags>
3936 * must be tested to know the calling context. If CO_RFL_BUF_FLUSH is set, it
3937 * means the caller wants to flush input data (from the mux buffer and the
3938 * channel buffer) to be able to use kernel splicing or any kind of mux-to-mux
3939 * xfer. If CO_RFL_KEEP_RECV is set, the mux must always subscribe for read
3940 * events before giving back. CO_RFL_BUF_WET is set if <buf> is congested with
3941 * data scheduled for leaving soon. CO_RFL_BUF_NOT_STUCK is set to instruct the
3942 * mux it may optimize the data copy to <buf> if necessary. Otherwise, it should
3943 * copy as much data as possible.
3944 */
Christopher Faulet99eff652019-08-11 23:11:30 +02003945static size_t fcgi_rcv_buf(struct conn_stream *cs, struct buffer *buf, size_t count, int flags)
3946{
Christopher Fauletdb90f2a2022-03-22 16:06:25 +01003947 struct fcgi_strm *fstrm = __cs_mux(cs);
Christopher Faulet99eff652019-08-11 23:11:30 +02003948 struct fcgi_conn *fconn = fstrm->fconn;
3949 size_t ret = 0;
3950
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003951 TRACE_ENTER(FCGI_EV_STRM_RECV, fconn->conn, fstrm);
3952
Christopher Faulet99eff652019-08-11 23:11:30 +02003953 if (!(fconn->flags & FCGI_CF_DEM_SALLOC))
3954 ret = fcgi_strm_parse_response(fstrm, buf, count);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003955 else
3956 TRACE_STATE("fstrm rxbuf not allocated", FCGI_EV_STRM_RECV|FCGI_EV_FSTRM_BLK, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003957
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01003958 if (b_data(&fstrm->rxbuf))
Christopher Fauletb041b232022-03-24 10:27:02 +01003959 cs->endp->flags |= (CS_EP_RCV_MORE | CS_EP_WANT_ROOM);
Christopher Faulet99eff652019-08-11 23:11:30 +02003960 else {
Christopher Fauletb041b232022-03-24 10:27:02 +01003961 cs->endp->flags &= ~(CS_EP_RCV_MORE | CS_EP_WANT_ROOM);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01003962 if (fstrm->state == FCGI_SS_ERROR || (fstrm->h1m.state == H1_MSG_DONE)) {
Christopher Fauletb041b232022-03-24 10:27:02 +01003963 cs->endp->flags |= CS_EP_EOI;
Christopher Faulet99eff652019-08-11 23:11:30 +02003964 if (!(fstrm->h1m.flags & (H1_MF_VER_11|H1_MF_XFER_LEN)))
Christopher Fauletb041b232022-03-24 10:27:02 +01003965 cs->endp->flags |= CS_EP_EOS;
Christopher Faulet99eff652019-08-11 23:11:30 +02003966 }
Christopher Faulet6670e3e2020-10-08 15:26:33 +02003967 if (fcgi_conn_read0_pending(fconn))
Christopher Fauletb041b232022-03-24 10:27:02 +01003968 cs->endp->flags |= CS_EP_EOS;
3969 if (cs->endp->flags & CS_EP_ERR_PENDING)
3970 cs->endp->flags |= CS_EP_ERROR;
Christopher Faulet99eff652019-08-11 23:11:30 +02003971 fcgi_release_buf(fconn, &fstrm->rxbuf);
3972 }
3973
3974 if (ret && fconn->dsi == fstrm->id) {
3975 /* demux is blocking on this stream's buffer */
3976 fconn->flags &= ~FCGI_CF_DEM_SFULL;
3977 fcgi_conn_restart_reading(fconn, 1);
3978 }
3979
Christopher Faulet5c0f8592019-10-04 15:21:17 +02003980 TRACE_LEAVE(FCGI_EV_STRM_RECV, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02003981 return ret;
3982}
3983
3984
Christopher Faulet99eff652019-08-11 23:11:30 +02003985/* Called from the upper layer, to send data from buffer <buf> for no more than
3986 * <count> bytes. Returns the number of bytes effectively sent. Some status
3987 * flags may be updated on the conn_stream.
3988 */
3989static size_t fcgi_snd_buf(struct conn_stream *cs, struct buffer *buf, size_t count, int flags)
3990{
Christopher Fauletdb90f2a2022-03-22 16:06:25 +01003991 struct fcgi_strm *fstrm = __cs_mux(cs);
Christopher Faulet99eff652019-08-11 23:11:30 +02003992 struct fcgi_conn *fconn = fstrm->fconn;
3993 size_t total = 0;
3994 size_t ret;
3995 struct htx *htx = NULL;
3996 struct htx_sl *sl;
3997 struct htx_blk *blk;
3998 uint32_t bsize;
3999
Willy Tarreau022e5e52020-09-10 09:33:15 +02004000 TRACE_ENTER(FCGI_EV_STRM_SEND, fconn->conn, fstrm, 0, (size_t[]){count});
Christopher Faulet5c0f8592019-10-04 15:21:17 +02004001
Christopher Faulet99eff652019-08-11 23:11:30 +02004002 /* If we were not just woken because we wanted to send but couldn't,
4003 * and there's somebody else that is waiting to send, do nothing,
4004 * we will subscribe later and be put at the end of the list
4005 */
Willy Tarreauf11be0e2020-01-16 16:59:45 +01004006 if (!(fstrm->flags & FCGI_SF_NOTIFIED) && !LIST_ISEMPTY(&fconn->send_list)) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02004007 TRACE_STATE("other streams already waiting, going to the queue and leaving", FCGI_EV_STRM_SEND|FCGI_EV_FSTRM_BLK, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02004008 return 0;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02004009 }
Willy Tarreauf11be0e2020-01-16 16:59:45 +01004010 fstrm->flags &= ~FCGI_SF_NOTIFIED;
Christopher Faulet99eff652019-08-11 23:11:30 +02004011
Christopher Faulet5c0f8592019-10-04 15:21:17 +02004012 if (fconn->state < FCGI_CS_RECORD_H) {
4013 TRACE_STATE("connection not ready, leaving", FCGI_EV_STRM_SEND|FCGI_EV_FSTRM_BLK, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02004014 return 0;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02004015 }
Christopher Faulet99eff652019-08-11 23:11:30 +02004016
4017 htx = htxbuf(buf);
4018 if (fstrm->id == 0) {
4019 int32_t id = fcgi_conn_get_next_sid(fconn);
4020
4021 if (id < 0) {
4022 fcgi_strm_close(fstrm);
Christopher Fauletb041b232022-03-24 10:27:02 +01004023 cs->endp->flags |= CS_EP_ERROR;
Christopher Faulet5c0f8592019-10-04 15:21:17 +02004024 TRACE_DEVEL("couldn't get a stream ID, leaving in error", FCGI_EV_STRM_SEND|FCGI_EV_FSTRM_ERR|FCGI_EV_STRM_ERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02004025 return 0;
4026 }
4027
4028 eb32_delete(&fstrm->by_id);
4029 fstrm->by_id.key = fstrm->id = id;
4030 fconn->max_id = id;
4031 fconn->nb_reserved--;
4032 eb32_insert(&fconn->streams_by_id, &fstrm->by_id);
4033
4034
4035 /* Check if length of the body is known or if the message is
4036 * full. Otherwise, the request is invalid.
4037 */
4038 sl = http_get_stline(htx);
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01004039 if (!sl || (!(sl->flags & HTX_SL_F_CLEN) && !(htx->flags & HTX_FL_EOM))) {
Christopher Faulet99eff652019-08-11 23:11:30 +02004040 htx->flags |= HTX_FL_PARSING_ERROR;
4041 fcgi_strm_error(fstrm);
4042 goto done;
4043 }
4044 }
4045
4046 if (!(fstrm->flags & FCGI_SF_BEGIN_SENT)) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02004047 TRACE_PROTO("sending FCGI BEGIN_REQUEST record", FCGI_EV_TX_RECORD|FCGI_EV_TX_BEGREQ, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02004048 if (!fcgi_strm_send_begin_request(fconn, fstrm))
4049 goto done;
4050 }
4051
4052 if (!(fstrm->flags & FCGI_SF_OUTGOING_DATA) && count)
4053 fstrm->flags |= FCGI_SF_OUTGOING_DATA;
4054
Christopher Fauletfe410d62020-05-19 15:13:00 +02004055 while (fstrm->state < FCGI_SS_HLOC && !(fstrm->flags & FCGI_SF_BLK_ANY) &&
Christopher Faulet99eff652019-08-11 23:11:30 +02004056 count && !htx_is_empty(htx)) {
4057 blk = htx_get_head_blk(htx);
William Lallemand13ed9fa2019-09-25 21:21:57 +02004058 ALREADY_CHECKED(blk);
Christopher Faulet99eff652019-08-11 23:11:30 +02004059 bsize = htx_get_blksz(blk);
4060
4061 switch (htx_get_blk_type(blk)) {
4062 case HTX_BLK_REQ_SL:
4063 case HTX_BLK_HDR:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02004064 TRACE_USER("sending FCGI PARAMS record", FCGI_EV_TX_RECORD|FCGI_EV_TX_PARAMS, fconn->conn, fstrm, htx);
Christopher Faulet99eff652019-08-11 23:11:30 +02004065 ret = fcgi_strm_send_params(fconn, fstrm, htx);
4066 if (!ret) {
4067 goto done;
4068 }
4069 total += ret;
4070 count -= ret;
4071 break;
4072
4073 case HTX_BLK_EOH:
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01004074 if (!(fstrm->flags & FCGI_SF_EP_SENT)) {
4075 TRACE_PROTO("sending FCGI PARAMS record", FCGI_EV_TX_RECORD|FCGI_EV_TX_PARAMS, fconn->conn, fstrm, htx);
4076 ret = fcgi_strm_send_empty_params(fconn, fstrm);
4077 if (!ret)
4078 goto done;
4079 }
4080 if (htx_is_unique_blk(htx, blk) && (htx->flags & HTX_FL_EOM)) {
4081 TRACE_PROTO("sending FCGI STDIN record", FCGI_EV_TX_RECORD|FCGI_EV_TX_STDIN, fconn->conn, fstrm, htx);
4082 ret = fcgi_strm_send_empty_stdin(fconn, fstrm);
4083 if (!ret)
4084 goto done;
4085 }
Christopher Faulet99eff652019-08-11 23:11:30 +02004086 goto remove_blk;
4087
4088 case HTX_BLK_DATA:
Christopher Faulet5c0f8592019-10-04 15:21:17 +02004089 TRACE_PROTO("sending FCGI STDIN record", FCGI_EV_TX_RECORD|FCGI_EV_TX_STDIN, fconn->conn, fstrm, htx);
Christopher Faulet99eff652019-08-11 23:11:30 +02004090 ret = fcgi_strm_send_stdin(fconn, fstrm, htx, count, buf);
4091 if (ret > 0) {
4092 htx = htx_from_buf(buf);
4093 total += ret;
4094 count -= ret;
4095 if (ret < bsize)
4096 goto done;
4097 }
4098 break;
4099
Christopher Faulet99eff652019-08-11 23:11:30 +02004100 default:
4101 remove_blk:
4102 htx_remove_blk(htx, blk);
4103 total += bsize;
4104 count -= bsize;
4105 break;
4106 }
4107 }
4108
4109 done:
4110 if (fstrm->state >= FCGI_SS_HLOC) {
4111 /* trim any possibly pending data after we close (extra CR-LF,
4112 * unprocessed trailers, abnormal extra data, ...)
4113 */
4114 total += count;
4115 count = 0;
4116 }
4117
4118 if (fstrm->state == FCGI_SS_ERROR) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02004119 TRACE_DEVEL("reporting error to the app-layer stream", FCGI_EV_STRM_SEND|FCGI_EV_FSTRM_ERR|FCGI_EV_STRM_ERR, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02004120 cs_set_error(cs);
4121 if (!(fstrm->flags & FCGI_SF_BEGIN_SENT) || fcgi_strm_send_abort(fconn, fstrm))
4122 fcgi_strm_close(fstrm);
4123 }
4124
4125 if (htx)
4126 htx_to_buf(htx, buf);
4127
Christopher Faulet99eff652019-08-11 23:11:30 +02004128 if (total > 0) {
Christopher Faulet5c0f8592019-10-04 15:21:17 +02004129 if (!(fconn->wait_event.events & SUB_RETRY_SEND)) {
4130 TRACE_DEVEL("data queued, waking up fconn sender", FCGI_EV_STRM_SEND|FCGI_EV_FCONN_SEND|FCGI_EV_FCONN_WAKE, fconn->conn, fstrm);
Christopher Faulet99eff652019-08-11 23:11:30 +02004131 tasklet_wakeup(fconn->wait_event.tasklet);
Christopher Faulet5c0f8592019-10-04 15:21:17 +02004132 }
Christopher Faulet99eff652019-08-11 23:11:30 +02004133
4134 /* Ok we managed to send something, leave the send_list */
Willy Tarreau7aad7032020-01-16 17:20:57 +01004135 if (!(fstrm->flags & (FCGI_SF_WANT_SHUTR|FCGI_SF_WANT_SHUTW)))
4136 LIST_DEL_INIT(&fstrm->send_list);
Christopher Faulet99eff652019-08-11 23:11:30 +02004137 }
Christopher Faulet5c0f8592019-10-04 15:21:17 +02004138
4139 TRACE_LEAVE(FCGI_EV_STRM_SEND, fconn->conn, fstrm, htx, (size_t[]){total});
Christopher Faulet99eff652019-08-11 23:11:30 +02004140 return total;
4141}
4142
4143/* for debugging with CLI's "show fd" command */
Willy Tarreau8050efe2021-01-21 08:26:06 +01004144static int fcgi_show_fd(struct buffer *msg, struct connection *conn)
Christopher Faulet99eff652019-08-11 23:11:30 +02004145{
4146 struct fcgi_conn *fconn = conn->ctx;
4147 struct fcgi_strm *fstrm = NULL;
4148 struct eb32_node *node;
4149 int send_cnt = 0;
4150 int tree_cnt = 0;
4151 int orph_cnt = 0;
4152 struct buffer *hmbuf, *tmbuf;
4153
4154 if (!fconn)
Willy Tarreau8050efe2021-01-21 08:26:06 +01004155 return 0;
Christopher Faulet99eff652019-08-11 23:11:30 +02004156
4157 list_for_each_entry(fstrm, &fconn->send_list, send_list)
4158 send_cnt++;
4159
4160 fstrm = NULL;
4161 node = eb32_first(&fconn->streams_by_id);
4162 while (node) {
4163 fstrm = container_of(node, struct fcgi_strm, by_id);
4164 tree_cnt++;
4165 if (!fstrm->cs)
4166 orph_cnt++;
4167 node = eb32_next(node);
4168 }
4169
4170 hmbuf = br_head(fconn->mbuf);
4171 tmbuf = br_tail(fconn->mbuf);
4172 chunk_appendf(msg, " fconn.st0=%d .maxid=%d .flg=0x%04x .nbst=%u"
4173 " .nbcs=%u .send_cnt=%d .tree_cnt=%d .orph_cnt=%d .sub=%d "
4174 ".dsi=%d .dbuf=%u@%p+%u/%u .mbuf=[%u..%u|%u],h=[%u@%p+%u/%u],t=[%u@%p+%u/%u]",
4175 fconn->state, fconn->max_id, fconn->flags,
4176 fconn->nb_streams, fconn->nb_cs, send_cnt, tree_cnt, orph_cnt,
4177 fconn->wait_event.events, fconn->dsi,
4178 (unsigned int)b_data(&fconn->dbuf), b_orig(&fconn->dbuf),
4179 (unsigned int)b_head_ofs(&fconn->dbuf), (unsigned int)b_size(&fconn->dbuf),
4180 br_head_idx(fconn->mbuf), br_tail_idx(fconn->mbuf), br_size(fconn->mbuf),
4181 (unsigned int)b_data(hmbuf), b_orig(hmbuf),
4182 (unsigned int)b_head_ofs(hmbuf), (unsigned int)b_size(hmbuf),
4183 (unsigned int)b_data(tmbuf), b_orig(tmbuf),
4184 (unsigned int)b_head_ofs(tmbuf), (unsigned int)b_size(tmbuf));
4185
4186 if (fstrm) {
4187 chunk_appendf(msg, " last_fstrm=%p .id=%d .flg=0x%04x .rxbuf=%u@%p+%u/%u .cs=%p",
4188 fstrm, fstrm->id, fstrm->flags,
4189 (unsigned int)b_data(&fstrm->rxbuf), b_orig(&fstrm->rxbuf),
4190 (unsigned int)b_head_ofs(&fstrm->rxbuf), (unsigned int)b_size(&fstrm->rxbuf),
4191 fstrm->cs);
4192 if (fstrm->cs)
Christopher Fauletf835dea2021-12-21 14:35:17 +01004193 chunk_appendf(msg, " .cs.flg=0x%08x .cs.app=%p",
4194 fstrm->cs->flags, fstrm->cs->app);
Willy Tarreau1776ffb2021-01-20 17:10:46 +01004195 chunk_appendf(&trash, " .subs=%p", fstrm->subs);
4196 if (fstrm->subs) {
Christopher Faulet6c93c4e2021-02-25 10:06:29 +01004197 chunk_appendf(&trash, "(ev=%d tl=%p", fstrm->subs->events, fstrm->subs->tasklet);
4198 chunk_appendf(&trash, " tl.calls=%d tl.ctx=%p tl.fct=",
4199 fstrm->subs->tasklet->calls,
4200 fstrm->subs->tasklet->context);
4201 resolve_sym_name(&trash, NULL, fstrm->subs->tasklet->process);
4202 chunk_appendf(&trash, ")");
Willy Tarreau1776ffb2021-01-20 17:10:46 +01004203 }
Christopher Faulet99eff652019-08-11 23:11:30 +02004204 }
Willy Tarreau8050efe2021-01-21 08:26:06 +01004205 return 0;
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01004206}
4207
4208/* Migrate the the connection to the current thread.
4209 * Return 0 if successful, non-zero otherwise.
4210 * Expected to be called with the old thread lock held.
4211 */
Olivier Houchard1662cdb2020-07-03 14:04:37 +02004212static int fcgi_takeover(struct connection *conn, int orig_tid)
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01004213{
4214 struct fcgi_conn *fcgi = conn->ctx;
Willy Tarreau88d18f82020-07-01 16:39:33 +02004215 struct task *task;
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01004216
4217 if (fd_takeover(conn->handle.fd, conn) != 0)
4218 return -1;
Olivier Houcharda74bb7e2020-07-03 14:01:21 +02004219
4220 if (conn->xprt->takeover && conn->xprt->takeover(conn, conn->xprt_ctx, orig_tid) != 0) {
4221 /* We failed to takeover the xprt, even if the connection may
4222 * still be valid, flag it as error'd, as we have already
4223 * taken over the fd, and wake the tasklet, so that it will
4224 * destroy it.
4225 */
4226 conn->flags |= CO_FL_ERROR;
4227 tasklet_wakeup_on(fcgi->wait_event.tasklet, orig_tid);
4228 return -1;
4229 }
4230
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01004231 if (fcgi->wait_event.events)
4232 fcgi->conn->xprt->unsubscribe(fcgi->conn, fcgi->conn->xprt_ctx,
4233 fcgi->wait_event.events, &fcgi->wait_event);
4234 /* To let the tasklet know it should free itself, and do nothing else,
4235 * set its context to NULL;
4236 */
4237 fcgi->wait_event.tasklet->context = NULL;
Olivier Houchard1662cdb2020-07-03 14:04:37 +02004238 tasklet_wakeup_on(fcgi->wait_event.tasklet, orig_tid);
Willy Tarreau88d18f82020-07-01 16:39:33 +02004239
4240 task = fcgi->task;
4241 if (task) {
4242 task->context = NULL;
4243 fcgi->task = NULL;
4244 __ha_barrier_store();
4245 task_kill(task);
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01004246
Willy Tarreaubeeabf52021-10-01 18:23:30 +02004247 fcgi->task = task_new_here();
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01004248 if (!fcgi->task) {
4249 fcgi_release(fcgi);
4250 return -1;
4251 }
4252 fcgi->task->process = fcgi_timeout_task;
4253 fcgi->task->context = fcgi;
4254 }
4255 fcgi->wait_event.tasklet = tasklet_new();
4256 if (!fcgi->wait_event.tasklet) {
4257 fcgi_release(fcgi);
4258 return -1;
4259 }
4260 fcgi->wait_event.tasklet->process = fcgi_io_cb;
4261 fcgi->wait_event.tasklet->context = fcgi;
4262 fcgi->conn->xprt->subscribe(fcgi->conn, fcgi->conn->xprt_ctx,
4263 SUB_RETRY_RECV, &fcgi->wait_event);
4264
4265 return 0;
Christopher Faulet99eff652019-08-11 23:11:30 +02004266}
4267
4268/****************************************/
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +05004269/* MUX initialization and instantiation */
Christopher Faulet99eff652019-08-11 23:11:30 +02004270/****************************************/
4271
4272/* The mux operations */
4273static const struct mux_ops mux_fcgi_ops = {
4274 .init = fcgi_init,
4275 .wake = fcgi_wake,
4276 .attach = fcgi_attach,
4277 .get_first_cs = fcgi_get_first_cs,
4278 .detach = fcgi_detach,
4279 .destroy = fcgi_destroy,
4280 .avail_streams = fcgi_avail_streams,
4281 .used_streams = fcgi_used_streams,
4282 .rcv_buf = fcgi_rcv_buf,
4283 .snd_buf = fcgi_snd_buf,
4284 .subscribe = fcgi_subscribe,
4285 .unsubscribe = fcgi_unsubscribe,
4286 .shutr = fcgi_shutr,
4287 .shutw = fcgi_shutw,
Olivier Houchard9b8e11e2019-10-25 16:19:26 +02004288 .ctl = fcgi_ctl,
Christopher Faulet99eff652019-08-11 23:11:30 +02004289 .show_fd = fcgi_show_fd,
Olivier Houcharda41bb0b2020-03-10 18:46:06 +01004290 .takeover = fcgi_takeover,
Christopher Fauleta4600572021-03-08 15:28:28 +01004291 .flags = MX_FL_HTX|MX_FL_HOL_RISK|MX_FL_NO_UPG,
Christopher Faulet99eff652019-08-11 23:11:30 +02004292 .name = "FCGI",
4293};
4294
4295
4296/* this mux registers FCGI proto */
4297static struct mux_proto_list mux_proto_fcgi =
4298{ .token = IST("fcgi"), .mode = PROTO_MODE_HTTP, .side = PROTO_SIDE_BE, .mux = &mux_fcgi_ops };
4299
4300INITCALL1(STG_REGISTER, register_mux_proto, &mux_proto_fcgi);
4301
4302/*
4303 * Local variables:
4304 * c-indent-level: 8
4305 * c-basic-offset: 8
4306 * End:
4307 */