blob: 3cf1f021ffbaf9a4f19eadac4eaca9a9340313f1 [file] [log] [blame]
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001/*
2 * Stream processing offload engine management.
3 *
4 * Copyright 2016 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#include <ctype.h>
13#include <errno.h>
14
Willy Tarreaudcc048a2020-06-04 19:11:43 +020015#include <haproxy/acl.h>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020016#include <haproxy/applet.h>
Willy Tarreau122eba92020-06-04 10:15:32 +020017#include <haproxy/action-t.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020018#include <haproxy/api.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020019#include <haproxy/arg.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020020#include <haproxy/cfgparse.h>
Tim Duesterhus75e2f8d2021-09-16 17:38:26 +020021#include <haproxy/check.h>
Willy Tarreauc7babd82020-06-04 21:29:29 +020022#include <haproxy/filters.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020023#include <haproxy/freq_ctr.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020024#include <haproxy/frontend.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020025#include <haproxy/global.h>
Willy Tarreauc761f842020-06-04 11:40:28 +020026#include <haproxy/http_rules.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020027#include <haproxy/log.h>
Willy Tarreaud0ef4392020-06-02 09:38:52 +020028#include <haproxy/pool.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020029#include <haproxy/proxy.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020030#include <haproxy/sample.h>
Willy Tarreau5edca2f2022-05-27 09:25:10 +020031#include <haproxy/sc_strm.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020032#include <haproxy/session.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020033#include <haproxy/signal.h>
Christopher Faulet1d7d0f82021-02-19 10:56:41 +010034#include <haproxy/sink.h>
Willy Tarreau6c58ab02020-06-04 22:35:49 +020035#include <haproxy/spoe.h>
Willy Tarreaucb086c62022-05-27 09:47:12 +020036#include <haproxy/stconn.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020037#include <haproxy/stream.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020038#include <haproxy/task.h>
Willy Tarreau8b550af2020-06-04 17:42:48 +020039#include <haproxy/tcp_rules.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <haproxy/thread.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020041#include <haproxy/time.h>
Willy Tarreaue16ada12021-05-08 12:57:17 +020042#include <haproxy/tools.h>
Willy Tarreaua1718922020-06-04 16:25:31 +020043#include <haproxy/vars.h>
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +020044
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +020045
46#if defined(DEBUG_SPOE) || defined(DEBUG_FULL)
47#define SPOE_PRINTF(x...) fprintf(x)
Christopher Fauletb077cdc2018-01-24 16:37:57 +010048#define SPOE_DEBUG_STMT(statement) statement
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +020049#else
50#define SPOE_PRINTF(x...)
Christopher Fauletb077cdc2018-01-24 16:37:57 +010051#define SPOE_DEBUG_STMT(statement)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +020052#endif
53
Christopher Faulet7aa0b2b2017-01-13 11:30:50 +010054/* Reserved 4 bytes to the frame size. So a frame and its size can be written
55 * together in a buffer */
56#define MAX_FRAME_SIZE global.tune.bufsize - 4
57
58/* The minimum size for a frame */
59#define MIN_FRAME_SIZE 256
60
Christopher Fauletf51f5fa2017-01-19 10:01:12 +010061/* Reserved for the metadata and the frame type.
62 * So <MAX_FRAME_SIZE> - <FRAME_HDR_SIZE> is the maximum payload size */
Christopher Faulet7aa0b2b2017-01-13 11:30:50 +010063#define FRAME_HDR_SIZE 32
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +020064
Christopher Fauletf51f5fa2017-01-19 10:01:12 +010065/* Helper to get SPOE ctx inside an appctx */
Willy Tarreau23a24072022-05-05 20:18:44 +020066#define SPOE_APPCTX(appctx) ((struct spoe_appctx *)((appctx)->svcctx))
Christopher Faulet42bfa462017-01-04 14:14:19 +010067
Christopher Faulet3b386a32017-02-23 10:17:15 +010068/* SPOE filter id. Used to identify SPOE filters */
69const char *spoe_filter_id = "SPOE filter";
70
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +020071/* Set if the handle on SIGUSR1 is registered */
72static int sighandler_registered = 0;
73
74/* proxy used during the parsing */
75struct proxy *curproxy = NULL;
76
77/* The name of the SPOE engine, used during the parsing */
78char *curengine = NULL;
79
80/* SPOE agent used during the parsing */
Christopher Faulet11610f32017-09-21 10:23:10 +020081/* SPOE agent/group/message used during the parsing */
82struct spoe_agent *curagent = NULL;
83struct spoe_group *curgrp = NULL;
84struct spoe_message *curmsg = NULL;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +020085
86/* list of SPOE messages and placeholders used during the parsing */
87struct list curmsgs;
Christopher Faulet11610f32017-09-21 10:23:10 +020088struct list curgrps;
89struct list curmphs;
90struct list curgphs;
Christopher Faulet336d3ef2017-12-22 10:00:55 +010091struct list curvars;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +020092
Christopher Faulet7250b8f2018-03-26 17:19:01 +020093/* list of log servers used during the parsing */
94struct list curlogsrvs;
95
Christopher Faulet0e0f0852018-03-26 17:20:36 +020096/* agent's proxy flags (PR_O_* and PR_O2_*) used during parsing */
97int curpxopts;
98int curpxopts2;
99
Christopher Faulet42bfa462017-01-04 14:14:19 +0100100/* Pools used to allocate SPOE structs */
Willy Tarreau8ceae722018-11-26 11:58:30 +0100101DECLARE_STATIC_POOL(pool_head_spoe_ctx, "spoe_ctx", sizeof(struct spoe_context));
102DECLARE_STATIC_POOL(pool_head_spoe_appctx, "spoe_appctx", sizeof(struct spoe_appctx));
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200103
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200104struct flt_ops spoe_ops;
105
Christopher Faulet8ef75252017-02-20 22:56:03 +0100106static int spoe_queue_context(struct spoe_context *ctx);
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200107static int spoe_acquire_buffer(struct buffer *buf, struct buffer_wait *buffer_wait);
108static void spoe_release_buffer(struct buffer *buf, struct buffer_wait *buffer_wait);
Christopher Faulet6f1296b2021-08-02 17:53:56 +0200109static struct appctx *spoe_create_appctx(struct spoe_config *conf);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200110
111/********************************************************************
112 * helper functions/globals
113 ********************************************************************/
114static void
Christopher Faulet11610f32017-09-21 10:23:10 +0200115spoe_release_placeholder(struct spoe_placeholder *ph)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200116{
Christopher Faulet11610f32017-09-21 10:23:10 +0200117 if (!ph)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200118 return;
Christopher Faulet11610f32017-09-21 10:23:10 +0200119 free(ph->id);
120 free(ph);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200121}
122
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200123static void
Christopher Faulet8ef75252017-02-20 22:56:03 +0100124spoe_release_message(struct spoe_message *msg)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200125{
Christopher Faulet57583e42017-09-04 15:41:09 +0200126 struct spoe_arg *arg, *argback;
127 struct acl *acl, *aclback;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200128
129 if (!msg)
130 return;
131 free(msg->id);
132 free(msg->conf.file);
Christopher Faulet57583e42017-09-04 15:41:09 +0200133 list_for_each_entry_safe(arg, argback, &msg->args, list) {
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200134 release_sample_expr(arg->expr);
135 free(arg->name);
Willy Tarreau2b718102021-04-21 07:32:39 +0200136 LIST_DELETE(&arg->list);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200137 free(arg);
138 }
Christopher Faulet57583e42017-09-04 15:41:09 +0200139 list_for_each_entry_safe(acl, aclback, &msg->acls, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200140 LIST_DELETE(&acl->list);
Christopher Faulet57583e42017-09-04 15:41:09 +0200141 prune_acl(acl);
142 free(acl);
143 }
144 if (msg->cond) {
145 prune_acl_cond(msg->cond);
146 free(msg->cond);
147 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200148 free(msg);
149}
150
151static void
Christopher Faulet11610f32017-09-21 10:23:10 +0200152spoe_release_group(struct spoe_group *grp)
153{
154 if (!grp)
155 return;
156 free(grp->id);
157 free(grp->conf.file);
158 free(grp);
159}
160
161static void
Christopher Faulet8ef75252017-02-20 22:56:03 +0100162spoe_release_agent(struct spoe_agent *agent)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200163{
Christopher Faulet11610f32017-09-21 10:23:10 +0200164 struct spoe_message *msg, *msgback;
165 struct spoe_group *grp, *grpback;
Christopher Faulet24289f22017-09-25 14:48:02 +0200166 int i;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200167
168 if (!agent)
169 return;
170 free(agent->id);
171 free(agent->conf.file);
172 free(agent->var_pfx);
Christopher Faulet985532d2016-11-16 15:36:19 +0100173 free(agent->var_on_error);
Christopher Faulet36bda1c2018-03-22 09:08:20 +0100174 free(agent->var_t_process);
175 free(agent->var_t_total);
Christopher Faulet11610f32017-09-21 10:23:10 +0200176 list_for_each_entry_safe(msg, msgback, &agent->messages, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200177 LIST_DELETE(&msg->list);
Christopher Faulet11610f32017-09-21 10:23:10 +0200178 spoe_release_message(msg);
179 }
180 list_for_each_entry_safe(grp, grpback, &agent->groups, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200181 LIST_DELETE(&grp->list);
Christopher Faulet11610f32017-09-21 10:23:10 +0200182 spoe_release_group(grp);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200183 }
Willy Tarreau3ddcf762019-02-07 14:22:52 +0100184 if (agent->rt) {
Christopher Fauletb1bb1af2019-09-17 11:55:52 +0200185 for (i = 0; i < global.nbthread; ++i) {
186 free(agent->rt[i].engine_id);
Willy Tarreau3ddcf762019-02-07 14:22:52 +0100187 HA_SPIN_DESTROY(&agent->rt[i].lock);
Christopher Fauletb1bb1af2019-09-17 11:55:52 +0200188 }
Willy Tarreau3ddcf762019-02-07 14:22:52 +0100189 }
Christopher Faulet24289f22017-09-25 14:48:02 +0200190 free(agent->rt);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200191 free(agent);
192}
193
194static const char *spoe_frm_err_reasons[SPOE_FRM_ERRS] = {
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100195 [SPOE_FRM_ERR_NONE] = "normal",
196 [SPOE_FRM_ERR_IO] = "I/O error",
197 [SPOE_FRM_ERR_TOUT] = "a timeout occurred",
198 [SPOE_FRM_ERR_TOO_BIG] = "frame is too big",
199 [SPOE_FRM_ERR_INVALID] = "invalid frame received",
200 [SPOE_FRM_ERR_NO_VSN] = "version value not found",
201 [SPOE_FRM_ERR_NO_FRAME_SIZE] = "max-frame-size value not found",
202 [SPOE_FRM_ERR_NO_CAP] = "capabilities value not found",
203 [SPOE_FRM_ERR_BAD_VSN] = "unsupported version",
204 [SPOE_FRM_ERR_BAD_FRAME_SIZE] = "max-frame-size too big or too small",
205 [SPOE_FRM_ERR_FRAG_NOT_SUPPORTED] = "fragmentation not supported",
206 [SPOE_FRM_ERR_INTERLACED_FRAMES] = "invalid interlaced frames",
Christopher Faulet8eda93f2017-02-09 09:44:33 +0100207 [SPOE_FRM_ERR_FRAMEID_NOTFOUND] = "frame-id not found",
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100208 [SPOE_FRM_ERR_RES] = "resource allocation error",
209 [SPOE_FRM_ERR_UNKNOWN] = "an unknown error occurred",
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200210};
211
212static const char *spoe_event_str[SPOE_EV_EVENTS] = {
213 [SPOE_EV_ON_CLIENT_SESS] = "on-client-session",
214 [SPOE_EV_ON_TCP_REQ_FE] = "on-frontend-tcp-request",
215 [SPOE_EV_ON_TCP_REQ_BE] = "on-backend-tcp-request",
216 [SPOE_EV_ON_HTTP_REQ_FE] = "on-frontend-http-request",
217 [SPOE_EV_ON_HTTP_REQ_BE] = "on-backend-http-request",
218
219 [SPOE_EV_ON_SERVER_SESS] = "on-server-session",
220 [SPOE_EV_ON_TCP_RSP] = "on-tcp-response",
221 [SPOE_EV_ON_HTTP_RSP] = "on-http-response",
222};
223
224
225#if defined(DEBUG_SPOE) || defined(DEBUG_FULL)
226
227static const char *spoe_ctx_state_str[SPOE_CTX_ST_ERROR+1] = {
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100228 [SPOE_CTX_ST_NONE] = "NONE",
229 [SPOE_CTX_ST_READY] = "READY",
230 [SPOE_CTX_ST_ENCODING_MSGS] = "ENCODING_MSGS",
231 [SPOE_CTX_ST_SENDING_MSGS] = "SENDING_MSGS",
232 [SPOE_CTX_ST_WAITING_ACK] = "WAITING_ACK",
233 [SPOE_CTX_ST_DONE] = "DONE",
234 [SPOE_CTX_ST_ERROR] = "ERROR",
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200235};
236
237static const char *spoe_appctx_state_str[SPOE_APPCTX_ST_END+1] = {
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100238 [SPOE_APPCTX_ST_CONNECT] = "CONNECT",
239 [SPOE_APPCTX_ST_CONNECTING] = "CONNECTING",
240 [SPOE_APPCTX_ST_IDLE] = "IDLE",
241 [SPOE_APPCTX_ST_PROCESSING] = "PROCESSING",
242 [SPOE_APPCTX_ST_SENDING_FRAG_NOTIFY] = "SENDING_FRAG_NOTIFY",
243 [SPOE_APPCTX_ST_WAITING_SYNC_ACK] = "WAITING_SYNC_ACK",
244 [SPOE_APPCTX_ST_DISCONNECT] = "DISCONNECT",
245 [SPOE_APPCTX_ST_DISCONNECTING] = "DISCONNECTING",
246 [SPOE_APPCTX_ST_EXIT] = "EXIT",
247 [SPOE_APPCTX_ST_END] = "END",
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200248};
249
250#endif
Christopher Fauleta1cda022016-12-21 08:58:06 +0100251
Christopher Faulet8ef75252017-02-20 22:56:03 +0100252/* Used to generates a unique id for an engine. On success, it returns a
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500253 * allocated string. So it is the caller's responsibility to release it. If the
Christopher Faulet8ef75252017-02-20 22:56:03 +0100254 * allocation failed, it returns NULL. */
Christopher Fauleta1cda022016-12-21 08:58:06 +0100255static char *
256generate_pseudo_uuid()
257{
Willy Tarreauee3bcdd2020-03-08 17:48:17 +0100258 ha_generate_uuid(&trash);
Kevin Zhu079f8082020-03-13 10:39:51 +0800259 return my_strndup(trash.area, trash.data);
Christopher Fauleta1cda022016-12-21 08:58:06 +0100260}
261
Christopher Fauletb2dd1e02018-03-22 09:07:41 +0100262
263static inline void
264spoe_update_stat_time(struct timeval *tv, long *t)
265{
266 if (*t == -1)
267 *t = tv_ms_elapsed(tv, &now);
268 else
269 *t += tv_ms_elapsed(tv, &now);
270 tv_zero(tv);
271}
272
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200273/********************************************************************
274 * Functions that encode/decode SPOE frames
275 ********************************************************************/
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200276/* Helper to get static string length, excluding the terminating null byte */
277#define SLEN(str) (sizeof(str)-1)
278
279/* Predefined key used in HELLO/DISCONNECT frames */
280#define SUPPORTED_VERSIONS_KEY "supported-versions"
281#define VERSION_KEY "version"
282#define MAX_FRAME_SIZE_KEY "max-frame-size"
283#define CAPABILITIES_KEY "capabilities"
Christopher Fauleta1cda022016-12-21 08:58:06 +0100284#define ENGINE_ID_KEY "engine-id"
Christopher Fauletba7bc162016-11-07 21:07:38 +0100285#define HEALTHCHECK_KEY "healthcheck"
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200286#define STATUS_CODE_KEY "status-code"
287#define MSG_KEY "message"
288
289struct spoe_version {
290 char *str;
291 int min;
292 int max;
293};
294
295/* All supported versions */
296static struct spoe_version supported_versions[] = {
Christopher Faulet63816502018-05-31 14:56:42 +0200297 /* 1.0 is now unsupported because of a bug about frame's flags*/
298 {"2.0", 2000, 2000},
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200299 {NULL, 0, 0}
300};
301
302/* Comma-separated list of supported versions */
Christopher Faulet63816502018-05-31 14:56:42 +0200303#define SUPPORTED_VERSIONS_VAL "2.0"
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200304
Christopher Faulet8ef75252017-02-20 22:56:03 +0100305/* Convert a string to a SPOE version value. The string must follow the format
306 * "MAJOR.MINOR". It will be concerted into the integer (1000 * MAJOR + MINOR).
307 * If an error occurred, -1 is returned. */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200308static int
Christopher Faulet8ef75252017-02-20 22:56:03 +0100309spoe_str_to_vsn(const char *str, size_t len)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200310{
Christopher Faulet8ef75252017-02-20 22:56:03 +0100311 const char *p, *end;
312 int maj, min, vsn;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200313
Christopher Faulet8ef75252017-02-20 22:56:03 +0100314 p = str;
315 end = str+len;
316 maj = min = 0;
317 vsn = -1;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200318
Christopher Faulet8ef75252017-02-20 22:56:03 +0100319 /* skip leading spaces */
Willy Tarreau90807112020-02-25 08:16:33 +0100320 while (p < end && isspace((unsigned char)*p))
Christopher Faulet8ef75252017-02-20 22:56:03 +0100321 p++;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200322
Christopher Faulet8ef75252017-02-20 22:56:03 +0100323 /* parse Major number, until the '.' */
324 while (*p != '.') {
325 if (p >= end || *p < '0' || *p > '9')
326 goto out;
327 maj *= 10;
328 maj += (*p - '0');
329 p++;
330 }
331
332 /* check Major version */
333 if (!maj)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200334 goto out;
335
Christopher Faulet8ef75252017-02-20 22:56:03 +0100336 p++; /* skip the '.' */
337 if (p >= end || *p < '0' || *p > '9') /* Minor number is missing */
338 goto out;
339
340 /* Parse Minor number */
341 while (p < end) {
342 if (*p < '0' || *p > '9')
343 break;
344 min *= 10;
345 min += (*p - '0');
346 p++;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200347 }
Christopher Faulet8ef75252017-02-20 22:56:03 +0100348
349 /* check Minor number */
350 if (min > 999)
351 goto out;
352
353 /* skip trailing spaces */
Willy Tarreau90807112020-02-25 08:16:33 +0100354 while (p < end && isspace((unsigned char)*p))
Christopher Faulet8ef75252017-02-20 22:56:03 +0100355 p++;
356 if (p != end)
357 goto out;
358
359 vsn = maj * 1000 + min;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200360 out:
361 return vsn;
362}
363
Christopher Faulet8ef75252017-02-20 22:56:03 +0100364/* Encode the HELLO frame sent by HAProxy to an agent. It returns the number of
Joseph Herlantf7f60312018-11-15 13:46:49 -0800365 * encoded bytes in the frame on success, 0 if an encoding error occurred and -1
Christopher Faulet8ef75252017-02-20 22:56:03 +0100366 * if a fatal error occurred. */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200367static int
Christopher Faulet8ef75252017-02-20 22:56:03 +0100368spoe_prepare_hahello_frame(struct appctx *appctx, char *frame, size_t size)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200369{
Willy Tarreau83061a82018-07-13 11:56:34 +0200370 struct buffer *chk;
Christopher Faulet42bfa462017-01-04 14:14:19 +0100371 struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100372 char *p, *end;
373 unsigned int flags = SPOE_FRM_FL_FIN;
374 size_t sz;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200375
Christopher Faulet8ef75252017-02-20 22:56:03 +0100376 p = frame;
377 end = frame+size;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200378
Christopher Faulet8ef75252017-02-20 22:56:03 +0100379 /* Set Frame type */
380 *p++ = SPOE_FRM_T_HAPROXY_HELLO;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200381
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100382 /* Set flags */
Thierry FOURNIERc4dcaff2018-05-18 12:25:39 +0200383 flags = htonl(flags);
Christopher Faulet8ef75252017-02-20 22:56:03 +0100384 memcpy(p, (char *)&flags, 4);
385 p += 4;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200386
387 /* No stream-id and frame-id for HELLO frames */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100388 *p++ = 0; *p++ = 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200389
390 /* There are 3 mandatory items: "supported-versions", "max-frame-size"
391 * and "capabilities" */
392
393 /* "supported-versions" K/V item */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100394 sz = SLEN(SUPPORTED_VERSIONS_KEY);
395 if (spoe_encode_buffer(SUPPORTED_VERSIONS_KEY, sz, &p, end) == -1)
396 goto too_big;
397
398 *p++ = SPOE_DATA_T_STR;
399 sz = SLEN(SUPPORTED_VERSIONS_VAL);
400 if (spoe_encode_buffer(SUPPORTED_VERSIONS_VAL, sz, &p, end) == -1)
401 goto too_big;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200402
403 /* "max-fram-size" K/V item */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100404 sz = SLEN(MAX_FRAME_SIZE_KEY);
405 if (spoe_encode_buffer(MAX_FRAME_SIZE_KEY, sz, &p, end) == -1)
406 goto too_big;
407
408 *p++ = SPOE_DATA_T_UINT32;
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200409 if (encode_varint(SPOE_APPCTX(appctx)->max_frame_size, &p, end) == -1)
Christopher Faulet8ef75252017-02-20 22:56:03 +0100410 goto too_big;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200411
412 /* "capabilities" K/V item */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100413 sz = SLEN(CAPABILITIES_KEY);
414 if (spoe_encode_buffer(CAPABILITIES_KEY, sz, &p, end) == -1)
415 goto too_big;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200416
Christopher Faulet8ef75252017-02-20 22:56:03 +0100417 *p++ = SPOE_DATA_T_STR;
Christopher Faulet305c6072017-02-23 16:17:53 +0100418 chk = get_trash_chunk();
419 if (agent != NULL && (agent->flags & SPOE_FL_PIPELINING)) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200420 memcpy(chk->area, "pipelining", 10);
421 chk->data += 10;
Christopher Faulet305c6072017-02-23 16:17:53 +0100422 }
423 if (agent != NULL && (agent->flags & SPOE_FL_ASYNC)) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200424 if (chk->data) chk->area[chk->data++] = ',';
425 memcpy(chk->area+chk->data, "async", 5);
426 chk->data += 5;
Christopher Faulet305c6072017-02-23 16:17:53 +0100427 }
Christopher Fauletcecd8522017-02-24 22:11:21 +0100428 if (agent != NULL && (agent->flags & SPOE_FL_RCV_FRAGMENTATION)) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200429 if (chk->data) chk->area[chk->data++] = ',';
430 memcpy(chk->area+chk->data, "fragmentation", 13);
Miroslav Zagorac6b3690b2019-01-13 16:55:01 +0100431 chk->data += 13;
Christopher Fauletcecd8522017-02-24 22:11:21 +0100432 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200433 if (spoe_encode_buffer(chk->area, chk->data, &p, end) == -1)
Christopher Faulet8ef75252017-02-20 22:56:03 +0100434 goto too_big;
435
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500436 /* (optional) "engine-id" K/V item, if present */
Christopher Fauletb1bb1af2019-09-17 11:55:52 +0200437 if (agent != NULL && agent->rt[tid].engine_id != NULL) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100438 sz = SLEN(ENGINE_ID_KEY);
439 if (spoe_encode_buffer(ENGINE_ID_KEY, sz, &p, end) == -1)
440 goto too_big;
441
442 *p++ = SPOE_DATA_T_STR;
Christopher Fauletb1bb1af2019-09-17 11:55:52 +0200443 sz = strlen(agent->rt[tid].engine_id);
444 if (spoe_encode_buffer(agent->rt[tid].engine_id, sz, &p, end) == -1)
Christopher Faulet8ef75252017-02-20 22:56:03 +0100445 goto too_big;
Christopher Fauleta1cda022016-12-21 08:58:06 +0100446 }
447
Christopher Faulet8ef75252017-02-20 22:56:03 +0100448 return (p - frame);
449
450 too_big:
451 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOO_BIG;
452 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200453}
454
Christopher Faulet8ef75252017-02-20 22:56:03 +0100455/* Encode DISCONNECT frame sent by HAProxy to an agent. It returns the number of
456 * encoded bytes in the frame on success, 0 if an encoding error occurred and -1
457 * if a fatal error occurred. */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200458static int
Christopher Faulet8ef75252017-02-20 22:56:03 +0100459spoe_prepare_hadiscon_frame(struct appctx *appctx, char *frame, size_t size)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200460{
Christopher Faulet8ef75252017-02-20 22:56:03 +0100461 const char *reason;
462 char *p, *end;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100463 unsigned int flags = SPOE_FRM_FL_FIN;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100464 size_t sz;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200465
Christopher Faulet8ef75252017-02-20 22:56:03 +0100466 p = frame;
467 end = frame+size;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200468
Christopher Faulet8ef75252017-02-20 22:56:03 +0100469 /* Set Frame type */
470 *p++ = SPOE_FRM_T_HAPROXY_DISCON;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200471
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100472 /* Set flags */
Thierry FOURNIERc4dcaff2018-05-18 12:25:39 +0200473 flags = htonl(flags);
Christopher Faulet8ef75252017-02-20 22:56:03 +0100474 memcpy(p, (char *)&flags, 4);
475 p += 4;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200476
477 /* No stream-id and frame-id for DISCONNECT frames */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100478 *p++ = 0; *p++ = 0;
479
480 if (SPOE_APPCTX(appctx)->status_code >= SPOE_FRM_ERRS)
481 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_UNKNOWN;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200482
483 /* There are 2 mandatory items: "status-code" and "message" */
484
485 /* "status-code" K/V item */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100486 sz = SLEN(STATUS_CODE_KEY);
487 if (spoe_encode_buffer(STATUS_CODE_KEY, sz, &p, end) == -1)
488 goto too_big;
489
490 *p++ = SPOE_DATA_T_UINT32;
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200491 if (encode_varint(SPOE_APPCTX(appctx)->status_code, &p, end) == -1)
Christopher Faulet8ef75252017-02-20 22:56:03 +0100492 goto too_big;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200493
494 /* "message" K/V item */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100495 sz = SLEN(MSG_KEY);
496 if (spoe_encode_buffer(MSG_KEY, sz, &p, end) == -1)
497 goto too_big;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200498
Christopher Faulet8ef75252017-02-20 22:56:03 +0100499 /*Get the message corresponding to the status code */
500 reason = spoe_frm_err_reasons[SPOE_APPCTX(appctx)->status_code];
501
502 *p++ = SPOE_DATA_T_STR;
503 sz = strlen(reason);
504 if (spoe_encode_buffer(reason, sz, &p, end) == -1)
505 goto too_big;
506
507 return (p - frame);
508
509 too_big:
510 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOO_BIG;
511 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200512}
513
Christopher Faulet8ef75252017-02-20 22:56:03 +0100514/* Encode the NOTIFY frame sent by HAProxy to an agent. It returns the number of
515 * encoded bytes in the frame on success, 0 if an encoding error occurred and -1
516 * if a fatal error occurred. */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200517static int
Christopher Faulet8ef75252017-02-20 22:56:03 +0100518spoe_prepare_hanotify_frame(struct appctx *appctx, struct spoe_context *ctx,
Christopher Fauleta1cda022016-12-21 08:58:06 +0100519 char *frame, size_t size)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200520{
Christopher Faulet8ef75252017-02-20 22:56:03 +0100521 char *p, *end;
522 unsigned int stream_id, frame_id;
523 unsigned int flags = SPOE_FRM_FL_FIN;
524 size_t sz;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200525
Christopher Faulet8ef75252017-02-20 22:56:03 +0100526 p = frame;
527 end = frame+size;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200528
Christopher Fauletf032c3e2017-02-17 15:18:35 +0100529 stream_id = ctx->stream_id;
530 frame_id = ctx->frame_id;
531
532 if (ctx->flags & SPOE_CTX_FL_FRAGMENTED) {
533 /* The fragmentation is not supported by the applet */
534 if (!(SPOE_APPCTX(appctx)->flags & SPOE_APPCTX_FL_FRAGMENTATION)) {
535 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_FRAG_NOT_SUPPORTED;
536 return -1;
537 }
538 flags = ctx->frag_ctx.flags;
539 }
540
541 /* Set Frame type */
542 *p++ = SPOE_FRM_T_HAPROXY_NOTIFY;
543
544 /* Set flags */
Thierry FOURNIERc4dcaff2018-05-18 12:25:39 +0200545 flags = htonl(flags);
Christopher Fauletf032c3e2017-02-17 15:18:35 +0100546 memcpy(p, (char *)&flags, 4);
547 p += 4;
548
549 /* Set stream-id and frame-id */
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200550 if (encode_varint(stream_id, &p, end) == -1)
Christopher Fauletf032c3e2017-02-17 15:18:35 +0100551 goto too_big;
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200552 if (encode_varint(frame_id, &p, end) == -1)
Christopher Fauletf032c3e2017-02-17 15:18:35 +0100553 goto too_big;
554
555 /* Copy encoded messages, if possible */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200556 sz = b_data(&ctx->buffer);
Christopher Fauletf032c3e2017-02-17 15:18:35 +0100557 if (p + sz >= end)
558 goto too_big;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200559 memcpy(p, b_head(&ctx->buffer), sz);
Christopher Fauletf032c3e2017-02-17 15:18:35 +0100560 p += sz;
561
562 return (p - frame);
563
564 too_big:
565 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOO_BIG;
566 return 0;
567}
568
569/* Encode next part of a fragmented frame sent by HAProxy to an agent. It
570 * returns the number of encoded bytes in the frame on success, 0 if an encoding
571 * error occurred and -1 if a fatal error occurred. */
572static int
573spoe_prepare_hafrag_frame(struct appctx *appctx, struct spoe_context *ctx,
574 char *frame, size_t size)
575{
576 char *p, *end;
577 unsigned int stream_id, frame_id;
578 unsigned int flags;
579 size_t sz;
580
581 p = frame;
582 end = frame+size;
583
Christopher Faulet8ef75252017-02-20 22:56:03 +0100584 /* <ctx> is null when the stream has aborted the processing of a
585 * fragmented frame. In this case, we must notify the corresponding
586 * agent using ids stored in <frag_ctx>. */
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100587 if (ctx == NULL) {
Christopher Fauletf032c3e2017-02-17 15:18:35 +0100588 flags = (SPOE_FRM_FL_FIN|SPOE_FRM_FL_ABRT);
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100589 stream_id = SPOE_APPCTX(appctx)->frag_ctx.cursid;
590 frame_id = SPOE_APPCTX(appctx)->frag_ctx.curfid;
591 }
592 else {
Christopher Fauletf032c3e2017-02-17 15:18:35 +0100593 flags = ctx->frag_ctx.flags;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100594 stream_id = ctx->stream_id;
595 frame_id = ctx->frame_id;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100596 }
597
Christopher Faulet8ef75252017-02-20 22:56:03 +0100598 /* Set Frame type */
Christopher Fauletf032c3e2017-02-17 15:18:35 +0100599 *p++ = SPOE_FRM_T_UNSET;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100600
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100601 /* Set flags */
Thierry FOURNIERc4dcaff2018-05-18 12:25:39 +0200602 flags = htonl(flags);
Christopher Faulet8ef75252017-02-20 22:56:03 +0100603 memcpy(p, (char *)&flags, 4);
604 p += 4;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200605
606 /* Set stream-id and frame-id */
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200607 if (encode_varint(stream_id, &p, end) == -1)
Christopher Faulet8ef75252017-02-20 22:56:03 +0100608 goto too_big;
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200609 if (encode_varint(frame_id, &p, end) == -1)
Christopher Faulet8ef75252017-02-20 22:56:03 +0100610 goto too_big;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200611
Christopher Fauletf032c3e2017-02-17 15:18:35 +0100612 if (ctx == NULL)
613 goto end;
614
Christopher Faulet8ef75252017-02-20 22:56:03 +0100615 /* Copy encoded messages, if possible */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200616 sz = b_data(&ctx->buffer);
Christopher Faulet8ef75252017-02-20 22:56:03 +0100617 if (p + sz >= end)
618 goto too_big;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200619 memcpy(p, b_head(&ctx->buffer), sz);
Christopher Faulet8ef75252017-02-20 22:56:03 +0100620 p += sz;
Christopher Fauleta1cda022016-12-21 08:58:06 +0100621
Christopher Fauletf032c3e2017-02-17 15:18:35 +0100622 end:
Christopher Faulet8ef75252017-02-20 22:56:03 +0100623 return (p - frame);
624
625 too_big:
626 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOO_BIG;
627 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200628}
629
Christopher Faulet8ef75252017-02-20 22:56:03 +0100630/* Decode and process the HELLO frame sent by an agent. It returns the number of
631 * read bytes on success, 0 if a decoding error occurred, and -1 if a fatal
632 * error occurred. */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200633static int
Christopher Faulet8ef75252017-02-20 22:56:03 +0100634spoe_handle_agenthello_frame(struct appctx *appctx, char *frame, size_t size)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200635{
Christopher Faulet305c6072017-02-23 16:17:53 +0100636 struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent;
637 char *p, *end;
638 int vsn, max_frame_size;
639 unsigned int flags;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100640
641 p = frame;
642 end = frame + size;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200643
644 /* Check frame type */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100645 if (*p++ != SPOE_FRM_T_AGENT_HELLO) {
646 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200647 return 0;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100648 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200649
Christopher Faulet8ef75252017-02-20 22:56:03 +0100650 if (size < 7 /* TYPE + METADATA */) {
651 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
652 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200653 }
654
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100655 /* Retrieve flags */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100656 memcpy((char *)&flags, p, 4);
Thierry FOURNIERc4dcaff2018-05-18 12:25:39 +0200657 flags = ntohl(flags);
Christopher Faulet8ef75252017-02-20 22:56:03 +0100658 p += 4;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200659
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100660 /* Fragmentation is not supported for HELLO frame */
661 if (!(flags & SPOE_FRM_FL_FIN)) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100662 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_FRAG_NOT_SUPPORTED;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100663 return -1;
664 }
665
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200666 /* stream-id and frame-id must be cleared */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100667 if (*p != 0 || *(p+1) != 0) {
668 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
669 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200670 }
Christopher Faulet8ef75252017-02-20 22:56:03 +0100671 p += 2;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200672
673 /* There are 3 mandatory items: "version", "max-frame-size" and
674 * "capabilities" */
675
676 /* Loop on K/V items */
Christopher Fauleta1cda022016-12-21 08:58:06 +0100677 vsn = max_frame_size = flags = 0;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100678 while (p < end) {
679 char *str;
Frédéric Lécaille6ca71a92017-08-22 10:33:14 +0200680 uint64_t sz;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100681 int ret;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200682
683 /* Decode the item key */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100684 ret = spoe_decode_buffer(&p, end, &str, &sz);
685 if (ret == -1 || !sz) {
686 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
687 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200688 }
Christopher Faulet8ef75252017-02-20 22:56:03 +0100689
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200690 /* Check "version" K/V item */
Willy Tarreauda21ed12020-06-16 17:58:14 +0200691 if (sz >= strlen(VERSION_KEY) && !memcmp(str, VERSION_KEY, strlen(VERSION_KEY))) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100692 int i, type = *p++;
693
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200694 /* The value must be a string */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100695 if ((type & SPOE_DATA_T_MASK) != SPOE_DATA_T_STR) {
696 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
697 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200698 }
Christopher Faulet8ef75252017-02-20 22:56:03 +0100699 if (spoe_decode_buffer(&p, end, &str, &sz) == -1) {
700 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
701 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200702 }
703
Christopher Faulet8ef75252017-02-20 22:56:03 +0100704 vsn = spoe_str_to_vsn(str, sz);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200705 if (vsn == -1) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100706 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_BAD_VSN;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200707 return -1;
708 }
709 for (i = 0; supported_versions[i].str != NULL; ++i) {
710 if (vsn >= supported_versions[i].min &&
711 vsn <= supported_versions[i].max)
712 break;
713 }
714 if (supported_versions[i].str == NULL) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100715 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_BAD_VSN;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200716 return -1;
717 }
718 }
719 /* Check "max-frame-size" K/V item */
Willy Tarreauda21ed12020-06-16 17:58:14 +0200720 else if (sz >= strlen(MAX_FRAME_SIZE_KEY) && !memcmp(str, MAX_FRAME_SIZE_KEY, strlen(MAX_FRAME_SIZE_KEY))) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100721 int type = *p++;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200722
723 /* The value must be integer */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200724 if ((type & SPOE_DATA_T_MASK) != SPOE_DATA_T_INT32 &&
725 (type & SPOE_DATA_T_MASK) != SPOE_DATA_T_INT64 &&
726 (type & SPOE_DATA_T_MASK) != SPOE_DATA_T_UINT32 &&
727 (type & SPOE_DATA_T_MASK) != SPOE_DATA_T_UINT64) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100728 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
729 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200730 }
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200731 if (decode_varint(&p, end, &sz) == -1) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100732 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
733 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200734 }
Christopher Faulet8ef75252017-02-20 22:56:03 +0100735 if (sz < MIN_FRAME_SIZE ||
736 sz > SPOE_APPCTX(appctx)->max_frame_size) {
737 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_BAD_FRAME_SIZE;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200738 return -1;
739 }
740 max_frame_size = sz;
741 }
Christopher Fauleta1cda022016-12-21 08:58:06 +0100742 /* Check "capabilities" K/V item */
Willy Tarreauda21ed12020-06-16 17:58:14 +0200743 else if (sz >= strlen(CAPABILITIES_KEY) && !memcmp(str, CAPABILITIES_KEY, strlen(CAPABILITIES_KEY))) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100744 int type = *p++;
Christopher Fauleta1cda022016-12-21 08:58:06 +0100745
746 /* The value must be a string */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100747 if ((type & SPOE_DATA_T_MASK) != SPOE_DATA_T_STR) {
748 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
749 return 0;
Christopher Fauleta1cda022016-12-21 08:58:06 +0100750 }
Christopher Faulet8ef75252017-02-20 22:56:03 +0100751 if (spoe_decode_buffer(&p, end, &str, &sz) == -1) {
752 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
753 return 0;
754 }
Christopher Fauleta1cda022016-12-21 08:58:06 +0100755
Christopher Faulet8ef75252017-02-20 22:56:03 +0100756 while (sz) {
Christopher Fauleta1cda022016-12-21 08:58:06 +0100757 char *delim;
758
759 /* Skip leading spaces */
Willy Tarreau90807112020-02-25 08:16:33 +0100760 for (; isspace((unsigned char)*str) && sz; str++, sz--);
Christopher Fauleta1cda022016-12-21 08:58:06 +0100761
Christopher Faulet8ef75252017-02-20 22:56:03 +0100762 if (sz >= 10 && !strncmp(str, "pipelining", 10)) {
763 str += 10; sz -= 10;
Willy Tarreau90807112020-02-25 08:16:33 +0100764 if (!sz || isspace((unsigned char)*str) || *str == ',')
Christopher Fauleta1cda022016-12-21 08:58:06 +0100765 flags |= SPOE_APPCTX_FL_PIPELINING;
766 }
Christopher Faulet8ef75252017-02-20 22:56:03 +0100767 else if (sz >= 5 && !strncmp(str, "async", 5)) {
768 str += 5; sz -= 5;
Willy Tarreau90807112020-02-25 08:16:33 +0100769 if (!sz || isspace((unsigned char)*str) || *str == ',')
Christopher Fauleta1cda022016-12-21 08:58:06 +0100770 flags |= SPOE_APPCTX_FL_ASYNC;
771 }
Christopher Faulet8ef75252017-02-20 22:56:03 +0100772 else if (sz >= 13 && !strncmp(str, "fragmentation", 13)) {
773 str += 13; sz -= 13;
Willy Tarreau90807112020-02-25 08:16:33 +0100774 if (!sz || isspace((unsigned char)*str) || *str == ',')
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100775 flags |= SPOE_APPCTX_FL_FRAGMENTATION;
776 }
Christopher Fauleta1cda022016-12-21 08:58:06 +0100777
Christopher Faulet8ef75252017-02-20 22:56:03 +0100778 /* Get the next comma or break */
779 if (!sz || (delim = memchr(str, ',', sz)) == NULL)
Christopher Fauleta1cda022016-12-21 08:58:06 +0100780 break;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100781 delim++;
782 sz -= (delim - str);
783 str = delim;
Christopher Fauleta1cda022016-12-21 08:58:06 +0100784 }
785 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200786 else {
787 /* Silently ignore unknown item */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100788 if (spoe_skip_data(&p, end) == -1) {
789 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
790 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200791 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200792 }
793 }
794
795 /* Final checks */
796 if (!vsn) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100797 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_NO_VSN;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200798 return -1;
799 }
800 if (!max_frame_size) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100801 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_NO_FRAME_SIZE;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200802 return -1;
803 }
Christopher Faulet11389012019-02-07 16:13:26 +0100804 if (!agent)
805 flags &= ~(SPOE_APPCTX_FL_PIPELINING|SPOE_APPCTX_FL_ASYNC);
806 else {
807 if ((flags & SPOE_APPCTX_FL_PIPELINING) && !(agent->flags & SPOE_FL_PIPELINING))
808 flags &= ~SPOE_APPCTX_FL_PIPELINING;
809 if ((flags & SPOE_APPCTX_FL_ASYNC) && !(agent->flags & SPOE_FL_ASYNC))
810 flags &= ~SPOE_APPCTX_FL_ASYNC;
811 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200812
Christopher Faulet42bfa462017-01-04 14:14:19 +0100813 SPOE_APPCTX(appctx)->version = (unsigned int)vsn;
814 SPOE_APPCTX(appctx)->max_frame_size = (unsigned int)max_frame_size;
815 SPOE_APPCTX(appctx)->flags |= flags;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100816
817 return (p - frame);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200818}
819
820/* Decode DISCONNECT frame sent by an agent. It returns the number of by read
821 * bytes on success, 0 if the frame can be ignored and -1 if an error
822 * occurred. */
823static int
Christopher Faulet8ef75252017-02-20 22:56:03 +0100824spoe_handle_agentdiscon_frame(struct appctx *appctx, char *frame, size_t size)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200825{
Christopher Faulet8ef75252017-02-20 22:56:03 +0100826 char *p, *end;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100827 unsigned int flags;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100828
829 p = frame;
830 end = frame + size;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200831
832 /* Check frame type */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100833 if (*p++ != SPOE_FRM_T_AGENT_DISCON) {
834 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200835 return 0;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100836 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200837
Christopher Faulet8ef75252017-02-20 22:56:03 +0100838 if (size < 7 /* TYPE + METADATA */) {
839 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
840 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200841 }
842
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100843 /* Retrieve flags */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100844 memcpy((char *)&flags, p, 4);
Thierry FOURNIERc4dcaff2018-05-18 12:25:39 +0200845 flags = ntohl(flags);
Christopher Faulet8ef75252017-02-20 22:56:03 +0100846 p += 4;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200847
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100848 /* Fragmentation is not supported for DISCONNECT frame */
849 if (!(flags & SPOE_FRM_FL_FIN)) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100850 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_FRAG_NOT_SUPPORTED;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100851 return -1;
852 }
853
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200854 /* stream-id and frame-id must be cleared */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100855 if (*p != 0 || *(p+1) != 0) {
856 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
857 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200858 }
Christopher Faulet8ef75252017-02-20 22:56:03 +0100859 p += 2;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200860
861 /* There are 2 mandatory items: "status-code" and "message" */
862
863 /* Loop on K/V items */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100864 while (p < end) {
865 char *str;
Frédéric Lécaille6ca71a92017-08-22 10:33:14 +0200866 uint64_t sz;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100867 int ret;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200868
869 /* Decode the item key */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100870 ret = spoe_decode_buffer(&p, end, &str, &sz);
871 if (ret == -1 || !sz) {
872 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
873 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200874 }
875
876 /* Check "status-code" K/V item */
Willy Tarreauda21ed12020-06-16 17:58:14 +0200877 if (sz >= strlen(STATUS_CODE_KEY) && !memcmp(str, STATUS_CODE_KEY, strlen(STATUS_CODE_KEY))) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100878 int type = *p++;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200879
880 /* The value must be an integer */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200881 if ((type & SPOE_DATA_T_MASK) != SPOE_DATA_T_INT32 &&
882 (type & SPOE_DATA_T_MASK) != SPOE_DATA_T_INT64 &&
883 (type & SPOE_DATA_T_MASK) != SPOE_DATA_T_UINT32 &&
884 (type & SPOE_DATA_T_MASK) != SPOE_DATA_T_UINT64) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100885 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
886 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200887 }
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200888 if (decode_varint(&p, end, &sz) == -1) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100889 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
890 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200891 }
Christopher Faulet8ef75252017-02-20 22:56:03 +0100892 SPOE_APPCTX(appctx)->status_code = sz;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200893 }
894
895 /* Check "message" K/V item */
Willy Tarreauda21ed12020-06-16 17:58:14 +0200896 else if (sz >= strlen(MSG_KEY) && !memcmp(str, MSG_KEY, strlen(MSG_KEY))) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100897 int type = *p++;
898
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200899 /* The value must be a string */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100900 if ((type & SPOE_DATA_T_MASK) != SPOE_DATA_T_STR) {
901 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
902 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200903 }
Christopher Faulet8ef75252017-02-20 22:56:03 +0100904 ret = spoe_decode_buffer(&p, end, &str, &sz);
905 if (ret == -1 || sz > 255) {
906 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
907 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200908 }
Christopher Faulet8ef75252017-02-20 22:56:03 +0100909#if defined(DEBUG_SPOE) || defined(DEBUG_FULL)
910 SPOE_APPCTX(appctx)->reason = str;
911 SPOE_APPCTX(appctx)->rlen = sz;
912#endif
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200913 }
914 else {
915 /* Silently ignore unknown item */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100916 if (spoe_skip_data(&p, end) == -1) {
917 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
918 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200919 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200920 }
921 }
922
Christopher Faulet8ef75252017-02-20 22:56:03 +0100923 return (p - frame);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200924}
925
926
Christopher Fauleta1cda022016-12-21 08:58:06 +0100927/* Decode ACK frame sent by an agent. It returns the number of read bytes on
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200928 * success, 0 if the frame can be ignored and -1 if an error occurred. */
929static int
Christopher Faulet8ef75252017-02-20 22:56:03 +0100930spoe_handle_agentack_frame(struct appctx *appctx, struct spoe_context **ctx,
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100931 char *frame, size_t size)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200932{
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100933 struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100934 char *p, *end;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100935 uint64_t stream_id, frame_id;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100936 int len;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100937 unsigned int flags;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100938
939 p = frame;
940 end = frame + size;
941 *ctx = NULL;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200942
943 /* Check frame type */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100944 if (*p++ != SPOE_FRM_T_AGENT_ACK) {
945 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200946 return 0;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100947 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200948
Christopher Faulet8ef75252017-02-20 22:56:03 +0100949 if (size < 7 /* TYPE + METADATA */) {
950 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
951 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200952 }
953
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100954 /* Retrieve flags */
Christopher Faulet8ef75252017-02-20 22:56:03 +0100955 memcpy((char *)&flags, p, 4);
Thierry FOURNIERc4dcaff2018-05-18 12:25:39 +0200956 flags = ntohl(flags);
Christopher Faulet8ef75252017-02-20 22:56:03 +0100957 p += 4;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200958
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100959 /* Fragmentation is not supported for now */
960 if (!(flags & SPOE_FRM_FL_FIN)) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100961 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_FRAG_NOT_SUPPORTED;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100962 return -1;
963 }
964
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200965 /* Get the stream-id and the frame-id */
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200966 if (decode_varint(&p, end, &stream_id) == -1) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100967 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
Christopher Fauleta1cda022016-12-21 08:58:06 +0100968 return 0;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100969 }
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200970 if (decode_varint(&p, end, &frame_id) == -1) {
Christopher Faulet8ef75252017-02-20 22:56:03 +0100971 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200972 return 0;
Christopher Faulet8ef75252017-02-20 22:56:03 +0100973 }
Christopher Fauleta1cda022016-12-21 08:58:06 +0100974
Christopher Faulet8ef75252017-02-20 22:56:03 +0100975 /* Try to find the corresponding SPOE context */
Christopher Faulet42bfa462017-01-04 14:14:19 +0100976 if (SPOE_APPCTX(appctx)->flags & SPOE_APPCTX_FL_ASYNC) {
Christopher Faulet24289f22017-09-25 14:48:02 +0200977 list_for_each_entry((*ctx), &agent->rt[tid].waiting_queue, list) {
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100978 if ((*ctx)->stream_id == (unsigned int)stream_id &&
979 (*ctx)->frame_id == (unsigned int)frame_id)
Christopher Fauleta1cda022016-12-21 08:58:06 +0100980 goto found;
981 }
982 }
983 else {
Christopher Fauletf51f5fa2017-01-19 10:01:12 +0100984 list_for_each_entry((*ctx), &SPOE_APPCTX(appctx)->waiting_queue, list) {
985 if ((*ctx)->stream_id == (unsigned int)stream_id &&
Christopher Faulet8ef75252017-02-20 22:56:03 +0100986 (*ctx)->frame_id == (unsigned int)frame_id)
Christopher Fauleta1cda022016-12-21 08:58:06 +0100987 goto found;
988 }
989 }
990
Christopher Faulet8eda93f2017-02-09 09:44:33 +0100991 if (SPOE_APPCTX(appctx)->frag_ctx.ctx &&
992 SPOE_APPCTX(appctx)->frag_ctx.cursid == (unsigned int)stream_id &&
993 SPOE_APPCTX(appctx)->frag_ctx.curfid == (unsigned int)frame_id) {
994
995 /* ABRT bit is set for an unfinished fragmented frame */
996 if (flags & SPOE_FRM_FL_ABRT) {
997 *ctx = SPOE_APPCTX(appctx)->frag_ctx.ctx;
Christopher Faulet8eda93f2017-02-09 09:44:33 +0100998 (*ctx)->state = SPOE_CTX_ST_ERROR;
999 (*ctx)->status_code = SPOE_CTX_ERR_FRAG_FRAME_ABRT;
1000 /* Ignore the payload */
1001 goto end;
1002 }
1003 /* TODO: Handle more flags for fragmented frames: RESUME, FINISH... */
1004 /* For now, we ignore the ack */
1005 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID;
1006 return 0;
1007 }
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01001008
Christopher Fauleta1cda022016-12-21 08:58:06 +01001009 /* No Stream found, ignore the frame */
Christopher Faulet8ef75252017-02-20 22:56:03 +01001010 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p"
1011 " - Ignore ACK frame"
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01001012 " - stream-id=%u - frame-id=%u\n",
1013 (int)now.tv_sec, (int)now.tv_usec, agent->id,
1014 __FUNCTION__, appctx,
1015 (unsigned int)stream_id, (unsigned int)frame_id);
1016
Christopher Faulet8eda93f2017-02-09 09:44:33 +01001017 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_FRAMEID_NOTFOUND;
Christopher Fauletc7ba9102020-11-10 14:31:39 +01001018 if (appctx->st0 == SPOE_APPCTX_ST_WAITING_SYNC_ACK) {
1019 /* Report an error if we are waiting the ack for another frame,
1020 * but not if there is no longer frame waiting for a ack
1021 * (timeout)
1022 */
1023 if (!LIST_ISEMPTY(&SPOE_APPCTX(appctx)->waiting_queue) ||
1024 SPOE_APPCTX(appctx)->frag_ctx.ctx)
1025 return -1;
1026 appctx->st0 = SPOE_APPCTX_ST_PROCESSING;
1027 SPOE_APPCTX(appctx)->cur_fpa = 0;
1028 }
Christopher Fauleta1cda022016-12-21 08:58:06 +01001029 return 0;
1030
1031 found:
Christopher Faulet8ef75252017-02-20 22:56:03 +01001032 if (!spoe_acquire_buffer(&SPOE_APPCTX(appctx)->buffer,
1033 &SPOE_APPCTX(appctx)->buffer_wait)) {
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01001034 *ctx = NULL;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001035 return 1; /* Retry later */
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01001036 }
Christopher Faulet4596fb72017-01-11 14:05:19 +01001037
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001038 /* Copy encoded actions */
Christopher Faulet8ef75252017-02-20 22:56:03 +01001039 len = (end - p);
Willy Tarreauc9fa0482018-07-10 17:43:27 +02001040 memcpy(b_head(&SPOE_APPCTX(appctx)->buffer), p, len);
1041 b_set_data(&SPOE_APPCTX(appctx)->buffer, len);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001042 p += len;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001043
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01001044 /* Transfer the buffer ownership to the SPOE context */
1045 (*ctx)->buffer = SPOE_APPCTX(appctx)->buffer;
Willy Tarreauc9fa0482018-07-10 17:43:27 +02001046 SPOE_APPCTX(appctx)->buffer = BUF_NULL;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001047
Christopher Faulet8ef75252017-02-20 22:56:03 +01001048 (*ctx)->state = SPOE_CTX_ST_DONE;
1049
Christopher Faulet8eda93f2017-02-09 09:44:33 +01001050 end:
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01001051 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p"
Christopher Faulet8ef75252017-02-20 22:56:03 +01001052 " - ACK frame received"
1053 " - ctx=%p - stream-id=%u - frame-id=%u - flags=0x%08x\n",
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01001054 (int)now.tv_sec, (int)now.tv_usec, agent->id,
Christopher Faulet8ef75252017-02-20 22:56:03 +01001055 __FUNCTION__, appctx, *ctx, (*ctx)->stream_id,
1056 (*ctx)->frame_id, flags);
1057 return (p - frame);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001058}
1059
Christopher Fauletba7bc162016-11-07 21:07:38 +01001060/* This function is used in cfgparse.c and declared in proto/checks.h. It
1061 * prepare the request to send to agents during a healthcheck. It returns 0 on
1062 * success and -1 if an error occurred. */
1063int
Christopher Faulet8ef75252017-02-20 22:56:03 +01001064spoe_prepare_healthcheck_request(char **req, int *len)
Christopher Fauletba7bc162016-11-07 21:07:38 +01001065{
Christopher Faulet8ef75252017-02-20 22:56:03 +01001066 struct appctx appctx;
1067 struct spoe_appctx spoe_appctx;
1068 char *frame, *end, buf[MAX_FRAME_SIZE+4];
1069 size_t sz;
1070 int ret;
Christopher Fauletba7bc162016-11-07 21:07:38 +01001071
Christopher Faulet42bfa462017-01-04 14:14:19 +01001072 memset(&appctx, 0, sizeof(appctx));
1073 memset(&spoe_appctx, 0, sizeof(spoe_appctx));
Christopher Fauletba7bc162016-11-07 21:07:38 +01001074 memset(buf, 0, sizeof(buf));
Christopher Faulet42bfa462017-01-04 14:14:19 +01001075
Willy Tarreau23a24072022-05-05 20:18:44 +02001076 appctx.svcctx = &spoe_appctx;
Christopher Faulet7aa0b2b2017-01-13 11:30:50 +01001077 SPOE_APPCTX(&appctx)->max_frame_size = MAX_FRAME_SIZE;
Christopher Fauletba7bc162016-11-07 21:07:38 +01001078
Christopher Faulet8ef75252017-02-20 22:56:03 +01001079 frame = buf+4; /* Reserved the 4 first bytes for the frame size */
1080 end = frame + MAX_FRAME_SIZE;
1081
1082 ret = spoe_prepare_hahello_frame(&appctx, frame, MAX_FRAME_SIZE);
1083 if (ret <= 0)
Christopher Fauletba7bc162016-11-07 21:07:38 +01001084 return -1;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001085 frame += ret;
Christopher Fauletba7bc162016-11-07 21:07:38 +01001086
Christopher Faulet8ef75252017-02-20 22:56:03 +01001087 /* Add "healthcheck" K/V item */
1088 sz = SLEN(HEALTHCHECK_KEY);
1089 if (spoe_encode_buffer(HEALTHCHECK_KEY, sz, &frame, end) == -1)
1090 return -1;
1091 *frame++ = (SPOE_DATA_T_BOOL | SPOE_DATA_FL_TRUE);
Christopher Fauletba7bc162016-11-07 21:07:38 +01001092
Christopher Faulet8ef75252017-02-20 22:56:03 +01001093 *len = frame - buf;
1094 sz = htonl(*len - 4);
1095 memcpy(buf, (char *)&sz, 4);
Christopher Fauletba7bc162016-11-07 21:07:38 +01001096
Christopher Faulet8ef75252017-02-20 22:56:03 +01001097 if ((*req = malloc(*len)) == NULL)
Christopher Fauletba7bc162016-11-07 21:07:38 +01001098 return -1;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001099 memcpy(*req, buf, *len);
Christopher Fauletba7bc162016-11-07 21:07:38 +01001100 return 0;
1101}
1102
1103/* This function is used in checks.c and declared in proto/checks.h. It decode
1104 * the response received from an agent during a healthcheck. It returns 0 on
1105 * success and -1 if an error occurred. */
1106int
Christopher Faulet8ef75252017-02-20 22:56:03 +01001107spoe_handle_healthcheck_response(char *frame, size_t size, char *err, int errlen)
Christopher Fauletba7bc162016-11-07 21:07:38 +01001108{
Christopher Faulet42bfa462017-01-04 14:14:19 +01001109 struct appctx appctx;
1110 struct spoe_appctx spoe_appctx;
Christopher Fauletba7bc162016-11-07 21:07:38 +01001111
Christopher Faulet42bfa462017-01-04 14:14:19 +01001112 memset(&appctx, 0, sizeof(appctx));
1113 memset(&spoe_appctx, 0, sizeof(spoe_appctx));
Christopher Fauletba7bc162016-11-07 21:07:38 +01001114
Willy Tarreau23a24072022-05-05 20:18:44 +02001115 appctx.svcctx = &spoe_appctx;
Christopher Faulet7aa0b2b2017-01-13 11:30:50 +01001116 SPOE_APPCTX(&appctx)->max_frame_size = MAX_FRAME_SIZE;
Christopher Faulet42bfa462017-01-04 14:14:19 +01001117
Christopher Faulet8ef75252017-02-20 22:56:03 +01001118 if (*frame == SPOE_FRM_T_AGENT_DISCON) {
1119 spoe_handle_agentdiscon_frame(&appctx, frame, size);
Christopher Fauletba7bc162016-11-07 21:07:38 +01001120 goto error;
1121 }
Christopher Faulet8ef75252017-02-20 22:56:03 +01001122 if (spoe_handle_agenthello_frame(&appctx, frame, size) <= 0)
1123 goto error;
Christopher Fauletba7bc162016-11-07 21:07:38 +01001124
1125 return 0;
1126
1127 error:
Christopher Faulet8ef75252017-02-20 22:56:03 +01001128 if (SPOE_APPCTX(&appctx)->status_code >= SPOE_FRM_ERRS)
1129 SPOE_APPCTX(&appctx)->status_code = SPOE_FRM_ERR_UNKNOWN;
1130 strncpy(err, spoe_frm_err_reasons[SPOE_APPCTX(&appctx)->status_code], errlen);
Christopher Fauletba7bc162016-11-07 21:07:38 +01001131 return -1;
1132}
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001133
Christopher Fauleta1cda022016-12-21 08:58:06 +01001134/* Send a SPOE frame to an agent. It returns -1 when an error occurred, 0 when
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +05001135 * the frame can be ignored, 1 to retry later, and the frame length on
Christopher Fauleta1cda022016-12-21 08:58:06 +01001136 * success. */
1137static int
Christopher Faulet8ef75252017-02-20 22:56:03 +01001138spoe_send_frame(struct appctx *appctx, char *buf, size_t framesz)
Christopher Fauleta1cda022016-12-21 08:58:06 +01001139{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001140 struct stconn *sc = appctx_sc(appctx);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001141 int ret;
1142 uint32_t netint;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001143
Christopher Faulet8ef75252017-02-20 22:56:03 +01001144 /* 4 bytes are reserved at the beginning of <buf> to store the frame
1145 * length. */
Christopher Fauleta1cda022016-12-21 08:58:06 +01001146 netint = htonl(framesz);
1147 memcpy(buf, (char *)&netint, 4);
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001148 ret = applet_putblk(appctx, buf, framesz+4);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001149 if (ret <= 0) {
Willy Tarreau9002a2e2022-05-27 10:34:25 +02001150 if ((ret == -3 && b_is_null(&sc_ic(sc)->buf)) || ret == -1) {
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001151 /* WT: is this still needed for the case ret==-3 ? */
Willy Tarreau9002a2e2022-05-27 10:34:25 +02001152 sc_need_room(sc);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001153 return 1; /* retry */
Christopher Faulet8ef75252017-02-20 22:56:03 +01001154 }
1155 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_IO;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001156 return -1; /* error */
1157 }
1158 return framesz;
1159}
1160
1161/* Receive a SPOE frame from an agent. It return -1 when an error occurred, 0
1162 * when the frame can be ignored, 1 to retry later and the frame length on
1163 * success. */
1164static int
Christopher Faulet8ef75252017-02-20 22:56:03 +01001165spoe_recv_frame(struct appctx *appctx, char *buf, size_t framesz)
Christopher Fauleta1cda022016-12-21 08:58:06 +01001166{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001167 struct stconn *sc = appctx_sc(appctx);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001168 int ret;
1169 uint32_t netint;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001170
Willy Tarreau9002a2e2022-05-27 10:34:25 +02001171 ret = co_getblk(sc_oc(sc), (char *)&netint, 4, 0);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001172 if (ret > 0) {
1173 framesz = ntohl(netint);
Christopher Faulet42bfa462017-01-04 14:14:19 +01001174 if (framesz > SPOE_APPCTX(appctx)->max_frame_size) {
Christopher Faulet8ef75252017-02-20 22:56:03 +01001175 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOO_BIG;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001176 return -1;
1177 }
Willy Tarreau9002a2e2022-05-27 10:34:25 +02001178 ret = co_getblk(sc_oc(sc), buf, framesz, 4);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001179 }
1180 if (ret <= 0) {
Christopher Faulet8ef75252017-02-20 22:56:03 +01001181 if (ret == 0) {
Christopher Fauleta1cda022016-12-21 08:58:06 +01001182 return 1; /* retry */
Christopher Faulet8ef75252017-02-20 22:56:03 +01001183 }
1184 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_IO;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001185 return -1; /* error */
1186 }
1187 return framesz;
1188}
1189
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001190/********************************************************************
1191 * Functions that manage the SPOE applet
1192 ********************************************************************/
Christopher Faulet4596fb72017-01-11 14:05:19 +01001193static int
Christopher Faulet8ef75252017-02-20 22:56:03 +01001194spoe_wakeup_appctx(struct appctx *appctx)
Christopher Faulet4596fb72017-01-11 14:05:19 +01001195{
Willy Tarreau75a8f8e2022-05-25 18:12:11 +02001196 applet_will_consume(appctx);
Willy Tarreau4164eb92022-05-25 15:42:03 +02001197 applet_have_more_data(appctx);
Christopher Faulet4596fb72017-01-11 14:05:19 +01001198 appctx_wakeup(appctx);
1199 return 1;
1200}
1201
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001202/* Callback function that catches applet timeouts. If a timeout occurred, we set
1203 * <appctx->st1> flag and the SPOE applet is woken up. */
1204static struct task *
Willy Tarreau144f84a2021-03-02 16:09:26 +01001205spoe_process_appctx(struct task * task, void *context, unsigned int state)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001206{
Olivier Houchard9f6af332018-05-25 14:04:04 +02001207 struct appctx *appctx = context;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001208
1209 appctx->st1 = SPOE_APPCTX_ERR_NONE;
1210 if (tick_is_expired(task->expire, now_ms)) {
1211 task->expire = TICK_ETERNITY;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001212 appctx->st1 = SPOE_APPCTX_ERR_TOUT;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001213 }
Christopher Faulet8ef75252017-02-20 22:56:03 +01001214 spoe_wakeup_appctx(appctx);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001215 return task;
1216}
1217
Christopher Faulet69ebc302022-05-12 15:28:51 +02001218static int
1219spoe_init_appctx(struct appctx *appctx)
1220{
1221 struct spoe_appctx *spoe_appctx = SPOE_APPCTX(appctx);
1222 struct spoe_agent *agent = spoe_appctx->agent;
1223 struct task *task;
1224 struct stream *s;
1225
1226 if ((task = task_new_here()) == NULL)
Christopher Fauletfa463af2022-05-18 07:42:49 +02001227 goto out_error;
Christopher Faulet69ebc302022-05-12 15:28:51 +02001228 task->process = spoe_process_appctx;
1229 task->context = appctx;
1230
1231 if (appctx_finalize_startup(appctx, &agent->spoe_conf->agent_fe, &BUF_NULL) == -1)
Christopher Fauletfa463af2022-05-18 07:42:49 +02001232 goto out_free_task;
Christopher Faulet69ebc302022-05-12 15:28:51 +02001233
1234 spoe_appctx->owner = appctx;
1235 spoe_appctx->task = task;
1236
1237 LIST_INIT(&spoe_appctx->buffer_wait.list);
1238 spoe_appctx->buffer_wait.target = appctx;
1239 spoe_appctx->buffer_wait.wakeup_cb = (int (*)(void *))spoe_wakeup_appctx;
1240
1241 s = appctx_strm(appctx);
1242 stream_set_backend(s, agent->b.be);
1243
1244 /* applet is waiting for data */
Willy Tarreau90e8b452022-05-25 18:21:43 +02001245 applet_need_more_data(appctx);
Christopher Faulet69ebc302022-05-12 15:28:51 +02001246
1247 s->do_log = NULL;
Christopher Faulet9a790f62023-03-16 14:40:03 +01001248 s->scb->flags |= SC_FL_RCV_ONCE;
Christopher Faulet69ebc302022-05-12 15:28:51 +02001249
1250 HA_SPIN_LOCK(SPOE_APPLET_LOCK, &agent->rt[tid].lock);
1251 LIST_APPEND(&agent->rt[tid].applets, &spoe_appctx->list);
1252 HA_SPIN_UNLOCK(SPOE_APPLET_LOCK, &agent->rt[tid].lock);
1253 _HA_ATOMIC_INC(&agent->counters.applets);
1254
1255 appctx->st0 = SPOE_APPCTX_ST_CONNECT;
1256 task_wakeup(spoe_appctx->task, TASK_WOKEN_INIT);
1257 return 0;
1258 out_free_task:
1259 task_destroy(task);
1260 out_error:
1261 return -1;
1262}
1263
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001264/* Callback function that releases a SPOE applet. This happens when the
1265 * connection with the agent is closed. */
1266static void
Christopher Faulet8ef75252017-02-20 22:56:03 +01001267spoe_release_appctx(struct appctx *appctx)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001268{
Christopher Faulet908628c2022-03-25 16:43:49 +01001269 struct spoe_appctx *spoe_appctx = SPOE_APPCTX(appctx);
1270 struct spoe_agent *agent;
1271 struct spoe_context *ctx, *back;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001272
1273 if (spoe_appctx == NULL)
1274 return;
1275
Willy Tarreau23a24072022-05-05 20:18:44 +02001276 appctx->svcctx = NULL;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001277 agent = spoe_appctx->agent;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001278
1279 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p\n",
1280 (int)now.tv_sec, (int)now.tv_usec, agent->id,
1281 __FUNCTION__, appctx);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001282
Christopher Faulet8ef75252017-02-20 22:56:03 +01001283 /* Remove applet from the list of running applets */
Willy Tarreau4781b152021-04-06 13:53:36 +02001284 _HA_ATOMIC_DEC(&agent->counters.applets);
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001285 HA_SPIN_LOCK(SPOE_APPLET_LOCK, &agent->rt[tid].lock);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001286 if (!LIST_ISEMPTY(&spoe_appctx->list)) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001287 LIST_DELETE(&spoe_appctx->list);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001288 LIST_INIT(&spoe_appctx->list);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001289 }
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001290 HA_SPIN_UNLOCK(SPOE_APPLET_LOCK, &agent->rt[tid].lock);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001291
Christopher Faulet8ef75252017-02-20 22:56:03 +01001292 /* Shutdown the server connection, if needed */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001293 if (appctx->st0 != SPOE_APPCTX_ST_END) {
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001294 if (appctx->st0 == SPOE_APPCTX_ST_IDLE) {
1295 eb32_delete(&spoe_appctx->node);
Willy Tarreau4781b152021-04-06 13:53:36 +02001296 _HA_ATOMIC_DEC(&agent->counters.idles);
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001297 }
Christopher Fauleta1cda022016-12-21 08:58:06 +01001298
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001299 appctx->st0 = SPOE_APPCTX_ST_END;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001300 if (spoe_appctx->status_code == SPOE_FRM_ERR_NONE)
1301 spoe_appctx->status_code = SPOE_FRM_ERR_IO;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001302 }
1303
Christopher Faulet8ef75252017-02-20 22:56:03 +01001304 /* Destroy the task attached to this applet */
Willy Tarreauf6562792019-05-07 19:05:35 +02001305 task_destroy(spoe_appctx->task);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001306
Christopher Faulet42a06622022-08-25 18:50:18 +02001307 /* Report an error to all streams in the appctx waiting queue */
Christopher Faulet8ef75252017-02-20 22:56:03 +01001308 list_for_each_entry_safe(ctx, back, &spoe_appctx->waiting_queue, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02001309 LIST_DELETE(&ctx->list);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001310 LIST_INIT(&ctx->list);
Willy Tarreau4781b152021-04-06 13:53:36 +02001311 _HA_ATOMIC_DEC(&agent->counters.nb_waiting);
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01001312 spoe_update_stat_time(&ctx->stats.tv_wait, &ctx->stats.t_waiting);
Christopher Fauletcf181c72020-11-10 18:45:34 +01001313 ctx->spoe_appctx = NULL;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001314 ctx->state = SPOE_CTX_ST_ERROR;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001315 ctx->status_code = (spoe_appctx->status_code + 0x100);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001316 task_wakeup(ctx->strm->task, TASK_WOKEN_MSG);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001317 }
1318
Christopher Faulet42a06622022-08-25 18:50:18 +02001319 /* If the applet was processing a fragmented frame, report an error to
1320 * the corresponding stream. */
Christopher Faulet8ef75252017-02-20 22:56:03 +01001321 if (spoe_appctx->frag_ctx.ctx) {
1322 ctx = spoe_appctx->frag_ctx.ctx;
Christopher Fauletfce747b2018-01-24 15:59:32 +01001323 ctx->spoe_appctx = NULL;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01001324 ctx->state = SPOE_CTX_ST_ERROR;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001325 ctx->status_code = (spoe_appctx->status_code + 0x100);
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01001326 task_wakeup(ctx->strm->task, TASK_WOKEN_MSG);
1327 }
1328
Christopher Faulet42a06622022-08-25 18:50:18 +02001329 if (!LIST_ISEMPTY(&agent->rt[tid].applets)) {
1330 /* If there are still some running applets, remove reference on
1331 * the current one from streams in the async waiting queue. In
1332 * async mode, the ACK may be received from another appctx.
1333 */
Christopher Fauletcf181c72020-11-10 18:45:34 +01001334 list_for_each_entry_safe(ctx, back, &agent->rt[tid].waiting_queue, list) {
1335 if (ctx->spoe_appctx == spoe_appctx)
1336 ctx->spoe_appctx = NULL;
1337 }
Christopher Faulet7aa0b2b2017-01-13 11:30:50 +01001338 goto end;
Christopher Fauletcf181c72020-11-10 18:45:34 +01001339 }
Christopher Faulet6f1296b2021-08-02 17:53:56 +02001340 else {
Christopher Faulet42a06622022-08-25 18:50:18 +02001341 /* It is the last running applet and the sending and async
1342 * waiting queues are not empty. So try to start a new applet if
1343 * HAproxy is not stopping. On success, we remove reference on
1344 * the current appctx from streams in the async waiting queue.
1345 * In async mode, the ACK may be received from another appctx.
Christopher Faulet6f1296b2021-08-02 17:53:56 +02001346 */
1347 if (!stopping &&
1348 (!LIST_ISEMPTY(&agent->rt[tid].sending_queue) || !LIST_ISEMPTY(&agent->rt[tid].waiting_queue)) &&
Christopher Faulet42a06622022-08-25 18:50:18 +02001349 spoe_create_appctx(agent->spoe_conf)) {
1350 list_for_each_entry_safe(ctx, back, &agent->rt[tid].waiting_queue, list) {
1351 if (ctx->spoe_appctx == spoe_appctx)
1352 ctx->spoe_appctx = NULL;
1353 }
Christopher Faulet6f1296b2021-08-02 17:53:56 +02001354 goto end;
Christopher Faulet42a06622022-08-25 18:50:18 +02001355 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001356
Christopher Faulet42a06622022-08-25 18:50:18 +02001357 /* Otherwise, report an error to all streams in the sending and
1358 * async waiting queues.
1359 */
Christopher Faulet6f1296b2021-08-02 17:53:56 +02001360 list_for_each_entry_safe(ctx, back, &agent->rt[tid].sending_queue, list) {
1361 LIST_DELETE(&ctx->list);
1362 LIST_INIT(&ctx->list);
1363 _HA_ATOMIC_DEC(&agent->counters.nb_sending);
1364 spoe_update_stat_time(&ctx->stats.tv_queue, &ctx->stats.t_queue);
1365 ctx->spoe_appctx = NULL;
1366 ctx->state = SPOE_CTX_ST_ERROR;
1367 ctx->status_code = (spoe_appctx->status_code + 0x100);
1368 task_wakeup(ctx->strm->task, TASK_WOKEN_MSG);
1369 }
1370 list_for_each_entry_safe(ctx, back, &agent->rt[tid].waiting_queue, list) {
1371 LIST_DELETE(&ctx->list);
1372 LIST_INIT(&ctx->list);
1373 _HA_ATOMIC_DEC(&agent->counters.nb_waiting);
1374 spoe_update_stat_time(&ctx->stats.tv_wait, &ctx->stats.t_waiting);
1375 ctx->spoe_appctx = NULL;
1376 ctx->state = SPOE_CTX_ST_ERROR;
1377 ctx->status_code = (spoe_appctx->status_code + 0x100);
1378 task_wakeup(ctx->strm->task, TASK_WOKEN_MSG);
1379 }
Christopher Fauleta1cda022016-12-21 08:58:06 +01001380 }
Christopher Faulet7aa0b2b2017-01-13 11:30:50 +01001381
1382 end:
Christopher Faulet55ae8a62019-05-23 22:47:48 +02001383 /* Release allocated memory */
1384 spoe_release_buffer(&spoe_appctx->buffer,
1385 &spoe_appctx->buffer_wait);
1386 pool_free(pool_head_spoe_appctx, spoe_appctx);
1387
Christopher Faulet7aa0b2b2017-01-13 11:30:50 +01001388 /* Update runtinme agent info */
Christopher Faulet24289f22017-09-25 14:48:02 +02001389 agent->rt[tid].frame_size = agent->max_frame_size;
1390 list_for_each_entry(spoe_appctx, &agent->rt[tid].applets, list)
1391 HA_ATOMIC_UPDATE_MIN(&agent->rt[tid].frame_size, spoe_appctx->max_frame_size);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001392}
1393
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001394static int
Christopher Faulet8ef75252017-02-20 22:56:03 +01001395spoe_handle_connect_appctx(struct appctx *appctx)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001396{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001397 struct stconn *sc = appctx_sc(appctx);
Christopher Faulet908628c2022-03-25 16:43:49 +01001398 struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001399 char *frame, *buf;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001400 int ret;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001401
Christopher Fauletd550d262023-03-31 11:04:34 +02001402 /* if the connection is not established, inform the stream that we want
1403 * to be notified whenever the connection completes.
1404 */
1405 if (sc_opposite(sc)->state < SC_ST_EST) {
1406 applet_need_more_data(appctx);
1407 se_need_remote_conn(appctx->sedesc);
1408 applet_have_more_data(appctx);
1409 goto stop;
1410 }
Christopher Fauleta73e59b2016-12-09 17:30:18 +01001411
Christopher Fauleta1cda022016-12-21 08:58:06 +01001412 if (appctx->st1 == SPOE_APPCTX_ERR_TOUT) {
Christopher Faulet8ef75252017-02-20 22:56:03 +01001413 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p"
1414 " - Connection timed out\n",
1415 (int)now.tv_sec, (int)now.tv_usec, agent->id,
1416 __FUNCTION__, appctx);
1417 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOUT;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001418 goto exit;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001419 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001420
Christopher Faulet42bfa462017-01-04 14:14:19 +01001421 if (SPOE_APPCTX(appctx)->task->expire == TICK_ETERNITY)
Christopher Faulet8ef75252017-02-20 22:56:03 +01001422 SPOE_APPCTX(appctx)->task->expire =
1423 tick_add_ifset(now_ms, agent->timeout.hello);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001424
Christopher Faulet8ef75252017-02-20 22:56:03 +01001425 /* 4 bytes are reserved at the beginning of <buf> to store the frame
1426 * length. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001427 buf = trash.area; frame = buf+4;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001428 ret = spoe_prepare_hahello_frame(appctx, frame,
1429 SPOE_APPCTX(appctx)->max_frame_size);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001430 if (ret > 1)
Christopher Faulet8ef75252017-02-20 22:56:03 +01001431 ret = spoe_send_frame(appctx, buf, ret);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001432
1433 switch (ret) {
1434 case -1: /* error */
Christopher Fauleta1cda022016-12-21 08:58:06 +01001435 case 0: /* ignore => an error, cannot be ignored */
1436 goto exit;
1437
1438 case 1: /* retry later */
Christopher Fauleta1cda022016-12-21 08:58:06 +01001439 goto stop;
1440
Christopher Faulet8ef75252017-02-20 22:56:03 +01001441 default:
1442 /* HELLO frame successfully sent, now wait for the
1443 * reply. */
Christopher Fauleta1cda022016-12-21 08:58:06 +01001444 appctx->st0 = SPOE_APPCTX_ST_CONNECTING;
1445 goto next;
1446 }
1447
1448 next:
1449 return 0;
1450 stop:
1451 return 1;
1452 exit:
1453 appctx->st0 = SPOE_APPCTX_ST_EXIT;
1454 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001455}
1456
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001457static int
Christopher Faulet8ef75252017-02-20 22:56:03 +01001458spoe_handle_connecting_appctx(struct appctx *appctx)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001459{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001460 struct stconn *sc = appctx_sc(appctx);
Christopher Faulet908628c2022-03-25 16:43:49 +01001461 struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001462 char *frame;
1463 int ret;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001464
Christopher Fauleta1cda022016-12-21 08:58:06 +01001465 if (appctx->st1 == SPOE_APPCTX_ERR_TOUT) {
Christopher Faulet8ef75252017-02-20 22:56:03 +01001466 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p"
1467 " - Connection timed out\n",
1468 (int)now.tv_sec, (int)now.tv_usec, agent->id,
1469 __FUNCTION__, appctx);
1470 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOUT;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001471 goto exit;
1472 }
1473
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001474 frame = trash.area; trash.data = 0;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001475 ret = spoe_recv_frame(appctx, frame,
1476 SPOE_APPCTX(appctx)->max_frame_size);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001477 if (ret > 1) {
1478 if (*frame == SPOE_FRM_T_AGENT_DISCON) {
1479 appctx->st0 = SPOE_APPCTX_ST_DISCONNECTING;
1480 goto next;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001481 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001482 trash.data = ret + 4;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001483 ret = spoe_handle_agenthello_frame(appctx, frame, ret);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001484 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001485
Christopher Fauleta1cda022016-12-21 08:58:06 +01001486 switch (ret) {
1487 case -1: /* error */
Christopher Faulet8ef75252017-02-20 22:56:03 +01001488 case 0: /* ignore => an error, cannot be ignored */
Christopher Fauleta1cda022016-12-21 08:58:06 +01001489 appctx->st0 = SPOE_APPCTX_ST_DISCONNECT;
1490 goto next;
1491
1492 case 1: /* retry later */
1493 goto stop;
1494
1495 default:
Willy Tarreau4781b152021-04-06 13:53:36 +02001496 _HA_ATOMIC_INC(&agent->counters.idles);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001497 appctx->st0 = SPOE_APPCTX_ST_IDLE;
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001498 SPOE_APPCTX(appctx)->node.key = 0;
1499 eb32_insert(&agent->rt[tid].idle_applets, &SPOE_APPCTX(appctx)->node);
Christopher Faulet7aa0b2b2017-01-13 11:30:50 +01001500
1501 /* Update runtinme agent info */
Christopher Faulet24289f22017-09-25 14:48:02 +02001502 HA_ATOMIC_UPDATE_MIN(&agent->rt[tid].frame_size, SPOE_APPCTX(appctx)->max_frame_size);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001503 goto next;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001504 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001505
Christopher Fauleta1cda022016-12-21 08:58:06 +01001506 next:
Christopher Faulet8ef75252017-02-20 22:56:03 +01001507 /* Do not forget to remove processed frame from the output buffer */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001508 if (trash.data)
Willy Tarreau9002a2e2022-05-27 10:34:25 +02001509 co_skip(sc_oc(sc), trash.data);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001510
1511 SPOE_APPCTX(appctx)->task->expire =
1512 tick_add_ifset(now_ms, agent->timeout.idle);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001513 return 0;
1514 stop:
1515 return 1;
1516 exit:
1517 appctx->st0 = SPOE_APPCTX_ST_EXIT;
1518 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001519}
1520
Christopher Fauletf032c3e2017-02-17 15:18:35 +01001521
Christopher Fauleta1cda022016-12-21 08:58:06 +01001522static int
Christopher Fauletf032c3e2017-02-17 15:18:35 +01001523spoe_handle_sending_frame_appctx(struct appctx *appctx, int *skip)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001524{
Christopher Fauletf032c3e2017-02-17 15:18:35 +01001525 struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent;
1526 struct spoe_context *ctx = NULL;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001527 char *frame, *buf;
1528 int ret;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001529
Christopher Faulet8ef75252017-02-20 22:56:03 +01001530 /* 4 bytes are reserved at the beginning of <buf> to store the frame
1531 * length. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001532 buf = trash.area; frame = buf+4;
Christopher Fauletf032c3e2017-02-17 15:18:35 +01001533
1534 if (appctx->st0 == SPOE_APPCTX_ST_SENDING_FRAG_NOTIFY) {
1535 ctx = SPOE_APPCTX(appctx)->frag_ctx.ctx;
1536 ret = spoe_prepare_hafrag_frame(appctx, ctx, frame,
1537 SPOE_APPCTX(appctx)->max_frame_size);
1538 }
Christopher Faulet24289f22017-09-25 14:48:02 +02001539 else if (LIST_ISEMPTY(&agent->rt[tid].sending_queue)) {
Christopher Fauletf032c3e2017-02-17 15:18:35 +01001540 *skip = 1;
1541 ret = 1;
1542 goto end;
1543 }
1544 else {
Christopher Faulet24289f22017-09-25 14:48:02 +02001545 ctx = LIST_NEXT(&agent->rt[tid].sending_queue, typeof(ctx), list);
Christopher Fauletf032c3e2017-02-17 15:18:35 +01001546 ret = spoe_prepare_hanotify_frame(appctx, ctx, frame,
1547 SPOE_APPCTX(appctx)->max_frame_size);
1548
1549 }
1550
Christopher Faulet8ef75252017-02-20 22:56:03 +01001551 if (ret > 1)
1552 ret = spoe_send_frame(appctx, buf, ret);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001553
Christopher Faulet8ef75252017-02-20 22:56:03 +01001554 switch (ret) {
1555 case -1: /* error */
1556 appctx->st0 = SPOE_APPCTX_ST_DISCONNECT;
1557 goto end;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001558
Christopher Faulet8ef75252017-02-20 22:56:03 +01001559 case 0: /* ignore */
1560 if (ctx == NULL)
1561 goto abort_frag_frame;
1562
Christopher Fauletf032c3e2017-02-17 15:18:35 +01001563 spoe_release_buffer(&ctx->buffer, &ctx->buffer_wait);
Willy Tarreau2b718102021-04-21 07:32:39 +02001564 LIST_DELETE(&ctx->list);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001565 LIST_INIT(&ctx->list);
Willy Tarreau4781b152021-04-06 13:53:36 +02001566 _HA_ATOMIC_DEC(&agent->counters.nb_sending);
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01001567 spoe_update_stat_time(&ctx->stats.tv_queue, &ctx->stats.t_queue);
Christopher Fauletfce747b2018-01-24 15:59:32 +01001568 ctx->spoe_appctx = NULL;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001569 ctx->state = SPOE_CTX_ST_ERROR;
1570 ctx->status_code = (SPOE_APPCTX(appctx)->status_code + 0x100);
1571 task_wakeup(ctx->strm->task, TASK_WOKEN_MSG);
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001572 *skip = 1;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001573 break;
1574
1575 case 1: /* retry */
1576 *skip = 1;
1577 break;
1578
1579 default:
1580 if (ctx == NULL)
1581 goto abort_frag_frame;
1582
Christopher Fauletf032c3e2017-02-17 15:18:35 +01001583 spoe_release_buffer(&ctx->buffer, &ctx->buffer_wait);
Willy Tarreau2b718102021-04-21 07:32:39 +02001584 LIST_DELETE(&ctx->list);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001585 LIST_INIT(&ctx->list);
Willy Tarreau4781b152021-04-06 13:53:36 +02001586 _HA_ATOMIC_DEC(&agent->counters.nb_sending);
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01001587 spoe_update_stat_time(&ctx->stats.tv_queue, &ctx->stats.t_queue);
Christopher Fauletfce747b2018-01-24 15:59:32 +01001588 ctx->spoe_appctx = SPOE_APPCTX(appctx);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001589 if (!(ctx->flags & SPOE_CTX_FL_FRAGMENTED) ||
1590 (ctx->frag_ctx.flags & SPOE_FRM_FL_FIN))
1591 goto no_frag_frame_sent;
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001592 else
Christopher Faulet8ef75252017-02-20 22:56:03 +01001593 goto frag_frame_sent;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001594 }
1595 goto end;
1596
1597 frag_frame_sent:
1598 appctx->st0 = SPOE_APPCTX_ST_SENDING_FRAG_NOTIFY;
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001599 *skip = 1;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001600 SPOE_APPCTX(appctx)->frag_ctx.ctx = ctx;
1601 SPOE_APPCTX(appctx)->frag_ctx.cursid = ctx->stream_id;
1602 SPOE_APPCTX(appctx)->frag_ctx.curfid = ctx->frame_id;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001603 ctx->state = SPOE_CTX_ST_ENCODING_MSGS;
1604 task_wakeup(ctx->strm->task, TASK_WOKEN_MSG);
1605 goto end;
1606
1607 no_frag_frame_sent:
1608 if (SPOE_APPCTX(appctx)->flags & SPOE_APPCTX_FL_ASYNC) {
1609 appctx->st0 = SPOE_APPCTX_ST_PROCESSING;
Willy Tarreau2b718102021-04-21 07:32:39 +02001610 LIST_APPEND(&agent->rt[tid].waiting_queue, &ctx->list);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001611 }
1612 else if (SPOE_APPCTX(appctx)->flags & SPOE_APPCTX_FL_PIPELINING) {
1613 appctx->st0 = SPOE_APPCTX_ST_PROCESSING;
Willy Tarreau2b718102021-04-21 07:32:39 +02001614 LIST_APPEND(&SPOE_APPCTX(appctx)->waiting_queue, &ctx->list);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001615 }
1616 else {
1617 appctx->st0 = SPOE_APPCTX_ST_WAITING_SYNC_ACK;
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001618 *skip = 1;
Willy Tarreau2b718102021-04-21 07:32:39 +02001619 LIST_APPEND(&SPOE_APPCTX(appctx)->waiting_queue, &ctx->list);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001620 }
Willy Tarreau4781b152021-04-06 13:53:36 +02001621 _HA_ATOMIC_INC(&agent->counters.nb_waiting);
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01001622 ctx->stats.tv_wait = now;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001623 SPOE_APPCTX(appctx)->frag_ctx.ctx = NULL;
1624 SPOE_APPCTX(appctx)->frag_ctx.cursid = 0;
1625 SPOE_APPCTX(appctx)->frag_ctx.curfid = 0;
Christopher Faulet8f82b202018-01-24 16:23:03 +01001626 SPOE_APPCTX(appctx)->cur_fpa++;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001627
Christopher Faulet8ef75252017-02-20 22:56:03 +01001628 ctx->state = SPOE_CTX_ST_WAITING_ACK;
1629 goto end;
1630
1631 abort_frag_frame:
1632 appctx->st0 = SPOE_APPCTX_ST_PROCESSING;
1633 SPOE_APPCTX(appctx)->frag_ctx.ctx = NULL;
1634 SPOE_APPCTX(appctx)->frag_ctx.cursid = 0;
1635 SPOE_APPCTX(appctx)->frag_ctx.curfid = 0;
1636 goto end;
1637
1638 end:
1639 return ret;
1640}
1641
1642static int
1643spoe_handle_receiving_frame_appctx(struct appctx *appctx, int *skip)
1644{
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02001645 struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001646 struct spoe_context *ctx = NULL;
1647 char *frame;
1648 int ret;
1649
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001650 frame = trash.area; trash.data = 0;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001651 ret = spoe_recv_frame(appctx, frame,
1652 SPOE_APPCTX(appctx)->max_frame_size);
1653 if (ret > 1) {
1654 if (*frame == SPOE_FRM_T_AGENT_DISCON) {
1655 appctx->st0 = SPOE_APPCTX_ST_DISCONNECTING;
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001656 ret = -1;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001657 goto end;
1658 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001659 trash.data = ret + 4;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001660 ret = spoe_handle_agentack_frame(appctx, &ctx, frame, ret);
1661 }
1662 switch (ret) {
1663 case -1: /* error */
1664 appctx->st0 = SPOE_APPCTX_ST_DISCONNECT;
1665 break;
1666
1667 case 0: /* ignore */
1668 break;
1669
1670 case 1: /* retry */
1671 *skip = 1;
1672 break;
1673
1674 default:
Willy Tarreau2b718102021-04-21 07:32:39 +02001675 LIST_DELETE(&ctx->list);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001676 LIST_INIT(&ctx->list);
Willy Tarreau4781b152021-04-06 13:53:36 +02001677 _HA_ATOMIC_DEC(&agent->counters.nb_waiting);
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01001678 spoe_update_stat_time(&ctx->stats.tv_wait, &ctx->stats.t_waiting);
1679 ctx->stats.tv_response = now;
Christopher Faulet8f82b202018-01-24 16:23:03 +01001680 if (ctx->spoe_appctx) {
1681 ctx->spoe_appctx->cur_fpa--;
Christopher Fauletfce747b2018-01-24 15:59:32 +01001682 ctx->spoe_appctx = NULL;
Christopher Faulet8f82b202018-01-24 16:23:03 +01001683 }
Christopher Faulet8eda93f2017-02-09 09:44:33 +01001684 if (appctx->st0 == SPOE_APPCTX_ST_SENDING_FRAG_NOTIFY &&
1685 ctx == SPOE_APPCTX(appctx)->frag_ctx.ctx) {
1686 appctx->st0 = SPOE_APPCTX_ST_PROCESSING;
1687 SPOE_APPCTX(appctx)->frag_ctx.ctx = NULL;
1688 SPOE_APPCTX(appctx)->frag_ctx.cursid = 0;
1689 SPOE_APPCTX(appctx)->frag_ctx.curfid = 0;
1690 }
1691 else if (appctx->st0 == SPOE_APPCTX_ST_WAITING_SYNC_ACK)
1692 appctx->st0 = SPOE_APPCTX_ST_PROCESSING;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001693 task_wakeup(ctx->strm->task, TASK_WOKEN_MSG);
1694 break;
1695 }
1696
1697 /* Do not forget to remove processed frame from the output buffer */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001698 if (trash.data)
Willy Tarreauc12b3212022-05-27 11:08:15 +02001699 co_skip(sc_oc(appctx_sc(appctx)), trash.data);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001700 end:
1701 return ret;
1702}
1703
1704static int
1705spoe_handle_processing_appctx(struct appctx *appctx)
1706{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001707 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau9002a2e2022-05-27 10:34:25 +02001708 struct server *srv = objt_server(__sc_strm(sc)->target);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001709 struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent;
Christopher Fauletd7da3dd2021-08-02 18:13:27 +02001710 int ret, skip_sending = 0, skip_receiving = 0, active_s = 0, active_r = 0, close_asap = 0;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001711
Christopher Faulet8ef75252017-02-20 22:56:03 +01001712 if (appctx->st1 == SPOE_APPCTX_ERR_TOUT) {
1713 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOUT;
1714 appctx->st0 = SPOE_APPCTX_ST_DISCONNECT;
1715 appctx->st1 = SPOE_APPCTX_ERR_NONE;
1716 goto next;
1717 }
1718
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01001719 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p"
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001720 " - process: fpa=%u/%u - appctx-state=%s - weight=%u - flags=0x%08x\n",
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01001721 (int)now.tv_sec, (int)now.tv_usec, agent->id,
Christopher Faulet8f82b202018-01-24 16:23:03 +01001722 __FUNCTION__, appctx, SPOE_APPCTX(appctx)->cur_fpa,
1723 agent->max_fpa, spoe_appctx_state_str[appctx->st0],
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001724 SPOE_APPCTX(appctx)->node.key, SPOE_APPCTX(appctx)->flags);
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01001725
Christopher Fauletd7da3dd2021-08-02 18:13:27 +02001726
1727 /* Close the applet ASAP because some sessions are waiting for a free
1728 * connection slot. It is only an issue in multithreaded mode.
1729 */
1730 close_asap = (global.nbthread > 1 &&
1731 (agent->b.be->queue.length ||
1732 (srv && (srv->queue.length || (srv->maxconn && srv->served >= srv_dynamic_maxconn(srv))))));
1733
1734 /* Don"t try to send new frame we are waiting for at lease a ack, in
1735 * sync mode or if applet must be closed ASAP
1736 */
1737 if (appctx->st0 == SPOE_APPCTX_ST_WAITING_SYNC_ACK || (close_asap && SPOE_APPCTX(appctx)->cur_fpa))
Christopher Faulet8f82b202018-01-24 16:23:03 +01001738 skip_sending = 1;
Christopher Faulet4596fb72017-01-11 14:05:19 +01001739
Christopher Faulet8f82b202018-01-24 16:23:03 +01001740 /* receiving_frame loop */
1741 while (!skip_receiving) {
1742 ret = spoe_handle_receiving_frame_appctx(appctx, &skip_receiving);
1743 switch (ret) {
1744 case -1: /* error */
1745 goto next;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001746
Christopher Faulet8f82b202018-01-24 16:23:03 +01001747 case 0: /* ignore */
1748 active_r = 1;
1749 break;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001750
Christopher Faulet8f82b202018-01-24 16:23:03 +01001751 case 1: /* retry */
1752 break;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001753
Christopher Faulet8f82b202018-01-24 16:23:03 +01001754 default:
1755 active_r = 1;
1756 break;
1757 }
Christopher Fauleta1cda022016-12-21 08:58:06 +01001758 }
Christopher Fauleta1cda022016-12-21 08:58:06 +01001759
Christopher Faulet8f82b202018-01-24 16:23:03 +01001760 /* send_frame loop */
1761 while (!skip_sending && SPOE_APPCTX(appctx)->cur_fpa < agent->max_fpa) {
1762 ret = spoe_handle_sending_frame_appctx(appctx, &skip_sending);
1763 switch (ret) {
1764 case -1: /* error */
1765 goto next;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001766
Christopher Faulet8f82b202018-01-24 16:23:03 +01001767 case 0: /* ignore */
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001768 if (SPOE_APPCTX(appctx)->node.key)
1769 SPOE_APPCTX(appctx)->node.key--;
Christopher Faulet8f82b202018-01-24 16:23:03 +01001770 active_s++;
1771 break;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001772
Christopher Faulet8f82b202018-01-24 16:23:03 +01001773 case 1: /* retry */
1774 break;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001775
Christopher Faulet8f82b202018-01-24 16:23:03 +01001776 default:
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001777 if (SPOE_APPCTX(appctx)->node.key)
1778 SPOE_APPCTX(appctx)->node.key--;
Christopher Faulet8f82b202018-01-24 16:23:03 +01001779 active_s++;
1780 break;
1781 }
Christopher Fauletd7da3dd2021-08-02 18:13:27 +02001782
1783 /* if applet must be close ASAP, don't send more than a frame */
1784 if (close_asap)
1785 break;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001786 }
Christopher Fauleta1cda022016-12-21 08:58:06 +01001787
Christopher Faulet8f82b202018-01-24 16:23:03 +01001788 if (active_s || active_r) {
Christopher Faulet8f82b202018-01-24 16:23:03 +01001789 update_freq_ctr(&agent->rt[tid].processing_per_sec, active_s);
1790 SPOE_APPCTX(appctx)->task->expire = tick_add_ifset(now_ms, agent->timeout.idle);
1791 }
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001792
Christopher Faulet8f82b202018-01-24 16:23:03 +01001793 if (appctx->st0 == SPOE_APPCTX_ST_PROCESSING && SPOE_APPCTX(appctx)->cur_fpa < agent->max_fpa) {
Christopher Fauletd7da3dd2021-08-02 18:13:27 +02001794 /* If applet must be closed, don't switch it in IDLE state and
1795 * close it when the last waiting frame is acknowledged.
Christopher Faulet9e647e52021-03-01 15:01:14 +01001796 */
Christopher Fauletd7da3dd2021-08-02 18:13:27 +02001797 if (close_asap) {
1798 if (SPOE_APPCTX(appctx)->cur_fpa)
1799 goto out;
Christopher Faulet9e647e52021-03-01 15:01:14 +01001800 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_NONE;
1801 appctx->st0 = SPOE_APPCTX_ST_DISCONNECT;
1802 appctx->st1 = SPOE_APPCTX_ERR_NONE;
1803 goto next;
1804 }
Willy Tarreau4781b152021-04-06 13:53:36 +02001805 _HA_ATOMIC_INC(&agent->counters.idles);
Christopher Faulet8f82b202018-01-24 16:23:03 +01001806 appctx->st0 = SPOE_APPCTX_ST_IDLE;
Christopher Fauletb077cdc2018-01-24 16:37:57 +01001807 eb32_insert(&agent->rt[tid].idle_applets, &SPOE_APPCTX(appctx)->node);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001808 }
Christopher Fauletd7da3dd2021-08-02 18:13:27 +02001809
1810 out:
Christopher Fauleta1cda022016-12-21 08:58:06 +01001811 return 1;
1812
Christopher Faulet8f82b202018-01-24 16:23:03 +01001813 next:
1814 SPOE_APPCTX(appctx)->task->expire = tick_add_ifset(now_ms, agent->timeout.idle);
1815 return 0;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001816}
1817
1818static int
Christopher Faulet8ef75252017-02-20 22:56:03 +01001819spoe_handle_disconnect_appctx(struct appctx *appctx)
Christopher Fauleta1cda022016-12-21 08:58:06 +01001820{
Christopher Faulet908628c2022-03-25 16:43:49 +01001821 struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001822 char *frame, *buf;
1823 int ret;
Christopher Fauletb067b062017-01-04 16:39:11 +01001824
Christopher Fauleta1cda022016-12-21 08:58:06 +01001825 if (appctx->st1 == SPOE_APPCTX_ERR_TOUT)
1826 goto exit;
1827
Christopher Faulet8ef75252017-02-20 22:56:03 +01001828 /* 4 bytes are reserved at the beginning of <buf> to store the frame
1829 * length. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001830 buf = trash.area; frame = buf+4;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001831 ret = spoe_prepare_hadiscon_frame(appctx, frame,
1832 SPOE_APPCTX(appctx)->max_frame_size);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001833 if (ret > 1)
Christopher Faulet8ef75252017-02-20 22:56:03 +01001834 ret = spoe_send_frame(appctx, buf, ret);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001835
1836 switch (ret) {
1837 case -1: /* error */
Christopher Faulet8ef75252017-02-20 22:56:03 +01001838 case 0: /* ignore => an error, cannot be ignored */
Christopher Fauleta1cda022016-12-21 08:58:06 +01001839 goto exit;
1840
1841 case 1: /* retry */
Christopher Fauleta1cda022016-12-21 08:58:06 +01001842 goto stop;
1843
1844 default:
1845 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p"
1846 " - disconnected by HAProxy (%d): %s\n",
1847 (int)now.tv_sec, (int)now.tv_usec, agent->id,
Christopher Faulet8ef75252017-02-20 22:56:03 +01001848 __FUNCTION__, appctx,
1849 SPOE_APPCTX(appctx)->status_code,
1850 spoe_frm_err_reasons[SPOE_APPCTX(appctx)->status_code]);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001851
1852 appctx->st0 = SPOE_APPCTX_ST_DISCONNECTING;
1853 goto next;
1854 }
1855
1856 next:
Christopher Faulet8ef75252017-02-20 22:56:03 +01001857 SPOE_APPCTX(appctx)->task->expire =
1858 tick_add_ifset(now_ms, agent->timeout.idle);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001859 return 0;
1860 stop:
1861 return 1;
1862 exit:
1863 appctx->st0 = SPOE_APPCTX_ST_EXIT;
1864 return 0;
1865}
1866
1867static int
Christopher Faulet8ef75252017-02-20 22:56:03 +01001868spoe_handle_disconnecting_appctx(struct appctx *appctx)
Christopher Fauleta1cda022016-12-21 08:58:06 +01001869{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001870 struct stconn *sc = appctx_sc(appctx);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001871 char *frame;
1872 int ret;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001873
Christopher Fauletb067b062017-01-04 16:39:11 +01001874 if (appctx->st1 == SPOE_APPCTX_ERR_TOUT) {
Christopher Faulet8ef75252017-02-20 22:56:03 +01001875 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOUT;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001876 goto exit;
Christopher Fauletb067b062017-01-04 16:39:11 +01001877 }
Christopher Fauleta1cda022016-12-21 08:58:06 +01001878
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001879 frame = trash.area; trash.data = 0;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001880 ret = spoe_recv_frame(appctx, frame,
1881 SPOE_APPCTX(appctx)->max_frame_size);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001882 if (ret > 1) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001883 trash.data = ret + 4;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001884 ret = spoe_handle_agentdiscon_frame(appctx, frame, ret);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001885 }
1886
1887 switch (ret) {
1888 case -1: /* error */
Christopher Fauleta1cda022016-12-21 08:58:06 +01001889 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p"
1890 " - error on frame (%s)\n",
1891 (int)now.tv_sec, (int)now.tv_usec,
Christopher Faulet42bfa462017-01-04 14:14:19 +01001892 ((struct spoe_agent *)SPOE_APPCTX(appctx)->agent)->id,
Christopher Fauleta1cda022016-12-21 08:58:06 +01001893 __FUNCTION__, appctx,
Christopher Faulet8ef75252017-02-20 22:56:03 +01001894 spoe_frm_err_reasons[SPOE_APPCTX(appctx)->status_code]);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001895 goto exit;
1896
1897 case 0: /* ignore */
Christopher Fauleta1cda022016-12-21 08:58:06 +01001898 goto next;
1899
1900 case 1: /* retry */
1901 goto stop;
1902
1903 default:
Christopher Fauleta1cda022016-12-21 08:58:06 +01001904 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p"
Christopher Faulet8ef75252017-02-20 22:56:03 +01001905 " - disconnected by peer (%d): %.*s\n",
Christopher Fauleta1cda022016-12-21 08:58:06 +01001906 (int)now.tv_sec, (int)now.tv_usec,
Christopher Faulet42bfa462017-01-04 14:14:19 +01001907 ((struct spoe_agent *)SPOE_APPCTX(appctx)->agent)->id,
Christopher Faulet8ef75252017-02-20 22:56:03 +01001908 __FUNCTION__, appctx, SPOE_APPCTX(appctx)->status_code,
1909 SPOE_APPCTX(appctx)->rlen, SPOE_APPCTX(appctx)->reason);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001910 goto exit;
1911 }
1912
1913 next:
Christopher Faulet8ef75252017-02-20 22:56:03 +01001914 /* Do not forget to remove processed frame from the output buffer */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001915 if (trash.data)
Willy Tarreau9002a2e2022-05-27 10:34:25 +02001916 co_skip(sc_oc(sc), trash.data);
Christopher Faulet8ef75252017-02-20 22:56:03 +01001917
Christopher Fauleta1cda022016-12-21 08:58:06 +01001918 return 0;
1919 stop:
1920 return 1;
1921 exit:
1922 appctx->st0 = SPOE_APPCTX_ST_EXIT;
1923 return 0;
1924}
1925
1926/* I/O Handler processing messages exchanged with the agent */
1927static void
Christopher Faulet8ef75252017-02-20 22:56:03 +01001928spoe_handle_appctx(struct appctx *appctx)
Christopher Fauleta1cda022016-12-21 08:58:06 +01001929{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001930 struct stconn *sc = appctx_sc(appctx);
Christopher Faulet908628c2022-03-25 16:43:49 +01001931 struct spoe_agent *agent;
Christopher Faulet8ef75252017-02-20 22:56:03 +01001932
1933 if (SPOE_APPCTX(appctx) == NULL)
1934 return;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001935
Christopher Fauletd550d262023-03-31 11:04:34 +02001936 if (unlikely(se_fl_test(appctx->sedesc, (SE_FL_EOS|SE_FL_ERROR|SE_FL_SHR|SE_FL_SHW)))) {
1937 co_skip(sc_oc(sc), co_data(sc_oc(sc)));
1938 goto out;
1939 }
1940
Christopher Faulet8ef75252017-02-20 22:56:03 +01001941 SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_NONE;
1942 agent = SPOE_APPCTX(appctx)->agent;
Christopher Fauletb067b062017-01-04 16:39:11 +01001943
Christopher Fauleta1cda022016-12-21 08:58:06 +01001944 switchstate:
1945 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p"
1946 " - appctx-state=%s\n",
1947 (int)now.tv_sec, (int)now.tv_usec, agent->id,
1948 __FUNCTION__, appctx, spoe_appctx_state_str[appctx->st0]);
1949
1950 switch (appctx->st0) {
1951 case SPOE_APPCTX_ST_CONNECT:
Christopher Faulet8ef75252017-02-20 22:56:03 +01001952 if (spoe_handle_connect_appctx(appctx))
Christopher Fauleta1cda022016-12-21 08:58:06 +01001953 goto out;
1954 goto switchstate;
1955
1956 case SPOE_APPCTX_ST_CONNECTING:
Christopher Faulet8ef75252017-02-20 22:56:03 +01001957 if (spoe_handle_connecting_appctx(appctx))
Christopher Fauleta1cda022016-12-21 08:58:06 +01001958 goto out;
1959 goto switchstate;
1960
1961 case SPOE_APPCTX_ST_IDLE:
Willy Tarreau4781b152021-04-06 13:53:36 +02001962 _HA_ATOMIC_DEC(&agent->counters.idles);
Christopher Faulet7d9f1ba2018-02-28 13:33:26 +01001963 eb32_delete(&SPOE_APPCTX(appctx)->node);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001964 if (stopping &&
Christopher Faulet24289f22017-09-25 14:48:02 +02001965 LIST_ISEMPTY(&agent->rt[tid].sending_queue) &&
Christopher Faulet42bfa462017-01-04 14:14:19 +01001966 LIST_ISEMPTY(&SPOE_APPCTX(appctx)->waiting_queue)) {
Christopher Faulet8ef75252017-02-20 22:56:03 +01001967 SPOE_APPCTX(appctx)->task->expire =
1968 tick_add_ifset(now_ms, agent->timeout.idle);
Christopher Fauleta1cda022016-12-21 08:58:06 +01001969 appctx->st0 = SPOE_APPCTX_ST_DISCONNECT;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001970 goto switchstate;
1971 }
Christopher Fauleta1cda022016-12-21 08:58:06 +01001972 appctx->st0 = SPOE_APPCTX_ST_PROCESSING;
Willy Tarreau3064f522022-11-14 07:22:14 +01001973 __fallthrough;
Christopher Fauleta1cda022016-12-21 08:58:06 +01001974
1975 case SPOE_APPCTX_ST_PROCESSING:
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01001976 case SPOE_APPCTX_ST_SENDING_FRAG_NOTIFY:
1977 case SPOE_APPCTX_ST_WAITING_SYNC_ACK:
Christopher Faulet8ef75252017-02-20 22:56:03 +01001978 if (spoe_handle_processing_appctx(appctx))
Christopher Fauleta1cda022016-12-21 08:58:06 +01001979 goto out;
1980 goto switchstate;
1981
1982 case SPOE_APPCTX_ST_DISCONNECT:
Christopher Faulet8ef75252017-02-20 22:56:03 +01001983 if (spoe_handle_disconnect_appctx(appctx))
Christopher Fauleta1cda022016-12-21 08:58:06 +01001984 goto out;
1985 goto switchstate;
1986
1987 case SPOE_APPCTX_ST_DISCONNECTING:
Christopher Faulet8ef75252017-02-20 22:56:03 +01001988 if (spoe_handle_disconnecting_appctx(appctx))
Christopher Fauleta1cda022016-12-21 08:58:06 +01001989 goto out;
1990 goto switchstate;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001991
1992 case SPOE_APPCTX_ST_EXIT:
Christopher Faulet8ef75252017-02-20 22:56:03 +01001993 appctx->st0 = SPOE_APPCTX_ST_END;
1994 SPOE_APPCTX(appctx)->task->expire = TICK_ETERNITY;
Christopher Fauletd550d262023-03-31 11:04:34 +02001995 se_fl_set(appctx->sedesc, SE_FL_EOS);
1996 if (SPOE_APPCTX(appctx)->status_code != SPOE_FRM_ERR_NONE)
1997 se_fl_set(appctx->sedesc, SE_FL_ERROR);
1998 else
1999 se_fl_set(appctx->sedesc, SE_FL_EOI);
Willy Tarreau3064f522022-11-14 07:22:14 +01002000 __fallthrough;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002001
2002 case SPOE_APPCTX_ST_END:
Christopher Fauleta73e59b2016-12-09 17:30:18 +01002003 return;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002004 }
Christopher Fauleta1cda022016-12-21 08:58:06 +01002005 out:
Christopher Faulet42bfa462017-01-04 14:14:19 +01002006 if (SPOE_APPCTX(appctx)->task->expire != TICK_ETERNITY)
2007 task_queue(SPOE_APPCTX(appctx)->task);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002008}
2009
2010struct applet spoe_applet = {
2011 .obj_type = OBJ_TYPE_APPLET,
2012 .name = "<SPOE>", /* used for logging */
Christopher Faulet8ef75252017-02-20 22:56:03 +01002013 .fct = spoe_handle_appctx,
Christopher Faulet69ebc302022-05-12 15:28:51 +02002014 .init = spoe_init_appctx,
Christopher Faulet8ef75252017-02-20 22:56:03 +01002015 .release = spoe_release_appctx,
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002016};
2017
2018/* Create a SPOE applet. On success, the created applet is returned, else
2019 * NULL. */
2020static struct appctx *
Christopher Faulet8ef75252017-02-20 22:56:03 +01002021spoe_create_appctx(struct spoe_config *conf)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002022{
Christopher Faulet69ebc302022-05-12 15:28:51 +02002023 struct spoe_appctx *spoe_appctx;
2024 struct appctx *appctx;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002025
Christopher Faulet69ebc302022-05-12 15:28:51 +02002026 spoe_appctx = pool_zalloc(pool_head_spoe_appctx);
2027 if (spoe_appctx == NULL)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002028 goto out_error;
2029
Christopher Faulet69ebc302022-05-12 15:28:51 +02002030 spoe_appctx->agent = conf->agent;
2031 spoe_appctx->version = 0;
2032 spoe_appctx->max_frame_size = conf->agent->max_frame_size;
2033 spoe_appctx->flags = 0;
2034 spoe_appctx->status_code = SPOE_FRM_ERR_NONE;
2035 spoe_appctx->buffer = BUF_NULL;
2036 spoe_appctx->cur_fpa = 0;
2037 LIST_INIT(&spoe_appctx->list);
2038 LIST_INIT(&spoe_appctx->waiting_queue);
Christopher Faulet42bfa462017-01-04 14:14:19 +01002039
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002040
Christopher Faulet6095d572022-05-16 17:09:48 +02002041 if ((appctx = appctx_new_here(&spoe_applet, NULL)) == NULL)
Christopher Faulet69ebc302022-05-12 15:28:51 +02002042 goto out_free_spoe_appctx;
Christopher Faulet13a35e52021-12-20 15:34:16 +01002043
Christopher Faulet69ebc302022-05-12 15:28:51 +02002044 appctx->svcctx = spoe_appctx;
2045 if (appctx_init(appctx) == -1)
2046 goto out_free_appctx;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002047
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002048 appctx_wakeup(appctx);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002049 return appctx;
2050
2051 /* Error unrolling */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002052 out_free_appctx:
Christopher Faulet69ebc302022-05-12 15:28:51 +02002053 appctx_free_on_early_error(appctx);
2054 out_free_spoe_appctx:
2055 pool_free(pool_head_spoe_appctx, spoe_appctx);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002056 out_error:
2057 return NULL;
2058}
2059
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002060static int
Christopher Faulet8ef75252017-02-20 22:56:03 +01002061spoe_queue_context(struct spoe_context *ctx)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002062{
2063 struct spoe_config *conf = FLT_CONF(ctx->filter);
2064 struct spoe_agent *agent = conf->agent;
2065 struct appctx *appctx;
Christopher Faulet42bfa462017-01-04 14:14:19 +01002066 struct spoe_appctx *spoe_appctx;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002067
Christopher Fauleta1cda022016-12-21 08:58:06 +01002068 /* Check if we need to create a new SPOE applet or not. */
Christopher Fauletb077cdc2018-01-24 16:37:57 +01002069 if (!eb_is_empty(&agent->rt[tid].idle_applets) &&
Christopher Fauleteccfa612020-06-22 15:32:14 +02002070 (agent->rt[tid].processing == 1 || agent->rt[tid].processing < read_freq_ctr(&agent->rt[tid].processing_per_sec)))
Christopher Fauleta1cda022016-12-21 08:58:06 +01002071 goto end;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002072
2073 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
Christopher Fauleta1cda022016-12-21 08:58:06 +01002074 " - try to create new SPOE appctx\n",
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002075 (int)now.tv_sec, (int)now.tv_usec, agent->id, __FUNCTION__,
2076 ctx->strm);
2077
Christopher Fauleta1cda022016-12-21 08:58:06 +01002078 /* Do not try to create a new applet if there is no server up for the
2079 * agent's backend. */
2080 if (!agent->b.be->srv_act && !agent->b.be->srv_bck) {
2081 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
2082 " - cannot create SPOE appctx: no server up\n",
2083 (int)now.tv_sec, (int)now.tv_usec, agent->id,
2084 __FUNCTION__, ctx->strm);
2085 goto end;
2086 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002087
Christopher Fauleta1cda022016-12-21 08:58:06 +01002088 /* Do not try to create a new applet if we have reached the maximum of
2089 * connection per seconds */
Christopher Faulet48026722016-11-16 15:01:12 +01002090 if (agent->cps_max > 0) {
Christopher Faulet24289f22017-09-25 14:48:02 +02002091 if (!freq_ctr_remain(&agent->rt[tid].conn_per_sec, agent->cps_max, 0)) {
Christopher Fauleta1cda022016-12-21 08:58:06 +01002092 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
2093 " - cannot create SPOE appctx: max CPS reached\n",
2094 (int)now.tv_sec, (int)now.tv_usec, agent->id,
2095 __FUNCTION__, ctx->strm);
2096 goto end;
2097 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002098 }
2099
Christopher Faulet8ef75252017-02-20 22:56:03 +01002100 appctx = spoe_create_appctx(conf);
Christopher Fauleta1cda022016-12-21 08:58:06 +01002101 if (appctx == NULL) {
2102 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
2103 " - failed to create SPOE appctx\n",
2104 (int)now.tv_sec, (int)now.tv_usec, agent->id,
2105 __FUNCTION__, ctx->strm);
Christopher Faulet3b8e3492018-03-26 17:20:58 +02002106 send_log(&conf->agent_fe, LOG_EMERG,
Christopher Faulet72bcc472017-01-04 16:39:41 +01002107 "SPOE: [%s] failed to create SPOE applet\n",
2108 agent->id);
2109
Christopher Fauleta1cda022016-12-21 08:58:06 +01002110 goto end;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002111 }
2112
Christopher Fauleta1cda022016-12-21 08:58:06 +01002113 /* Increase the per-process number of cumulated connections */
2114 if (agent->cps_max > 0)
Christopher Faulet24289f22017-09-25 14:48:02 +02002115 update_freq_ctr(&agent->rt[tid].conn_per_sec, 1);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002116
Christopher Fauleta1cda022016-12-21 08:58:06 +01002117 end:
2118 /* The only reason to return an error is when there is no applet */
Christopher Faulet24289f22017-09-25 14:48:02 +02002119 if (LIST_ISEMPTY(&agent->rt[tid].applets)) {
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002120 ctx->status_code = SPOE_CTX_ERR_RES;
2121 return -1;
2122 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002123
Christopher Faulet3e86cec2019-04-10 14:02:12 +02002124 /* Add the SPOE context in the sending queue if the stream has no applet
2125 * already assigned and wakeup all idle applets. Otherwise, don't queue
2126 * it. */
Willy Tarreau4781b152021-04-06 13:53:36 +02002127 _HA_ATOMIC_INC(&agent->counters.nb_sending);
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002128 spoe_update_stat_time(&ctx->stats.tv_request, &ctx->stats.t_request);
2129 ctx->stats.tv_queue = now;
Christopher Faulet3e86cec2019-04-10 14:02:12 +02002130 if (ctx->spoe_appctx)
2131 return 1;
Willy Tarreau2b718102021-04-21 07:32:39 +02002132 LIST_APPEND(&agent->rt[tid].sending_queue, &ctx->list);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002133
2134 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
Christopher Faulet8ef75252017-02-20 22:56:03 +01002135 " - Add stream in sending queue"
Christopher Faulet68db0232018-04-06 11:34:12 +02002136 " - applets=%u - idles=%u - processing=%u\n",
Christopher Fauleta1cda022016-12-21 08:58:06 +01002137 (int)now.tv_sec, (int)now.tv_usec, agent->id, __FUNCTION__,
Christopher Faulet68db0232018-04-06 11:34:12 +02002138 ctx->strm, agent->counters.applets, agent->counters.idles,
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002139 agent->rt[tid].processing);
Christopher Fauletf7a30922016-11-10 15:04:51 +01002140
Christopher Fauletb077cdc2018-01-24 16:37:57 +01002141 /* Finally try to wakeup an IDLE applet. */
2142 if (!eb_is_empty(&agent->rt[tid].idle_applets)) {
2143 struct eb32_node *node;
2144
2145 node = eb32_first(&agent->rt[tid].idle_applets);
2146 spoe_appctx = eb32_entry(node, struct spoe_appctx, node);
2147 if (node && spoe_appctx) {
2148 eb32_delete(&spoe_appctx->node);
2149 spoe_appctx->node.key++;
2150 eb32_insert(&agent->rt[tid].idle_applets, &spoe_appctx->node);
2151 spoe_wakeup_appctx(spoe_appctx->owner);
Christopher Fauleta1cda022016-12-21 08:58:06 +01002152 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002153 }
Christopher Fauleta1cda022016-12-21 08:58:06 +01002154 return 1;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002155}
2156
2157/***************************************************************************
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002158 * Functions that encode SPOE messages
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002159 **************************************************************************/
Christopher Faulet10e37672017-09-21 16:38:22 +02002160/* Encode a SPOE message. Info in <ctx->frag_ctx>, if any, are used to handle
2161 * fragmented_content. If the next message can be processed, it returns 0. If
2162 * the message is too big, it returns -1.*/
2163static int
2164spoe_encode_message(struct stream *s, struct spoe_context *ctx,
2165 struct spoe_message *msg, int dir,
2166 char **buf, char *end)
2167{
2168 struct sample *smp;
2169 struct spoe_arg *arg;
2170 int ret;
2171
2172 if (msg->cond) {
2173 ret = acl_exec_cond(msg->cond, s->be, s->sess, s, dir|SMP_OPT_FINAL);
2174 ret = acl_pass(ret);
2175 if (msg->cond->pol == ACL_COND_UNLESS)
2176 ret = !ret;
2177
2178 /* the rule does not match */
2179 if (!ret)
2180 goto next;
2181 }
2182
2183 /* Resume encoding of a SPOE argument */
2184 if (ctx->frag_ctx.curarg != NULL) {
2185 arg = ctx->frag_ctx.curarg;
2186 goto encode_argument;
2187 }
2188
2189 if (ctx->frag_ctx.curoff != UINT_MAX)
2190 goto encode_msg_payload;
2191
2192 /* Check if there is enough space for the message name and the
2193 * number of arguments. It implies <msg->id_len> is encoded on 2
2194 * bytes, at most (< 2288). */
2195 if (*buf + 2 + msg->id_len + 1 > end)
2196 goto too_big;
2197
2198 /* Encode the message name */
2199 if (spoe_encode_buffer(msg->id, msg->id_len, buf, end) == -1)
2200 goto too_big;
2201
2202 /* Set the number of arguments for this message */
2203 **buf = msg->nargs;
2204 (*buf)++;
2205
2206 ctx->frag_ctx.curoff = 0;
2207 encode_msg_payload:
2208
2209 /* Loop on arguments */
2210 list_for_each_entry(arg, &msg->args, list) {
2211 ctx->frag_ctx.curarg = arg;
2212 ctx->frag_ctx.curoff = UINT_MAX;
Kevin Zhuf7f54282019-04-26 14:00:01 +08002213 ctx->frag_ctx.curlen = 0;
Christopher Faulet10e37672017-09-21 16:38:22 +02002214
2215 encode_argument:
2216 if (ctx->frag_ctx.curoff != UINT_MAX)
2217 goto encode_arg_value;
2218
Joseph Herlantf7f60312018-11-15 13:46:49 -08002219 /* Encode the argument name as a string. It can by NULL */
Christopher Faulet10e37672017-09-21 16:38:22 +02002220 if (spoe_encode_buffer(arg->name, arg->name_len, buf, end) == -1)
2221 goto too_big;
2222
2223 ctx->frag_ctx.curoff = 0;
2224 encode_arg_value:
2225
Joseph Herlantf7f60312018-11-15 13:46:49 -08002226 /* Fetch the argument value */
Christopher Faulet10e37672017-09-21 16:38:22 +02002227 smp = sample_process(s->be, s->sess, s, dir|SMP_OPT_FINAL, arg->expr, NULL);
Christopher Faulet3b1d0042019-05-06 09:53:10 +02002228 if (smp) {
2229 smp->ctx.a[0] = &ctx->frag_ctx.curlen;
2230 smp->ctx.a[1] = &ctx->frag_ctx.curoff;
2231 }
Christopher Faulet85db3212019-04-26 14:30:15 +02002232 ret = spoe_encode_data(smp, buf, end);
Christopher Faulet10e37672017-09-21 16:38:22 +02002233 if (ret == -1 || ctx->frag_ctx.curoff)
2234 goto too_big;
2235 }
2236
2237 next:
2238 return 0;
2239
2240 too_big:
2241 return -1;
2242}
2243
Christopher Fauletc718b822017-09-21 16:50:56 +02002244/* Encode list of SPOE messages. Info in <ctx->frag_ctx>, if any, are used to
2245 * handle fragmented content. On success it returns 1. If an error occurred, -1
2246 * is returned. If nothing has been encoded, it returns 0 (this is only possible
2247 * for unfragmented payload). */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002248static int
Christopher Faulet8ef75252017-02-20 22:56:03 +01002249spoe_encode_messages(struct stream *s, struct spoe_context *ctx,
Christopher Fauletc718b822017-09-21 16:50:56 +02002250 struct list *messages, int dir, int type)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002251{
Christopher Fauleta1cda022016-12-21 08:58:06 +01002252 struct spoe_config *conf = FLT_CONF(ctx->filter);
2253 struct spoe_agent *agent = conf->agent;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002254 struct spoe_message *msg;
Christopher Faulet8ef75252017-02-20 22:56:03 +01002255 char *p, *end;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002256
Willy Tarreauc9fa0482018-07-10 17:43:27 +02002257 p = b_head(&ctx->buffer);
Christopher Faulet24289f22017-09-25 14:48:02 +02002258 end = p + agent->rt[tid].frame_size - FRAME_HDR_SIZE;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002259
Christopher Fauletc718b822017-09-21 16:50:56 +02002260 if (type == SPOE_MSGS_BY_EVENT) { /* Loop on messages by event */
2261 /* Resume encoding of a SPOE message */
2262 if (ctx->frag_ctx.curmsg != NULL) {
2263 msg = ctx->frag_ctx.curmsg;
2264 goto encode_evt_message;
2265 }
2266
2267 list_for_each_entry(msg, messages, by_evt) {
2268 ctx->frag_ctx.curmsg = msg;
2269 ctx->frag_ctx.curarg = NULL;
2270 ctx->frag_ctx.curoff = UINT_MAX;
2271
2272 encode_evt_message:
2273 if (spoe_encode_message(s, ctx, msg, dir, &p, end) == -1)
2274 goto too_big;
2275 }
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002276 }
Christopher Fauletc718b822017-09-21 16:50:56 +02002277 else if (type == SPOE_MSGS_BY_GROUP) { /* Loop on messages by group */
2278 /* Resume encoding of a SPOE message */
2279 if (ctx->frag_ctx.curmsg != NULL) {
2280 msg = ctx->frag_ctx.curmsg;
2281 goto encode_grp_message;
2282 }
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002283
Christopher Fauletc718b822017-09-21 16:50:56 +02002284 list_for_each_entry(msg, messages, by_grp) {
2285 ctx->frag_ctx.curmsg = msg;
2286 ctx->frag_ctx.curarg = NULL;
2287 ctx->frag_ctx.curoff = UINT_MAX;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002288
Christopher Fauletc718b822017-09-21 16:50:56 +02002289 encode_grp_message:
2290 if (spoe_encode_message(s, ctx, msg, dir, &p, end) == -1)
2291 goto too_big;
2292 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002293 }
Christopher Fauletc718b822017-09-21 16:50:56 +02002294 else
2295 goto skip;
2296
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002297
Christopher Faulet57583e42017-09-04 15:41:09 +02002298 /* nothing has been encoded for an unfragmented payload */
Willy Tarreauc9fa0482018-07-10 17:43:27 +02002299 if (!(ctx->flags & SPOE_CTX_FL_FRAGMENTED) && p == b_head(&ctx->buffer))
Christopher Faulet57583e42017-09-04 15:41:09 +02002300 goto skip;
2301
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002302 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
Christopher Faulet8ef75252017-02-20 22:56:03 +01002303 " - encode %s messages - spoe_appctx=%p"
2304 "- max_size=%u - encoded=%ld\n",
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002305 (int)now.tv_sec, (int)now.tv_usec,
2306 agent->id, __FUNCTION__, s,
2307 ((ctx->flags & SPOE_CTX_FL_FRAGMENTED) ? "last fragment of" : "unfragmented"),
Christopher Fauletfce747b2018-01-24 15:59:32 +01002308 ctx->spoe_appctx, (agent->rt[tid].frame_size - FRAME_HDR_SIZE),
Christopher Faulet45073512018-07-20 10:16:29 +02002309 p - b_head(&ctx->buffer));
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002310
Willy Tarreauc9fa0482018-07-10 17:43:27 +02002311 b_set_data(&ctx->buffer, p - b_head(&ctx->buffer));
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002312 ctx->frag_ctx.curmsg = NULL;
2313 ctx->frag_ctx.curarg = NULL;
2314 ctx->frag_ctx.curoff = 0;
2315 ctx->frag_ctx.flags = SPOE_FRM_FL_FIN;
Christopher Faulet57583e42017-09-04 15:41:09 +02002316
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002317 return 1;
2318
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002319 too_big:
Christopher Fauleta715ea82019-04-10 14:21:51 +02002320 /* Return an error if fragmentation is unsupported or if nothing has
2321 * been encoded because its too big and not splittable. */
2322 if (!(agent->flags & SPOE_FL_SND_FRAGMENTATION) || p == b_head(&ctx->buffer)) {
Christopher Fauletcecd8522017-02-24 22:11:21 +01002323 ctx->status_code = SPOE_CTX_ERR_TOO_BIG;
2324 return -1;
2325 }
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002326
2327 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
Christopher Faulet8ef75252017-02-20 22:56:03 +01002328 " - encode fragmented messages - spoe_appctx=%p"
2329 " - curmsg=%p - curarg=%p - curoff=%u"
2330 " - max_size=%u - encoded=%ld\n",
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002331 (int)now.tv_sec, (int)now.tv_usec,
Christopher Fauletfce747b2018-01-24 15:59:32 +01002332 agent->id, __FUNCTION__, s, ctx->spoe_appctx,
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002333 ctx->frag_ctx.curmsg, ctx->frag_ctx.curarg, ctx->frag_ctx.curoff,
Willy Tarreauc9fa0482018-07-10 17:43:27 +02002334 (agent->rt[tid].frame_size - FRAME_HDR_SIZE), p - b_head(&ctx->buffer));
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002335
Willy Tarreauc9fa0482018-07-10 17:43:27 +02002336 b_set_data(&ctx->buffer, p - b_head(&ctx->buffer));
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002337 ctx->flags |= SPOE_CTX_FL_FRAGMENTED;
2338 ctx->frag_ctx.flags &= ~SPOE_FRM_FL_FIN;
2339 return 1;
Christopher Faulet57583e42017-09-04 15:41:09 +02002340
2341 skip:
2342 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
2343 " - skip the frame because nothing has been encoded\n",
2344 (int)now.tv_sec, (int)now.tv_usec,
2345 agent->id, __FUNCTION__, s);
2346 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002347}
2348
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002349
2350/***************************************************************************
2351 * Functions that handle SPOE actions
2352 **************************************************************************/
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002353/* Helper function to set a variable */
2354static void
Christopher Faulet8ef75252017-02-20 22:56:03 +01002355spoe_set_var(struct spoe_context *ctx, char *scope, char *name, int len,
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002356 struct sample *smp)
2357{
2358 struct spoe_config *conf = FLT_CONF(ctx->filter);
2359 struct spoe_agent *agent = conf->agent;
2360 char varname[64];
2361
2362 memset(varname, 0, sizeof(varname));
2363 len = snprintf(varname, sizeof(varname), "%s.%s.%.*s",
2364 scope, agent->var_pfx, len, name);
Etienne Carriereaec89892017-12-14 09:36:40 +00002365 if (agent->flags & SPOE_FL_FORCE_SET_VAR)
2366 vars_set_by_name(varname, len, smp);
2367 else
2368 vars_set_by_name_ifexist(varname, len, smp);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002369}
2370
2371/* Helper function to unset a variable */
2372static void
Christopher Faulet8ef75252017-02-20 22:56:03 +01002373spoe_unset_var(struct spoe_context *ctx, char *scope, char *name, int len,
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002374 struct sample *smp)
2375{
2376 struct spoe_config *conf = FLT_CONF(ctx->filter);
2377 struct spoe_agent *agent = conf->agent;
2378 char varname[64];
2379
2380 memset(varname, 0, sizeof(varname));
2381 len = snprintf(varname, sizeof(varname), "%s.%s.%.*s",
2382 scope, agent->var_pfx, len, name);
2383 vars_unset_by_name_ifexist(varname, len, smp);
2384}
2385
2386
Christopher Faulet8ef75252017-02-20 22:56:03 +01002387static inline int
2388spoe_decode_action_set_var(struct stream *s, struct spoe_context *ctx,
2389 char **buf, char *end, int dir)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002390{
Christopher Faulet8ef75252017-02-20 22:56:03 +01002391 char *str, *scope, *p = *buf;
2392 struct sample smp;
2393 uint64_t sz;
2394 int ret;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002395
Christopher Faulet8ef75252017-02-20 22:56:03 +01002396 if (p + 2 >= end)
2397 goto skip;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002398
Christopher Faulet8ef75252017-02-20 22:56:03 +01002399 /* SET-VAR requires 3 arguments */
2400 if (*p++ != 3)
2401 goto skip;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002402
Christopher Faulet8ef75252017-02-20 22:56:03 +01002403 switch (*p++) {
2404 case SPOE_SCOPE_PROC: scope = "proc"; break;
2405 case SPOE_SCOPE_SESS: scope = "sess"; break;
2406 case SPOE_SCOPE_TXN : scope = "txn"; break;
2407 case SPOE_SCOPE_REQ : scope = "req"; break;
2408 case SPOE_SCOPE_RES : scope = "res"; break;
2409 default: goto skip;
2410 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002411
Christopher Faulet8ef75252017-02-20 22:56:03 +01002412 if (spoe_decode_buffer(&p, end, &str, &sz) == -1)
2413 goto skip;
2414 memset(&smp, 0, sizeof(smp));
2415 smp_set_owner(&smp, s->be, s->sess, s, dir|SMP_OPT_FINAL);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002416
Christopher Faulet8ef75252017-02-20 22:56:03 +01002417 if (spoe_decode_data(&p, end, &smp) == -1)
2418 goto skip;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002419
Christopher Faulet8ef75252017-02-20 22:56:03 +01002420 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
2421 " - set-var '%s.%s.%.*s'\n",
2422 (int)now.tv_sec, (int)now.tv_usec,
2423 ((struct spoe_config *)FLT_CONF(ctx->filter))->agent->id,
2424 __FUNCTION__, s, scope,
2425 ((struct spoe_config *)FLT_CONF(ctx->filter))->agent->var_pfx,
2426 (int)sz, str);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002427
Christopher Faulet2469eba2020-10-15 16:08:30 +02002428 if (smp.data.type == SMP_T_ANY)
2429 spoe_unset_var(ctx, scope, str, sz, &smp);
2430 else
2431 spoe_set_var(ctx, scope, str, sz, &smp);
Christopher Fauletb5cff602016-11-24 14:53:22 +01002432
Christopher Faulet8ef75252017-02-20 22:56:03 +01002433 ret = (p - *buf);
2434 *buf = p;
2435 return ret;
2436 skip:
2437 return 0;
2438}
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002439
Christopher Faulet8ef75252017-02-20 22:56:03 +01002440static inline int
2441spoe_decode_action_unset_var(struct stream *s, struct spoe_context *ctx,
2442 char **buf, char *end, int dir)
2443{
2444 char *str, *scope, *p = *buf;
2445 struct sample smp;
2446 uint64_t sz;
2447 int ret;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002448
Christopher Faulet8ef75252017-02-20 22:56:03 +01002449 if (p + 2 >= end)
2450 goto skip;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002451
Christopher Faulet8ef75252017-02-20 22:56:03 +01002452 /* UNSET-VAR requires 2 arguments */
2453 if (*p++ != 2)
2454 goto skip;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002455
Christopher Faulet8ef75252017-02-20 22:56:03 +01002456 switch (*p++) {
2457 case SPOE_SCOPE_PROC: scope = "proc"; break;
2458 case SPOE_SCOPE_SESS: scope = "sess"; break;
2459 case SPOE_SCOPE_TXN : scope = "txn"; break;
2460 case SPOE_SCOPE_REQ : scope = "req"; break;
2461 case SPOE_SCOPE_RES : scope = "res"; break;
2462 default: goto skip;
2463 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002464
Christopher Faulet8ef75252017-02-20 22:56:03 +01002465 if (spoe_decode_buffer(&p, end, &str, &sz) == -1)
2466 goto skip;
2467 memset(&smp, 0, sizeof(smp));
2468 smp_set_owner(&smp, s->be, s->sess, s, dir|SMP_OPT_FINAL);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002469
Christopher Faulet8ef75252017-02-20 22:56:03 +01002470 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
2471 " - unset-var '%s.%s.%.*s'\n",
2472 (int)now.tv_sec, (int)now.tv_usec,
2473 ((struct spoe_config *)FLT_CONF(ctx->filter))->agent->id,
2474 __FUNCTION__, s, scope,
2475 ((struct spoe_config *)FLT_CONF(ctx->filter))->agent->var_pfx,
2476 (int)sz, str);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002477
Christopher Faulet8ef75252017-02-20 22:56:03 +01002478 spoe_unset_var(ctx, scope, str, sz, &smp);
2479
2480 ret = (p - *buf);
2481 *buf = p;
2482 return ret;
2483 skip:
2484 return 0;
2485}
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002486
Christopher Faulet8ef75252017-02-20 22:56:03 +01002487/* Process SPOE actions for a specific event. It returns 1 on success. If an
2488 * error occurred, 0 is returned. */
2489static int
Christopher Faulet58d03682017-09-21 16:57:24 +02002490spoe_process_actions(struct stream *s, struct spoe_context *ctx, int dir)
Christopher Faulet8ef75252017-02-20 22:56:03 +01002491{
2492 char *p, *end;
2493 int ret;
2494
Willy Tarreauc9fa0482018-07-10 17:43:27 +02002495 p = b_head(&ctx->buffer);
2496 end = p + b_data(&ctx->buffer);
Christopher Faulet8ef75252017-02-20 22:56:03 +01002497
2498 while (p < end) {
2499 enum spoe_action_type type;
2500
2501 type = *p++;
2502 switch (type) {
2503 case SPOE_ACT_T_SET_VAR:
2504 ret = spoe_decode_action_set_var(s, ctx, &p, end, dir);
2505 if (!ret)
2506 goto skip;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002507 break;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002508
Christopher Faulet8ef75252017-02-20 22:56:03 +01002509 case SPOE_ACT_T_UNSET_VAR:
2510 ret = spoe_decode_action_unset_var(s, ctx, &p, end, dir);
2511 if (!ret)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002512 goto skip;
Christopher Faulet8ef75252017-02-20 22:56:03 +01002513 break;
2514
2515 default:
2516 goto skip;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002517 }
2518 }
2519
2520 return 1;
2521 skip:
2522 return 0;
2523}
2524
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002525/***************************************************************************
2526 * Functions that process SPOE events
2527 **************************************************************************/
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002528static void
2529spoe_update_stats(struct stream *s, struct spoe_agent *agent,
2530 struct spoe_context *ctx, int dir)
2531{
2532 if (!tv_iszero(&ctx->stats.tv_start)) {
2533 spoe_update_stat_time(&ctx->stats.tv_start, &ctx->stats.t_process);
2534 ctx->stats.t_total += ctx->stats.t_process;
2535 tv_zero(&ctx->stats.tv_request);
2536 tv_zero(&ctx->stats.tv_queue);
2537 tv_zero(&ctx->stats.tv_wait);
2538 tv_zero(&ctx->stats.tv_response);
2539 }
2540
2541 if (agent->var_t_process) {
2542 struct sample smp;
2543
2544 memset(&smp, 0, sizeof(smp));
2545 smp_set_owner(&smp, s->be, s->sess, s, dir|SMP_OPT_FINAL);
2546 smp.data.u.sint = ctx->stats.t_process;
2547 smp.data.type = SMP_T_SINT;
2548
2549 spoe_set_var(ctx, "txn", agent->var_t_process,
2550 strlen(agent->var_t_process), &smp);
2551 }
2552
2553 if (agent->var_t_total) {
2554 struct sample smp;
2555
2556 memset(&smp, 0, sizeof(smp));
2557 smp_set_owner(&smp, s->be, s->sess, s, dir|SMP_OPT_FINAL);
2558 smp.data.u.sint = ctx->stats.t_total;
2559 smp.data.type = SMP_T_SINT;
2560
2561 spoe_set_var(ctx, "txn", agent->var_t_total,
2562 strlen(agent->var_t_total), &smp);
2563 }
2564}
2565
2566static void
2567spoe_handle_processing_error(struct stream *s, struct spoe_agent *agent,
2568 struct spoe_context *ctx, int dir)
2569{
2570 if (agent->eps_max > 0)
2571 update_freq_ctr(&agent->rt[tid].err_per_sec, 1);
2572
2573 if (agent->var_on_error) {
2574 struct sample smp;
2575
2576 memset(&smp, 0, sizeof(smp));
2577 smp_set_owner(&smp, s->be, s->sess, s, dir|SMP_OPT_FINAL);
2578 smp.data.u.sint = ctx->status_code;
2579 smp.data.type = SMP_T_BOOL;
2580
2581 spoe_set_var(ctx, "txn", agent->var_on_error,
2582 strlen(agent->var_on_error), &smp);
2583 }
2584
2585 ctx->state = ((agent->flags & SPOE_FL_CONT_ON_ERR)
2586 ? SPOE_CTX_ST_READY
2587 : SPOE_CTX_ST_NONE);
2588}
2589
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002590static inline int
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002591spoe_start_processing(struct spoe_agent *agent, struct spoe_context *ctx, int dir)
Christopher Fauleta1cda022016-12-21 08:58:06 +01002592{
Christopher Fauleta1cda022016-12-21 08:58:06 +01002593 /* If a process is already started for this SPOE context, retry
2594 * later. */
2595 if (ctx->flags & SPOE_CTX_FL_PROCESS)
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002596 return 0;
Christopher Fauleta1cda022016-12-21 08:58:06 +01002597
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002598 agent->rt[tid].processing++;
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002599 ctx->stats.tv_start = now;
2600 ctx->stats.tv_request = now;
2601 ctx->stats.t_request = -1;
2602 ctx->stats.t_queue = -1;
2603 ctx->stats.t_waiting = -1;
2604 ctx->stats.t_response = -1;
2605 ctx->stats.t_process = -1;
2606
2607 ctx->status_code = 0;
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002608
Christopher Fauleta1cda022016-12-21 08:58:06 +01002609 /* Set the right flag to prevent request and response processing
2610 * in same time. */
2611 ctx->flags |= ((dir == SMP_OPT_DIR_REQ)
2612 ? SPOE_CTX_FL_REQ_PROCESS
2613 : SPOE_CTX_FL_RSP_PROCESS);
Christopher Fauleta1cda022016-12-21 08:58:06 +01002614 return 1;
Christopher Fauleta1cda022016-12-21 08:58:06 +01002615}
2616
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002617static inline void
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002618spoe_stop_processing(struct spoe_agent *agent, struct spoe_context *ctx)
Christopher Fauleta1cda022016-12-21 08:58:06 +01002619{
Christopher Fauletfce747b2018-01-24 15:59:32 +01002620 struct spoe_appctx *sa = ctx->spoe_appctx;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002621
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002622 if (!(ctx->flags & SPOE_CTX_FL_PROCESS))
2623 return;
Willy Tarreau4781b152021-04-06 13:53:36 +02002624 _HA_ATOMIC_INC(&agent->counters.nb_processed);
Christopher Faulet879dca92018-03-23 11:53:24 +01002625 if (sa) {
2626 if (sa->frag_ctx.ctx == ctx) {
2627 sa->frag_ctx.ctx = NULL;
2628 spoe_wakeup_appctx(sa->owner);
2629 }
2630 else
2631 sa->cur_fpa--;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002632 }
2633
Christopher Fauleta1cda022016-12-21 08:58:06 +01002634 /* Reset the flag to allow next processing */
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002635 agent->rt[tid].processing--;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002636 ctx->flags &= ~(SPOE_CTX_FL_PROCESS|SPOE_CTX_FL_FRAGMENTED);
Christopher Fauleta1cda022016-12-21 08:58:06 +01002637
2638 /* Reset processing timer */
2639 ctx->process_exp = TICK_ETERNITY;
2640
Christopher Faulet8ef75252017-02-20 22:56:03 +01002641 spoe_release_buffer(&ctx->buffer, &ctx->buffer_wait);
Christopher Fauleta1cda022016-12-21 08:58:06 +01002642
Christopher Fauletfce747b2018-01-24 15:59:32 +01002643 ctx->spoe_appctx = NULL;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002644 ctx->frag_ctx.curmsg = NULL;
2645 ctx->frag_ctx.curarg = NULL;
2646 ctx->frag_ctx.curoff = 0;
2647 ctx->frag_ctx.flags = 0;
2648
Christopher Fauleta1cda022016-12-21 08:58:06 +01002649 if (!LIST_ISEMPTY(&ctx->list)) {
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002650 if (ctx->state == SPOE_CTX_ST_SENDING_MSGS)
Willy Tarreau4781b152021-04-06 13:53:36 +02002651 _HA_ATOMIC_DEC(&agent->counters.nb_sending);
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002652 else
Willy Tarreau4781b152021-04-06 13:53:36 +02002653 _HA_ATOMIC_DEC(&agent->counters.nb_waiting);
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002654
Willy Tarreau2b718102021-04-21 07:32:39 +02002655 LIST_DELETE(&ctx->list);
Christopher Fauleta1cda022016-12-21 08:58:06 +01002656 LIST_INIT(&ctx->list);
2657 }
Christopher Faulet344c4ab2017-09-22 10:20:13 +02002658}
2659
Christopher Faulet58d03682017-09-21 16:57:24 +02002660/* Process a list of SPOE messages. First, this functions will process messages
2661 * and send them to an agent in a NOTIFY frame. Then, it will wait a ACK frame
2662 * to process corresponding actions. During all the processing, it returns 0
2663 * and it returns 1 when the processing is finished. If an error occurred, -1
2664 * is returned. */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002665static int
Christopher Faulet58d03682017-09-21 16:57:24 +02002666spoe_process_messages(struct stream *s, struct spoe_context *ctx,
2667 struct list *messages, int dir, int type)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002668{
Christopher Fauletf7a30922016-11-10 15:04:51 +01002669 struct spoe_config *conf = FLT_CONF(ctx->filter);
2670 struct spoe_agent *agent = conf->agent;
Christopher Faulet58d03682017-09-21 16:57:24 +02002671 int ret = 1;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002672
2673 if (ctx->state == SPOE_CTX_ST_ERROR)
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002674 goto end;
Christopher Fauletf7a30922016-11-10 15:04:51 +01002675
2676 if (tick_is_expired(ctx->process_exp, now_ms) && ctx->state != SPOE_CTX_ST_DONE) {
2677 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
Christopher Faulet58d03682017-09-21 16:57:24 +02002678 " - failed to process messages: timeout\n",
Christopher Fauletf7a30922016-11-10 15:04:51 +01002679 (int)now.tv_sec, (int)now.tv_usec,
Christopher Faulet58d03682017-09-21 16:57:24 +02002680 agent->id, __FUNCTION__, s);
Christopher Fauletb067b062017-01-04 16:39:11 +01002681 ctx->status_code = SPOE_CTX_ERR_TOUT;
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002682 goto end;
Christopher Fauletf7a30922016-11-10 15:04:51 +01002683 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002684
2685 if (ctx->state == SPOE_CTX_ST_READY) {
Christopher Fauleta1cda022016-12-21 08:58:06 +01002686 if (agent->eps_max > 0) {
Christopher Faulet24289f22017-09-25 14:48:02 +02002687 if (!freq_ctr_remain(&agent->rt[tid].err_per_sec, agent->eps_max, 0)) {
Christopher Fauleta1cda022016-12-21 08:58:06 +01002688 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
Christopher Faulet58d03682017-09-21 16:57:24 +02002689 " - skip processing of messages: max EPS reached\n",
Christopher Fauleta1cda022016-12-21 08:58:06 +01002690 (int)now.tv_sec, (int)now.tv_usec,
Christopher Faulet58d03682017-09-21 16:57:24 +02002691 agent->id, __FUNCTION__, s);
Christopher Fauleta1cda022016-12-21 08:58:06 +01002692 goto skip;
2693 }
2694 }
2695
Christopher Fauletf7a30922016-11-10 15:04:51 +01002696 if (!tick_isset(ctx->process_exp)) {
2697 ctx->process_exp = tick_add_ifset(now_ms, agent->timeout.processing);
2698 s->task->expire = tick_first((tick_is_expired(s->task->expire, now_ms) ? 0 : s->task->expire),
2699 ctx->process_exp);
2700 }
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002701 ret = spoe_start_processing(agent, ctx, dir);
Christopher Fauletb067b062017-01-04 16:39:11 +01002702 if (!ret)
2703 goto out;
Christopher Fauleta1cda022016-12-21 08:58:06 +01002704
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002705 ctx->state = SPOE_CTX_ST_ENCODING_MSGS;
Christopher Fauleta1cda022016-12-21 08:58:06 +01002706 /* fall through */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002707 }
2708
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002709 if (ctx->state == SPOE_CTX_ST_ENCODING_MSGS) {
Christopher Faulet63263e52019-04-10 14:47:18 +02002710 if (tv_iszero(&ctx->stats.tv_request))
2711 ctx->stats.tv_request = now;
Christopher Faulet8ef75252017-02-20 22:56:03 +01002712 if (!spoe_acquire_buffer(&ctx->buffer, &ctx->buffer_wait))
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002713 goto out;
Christopher Faulet58d03682017-09-21 16:57:24 +02002714 ret = spoe_encode_messages(s, ctx, messages, dir, type);
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002715 if (ret < 0)
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002716 goto end;
Christopher Faulet57583e42017-09-04 15:41:09 +02002717 if (!ret)
2718 goto skip;
Christopher Faulet333694d2018-01-12 10:45:47 +01002719 if (spoe_queue_context(ctx) < 0)
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002720 goto end;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002721 ctx->state = SPOE_CTX_ST_SENDING_MSGS;
2722 }
2723
2724 if (ctx->state == SPOE_CTX_ST_SENDING_MSGS) {
Christopher Fauletfce747b2018-01-24 15:59:32 +01002725 if (ctx->spoe_appctx)
2726 spoe_wakeup_appctx(ctx->spoe_appctx->owner);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002727 ret = 0;
2728 goto out;
2729 }
2730
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01002731 if (ctx->state == SPOE_CTX_ST_WAITING_ACK) {
2732 ret = 0;
2733 goto out;
2734 }
2735
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002736 if (ctx->state == SPOE_CTX_ST_DONE) {
Christopher Faulet58d03682017-09-21 16:57:24 +02002737 spoe_process_actions(s, ctx, dir);
Christopher Faulet8ef75252017-02-20 22:56:03 +01002738 ret = 1;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002739 ctx->frame_id++;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002740 ctx->state = SPOE_CTX_ST_READY;
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002741 spoe_update_stat_time(&ctx->stats.tv_response, &ctx->stats.t_response);
Christopher Fauleta1cda022016-12-21 08:58:06 +01002742 goto end;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002743 }
2744
2745 out:
2746 return ret;
2747
Christopher Fauleta1cda022016-12-21 08:58:06 +01002748 skip:
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002749 tv_zero(&ctx->stats.tv_start);
Christopher Fauleta1cda022016-12-21 08:58:06 +01002750 ctx->state = SPOE_CTX_ST_READY;
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002751 spoe_stop_processing(agent, ctx);
2752 return 1;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002753
Christopher Fauleta1cda022016-12-21 08:58:06 +01002754 end:
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002755 spoe_update_stats(s, agent, ctx, dir);
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002756 spoe_stop_processing(agent, ctx);
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002757 if (ctx->status_code) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002758 _HA_ATOMIC_INC(&agent->counters.nb_errors);
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002759 spoe_handle_processing_error(s, agent, ctx, dir);
2760 ret = 1;
2761 }
Christopher Faulet58d03682017-09-21 16:57:24 +02002762 return ret;
2763}
2764
Christopher Faulet344c4ab2017-09-22 10:20:13 +02002765/* Process a SPOE group, ie the list of messages attached to the group <grp>.
2766 * See spoe_process_message for details. */
2767static int
2768spoe_process_group(struct stream *s, struct spoe_context *ctx,
2769 struct spoe_group *group, int dir)
2770{
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002771 struct spoe_config *conf = FLT_CONF(ctx->filter);
2772 struct spoe_agent *agent = conf->agent;
Christopher Faulet344c4ab2017-09-22 10:20:13 +02002773 int ret;
2774
2775 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
2776 " - ctx-state=%s - Process messages for group=%s\n",
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002777 (int)now.tv_sec, (int)now.tv_usec, agent->id,
Christopher Faulet344c4ab2017-09-22 10:20:13 +02002778 __FUNCTION__, s, spoe_ctx_state_str[ctx->state],
2779 group->id);
2780
2781 if (LIST_ISEMPTY(&group->messages))
2782 return 1;
2783
2784 ret = spoe_process_messages(s, ctx, &group->messages, dir, SPOE_MSGS_BY_GROUP);
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002785 if (ret && ctx->stats.t_process != -1) {
2786 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002787 " - <GROUP:%s> sid=%u st=%u %ld/%ld/%ld/%ld/%ld %u/%u %u/%u %llu/%llu %u/%u\n",
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002788 (int)now.tv_sec, (int)now.tv_usec, agent->id,
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002789 __FUNCTION__, s, group->id, s->uniq_id, ctx->status_code,
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002790 ctx->stats.t_request, ctx->stats.t_queue, ctx->stats.t_waiting,
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002791 ctx->stats.t_response, ctx->stats.t_process,
2792 agent->counters.idles, agent->counters.applets,
2793 agent->counters.nb_sending, agent->counters.nb_waiting,
2794 agent->counters.nb_errors, agent->counters.nb_processed,
2795 agent->rt[tid].processing, read_freq_ctr(&agent->rt[tid].processing_per_sec));
2796 if (ctx->status_code || !(conf->agent_fe.options2 & PR_O2_NOLOGNORM))
2797 send_log(&conf->agent_fe, (!ctx->status_code ? LOG_NOTICE : LOG_WARNING),
2798 "SPOE: [%s] <GROUP:%s> sid=%u st=%u %ld/%ld/%ld/%ld/%ld %u/%u %u/%u %llu/%llu\n",
2799 agent->id, group->id, s->uniq_id, ctx->status_code,
2800 ctx->stats.t_request, ctx->stats.t_queue, ctx->stats.t_waiting,
2801 ctx->stats.t_response, ctx->stats.t_process,
2802 agent->counters.idles, agent->counters.applets,
2803 agent->counters.nb_sending, agent->counters.nb_waiting,
2804 agent->counters.nb_errors, agent->counters.nb_processed);
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002805 }
Christopher Faulet344c4ab2017-09-22 10:20:13 +02002806 return ret;
2807}
2808
Christopher Faulet58d03682017-09-21 16:57:24 +02002809/* Process a SPOE event, ie the list of messages attached to the event <ev>.
2810 * See spoe_process_message for details. */
2811static int
2812spoe_process_event(struct stream *s, struct spoe_context *ctx,
2813 enum spoe_event ev)
2814{
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002815 struct spoe_config *conf = FLT_CONF(ctx->filter);
2816 struct spoe_agent *agent = conf->agent;
Christopher Faulet58d03682017-09-21 16:57:24 +02002817 int dir, ret;
2818
2819 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
Christopher Faulet344c4ab2017-09-22 10:20:13 +02002820 " - ctx-state=%s - Process messages for event=%s\n",
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002821 (int)now.tv_sec, (int)now.tv_usec, agent->id,
Christopher Faulet58d03682017-09-21 16:57:24 +02002822 __FUNCTION__, s, spoe_ctx_state_str[ctx->state],
2823 spoe_event_str[ev]);
2824
2825 dir = ((ev < SPOE_EV_ON_SERVER_SESS) ? SMP_OPT_DIR_REQ : SMP_OPT_DIR_RES);
2826
2827 if (LIST_ISEMPTY(&(ctx->events[ev])))
2828 return 1;
2829
2830 ret = spoe_process_messages(s, ctx, &(ctx->events[ev]), dir, SPOE_MSGS_BY_EVENT);
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002831 if (ret && ctx->stats.t_process != -1) {
2832 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002833 " - <EVENT:%s> sid=%u st=%u %ld/%ld/%ld/%ld/%ld %u/%u %u/%u %llu/%llu %u/%u\n",
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002834 (int)now.tv_sec, (int)now.tv_usec, agent->id,
2835 __FUNCTION__, s, spoe_event_str[ev], s->uniq_id, ctx->status_code,
2836 ctx->stats.t_request, ctx->stats.t_queue, ctx->stats.t_waiting,
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02002837 ctx->stats.t_response, ctx->stats.t_process,
2838 agent->counters.idles, agent->counters.applets,
2839 agent->counters.nb_sending, agent->counters.nb_waiting,
2840 agent->counters.nb_errors, agent->counters.nb_processed,
2841 agent->rt[tid].processing, read_freq_ctr(&agent->rt[tid].processing_per_sec));
2842 if (ctx->status_code || !(conf->agent_fe.options2 & PR_O2_NOLOGNORM))
2843 send_log(&conf->agent_fe, (!ctx->status_code ? LOG_NOTICE : LOG_WARNING),
2844 "SPOE: [%s] <EVENT:%s> sid=%u st=%u %ld/%ld/%ld/%ld/%ld %u/%u %u/%u %llu/%llu\n",
2845 agent->id, spoe_event_str[ev], s->uniq_id, ctx->status_code,
2846 ctx->stats.t_request, ctx->stats.t_queue, ctx->stats.t_waiting,
2847 ctx->stats.t_response, ctx->stats.t_process,
2848 agent->counters.idles, agent->counters.applets,
2849 agent->counters.nb_sending, agent->counters.nb_waiting,
2850 agent->counters.nb_errors, agent->counters.nb_processed);
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002851 }
Christopher Fauleta1cda022016-12-21 08:58:06 +01002852 return ret;
2853}
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002854
2855/***************************************************************************
2856 * Functions that create/destroy SPOE contexts
2857 **************************************************************************/
Christopher Fauleta1cda022016-12-21 08:58:06 +01002858static int
Willy Tarreauc9fa0482018-07-10 17:43:27 +02002859spoe_acquire_buffer(struct buffer *buf, struct buffer_wait *buffer_wait)
Christopher Fauleta1cda022016-12-21 08:58:06 +01002860{
Willy Tarreauc9fa0482018-07-10 17:43:27 +02002861 if (buf->size)
Christopher Fauleta1cda022016-12-21 08:58:06 +01002862 return 1;
2863
Willy Tarreau2b718102021-04-21 07:32:39 +02002864 if (LIST_INLIST(&buffer_wait->list))
Willy Tarreau90f366b2021-02-20 11:49:49 +01002865 LIST_DEL_INIT(&buffer_wait->list);
Christopher Fauleta1cda022016-12-21 08:58:06 +01002866
Willy Tarreaud68d4f12021-03-22 14:44:31 +01002867 if (b_alloc(buf))
Christopher Fauleta1cda022016-12-21 08:58:06 +01002868 return 1;
2869
Willy Tarreaub4e34762021-09-30 19:02:18 +02002870 LIST_APPEND(&th_ctx->buffer_wq, &buffer_wait->list);
Christopher Fauleta1cda022016-12-21 08:58:06 +01002871 return 0;
2872}
2873
2874static void
Willy Tarreauc9fa0482018-07-10 17:43:27 +02002875spoe_release_buffer(struct buffer *buf, struct buffer_wait *buffer_wait)
Christopher Fauleta1cda022016-12-21 08:58:06 +01002876{
Willy Tarreau2b718102021-04-21 07:32:39 +02002877 if (LIST_INLIST(&buffer_wait->list))
Willy Tarreau90f366b2021-02-20 11:49:49 +01002878 LIST_DEL_INIT(&buffer_wait->list);
Christopher Fauleta1cda022016-12-21 08:58:06 +01002879
2880 /* Release the buffer if needed */
Willy Tarreauc9fa0482018-07-10 17:43:27 +02002881 if (buf->size) {
Christopher Faulet4596fb72017-01-11 14:05:19 +01002882 b_free(buf);
Willy Tarreau4d77bbf2021-02-20 12:02:46 +01002883 offer_buffers(buffer_wait->target, 1);
Christopher Fauleta1cda022016-12-21 08:58:06 +01002884 }
2885}
2886
Christopher Faulet4596fb72017-01-11 14:05:19 +01002887static int
Christopher Faulet8ef75252017-02-20 22:56:03 +01002888spoe_wakeup_context(struct spoe_context *ctx)
Christopher Fauleta73e59b2016-12-09 17:30:18 +01002889{
2890 task_wakeup(ctx->strm->task, TASK_WOKEN_MSG);
2891 return 1;
2892}
2893
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002894static struct spoe_context *
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002895spoe_create_context(struct stream *s, struct filter *filter)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002896{
2897 struct spoe_config *conf = FLT_CONF(filter);
2898 struct spoe_context *ctx;
2899
Willy Tarreauc9ef9bc2021-03-22 21:04:50 +01002900 ctx = pool_zalloc(pool_head_spoe_ctx);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002901 if (ctx == NULL) {
2902 return NULL;
2903 }
Christopher Fauletb067b062017-01-04 16:39:11 +01002904 ctx->filter = filter;
2905 ctx->state = SPOE_CTX_ST_NONE;
2906 ctx->status_code = SPOE_CTX_ERR_NONE;
2907 ctx->flags = 0;
Christopher Faulet11610f32017-09-21 10:23:10 +02002908 ctx->events = conf->agent->events;
Christopher Faulet76c09ef2017-09-21 11:03:52 +02002909 ctx->groups = &conf->agent->groups;
Willy Tarreauc9fa0482018-07-10 17:43:27 +02002910 ctx->buffer = BUF_NULL;
Willy Tarreau90f366b2021-02-20 11:49:49 +01002911 LIST_INIT(&ctx->buffer_wait.list);
Christopher Fauleta73e59b2016-12-09 17:30:18 +01002912 ctx->buffer_wait.target = ctx;
Christopher Faulet8ef75252017-02-20 22:56:03 +01002913 ctx->buffer_wait.wakeup_cb = (int (*)(void *))spoe_wakeup_context;
Christopher Fauleta1cda022016-12-21 08:58:06 +01002914 LIST_INIT(&ctx->list);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002915
Christopher Fauletf7a30922016-11-10 15:04:51 +01002916 ctx->stream_id = 0;
2917 ctx->frame_id = 1;
2918 ctx->process_exp = TICK_ETERNITY;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002919
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002920 tv_zero(&ctx->stats.tv_start);
2921 tv_zero(&ctx->stats.tv_request);
2922 tv_zero(&ctx->stats.tv_queue);
2923 tv_zero(&ctx->stats.tv_wait);
2924 tv_zero(&ctx->stats.tv_response);
2925 ctx->stats.t_request = -1;
2926 ctx->stats.t_queue = -1;
2927 ctx->stats.t_waiting = -1;
2928 ctx->stats.t_response = -1;
2929 ctx->stats.t_process = -1;
2930 ctx->stats.t_total = 0;
2931
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002932 ctx->strm = s;
2933 ctx->state = SPOE_CTX_ST_READY;
2934 filter->ctx = ctx;
2935
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002936 return ctx;
2937}
2938
2939static void
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002940spoe_destroy_context(struct filter *filter)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002941{
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002942 struct spoe_config *conf = FLT_CONF(filter);
2943 struct spoe_context *ctx = filter->ctx;
2944
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002945 if (!ctx)
2946 return;
2947
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002948 spoe_stop_processing(conf->agent, ctx);
Willy Tarreaubafbe012017-11-24 17:34:44 +01002949 pool_free(pool_head_spoe_ctx, ctx);
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01002950 filter->ctx = NULL;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002951}
2952
2953static void
Christopher Faulet8ef75252017-02-20 22:56:03 +01002954spoe_reset_context(struct spoe_context *ctx)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002955{
2956 ctx->state = SPOE_CTX_ST_READY;
Christopher Fauletf032c3e2017-02-17 15:18:35 +01002957 ctx->flags &= ~(SPOE_CTX_FL_PROCESS|SPOE_CTX_FL_FRAGMENTED);
Christopher Fauletb2dd1e02018-03-22 09:07:41 +01002958
2959 tv_zero(&ctx->stats.tv_start);
2960 tv_zero(&ctx->stats.tv_request);
2961 tv_zero(&ctx->stats.tv_queue);
2962 tv_zero(&ctx->stats.tv_wait);
2963 tv_zero(&ctx->stats.tv_response);
2964 ctx->stats.t_request = -1;
2965 ctx->stats.t_queue = -1;
2966 ctx->stats.t_waiting = -1;
2967 ctx->stats.t_response = -1;
2968 ctx->stats.t_process = -1;
2969 ctx->stats.t_total = 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002970}
2971
2972
2973/***************************************************************************
2974 * Hooks that manage the filter lifecycle (init/check/deinit)
2975 **************************************************************************/
2976/* Signal handler: Do a soft stop, wakeup SPOE applet */
2977static void
Christopher Faulet8ef75252017-02-20 22:56:03 +01002978spoe_sig_stop(struct sig_handler *sh)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002979{
2980 struct proxy *p;
2981
Olivier Houchardfbc74e82017-11-24 16:54:05 +01002982 p = proxies_list;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002983 while (p) {
2984 struct flt_conf *fconf;
2985
2986 list_for_each_entry(fconf, &p->filter_configs, list) {
Christopher Faulet3b386a32017-02-23 10:17:15 +01002987 struct spoe_config *conf;
2988 struct spoe_agent *agent;
Christopher Faulet42bfa462017-01-04 14:14:19 +01002989 struct spoe_appctx *spoe_appctx;
Christopher Faulet24289f22017-09-25 14:48:02 +02002990 int i;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02002991
Christopher Faulet3b386a32017-02-23 10:17:15 +01002992 if (fconf->id != spoe_filter_id)
2993 continue;
2994
2995 conf = fconf->conf;
2996 agent = conf->agent;
2997
Christopher Faulet24289f22017-09-25 14:48:02 +02002998 for (i = 0; i < global.nbthread; ++i) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +01002999 HA_SPIN_LOCK(SPOE_APPLET_LOCK, &agent->rt[i].lock);
Christopher Faulet24289f22017-09-25 14:48:02 +02003000 list_for_each_entry(spoe_appctx, &agent->rt[i].applets, list)
3001 spoe_wakeup_appctx(spoe_appctx->owner);
Christopher Faulet2a944ee2017-11-07 10:42:54 +01003002 HA_SPIN_UNLOCK(SPOE_APPLET_LOCK, &agent->rt[i].lock);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003003 }
3004 }
3005 p = p->next;
3006 }
3007}
3008
3009
3010/* Initialize the SPOE filter. Returns -1 on error, else 0. */
3011static int
3012spoe_init(struct proxy *px, struct flt_conf *fconf)
3013{
3014 struct spoe_config *conf = fconf->conf;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003015
Christopher Faulet7250b8f2018-03-26 17:19:01 +02003016 /* conf->agent_fe was already initialized during the config
3017 * parsing. Finish initialization. */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003018 conf->agent_fe.last_change = now.tv_sec;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003019 conf->agent_fe.cap = PR_CAP_FE;
3020 conf->agent_fe.mode = PR_MODE_TCP;
3021 conf->agent_fe.maxconn = 0;
3022 conf->agent_fe.options2 |= PR_O2_INDEPSTR;
3023 conf->agent_fe.conn_retries = CONN_RETRIES;
3024 conf->agent_fe.accept = frontend_accept;
3025 conf->agent_fe.srv = NULL;
3026 conf->agent_fe.timeout.client = TICK_ETERNITY;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003027 conf->agent_fe.fe_req_ana = AN_REQ_SWITCHING_RULES;
3028
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003029 if (!sighandler_registered) {
Christopher Faulet8ef75252017-02-20 22:56:03 +01003030 signal_register_fct(0, spoe_sig_stop, 0);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003031 sighandler_registered = 1;
3032 }
3033
Christopher Faulet00292352019-01-09 15:05:10 +01003034 fconf->flags |= FLT_CFG_FL_HTX;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003035 return 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003036}
3037
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +05003038/* Free resources allocated by the SPOE filter. */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003039static void
3040spoe_deinit(struct proxy *px, struct flt_conf *fconf)
3041{
3042 struct spoe_config *conf = fconf->conf;
3043
3044 if (conf) {
3045 struct spoe_agent *agent = conf->agent;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003046
Christopher Faulet8ef75252017-02-20 22:56:03 +01003047 spoe_release_agent(agent);
Christopher Faulet7ee86672017-09-19 11:08:28 +02003048 free(conf->id);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003049 free(conf);
3050 }
3051 fconf->conf = NULL;
3052}
3053
3054/* Check configuration of a SPOE filter for a specified proxy.
3055 * Return 1 on error, else 0. */
3056static int
3057spoe_check(struct proxy *px, struct flt_conf *fconf)
3058{
Christopher Faulet7ee86672017-09-19 11:08:28 +02003059 struct flt_conf *f;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003060 struct spoe_config *conf = fconf->conf;
3061 struct proxy *target;
Christopher Faulet1d7d0f82021-02-19 10:56:41 +01003062 struct logsrv *logsrv;
Willy Tarreaub0769b22019-02-07 13:40:33 +01003063 int i;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003064
Christopher Faulet7ee86672017-09-19 11:08:28 +02003065 /* Check all SPOE filters for proxy <px> to be sure all SPOE agent names
3066 * are uniq */
3067 list_for_each_entry(f, &px->filter_configs, list) {
3068 struct spoe_config *c = f->conf;
3069
3070 /* This is not an SPOE filter */
3071 if (f->id != spoe_filter_id)
3072 continue;
3073 /* This is the current SPOE filter */
3074 if (f == fconf)
3075 continue;
3076
3077 /* Check engine Id. It should be uniq */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003078 if (strcmp(conf->id, c->id) == 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003079 ha_alert("Proxy %s : duplicated name for SPOE engine '%s'.\n",
3080 px->id, conf->id);
Christopher Faulet7ee86672017-09-19 11:08:28 +02003081 return 1;
3082 }
3083 }
3084
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003085 target = proxy_be_by_name(conf->agent->b.name);
3086 if (target == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003087 ha_alert("Proxy %s : unknown backend '%s' used by SPOE agent '%s'"
3088 " declared at %s:%d.\n",
3089 px->id, conf->agent->b.name, conf->agent->id,
3090 conf->agent->conf.file, conf->agent->conf.line);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003091 return 1;
3092 }
3093 if (target->mode != PR_MODE_TCP) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003094 ha_alert("Proxy %s : backend '%s' used by SPOE agent '%s' declared"
3095 " at %s:%d does not support HTTP mode.\n",
3096 px->id, target->id, conf->agent->id,
3097 conf->agent->conf.file, conf->agent->conf.line);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003098 return 1;
3099 }
3100
Christopher Fauletfe261552019-03-18 13:57:42 +01003101 if ((conf->agent->rt = calloc(global.nbthread, sizeof(*conf->agent->rt))) == NULL) {
Willy Tarreaub0769b22019-02-07 13:40:33 +01003102 ha_alert("Proxy %s : out of memory initializing SPOE agent '%s' declared at %s:%d.\n",
3103 px->id, conf->agent->id, conf->agent->conf.file, conf->agent->conf.line);
3104 return 1;
3105 }
3106 for (i = 0; i < global.nbthread; ++i) {
Christopher Fauletb1bb1af2019-09-17 11:55:52 +02003107 conf->agent->rt[i].engine_id = NULL;
Christopher Fauletfe261552019-03-18 13:57:42 +01003108 conf->agent->rt[i].frame_size = conf->agent->max_frame_size;
3109 conf->agent->rt[i].processing = 0;
3110 LIST_INIT(&conf->agent->rt[i].applets);
3111 LIST_INIT(&conf->agent->rt[i].sending_queue);
3112 LIST_INIT(&conf->agent->rt[i].waiting_queue);
3113 HA_SPIN_INIT(&conf->agent->rt[i].lock);
Willy Tarreaub0769b22019-02-07 13:40:33 +01003114 }
3115
Christopher Faulet1d7d0f82021-02-19 10:56:41 +01003116 list_for_each_entry(logsrv, &conf->agent_fe.logsrvs, list) {
3117 if (logsrv->type == LOG_TARGET_BUFFER) {
3118 struct sink *sink = sink_find(logsrv->ring_name);
3119
3120 if (!sink || sink->type != SINK_TYPE_BUFFER) {
3121 ha_alert("Proxy %s : log server used by SPOE agent '%s' declared"
Ilya Shipitsind7a988c2021-03-04 23:26:15 +05003122 " at %s:%d uses unknown ring named '%s'.\n",
Christopher Faulet1d7d0f82021-02-19 10:56:41 +01003123 px->id, conf->agent->id, conf->agent->conf.file,
3124 conf->agent->conf.line, logsrv->ring_name);
3125 return 1;
3126 }
3127 logsrv->sink = sink;
3128 }
3129 }
3130
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003131 ha_free(&conf->agent->b.name);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003132 conf->agent->b.be = target;
3133 return 0;
3134}
3135
Kevin Zhud87b1a52019-09-17 15:05:45 +02003136/* Initializes the SPOE filter for a proxy for a specific thread.
3137 * Returns a negative value if an error occurs. */
3138static int
3139spoe_init_per_thread(struct proxy *p, struct flt_conf *fconf)
3140{
3141 struct spoe_config *conf = fconf->conf;
3142 struct spoe_agent *agent = conf->agent;
3143
Christopher Fauletb1bb1af2019-09-17 11:55:52 +02003144 agent->rt[tid].engine_id = generate_pseudo_uuid();
3145 if (agent->rt[tid].engine_id == NULL)
3146 return -1;
Kevin Zhud87b1a52019-09-17 15:05:45 +02003147 return 0;
3148}
3149
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003150/**************************************************************************
3151 * Hooks attached to a stream
3152 *************************************************************************/
3153/* Called when a filter instance is created and attach to a stream. It creates
3154 * the context that will be used to process this stream. */
3155static int
3156spoe_start(struct stream *s, struct filter *filter)
3157{
Christopher Faulet72bcc472017-01-04 16:39:41 +01003158 struct spoe_config *conf = FLT_CONF(filter);
3159 struct spoe_agent *agent = conf->agent;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003160 struct spoe_context *ctx;
3161
3162 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p\n",
Christopher Faulet72bcc472017-01-04 16:39:41 +01003163 (int)now.tv_sec, (int)now.tv_usec, agent->id,
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003164 __FUNCTION__, s);
3165
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01003166 if ((ctx = spoe_create_context(s, filter)) == NULL) {
Christopher Faulet72bcc472017-01-04 16:39:41 +01003167 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
3168 " - failed to create SPOE context\n",
3169 (int)now.tv_sec, (int)now.tv_usec, agent->id,
Christopher Fauletccbc3fd2017-09-15 11:51:18 +02003170 __FUNCTION__, s);
Christopher Faulet3b8e3492018-03-26 17:20:58 +02003171 send_log(&conf->agent_fe, LOG_EMERG,
Christopher Faulet72bcc472017-01-04 16:39:41 +01003172 "SPOE: [%s] failed to create SPOE context\n",
3173 agent->id);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003174 return 0;
3175 }
3176
Christopher Faulet11610f32017-09-21 10:23:10 +02003177 if (!LIST_ISEMPTY(&ctx->events[SPOE_EV_ON_TCP_REQ_FE]))
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003178 filter->pre_analyzers |= AN_REQ_INSPECT_FE;
3179
Christopher Faulet11610f32017-09-21 10:23:10 +02003180 if (!LIST_ISEMPTY(&ctx->events[SPOE_EV_ON_TCP_REQ_BE]))
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003181 filter->pre_analyzers |= AN_REQ_INSPECT_BE;
3182
Christopher Faulet11610f32017-09-21 10:23:10 +02003183 if (!LIST_ISEMPTY(&ctx->events[SPOE_EV_ON_TCP_RSP]))
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003184 filter->pre_analyzers |= AN_RES_INSPECT;
3185
Christopher Faulet11610f32017-09-21 10:23:10 +02003186 if (!LIST_ISEMPTY(&ctx->events[SPOE_EV_ON_HTTP_REQ_FE]))
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003187 filter->pre_analyzers |= AN_REQ_HTTP_PROCESS_FE;
3188
Christopher Faulet11610f32017-09-21 10:23:10 +02003189 if (!LIST_ISEMPTY(&ctx->events[SPOE_EV_ON_HTTP_REQ_BE]))
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003190 filter->pre_analyzers |= AN_REQ_HTTP_PROCESS_BE;
3191
Christopher Faulet11610f32017-09-21 10:23:10 +02003192 if (!LIST_ISEMPTY(&ctx->events[SPOE_EV_ON_HTTP_RSP]))
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003193 filter->pre_analyzers |= AN_RES_HTTP_PROCESS_FE;
3194
3195 return 1;
3196}
3197
3198/* Called when a filter instance is detached from a stream. It release the
3199 * attached SPOE context. */
3200static void
3201spoe_stop(struct stream *s, struct filter *filter)
3202{
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003203 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p\n",
3204 (int)now.tv_sec, (int)now.tv_usec,
3205 ((struct spoe_config *)FLT_CONF(filter))->agent->id,
3206 __FUNCTION__, s);
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01003207 spoe_destroy_context(filter);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003208}
3209
Christopher Fauletf7a30922016-11-10 15:04:51 +01003210
3211/*
3212 * Called when the stream is woken up because of expired timer.
3213 */
3214static void
3215spoe_check_timeouts(struct stream *s, struct filter *filter)
3216{
3217 struct spoe_context *ctx = filter->ctx;
3218
Christopher Fauletac580602018-03-20 16:09:20 +01003219 if (tick_is_expired(ctx->process_exp, now_ms))
Christopher Fauleta73e59b2016-12-09 17:30:18 +01003220 s->pending_events |= TASK_WOKEN_MSG;
Christopher Fauletf7a30922016-11-10 15:04:51 +01003221}
3222
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003223/* Called when we are ready to filter data on a channel */
3224static int
3225spoe_start_analyze(struct stream *s, struct filter *filter, struct channel *chn)
3226{
3227 struct spoe_context *ctx = filter->ctx;
3228 int ret = 1;
3229
3230 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p - ctx-state=%s"
3231 " - ctx-flags=0x%08x\n",
3232 (int)now.tv_sec, (int)now.tv_usec,
3233 ((struct spoe_config *)FLT_CONF(filter))->agent->id,
3234 __FUNCTION__, s, spoe_ctx_state_str[ctx->state], ctx->flags);
3235
Christopher Fauletb067b062017-01-04 16:39:11 +01003236 if (ctx->state == SPOE_CTX_ST_NONE)
3237 goto out;
3238
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003239 if (!(chn->flags & CF_ISRESP)) {
3240 if (filter->pre_analyzers & AN_REQ_INSPECT_FE)
3241 chn->analysers |= AN_REQ_INSPECT_FE;
3242 if (filter->pre_analyzers & AN_REQ_INSPECT_BE)
3243 chn->analysers |= AN_REQ_INSPECT_BE;
3244
3245 if (ctx->flags & SPOE_CTX_FL_CLI_CONNECTED)
3246 goto out;
3247
3248 ctx->stream_id = s->uniq_id;
Christopher Faulet8ef75252017-02-20 22:56:03 +01003249 ret = spoe_process_event(s, ctx, SPOE_EV_ON_CLIENT_SESS);
Christopher Fauletb067b062017-01-04 16:39:11 +01003250 if (!ret)
3251 goto out;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003252 ctx->flags |= SPOE_CTX_FL_CLI_CONNECTED;
3253 }
3254 else {
Miroslav Zagorac88403262020-06-19 22:17:17 +02003255 if (filter->pre_analyzers & AN_RES_INSPECT)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003256 chn->analysers |= AN_RES_INSPECT;
3257
3258 if (ctx->flags & SPOE_CTX_FL_SRV_CONNECTED)
3259 goto out;
3260
Christopher Faulet8ef75252017-02-20 22:56:03 +01003261 ret = spoe_process_event(s, ctx, SPOE_EV_ON_SERVER_SESS);
Christopher Fauleta1cda022016-12-21 08:58:06 +01003262 if (!ret) {
3263 channel_dont_read(chn);
3264 channel_dont_close(chn);
Christopher Fauletb067b062017-01-04 16:39:11 +01003265 goto out;
Christopher Fauleta1cda022016-12-21 08:58:06 +01003266 }
Christopher Fauletb067b062017-01-04 16:39:11 +01003267 ctx->flags |= SPOE_CTX_FL_SRV_CONNECTED;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003268 }
3269
3270 out:
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003271 return ret;
3272}
3273
3274/* Called before a processing happens on a given channel */
3275static int
3276spoe_chn_pre_analyze(struct stream *s, struct filter *filter,
3277 struct channel *chn, unsigned an_bit)
3278{
3279 struct spoe_context *ctx = filter->ctx;
3280 int ret = 1;
3281
3282 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p - ctx-state=%s"
3283 " - ctx-flags=0x%08x - ana=0x%08x\n",
3284 (int)now.tv_sec, (int)now.tv_usec,
3285 ((struct spoe_config *)FLT_CONF(filter))->agent->id,
3286 __FUNCTION__, s, spoe_ctx_state_str[ctx->state],
3287 ctx->flags, an_bit);
3288
Christopher Fauletb067b062017-01-04 16:39:11 +01003289 if (ctx->state == SPOE_CTX_ST_NONE)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003290 goto out;
3291
3292 switch (an_bit) {
3293 case AN_REQ_INSPECT_FE:
Christopher Faulet8ef75252017-02-20 22:56:03 +01003294 ret = spoe_process_event(s, ctx, SPOE_EV_ON_TCP_REQ_FE);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003295 break;
3296 case AN_REQ_INSPECT_BE:
Christopher Faulet8ef75252017-02-20 22:56:03 +01003297 ret = spoe_process_event(s, ctx, SPOE_EV_ON_TCP_REQ_BE);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003298 break;
3299 case AN_RES_INSPECT:
Christopher Faulet8ef75252017-02-20 22:56:03 +01003300 ret = spoe_process_event(s, ctx, SPOE_EV_ON_TCP_RSP);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003301 break;
3302 case AN_REQ_HTTP_PROCESS_FE:
Christopher Faulet8ef75252017-02-20 22:56:03 +01003303 ret = spoe_process_event(s, ctx, SPOE_EV_ON_HTTP_REQ_FE);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003304 break;
3305 case AN_REQ_HTTP_PROCESS_BE:
Christopher Faulet8ef75252017-02-20 22:56:03 +01003306 ret = spoe_process_event(s, ctx, SPOE_EV_ON_HTTP_REQ_BE);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003307 break;
3308 case AN_RES_HTTP_PROCESS_FE:
Christopher Faulet8ef75252017-02-20 22:56:03 +01003309 ret = spoe_process_event(s, ctx, SPOE_EV_ON_HTTP_RSP);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003310 break;
3311 }
3312
3313 out:
Christopher Faulet9cdca972018-02-01 08:45:45 +01003314 if (!ret && (chn->flags & CF_ISRESP)) {
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003315 channel_dont_read(chn);
3316 channel_dont_close(chn);
3317 }
3318 return ret;
3319}
3320
3321/* Called when the filtering on the channel ends. */
3322static int
3323spoe_end_analyze(struct stream *s, struct filter *filter, struct channel *chn)
3324{
3325 struct spoe_context *ctx = filter->ctx;
3326
3327 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p - ctx-state=%s"
3328 " - ctx-flags=0x%08x\n",
3329 (int)now.tv_sec, (int)now.tv_usec,
3330 ((struct spoe_config *)FLT_CONF(filter))->agent->id,
3331 __FUNCTION__, s, spoe_ctx_state_str[ctx->state], ctx->flags);
3332
3333 if (!(ctx->flags & SPOE_CTX_FL_PROCESS)) {
Christopher Faulet8ef75252017-02-20 22:56:03 +01003334 spoe_reset_context(ctx);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003335 }
3336
3337 return 1;
3338}
3339
3340/********************************************************************
3341 * Functions that manage the filter initialization
3342 ********************************************************************/
3343struct flt_ops spoe_ops = {
3344 /* Manage SPOE filter, called for each filter declaration */
3345 .init = spoe_init,
3346 .deinit = spoe_deinit,
3347 .check = spoe_check,
Kevin Zhud87b1a52019-09-17 15:05:45 +02003348 .init_per_thread = spoe_init_per_thread,
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003349
3350 /* Handle start/stop of SPOE */
Christopher Fauletf7a30922016-11-10 15:04:51 +01003351 .attach = spoe_start,
3352 .detach = spoe_stop,
3353 .check_timeouts = spoe_check_timeouts,
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003354
3355 /* Handle channels activity */
3356 .channel_start_analyze = spoe_start_analyze,
3357 .channel_pre_analyze = spoe_chn_pre_analyze,
3358 .channel_end_analyze = spoe_end_analyze,
3359};
3360
3361
3362static int
3363cfg_parse_spoe_agent(const char *file, int linenum, char **args, int kwm)
3364{
3365 const char *err;
3366 int i, err_code = 0;
3367
3368 if ((cfg_scope == NULL && curengine != NULL) ||
3369 (cfg_scope != NULL && curengine == NULL) ||
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003370 (curengine != NULL && cfg_scope != NULL && strcmp(curengine, cfg_scope) != 0))
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003371 goto out;
3372
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003373 if (strcmp(args[0], "spoe-agent") == 0) { /* new spoe-agent section */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003374 if (!*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003375 ha_alert("parsing [%s:%d] : missing name for spoe-agent section.\n",
3376 file, linenum);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003377 err_code |= ERR_ALERT | ERR_ABORT;
3378 goto out;
3379 }
Christopher Fauletecc537a2017-02-23 22:52:39 +01003380 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
3381 err_code |= ERR_ABORT;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003382 goto out;
3383 }
3384
3385 err = invalid_char(args[1]);
3386 if (err) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003387 ha_alert("parsing [%s:%d] : character '%c' is not permitted in '%s' name '%s'.\n",
3388 file, linenum, *err, args[0], args[1]);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003389 err_code |= ERR_ALERT | ERR_ABORT;
3390 goto out;
3391 }
3392
3393 if (curagent != NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003394 ha_alert("parsing [%s:%d] : another spoe-agent section previously defined.\n",
3395 file, linenum);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003396 err_code |= ERR_ALERT | ERR_ABORT;
3397 goto out;
3398 }
3399 if ((curagent = calloc(1, sizeof(*curagent))) == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003400 ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003401 err_code |= ERR_ALERT | ERR_ABORT;
3402 goto out;
3403 }
3404
3405 curagent->id = strdup(args[1]);
Christopher Fauleta1cda022016-12-21 08:58:06 +01003406
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003407 curagent->conf.file = strdup(file);
3408 curagent->conf.line = linenum;
Christopher Fauleta1cda022016-12-21 08:58:06 +01003409
3410 curagent->timeout.hello = TICK_ETERNITY;
3411 curagent->timeout.idle = TICK_ETERNITY;
Christopher Fauletf7a30922016-11-10 15:04:51 +01003412 curagent->timeout.processing = TICK_ETERNITY;
Christopher Fauleta1cda022016-12-21 08:58:06 +01003413
Christopher Fauleta1cda022016-12-21 08:58:06 +01003414 curagent->var_pfx = NULL;
3415 curagent->var_on_error = NULL;
Christopher Faulet36bda1c2018-03-22 09:08:20 +01003416 curagent->var_t_process = NULL;
3417 curagent->var_t_total = NULL;
Christopher Fauletb1bb1af2019-09-17 11:55:52 +02003418 curagent->flags = (SPOE_FL_ASYNC | SPOE_FL_PIPELINING | SPOE_FL_SND_FRAGMENTATION);
Christopher Fauleta1cda022016-12-21 08:58:06 +01003419 curagent->cps_max = 0;
3420 curagent->eps_max = 0;
Christopher Faulet7aa0b2b2017-01-13 11:30:50 +01003421 curagent->max_frame_size = MAX_FRAME_SIZE;
Christopher Fauletb077cdc2018-01-24 16:37:57 +01003422 curagent->max_fpa = 20;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003423
3424 for (i = 0; i < SPOE_EV_EVENTS; ++i)
Christopher Faulet11610f32017-09-21 10:23:10 +02003425 LIST_INIT(&curagent->events[i]);
3426 LIST_INIT(&curagent->groups);
3427 LIST_INIT(&curagent->messages);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003428 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003429 else if (strcmp(args[0], "use-backend") == 0) {
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003430 if (!*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003431 ha_alert("parsing [%s:%d] : '%s' expects a backend name.\n",
3432 file, linenum, args[0]);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003433 err_code |= ERR_ALERT | ERR_FATAL;
3434 goto out;
3435 }
Christopher Fauletecc537a2017-02-23 22:52:39 +01003436 if (alertif_too_many_args(1, file, linenum, args, &err_code))
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003437 goto out;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003438 free(curagent->b.name);
3439 curagent->b.name = strdup(args[1]);
3440 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003441 else if (strcmp(args[0], "messages") == 0) {
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003442 int cur_arg = 1;
3443 while (*args[cur_arg]) {
Christopher Faulet11610f32017-09-21 10:23:10 +02003444 struct spoe_placeholder *ph = NULL;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003445
Christopher Faulet11610f32017-09-21 10:23:10 +02003446 list_for_each_entry(ph, &curmphs, list) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003447 if (strcmp(ph->id, args[cur_arg]) == 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003448 ha_alert("parsing [%s:%d]: spoe-message '%s' already used.\n",
3449 file, linenum, args[cur_arg]);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003450 err_code |= ERR_ALERT | ERR_FATAL;
3451 goto out;
3452 }
3453 }
3454
Christopher Faulet11610f32017-09-21 10:23:10 +02003455 if ((ph = calloc(1, sizeof(*ph))) == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003456 ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003457 err_code |= ERR_ALERT | ERR_ABORT;
3458 goto out;
3459 }
Christopher Faulet11610f32017-09-21 10:23:10 +02003460 ph->id = strdup(args[cur_arg]);
Willy Tarreau2b718102021-04-21 07:32:39 +02003461 LIST_APPEND(&curmphs, &ph->list);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003462 cur_arg++;
3463 }
3464 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003465 else if (strcmp(args[0], "groups") == 0) {
Christopher Faulet11610f32017-09-21 10:23:10 +02003466 int cur_arg = 1;
3467 while (*args[cur_arg]) {
3468 struct spoe_placeholder *ph = NULL;
3469
3470 list_for_each_entry(ph, &curgphs, list) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003471 if (strcmp(ph->id, args[cur_arg]) == 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003472 ha_alert("parsing [%s:%d]: spoe-group '%s' already used.\n",
3473 file, linenum, args[cur_arg]);
Christopher Faulet11610f32017-09-21 10:23:10 +02003474 err_code |= ERR_ALERT | ERR_FATAL;
3475 goto out;
3476 }
3477 }
3478
3479 if ((ph = calloc(1, sizeof(*ph))) == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003480 ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum);
Christopher Faulet11610f32017-09-21 10:23:10 +02003481 err_code |= ERR_ALERT | ERR_ABORT;
3482 goto out;
3483 }
3484 ph->id = strdup(args[cur_arg]);
Willy Tarreau2b718102021-04-21 07:32:39 +02003485 LIST_APPEND(&curgphs, &ph->list);
Christopher Faulet11610f32017-09-21 10:23:10 +02003486 cur_arg++;
3487 }
3488 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003489 else if (strcmp(args[0], "timeout") == 0) {
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003490 unsigned int *tv = NULL;
3491 const char *res;
3492 unsigned timeout;
3493
3494 if (!*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003495 ha_alert("parsing [%s:%d] : 'timeout' expects 'hello', 'idle' and 'processing'.\n",
3496 file, linenum);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003497 err_code |= ERR_ALERT | ERR_FATAL;
3498 goto out;
3499 }
Christopher Fauletecc537a2017-02-23 22:52:39 +01003500 if (alertif_too_many_args(2, file, linenum, args, &err_code))
3501 goto out;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003502 if (strcmp(args[1], "hello") == 0)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003503 tv = &curagent->timeout.hello;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003504 else if (strcmp(args[1], "idle") == 0)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003505 tv = &curagent->timeout.idle;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003506 else if (strcmp(args[1], "processing") == 0)
Christopher Fauletf7a30922016-11-10 15:04:51 +01003507 tv = &curagent->timeout.processing;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003508 else {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003509 ha_alert("parsing [%s:%d] : 'timeout' supports 'hello', 'idle' or 'processing' (got %s).\n",
3510 file, linenum, args[1]);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003511 err_code |= ERR_ALERT | ERR_FATAL;
3512 goto out;
3513 }
3514 if (!*args[2]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003515 ha_alert("parsing [%s:%d] : 'timeout %s' expects an integer value (in milliseconds).\n",
3516 file, linenum, args[1]);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003517 err_code |= ERR_ALERT | ERR_FATAL;
3518 goto out;
3519 }
3520 res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
Willy Tarreau9faebe32019-06-07 19:00:37 +02003521 if (res == PARSE_TIME_OVER) {
3522 ha_alert("parsing [%s:%d]: timer overflow in argument <%s> to <%s %s>, maximum value is 2147483647 ms (~24.8 days).\n",
3523 file, linenum, args[2], args[0], args[1]);
3524 err_code |= ERR_ALERT | ERR_FATAL;
3525 goto out;
3526 }
3527 else if (res == PARSE_TIME_UNDER) {
3528 ha_alert("parsing [%s:%d]: timer underflow in argument <%s> to <%s %s>, minimum non-null value is 1 ms.\n",
3529 file, linenum, args[2], args[0], args[1]);
3530 err_code |= ERR_ALERT | ERR_FATAL;
3531 goto out;
3532 }
3533 else if (res) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003534 ha_alert("parsing [%s:%d] : unexpected character '%c' in 'timeout %s'.\n",
3535 file, linenum, *res, args[1]);
Christopher Fauletecc537a2017-02-23 22:52:39 +01003536 err_code |= ERR_ALERT | ERR_FATAL;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003537 goto out;
3538 }
3539 *tv = MS_TO_TICKS(timeout);
3540 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003541 else if (strcmp(args[0], "option") == 0) {
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003542 if (!*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003543 ha_alert("parsing [%s:%d]: '%s' expects an option name.\n",
3544 file, linenum, args[0]);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003545 err_code |= ERR_ALERT | ERR_FATAL;
3546 goto out;
3547 }
Christopher Faulet6a2940c2017-02-23 15:06:26 +01003548
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003549 if (strcmp(args[1], "pipelining") == 0) {
Christopher Fauletecc537a2017-02-23 22:52:39 +01003550 if (alertif_too_many_args(1, file, linenum, args, &err_code))
Christopher Faulet305c6072017-02-23 16:17:53 +01003551 goto out;
Christopher Faulet305c6072017-02-23 16:17:53 +01003552 if (kwm == 1)
3553 curagent->flags &= ~SPOE_FL_PIPELINING;
3554 else
3555 curagent->flags |= SPOE_FL_PIPELINING;
3556 goto out;
3557 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003558 else if (strcmp(args[1], "async") == 0) {
Christopher Fauletecc537a2017-02-23 22:52:39 +01003559 if (alertif_too_many_args(1, file, linenum, args, &err_code))
Christopher Faulet305c6072017-02-23 16:17:53 +01003560 goto out;
Christopher Faulet305c6072017-02-23 16:17:53 +01003561 if (kwm == 1)
3562 curagent->flags &= ~SPOE_FL_ASYNC;
Christopher Fauletb1bb1af2019-09-17 11:55:52 +02003563 else
3564 curagent->flags |= SPOE_FL_ASYNC;
Christopher Faulet305c6072017-02-23 16:17:53 +01003565 goto out;
3566 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003567 else if (strcmp(args[1], "send-frag-payload") == 0) {
Christopher Fauletcecd8522017-02-24 22:11:21 +01003568 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3569 goto out;
3570 if (kwm == 1)
3571 curagent->flags &= ~SPOE_FL_SND_FRAGMENTATION;
3572 else
3573 curagent->flags |= SPOE_FL_SND_FRAGMENTATION;
3574 goto out;
3575 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003576 else if (strcmp(args[1], "dontlog-normal") == 0) {
Christopher Faulet0e0f0852018-03-26 17:20:36 +02003577 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3578 goto out;
3579 if (kwm == 1)
3580 curpxopts2 &= ~PR_O2_NOLOGNORM;
3581 else
3582 curpxopts2 |= PR_O2_NOLOGNORM;
Christopher Faulet799f5182018-04-26 11:36:34 +02003583 goto out;
Christopher Faulet0e0f0852018-03-26 17:20:36 +02003584 }
Christopher Faulet305c6072017-02-23 16:17:53 +01003585
Christopher Faulet6a2940c2017-02-23 15:06:26 +01003586 /* Following options does not support negation */
3587 if (kwm == 1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003588 ha_alert("parsing [%s:%d]: negation is not supported for option '%s'.\n",
3589 file, linenum, args[1]);
Christopher Faulet6a2940c2017-02-23 15:06:26 +01003590 err_code |= ERR_ALERT | ERR_FATAL;
3591 goto out;
3592 }
3593
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003594 if (strcmp(args[1], "var-prefix") == 0) {
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003595 char *tmp;
3596
3597 if (!*args[2]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003598 ha_alert("parsing [%s:%d]: '%s %s' expects a value.\n",
3599 file, linenum, args[0],
3600 args[1]);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003601 err_code |= ERR_ALERT | ERR_FATAL;
3602 goto out;
3603 }
Christopher Fauletecc537a2017-02-23 22:52:39 +01003604 if (alertif_too_many_args(2, file, linenum, args, &err_code))
3605 goto out;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003606 tmp = args[2];
3607 while (*tmp) {
Willy Tarreau90807112020-02-25 08:16:33 +01003608 if (!isalnum((unsigned char)*tmp) && *tmp != '_' && *tmp != '.') {
Thierry FOURNIER01a3f202018-05-10 16:41:26 +02003609 ha_alert("parsing [%s:%d]: '%s %s' only supports [a-zA-Z0-9_.] chars.\n",
Christopher Faulet767a84b2017-11-24 16:50:31 +01003610 file, linenum, args[0], args[1]);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003611 err_code |= ERR_ALERT | ERR_FATAL;
3612 goto out;
3613 }
3614 tmp++;
3615 }
3616 curagent->var_pfx = strdup(args[2]);
3617 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003618 else if (strcmp(args[1], "force-set-var") == 0) {
Etienne Carriereaec89892017-12-14 09:36:40 +00003619 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3620 goto out;
3621 curagent->flags |= SPOE_FL_FORCE_SET_VAR;
3622 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003623 else if (strcmp(args[1], "continue-on-error") == 0) {
Christopher Fauletecc537a2017-02-23 22:52:39 +01003624 if (alertif_too_many_args(1, file, linenum, args, &err_code))
Christopher Fauletea62c2a2016-11-14 10:54:21 +01003625 goto out;
Christopher Fauletea62c2a2016-11-14 10:54:21 +01003626 curagent->flags |= SPOE_FL_CONT_ON_ERR;
3627 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003628 else if (strcmp(args[1], "set-on-error") == 0) {
Christopher Faulet985532d2016-11-16 15:36:19 +01003629 char *tmp;
3630
3631 if (!*args[2]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003632 ha_alert("parsing [%s:%d]: '%s %s' expects a value.\n",
3633 file, linenum, args[0],
3634 args[1]);
Christopher Faulet985532d2016-11-16 15:36:19 +01003635 err_code |= ERR_ALERT | ERR_FATAL;
3636 goto out;
3637 }
Christopher Fauletecc537a2017-02-23 22:52:39 +01003638 if (alertif_too_many_args(2, file, linenum, args, &err_code))
3639 goto out;
Christopher Faulet985532d2016-11-16 15:36:19 +01003640 tmp = args[2];
3641 while (*tmp) {
Willy Tarreau90807112020-02-25 08:16:33 +01003642 if (!isalnum((unsigned char)*tmp) && *tmp != '_' && *tmp != '.') {
Thierry FOURNIER01a3f202018-05-10 16:41:26 +02003643 ha_alert("parsing [%s:%d]: '%s %s' only supports [a-zA-Z0-9_.] chars.\n",
Christopher Faulet767a84b2017-11-24 16:50:31 +01003644 file, linenum, args[0], args[1]);
Christopher Faulet985532d2016-11-16 15:36:19 +01003645 err_code |= ERR_ALERT | ERR_FATAL;
3646 goto out;
3647 }
3648 tmp++;
3649 }
3650 curagent->var_on_error = strdup(args[2]);
3651 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003652 else if (strcmp(args[1], "set-process-time") == 0) {
Christopher Faulet36bda1c2018-03-22 09:08:20 +01003653 char *tmp;
3654
3655 if (!*args[2]) {
3656 ha_alert("parsing [%s:%d]: '%s %s' expects a value.\n",
3657 file, linenum, args[0],
3658 args[1]);
3659 err_code |= ERR_ALERT | ERR_FATAL;
3660 goto out;
3661 }
3662 if (alertif_too_many_args(2, file, linenum, args, &err_code))
3663 goto out;
3664 tmp = args[2];
3665 while (*tmp) {
Willy Tarreau90807112020-02-25 08:16:33 +01003666 if (!isalnum((unsigned char)*tmp) && *tmp != '_' && *tmp != '.') {
Thierry FOURNIER01a3f202018-05-10 16:41:26 +02003667 ha_alert("parsing [%s:%d]: '%s %s' only supports [a-zA-Z0-9_.] chars.\n",
Christopher Faulet36bda1c2018-03-22 09:08:20 +01003668 file, linenum, args[0], args[1]);
3669 err_code |= ERR_ALERT | ERR_FATAL;
3670 goto out;
3671 }
3672 tmp++;
3673 }
3674 curagent->var_t_process = strdup(args[2]);
3675 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003676 else if (strcmp(args[1], "set-total-time") == 0) {
Christopher Faulet36bda1c2018-03-22 09:08:20 +01003677 char *tmp;
3678
3679 if (!*args[2]) {
3680 ha_alert("parsing [%s:%d]: '%s %s' expects a value.\n",
3681 file, linenum, args[0],
3682 args[1]);
3683 err_code |= ERR_ALERT | ERR_FATAL;
3684 goto out;
3685 }
3686 if (alertif_too_many_args(2, file, linenum, args, &err_code))
3687 goto out;
3688 tmp = args[2];
3689 while (*tmp) {
Willy Tarreau90807112020-02-25 08:16:33 +01003690 if (!isalnum((unsigned char)*tmp) && *tmp != '_' && *tmp != '.') {
Thierry FOURNIER01a3f202018-05-10 16:41:26 +02003691 ha_alert("parsing [%s:%d]: '%s %s' only supports [a-zA-Z0-9_.] chars.\n",
Christopher Faulet36bda1c2018-03-22 09:08:20 +01003692 file, linenum, args[0], args[1]);
3693 err_code |= ERR_ALERT | ERR_FATAL;
3694 goto out;
3695 }
3696 tmp++;
3697 }
3698 curagent->var_t_total = strdup(args[2]);
3699 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003700 else {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003701 ha_alert("parsing [%s:%d]: option '%s' is not supported.\n",
3702 file, linenum, args[1]);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003703 err_code |= ERR_ALERT | ERR_FATAL;
3704 goto out;
3705 }
Christopher Faulet48026722016-11-16 15:01:12 +01003706 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003707 else if (strcmp(args[0], "maxconnrate") == 0) {
Christopher Faulet48026722016-11-16 15:01:12 +01003708 if (!*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003709 ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n",
3710 file, linenum, args[0]);
Christopher Faulet48026722016-11-16 15:01:12 +01003711 err_code |= ERR_ALERT | ERR_FATAL;
3712 goto out;
3713 }
Christopher Fauletecc537a2017-02-23 22:52:39 +01003714 if (alertif_too_many_args(1, file, linenum, args, &err_code))
Christopher Faulet48026722016-11-16 15:01:12 +01003715 goto out;
Christopher Faulet48026722016-11-16 15:01:12 +01003716 curagent->cps_max = atol(args[1]);
3717 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003718 else if (strcmp(args[0], "maxerrrate") == 0) {
Christopher Faulet48026722016-11-16 15:01:12 +01003719 if (!*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003720 ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n",
3721 file, linenum, args[0]);
Christopher Faulet48026722016-11-16 15:01:12 +01003722 err_code |= ERR_ALERT | ERR_FATAL;
3723 goto out;
3724 }
Christopher Fauletecc537a2017-02-23 22:52:39 +01003725 if (alertif_too_many_args(1, file, linenum, args, &err_code))
Christopher Faulet48026722016-11-16 15:01:12 +01003726 goto out;
Christopher Faulet48026722016-11-16 15:01:12 +01003727 curagent->eps_max = atol(args[1]);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003728 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003729 else if (strcmp(args[0], "max-frame-size") == 0) {
Christopher Faulet2eca6b52017-02-27 09:40:34 +01003730 if (!*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003731 ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n",
3732 file, linenum, args[0]);
Christopher Faulet2eca6b52017-02-27 09:40:34 +01003733 err_code |= ERR_ALERT | ERR_FATAL;
3734 goto out;
3735 }
3736 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3737 goto out;
3738 curagent->max_frame_size = atol(args[1]);
3739 if (curagent->max_frame_size < MIN_FRAME_SIZE ||
3740 curagent->max_frame_size > MAX_FRAME_SIZE) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003741 ha_alert("parsing [%s:%d] : '%s' expects a positive integer argument in the range [%d, %d].\n",
3742 file, linenum, args[0], MIN_FRAME_SIZE, MAX_FRAME_SIZE);
Christopher Faulet2eca6b52017-02-27 09:40:34 +01003743 err_code |= ERR_ALERT | ERR_FATAL;
3744 goto out;
3745 }
3746 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003747 else if (strcmp(args[0], "max-waiting-frames") == 0) {
Christopher Faulete8ade382018-01-25 15:32:22 +01003748 if (!*args[1]) {
3749 ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n",
3750 file, linenum, args[0]);
3751 err_code |= ERR_ALERT | ERR_FATAL;
3752 goto out;
3753 }
3754 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3755 goto out;
3756 curagent->max_fpa = atol(args[1]);
3757 if (curagent->max_fpa < 1) {
3758 ha_alert("parsing [%s:%d] : '%s' expects a positive integer argument.\n",
3759 file, linenum, args[0]);
3760 err_code |= ERR_ALERT | ERR_FATAL;
3761 goto out;
3762 }
3763 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003764 else if (strcmp(args[0], "register-var-names") == 0) {
Christopher Faulet336d3ef2017-12-22 10:00:55 +01003765 int cur_arg;
3766
3767 if (!*args[1]) {
3768 ha_alert("parsing [%s:%d] : '%s' expects one or more variable names.\n",
3769 file, linenum, args[0]);
3770 err_code |= ERR_ALERT | ERR_FATAL;
3771 goto out;
3772 }
3773 cur_arg = 1;
3774 while (*args[cur_arg]) {
3775 struct spoe_var_placeholder *vph;
3776
3777 if ((vph = calloc(1, sizeof(*vph))) == NULL) {
3778 ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum);
3779 err_code |= ERR_ALERT | ERR_ABORT;
3780 goto out;
3781 }
3782 if ((vph->name = strdup(args[cur_arg])) == NULL) {
Tim Duesterhusb2986132019-06-23 22:10:13 +02003783 free(vph);
Christopher Faulet336d3ef2017-12-22 10:00:55 +01003784 ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum);
3785 err_code |= ERR_ALERT | ERR_ABORT;
3786 goto out;
3787 }
Willy Tarreau2b718102021-04-21 07:32:39 +02003788 LIST_APPEND(&curvars, &vph->list);
Christopher Faulet336d3ef2017-12-22 10:00:55 +01003789 cur_arg++;
3790 }
3791 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003792 else if (strcmp(args[0], "log") == 0) {
Christopher Faulet7250b8f2018-03-26 17:19:01 +02003793 char *errmsg = NULL;
3794
Emeric Brun9533a702021-04-02 10:13:43 +02003795 if (!parse_logsrv(args, &curlogsrvs, (kwm == 1), file, linenum, &errmsg)) {
Christopher Faulet7250b8f2018-03-26 17:19:01 +02003796 ha_alert("parsing [%s:%d] : %s : %s\n", file, linenum, args[0], errmsg);
3797 err_code |= ERR_ALERT | ERR_FATAL;
3798 goto out;
3799 }
3800 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003801 else if (*args[0]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003802 ha_alert("parsing [%s:%d] : unknown keyword '%s' in spoe-agent section.\n",
3803 file, linenum, args[0]);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003804 err_code |= ERR_ALERT | ERR_FATAL;
3805 goto out;
3806 }
3807 out:
3808 return err_code;
3809}
Christopher Faulet11610f32017-09-21 10:23:10 +02003810static int
3811cfg_parse_spoe_group(const char *file, int linenum, char **args, int kwm)
3812{
3813 struct spoe_group *grp;
3814 const char *err;
3815 int err_code = 0;
3816
3817 if ((cfg_scope == NULL && curengine != NULL) ||
3818 (cfg_scope != NULL && curengine == NULL) ||
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003819 (curengine != NULL && cfg_scope != NULL && strcmp(curengine, cfg_scope) != 0))
Christopher Faulet11610f32017-09-21 10:23:10 +02003820 goto out;
3821
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003822 if (strcmp(args[0], "spoe-group") == 0) { /* new spoe-group section */
Christopher Faulet11610f32017-09-21 10:23:10 +02003823 if (!*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003824 ha_alert("parsing [%s:%d] : missing name for spoe-group section.\n",
3825 file, linenum);
Christopher Faulet11610f32017-09-21 10:23:10 +02003826 err_code |= ERR_ALERT | ERR_ABORT;
3827 goto out;
3828 }
3829 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
3830 err_code |= ERR_ABORT;
3831 goto out;
3832 }
3833
3834 err = invalid_char(args[1]);
3835 if (err) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003836 ha_alert("parsing [%s:%d] : character '%c' is not permitted in '%s' name '%s'.\n",
3837 file, linenum, *err, args[0], args[1]);
Christopher Faulet11610f32017-09-21 10:23:10 +02003838 err_code |= ERR_ALERT | ERR_ABORT;
3839 goto out;
3840 }
3841
3842 list_for_each_entry(grp, &curgrps, list) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003843 if (strcmp(grp->id, args[1]) == 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003844 ha_alert("parsing [%s:%d]: spoe-group section '%s' has the same"
3845 " name as another one declared at %s:%d.\n",
3846 file, linenum, args[1], grp->conf.file, grp->conf.line);
Christopher Faulet11610f32017-09-21 10:23:10 +02003847 err_code |= ERR_ALERT | ERR_FATAL;
3848 goto out;
3849 }
3850 }
3851
3852 if ((curgrp = calloc(1, sizeof(*curgrp))) == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003853 ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum);
Christopher Faulet11610f32017-09-21 10:23:10 +02003854 err_code |= ERR_ALERT | ERR_ABORT;
3855 goto out;
3856 }
3857
3858 curgrp->id = strdup(args[1]);
3859 curgrp->conf.file = strdup(file);
3860 curgrp->conf.line = linenum;
3861 LIST_INIT(&curgrp->phs);
3862 LIST_INIT(&curgrp->messages);
Willy Tarreau2b718102021-04-21 07:32:39 +02003863 LIST_APPEND(&curgrps, &curgrp->list);
Christopher Faulet11610f32017-09-21 10:23:10 +02003864 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003865 else if (strcmp(args[0], "messages") == 0) {
Christopher Faulet11610f32017-09-21 10:23:10 +02003866 int cur_arg = 1;
3867 while (*args[cur_arg]) {
3868 struct spoe_placeholder *ph = NULL;
3869
3870 list_for_each_entry(ph, &curgrp->phs, list) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003871 if (strcmp(ph->id, args[cur_arg]) == 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003872 ha_alert("parsing [%s:%d]: spoe-message '%s' already used.\n",
3873 file, linenum, args[cur_arg]);
Christopher Faulet11610f32017-09-21 10:23:10 +02003874 err_code |= ERR_ALERT | ERR_FATAL;
3875 goto out;
3876 }
3877 }
3878
3879 if ((ph = calloc(1, sizeof(*ph))) == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003880 ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum);
Christopher Faulet11610f32017-09-21 10:23:10 +02003881 err_code |= ERR_ALERT | ERR_ABORT;
3882 goto out;
3883 }
3884 ph->id = strdup(args[cur_arg]);
Willy Tarreau2b718102021-04-21 07:32:39 +02003885 LIST_APPEND(&curgrp->phs, &ph->list);
Christopher Faulet11610f32017-09-21 10:23:10 +02003886 cur_arg++;
3887 }
3888 }
3889 else if (*args[0]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003890 ha_alert("parsing [%s:%d] : unknown keyword '%s' in spoe-group section.\n",
3891 file, linenum, args[0]);
Christopher Faulet11610f32017-09-21 10:23:10 +02003892 err_code |= ERR_ALERT | ERR_FATAL;
3893 goto out;
3894 }
3895 out:
3896 return err_code;
3897}
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003898
3899static int
3900cfg_parse_spoe_message(const char *file, int linenum, char **args, int kwm)
3901{
3902 struct spoe_message *msg;
3903 struct spoe_arg *arg;
3904 const char *err;
3905 char *errmsg = NULL;
3906 int err_code = 0;
3907
3908 if ((cfg_scope == NULL && curengine != NULL) ||
3909 (cfg_scope != NULL && curengine == NULL) ||
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003910 (curengine != NULL && cfg_scope != NULL && strcmp(curengine, cfg_scope) != 0))
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003911 goto out;
3912
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003913 if (strcmp(args[0], "spoe-message") == 0) { /* new spoe-message section */
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003914 if (!*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003915 ha_alert("parsing [%s:%d] : missing name for spoe-message section.\n",
3916 file, linenum);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003917 err_code |= ERR_ALERT | ERR_ABORT;
3918 goto out;
3919 }
Christopher Fauletecc537a2017-02-23 22:52:39 +01003920 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
3921 err_code |= ERR_ABORT;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003922 goto out;
3923 }
3924
3925 err = invalid_char(args[1]);
3926 if (err) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003927 ha_alert("parsing [%s:%d] : character '%c' is not permitted in '%s' name '%s'.\n",
3928 file, linenum, *err, args[0], args[1]);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003929 err_code |= ERR_ALERT | ERR_ABORT;
3930 goto out;
3931 }
3932
3933 list_for_each_entry(msg, &curmsgs, list) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003934 if (strcmp(msg->id, args[1]) == 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003935 ha_alert("parsing [%s:%d]: spoe-message section '%s' has the same"
3936 " name as another one declared at %s:%d.\n",
3937 file, linenum, args[1], msg->conf.file, msg->conf.line);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003938 err_code |= ERR_ALERT | ERR_FATAL;
3939 goto out;
3940 }
3941 }
3942
3943 if ((curmsg = calloc(1, sizeof(*curmsg))) == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003944 ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003945 err_code |= ERR_ALERT | ERR_ABORT;
3946 goto out;
3947 }
3948
3949 curmsg->id = strdup(args[1]);
3950 curmsg->id_len = strlen(curmsg->id);
3951 curmsg->event = SPOE_EV_NONE;
3952 curmsg->conf.file = strdup(file);
3953 curmsg->conf.line = linenum;
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01003954 curmsg->nargs = 0;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003955 LIST_INIT(&curmsg->args);
Christopher Faulet57583e42017-09-04 15:41:09 +02003956 LIST_INIT(&curmsg->acls);
Christopher Faulet11610f32017-09-21 10:23:10 +02003957 LIST_INIT(&curmsg->by_evt);
3958 LIST_INIT(&curmsg->by_grp);
Willy Tarreau2b718102021-04-21 07:32:39 +02003959 LIST_APPEND(&curmsgs, &curmsg->list);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003960 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003961 else if (strcmp(args[0], "args") == 0) {
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003962 int cur_arg = 1;
3963
3964 curproxy->conf.args.ctx = ARGC_SPOE;
3965 curproxy->conf.args.file = file;
3966 curproxy->conf.args.line = linenum;
3967 while (*args[cur_arg]) {
3968 char *delim = strchr(args[cur_arg], '=');
3969 int idx = 0;
3970
3971 if ((arg = calloc(1, sizeof(*arg))) == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003972 ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003973 err_code |= ERR_ALERT | ERR_ABORT;
3974 goto out;
3975 }
3976
3977 if (!delim) {
3978 arg->name = NULL;
3979 arg->name_len = 0;
3980 delim = args[cur_arg];
3981 }
3982 else {
3983 arg->name = my_strndup(args[cur_arg], delim - args[cur_arg]);
3984 arg->name_len = delim - args[cur_arg];
3985 delim++;
3986 }
Christopher Fauletb0b42382017-02-23 22:41:09 +01003987 arg->expr = sample_parse_expr((char*[]){delim, NULL},
3988 &idx, file, linenum, &errmsg,
Willy Tarreaue3b57bf2020-02-14 16:50:14 +01003989 &curproxy->conf.args, NULL);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003990 if (arg->expr == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01003991 ha_alert("parsing [%s:%d] : '%s': %s.\n", file, linenum, args[0], errmsg);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003992 err_code |= ERR_ALERT | ERR_FATAL;
3993 free(arg->name);
3994 free(arg);
3995 goto out;
3996 }
Christopher Fauletf51f5fa2017-01-19 10:01:12 +01003997 curmsg->nargs++;
Willy Tarreau2b718102021-04-21 07:32:39 +02003998 LIST_APPEND(&curmsg->args, &arg->list);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02003999 cur_arg++;
4000 }
4001 curproxy->conf.args.file = NULL;
4002 curproxy->conf.args.line = 0;
4003 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004004 else if (strcmp(args[0], "acl") == 0) {
Christopher Faulet57583e42017-09-04 15:41:09 +02004005 err = invalid_char(args[1]);
4006 if (err) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01004007 ha_alert("parsing [%s:%d] : character '%c' is not permitted in acl name '%s'.\n",
4008 file, linenum, *err, args[1]);
Christopher Faulet57583e42017-09-04 15:41:09 +02004009 err_code |= ERR_ALERT | ERR_FATAL;
4010 goto out;
4011 }
Tim Duesterhus0cf811a2020-02-05 21:00:50 +01004012 if (strcasecmp(args[1], "or") == 0) {
Tim Duesterhusf1bc24c2020-02-06 22:04:03 +01004013 ha_alert("parsing [%s:%d] : acl name '%s' will never match. 'or' is used to express a "
Tim Duesterhus0cf811a2020-02-05 21:00:50 +01004014 "logical disjunction within a condition.\n",
4015 file, linenum, args[1]);
4016 err_code |= ERR_ALERT | ERR_FATAL;
4017 goto out;
4018 }
Christopher Faulet57583e42017-09-04 15:41:09 +02004019 if (parse_acl((const char **)args + 1, &curmsg->acls, &errmsg, &curproxy->conf.args, file, linenum) == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01004020 ha_alert("parsing [%s:%d] : error detected while parsing ACL '%s' : %s.\n",
4021 file, linenum, args[1], errmsg);
Christopher Faulet57583e42017-09-04 15:41:09 +02004022 err_code |= ERR_ALERT | ERR_FATAL;
4023 goto out;
4024 }
4025 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004026 else if (strcmp(args[0], "event") == 0) {
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004027 if (!*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01004028 ha_alert("parsing [%s:%d] : missing event name.\n", file, linenum);
Christopher Fauletecc537a2017-02-23 22:52:39 +01004029 err_code |= ERR_ALERT | ERR_FATAL;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004030 goto out;
4031 }
Christopher Faulet57583e42017-09-04 15:41:09 +02004032 /* if (alertif_too_many_args(1, file, linenum, args, &err_code)) */
4033 /* goto out; */
Christopher Fauletecc537a2017-02-23 22:52:39 +01004034
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004035 if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_CLIENT_SESS]) == 0)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004036 curmsg->event = SPOE_EV_ON_CLIENT_SESS;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004037 else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_SERVER_SESS]) == 0)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004038 curmsg->event = SPOE_EV_ON_SERVER_SESS;
4039
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004040 else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_TCP_REQ_FE]) == 0)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004041 curmsg->event = SPOE_EV_ON_TCP_REQ_FE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004042 else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_TCP_REQ_BE]) == 0)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004043 curmsg->event = SPOE_EV_ON_TCP_REQ_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004044 else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_TCP_RSP]) == 0)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004045 curmsg->event = SPOE_EV_ON_TCP_RSP;
4046
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004047 else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_HTTP_REQ_FE]) == 0)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004048 curmsg->event = SPOE_EV_ON_HTTP_REQ_FE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004049 else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_HTTP_REQ_BE]) == 0)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004050 curmsg->event = SPOE_EV_ON_HTTP_REQ_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004051 else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_HTTP_RSP]) == 0)
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004052 curmsg->event = SPOE_EV_ON_HTTP_RSP;
4053 else {
Joseph Herlantf1da69d2018-11-15 13:49:02 -08004054 ha_alert("parsing [%s:%d] : unknown event '%s'.\n",
Christopher Faulet767a84b2017-11-24 16:50:31 +01004055 file, linenum, args[1]);
Christopher Fauletecc537a2017-02-23 22:52:39 +01004056 err_code |= ERR_ALERT | ERR_FATAL;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004057 goto out;
4058 }
Christopher Faulet57583e42017-09-04 15:41:09 +02004059
4060 if (strcmp(args[2], "if") == 0 || strcmp(args[2], "unless") == 0) {
4061 struct acl_cond *cond;
4062
4063 cond = build_acl_cond(file, linenum, &curmsg->acls,
4064 curproxy, (const char **)args+2,
4065 &errmsg);
4066 if (cond == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01004067 ha_alert("parsing [%s:%d] : error detected while "
4068 "parsing an 'event %s' condition : %s.\n",
4069 file, linenum, args[1], errmsg);
Christopher Faulet57583e42017-09-04 15:41:09 +02004070 err_code |= ERR_ALERT | ERR_FATAL;
4071 goto out;
4072 }
4073 curmsg->cond = cond;
4074 }
4075 else if (*args[2]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01004076 ha_alert("parsing [%s:%d]: 'event %s' expects either 'if' "
4077 "or 'unless' followed by a condition but found '%s'.\n",
4078 file, linenum, args[1], args[2]);
Christopher Faulet57583e42017-09-04 15:41:09 +02004079 err_code |= ERR_ALERT | ERR_FATAL;
4080 goto out;
4081 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004082 }
4083 else if (!*args[0]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01004084 ha_alert("parsing [%s:%d] : unknown keyword '%s' in spoe-message section.\n",
4085 file, linenum, args[0]);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004086 err_code |= ERR_ALERT | ERR_FATAL;
4087 goto out;
4088 }
4089 out:
4090 free(errmsg);
4091 return err_code;
4092}
4093
4094/* Return -1 on error, else 0 */
4095static int
4096parse_spoe_flt(char **args, int *cur_arg, struct proxy *px,
4097 struct flt_conf *fconf, char **err, void *private)
4098{
4099 struct list backup_sections;
4100 struct spoe_config *conf;
4101 struct spoe_message *msg, *msgback;
Christopher Faulet11610f32017-09-21 10:23:10 +02004102 struct spoe_group *grp, *grpback;
4103 struct spoe_placeholder *ph, *phback;
Christopher Faulet336d3ef2017-12-22 10:00:55 +01004104 struct spoe_var_placeholder *vph, *vphback;
Christopher Faulet7250b8f2018-03-26 17:19:01 +02004105 struct logsrv *logsrv, *logsrvback;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004106 char *file = NULL, *engine = NULL;
4107 int ret, pos = *cur_arg + 1;
4108
Christopher Faulet84c844e2018-03-23 14:37:14 +01004109 LIST_INIT(&curmsgs);
4110 LIST_INIT(&curgrps);
4111 LIST_INIT(&curmphs);
4112 LIST_INIT(&curgphs);
4113 LIST_INIT(&curvars);
Christopher Faulet7250b8f2018-03-26 17:19:01 +02004114 LIST_INIT(&curlogsrvs);
Christopher Faulet0e0f0852018-03-26 17:20:36 +02004115 curpxopts = 0;
4116 curpxopts2 = 0;
Christopher Faulet84c844e2018-03-23 14:37:14 +01004117
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004118 conf = calloc(1, sizeof(*conf));
4119 if (conf == NULL) {
4120 memprintf(err, "%s: out of memory", args[*cur_arg]);
4121 goto error;
4122 }
4123 conf->proxy = px;
4124
4125 while (*args[pos]) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004126 if (strcmp(args[pos], "config") == 0) {
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004127 if (!*args[pos+1]) {
4128 memprintf(err, "'%s' : '%s' option without value",
4129 args[*cur_arg], args[pos]);
4130 goto error;
4131 }
4132 file = args[pos+1];
4133 pos += 2;
4134 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004135 else if (strcmp(args[pos], "engine") == 0) {
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004136 if (!*args[pos+1]) {
4137 memprintf(err, "'%s' : '%s' option without value",
4138 args[*cur_arg], args[pos]);
4139 goto error;
4140 }
4141 engine = args[pos+1];
4142 pos += 2;
4143 }
4144 else {
4145 memprintf(err, "unknown keyword '%s'", args[pos]);
4146 goto error;
4147 }
4148 }
4149 if (file == NULL) {
4150 memprintf(err, "'%s' : missing config file", args[*cur_arg]);
4151 goto error;
4152 }
4153
4154 /* backup sections and register SPOE sections */
4155 LIST_INIT(&backup_sections);
4156 cfg_backup_sections(&backup_sections);
Christopher Faulet11610f32017-09-21 10:23:10 +02004157 cfg_register_section("spoe-agent", cfg_parse_spoe_agent, NULL);
4158 cfg_register_section("spoe-group", cfg_parse_spoe_group, NULL);
William Lallemandd2ff56d2017-10-16 11:06:50 +02004159 cfg_register_section("spoe-message", cfg_parse_spoe_message, NULL);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004160
4161 /* Parse SPOE filter configuration file */
4162 curengine = engine;
4163 curproxy = px;
4164 curagent = NULL;
4165 curmsg = NULL;
4166 ret = readcfgfile(file);
4167 curproxy = NULL;
4168
4169 /* unregister SPOE sections and restore previous sections */
4170 cfg_unregister_sections();
4171 cfg_restore_sections(&backup_sections);
4172
4173 if (ret == -1) {
4174 memprintf(err, "Could not open configuration file %s : %s",
4175 file, strerror(errno));
4176 goto error;
4177 }
4178 if (ret & (ERR_ABORT|ERR_FATAL)) {
4179 memprintf(err, "Error(s) found in configuration file %s", file);
4180 goto error;
4181 }
4182
4183 /* Check SPOE agent */
4184 if (curagent == NULL) {
4185 memprintf(err, "No SPOE agent found in file %s", file);
4186 goto error;
4187 }
4188 if (curagent->b.name == NULL) {
4189 memprintf(err, "No backend declared for SPOE agent '%s' declared at %s:%d",
4190 curagent->id, curagent->conf.file, curagent->conf.line);
4191 goto error;
4192 }
Christopher Fauletf7a30922016-11-10 15:04:51 +01004193 if (curagent->timeout.hello == TICK_ETERNITY ||
4194 curagent->timeout.idle == TICK_ETERNITY ||
Christopher Fauletf7a30922016-11-10 15:04:51 +01004195 curagent->timeout.processing == TICK_ETERNITY) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01004196 ha_warning("Proxy '%s': missing timeouts for SPOE agent '%s' declare at %s:%d.\n"
4197 " | While not properly invalid, you will certainly encounter various problems\n"
4198 " | with such a configuration. To fix this, please ensure that all following\n"
4199 " | timeouts are set to a non-zero value: 'hello', 'idle', 'processing'.\n",
4200 px->id, curagent->id, curagent->conf.file, curagent->conf.line);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004201 }
4202 if (curagent->var_pfx == NULL) {
4203 char *tmp = curagent->id;
4204
4205 while (*tmp) {
Willy Tarreau90807112020-02-25 08:16:33 +01004206 if (!isalnum((unsigned char)*tmp) && *tmp != '_' && *tmp != '.') {
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004207 memprintf(err, "Invalid variable prefix '%s' for SPOE agent '%s' declared at %s:%d. "
4208 "Use 'option var-prefix' to set it. Only [a-zA-Z0-9_.] chars are supported.\n",
4209 curagent->id, curagent->id, curagent->conf.file, curagent->conf.line);
4210 goto error;
4211 }
4212 tmp++;
4213 }
4214 curagent->var_pfx = strdup(curagent->id);
4215 }
4216
Christopher Fauletb7426d12018-03-21 14:12:17 +01004217 if (curagent->var_on_error) {
4218 struct arg arg;
4219
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004220 trash.data = snprintf(trash.area, trash.size, "txn.%s.%s",
Christopher Fauletb7426d12018-03-21 14:12:17 +01004221 curagent->var_pfx, curagent->var_on_error);
4222
4223 arg.type = ARGT_STR;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004224 arg.data.str.area = trash.area;
4225 arg.data.str.data = trash.data;
William Dauchyafb93682021-01-05 11:14:58 +01004226 arg.data.str.size = 0; /* Set it to 0 to not release it in vars_check_arg() */
Christopher Fauletb7426d12018-03-21 14:12:17 +01004227 if (!vars_check_arg(&arg, err)) {
4228 memprintf(err, "SPOE agent '%s': failed to register variable %s.%s (%s)",
4229 curagent->id, curagent->var_pfx, curagent->var_on_error, *err);
4230 goto error;
4231 }
4232 }
4233
Christopher Faulet36bda1c2018-03-22 09:08:20 +01004234 if (curagent->var_t_process) {
4235 struct arg arg;
4236
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004237 trash.data = snprintf(trash.area, trash.size, "txn.%s.%s",
Christopher Faulet36bda1c2018-03-22 09:08:20 +01004238 curagent->var_pfx, curagent->var_t_process);
4239
4240 arg.type = ARGT_STR;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004241 arg.data.str.area = trash.area;
4242 arg.data.str.data = trash.data;
William Dauchyafb93682021-01-05 11:14:58 +01004243 arg.data.str.size = 0; /* Set it to 0 to not release it in vars_check_arg() */
Christopher Faulet36bda1c2018-03-22 09:08:20 +01004244 if (!vars_check_arg(&arg, err)) {
4245 memprintf(err, "SPOE agent '%s': failed to register variable %s.%s (%s)",
4246 curagent->id, curagent->var_pfx, curagent->var_t_process, *err);
4247 goto error;
4248 }
4249 }
4250
4251 if (curagent->var_t_total) {
4252 struct arg arg;
4253
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004254 trash.data = snprintf(trash.area, trash.size, "txn.%s.%s",
Christopher Faulet36bda1c2018-03-22 09:08:20 +01004255 curagent->var_pfx, curagent->var_t_total);
4256
4257 arg.type = ARGT_STR;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004258 arg.data.str.area = trash.area;
4259 arg.data.str.data = trash.data;
William Dauchyafb93682021-01-05 11:14:58 +01004260 arg.data.str.size = 0; /* Set it to 0 to not release it in vars_check_arg() */
Christopher Faulet36bda1c2018-03-22 09:08:20 +01004261 if (!vars_check_arg(&arg, err)) {
4262 memprintf(err, "SPOE agent '%s': failed to register variable %s.%s (%s)",
4263 curagent->id, curagent->var_pfx, curagent->var_t_process, *err);
4264 goto error;
4265 }
4266 }
4267
Christopher Faulet11610f32017-09-21 10:23:10 +02004268 if (LIST_ISEMPTY(&curmphs) && LIST_ISEMPTY(&curgphs)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01004269 ha_warning("Proxy '%s': No message/group used by SPOE agent '%s' declared at %s:%d.\n",
4270 px->id, curagent->id, curagent->conf.file, curagent->conf.line);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004271 goto finish;
4272 }
4273
Christopher Faulet11610f32017-09-21 10:23:10 +02004274 /* Replace placeholders by the corresponding messages for the SPOE
4275 * agent */
4276 list_for_each_entry(ph, &curmphs, list) {
4277 list_for_each_entry(msg, &curmsgs, list) {
Christopher Fauleta21b0642017-01-09 16:56:23 +01004278 struct spoe_arg *arg;
4279 unsigned int where;
4280
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004281 if (strcmp(msg->id, ph->id) == 0) {
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004282 if ((px->cap & (PR_CAP_FE|PR_CAP_BE)) == (PR_CAP_FE|PR_CAP_BE)) {
4283 if (msg->event == SPOE_EV_ON_TCP_REQ_BE)
4284 msg->event = SPOE_EV_ON_TCP_REQ_FE;
4285 if (msg->event == SPOE_EV_ON_HTTP_REQ_BE)
4286 msg->event = SPOE_EV_ON_HTTP_REQ_FE;
4287 }
4288 if (!(px->cap & PR_CAP_FE) && (msg->event == SPOE_EV_ON_CLIENT_SESS ||
4289 msg->event == SPOE_EV_ON_TCP_REQ_FE ||
4290 msg->event == SPOE_EV_ON_HTTP_REQ_FE)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01004291 ha_warning("Proxy '%s': frontend event used on a backend proxy at %s:%d.\n",
4292 px->id, msg->conf.file, msg->conf.line);
Christopher Faulet11610f32017-09-21 10:23:10 +02004293 goto next_mph;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004294 }
4295 if (msg->event == SPOE_EV_NONE) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01004296 ha_warning("Proxy '%s': Ignore SPOE message '%s' without event at %s:%d.\n",
4297 px->id, msg->id, msg->conf.file, msg->conf.line);
Christopher Faulet11610f32017-09-21 10:23:10 +02004298 goto next_mph;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004299 }
Christopher Fauleta21b0642017-01-09 16:56:23 +01004300
4301 where = 0;
4302 switch (msg->event) {
4303 case SPOE_EV_ON_CLIENT_SESS:
4304 where |= SMP_VAL_FE_CON_ACC;
4305 break;
4306
4307 case SPOE_EV_ON_TCP_REQ_FE:
4308 where |= SMP_VAL_FE_REQ_CNT;
4309 break;
4310
4311 case SPOE_EV_ON_HTTP_REQ_FE:
4312 where |= SMP_VAL_FE_HRQ_HDR;
4313 break;
4314
4315 case SPOE_EV_ON_TCP_REQ_BE:
4316 if (px->cap & PR_CAP_FE)
4317 where |= SMP_VAL_FE_REQ_CNT;
4318 if (px->cap & PR_CAP_BE)
4319 where |= SMP_VAL_BE_REQ_CNT;
4320 break;
4321
4322 case SPOE_EV_ON_HTTP_REQ_BE:
4323 if (px->cap & PR_CAP_FE)
4324 where |= SMP_VAL_FE_HRQ_HDR;
4325 if (px->cap & PR_CAP_BE)
4326 where |= SMP_VAL_BE_HRQ_HDR;
4327 break;
4328
4329 case SPOE_EV_ON_SERVER_SESS:
4330 where |= SMP_VAL_BE_SRV_CON;
4331 break;
4332
4333 case SPOE_EV_ON_TCP_RSP:
4334 if (px->cap & PR_CAP_FE)
4335 where |= SMP_VAL_FE_RES_CNT;
4336 if (px->cap & PR_CAP_BE)
4337 where |= SMP_VAL_BE_RES_CNT;
4338 break;
4339
4340 case SPOE_EV_ON_HTTP_RSP:
4341 if (px->cap & PR_CAP_FE)
4342 where |= SMP_VAL_FE_HRS_HDR;
4343 if (px->cap & PR_CAP_BE)
4344 where |= SMP_VAL_BE_HRS_HDR;
4345 break;
4346
4347 default:
4348 break;
4349 }
4350
4351 list_for_each_entry(arg, &msg->args, list) {
4352 if (!(arg->expr->fetch->val & where)) {
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004353 memprintf(err, "Ignore SPOE message '%s' at %s:%d: "
Christopher Fauleta21b0642017-01-09 16:56:23 +01004354 "some args extract information from '%s', "
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004355 "none of which is available here ('%s')",
4356 msg->id, msg->conf.file, msg->conf.line,
Christopher Fauleta21b0642017-01-09 16:56:23 +01004357 sample_ckp_names(arg->expr->fetch->use),
4358 sample_ckp_names(where));
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004359 goto error;
Christopher Fauleta21b0642017-01-09 16:56:23 +01004360 }
4361 }
4362
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004363 msg->agent = curagent;
Willy Tarreau2b718102021-04-21 07:32:39 +02004364 LIST_APPEND(&curagent->events[msg->event], &msg->by_evt);
Christopher Faulet11610f32017-09-21 10:23:10 +02004365 goto next_mph;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004366 }
4367 }
4368 memprintf(err, "SPOE agent '%s' try to use undefined SPOE message '%s' at %s:%d",
Christopher Faulet11610f32017-09-21 10:23:10 +02004369 curagent->id, ph->id, curagent->conf.file, curagent->conf.line);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004370 goto error;
Christopher Faulet11610f32017-09-21 10:23:10 +02004371 next_mph:
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004372 continue;
4373 }
4374
Christopher Faulet11610f32017-09-21 10:23:10 +02004375 /* Replace placeholders by the corresponding groups for the SPOE
4376 * agent */
4377 list_for_each_entry(ph, &curgphs, list) {
4378 list_for_each_entry_safe(grp, grpback, &curgrps, list) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004379 if (strcmp(grp->id, ph->id) == 0) {
Christopher Faulet11610f32017-09-21 10:23:10 +02004380 grp->agent = curagent;
Willy Tarreau2b718102021-04-21 07:32:39 +02004381 LIST_DELETE(&grp->list);
4382 LIST_APPEND(&curagent->groups, &grp->list);
Christopher Faulet11610f32017-09-21 10:23:10 +02004383 goto next_aph;
4384 }
4385 }
4386 memprintf(err, "SPOE agent '%s' try to use undefined SPOE group '%s' at %s:%d",
4387 curagent->id, ph->id, curagent->conf.file, curagent->conf.line);
4388 goto error;
4389 next_aph:
4390 continue;
4391 }
4392
4393 /* Replace placeholders by the corresponding message for each SPOE
4394 * group of the SPOE agent */
4395 list_for_each_entry(grp, &curagent->groups, list) {
4396 list_for_each_entry_safe(ph, phback, &grp->phs, list) {
4397 list_for_each_entry(msg, &curmsgs, list) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004398 if (strcmp(msg->id, ph->id) == 0) {
Christopher Faulet11610f32017-09-21 10:23:10 +02004399 if (msg->group != NULL) {
4400 memprintf(err, "SPOE message '%s' already belongs to "
4401 "the SPOE group '%s' declare at %s:%d",
4402 msg->id, msg->group->id,
4403 msg->group->conf.file,
4404 msg->group->conf.line);
4405 goto error;
4406 }
4407
4408 /* Scope for arguments are not checked for now. We will check
4409 * them only if a rule use the corresponding SPOE group. */
4410 msg->agent = curagent;
4411 msg->group = grp;
Willy Tarreau2b718102021-04-21 07:32:39 +02004412 LIST_DELETE(&ph->list);
4413 LIST_APPEND(&grp->messages, &msg->by_grp);
Christopher Faulet11610f32017-09-21 10:23:10 +02004414 goto next_mph_grp;
4415 }
4416 }
4417 memprintf(err, "SPOE group '%s' try to use undefined SPOE message '%s' at %s:%d",
4418 grp->id, ph->id, curagent->conf.file, curagent->conf.line);
4419 goto error;
4420 next_mph_grp:
4421 continue;
4422 }
4423 }
4424
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004425 finish:
Christopher Faulet11610f32017-09-21 10:23:10 +02004426 /* move curmsgs to the agent message list */
4427 curmsgs.n->p = &curagent->messages;
4428 curmsgs.p->n = &curagent->messages;
4429 curagent->messages = curmsgs;
4430 LIST_INIT(&curmsgs);
4431
Christopher Faulet7ee86672017-09-19 11:08:28 +02004432 conf->id = strdup(engine ? engine : curagent->id);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004433 conf->agent = curagent;
Christopher Faulet434b8522021-08-02 17:51:01 +02004434 curagent->spoe_conf = conf;
Christopher Faulet7250b8f2018-03-26 17:19:01 +02004435
4436 /* Start agent's proxy initialization here. It will be finished during
4437 * the filter init. */
4438 memset(&conf->agent_fe, 0, sizeof(conf->agent_fe));
4439 init_new_proxy(&conf->agent_fe);
4440 conf->agent_fe.id = conf->agent->id;
4441 conf->agent_fe.parent = conf->agent;
Christopher Faulet0e0f0852018-03-26 17:20:36 +02004442 conf->agent_fe.options |= curpxopts;
4443 conf->agent_fe.options2 |= curpxopts2;
Christopher Faulet7250b8f2018-03-26 17:19:01 +02004444
4445 list_for_each_entry_safe(logsrv, logsrvback, &curlogsrvs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02004446 LIST_DELETE(&logsrv->list);
4447 LIST_APPEND(&conf->agent_fe.logsrvs, &logsrv->list);
Christopher Faulet7250b8f2018-03-26 17:19:01 +02004448 }
4449
Christopher Faulet11610f32017-09-21 10:23:10 +02004450 list_for_each_entry_safe(ph, phback, &curmphs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02004451 LIST_DELETE(&ph->list);
Christopher Faulet11610f32017-09-21 10:23:10 +02004452 spoe_release_placeholder(ph);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004453 }
Christopher Faulet11610f32017-09-21 10:23:10 +02004454 list_for_each_entry_safe(ph, phback, &curgphs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02004455 LIST_DELETE(&ph->list);
Christopher Faulet11610f32017-09-21 10:23:10 +02004456 spoe_release_placeholder(ph);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004457 }
Christopher Faulet336d3ef2017-12-22 10:00:55 +01004458 list_for_each_entry_safe(vph, vphback, &curvars, list) {
4459 struct arg arg;
4460
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004461 trash.data = snprintf(trash.area, trash.size, "proc.%s.%s",
Christopher Faulet336d3ef2017-12-22 10:00:55 +01004462 curagent->var_pfx, vph->name);
4463
4464 arg.type = ARGT_STR;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004465 arg.data.str.area = trash.area;
4466 arg.data.str.data = trash.data;
William Dauchyafb93682021-01-05 11:14:58 +01004467 arg.data.str.size = 0; /* Set it to 0 to not release it in vars_check_arg() */
Christopher Faulet336d3ef2017-12-22 10:00:55 +01004468 if (!vars_check_arg(&arg, err)) {
4469 memprintf(err, "SPOE agent '%s': failed to register variable %s.%s (%s)",
4470 curagent->id, curagent->var_pfx, vph->name, *err);
4471 goto error;
4472 }
4473
Willy Tarreau2b718102021-04-21 07:32:39 +02004474 LIST_DELETE(&vph->list);
Christopher Faulet336d3ef2017-12-22 10:00:55 +01004475 free(vph->name);
4476 free(vph);
4477 }
Christopher Faulet11610f32017-09-21 10:23:10 +02004478 list_for_each_entry_safe(grp, grpback, &curgrps, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02004479 LIST_DELETE(&grp->list);
Christopher Faulet11610f32017-09-21 10:23:10 +02004480 spoe_release_group(grp);
4481 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004482 *cur_arg = pos;
Christopher Faulet3b386a32017-02-23 10:17:15 +01004483 fconf->id = spoe_filter_id;
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004484 fconf->ops = &spoe_ops;
4485 fconf->conf = conf;
4486 return 0;
4487
4488 error:
Christopher Faulet8ef75252017-02-20 22:56:03 +01004489 spoe_release_agent(curagent);
Christopher Faulet11610f32017-09-21 10:23:10 +02004490 list_for_each_entry_safe(ph, phback, &curmphs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02004491 LIST_DELETE(&ph->list);
Christopher Faulet11610f32017-09-21 10:23:10 +02004492 spoe_release_placeholder(ph);
4493 }
4494 list_for_each_entry_safe(ph, phback, &curgphs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02004495 LIST_DELETE(&ph->list);
Christopher Faulet11610f32017-09-21 10:23:10 +02004496 spoe_release_placeholder(ph);
4497 }
Christopher Faulet336d3ef2017-12-22 10:00:55 +01004498 list_for_each_entry_safe(vph, vphback, &curvars, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02004499 LIST_DELETE(&vph->list);
Christopher Faulet336d3ef2017-12-22 10:00:55 +01004500 free(vph->name);
4501 free(vph);
4502 }
Christopher Faulet11610f32017-09-21 10:23:10 +02004503 list_for_each_entry_safe(grp, grpback, &curgrps, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02004504 LIST_DELETE(&grp->list);
Christopher Faulet11610f32017-09-21 10:23:10 +02004505 spoe_release_group(grp);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004506 }
4507 list_for_each_entry_safe(msg, msgback, &curmsgs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02004508 LIST_DELETE(&msg->list);
Christopher Faulet8ef75252017-02-20 22:56:03 +01004509 spoe_release_message(msg);
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004510 }
Christopher Faulet7250b8f2018-03-26 17:19:01 +02004511 list_for_each_entry_safe(logsrv, logsrvback, &curlogsrvs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +02004512 LIST_DELETE(&logsrv->list);
Christopher Faulet7250b8f2018-03-26 17:19:01 +02004513 free(logsrv);
4514 }
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004515 free(conf);
4516 return -1;
4517}
4518
Christopher Faulet344c4ab2017-09-22 10:20:13 +02004519/* Send message of a SPOE group. This is the action_ptr callback of a rule
4520 * associated to a "send-spoe-group" action.
4521 *
Christopher Faulet13403762019-12-13 09:01:57 +01004522 * It returns ACT_RET_CONT if processing is finished (with error or not), it returns
4523 * ACT_RET_YIELD if the action is in progress. */
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004524static enum act_return
4525spoe_send_group(struct act_rule *rule, struct proxy *px,
4526 struct session *sess, struct stream *s, int flags)
4527{
4528 struct filter *filter;
4529 struct spoe_agent *agent = NULL;
4530 struct spoe_group *group = NULL;
4531 struct spoe_context *ctx = NULL;
4532 int ret, dir;
4533
4534 list_for_each_entry(filter, &s->strm_flt.filters, list) {
4535 if (filter->config == rule->arg.act.p[0]) {
4536 agent = rule->arg.act.p[2];
4537 group = rule->arg.act.p[3];
4538 ctx = filter->ctx;
4539 break;
4540 }
4541 }
4542 if (agent == NULL || group == NULL || ctx == NULL)
Christopher Faulet13403762019-12-13 09:01:57 +01004543 return ACT_RET_CONT;
Christopher Faulet344c4ab2017-09-22 10:20:13 +02004544 if (ctx->state == SPOE_CTX_ST_NONE)
4545 return ACT_RET_CONT;
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004546
Christopher Faulet344c4ab2017-09-22 10:20:13 +02004547 switch (rule->from) {
4548 case ACT_F_TCP_REQ_SES: dir = SMP_OPT_DIR_REQ; break;
4549 case ACT_F_TCP_REQ_CNT: dir = SMP_OPT_DIR_REQ; break;
4550 case ACT_F_TCP_RES_CNT: dir = SMP_OPT_DIR_RES; break;
4551 case ACT_F_HTTP_REQ: dir = SMP_OPT_DIR_REQ; break;
4552 case ACT_F_HTTP_RES: dir = SMP_OPT_DIR_RES; break;
4553 default:
4554 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
4555 " - internal error while execute spoe-send-group\n",
4556 (int)now.tv_sec, (int)now.tv_usec, agent->id,
4557 __FUNCTION__, s);
4558 send_log(px, LOG_ERR, "SPOE: [%s] internal error while execute spoe-send-group\n",
4559 agent->id);
4560 return ACT_RET_CONT;
4561 }
4562
4563 ret = spoe_process_group(s, ctx, group, dir);
4564 if (ret == 1)
4565 return ACT_RET_CONT;
4566 else if (ret == 0) {
Christopher Faulet105ba6c2019-12-18 14:41:51 +01004567 if (flags & ACT_OPT_FINAL) {
Christopher Faulet344c4ab2017-09-22 10:20:13 +02004568 SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p"
4569 " - failed to process group '%s': interrupted by caller\n",
4570 (int)now.tv_sec, (int)now.tv_usec,
4571 agent->id, __FUNCTION__, s, group->id);
4572 ctx->status_code = SPOE_CTX_ERR_INTERRUPT;
Christopher Faulet6f9ea4f2018-01-24 16:13:48 +01004573 spoe_stop_processing(agent, ctx);
Christopher Fauletcaf2fec2018-04-04 10:25:50 +02004574 spoe_handle_processing_error(s, agent, ctx, dir);
Christopher Faulet344c4ab2017-09-22 10:20:13 +02004575 return ACT_RET_CONT;
4576 }
4577 return ACT_RET_YIELD;
4578 }
4579 else
Christopher Faulet13403762019-12-13 09:01:57 +01004580 return ACT_RET_CONT;
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004581}
4582
4583/* Check an "send-spoe-group" action. Here, we'll try to find the real SPOE
4584 * group associated to <rule>. The format of an rule using 'send-spoe-group'
4585 * action should be:
4586 *
4587 * (http|tcp)-(request|response) send-spoe-group <engine-id> <group-id>
4588 *
4589 * So, we'll loop on each configured SPOE filter for the proxy <px> to find the
4590 * SPOE engine matching <engine-id>. And then, we'll try to find the good group
4591 * matching <group-id>. Finally, we'll check all messages referenced by the SPOE
4592 * group.
4593 *
4594 * The function returns 1 in success case, otherwise, it returns 0 and err is
4595 * filled.
4596 */
4597static int
4598check_send_spoe_group(struct act_rule *rule, struct proxy *px, char **err)
4599{
4600 struct flt_conf *fconf;
4601 struct spoe_config *conf;
4602 struct spoe_agent *agent = NULL;
4603 struct spoe_group *group;
4604 struct spoe_message *msg;
4605 char *engine_id = rule->arg.act.p[0];
4606 char *group_id = rule->arg.act.p[1];
4607 unsigned int where = 0;
4608
4609 switch (rule->from) {
4610 case ACT_F_TCP_REQ_SES: where = SMP_VAL_FE_SES_ACC; break;
4611 case ACT_F_TCP_REQ_CNT: where = SMP_VAL_FE_REQ_CNT; break;
4612 case ACT_F_TCP_RES_CNT: where = SMP_VAL_BE_RES_CNT; break;
4613 case ACT_F_HTTP_REQ: where = SMP_VAL_FE_HRQ_HDR; break;
4614 case ACT_F_HTTP_RES: where = SMP_VAL_BE_HRS_HDR; break;
4615 default:
4616 memprintf(err,
4617 "internal error, unexpected rule->from=%d, please report this bug!",
4618 rule->from);
4619 goto error;
4620 }
4621
4622 /* Try to find the SPOE engine by checking all SPOE filters for proxy
4623 * <px> */
4624 list_for_each_entry(fconf, &px->filter_configs, list) {
4625 conf = fconf->conf;
4626
4627 /* This is not an SPOE filter */
4628 if (fconf->id != spoe_filter_id)
4629 continue;
4630
4631 /* This is the good engine */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004632 if (strcmp(conf->id, engine_id) == 0) {
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004633 agent = conf->agent;
4634 break;
4635 }
4636 }
4637 if (agent == NULL) {
4638 memprintf(err, "unable to find SPOE engine '%s' used by the send-spoe-group '%s'",
4639 engine_id, group_id);
4640 goto error;
4641 }
4642
4643 /* Try to find the right group */
4644 list_for_each_entry(group, &agent->groups, list) {
4645 /* This is the good group */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01004646 if (strcmp(group->id, group_id) == 0)
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004647 break;
4648 }
4649 if (&group->list == &agent->groups) {
4650 memprintf(err, "unable to find SPOE group '%s' into SPOE engine '%s' configuration",
4651 group_id, engine_id);
4652 goto error;
4653 }
4654
4655 /* Ok, we found the group, we need to check messages and their
4656 * arguments */
4657 list_for_each_entry(msg, &group->messages, by_grp) {
4658 struct spoe_arg *arg;
4659
4660 list_for_each_entry(arg, &msg->args, list) {
4661 if (!(arg->expr->fetch->val & where)) {
4662 memprintf(err, "Invalid SPOE message '%s' used by SPOE group '%s' at %s:%d: "
4663 "some args extract information from '%s',"
4664 "none of which is available here ('%s')",
4665 msg->id, group->id, msg->conf.file, msg->conf.line,
4666 sample_ckp_names(arg->expr->fetch->use),
4667 sample_ckp_names(where));
4668 goto error;
4669 }
4670 }
4671 }
4672
4673 free(engine_id);
4674 free(group_id);
4675 rule->arg.act.p[0] = fconf; /* Associate filter config with the rule */
4676 rule->arg.act.p[1] = conf; /* Associate SPOE config with the rule */
4677 rule->arg.act.p[2] = agent; /* Associate SPOE agent with the rule */
4678 rule->arg.act.p[3] = group; /* Associate SPOE group with the rule */
4679 return 1;
4680
4681 error:
4682 free(engine_id);
4683 free(group_id);
4684 return 0;
4685}
4686
4687/* Parse 'send-spoe-group' action following the format:
4688 *
4689 * ... send-spoe-group <engine-id> <group-id>
4690 *
4691 * It returns ACT_RET_PRS_ERR if fails and <err> is filled with an error
4692 * message. Otherwise, it returns ACT_RET_PRS_OK and parsing engine and group
4693 * ids are saved and used later, when the rule will be checked.
4694 */
4695static enum act_parse_ret
4696parse_send_spoe_group(const char **args, int *orig_arg, struct proxy *px,
4697 struct act_rule *rule, char **err)
4698{
4699 if (!*args[*orig_arg] || !*args[*orig_arg+1] ||
4700 (*args[*orig_arg+2] && strcmp(args[*orig_arg+2], "if") != 0 && strcmp(args[*orig_arg+2], "unless") != 0)) {
4701 memprintf(err, "expects 2 arguments: <engine-id> <group-id>");
4702 return ACT_RET_PRS_ERR;
4703 }
4704 rule->arg.act.p[0] = strdup(args[*orig_arg]); /* Copy the SPOE engine id */
4705 rule->arg.act.p[1] = strdup(args[*orig_arg+1]); /* Cope the SPOE group id */
4706
4707 (*orig_arg) += 2;
4708
4709 rule->action = ACT_CUSTOM;
4710 rule->action_ptr = spoe_send_group;
4711 rule->check_ptr = check_send_spoe_group;
4712 return ACT_RET_PRS_OK;
4713}
4714
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02004715
4716/* Declare the filter parser for "spoe" keyword */
4717static struct flt_kw_list flt_kws = { "SPOE", { }, {
4718 { "spoe", parse_spoe_flt, NULL },
4719 { NULL, NULL, NULL },
4720 }
4721};
4722
Willy Tarreau0108d902018-11-25 19:14:37 +01004723INITCALL1(STG_REGISTER, flt_register_keywords, &flt_kws);
4724
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004725/* Delcate the action parser for "spoe-action" keyword */
4726static struct action_kw_list tcp_req_action_kws = { { }, {
4727 { "send-spoe-group", parse_send_spoe_group },
4728 { /* END */ },
4729 }
4730};
Willy Tarreau0108d902018-11-25 19:14:37 +01004731
4732INITCALL1(STG_REGISTER, tcp_req_cont_keywords_register, &tcp_req_action_kws);
4733
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004734static struct action_kw_list tcp_res_action_kws = { { }, {
4735 { "send-spoe-group", parse_send_spoe_group },
4736 { /* END */ },
4737 }
4738};
Willy Tarreau0108d902018-11-25 19:14:37 +01004739
4740INITCALL1(STG_REGISTER, tcp_res_cont_keywords_register, &tcp_res_action_kws);
4741
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004742static struct action_kw_list http_req_action_kws = { { }, {
4743 { "send-spoe-group", parse_send_spoe_group },
4744 { /* END */ },
4745 }
4746};
Willy Tarreau0108d902018-11-25 19:14:37 +01004747
4748INITCALL1(STG_REGISTER, http_req_keywords_register, &http_req_action_kws);
4749
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004750static struct action_kw_list http_res_action_kws = { { }, {
4751 { "send-spoe-group", parse_send_spoe_group },
4752 { /* END */ },
4753 }
4754};
4755
Willy Tarreau0108d902018-11-25 19:14:37 +01004756INITCALL1(STG_REGISTER, http_res_keywords_register, &http_res_action_kws);