diff options
Diffstat (limited to 'src/flt_spoe.c')
| -rw-r--r-- | src/flt_spoe.c | 4739 |
1 files changed, 4739 insertions, 0 deletions
diff --git a/src/flt_spoe.c b/src/flt_spoe.c new file mode 100644 index 0000000..70ea2ba --- /dev/null +++ b/src/flt_spoe.c @@ -0,0 +1,4739 @@ +/* + * Stream processing offload engine management. + * + * Copyright 2016 HAProxy Technologies, Christopher Faulet <cfaulet@haproxy.com> + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version + * 2 of the License, or (at your option) any later version. + * + */ +#include <ctype.h> +#include <errno.h> + +#include <haproxy/acl.h> +#include <haproxy/applet.h> +#include <haproxy/action-t.h> +#include <haproxy/api.h> +#include <haproxy/arg.h> +#include <haproxy/cfgparse.h> +#include <haproxy/check.h> +#include <haproxy/filters.h> +#include <haproxy/freq_ctr.h> +#include <haproxy/frontend.h> +#include <haproxy/global.h> +#include <haproxy/http_rules.h> +#include <haproxy/log.h> +#include <haproxy/pool.h> +#include <haproxy/proxy.h> +#include <haproxy/sample.h> +#include <haproxy/sc_strm.h> +#include <haproxy/session.h> +#include <haproxy/signal.h> +#include <haproxy/sink.h> +#include <haproxy/spoe.h> +#include <haproxy/stconn.h> +#include <haproxy/stream.h> +#include <haproxy/task.h> +#include <haproxy/tcp_rules.h> +#include <haproxy/thread.h> +#include <haproxy/time.h> +#include <haproxy/tools.h> +#include <haproxy/vars.h> + + +#if defined(DEBUG_SPOE) || defined(DEBUG_FULL) +#define SPOE_PRINTF(x...) fprintf(x) +#define SPOE_DEBUG_STMT(statement) statement +#else +#define SPOE_PRINTF(x...) +#define SPOE_DEBUG_STMT(statement) +#endif + +/* Reserved 4 bytes to the frame size. So a frame and its size can be written + * together in a buffer */ +#define MAX_FRAME_SIZE global.tune.bufsize - 4 + +/* The minimum size for a frame */ +#define MIN_FRAME_SIZE 256 + +/* Reserved for the metadata and the frame type. + * So <MAX_FRAME_SIZE> - <FRAME_HDR_SIZE> is the maximum payload size */ +#define FRAME_HDR_SIZE 32 + +/* Helper to get SPOE ctx inside an appctx */ +#define SPOE_APPCTX(appctx) ((struct spoe_appctx *)((appctx)->svcctx)) + +/* SPOE filter id. Used to identify SPOE filters */ +const char *spoe_filter_id = "SPOE filter"; + +/* Set if the handle on SIGUSR1 is registered */ +static int sighandler_registered = 0; + +/* The name of the SPOE engine, used during the parsing */ +char *curengine = NULL; + +/* SPOE agent used during the parsing */ +/* SPOE agent/group/message used during the parsing */ +struct spoe_agent *curagent = NULL; +struct spoe_group *curgrp = NULL; +struct spoe_message *curmsg = NULL; + +/* list of SPOE messages and placeholders used during the parsing */ +struct list curmsgs; +struct list curgrps; +struct list curmphs; +struct list curgphs; +struct list curvars; + +/* list of log servers used during the parsing */ +struct list curloggers; + +/* agent's proxy flags (PR_O_* and PR_O2_*) used during parsing */ +int curpxopts; +int curpxopts2; + +/* Pools used to allocate SPOE structs */ +DECLARE_STATIC_POOL(pool_head_spoe_ctx, "spoe_ctx", sizeof(struct spoe_context)); +DECLARE_STATIC_POOL(pool_head_spoe_appctx, "spoe_appctx", sizeof(struct spoe_appctx)); + +struct flt_ops spoe_ops; + +static int spoe_queue_context(struct spoe_context *ctx); +static int spoe_acquire_buffer(struct buffer *buf, struct buffer_wait *buffer_wait); +static void spoe_release_buffer(struct buffer *buf, struct buffer_wait *buffer_wait); +static struct appctx *spoe_create_appctx(struct spoe_config *conf); + +/******************************************************************** + * helper functions/globals + ********************************************************************/ +static void +spoe_release_placeholder(struct spoe_placeholder *ph) +{ + if (!ph) + return; + free(ph->id); + free(ph); +} + +static void +spoe_release_message(struct spoe_message *msg) +{ + struct spoe_arg *arg, *argback; + struct acl *acl, *aclback; + + if (!msg) + return; + free(msg->id); + free(msg->conf.file); + list_for_each_entry_safe(arg, argback, &msg->args, list) { + release_sample_expr(arg->expr); + free(arg->name); + LIST_DELETE(&arg->list); + free(arg); + } + list_for_each_entry_safe(acl, aclback, &msg->acls, list) { + LIST_DELETE(&acl->list); + prune_acl(acl); + free(acl); + } + free_acl_cond(msg->cond); + free(msg); +} + +static void +spoe_release_group(struct spoe_group *grp) +{ + if (!grp) + return; + free(grp->id); + free(grp->conf.file); + free(grp); +} + +static void +spoe_release_agent(struct spoe_agent *agent) +{ + struct spoe_message *msg, *msgback; + struct spoe_group *grp, *grpback; + int i; + + if (!agent) + return; + free(agent->id); + free(agent->conf.file); + free(agent->var_pfx); + free(agent->var_on_error); + free(agent->var_t_process); + free(agent->var_t_total); + list_for_each_entry_safe(msg, msgback, &agent->messages, list) { + LIST_DELETE(&msg->list); + spoe_release_message(msg); + } + list_for_each_entry_safe(grp, grpback, &agent->groups, list) { + LIST_DELETE(&grp->list); + spoe_release_group(grp); + } + if (agent->rt) { + for (i = 0; i < global.nbthread; ++i) { + free(agent->rt[i].engine_id); + HA_SPIN_DESTROY(&agent->rt[i].lock); + } + } + free(agent->rt); + free(agent); +} + +static const char *spoe_frm_err_reasons[SPOE_FRM_ERRS] = { + [SPOE_FRM_ERR_NONE] = "normal", + [SPOE_FRM_ERR_IO] = "I/O error", + [SPOE_FRM_ERR_TOUT] = "a timeout occurred", + [SPOE_FRM_ERR_TOO_BIG] = "frame is too big", + [SPOE_FRM_ERR_INVALID] = "invalid frame received", + [SPOE_FRM_ERR_NO_VSN] = "version value not found", + [SPOE_FRM_ERR_NO_FRAME_SIZE] = "max-frame-size value not found", + [SPOE_FRM_ERR_NO_CAP] = "capabilities value not found", + [SPOE_FRM_ERR_BAD_VSN] = "unsupported version", + [SPOE_FRM_ERR_BAD_FRAME_SIZE] = "max-frame-size too big or too small", + [SPOE_FRM_ERR_FRAG_NOT_SUPPORTED] = "fragmentation not supported", + [SPOE_FRM_ERR_INTERLACED_FRAMES] = "invalid interlaced frames", + [SPOE_FRM_ERR_FRAMEID_NOTFOUND] = "frame-id not found", + [SPOE_FRM_ERR_RES] = "resource allocation error", + [SPOE_FRM_ERR_UNKNOWN] = "an unknown error occurred", +}; + +static const char *spoe_event_str[SPOE_EV_EVENTS] = { + [SPOE_EV_ON_CLIENT_SESS] = "on-client-session", + [SPOE_EV_ON_TCP_REQ_FE] = "on-frontend-tcp-request", + [SPOE_EV_ON_TCP_REQ_BE] = "on-backend-tcp-request", + [SPOE_EV_ON_HTTP_REQ_FE] = "on-frontend-http-request", + [SPOE_EV_ON_HTTP_REQ_BE] = "on-backend-http-request", + + [SPOE_EV_ON_SERVER_SESS] = "on-server-session", + [SPOE_EV_ON_TCP_RSP] = "on-tcp-response", + [SPOE_EV_ON_HTTP_RSP] = "on-http-response", +}; + + +#if defined(DEBUG_SPOE) || defined(DEBUG_FULL) + +static const char *spoe_ctx_state_str[SPOE_CTX_ST_ERROR+1] = { + [SPOE_CTX_ST_NONE] = "NONE", + [SPOE_CTX_ST_READY] = "READY", + [SPOE_CTX_ST_ENCODING_MSGS] = "ENCODING_MSGS", + [SPOE_CTX_ST_SENDING_MSGS] = "SENDING_MSGS", + [SPOE_CTX_ST_WAITING_ACK] = "WAITING_ACK", + [SPOE_CTX_ST_DONE] = "DONE", + [SPOE_CTX_ST_ERROR] = "ERROR", +}; + +static const char *spoe_appctx_state_str[SPOE_APPCTX_ST_END+1] = { + [SPOE_APPCTX_ST_CONNECT] = "CONNECT", + [SPOE_APPCTX_ST_CONNECTING] = "CONNECTING", + [SPOE_APPCTX_ST_IDLE] = "IDLE", + [SPOE_APPCTX_ST_PROCESSING] = "PROCESSING", + [SPOE_APPCTX_ST_SENDING_FRAG_NOTIFY] = "SENDING_FRAG_NOTIFY", + [SPOE_APPCTX_ST_WAITING_SYNC_ACK] = "WAITING_SYNC_ACK", + [SPOE_APPCTX_ST_DISCONNECT] = "DISCONNECT", + [SPOE_APPCTX_ST_DISCONNECTING] = "DISCONNECTING", + [SPOE_APPCTX_ST_EXIT] = "EXIT", + [SPOE_APPCTX_ST_END] = "END", +}; + +#endif + +/* Used to generates a unique id for an engine. On success, it returns a + * allocated string. So it is the caller's responsibility to release it. If the + * allocation failed, it returns NULL. */ +static char * +generate_pseudo_uuid() +{ + ha_generate_uuid(&trash); + return my_strndup(trash.area, trash.data); +} + +/* set/add to <t> the elapsed time since <since> and now */ +static inline void +spoe_update_stat_time(ullong *since, long *t) +{ + if (*t == -1) + *t = ns_to_ms(now_ns - *since); + else + *t += ns_to_ms(now_ns - *since); + *since = 0; +} + +/******************************************************************** + * Functions that encode/decode SPOE frames + ********************************************************************/ +/* Helper to get static string length, excluding the terminating null byte */ +#define SLEN(str) (sizeof(str)-1) + +/* Predefined key used in HELLO/DISCONNECT frames */ +#define SUPPORTED_VERSIONS_KEY "supported-versions" +#define VERSION_KEY "version" +#define MAX_FRAME_SIZE_KEY "max-frame-size" +#define CAPABILITIES_KEY "capabilities" +#define ENGINE_ID_KEY "engine-id" +#define HEALTHCHECK_KEY "healthcheck" +#define STATUS_CODE_KEY "status-code" +#define MSG_KEY "message" + +struct spoe_version { + char *str; + int min; + int max; +}; + +/* All supported versions */ +static struct spoe_version supported_versions[] = { + /* 1.0 is now unsupported because of a bug about frame's flags*/ + {"2.0", 2000, 2000}, + {NULL, 0, 0} +}; + +/* Comma-separated list of supported versions */ +#define SUPPORTED_VERSIONS_VAL "2.0" + +/* Convert a string to a SPOE version value. The string must follow the format + * "MAJOR.MINOR". It will be concerted into the integer (1000 * MAJOR + MINOR). + * If an error occurred, -1 is returned. */ +static int +spoe_str_to_vsn(const char *str, size_t len) +{ + const char *p, *end; + int maj, min, vsn; + + p = str; + end = str+len; + maj = min = 0; + vsn = -1; + + /* skip leading spaces */ + while (p < end && isspace((unsigned char)*p)) + p++; + + /* parse Major number, until the '.' */ + while (*p != '.') { + if (p >= end || *p < '0' || *p > '9') + goto out; + maj *= 10; + maj += (*p - '0'); + p++; + } + + /* check Major version */ + if (!maj) + goto out; + + p++; /* skip the '.' */ + if (p >= end || *p < '0' || *p > '9') /* Minor number is missing */ + goto out; + + /* Parse Minor number */ + while (p < end) { + if (*p < '0' || *p > '9') + break; + min *= 10; + min += (*p - '0'); + p++; + } + + /* check Minor number */ + if (min > 999) + goto out; + + /* skip trailing spaces */ + while (p < end && isspace((unsigned char)*p)) + p++; + if (p != end) + goto out; + + vsn = maj * 1000 + min; + out: + return vsn; +} + +/* Encode the HELLO frame sent by HAProxy to an agent. It returns the number of + * encoded bytes in the frame on success, 0 if an encoding error occurred and -1 + * if a fatal error occurred. */ +static int +spoe_prepare_hahello_frame(struct appctx *appctx, char *frame, size_t size) +{ + struct buffer *chk; + struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent; + char *p, *end; + unsigned int flags = SPOE_FRM_FL_FIN; + size_t sz; + + p = frame; + end = frame+size; + + /* Set Frame type */ + *p++ = SPOE_FRM_T_HAPROXY_HELLO; + + /* Set flags */ + flags = htonl(flags); + memcpy(p, (char *)&flags, 4); + p += 4; + + /* No stream-id and frame-id for HELLO frames */ + *p++ = 0; *p++ = 0; + + /* There are 3 mandatory items: "supported-versions", "max-frame-size" + * and "capabilities" */ + + /* "supported-versions" K/V item */ + sz = SLEN(SUPPORTED_VERSIONS_KEY); + if (spoe_encode_buffer(SUPPORTED_VERSIONS_KEY, sz, &p, end) == -1) + goto too_big; + + *p++ = SPOE_DATA_T_STR; + sz = SLEN(SUPPORTED_VERSIONS_VAL); + if (spoe_encode_buffer(SUPPORTED_VERSIONS_VAL, sz, &p, end) == -1) + goto too_big; + + /* "max-fram-size" K/V item */ + sz = SLEN(MAX_FRAME_SIZE_KEY); + if (spoe_encode_buffer(MAX_FRAME_SIZE_KEY, sz, &p, end) == -1) + goto too_big; + + *p++ = SPOE_DATA_T_UINT32; + if (encode_varint(SPOE_APPCTX(appctx)->max_frame_size, &p, end) == -1) + goto too_big; + + /* "capabilities" K/V item */ + sz = SLEN(CAPABILITIES_KEY); + if (spoe_encode_buffer(CAPABILITIES_KEY, sz, &p, end) == -1) + goto too_big; + + *p++ = SPOE_DATA_T_STR; + chk = get_trash_chunk(); + if (agent != NULL && (agent->flags & SPOE_FL_PIPELINING)) { + memcpy(chk->area, "pipelining", 10); + chk->data += 10; + } + if (agent != NULL && (agent->flags & SPOE_FL_ASYNC)) { + if (chk->data) chk->area[chk->data++] = ','; + memcpy(chk->area+chk->data, "async", 5); + chk->data += 5; + } + if (agent != NULL && (agent->flags & SPOE_FL_RCV_FRAGMENTATION)) { + if (chk->data) chk->area[chk->data++] = ','; + memcpy(chk->area+chk->data, "fragmentation", 13); + chk->data += 13; + } + if (spoe_encode_buffer(chk->area, chk->data, &p, end) == -1) + goto too_big; + + /* (optional) "engine-id" K/V item, if present */ + if (agent != NULL && agent->rt[tid].engine_id != NULL) { + sz = SLEN(ENGINE_ID_KEY); + if (spoe_encode_buffer(ENGINE_ID_KEY, sz, &p, end) == -1) + goto too_big; + + *p++ = SPOE_DATA_T_STR; + sz = strlen(agent->rt[tid].engine_id); + if (spoe_encode_buffer(agent->rt[tid].engine_id, sz, &p, end) == -1) + goto too_big; + } + + return (p - frame); + + too_big: + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOO_BIG; + return 0; +} + +/* Encode DISCONNECT frame sent by HAProxy to an agent. It returns the number of + * encoded bytes in the frame on success, 0 if an encoding error occurred and -1 + * if a fatal error occurred. */ +static int +spoe_prepare_hadiscon_frame(struct appctx *appctx, char *frame, size_t size) +{ + const char *reason; + char *p, *end; + unsigned int flags = SPOE_FRM_FL_FIN; + size_t sz; + + p = frame; + end = frame+size; + + /* Set Frame type */ + *p++ = SPOE_FRM_T_HAPROXY_DISCON; + + /* Set flags */ + flags = htonl(flags); + memcpy(p, (char *)&flags, 4); + p += 4; + + /* No stream-id and frame-id for DISCONNECT frames */ + *p++ = 0; *p++ = 0; + + if (SPOE_APPCTX(appctx)->status_code >= SPOE_FRM_ERRS) + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_UNKNOWN; + + /* There are 2 mandatory items: "status-code" and "message" */ + + /* "status-code" K/V item */ + sz = SLEN(STATUS_CODE_KEY); + if (spoe_encode_buffer(STATUS_CODE_KEY, sz, &p, end) == -1) + goto too_big; + + *p++ = SPOE_DATA_T_UINT32; + if (encode_varint(SPOE_APPCTX(appctx)->status_code, &p, end) == -1) + goto too_big; + + /* "message" K/V item */ + sz = SLEN(MSG_KEY); + if (spoe_encode_buffer(MSG_KEY, sz, &p, end) == -1) + goto too_big; + + /*Get the message corresponding to the status code */ + reason = spoe_frm_err_reasons[SPOE_APPCTX(appctx)->status_code]; + + *p++ = SPOE_DATA_T_STR; + sz = strlen(reason); + if (spoe_encode_buffer(reason, sz, &p, end) == -1) + goto too_big; + + return (p - frame); + + too_big: + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOO_BIG; + return 0; +} + +/* Encode the NOTIFY frame sent by HAProxy to an agent. It returns the number of + * encoded bytes in the frame on success, 0 if an encoding error occurred and -1 + * if a fatal error occurred. */ +static int +spoe_prepare_hanotify_frame(struct appctx *appctx, struct spoe_context *ctx, + char *frame, size_t size) +{ + char *p, *end; + unsigned int stream_id, frame_id; + unsigned int flags = SPOE_FRM_FL_FIN; + size_t sz; + + p = frame; + end = frame+size; + + stream_id = ctx->stream_id; + frame_id = ctx->frame_id; + + if (ctx->flags & SPOE_CTX_FL_FRAGMENTED) { + /* The fragmentation is not supported by the applet */ + if (!(SPOE_APPCTX(appctx)->flags & SPOE_APPCTX_FL_FRAGMENTATION)) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_FRAG_NOT_SUPPORTED; + return -1; + } + flags = ctx->frag_ctx.flags; + } + + /* Set Frame type */ + *p++ = SPOE_FRM_T_HAPROXY_NOTIFY; + + /* Set flags */ + flags = htonl(flags); + memcpy(p, (char *)&flags, 4); + p += 4; + + /* Set stream-id and frame-id */ + if (encode_varint(stream_id, &p, end) == -1) + goto too_big; + if (encode_varint(frame_id, &p, end) == -1) + goto too_big; + + /* Copy encoded messages, if possible */ + sz = b_data(&ctx->buffer); + if (p + sz >= end) + goto too_big; + memcpy(p, b_head(&ctx->buffer), sz); + p += sz; + + return (p - frame); + + too_big: + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOO_BIG; + return 0; +} + +/* Encode next part of a fragmented frame sent by HAProxy to an agent. It + * returns the number of encoded bytes in the frame on success, 0 if an encoding + * error occurred and -1 if a fatal error occurred. */ +static int +spoe_prepare_hafrag_frame(struct appctx *appctx, struct spoe_context *ctx, + char *frame, size_t size) +{ + char *p, *end; + unsigned int stream_id, frame_id; + unsigned int flags; + size_t sz; + + p = frame; + end = frame+size; + + /* <ctx> is null when the stream has aborted the processing of a + * fragmented frame. In this case, we must notify the corresponding + * agent using ids stored in <frag_ctx>. */ + if (ctx == NULL) { + flags = (SPOE_FRM_FL_FIN|SPOE_FRM_FL_ABRT); + stream_id = SPOE_APPCTX(appctx)->frag_ctx.cursid; + frame_id = SPOE_APPCTX(appctx)->frag_ctx.curfid; + } + else { + flags = ctx->frag_ctx.flags; + stream_id = ctx->stream_id; + frame_id = ctx->frame_id; + } + + /* Set Frame type */ + *p++ = SPOE_FRM_T_UNSET; + + /* Set flags */ + flags = htonl(flags); + memcpy(p, (char *)&flags, 4); + p += 4; + + /* Set stream-id and frame-id */ + if (encode_varint(stream_id, &p, end) == -1) + goto too_big; + if (encode_varint(frame_id, &p, end) == -1) + goto too_big; + + if (ctx == NULL) + goto end; + + /* Copy encoded messages, if possible */ + sz = b_data(&ctx->buffer); + if (p + sz >= end) + goto too_big; + memcpy(p, b_head(&ctx->buffer), sz); + p += sz; + + end: + return (p - frame); + + too_big: + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOO_BIG; + return 0; +} + +/* Decode and process the HELLO frame sent by an agent. It returns the number of + * read bytes on success, 0 if a decoding error occurred, and -1 if a fatal + * error occurred. */ +static int +spoe_handle_agenthello_frame(struct appctx *appctx, char *frame, size_t size) +{ + struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent; + char *p, *end; + int vsn, max_frame_size; + unsigned int flags; + + p = frame; + end = frame + size; + + /* Check frame type */ + if (*p++ != SPOE_FRM_T_AGENT_HELLO) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + + if (size < 7 /* TYPE + METADATA */) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + + /* Retrieve flags */ + memcpy((char *)&flags, p, 4); + flags = ntohl(flags); + p += 4; + + /* Fragmentation is not supported for HELLO frame */ + if (!(flags & SPOE_FRM_FL_FIN)) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_FRAG_NOT_SUPPORTED; + return -1; + } + + /* stream-id and frame-id must be cleared */ + if (*p != 0 || *(p+1) != 0) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + p += 2; + + /* There are 3 mandatory items: "version", "max-frame-size" and + * "capabilities" */ + + /* Loop on K/V items */ + vsn = max_frame_size = flags = 0; + while (p < end) { + char *str; + uint64_t sz; + int ret; + + /* Decode the item key */ + ret = spoe_decode_buffer(&p, end, &str, &sz); + if (ret == -1 || !sz) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + + /* Check "version" K/V item */ + if (sz >= strlen(VERSION_KEY) && !memcmp(str, VERSION_KEY, strlen(VERSION_KEY))) { + int i, type = *p++; + + /* The value must be a string */ + if ((type & SPOE_DATA_T_MASK) != SPOE_DATA_T_STR) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + if (spoe_decode_buffer(&p, end, &str, &sz) == -1) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + + vsn = spoe_str_to_vsn(str, sz); + if (vsn == -1) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_BAD_VSN; + return -1; + } + for (i = 0; supported_versions[i].str != NULL; ++i) { + if (vsn >= supported_versions[i].min && + vsn <= supported_versions[i].max) + break; + } + if (supported_versions[i].str == NULL) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_BAD_VSN; + return -1; + } + } + /* Check "max-frame-size" K/V item */ + else if (sz >= strlen(MAX_FRAME_SIZE_KEY) && !memcmp(str, MAX_FRAME_SIZE_KEY, strlen(MAX_FRAME_SIZE_KEY))) { + int type = *p++; + + /* The value must be integer */ + if ((type & SPOE_DATA_T_MASK) != SPOE_DATA_T_INT32 && + (type & SPOE_DATA_T_MASK) != SPOE_DATA_T_INT64 && + (type & SPOE_DATA_T_MASK) != SPOE_DATA_T_UINT32 && + (type & SPOE_DATA_T_MASK) != SPOE_DATA_T_UINT64) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + if (decode_varint(&p, end, &sz) == -1) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + if (sz < MIN_FRAME_SIZE || + sz > SPOE_APPCTX(appctx)->max_frame_size) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_BAD_FRAME_SIZE; + return -1; + } + max_frame_size = sz; + } + /* Check "capabilities" K/V item */ + else if (sz >= strlen(CAPABILITIES_KEY) && !memcmp(str, CAPABILITIES_KEY, strlen(CAPABILITIES_KEY))) { + int type = *p++; + + /* The value must be a string */ + if ((type & SPOE_DATA_T_MASK) != SPOE_DATA_T_STR) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + if (spoe_decode_buffer(&p, end, &str, &sz) == -1) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + + while (sz) { + char *delim; + + /* Skip leading spaces */ + for (; isspace((unsigned char)*str) && sz; str++, sz--); + + if (sz >= 10 && !strncmp(str, "pipelining", 10)) { + str += 10; sz -= 10; + if (!sz || isspace((unsigned char)*str) || *str == ',') + flags |= SPOE_APPCTX_FL_PIPELINING; + } + else if (sz >= 5 && !strncmp(str, "async", 5)) { + str += 5; sz -= 5; + if (!sz || isspace((unsigned char)*str) || *str == ',') + flags |= SPOE_APPCTX_FL_ASYNC; + } + else if (sz >= 13 && !strncmp(str, "fragmentation", 13)) { + str += 13; sz -= 13; + if (!sz || isspace((unsigned char)*str) || *str == ',') + flags |= SPOE_APPCTX_FL_FRAGMENTATION; + } + + /* Get the next comma or break */ + if (!sz || (delim = memchr(str, ',', sz)) == NULL) + break; + delim++; + sz -= (delim - str); + str = delim; + } + } + else { + /* Silently ignore unknown item */ + if (spoe_skip_data(&p, end) == -1) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + } + } + + /* Final checks */ + if (!vsn) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_NO_VSN; + return -1; + } + if (!max_frame_size) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_NO_FRAME_SIZE; + return -1; + } + if (!agent) + flags &= ~(SPOE_APPCTX_FL_PIPELINING|SPOE_APPCTX_FL_ASYNC); + else { + if ((flags & SPOE_APPCTX_FL_PIPELINING) && !(agent->flags & SPOE_FL_PIPELINING)) + flags &= ~SPOE_APPCTX_FL_PIPELINING; + if ((flags & SPOE_APPCTX_FL_ASYNC) && !(agent->flags & SPOE_FL_ASYNC)) + flags &= ~SPOE_APPCTX_FL_ASYNC; + } + + SPOE_APPCTX(appctx)->version = (unsigned int)vsn; + SPOE_APPCTX(appctx)->max_frame_size = (unsigned int)max_frame_size; + SPOE_APPCTX(appctx)->flags |= flags; + + return (p - frame); +} + +/* Decode DISCONNECT frame sent by an agent. It returns the number of by read + * bytes on success, 0 if the frame can be ignored and -1 if an error + * occurred. */ +static int +spoe_handle_agentdiscon_frame(struct appctx *appctx, char *frame, size_t size) +{ + char *p, *end; + unsigned int flags; + + p = frame; + end = frame + size; + + /* Check frame type */ + if (*p++ != SPOE_FRM_T_AGENT_DISCON) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + + if (size < 7 /* TYPE + METADATA */) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + + /* Retrieve flags */ + memcpy((char *)&flags, p, 4); + flags = ntohl(flags); + p += 4; + + /* Fragmentation is not supported for DISCONNECT frame */ + if (!(flags & SPOE_FRM_FL_FIN)) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_FRAG_NOT_SUPPORTED; + return -1; + } + + /* stream-id and frame-id must be cleared */ + if (*p != 0 || *(p+1) != 0) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + p += 2; + + /* There are 2 mandatory items: "status-code" and "message" */ + + /* Loop on K/V items */ + while (p < end) { + char *str; + uint64_t sz; + int ret; + + /* Decode the item key */ + ret = spoe_decode_buffer(&p, end, &str, &sz); + if (ret == -1 || !sz) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + + /* Check "status-code" K/V item */ + if (sz >= strlen(STATUS_CODE_KEY) && !memcmp(str, STATUS_CODE_KEY, strlen(STATUS_CODE_KEY))) { + int type = *p++; + + /* The value must be an integer */ + if ((type & SPOE_DATA_T_MASK) != SPOE_DATA_T_INT32 && + (type & SPOE_DATA_T_MASK) != SPOE_DATA_T_INT64 && + (type & SPOE_DATA_T_MASK) != SPOE_DATA_T_UINT32 && + (type & SPOE_DATA_T_MASK) != SPOE_DATA_T_UINT64) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + if (decode_varint(&p, end, &sz) == -1) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + SPOE_APPCTX(appctx)->status_code = sz; + } + + /* Check "message" K/V item */ + else if (sz >= strlen(MSG_KEY) && !memcmp(str, MSG_KEY, strlen(MSG_KEY))) { + int type = *p++; + + /* The value must be a string */ + if ((type & SPOE_DATA_T_MASK) != SPOE_DATA_T_STR) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + ret = spoe_decode_buffer(&p, end, &str, &sz); + if (ret == -1 || sz > 255) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } +#if defined(DEBUG_SPOE) || defined(DEBUG_FULL) + SPOE_APPCTX(appctx)->reason = str; + SPOE_APPCTX(appctx)->rlen = sz; +#endif + } + else { + /* Silently ignore unknown item */ + if (spoe_skip_data(&p, end) == -1) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + } + } + + return (p - frame); +} + + +/* Decode ACK frame sent by an agent. It returns the number of read bytes on + * success, 0 if the frame can be ignored and -1 if an error occurred. */ +static int +spoe_handle_agentack_frame(struct appctx *appctx, struct spoe_context **ctx, + char *frame, size_t size) +{ + struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent; + char *p, *end; + uint64_t stream_id, frame_id; + int len; + unsigned int flags; + + p = frame; + end = frame + size; + *ctx = NULL; + + /* Check frame type */ + if (*p++ != SPOE_FRM_T_AGENT_ACK) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + + if (size < 7 /* TYPE + METADATA */) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + + /* Retrieve flags */ + memcpy((char *)&flags, p, 4); + flags = ntohl(flags); + p += 4; + + /* Fragmentation is not supported for now */ + if (!(flags & SPOE_FRM_FL_FIN)) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_FRAG_NOT_SUPPORTED; + return -1; + } + + /* Get the stream-id and the frame-id */ + if (decode_varint(&p, end, &stream_id) == -1) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + if (decode_varint(&p, end, &frame_id) == -1) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + + /* Try to find the corresponding SPOE context */ + if (SPOE_APPCTX(appctx)->flags & SPOE_APPCTX_FL_ASYNC) { + list_for_each_entry((*ctx), &agent->rt[tid].waiting_queue, list) { + if ((*ctx)->stream_id == (unsigned int)stream_id && + (*ctx)->frame_id == (unsigned int)frame_id) + goto found; + } + } + else { + list_for_each_entry((*ctx), &SPOE_APPCTX(appctx)->waiting_queue, list) { + if ((*ctx)->stream_id == (unsigned int)stream_id && + (*ctx)->frame_id == (unsigned int)frame_id) + goto found; + } + } + + if (SPOE_APPCTX(appctx)->frag_ctx.ctx && + SPOE_APPCTX(appctx)->frag_ctx.cursid == (unsigned int)stream_id && + SPOE_APPCTX(appctx)->frag_ctx.curfid == (unsigned int)frame_id) { + + /* ABRT bit is set for an unfinished fragmented frame */ + if (flags & SPOE_FRM_FL_ABRT) { + *ctx = SPOE_APPCTX(appctx)->frag_ctx.ctx; + (*ctx)->state = SPOE_CTX_ST_ERROR; + (*ctx)->status_code = SPOE_CTX_ERR_FRAG_FRAME_ABRT; + /* Ignore the payload */ + goto end; + } + /* TODO: Handle more flags for fragmented frames: RESUME, FINISH... */ + /* For now, we ignore the ack */ + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_INVALID; + return 0; + } + + /* No Stream found, ignore the frame */ + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p" + " - Ignore ACK frame" + " - stream-id=%u - frame-id=%u\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, appctx, + (unsigned int)stream_id, (unsigned int)frame_id); + + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_FRAMEID_NOTFOUND; + if (appctx->st0 == SPOE_APPCTX_ST_WAITING_SYNC_ACK) { + /* Report an error if we are waiting the ack for another frame, + * but not if there is no longer frame waiting for a ack + * (timeout) + */ + if (!LIST_ISEMPTY(&SPOE_APPCTX(appctx)->waiting_queue) || + SPOE_APPCTX(appctx)->frag_ctx.ctx) + return -1; + appctx->st0 = SPOE_APPCTX_ST_PROCESSING; + SPOE_APPCTX(appctx)->cur_fpa = 0; + } + return 0; + + found: + if (!spoe_acquire_buffer(&SPOE_APPCTX(appctx)->buffer, + &SPOE_APPCTX(appctx)->buffer_wait)) { + *ctx = NULL; + return 1; /* Retry later */ + } + + /* Copy encoded actions */ + len = (end - p); + memcpy(b_head(&SPOE_APPCTX(appctx)->buffer), p, len); + b_set_data(&SPOE_APPCTX(appctx)->buffer, len); + p += len; + + /* Transfer the buffer ownership to the SPOE context */ + (*ctx)->buffer = SPOE_APPCTX(appctx)->buffer; + SPOE_APPCTX(appctx)->buffer = BUF_NULL; + + (*ctx)->state = SPOE_CTX_ST_DONE; + + end: + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p" + " - ACK frame received" + " - ctx=%p - stream-id=%u - frame-id=%u - flags=0x%08x\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, appctx, *ctx, (*ctx)->stream_id, + (*ctx)->frame_id, flags); + return (p - frame); +} + +/* This function is used in cfgparse.c and declared in proto/checks.h. It + * prepare the request to send to agents during a healthcheck. It returns 0 on + * success and -1 if an error occurred. */ +int +spoe_prepare_healthcheck_request(char **req, int *len) +{ + struct appctx appctx; + struct spoe_appctx spoe_appctx; + char *frame, *end, buf[MAX_FRAME_SIZE+4]; + size_t sz; + int ret; + + memset(&appctx, 0, sizeof(appctx)); + memset(&spoe_appctx, 0, sizeof(spoe_appctx)); + memset(buf, 0, sizeof(buf)); + + appctx.svcctx = &spoe_appctx; + SPOE_APPCTX(&appctx)->max_frame_size = MAX_FRAME_SIZE; + + frame = buf+4; /* Reserved the 4 first bytes for the frame size */ + end = frame + MAX_FRAME_SIZE; + + ret = spoe_prepare_hahello_frame(&appctx, frame, MAX_FRAME_SIZE); + if (ret <= 0) + return -1; + frame += ret; + + /* Add "healthcheck" K/V item */ + sz = SLEN(HEALTHCHECK_KEY); + if (spoe_encode_buffer(HEALTHCHECK_KEY, sz, &frame, end) == -1) + return -1; + *frame++ = (SPOE_DATA_T_BOOL | SPOE_DATA_FL_TRUE); + + *len = frame - buf; + sz = htonl(*len - 4); + memcpy(buf, (char *)&sz, 4); + + if ((*req = malloc(*len)) == NULL) + return -1; + memcpy(*req, buf, *len); + return 0; +} + +/* This function is used in checks.c and declared in proto/checks.h. It decode + * the response received from an agent during a healthcheck. It returns 0 on + * success and -1 if an error occurred. */ +int +spoe_handle_healthcheck_response(char *frame, size_t size, char *err, int errlen) +{ + struct appctx appctx; + struct spoe_appctx spoe_appctx; + + memset(&appctx, 0, sizeof(appctx)); + memset(&spoe_appctx, 0, sizeof(spoe_appctx)); + + appctx.svcctx = &spoe_appctx; + SPOE_APPCTX(&appctx)->max_frame_size = MAX_FRAME_SIZE; + + if (*frame == SPOE_FRM_T_AGENT_DISCON) { + spoe_handle_agentdiscon_frame(&appctx, frame, size); + goto error; + } + if (spoe_handle_agenthello_frame(&appctx, frame, size) <= 0) + goto error; + + return 0; + + error: + if (SPOE_APPCTX(&appctx)->status_code >= SPOE_FRM_ERRS) + SPOE_APPCTX(&appctx)->status_code = SPOE_FRM_ERR_UNKNOWN; + strncpy(err, spoe_frm_err_reasons[SPOE_APPCTX(&appctx)->status_code], errlen); + return -1; +} + +/* Send a SPOE frame to an agent. It returns -1 when an error occurred, 0 when + * the frame can be ignored, 1 to retry later, and the frame length on + * success. */ +static int +spoe_send_frame(struct appctx *appctx, char *buf, size_t framesz) +{ + struct stconn *sc = appctx_sc(appctx); + int ret; + uint32_t netint; + + /* 4 bytes are reserved at the beginning of <buf> to store the frame + * length. */ + netint = htonl(framesz); + memcpy(buf, (char *)&netint, 4); + ret = applet_putblk(appctx, buf, framesz+4); + if (ret <= 0) { + if (ret == -3 && b_is_null(&sc_ic(sc)->buf)) { + /* WT: is this still needed for the case ret==-3 ? */ + sc_need_room(sc, 0); + return 1; /* retry */ + } + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_IO; + return -1; /* error */ + } + return framesz; +} + +/* Receive a SPOE frame from an agent. It return -1 when an error occurred, 0 + * when the frame can be ignored, 1 to retry later and the frame length on + * success. */ +static int +spoe_recv_frame(struct appctx *appctx, char *buf, size_t framesz) +{ + struct stconn *sc = appctx_sc(appctx); + int ret; + uint32_t netint; + + ret = co_getblk(sc_oc(sc), (char *)&netint, 4, 0); + if (ret > 0) { + framesz = ntohl(netint); + if (framesz > SPOE_APPCTX(appctx)->max_frame_size) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOO_BIG; + return -1; + } + ret = co_getblk(sc_oc(sc), buf, framesz, 4); + } + if (ret <= 0) { + if (ret == 0) { + return 1; /* retry */ + } + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_IO; + return -1; /* error */ + } + return framesz; +} + +/******************************************************************** + * Functions that manage the SPOE applet + ********************************************************************/ +static int +spoe_wakeup_appctx(struct appctx *appctx) +{ + applet_will_consume(appctx); + applet_have_more_data(appctx); + appctx_wakeup(appctx); + return 1; +} + +/* Callback function that catches applet timeouts. If a timeout occurred, we set + * <appctx->st1> flag and the SPOE applet is woken up. */ +static struct task * +spoe_process_appctx(struct task * task, void *context, unsigned int state) +{ + struct appctx *appctx = context; + + appctx->st1 = SPOE_APPCTX_ERR_NONE; + if (tick_is_expired(task->expire, now_ms)) { + task->expire = TICK_ETERNITY; + appctx->st1 = SPOE_APPCTX_ERR_TOUT; + } + spoe_wakeup_appctx(appctx); + return task; +} + +static int +spoe_init_appctx(struct appctx *appctx) +{ + struct spoe_appctx *spoe_appctx = SPOE_APPCTX(appctx); + struct spoe_agent *agent = spoe_appctx->agent; + struct task *task; + struct stream *s; + + if ((task = task_new_here()) == NULL) + goto out_error; + task->process = spoe_process_appctx; + task->context = appctx; + + if (appctx_finalize_startup(appctx, &agent->spoe_conf->agent_fe, &BUF_NULL) == -1) + goto out_free_task; + + spoe_appctx->owner = appctx; + spoe_appctx->task = task; + + LIST_INIT(&spoe_appctx->buffer_wait.list); + spoe_appctx->buffer_wait.target = appctx; + spoe_appctx->buffer_wait.wakeup_cb = (int (*)(void *))spoe_wakeup_appctx; + + s = appctx_strm(appctx); + stream_set_backend(s, agent->b.be); + + /* applet is waiting for data */ + applet_need_more_data(appctx); + + s->do_log = NULL; + s->scb->flags |= SC_FL_RCV_ONCE; + + HA_SPIN_LOCK(SPOE_APPLET_LOCK, &agent->rt[tid].lock); + LIST_APPEND(&agent->rt[tid].applets, &spoe_appctx->list); + HA_SPIN_UNLOCK(SPOE_APPLET_LOCK, &agent->rt[tid].lock); + _HA_ATOMIC_INC(&agent->counters.applets); + + appctx->st0 = SPOE_APPCTX_ST_CONNECT; + task_wakeup(spoe_appctx->task, TASK_WOKEN_INIT); + return 0; + out_free_task: + task_destroy(task); + out_error: + return -1; +} + +/* Callback function that releases a SPOE applet. This happens when the + * connection with the agent is closed. */ +static void +spoe_release_appctx(struct appctx *appctx) +{ + struct spoe_appctx *spoe_appctx = SPOE_APPCTX(appctx); + struct spoe_agent *agent; + struct spoe_context *ctx, *back; + + if (spoe_appctx == NULL) + return; + + appctx->svcctx = NULL; + agent = spoe_appctx->agent; + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, appctx); + + /* Remove applet from the list of running applets */ + _HA_ATOMIC_DEC(&agent->counters.applets); + HA_SPIN_LOCK(SPOE_APPLET_LOCK, &agent->rt[tid].lock); + if (!LIST_ISEMPTY(&spoe_appctx->list)) { + LIST_DELETE(&spoe_appctx->list); + LIST_INIT(&spoe_appctx->list); + } + HA_SPIN_UNLOCK(SPOE_APPLET_LOCK, &agent->rt[tid].lock); + + /* Shutdown the server connection, if needed */ + if (appctx->st0 != SPOE_APPCTX_ST_END) { + if (appctx->st0 == SPOE_APPCTX_ST_IDLE) { + eb32_delete(&spoe_appctx->node); + _HA_ATOMIC_DEC(&agent->counters.idles); + agent->rt[tid].idles--; + } + + appctx->st0 = SPOE_APPCTX_ST_END; + if (spoe_appctx->status_code == SPOE_FRM_ERR_NONE) + spoe_appctx->status_code = SPOE_FRM_ERR_IO; + } + + /* Destroy the task attached to this applet */ + task_destroy(spoe_appctx->task); + + /* Report an error to all streams in the appctx waiting queue */ + list_for_each_entry_safe(ctx, back, &spoe_appctx->waiting_queue, list) { + LIST_DELETE(&ctx->list); + LIST_INIT(&ctx->list); + _HA_ATOMIC_DEC(&agent->counters.nb_waiting); + spoe_update_stat_time(&ctx->stats.wait_ts, &ctx->stats.t_waiting); + ctx->spoe_appctx = NULL; + ctx->state = SPOE_CTX_ST_ERROR; + ctx->status_code = (spoe_appctx->status_code + 0x100); + task_wakeup(ctx->strm->task, TASK_WOKEN_MSG); + } + + /* If the applet was processing a fragmented frame, report an error to + * the corresponding stream. */ + if (spoe_appctx->frag_ctx.ctx) { + ctx = spoe_appctx->frag_ctx.ctx; + ctx->spoe_appctx = NULL; + ctx->state = SPOE_CTX_ST_ERROR; + ctx->status_code = (spoe_appctx->status_code + 0x100); + task_wakeup(ctx->strm->task, TASK_WOKEN_MSG); + } + + if (!LIST_ISEMPTY(&agent->rt[tid].applets)) { + /* If there are still some running applets, remove reference on + * the current one from streams in the async waiting queue. In + * async mode, the ACK may be received from another appctx. + */ + list_for_each_entry_safe(ctx, back, &agent->rt[tid].waiting_queue, list) { + if (ctx->spoe_appctx == spoe_appctx) + ctx->spoe_appctx = NULL; + } + goto end; + } + else { + /* It is the last running applet and the sending and async + * waiting queues are not empty. So try to start a new applet if + * HAproxy is not stopping. On success, we remove reference on + * the current appctx from streams in the async waiting queue. + * In async mode, the ACK may be received from another appctx. + */ + if (!stopping && + (!LIST_ISEMPTY(&agent->rt[tid].sending_queue) || !LIST_ISEMPTY(&agent->rt[tid].waiting_queue)) && + spoe_create_appctx(agent->spoe_conf)) { + list_for_each_entry_safe(ctx, back, &agent->rt[tid].waiting_queue, list) { + if (ctx->spoe_appctx == spoe_appctx) + ctx->spoe_appctx = NULL; + } + goto end; + } + + /* Otherwise, report an error to all streams in the sending and + * async waiting queues. + */ + list_for_each_entry_safe(ctx, back, &agent->rt[tid].sending_queue, list) { + LIST_DELETE(&ctx->list); + LIST_INIT(&ctx->list); + _HA_ATOMIC_DEC(&agent->counters.nb_sending); + spoe_update_stat_time(&ctx->stats.queue_ts, &ctx->stats.t_queue); + ctx->spoe_appctx = NULL; + ctx->state = SPOE_CTX_ST_ERROR; + ctx->status_code = (spoe_appctx->status_code + 0x100); + task_wakeup(ctx->strm->task, TASK_WOKEN_MSG); + } + list_for_each_entry_safe(ctx, back, &agent->rt[tid].waiting_queue, list) { + LIST_DELETE(&ctx->list); + LIST_INIT(&ctx->list); + _HA_ATOMIC_DEC(&agent->counters.nb_waiting); + spoe_update_stat_time(&ctx->stats.wait_ts, &ctx->stats.t_waiting); + ctx->spoe_appctx = NULL; + ctx->state = SPOE_CTX_ST_ERROR; + ctx->status_code = (spoe_appctx->status_code + 0x100); + task_wakeup(ctx->strm->task, TASK_WOKEN_MSG); + } + } + + end: + /* Release allocated memory */ + spoe_release_buffer(&spoe_appctx->buffer, + &spoe_appctx->buffer_wait); + pool_free(pool_head_spoe_appctx, spoe_appctx); + + /* Update runtinme agent info */ + agent->rt[tid].frame_size = agent->max_frame_size; + list_for_each_entry(spoe_appctx, &agent->rt[tid].applets, list) + HA_ATOMIC_UPDATE_MIN(&agent->rt[tid].frame_size, spoe_appctx->max_frame_size); +} + +static int +spoe_handle_connect_appctx(struct appctx *appctx) +{ + struct stconn *sc = appctx_sc(appctx); + struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent; + char *frame, *buf; + int ret; + + /* if the connection is not established, inform the stream that we want + * to be notified whenever the connection completes. + */ + if (sc_opposite(sc)->state < SC_ST_EST) { + applet_need_more_data(appctx); + se_need_remote_conn(appctx->sedesc); + applet_have_more_data(appctx); + goto stop; + } + + if (appctx->st1 == SPOE_APPCTX_ERR_TOUT) { + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p" + " - Connection timed out\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, appctx); + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOUT; + goto exit; + } + + if (SPOE_APPCTX(appctx)->task->expire == TICK_ETERNITY) + SPOE_APPCTX(appctx)->task->expire = + tick_add_ifset(now_ms, agent->timeout.hello); + + /* 4 bytes are reserved at the beginning of <buf> to store the frame + * length. */ + buf = trash.area; frame = buf+4; + ret = spoe_prepare_hahello_frame(appctx, frame, + SPOE_APPCTX(appctx)->max_frame_size); + if (ret > 1) + ret = spoe_send_frame(appctx, buf, ret); + + switch (ret) { + case -1: /* error */ + case 0: /* ignore => an error, cannot be ignored */ + goto exit; + + case 1: /* retry later */ + goto stop; + + default: + /* HELLO frame successfully sent, now wait for the + * reply. */ + appctx->st0 = SPOE_APPCTX_ST_CONNECTING; + goto next; + } + + next: + return 0; + stop: + return 1; + exit: + appctx->st0 = SPOE_APPCTX_ST_EXIT; + return 0; +} + +static int +spoe_handle_connecting_appctx(struct appctx *appctx) +{ + struct stconn *sc = appctx_sc(appctx); + struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent; + char *frame; + int ret; + + if (appctx->st1 == SPOE_APPCTX_ERR_TOUT) { + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p" + " - Connection timed out\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, appctx); + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOUT; + goto exit; + } + + frame = trash.area; trash.data = 0; + ret = spoe_recv_frame(appctx, frame, + SPOE_APPCTX(appctx)->max_frame_size); + if (ret > 1) { + if (*frame == SPOE_FRM_T_AGENT_DISCON) { + appctx->st0 = SPOE_APPCTX_ST_DISCONNECTING; + goto next; + } + trash.data = ret + 4; + ret = spoe_handle_agenthello_frame(appctx, frame, ret); + } + + switch (ret) { + case -1: /* error */ + case 0: /* ignore => an error, cannot be ignored */ + appctx->st0 = SPOE_APPCTX_ST_DISCONNECT; + goto next; + + case 1: /* retry later */ + goto stop; + + default: + _HA_ATOMIC_INC(&agent->counters.idles); + agent->rt[tid].idles++; + appctx->st0 = SPOE_APPCTX_ST_IDLE; + SPOE_APPCTX(appctx)->node.key = 0; + eb32_insert(&agent->rt[tid].idle_applets, &SPOE_APPCTX(appctx)->node); + + /* Update runtinme agent info */ + HA_ATOMIC_UPDATE_MIN(&agent->rt[tid].frame_size, SPOE_APPCTX(appctx)->max_frame_size); + goto next; + } + + next: + /* Do not forget to remove processed frame from the output buffer */ + if (trash.data) + co_skip(sc_oc(sc), trash.data); + + SPOE_APPCTX(appctx)->task->expire = + tick_add_ifset(now_ms, agent->timeout.idle); + return 0; + stop: + return 1; + exit: + appctx->st0 = SPOE_APPCTX_ST_EXIT; + return 0; +} + + +static int +spoe_handle_sending_frame_appctx(struct appctx *appctx, int *skip) +{ + struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent; + struct spoe_context *ctx = NULL; + char *frame, *buf; + int ret; + + /* 4 bytes are reserved at the beginning of <buf> to store the frame + * length. */ + buf = trash.area; frame = buf+4; + + if (appctx->st0 == SPOE_APPCTX_ST_SENDING_FRAG_NOTIFY) { + ctx = SPOE_APPCTX(appctx)->frag_ctx.ctx; + ret = spoe_prepare_hafrag_frame(appctx, ctx, frame, + SPOE_APPCTX(appctx)->max_frame_size); + } + else if (LIST_ISEMPTY(&agent->rt[tid].sending_queue)) { + *skip = 1; + ret = 1; + goto end; + } + else { + ctx = LIST_NEXT(&agent->rt[tid].sending_queue, typeof(ctx), list); + ret = spoe_prepare_hanotify_frame(appctx, ctx, frame, + SPOE_APPCTX(appctx)->max_frame_size); + + } + + if (ret > 1) + ret = spoe_send_frame(appctx, buf, ret); + + switch (ret) { + case -1: /* error */ + appctx->st0 = SPOE_APPCTX_ST_DISCONNECT; + goto end; + + case 0: /* ignore */ + if (ctx == NULL) + goto abort_frag_frame; + + spoe_release_buffer(&ctx->buffer, &ctx->buffer_wait); + LIST_DELETE(&ctx->list); + LIST_INIT(&ctx->list); + _HA_ATOMIC_DEC(&agent->counters.nb_sending); + spoe_update_stat_time(&ctx->stats.queue_ts, &ctx->stats.t_queue); + ctx->spoe_appctx = NULL; + ctx->state = SPOE_CTX_ST_ERROR; + ctx->status_code = (SPOE_APPCTX(appctx)->status_code + 0x100); + task_wakeup(ctx->strm->task, TASK_WOKEN_MSG); + *skip = 1; + break; + + case 1: /* retry */ + *skip = 1; + break; + + default: + if (ctx == NULL) + goto abort_frag_frame; + + spoe_release_buffer(&ctx->buffer, &ctx->buffer_wait); + LIST_DELETE(&ctx->list); + LIST_INIT(&ctx->list); + _HA_ATOMIC_DEC(&agent->counters.nb_sending); + spoe_update_stat_time(&ctx->stats.queue_ts, &ctx->stats.t_queue); + ctx->spoe_appctx = SPOE_APPCTX(appctx); + if (!(ctx->flags & SPOE_CTX_FL_FRAGMENTED) || + (ctx->frag_ctx.flags & SPOE_FRM_FL_FIN)) + goto no_frag_frame_sent; + else + goto frag_frame_sent; + } + goto end; + + frag_frame_sent: + appctx->st0 = SPOE_APPCTX_ST_SENDING_FRAG_NOTIFY; + *skip = 1; + SPOE_APPCTX(appctx)->frag_ctx.ctx = ctx; + SPOE_APPCTX(appctx)->frag_ctx.cursid = ctx->stream_id; + SPOE_APPCTX(appctx)->frag_ctx.curfid = ctx->frame_id; + ctx->state = SPOE_CTX_ST_ENCODING_MSGS; + task_wakeup(ctx->strm->task, TASK_WOKEN_MSG); + goto end; + + no_frag_frame_sent: + if (SPOE_APPCTX(appctx)->flags & SPOE_APPCTX_FL_ASYNC) { + appctx->st0 = SPOE_APPCTX_ST_PROCESSING; + LIST_APPEND(&agent->rt[tid].waiting_queue, &ctx->list); + } + else if (SPOE_APPCTX(appctx)->flags & SPOE_APPCTX_FL_PIPELINING) { + appctx->st0 = SPOE_APPCTX_ST_PROCESSING; + LIST_APPEND(&SPOE_APPCTX(appctx)->waiting_queue, &ctx->list); + } + else { + appctx->st0 = SPOE_APPCTX_ST_WAITING_SYNC_ACK; + *skip = 1; + LIST_APPEND(&SPOE_APPCTX(appctx)->waiting_queue, &ctx->list); + } + _HA_ATOMIC_INC(&agent->counters.nb_waiting); + ctx->stats.wait_ts = now_ns; + SPOE_APPCTX(appctx)->frag_ctx.ctx = NULL; + SPOE_APPCTX(appctx)->frag_ctx.cursid = 0; + SPOE_APPCTX(appctx)->frag_ctx.curfid = 0; + SPOE_APPCTX(appctx)->cur_fpa++; + + ctx->state = SPOE_CTX_ST_WAITING_ACK; + goto end; + + abort_frag_frame: + appctx->st0 = SPOE_APPCTX_ST_PROCESSING; + SPOE_APPCTX(appctx)->frag_ctx.ctx = NULL; + SPOE_APPCTX(appctx)->frag_ctx.cursid = 0; + SPOE_APPCTX(appctx)->frag_ctx.curfid = 0; + goto end; + + end: + return ret; +} + +static int +spoe_handle_receiving_frame_appctx(struct appctx *appctx, int *skip) +{ + struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent; + struct spoe_context *ctx = NULL; + char *frame; + int ret; + + frame = trash.area; trash.data = 0; + ret = spoe_recv_frame(appctx, frame, + SPOE_APPCTX(appctx)->max_frame_size); + if (ret > 1) { + if (*frame == SPOE_FRM_T_AGENT_DISCON) { + appctx->st0 = SPOE_APPCTX_ST_DISCONNECTING; + ret = -1; + goto end; + } + trash.data = ret + 4; + ret = spoe_handle_agentack_frame(appctx, &ctx, frame, ret); + } + switch (ret) { + case -1: /* error */ + appctx->st0 = SPOE_APPCTX_ST_DISCONNECT; + break; + + case 0: /* ignore */ + break; + + case 1: /* retry */ + *skip = 1; + break; + + default: + LIST_DELETE(&ctx->list); + LIST_INIT(&ctx->list); + _HA_ATOMIC_DEC(&agent->counters.nb_waiting); + spoe_update_stat_time(&ctx->stats.wait_ts, &ctx->stats.t_waiting); + ctx->stats.response_ts = now_ns; + if (ctx->spoe_appctx) { + ctx->spoe_appctx->cur_fpa--; + ctx->spoe_appctx = NULL; + } + if (appctx->st0 == SPOE_APPCTX_ST_SENDING_FRAG_NOTIFY && + ctx == SPOE_APPCTX(appctx)->frag_ctx.ctx) { + appctx->st0 = SPOE_APPCTX_ST_PROCESSING; + SPOE_APPCTX(appctx)->frag_ctx.ctx = NULL; + SPOE_APPCTX(appctx)->frag_ctx.cursid = 0; + SPOE_APPCTX(appctx)->frag_ctx.curfid = 0; + } + else if (appctx->st0 == SPOE_APPCTX_ST_WAITING_SYNC_ACK) + appctx->st0 = SPOE_APPCTX_ST_PROCESSING; + task_wakeup(ctx->strm->task, TASK_WOKEN_MSG); + break; + } + + /* Do not forget to remove processed frame from the output buffer */ + if (trash.data) + co_skip(sc_oc(appctx_sc(appctx)), trash.data); + end: + return ret; +} + +static int +spoe_handle_processing_appctx(struct appctx *appctx) +{ + struct stconn *sc = appctx_sc(appctx); + struct server *srv = objt_server(__sc_strm(sc)->target); + struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent; + int ret, skip_sending = 0, skip_receiving = 0, active_s = 0, active_r = 0, close_asap = 0; + + if (appctx->st1 == SPOE_APPCTX_ERR_TOUT) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOUT; + appctx->st0 = SPOE_APPCTX_ST_DISCONNECT; + appctx->st1 = SPOE_APPCTX_ERR_NONE; + goto next; + } + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p" + " - process: fpa=%u/%u - appctx-state=%s - weight=%u - flags=0x%08x\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, appctx, SPOE_APPCTX(appctx)->cur_fpa, + agent->max_fpa, spoe_appctx_state_str[appctx->st0], + SPOE_APPCTX(appctx)->node.key, SPOE_APPCTX(appctx)->flags); + + + /* Close the applet ASAP because some sessions are waiting for a free + * connection slot. It is only an issue in multithreaded mode. + */ + close_asap = (global.nbthread > 1 && + (agent->b.be->queue.length || + (srv && (srv->queue.length || (srv->maxconn && srv->served >= srv_dynamic_maxconn(srv)))))); + + /* receiving_frame loop */ + while (!skip_receiving) { + ret = spoe_handle_receiving_frame_appctx(appctx, &skip_receiving); + switch (ret) { + case -1: /* error */ + goto next; + + case 0: /* ignore */ + active_r = 1; + break; + + case 1: /* retry */ + break; + + default: + active_r = 1; + break; + } + } + + /* Don"t try to send new frame we are waiting for at lease a ack, in + * sync mode or if applet must be closed ASAP + */ + if (appctx->st0 == SPOE_APPCTX_ST_WAITING_SYNC_ACK || (close_asap && SPOE_APPCTX(appctx)->cur_fpa)) + skip_sending = 1; + + /* send_frame loop */ + while (!skip_sending && SPOE_APPCTX(appctx)->cur_fpa < agent->max_fpa) { + ret = spoe_handle_sending_frame_appctx(appctx, &skip_sending); + switch (ret) { + case -1: /* error */ + goto next; + + case 0: /* ignore */ + if (SPOE_APPCTX(appctx)->node.key) + SPOE_APPCTX(appctx)->node.key--; + active_s++; + break; + + case 1: /* retry */ + break; + + default: + if (SPOE_APPCTX(appctx)->node.key) + SPOE_APPCTX(appctx)->node.key--; + active_s++; + break; + } + + /* if applet must be close ASAP, don't send more than a frame */ + if (close_asap) + break; + } + + if (active_s || active_r) { + update_freq_ctr(&agent->rt[tid].processing_per_sec, active_s); + SPOE_APPCTX(appctx)->task->expire = tick_add_ifset(now_ms, agent->timeout.idle); + } + + if (appctx->st0 == SPOE_APPCTX_ST_PROCESSING && SPOE_APPCTX(appctx)->cur_fpa < agent->max_fpa) { + /* If applet must be closed, don't switch it in IDLE state and + * close it when the last waiting frame is acknowledged. + */ + if (close_asap) { + if (SPOE_APPCTX(appctx)->cur_fpa) + goto out; + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_NONE; + appctx->st0 = SPOE_APPCTX_ST_DISCONNECT; + appctx->st1 = SPOE_APPCTX_ERR_NONE; + goto next; + } + _HA_ATOMIC_INC(&agent->counters.idles); + agent->rt[tid].idles++; + appctx->st0 = SPOE_APPCTX_ST_IDLE; + eb32_insert(&agent->rt[tid].idle_applets, &SPOE_APPCTX(appctx)->node); + } + + out: + return 1; + + next: + SPOE_APPCTX(appctx)->task->expire = tick_add_ifset(now_ms, agent->timeout.idle); + return 0; +} + +static int +spoe_handle_disconnect_appctx(struct appctx *appctx) +{ + struct spoe_agent *agent = SPOE_APPCTX(appctx)->agent; + char *frame, *buf; + int ret; + + if (appctx->st1 == SPOE_APPCTX_ERR_TOUT) + goto exit; + + /* 4 bytes are reserved at the beginning of <buf> to store the frame + * length. */ + buf = trash.area; frame = buf+4; + ret = spoe_prepare_hadiscon_frame(appctx, frame, + SPOE_APPCTX(appctx)->max_frame_size); + if (ret > 1) + ret = spoe_send_frame(appctx, buf, ret); + + switch (ret) { + case -1: /* error */ + case 0: /* ignore => an error, cannot be ignored */ + goto exit; + + case 1: /* retry */ + goto stop; + + default: + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p" + " - disconnected by HAProxy (%d): %s\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, appctx, + SPOE_APPCTX(appctx)->status_code, + spoe_frm_err_reasons[SPOE_APPCTX(appctx)->status_code]); + + appctx->st0 = SPOE_APPCTX_ST_DISCONNECTING; + goto next; + } + + next: + SPOE_APPCTX(appctx)->task->expire = + tick_add_ifset(now_ms, agent->timeout.idle); + return 0; + stop: + return 1; + exit: + appctx->st0 = SPOE_APPCTX_ST_EXIT; + return 0; +} + +static int +spoe_handle_disconnecting_appctx(struct appctx *appctx) +{ + struct stconn *sc = appctx_sc(appctx); + char *frame; + int ret; + + if (appctx->st1 == SPOE_APPCTX_ERR_TOUT) { + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_TOUT; + goto exit; + } + + frame = trash.area; trash.data = 0; + ret = spoe_recv_frame(appctx, frame, + SPOE_APPCTX(appctx)->max_frame_size); + if (ret > 1) { + trash.data = ret + 4; + ret = spoe_handle_agentdiscon_frame(appctx, frame, ret); + } + + switch (ret) { + case -1: /* error */ + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p" + " - error on frame (%s)\n", + (int)date.tv_sec, (int)date.tv_usec, + ((struct spoe_agent *)SPOE_APPCTX(appctx)->agent)->id, + __FUNCTION__, appctx, + spoe_frm_err_reasons[SPOE_APPCTX(appctx)->status_code]); + goto exit; + + case 0: /* ignore */ + goto next; + + case 1: /* retry */ + goto stop; + + default: + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p" + " - disconnected by peer (%d): %.*s\n", + (int)date.tv_sec, (int)date.tv_usec, + ((struct spoe_agent *)SPOE_APPCTX(appctx)->agent)->id, + __FUNCTION__, appctx, SPOE_APPCTX(appctx)->status_code, + SPOE_APPCTX(appctx)->rlen, SPOE_APPCTX(appctx)->reason); + goto exit; + } + + next: + /* Do not forget to remove processed frame from the output buffer */ + if (trash.data) + co_skip(sc_oc(sc), trash.data); + + return 0; + stop: + return 1; + exit: + appctx->st0 = SPOE_APPCTX_ST_EXIT; + return 0; +} + +/* I/O Handler processing messages exchanged with the agent */ +static void +spoe_handle_appctx(struct appctx *appctx) +{ + struct stconn *sc = appctx_sc(appctx); + struct spoe_agent *agent; + + if (SPOE_APPCTX(appctx) == NULL) + return; + + if (unlikely(se_fl_test(appctx->sedesc, (SE_FL_EOS|SE_FL_ERROR|SE_FL_SHR|SE_FL_SHW)))) { + co_skip(sc_oc(sc), co_data(sc_oc(sc))); + goto out; + } + + SPOE_APPCTX(appctx)->status_code = SPOE_FRM_ERR_NONE; + agent = SPOE_APPCTX(appctx)->agent; + + switchstate: + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: appctx=%p" + " - appctx-state=%s\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, appctx, spoe_appctx_state_str[appctx->st0]); + + switch (appctx->st0) { + case SPOE_APPCTX_ST_CONNECT: + if (spoe_handle_connect_appctx(appctx)) + goto out; + goto switchstate; + + case SPOE_APPCTX_ST_CONNECTING: + if (spoe_handle_connecting_appctx(appctx)) + goto out; + goto switchstate; + + case SPOE_APPCTX_ST_IDLE: + _HA_ATOMIC_DEC(&agent->counters.idles); + agent->rt[tid].idles--; + eb32_delete(&SPOE_APPCTX(appctx)->node); + if (stopping && + LIST_ISEMPTY(&agent->rt[tid].sending_queue) && + LIST_ISEMPTY(&SPOE_APPCTX(appctx)->waiting_queue)) { + SPOE_APPCTX(appctx)->task->expire = + tick_add_ifset(now_ms, agent->timeout.idle); + appctx->st0 = SPOE_APPCTX_ST_DISCONNECT; + goto switchstate; + } + appctx->st0 = SPOE_APPCTX_ST_PROCESSING; + __fallthrough; + + case SPOE_APPCTX_ST_PROCESSING: + case SPOE_APPCTX_ST_SENDING_FRAG_NOTIFY: + case SPOE_APPCTX_ST_WAITING_SYNC_ACK: + if (spoe_handle_processing_appctx(appctx)) + goto out; + goto switchstate; + + case SPOE_APPCTX_ST_DISCONNECT: + if (spoe_handle_disconnect_appctx(appctx)) + goto out; + goto switchstate; + + case SPOE_APPCTX_ST_DISCONNECTING: + if (spoe_handle_disconnecting_appctx(appctx)) + goto out; + goto switchstate; + + case SPOE_APPCTX_ST_EXIT: + appctx->st0 = SPOE_APPCTX_ST_END; + SPOE_APPCTX(appctx)->task->expire = TICK_ETERNITY; + se_fl_set(appctx->sedesc, SE_FL_EOS); + if (SPOE_APPCTX(appctx)->status_code != SPOE_FRM_ERR_NONE) + se_fl_set(appctx->sedesc, SE_FL_ERROR); + else + se_fl_set(appctx->sedesc, SE_FL_EOI); + __fallthrough; + + case SPOE_APPCTX_ST_END: + return; + } + out: + if (SPOE_APPCTX(appctx)->task->expire != TICK_ETERNITY) + task_queue(SPOE_APPCTX(appctx)->task); +} + +struct applet spoe_applet = { + .obj_type = OBJ_TYPE_APPLET, + .name = "<SPOE>", /* used for logging */ + .fct = spoe_handle_appctx, + .init = spoe_init_appctx, + .release = spoe_release_appctx, +}; + +/* Create a SPOE applet. On success, the created applet is returned, else + * NULL. */ +static struct appctx * +spoe_create_appctx(struct spoe_config *conf) +{ + struct spoe_agent *agent = conf->agent; + struct spoe_appctx *spoe_appctx; + struct appctx *appctx; + + /* Do not try to create a new applet if there is no server up for the + * agent's backend. */ + if (!agent->b.be->srv_act && !agent->b.be->srv_bck) { + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: don't create SPOE appctx: no server up\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, __FUNCTION__); + goto out; + } + + /* Do not try to create a new applet if we have reached the maximum of + * connection per seconds */ + if (agent->cps_max > 0) { + if (!freq_ctr_remain(&agent->rt[tid].conn_per_sec, agent->cps_max, 0)) { + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: don't create SPOE appctx: max CPS reached\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, __FUNCTION__); + goto out; + } + } + + spoe_appctx = pool_zalloc(pool_head_spoe_appctx); + if (spoe_appctx == NULL) + goto out_error; + + spoe_appctx->agent = agent; + spoe_appctx->version = 0; + spoe_appctx->max_frame_size = agent->max_frame_size; + spoe_appctx->flags = 0; + spoe_appctx->status_code = SPOE_FRM_ERR_NONE; + spoe_appctx->buffer = BUF_NULL; + spoe_appctx->cur_fpa = 0; + LIST_INIT(&spoe_appctx->list); + LIST_INIT(&spoe_appctx->waiting_queue); + + + if ((appctx = appctx_new_here(&spoe_applet, NULL)) == NULL) + goto out_free_spoe_appctx; + + appctx->svcctx = spoe_appctx; + if (appctx_init(appctx) == -1) + goto out_free_appctx; + + /* Increase the per-process number of cumulated connections */ + if (agent->cps_max > 0) + update_freq_ctr(&agent->rt[tid].conn_per_sec, 1); + + appctx_wakeup(appctx); + return appctx; + + /* Error unrolling */ + out_free_appctx: + appctx_free_on_early_error(appctx); + out_free_spoe_appctx: + pool_free(pool_head_spoe_appctx, spoe_appctx); + out_error: + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: failed to create SPOE appctx\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, __FUNCTION__); + send_log(&conf->agent_fe, LOG_EMERG, "SPOE: [%s] failed to create SPOE applet\n", agent->id); + out: + + return NULL; +} + +static int +spoe_queue_context(struct spoe_context *ctx) +{ + struct spoe_config *conf = FLT_CONF(ctx->filter); + struct spoe_agent *agent = conf->agent; + struct spoe_appctx *spoe_appctx; + + /* Check if we need to create a new SPOE applet or not. */ + if (agent->rt[tid].processing < agent->rt[tid].idles || + agent->rt[tid].processing < read_freq_ctr(&agent->rt[tid].processing_per_sec)) + goto end; + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - try to create new SPOE appctx\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, __FUNCTION__, + ctx->strm); + + spoe_create_appctx(conf); + + end: + /* The only reason to return an error is when there is no applet */ + if (LIST_ISEMPTY(&agent->rt[tid].applets)) { + ctx->status_code = SPOE_CTX_ERR_RES; + return -1; + } + + /* Add the SPOE context in the sending queue if the stream has no applet + * already assigned and wakeup all idle applets. Otherwise, don't queue + * it. */ + _HA_ATOMIC_INC(&agent->counters.nb_sending); + spoe_update_stat_time(&ctx->stats.request_ts, &ctx->stats.t_request); + ctx->stats.queue_ts = now_ns; + if (ctx->spoe_appctx) + return 1; + LIST_APPEND(&agent->rt[tid].sending_queue, &ctx->list); + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - Add stream in sending queue" + " - applets=%u - idles=%u - processing=%u\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, __FUNCTION__, + ctx->strm, agent->counters.applets, agent->counters.idles, + agent->rt[tid].processing); + + /* Finally try to wakeup an IDLE applet. */ + if (!eb_is_empty(&agent->rt[tid].idle_applets)) { + struct eb32_node *node; + + node = eb32_first(&agent->rt[tid].idle_applets); + spoe_appctx = eb32_entry(node, struct spoe_appctx, node); + if (node && spoe_appctx) { + eb32_delete(&spoe_appctx->node); + spoe_appctx->node.key++; + eb32_insert(&agent->rt[tid].idle_applets, &spoe_appctx->node); + spoe_wakeup_appctx(spoe_appctx->owner); + } + } + return 1; +} + +/*************************************************************************** + * Functions that encode SPOE messages + **************************************************************************/ +/* Encode a SPOE message. Info in <ctx->frag_ctx>, if any, are used to handle + * fragmented_content. If the next message can be processed, it returns 0. If + * the message is too big, it returns -1.*/ +static int +spoe_encode_message(struct stream *s, struct spoe_context *ctx, + struct spoe_message *msg, int dir, + char **buf, char *end) +{ + struct sample *smp; + struct spoe_arg *arg; + int ret; + + if (msg->cond) { + ret = acl_exec_cond(msg->cond, s->be, s->sess, s, dir|SMP_OPT_FINAL); + ret = acl_pass(ret); + if (msg->cond->pol == ACL_COND_UNLESS) + ret = !ret; + + /* the rule does not match */ + if (!ret) + goto next; + } + + /* Resume encoding of a SPOE argument */ + if (ctx->frag_ctx.curarg != NULL) { + arg = ctx->frag_ctx.curarg; + goto encode_argument; + } + + if (ctx->frag_ctx.curoff != UINT_MAX) + goto encode_msg_payload; + + /* Check if there is enough space for the message name and the + * number of arguments. It implies <msg->id_len> is encoded on 2 + * bytes, at most (< 2288). */ + if (*buf + 2 + msg->id_len + 1 > end) + goto too_big; + + /* Encode the message name */ + if (spoe_encode_buffer(msg->id, msg->id_len, buf, end) == -1) + goto too_big; + + /* Set the number of arguments for this message */ + **buf = msg->nargs; + (*buf)++; + + ctx->frag_ctx.curoff = 0; + encode_msg_payload: + + /* Loop on arguments */ + list_for_each_entry(arg, &msg->args, list) { + ctx->frag_ctx.curarg = arg; + ctx->frag_ctx.curoff = UINT_MAX; + ctx->frag_ctx.curlen = 0; + + encode_argument: + if (ctx->frag_ctx.curoff != UINT_MAX) + goto encode_arg_value; + + /* Encode the argument name as a string. It can by NULL */ + if (spoe_encode_buffer(arg->name, arg->name_len, buf, end) == -1) + goto too_big; + + ctx->frag_ctx.curoff = 0; + encode_arg_value: + + /* Fetch the argument value */ + smp = sample_process(s->be, s->sess, s, dir|SMP_OPT_FINAL, arg->expr, NULL); + if (smp) { + smp->ctx.a[0] = &ctx->frag_ctx.curlen; + smp->ctx.a[1] = &ctx->frag_ctx.curoff; + } + ret = spoe_encode_data(smp, buf, end); + if (ret == -1 || ctx->frag_ctx.curoff) + goto too_big; + } + + next: + return 0; + + too_big: + return -1; +} + +/* Encode list of SPOE messages. Info in <ctx->frag_ctx>, if any, are used to + * handle fragmented content. On success it returns 1. If an error occurred, -1 + * is returned. If nothing has been encoded, it returns 0 (this is only possible + * for unfragmented payload). */ +static int +spoe_encode_messages(struct stream *s, struct spoe_context *ctx, + struct list *messages, int dir, int type) +{ + struct spoe_config *conf = FLT_CONF(ctx->filter); + struct spoe_agent *agent = conf->agent; + struct spoe_message *msg; + char *p, *end; + + p = b_head(&ctx->buffer); + end = p + agent->rt[tid].frame_size - FRAME_HDR_SIZE; + + if (type == SPOE_MSGS_BY_EVENT) { /* Loop on messages by event */ + /* Resume encoding of a SPOE message */ + if (ctx->frag_ctx.curmsg != NULL) { + msg = ctx->frag_ctx.curmsg; + goto encode_evt_message; + } + + list_for_each_entry(msg, messages, by_evt) { + ctx->frag_ctx.curmsg = msg; + ctx->frag_ctx.curarg = NULL; + ctx->frag_ctx.curoff = UINT_MAX; + + encode_evt_message: + if (spoe_encode_message(s, ctx, msg, dir, &p, end) == -1) + goto too_big; + } + } + else if (type == SPOE_MSGS_BY_GROUP) { /* Loop on messages by group */ + /* Resume encoding of a SPOE message */ + if (ctx->frag_ctx.curmsg != NULL) { + msg = ctx->frag_ctx.curmsg; + goto encode_grp_message; + } + + list_for_each_entry(msg, messages, by_grp) { + ctx->frag_ctx.curmsg = msg; + ctx->frag_ctx.curarg = NULL; + ctx->frag_ctx.curoff = UINT_MAX; + + encode_grp_message: + if (spoe_encode_message(s, ctx, msg, dir, &p, end) == -1) + goto too_big; + } + } + else + goto skip; + + + /* nothing has been encoded for an unfragmented payload */ + if (!(ctx->flags & SPOE_CTX_FL_FRAGMENTED) && p == b_head(&ctx->buffer)) + goto skip; + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - encode %s messages - spoe_appctx=%p" + "- max_size=%u - encoded=%ld\n", + (int)date.tv_sec, (int)date.tv_usec, + agent->id, __FUNCTION__, s, + ((ctx->flags & SPOE_CTX_FL_FRAGMENTED) ? "last fragment of" : "unfragmented"), + ctx->spoe_appctx, (agent->rt[tid].frame_size - FRAME_HDR_SIZE), + p - b_head(&ctx->buffer)); + + b_set_data(&ctx->buffer, p - b_head(&ctx->buffer)); + ctx->frag_ctx.curmsg = NULL; + ctx->frag_ctx.curarg = NULL; + ctx->frag_ctx.curoff = 0; + ctx->frag_ctx.flags = SPOE_FRM_FL_FIN; + + return 1; + + too_big: + /* Return an error if fragmentation is unsupported or if nothing has + * been encoded because its too big and not splittable. */ + if (!(agent->flags & SPOE_FL_SND_FRAGMENTATION) || p == b_head(&ctx->buffer)) { + ctx->status_code = SPOE_CTX_ERR_TOO_BIG; + return -1; + } + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - encode fragmented messages - spoe_appctx=%p" + " - curmsg=%p - curarg=%p - curoff=%u" + " - max_size=%u - encoded=%ld\n", + (int)date.tv_sec, (int)date.tv_usec, + agent->id, __FUNCTION__, s, ctx->spoe_appctx, + ctx->frag_ctx.curmsg, ctx->frag_ctx.curarg, ctx->frag_ctx.curoff, + (agent->rt[tid].frame_size - FRAME_HDR_SIZE), p - b_head(&ctx->buffer)); + + b_set_data(&ctx->buffer, p - b_head(&ctx->buffer)); + ctx->flags |= SPOE_CTX_FL_FRAGMENTED; + ctx->frag_ctx.flags &= ~SPOE_FRM_FL_FIN; + return 1; + + skip: + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - skip the frame because nothing has been encoded\n", + (int)date.tv_sec, (int)date.tv_usec, + agent->id, __FUNCTION__, s); + return 0; +} + + +/*************************************************************************** + * Functions that handle SPOE actions + **************************************************************************/ +/* Helper function to set a variable */ +static void +spoe_set_var(struct spoe_context *ctx, char *scope, char *name, int len, + struct sample *smp) +{ + struct spoe_config *conf = FLT_CONF(ctx->filter); + struct spoe_agent *agent = conf->agent; + char varname[64]; + + memset(varname, 0, sizeof(varname)); + len = snprintf(varname, sizeof(varname), "%s.%s.%.*s", + scope, agent->var_pfx, len, name); + if (agent->flags & SPOE_FL_FORCE_SET_VAR) + vars_set_by_name(varname, len, smp); + else + vars_set_by_name_ifexist(varname, len, smp); +} + +/* Helper function to unset a variable */ +static void +spoe_unset_var(struct spoe_context *ctx, char *scope, char *name, int len, + struct sample *smp) +{ + struct spoe_config *conf = FLT_CONF(ctx->filter); + struct spoe_agent *agent = conf->agent; + char varname[64]; + + memset(varname, 0, sizeof(varname)); + len = snprintf(varname, sizeof(varname), "%s.%s.%.*s", + scope, agent->var_pfx, len, name); + vars_unset_by_name_ifexist(varname, len, smp); +} + + +static inline int +spoe_decode_action_set_var(struct stream *s, struct spoe_context *ctx, + char **buf, char *end, int dir) +{ + char *str, *scope, *p = *buf; + struct sample smp; + uint64_t sz; + int ret; + + if (p + 2 >= end) + goto skip; + + /* SET-VAR requires 3 arguments */ + if (*p++ != 3) + goto skip; + + switch (*p++) { + case SPOE_SCOPE_PROC: scope = "proc"; break; + case SPOE_SCOPE_SESS: scope = "sess"; break; + case SPOE_SCOPE_TXN : scope = "txn"; break; + case SPOE_SCOPE_REQ : scope = "req"; break; + case SPOE_SCOPE_RES : scope = "res"; break; + default: goto skip; + } + + if (spoe_decode_buffer(&p, end, &str, &sz) == -1) + goto skip; + memset(&smp, 0, sizeof(smp)); + smp_set_owner(&smp, s->be, s->sess, s, dir|SMP_OPT_FINAL); + + if (spoe_decode_data(&p, end, &smp) == -1) + goto skip; + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - set-var '%s.%s.%.*s'\n", + (int)date.tv_sec, (int)date.tv_usec, + ((struct spoe_config *)FLT_CONF(ctx->filter))->agent->id, + __FUNCTION__, s, scope, + ((struct spoe_config *)FLT_CONF(ctx->filter))->agent->var_pfx, + (int)sz, str); + + if (smp.data.type == SMP_T_ANY) + spoe_unset_var(ctx, scope, str, sz, &smp); + else + spoe_set_var(ctx, scope, str, sz, &smp); + + ret = (p - *buf); + *buf = p; + return ret; + skip: + return 0; +} + +static inline int +spoe_decode_action_unset_var(struct stream *s, struct spoe_context *ctx, + char **buf, char *end, int dir) +{ + char *str, *scope, *p = *buf; + struct sample smp; + uint64_t sz; + int ret; + + if (p + 2 >= end) + goto skip; + + /* UNSET-VAR requires 2 arguments */ + if (*p++ != 2) + goto skip; + + switch (*p++) { + case SPOE_SCOPE_PROC: scope = "proc"; break; + case SPOE_SCOPE_SESS: scope = "sess"; break; + case SPOE_SCOPE_TXN : scope = "txn"; break; + case SPOE_SCOPE_REQ : scope = "req"; break; + case SPOE_SCOPE_RES : scope = "res"; break; + default: goto skip; + } + + if (spoe_decode_buffer(&p, end, &str, &sz) == -1) + goto skip; + memset(&smp, 0, sizeof(smp)); + smp_set_owner(&smp, s->be, s->sess, s, dir|SMP_OPT_FINAL); + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - unset-var '%s.%s.%.*s'\n", + (int)date.tv_sec, (int)date.tv_usec, + ((struct spoe_config *)FLT_CONF(ctx->filter))->agent->id, + __FUNCTION__, s, scope, + ((struct spoe_config *)FLT_CONF(ctx->filter))->agent->var_pfx, + (int)sz, str); + + spoe_unset_var(ctx, scope, str, sz, &smp); + + ret = (p - *buf); + *buf = p; + return ret; + skip: + return 0; +} + +/* Process SPOE actions for a specific event. It returns 1 on success. If an + * error occurred, 0 is returned. */ +static int +spoe_process_actions(struct stream *s, struct spoe_context *ctx, int dir) +{ + char *p, *end; + int ret; + + p = b_head(&ctx->buffer); + end = p + b_data(&ctx->buffer); + + while (p < end) { + enum spoe_action_type type; + + type = *p++; + switch (type) { + case SPOE_ACT_T_SET_VAR: + ret = spoe_decode_action_set_var(s, ctx, &p, end, dir); + if (!ret) + goto skip; + break; + + case SPOE_ACT_T_UNSET_VAR: + ret = spoe_decode_action_unset_var(s, ctx, &p, end, dir); + if (!ret) + goto skip; + break; + + default: + goto skip; + } + } + + return 1; + skip: + return 0; +} + +/*************************************************************************** + * Functions that process SPOE events + **************************************************************************/ +static void +spoe_update_stats(struct stream *s, struct spoe_agent *agent, + struct spoe_context *ctx, int dir) +{ + if (ctx->stats.start_ts != 0) { + spoe_update_stat_time(&ctx->stats.start_ts, &ctx->stats.t_process); + ctx->stats.t_total += ctx->stats.t_process; + ctx->stats.request_ts = 0; + ctx->stats.queue_ts = 0; + ctx->stats.wait_ts = 0; + ctx->stats.response_ts = 0; + } + + if (agent->var_t_process) { + struct sample smp; + + memset(&smp, 0, sizeof(smp)); + smp_set_owner(&smp, s->be, s->sess, s, dir|SMP_OPT_FINAL); + smp.data.u.sint = ctx->stats.t_process; + smp.data.type = SMP_T_SINT; + + spoe_set_var(ctx, "txn", agent->var_t_process, + strlen(agent->var_t_process), &smp); + } + + if (agent->var_t_total) { + struct sample smp; + + memset(&smp, 0, sizeof(smp)); + smp_set_owner(&smp, s->be, s->sess, s, dir|SMP_OPT_FINAL); + smp.data.u.sint = ctx->stats.t_total; + smp.data.type = SMP_T_SINT; + + spoe_set_var(ctx, "txn", agent->var_t_total, + strlen(agent->var_t_total), &smp); + } +} + +static void +spoe_handle_processing_error(struct stream *s, struct spoe_agent *agent, + struct spoe_context *ctx, int dir) +{ + if (agent->eps_max > 0) + update_freq_ctr(&agent->rt[tid].err_per_sec, 1); + + if (agent->var_on_error) { + struct sample smp; + + memset(&smp, 0, sizeof(smp)); + smp_set_owner(&smp, s->be, s->sess, s, dir|SMP_OPT_FINAL); + smp.data.u.sint = ctx->status_code; + smp.data.type = SMP_T_BOOL; + + spoe_set_var(ctx, "txn", agent->var_on_error, + strlen(agent->var_on_error), &smp); + } + + ctx->state = ((agent->flags & SPOE_FL_CONT_ON_ERR) + ? SPOE_CTX_ST_READY + : SPOE_CTX_ST_NONE); +} + +static inline int +spoe_start_processing(struct spoe_agent *agent, struct spoe_context *ctx, int dir) +{ + /* If a process is already started for this SPOE context, retry + * later. */ + if (ctx->flags & SPOE_CTX_FL_PROCESS) + return 0; + + agent->rt[tid].processing++; + ctx->stats.start_ts = now_ns; + ctx->stats.request_ts = now_ns; + ctx->stats.t_request = -1; + ctx->stats.t_queue = -1; + ctx->stats.t_waiting = -1; + ctx->stats.t_response = -1; + ctx->stats.t_process = -1; + + ctx->status_code = 0; + + /* Set the right flag to prevent request and response processing + * in same time. */ + ctx->flags |= ((dir == SMP_OPT_DIR_REQ) + ? SPOE_CTX_FL_REQ_PROCESS + : SPOE_CTX_FL_RSP_PROCESS); + return 1; +} + +static inline void +spoe_stop_processing(struct spoe_agent *agent, struct spoe_context *ctx) +{ + struct spoe_appctx *sa = ctx->spoe_appctx; + + if (!(ctx->flags & SPOE_CTX_FL_PROCESS)) + return; + _HA_ATOMIC_INC(&agent->counters.nb_processed); + if (sa) { + if (sa->frag_ctx.ctx == ctx) { + sa->frag_ctx.ctx = NULL; + spoe_wakeup_appctx(sa->owner); + } + else + sa->cur_fpa--; + } + + /* Reset the flag to allow next processing */ + agent->rt[tid].processing--; + ctx->flags &= ~(SPOE_CTX_FL_PROCESS|SPOE_CTX_FL_FRAGMENTED); + + /* Reset processing timer */ + ctx->process_exp = TICK_ETERNITY; + + spoe_release_buffer(&ctx->buffer, &ctx->buffer_wait); + + ctx->spoe_appctx = NULL; + ctx->frag_ctx.curmsg = NULL; + ctx->frag_ctx.curarg = NULL; + ctx->frag_ctx.curoff = 0; + ctx->frag_ctx.flags = 0; + + if (!LIST_ISEMPTY(&ctx->list)) { + if (ctx->state == SPOE_CTX_ST_SENDING_MSGS) + _HA_ATOMIC_DEC(&agent->counters.nb_sending); + else + _HA_ATOMIC_DEC(&agent->counters.nb_waiting); + + LIST_DELETE(&ctx->list); + LIST_INIT(&ctx->list); + } +} + +/* Process a list of SPOE messages. First, this functions will process messages + * and send them to an agent in a NOTIFY frame. Then, it will wait a ACK frame + * to process corresponding actions. During all the processing, it returns 0 + * and it returns 1 when the processing is finished. If an error occurred, -1 + * is returned. */ +static int +spoe_process_messages(struct stream *s, struct spoe_context *ctx, + struct list *messages, int dir, int type) +{ + struct spoe_config *conf = FLT_CONF(ctx->filter); + struct spoe_agent *agent = conf->agent; + int ret = 1; + + if (ctx->state == SPOE_CTX_ST_ERROR) + goto end; + + if (tick_is_expired(ctx->process_exp, now_ms) && ctx->state != SPOE_CTX_ST_DONE) { + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - failed to process messages: timeout\n", + (int)date.tv_sec, (int)date.tv_usec, + agent->id, __FUNCTION__, s); + ctx->status_code = SPOE_CTX_ERR_TOUT; + goto end; + } + + if (ctx->state == SPOE_CTX_ST_READY) { + if (agent->eps_max > 0) { + if (!freq_ctr_remain(&agent->rt[tid].err_per_sec, agent->eps_max, 0)) { + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - skip processing of messages: max EPS reached\n", + (int)date.tv_sec, (int)date.tv_usec, + agent->id, __FUNCTION__, s); + goto skip; + } + } + + if (!tick_isset(ctx->process_exp)) { + ctx->process_exp = tick_add_ifset(now_ms, agent->timeout.processing); + s->task->expire = tick_first((tick_is_expired(s->task->expire, now_ms) ? 0 : s->task->expire), + ctx->process_exp); + } + ret = spoe_start_processing(agent, ctx, dir); + if (!ret) + goto out; + + ctx->state = SPOE_CTX_ST_ENCODING_MSGS; + /* fall through */ + } + + if (ctx->state == SPOE_CTX_ST_ENCODING_MSGS) { + if (ctx->stats.request_ts == 0) + ctx->stats.request_ts = now_ns; + if (!spoe_acquire_buffer(&ctx->buffer, &ctx->buffer_wait)) + goto out; + ret = spoe_encode_messages(s, ctx, messages, dir, type); + if (ret < 0) + goto end; + if (!ret) + goto skip; + if (spoe_queue_context(ctx) < 0) + goto end; + ctx->state = SPOE_CTX_ST_SENDING_MSGS; + } + + if (ctx->state == SPOE_CTX_ST_SENDING_MSGS) { + if (ctx->spoe_appctx) + spoe_wakeup_appctx(ctx->spoe_appctx->owner); + ret = 0; + goto out; + } + + if (ctx->state == SPOE_CTX_ST_WAITING_ACK) { + ret = 0; + goto out; + } + + if (ctx->state == SPOE_CTX_ST_DONE) { + spoe_process_actions(s, ctx, dir); + ret = 1; + ctx->frame_id++; + ctx->state = SPOE_CTX_ST_READY; + spoe_update_stat_time(&ctx->stats.response_ts, &ctx->stats.t_response); + goto end; + } + + out: + return ret; + + skip: + ctx->stats.start_ts = 0; + ctx->state = SPOE_CTX_ST_READY; + spoe_stop_processing(agent, ctx); + return 1; + + end: + spoe_update_stats(s, agent, ctx, dir); + spoe_stop_processing(agent, ctx); + if (ctx->status_code) { + _HA_ATOMIC_INC(&agent->counters.nb_errors); + spoe_handle_processing_error(s, agent, ctx, dir); + ret = 1; + } + return ret; +} + +/* Process a SPOE group, ie the list of messages attached to the group <grp>. + * See spoe_process_message for details. */ +static int +spoe_process_group(struct stream *s, struct spoe_context *ctx, + struct spoe_group *group, int dir) +{ + struct spoe_config *conf = FLT_CONF(ctx->filter); + struct spoe_agent *agent = conf->agent; + int ret; + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - ctx-state=%s - Process messages for group=%s\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, s, spoe_ctx_state_str[ctx->state], + group->id); + + if (LIST_ISEMPTY(&group->messages)) + return 1; + + ret = spoe_process_messages(s, ctx, &group->messages, dir, SPOE_MSGS_BY_GROUP); + if (ret && ctx->stats.t_process != -1) { + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - <GROUP:%s> sid=%u st=%u %ld/%ld/%ld/%ld/%ld %u/%u %u/%u %llu/%llu %u/%u\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, s, group->id, s->uniq_id, ctx->status_code, + ctx->stats.t_request, ctx->stats.t_queue, ctx->stats.t_waiting, + ctx->stats.t_response, ctx->stats.t_process, + agent->counters.idles, agent->counters.applets, + agent->counters.nb_sending, agent->counters.nb_waiting, + agent->counters.nb_errors, agent->counters.nb_processed, + agent->rt[tid].processing, read_freq_ctr(&agent->rt[tid].processing_per_sec)); + if (ctx->status_code || !(conf->agent_fe.options2 & PR_O2_NOLOGNORM)) + send_log(&conf->agent_fe, (!ctx->status_code ? LOG_NOTICE : LOG_WARNING), + "SPOE: [%s] <GROUP:%s> sid=%u st=%u %ld/%ld/%ld/%ld/%ld %u/%u %u/%u %llu/%llu\n", + agent->id, group->id, s->uniq_id, ctx->status_code, + ctx->stats.t_request, ctx->stats.t_queue, ctx->stats.t_waiting, + ctx->stats.t_response, ctx->stats.t_process, + agent->counters.idles, agent->counters.applets, + agent->counters.nb_sending, agent->counters.nb_waiting, + agent->counters.nb_errors, agent->counters.nb_processed); + } + return ret; +} + +/* Process a SPOE event, ie the list of messages attached to the event <ev>. + * See spoe_process_message for details. */ +static int +spoe_process_event(struct stream *s, struct spoe_context *ctx, + enum spoe_event ev) +{ + struct spoe_config *conf = FLT_CONF(ctx->filter); + struct spoe_agent *agent = conf->agent; + int dir, ret; + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - ctx-state=%s - Process messages for event=%s\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, s, spoe_ctx_state_str[ctx->state], + spoe_event_str[ev]); + + dir = ((ev < SPOE_EV_ON_SERVER_SESS) ? SMP_OPT_DIR_REQ : SMP_OPT_DIR_RES); + + if (LIST_ISEMPTY(&(ctx->events[ev]))) + return 1; + + ret = spoe_process_messages(s, ctx, &(ctx->events[ev]), dir, SPOE_MSGS_BY_EVENT); + if (ret && ctx->stats.t_process != -1) { + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - <EVENT:%s> sid=%u st=%u %ld/%ld/%ld/%ld/%ld %u/%u %u/%u %llu/%llu %u/%u\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, s, spoe_event_str[ev], s->uniq_id, ctx->status_code, + ctx->stats.t_request, ctx->stats.t_queue, ctx->stats.t_waiting, + ctx->stats.t_response, ctx->stats.t_process, + agent->counters.idles, agent->counters.applets, + agent->counters.nb_sending, agent->counters.nb_waiting, + agent->counters.nb_errors, agent->counters.nb_processed, + agent->rt[tid].processing, read_freq_ctr(&agent->rt[tid].processing_per_sec)); + if (ctx->status_code || !(conf->agent_fe.options2 & PR_O2_NOLOGNORM)) + send_log(&conf->agent_fe, (!ctx->status_code ? LOG_NOTICE : LOG_WARNING), + "SPOE: [%s] <EVENT:%s> sid=%u st=%u %ld/%ld/%ld/%ld/%ld %u/%u %u/%u %llu/%llu\n", + agent->id, spoe_event_str[ev], s->uniq_id, ctx->status_code, + ctx->stats.t_request, ctx->stats.t_queue, ctx->stats.t_waiting, + ctx->stats.t_response, ctx->stats.t_process, + agent->counters.idles, agent->counters.applets, + agent->counters.nb_sending, agent->counters.nb_waiting, + agent->counters.nb_errors, agent->counters.nb_processed); + } + return ret; +} + +/*************************************************************************** + * Functions that create/destroy SPOE contexts + **************************************************************************/ +static int +spoe_acquire_buffer(struct buffer *buf, struct buffer_wait *buffer_wait) +{ + if (buf->size) + return 1; + + if (LIST_INLIST(&buffer_wait->list)) + LIST_DEL_INIT(&buffer_wait->list); + + if (b_alloc(buf)) + return 1; + + LIST_APPEND(&th_ctx->buffer_wq, &buffer_wait->list); + return 0; +} + +static void +spoe_release_buffer(struct buffer *buf, struct buffer_wait *buffer_wait) +{ + if (LIST_INLIST(&buffer_wait->list)) + LIST_DEL_INIT(&buffer_wait->list); + + /* Release the buffer if needed */ + if (buf->size) { + b_free(buf); + offer_buffers(buffer_wait->target, 1); + } +} + +static int +spoe_wakeup_context(struct spoe_context *ctx) +{ + task_wakeup(ctx->strm->task, TASK_WOKEN_MSG); + return 1; +} + +static struct spoe_context * +spoe_create_context(struct stream *s, struct filter *filter) +{ + struct spoe_config *conf = FLT_CONF(filter); + struct spoe_context *ctx; + + ctx = pool_zalloc(pool_head_spoe_ctx); + if (ctx == NULL) { + return NULL; + } + ctx->filter = filter; + ctx->state = SPOE_CTX_ST_NONE; + ctx->status_code = SPOE_CTX_ERR_NONE; + ctx->flags = 0; + ctx->events = conf->agent->events; + ctx->groups = &conf->agent->groups; + ctx->buffer = BUF_NULL; + LIST_INIT(&ctx->buffer_wait.list); + ctx->buffer_wait.target = ctx; + ctx->buffer_wait.wakeup_cb = (int (*)(void *))spoe_wakeup_context; + LIST_INIT(&ctx->list); + + ctx->stream_id = 0; + ctx->frame_id = 1; + ctx->process_exp = TICK_ETERNITY; + + ctx->stats.start_ts = 0; + ctx->stats.request_ts = 0; + ctx->stats.queue_ts = 0; + ctx->stats.wait_ts = 0; + ctx->stats.response_ts= 0; + ctx->stats.t_request = -1; + ctx->stats.t_queue = -1; + ctx->stats.t_waiting = -1; + ctx->stats.t_response = -1; + ctx->stats.t_process = -1; + ctx->stats.t_total = 0; + + ctx->strm = s; + ctx->state = SPOE_CTX_ST_READY; + filter->ctx = ctx; + + return ctx; +} + +static void +spoe_destroy_context(struct filter *filter) +{ + struct spoe_config *conf = FLT_CONF(filter); + struct spoe_context *ctx = filter->ctx; + + if (!ctx) + return; + + spoe_stop_processing(conf->agent, ctx); + pool_free(pool_head_spoe_ctx, ctx); + filter->ctx = NULL; +} + +static void +spoe_reset_context(struct spoe_context *ctx) +{ + ctx->state = SPOE_CTX_ST_READY; + ctx->flags &= ~(SPOE_CTX_FL_PROCESS|SPOE_CTX_FL_FRAGMENTED); + + ctx->stats.start_ts = 0; + ctx->stats.request_ts = 0; + ctx->stats.queue_ts = 0; + ctx->stats.wait_ts = 0; + ctx->stats.response_ts= 0; + ctx->stats.t_request = -1; + ctx->stats.t_queue = -1; + ctx->stats.t_waiting = -1; + ctx->stats.t_response = -1; + ctx->stats.t_process = -1; + ctx->stats.t_total = 0; +} + + +/*************************************************************************** + * Hooks that manage the filter lifecycle (init/check/deinit) + **************************************************************************/ +/* Signal handler: Do a soft stop, wakeup SPOE applet */ +static void +spoe_sig_stop(struct sig_handler *sh) +{ + struct proxy *p; + + p = proxies_list; + while (p) { + struct flt_conf *fconf; + + /* SPOE filter are not initialized for disabled proxoes. Move to + * the next one + */ + if (p->flags & PR_FL_DISABLED) { + p = p->next; + continue; + } + + list_for_each_entry(fconf, &p->filter_configs, list) { + struct spoe_config *conf; + struct spoe_agent *agent; + struct spoe_appctx *spoe_appctx; + int i; + + if (fconf->id != spoe_filter_id) + continue; + + conf = fconf->conf; + agent = conf->agent; + + for (i = 0; i < global.nbthread; ++i) { + HA_SPIN_LOCK(SPOE_APPLET_LOCK, &agent->rt[i].lock); + list_for_each_entry(spoe_appctx, &agent->rt[i].applets, list) + spoe_wakeup_appctx(spoe_appctx->owner); + HA_SPIN_UNLOCK(SPOE_APPLET_LOCK, &agent->rt[i].lock); + } + } + p = p->next; + } +} + + +/* Initialize the SPOE filter. Returns -1 on error, else 0. */ +static int +spoe_init(struct proxy *px, struct flt_conf *fconf) +{ + struct spoe_config *conf = fconf->conf; + + /* conf->agent_fe was already initialized during the config + * parsing. Finish initialization. */ + conf->agent_fe.last_change = ns_to_sec(now_ns); + conf->agent_fe.cap = PR_CAP_FE; + conf->agent_fe.mode = PR_MODE_TCP; + conf->agent_fe.maxconn = 0; + conf->agent_fe.options2 |= PR_O2_INDEPSTR; + conf->agent_fe.conn_retries = CONN_RETRIES; + conf->agent_fe.accept = frontend_accept; + conf->agent_fe.srv = NULL; + conf->agent_fe.timeout.client = TICK_ETERNITY; + conf->agent_fe.fe_req_ana = AN_REQ_SWITCHING_RULES; + + if (!sighandler_registered) { + signal_register_fct(0, spoe_sig_stop, 0); + sighandler_registered = 1; + } + + fconf->flags |= FLT_CFG_FL_HTX; + return 0; +} + +/* Free resources allocated by the SPOE filter. */ +static void +spoe_deinit(struct proxy *px, struct flt_conf *fconf) +{ + struct spoe_config *conf = fconf->conf; + + if (conf) { + struct spoe_agent *agent = conf->agent; + + spoe_release_agent(agent); + free(conf->id); + free(conf); + } + fconf->conf = NULL; +} + +/* Check configuration of a SPOE filter for a specified proxy. + * Return 1 on error, else 0. */ +static int +spoe_check(struct proxy *px, struct flt_conf *fconf) +{ + struct flt_conf *f; + struct spoe_config *conf = fconf->conf; + struct proxy *target; + int i; + + /* Check all SPOE filters for proxy <px> to be sure all SPOE agent names + * are uniq */ + list_for_each_entry(f, &px->filter_configs, list) { + struct spoe_config *c = f->conf; + + /* This is not an SPOE filter */ + if (f->id != spoe_filter_id) + continue; + /* This is the current SPOE filter */ + if (f == fconf) + continue; + + /* Check engine Id. It should be uniq */ + if (strcmp(conf->id, c->id) == 0) { + ha_alert("Proxy %s : duplicated name for SPOE engine '%s'.\n", + px->id, conf->id); + return 1; + } + } + + target = proxy_be_by_name(conf->agent->b.name); + if (target == NULL) { + ha_alert("Proxy %s : unknown backend '%s' used by SPOE agent '%s'" + " declared at %s:%d.\n", + px->id, conf->agent->b.name, conf->agent->id, + conf->agent->conf.file, conf->agent->conf.line); + return 1; + } + if (target->mode != PR_MODE_TCP) { + ha_alert("Proxy %s : backend '%s' used by SPOE agent '%s' declared" + " at %s:%d does not support HTTP mode.\n", + px->id, target->id, conf->agent->id, + conf->agent->conf.file, conf->agent->conf.line); + return 1; + } + + if ((conf->agent->rt = calloc(global.nbthread, sizeof(*conf->agent->rt))) == NULL) { + ha_alert("Proxy %s : out of memory initializing SPOE agent '%s' declared at %s:%d.\n", + px->id, conf->agent->id, conf->agent->conf.file, conf->agent->conf.line); + return 1; + } + for (i = 0; i < global.nbthread; ++i) { + conf->agent->rt[i].engine_id = NULL; + conf->agent->rt[i].frame_size = conf->agent->max_frame_size; + conf->agent->rt[i].processing = 0; + conf->agent->rt[i].idles = 0; + LIST_INIT(&conf->agent->rt[i].applets); + LIST_INIT(&conf->agent->rt[i].sending_queue); + LIST_INIT(&conf->agent->rt[i].waiting_queue); + HA_SPIN_INIT(&conf->agent->rt[i].lock); + } + + if (postresolve_logger_list(&conf->agent_fe.loggers, "SPOE agent", conf->agent->id) & ERR_CODE) + return 1; + + ha_free(&conf->agent->b.name); + conf->agent->b.be = target; + return 0; +} + +/* Initializes the SPOE filter for a proxy for a specific thread. + * Returns a negative value if an error occurs. */ +static int +spoe_init_per_thread(struct proxy *p, struct flt_conf *fconf) +{ + struct spoe_config *conf = fconf->conf; + struct spoe_agent *agent = conf->agent; + + agent->rt[tid].engine_id = generate_pseudo_uuid(); + if (agent->rt[tid].engine_id == NULL) + return -1; + return 0; +} + +/************************************************************************** + * Hooks attached to a stream + *************************************************************************/ +/* Called when a filter instance is created and attach to a stream. It creates + * the context that will be used to process this stream. */ +static int +spoe_start(struct stream *s, struct filter *filter) +{ + struct spoe_config *conf = FLT_CONF(filter); + struct spoe_agent *agent = conf->agent; + struct spoe_context *ctx; + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, s); + + if ((ctx = spoe_create_context(s, filter)) == NULL) { + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - failed to create SPOE context\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, s); + send_log(&conf->agent_fe, LOG_EMERG, + "SPOE: [%s] failed to create SPOE context\n", + agent->id); + return 0; + } + + if (!LIST_ISEMPTY(&ctx->events[SPOE_EV_ON_TCP_REQ_FE])) + filter->pre_analyzers |= AN_REQ_INSPECT_FE; + + if (!LIST_ISEMPTY(&ctx->events[SPOE_EV_ON_TCP_REQ_BE])) + filter->pre_analyzers |= AN_REQ_INSPECT_BE; + + if (!LIST_ISEMPTY(&ctx->events[SPOE_EV_ON_TCP_RSP])) + filter->pre_analyzers |= AN_RES_INSPECT; + + if (!LIST_ISEMPTY(&ctx->events[SPOE_EV_ON_HTTP_REQ_FE])) + filter->pre_analyzers |= AN_REQ_HTTP_PROCESS_FE; + + if (!LIST_ISEMPTY(&ctx->events[SPOE_EV_ON_HTTP_REQ_BE])) + filter->pre_analyzers |= AN_REQ_HTTP_PROCESS_BE; + + if (!LIST_ISEMPTY(&ctx->events[SPOE_EV_ON_HTTP_RSP])) + filter->pre_analyzers |= AN_RES_HTTP_PROCESS_FE; + + return 1; +} + +/* Called when a filter instance is detached from a stream. It release the + * attached SPOE context. */ +static void +spoe_stop(struct stream *s, struct filter *filter) +{ + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p\n", + (int)date.tv_sec, (int)date.tv_usec, + ((struct spoe_config *)FLT_CONF(filter))->agent->id, + __FUNCTION__, s); + spoe_destroy_context(filter); +} + + +/* + * Called when the stream is woken up because of expired timer. + */ +static void +spoe_check_timeouts(struct stream *s, struct filter *filter) +{ + struct spoe_context *ctx = filter->ctx; + + if (tick_is_expired(ctx->process_exp, now_ms)) + s->pending_events |= TASK_WOKEN_MSG; +} + +/* Called when we are ready to filter data on a channel */ +static int +spoe_start_analyze(struct stream *s, struct filter *filter, struct channel *chn) +{ + struct spoe_context *ctx = filter->ctx; + int ret = 1; + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p - ctx-state=%s" + " - ctx-flags=0x%08x\n", + (int)date.tv_sec, (int)date.tv_usec, + ((struct spoe_config *)FLT_CONF(filter))->agent->id, + __FUNCTION__, s, spoe_ctx_state_str[ctx->state], ctx->flags); + + if (ctx->state == SPOE_CTX_ST_NONE) + goto out; + + if (!(chn->flags & CF_ISRESP)) { + if (filter->pre_analyzers & AN_REQ_INSPECT_FE) + chn->analysers |= AN_REQ_INSPECT_FE; + if (filter->pre_analyzers & AN_REQ_INSPECT_BE) + chn->analysers |= AN_REQ_INSPECT_BE; + + if (ctx->flags & SPOE_CTX_FL_CLI_CONNECTED) + goto out; + + ctx->stream_id = s->uniq_id; + ret = spoe_process_event(s, ctx, SPOE_EV_ON_CLIENT_SESS); + if (!ret) + goto out; + ctx->flags |= SPOE_CTX_FL_CLI_CONNECTED; + } + else { + if (filter->pre_analyzers & AN_RES_INSPECT) + chn->analysers |= AN_RES_INSPECT; + + if (ctx->flags & SPOE_CTX_FL_SRV_CONNECTED) + goto out; + + ret = spoe_process_event(s, ctx, SPOE_EV_ON_SERVER_SESS); + if (!ret) { + channel_dont_read(chn); + channel_dont_close(chn); + goto out; + } + ctx->flags |= SPOE_CTX_FL_SRV_CONNECTED; + } + + out: + return ret; +} + +/* Called before a processing happens on a given channel */ +static int +spoe_chn_pre_analyze(struct stream *s, struct filter *filter, + struct channel *chn, unsigned an_bit) +{ + struct spoe_context *ctx = filter->ctx; + int ret = 1; + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p - ctx-state=%s" + " - ctx-flags=0x%08x - ana=0x%08x\n", + (int)date.tv_sec, (int)date.tv_usec, + ((struct spoe_config *)FLT_CONF(filter))->agent->id, + __FUNCTION__, s, spoe_ctx_state_str[ctx->state], + ctx->flags, an_bit); + + if (ctx->state == SPOE_CTX_ST_NONE) + goto out; + + switch (an_bit) { + case AN_REQ_INSPECT_FE: + ret = spoe_process_event(s, ctx, SPOE_EV_ON_TCP_REQ_FE); + break; + case AN_REQ_INSPECT_BE: + ret = spoe_process_event(s, ctx, SPOE_EV_ON_TCP_REQ_BE); + break; + case AN_RES_INSPECT: + ret = spoe_process_event(s, ctx, SPOE_EV_ON_TCP_RSP); + break; + case AN_REQ_HTTP_PROCESS_FE: + ret = spoe_process_event(s, ctx, SPOE_EV_ON_HTTP_REQ_FE); + break; + case AN_REQ_HTTP_PROCESS_BE: + ret = spoe_process_event(s, ctx, SPOE_EV_ON_HTTP_REQ_BE); + break; + case AN_RES_HTTP_PROCESS_FE: + ret = spoe_process_event(s, ctx, SPOE_EV_ON_HTTP_RSP); + break; + } + + out: + if (!ret && (chn->flags & CF_ISRESP)) { + channel_dont_read(chn); + channel_dont_close(chn); + } + return ret; +} + +/* Called when the filtering on the channel ends. */ +static int +spoe_end_analyze(struct stream *s, struct filter *filter, struct channel *chn) +{ + struct spoe_context *ctx = filter->ctx; + + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p - ctx-state=%s" + " - ctx-flags=0x%08x\n", + (int)date.tv_sec, (int)date.tv_usec, + ((struct spoe_config *)FLT_CONF(filter))->agent->id, + __FUNCTION__, s, spoe_ctx_state_str[ctx->state], ctx->flags); + + if (!(ctx->flags & SPOE_CTX_FL_PROCESS)) { + spoe_reset_context(ctx); + } + + return 1; +} + +/******************************************************************** + * Functions that manage the filter initialization + ********************************************************************/ +struct flt_ops spoe_ops = { + /* Manage SPOE filter, called for each filter declaration */ + .init = spoe_init, + .deinit = spoe_deinit, + .check = spoe_check, + .init_per_thread = spoe_init_per_thread, + + /* Handle start/stop of SPOE */ + .attach = spoe_start, + .detach = spoe_stop, + .check_timeouts = spoe_check_timeouts, + + /* Handle channels activity */ + .channel_start_analyze = spoe_start_analyze, + .channel_pre_analyze = spoe_chn_pre_analyze, + .channel_end_analyze = spoe_end_analyze, +}; + + +static int +cfg_parse_spoe_agent(const char *file, int linenum, char **args, int kwm) +{ + const char *err; + int i, err_code = 0; + + if ((cfg_scope == NULL && curengine != NULL) || + (cfg_scope != NULL && curengine == NULL) || + (curengine != NULL && cfg_scope != NULL && strcmp(curengine, cfg_scope) != 0)) + goto out; + + if (strcmp(args[0], "spoe-agent") == 0) { /* new spoe-agent section */ + if (!*args[1]) { + ha_alert("parsing [%s:%d] : missing name for spoe-agent section.\n", + file, linenum); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + if (alertif_too_many_args(1, file, linenum, args, &err_code)) { + err_code |= ERR_ABORT; + goto out; + } + + err = invalid_char(args[1]); + if (err) { + ha_alert("parsing [%s:%d] : character '%c' is not permitted in '%s' name '%s'.\n", + file, linenum, *err, args[0], args[1]); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + + if (curagent != NULL) { + ha_alert("parsing [%s:%d] : another spoe-agent section previously defined.\n", + file, linenum); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + if ((curagent = calloc(1, sizeof(*curagent))) == NULL) { + ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + + curagent->id = strdup(args[1]); + + curagent->conf.file = strdup(file); + curagent->conf.line = linenum; + + curagent->timeout.hello = TICK_ETERNITY; + curagent->timeout.idle = TICK_ETERNITY; + curagent->timeout.processing = TICK_ETERNITY; + + curagent->var_pfx = NULL; + curagent->var_on_error = NULL; + curagent->var_t_process = NULL; + curagent->var_t_total = NULL; + curagent->flags = (SPOE_FL_ASYNC | SPOE_FL_PIPELINING | SPOE_FL_SND_FRAGMENTATION); + curagent->cps_max = 0; + curagent->eps_max = 0; + curagent->max_frame_size = MAX_FRAME_SIZE; + curagent->max_fpa = 20; + + for (i = 0; i < SPOE_EV_EVENTS; ++i) + LIST_INIT(&curagent->events[i]); + LIST_INIT(&curagent->groups); + LIST_INIT(&curagent->messages); + } + else if (strcmp(args[0], "use-backend") == 0) { + if (!*args[1]) { + ha_alert("parsing [%s:%d] : '%s' expects a backend name.\n", + file, linenum, args[0]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + if (alertif_too_many_args(1, file, linenum, args, &err_code)) + goto out; + free(curagent->b.name); + curagent->b.name = strdup(args[1]); + } + else if (strcmp(args[0], "messages") == 0) { + int cur_arg = 1; + while (*args[cur_arg]) { + struct spoe_placeholder *ph = NULL; + + list_for_each_entry(ph, &curmphs, list) { + if (strcmp(ph->id, args[cur_arg]) == 0) { + ha_alert("parsing [%s:%d]: spoe-message '%s' already used.\n", + file, linenum, args[cur_arg]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + } + + if ((ph = calloc(1, sizeof(*ph))) == NULL) { + ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + ph->id = strdup(args[cur_arg]); + LIST_APPEND(&curmphs, &ph->list); + cur_arg++; + } + } + else if (strcmp(args[0], "groups") == 0) { + int cur_arg = 1; + while (*args[cur_arg]) { + struct spoe_placeholder *ph = NULL; + + list_for_each_entry(ph, &curgphs, list) { + if (strcmp(ph->id, args[cur_arg]) == 0) { + ha_alert("parsing [%s:%d]: spoe-group '%s' already used.\n", + file, linenum, args[cur_arg]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + } + + if ((ph = calloc(1, sizeof(*ph))) == NULL) { + ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + ph->id = strdup(args[cur_arg]); + LIST_APPEND(&curgphs, &ph->list); + cur_arg++; + } + } + else if (strcmp(args[0], "timeout") == 0) { + unsigned int *tv = NULL; + const char *res; + unsigned timeout; + + if (!*args[1]) { + ha_alert("parsing [%s:%d] : 'timeout' expects 'hello', 'idle' and 'processing'.\n", + file, linenum); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + if (alertif_too_many_args(2, file, linenum, args, &err_code)) + goto out; + if (strcmp(args[1], "hello") == 0) + tv = &curagent->timeout.hello; + else if (strcmp(args[1], "idle") == 0) + tv = &curagent->timeout.idle; + else if (strcmp(args[1], "processing") == 0) + tv = &curagent->timeout.processing; + else { + ha_alert("parsing [%s:%d] : 'timeout' supports 'hello', 'idle' or 'processing' (got %s).\n", + file, linenum, args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + if (!*args[2]) { + ha_alert("parsing [%s:%d] : 'timeout %s' expects an integer value (in milliseconds).\n", + file, linenum, args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + res = parse_time_err(args[2], &timeout, TIME_UNIT_MS); + if (res == PARSE_TIME_OVER) { + ha_alert("parsing [%s:%d]: timer overflow in argument <%s> to <%s %s>, maximum value is 2147483647 ms (~24.8 days).\n", + file, linenum, args[2], args[0], args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + else if (res == PARSE_TIME_UNDER) { + ha_alert("parsing [%s:%d]: timer underflow in argument <%s> to <%s %s>, minimum non-null value is 1 ms.\n", + file, linenum, args[2], args[0], args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + else if (res) { + ha_alert("parsing [%s:%d] : unexpected character '%c' in 'timeout %s'.\n", + file, linenum, *res, args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + *tv = MS_TO_TICKS(timeout); + } + else if (strcmp(args[0], "option") == 0) { + if (!*args[1]) { + ha_alert("parsing [%s:%d]: '%s' expects an option name.\n", + file, linenum, args[0]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + + if (strcmp(args[1], "pipelining") == 0) { + if (alertif_too_many_args(1, file, linenum, args, &err_code)) + goto out; + if (kwm == 1) + curagent->flags &= ~SPOE_FL_PIPELINING; + else + curagent->flags |= SPOE_FL_PIPELINING; + goto out; + } + else if (strcmp(args[1], "async") == 0) { + if (alertif_too_many_args(1, file, linenum, args, &err_code)) + goto out; + if (kwm == 1) + curagent->flags &= ~SPOE_FL_ASYNC; + else + curagent->flags |= SPOE_FL_ASYNC; + goto out; + } + else if (strcmp(args[1], "send-frag-payload") == 0) { + if (alertif_too_many_args(1, file, linenum, args, &err_code)) + goto out; + if (kwm == 1) + curagent->flags &= ~SPOE_FL_SND_FRAGMENTATION; + else + curagent->flags |= SPOE_FL_SND_FRAGMENTATION; + goto out; + } + else if (strcmp(args[1], "dontlog-normal") == 0) { + if (alertif_too_many_args(1, file, linenum, args, &err_code)) + goto out; + if (kwm == 1) + curpxopts2 &= ~PR_O2_NOLOGNORM; + else + curpxopts2 |= PR_O2_NOLOGNORM; + goto out; + } + + /* Following options does not support negation */ + if (kwm == 1) { + ha_alert("parsing [%s:%d]: negation is not supported for option '%s'.\n", + file, linenum, args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + + if (strcmp(args[1], "var-prefix") == 0) { + char *tmp; + + if (!*args[2]) { + ha_alert("parsing [%s:%d]: '%s %s' expects a value.\n", + file, linenum, args[0], + args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + if (alertif_too_many_args(2, file, linenum, args, &err_code)) + goto out; + tmp = args[2]; + while (*tmp) { + if (!isalnum((unsigned char)*tmp) && *tmp != '_' && *tmp != '.') { + ha_alert("parsing [%s:%d]: '%s %s' only supports [a-zA-Z0-9_.] chars.\n", + file, linenum, args[0], args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + tmp++; + } + curagent->var_pfx = strdup(args[2]); + } + else if (strcmp(args[1], "force-set-var") == 0) { + if (alertif_too_many_args(1, file, linenum, args, &err_code)) + goto out; + curagent->flags |= SPOE_FL_FORCE_SET_VAR; + } + else if (strcmp(args[1], "continue-on-error") == 0) { + if (alertif_too_many_args(1, file, linenum, args, &err_code)) + goto out; + curagent->flags |= SPOE_FL_CONT_ON_ERR; + } + else if (strcmp(args[1], "set-on-error") == 0) { + char *tmp; + + if (!*args[2]) { + ha_alert("parsing [%s:%d]: '%s %s' expects a value.\n", + file, linenum, args[0], + args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + if (alertif_too_many_args(2, file, linenum, args, &err_code)) + goto out; + tmp = args[2]; + while (*tmp) { + if (!isalnum((unsigned char)*tmp) && *tmp != '_' && *tmp != '.') { + ha_alert("parsing [%s:%d]: '%s %s' only supports [a-zA-Z0-9_.] chars.\n", + file, linenum, args[0], args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + tmp++; + } + curagent->var_on_error = strdup(args[2]); + } + else if (strcmp(args[1], "set-process-time") == 0) { + char *tmp; + + if (!*args[2]) { + ha_alert("parsing [%s:%d]: '%s %s' expects a value.\n", + file, linenum, args[0], + args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + if (alertif_too_many_args(2, file, linenum, args, &err_code)) + goto out; + tmp = args[2]; + while (*tmp) { + if (!isalnum((unsigned char)*tmp) && *tmp != '_' && *tmp != '.') { + ha_alert("parsing [%s:%d]: '%s %s' only supports [a-zA-Z0-9_.] chars.\n", + file, linenum, args[0], args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + tmp++; + } + curagent->var_t_process = strdup(args[2]); + } + else if (strcmp(args[1], "set-total-time") == 0) { + char *tmp; + + if (!*args[2]) { + ha_alert("parsing [%s:%d]: '%s %s' expects a value.\n", + file, linenum, args[0], + args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + if (alertif_too_many_args(2, file, linenum, args, &err_code)) + goto out; + tmp = args[2]; + while (*tmp) { + if (!isalnum((unsigned char)*tmp) && *tmp != '_' && *tmp != '.') { + ha_alert("parsing [%s:%d]: '%s %s' only supports [a-zA-Z0-9_.] chars.\n", + file, linenum, args[0], args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + tmp++; + } + curagent->var_t_total = strdup(args[2]); + } + else { + ha_alert("parsing [%s:%d]: option '%s' is not supported.\n", + file, linenum, args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + } + else if (strcmp(args[0], "maxconnrate") == 0) { + if (!*args[1]) { + ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n", + file, linenum, args[0]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + if (alertif_too_many_args(1, file, linenum, args, &err_code)) + goto out; + curagent->cps_max = atol(args[1]); + } + else if (strcmp(args[0], "maxerrrate") == 0) { + if (!*args[1]) { + ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n", + file, linenum, args[0]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + if (alertif_too_many_args(1, file, linenum, args, &err_code)) + goto out; + curagent->eps_max = atol(args[1]); + } + else if (strcmp(args[0], "max-frame-size") == 0) { + if (!*args[1]) { + ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n", + file, linenum, args[0]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + if (alertif_too_many_args(1, file, linenum, args, &err_code)) + goto out; + curagent->max_frame_size = atol(args[1]); + if (curagent->max_frame_size < MIN_FRAME_SIZE || + curagent->max_frame_size > MAX_FRAME_SIZE) { + ha_alert("parsing [%s:%d] : '%s' expects a positive integer argument in the range [%d, %d].\n", + file, linenum, args[0], MIN_FRAME_SIZE, MAX_FRAME_SIZE); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + } + else if (strcmp(args[0], "max-waiting-frames") == 0) { + if (!*args[1]) { + ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n", + file, linenum, args[0]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + if (alertif_too_many_args(1, file, linenum, args, &err_code)) + goto out; + curagent->max_fpa = atol(args[1]); + if (curagent->max_fpa < 1) { + ha_alert("parsing [%s:%d] : '%s' expects a positive integer argument.\n", + file, linenum, args[0]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + } + else if (strcmp(args[0], "register-var-names") == 0) { + int cur_arg; + + if (!*args[1]) { + ha_alert("parsing [%s:%d] : '%s' expects one or more variable names.\n", + file, linenum, args[0]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + cur_arg = 1; + while (*args[cur_arg]) { + struct spoe_var_placeholder *vph; + + if ((vph = calloc(1, sizeof(*vph))) == NULL) { + ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + if ((vph->name = strdup(args[cur_arg])) == NULL) { + free(vph); + ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + LIST_APPEND(&curvars, &vph->list); + cur_arg++; + } + } + else if (strcmp(args[0], "log") == 0) { + char *errmsg = NULL; + + if (!parse_logger(args, &curloggers, (kwm == 1), file, linenum, &errmsg)) { + ha_alert("parsing [%s:%d] : %s : %s\n", file, linenum, args[0], errmsg); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + } + else if (*args[0]) { + ha_alert("parsing [%s:%d] : unknown keyword '%s' in spoe-agent section.\n", + file, linenum, args[0]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + out: + return err_code; +} +static int +cfg_parse_spoe_group(const char *file, int linenum, char **args, int kwm) +{ + struct spoe_group *grp; + const char *err; + int err_code = 0; + + if ((cfg_scope == NULL && curengine != NULL) || + (cfg_scope != NULL && curengine == NULL) || + (curengine != NULL && cfg_scope != NULL && strcmp(curengine, cfg_scope) != 0)) + goto out; + + if (strcmp(args[0], "spoe-group") == 0) { /* new spoe-group section */ + if (!*args[1]) { + ha_alert("parsing [%s:%d] : missing name for spoe-group section.\n", + file, linenum); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + if (alertif_too_many_args(1, file, linenum, args, &err_code)) { + err_code |= ERR_ABORT; + goto out; + } + + err = invalid_char(args[1]); + if (err) { + ha_alert("parsing [%s:%d] : character '%c' is not permitted in '%s' name '%s'.\n", + file, linenum, *err, args[0], args[1]); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + + list_for_each_entry(grp, &curgrps, list) { + if (strcmp(grp->id, args[1]) == 0) { + ha_alert("parsing [%s:%d]: spoe-group section '%s' has the same" + " name as another one declared at %s:%d.\n", + file, linenum, args[1], grp->conf.file, grp->conf.line); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + } + + if ((curgrp = calloc(1, sizeof(*curgrp))) == NULL) { + ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + + curgrp->id = strdup(args[1]); + curgrp->conf.file = strdup(file); + curgrp->conf.line = linenum; + LIST_INIT(&curgrp->phs); + LIST_INIT(&curgrp->messages); + LIST_APPEND(&curgrps, &curgrp->list); + } + else if (strcmp(args[0], "messages") == 0) { + int cur_arg = 1; + while (*args[cur_arg]) { + struct spoe_placeholder *ph = NULL; + + list_for_each_entry(ph, &curgrp->phs, list) { + if (strcmp(ph->id, args[cur_arg]) == 0) { + ha_alert("parsing [%s:%d]: spoe-message '%s' already used.\n", + file, linenum, args[cur_arg]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + } + + if ((ph = calloc(1, sizeof(*ph))) == NULL) { + ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + ph->id = strdup(args[cur_arg]); + LIST_APPEND(&curgrp->phs, &ph->list); + cur_arg++; + } + } + else if (*args[0]) { + ha_alert("parsing [%s:%d] : unknown keyword '%s' in spoe-group section.\n", + file, linenum, args[0]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + out: + return err_code; +} + +static int +cfg_parse_spoe_message(const char *file, int linenum, char **args, int kwm) +{ + struct spoe_message *msg; + struct spoe_arg *arg; + const char *err; + char *errmsg = NULL; + int err_code = 0; + + if ((cfg_scope == NULL && curengine != NULL) || + (cfg_scope != NULL && curengine == NULL) || + (curengine != NULL && cfg_scope != NULL && strcmp(curengine, cfg_scope) != 0)) + goto out; + + if (strcmp(args[0], "spoe-message") == 0) { /* new spoe-message section */ + if (!*args[1]) { + ha_alert("parsing [%s:%d] : missing name for spoe-message section.\n", + file, linenum); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + if (alertif_too_many_args(1, file, linenum, args, &err_code)) { + err_code |= ERR_ABORT; + goto out; + } + + err = invalid_char(args[1]); + if (err) { + ha_alert("parsing [%s:%d] : character '%c' is not permitted in '%s' name '%s'.\n", + file, linenum, *err, args[0], args[1]); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + + list_for_each_entry(msg, &curmsgs, list) { + if (strcmp(msg->id, args[1]) == 0) { + ha_alert("parsing [%s:%d]: spoe-message section '%s' has the same" + " name as another one declared at %s:%d.\n", + file, linenum, args[1], msg->conf.file, msg->conf.line); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + } + + if ((curmsg = calloc(1, sizeof(*curmsg))) == NULL) { + ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + + curmsg->id = strdup(args[1]); + curmsg->id_len = strlen(curmsg->id); + curmsg->event = SPOE_EV_NONE; + curmsg->conf.file = strdup(file); + curmsg->conf.line = linenum; + curmsg->nargs = 0; + LIST_INIT(&curmsg->args); + LIST_INIT(&curmsg->acls); + LIST_INIT(&curmsg->by_evt); + LIST_INIT(&curmsg->by_grp); + LIST_APPEND(&curmsgs, &curmsg->list); + } + else if (strcmp(args[0], "args") == 0) { + int cur_arg = 1; + + curproxy->conf.args.ctx = ARGC_SPOE; + curproxy->conf.args.file = file; + curproxy->conf.args.line = linenum; + while (*args[cur_arg]) { + char *delim = strchr(args[cur_arg], '='); + int idx = 0; + + if ((arg = calloc(1, sizeof(*arg))) == NULL) { + ha_alert("parsing [%s:%d] : out of memory.\n", file, linenum); + err_code |= ERR_ALERT | ERR_ABORT; + goto out; + } + + if (!delim) { + arg->name = NULL; + arg->name_len = 0; + delim = args[cur_arg]; + } + else { + arg->name = my_strndup(args[cur_arg], delim - args[cur_arg]); + arg->name_len = delim - args[cur_arg]; + delim++; + } + arg->expr = sample_parse_expr((char*[]){delim, NULL}, + &idx, file, linenum, &errmsg, + &curproxy->conf.args, NULL); + if (arg->expr == NULL) { + ha_alert("parsing [%s:%d] : '%s': %s.\n", file, linenum, args[0], errmsg); + err_code |= ERR_ALERT | ERR_FATAL; + free(arg->name); + free(arg); + goto out; + } + curmsg->nargs++; + LIST_APPEND(&curmsg->args, &arg->list); + cur_arg++; + } + curproxy->conf.args.file = NULL; + curproxy->conf.args.line = 0; + } + else if (strcmp(args[0], "acl") == 0) { + err = invalid_char(args[1]); + if (err) { + ha_alert("parsing [%s:%d] : character '%c' is not permitted in acl name '%s'.\n", + file, linenum, *err, args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + if (strcasecmp(args[1], "or") == 0) { + ha_alert("parsing [%s:%d] : acl name '%s' will never match. 'or' is used to express a " + "logical disjunction within a condition.\n", + file, linenum, args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + if (parse_acl((const char **)args + 1, &curmsg->acls, &errmsg, &curproxy->conf.args, file, linenum) == NULL) { + ha_alert("parsing [%s:%d] : error detected while parsing ACL '%s' : %s.\n", + file, linenum, args[1], errmsg); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + } + else if (strcmp(args[0], "event") == 0) { + if (!*args[1]) { + ha_alert("parsing [%s:%d] : missing event name.\n", file, linenum); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + /* if (alertif_too_many_args(1, file, linenum, args, &err_code)) */ + /* goto out; */ + + if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_CLIENT_SESS]) == 0) + curmsg->event = SPOE_EV_ON_CLIENT_SESS; + else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_SERVER_SESS]) == 0) + curmsg->event = SPOE_EV_ON_SERVER_SESS; + + else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_TCP_REQ_FE]) == 0) + curmsg->event = SPOE_EV_ON_TCP_REQ_FE; + else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_TCP_REQ_BE]) == 0) + curmsg->event = SPOE_EV_ON_TCP_REQ_BE; + else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_TCP_RSP]) == 0) + curmsg->event = SPOE_EV_ON_TCP_RSP; + + else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_HTTP_REQ_FE]) == 0) + curmsg->event = SPOE_EV_ON_HTTP_REQ_FE; + else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_HTTP_REQ_BE]) == 0) + curmsg->event = SPOE_EV_ON_HTTP_REQ_BE; + else if (strcmp(args[1], spoe_event_str[SPOE_EV_ON_HTTP_RSP]) == 0) + curmsg->event = SPOE_EV_ON_HTTP_RSP; + else { + ha_alert("parsing [%s:%d] : unknown event '%s'.\n", + file, linenum, args[1]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + + if (strcmp(args[2], "if") == 0 || strcmp(args[2], "unless") == 0) { + struct acl_cond *cond; + + cond = build_acl_cond(file, linenum, &curmsg->acls, + curproxy, (const char **)args+2, + &errmsg); + if (cond == NULL) { + ha_alert("parsing [%s:%d] : error detected while " + "parsing an 'event %s' condition : %s.\n", + file, linenum, args[1], errmsg); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + curmsg->cond = cond; + } + else if (*args[2]) { + ha_alert("parsing [%s:%d]: 'event %s' expects either 'if' " + "or 'unless' followed by a condition but found '%s'.\n", + file, linenum, args[1], args[2]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + } + else if (!*args[0]) { + ha_alert("parsing [%s:%d] : unknown keyword '%s' in spoe-message section.\n", + file, linenum, args[0]); + err_code |= ERR_ALERT | ERR_FATAL; + goto out; + } + out: + free(errmsg); + return err_code; +} + +/* Return -1 on error, else 0 */ +static int +parse_spoe_flt(char **args, int *cur_arg, struct proxy *px, + struct flt_conf *fconf, char **err, void *private) +{ + struct list backup_sections; + struct spoe_config *conf; + struct spoe_message *msg, *msgback; + struct spoe_group *grp, *grpback; + struct spoe_placeholder *ph, *phback; + struct spoe_var_placeholder *vph, *vphback; + struct logger *logger, *loggerback; + char *file = NULL, *engine = NULL; + int ret, pos = *cur_arg + 1; + + LIST_INIT(&curmsgs); + LIST_INIT(&curgrps); + LIST_INIT(&curmphs); + LIST_INIT(&curgphs); + LIST_INIT(&curvars); + LIST_INIT(&curloggers); + curpxopts = 0; + curpxopts2 = 0; + + conf = calloc(1, sizeof(*conf)); + if (conf == NULL) { + memprintf(err, "%s: out of memory", args[*cur_arg]); + goto error; + } + conf->proxy = px; + + while (*args[pos]) { + if (strcmp(args[pos], "config") == 0) { + if (!*args[pos+1]) { + memprintf(err, "'%s' : '%s' option without value", + args[*cur_arg], args[pos]); + goto error; + } + file = args[pos+1]; + pos += 2; + } + else if (strcmp(args[pos], "engine") == 0) { + if (!*args[pos+1]) { + memprintf(err, "'%s' : '%s' option without value", + args[*cur_arg], args[pos]); + goto error; + } + engine = args[pos+1]; + pos += 2; + } + else { + memprintf(err, "unknown keyword '%s'", args[pos]); + goto error; + } + } + if (file == NULL) { + memprintf(err, "'%s' : missing config file", args[*cur_arg]); + goto error; + } + + /* backup sections and register SPOE sections */ + LIST_INIT(&backup_sections); + cfg_backup_sections(&backup_sections); + cfg_register_section("spoe-agent", cfg_parse_spoe_agent, NULL); + cfg_register_section("spoe-group", cfg_parse_spoe_group, NULL); + cfg_register_section("spoe-message", cfg_parse_spoe_message, NULL); + + /* Parse SPOE filter configuration file */ + BUG_ON(px != curproxy); + curengine = engine; + curagent = NULL; + curmsg = NULL; + ret = readcfgfile(file); + + /* unregister SPOE sections and restore previous sections */ + cfg_unregister_sections(); + cfg_restore_sections(&backup_sections); + + if (ret == -1) { + memprintf(err, "Could not open configuration file %s : %s", + file, strerror(errno)); + goto error; + } + if (ret & (ERR_ABORT|ERR_FATAL)) { + memprintf(err, "Error(s) found in configuration file %s", file); + goto error; + } + + /* Check SPOE agent */ + if (curagent == NULL) { + memprintf(err, "No SPOE agent found in file %s", file); + goto error; + } + if (curagent->b.name == NULL) { + memprintf(err, "No backend declared for SPOE agent '%s' declared at %s:%d", + curagent->id, curagent->conf.file, curagent->conf.line); + goto error; + } + if (curagent->timeout.hello == TICK_ETERNITY || + curagent->timeout.idle == TICK_ETERNITY || + curagent->timeout.processing == TICK_ETERNITY) { + ha_warning("Proxy '%s': missing timeouts for SPOE agent '%s' declare at %s:%d.\n" + " | While not properly invalid, you will certainly encounter various problems\n" + " | with such a configuration. To fix this, please ensure that all following\n" + " | timeouts are set to a non-zero value: 'hello', 'idle', 'processing'.\n", + px->id, curagent->id, curagent->conf.file, curagent->conf.line); + } + if (curagent->var_pfx == NULL) { + char *tmp = curagent->id; + + while (*tmp) { + if (!isalnum((unsigned char)*tmp) && *tmp != '_' && *tmp != '.') { + memprintf(err, "Invalid variable prefix '%s' for SPOE agent '%s' declared at %s:%d. " + "Use 'option var-prefix' to set it. Only [a-zA-Z0-9_.] chars are supported.\n", + curagent->id, curagent->id, curagent->conf.file, curagent->conf.line); + goto error; + } + tmp++; + } + curagent->var_pfx = strdup(curagent->id); + } + + if (curagent->var_on_error) { + struct arg arg; + + trash.data = snprintf(trash.area, trash.size, "txn.%s.%s", + curagent->var_pfx, curagent->var_on_error); + + arg.type = ARGT_STR; + arg.data.str.area = trash.area; + arg.data.str.data = trash.data; + arg.data.str.size = 0; /* Set it to 0 to not release it in vars_check_arg() */ + if (!vars_check_arg(&arg, err)) { + memprintf(err, "SPOE agent '%s': failed to register variable %s.%s (%s)", + curagent->id, curagent->var_pfx, curagent->var_on_error, *err); + goto error; + } + } + + if (curagent->var_t_process) { + struct arg arg; + + trash.data = snprintf(trash.area, trash.size, "txn.%s.%s", + curagent->var_pfx, curagent->var_t_process); + + arg.type = ARGT_STR; + arg.data.str.area = trash.area; + arg.data.str.data = trash.data; + arg.data.str.size = 0; /* Set it to 0 to not release it in vars_check_arg() */ + if (!vars_check_arg(&arg, err)) { + memprintf(err, "SPOE agent '%s': failed to register variable %s.%s (%s)", + curagent->id, curagent->var_pfx, curagent->var_t_process, *err); + goto error; + } + } + + if (curagent->var_t_total) { + struct arg arg; + + trash.data = snprintf(trash.area, trash.size, "txn.%s.%s", + curagent->var_pfx, curagent->var_t_total); + + arg.type = ARGT_STR; + arg.data.str.area = trash.area; + arg.data.str.data = trash.data; + arg.data.str.size = 0; /* Set it to 0 to not release it in vars_check_arg() */ + if (!vars_check_arg(&arg, err)) { + memprintf(err, "SPOE agent '%s': failed to register variable %s.%s (%s)", + curagent->id, curagent->var_pfx, curagent->var_t_process, *err); + goto error; + } + } + + if (LIST_ISEMPTY(&curmphs) && LIST_ISEMPTY(&curgphs)) { + ha_warning("Proxy '%s': No message/group used by SPOE agent '%s' declared at %s:%d.\n", + px->id, curagent->id, curagent->conf.file, curagent->conf.line); + goto finish; + } + + /* Replace placeholders by the corresponding messages for the SPOE + * agent */ + list_for_each_entry(ph, &curmphs, list) { + list_for_each_entry(msg, &curmsgs, list) { + struct spoe_arg *arg; + unsigned int where; + + if (strcmp(msg->id, ph->id) == 0) { + if ((px->cap & (PR_CAP_FE|PR_CAP_BE)) == (PR_CAP_FE|PR_CAP_BE)) { + if (msg->event == SPOE_EV_ON_TCP_REQ_BE) + msg->event = SPOE_EV_ON_TCP_REQ_FE; + if (msg->event == SPOE_EV_ON_HTTP_REQ_BE) + msg->event = SPOE_EV_ON_HTTP_REQ_FE; + } + if (!(px->cap & PR_CAP_FE) && (msg->event == SPOE_EV_ON_CLIENT_SESS || + msg->event == SPOE_EV_ON_TCP_REQ_FE || + msg->event == SPOE_EV_ON_HTTP_REQ_FE)) { + ha_warning("Proxy '%s': frontend event used on a backend proxy at %s:%d.\n", + px->id, msg->conf.file, msg->conf.line); + goto next_mph; + } + if (msg->event == SPOE_EV_NONE) { + ha_warning("Proxy '%s': Ignore SPOE message '%s' without event at %s:%d.\n", + px->id, msg->id, msg->conf.file, msg->conf.line); + goto next_mph; + } + + where = 0; + switch (msg->event) { + case SPOE_EV_ON_CLIENT_SESS: + where |= SMP_VAL_FE_CON_ACC; + break; + + case SPOE_EV_ON_TCP_REQ_FE: + where |= SMP_VAL_FE_REQ_CNT; + break; + + case SPOE_EV_ON_HTTP_REQ_FE: + where |= SMP_VAL_FE_HRQ_HDR; + break; + + case SPOE_EV_ON_TCP_REQ_BE: + if (px->cap & PR_CAP_FE) + where |= SMP_VAL_FE_REQ_CNT; + if (px->cap & PR_CAP_BE) + where |= SMP_VAL_BE_REQ_CNT; + break; + + case SPOE_EV_ON_HTTP_REQ_BE: + if (px->cap & PR_CAP_FE) + where |= SMP_VAL_FE_HRQ_HDR; + if (px->cap & PR_CAP_BE) + where |= SMP_VAL_BE_HRQ_HDR; + break; + + case SPOE_EV_ON_SERVER_SESS: + where |= SMP_VAL_BE_SRV_CON; + break; + + case SPOE_EV_ON_TCP_RSP: + if (px->cap & PR_CAP_FE) + where |= SMP_VAL_FE_RES_CNT; + if (px->cap & PR_CAP_BE) + where |= SMP_VAL_BE_RES_CNT; + break; + + case SPOE_EV_ON_HTTP_RSP: + if (px->cap & PR_CAP_FE) + where |= SMP_VAL_FE_HRS_HDR; + if (px->cap & PR_CAP_BE) + where |= SMP_VAL_BE_HRS_HDR; + break; + + default: + break; + } + + list_for_each_entry(arg, &msg->args, list) { + if (!(arg->expr->fetch->val & where)) { + memprintf(err, "Ignore SPOE message '%s' at %s:%d: " + "some args extract information from '%s', " + "none of which is available here ('%s')", + msg->id, msg->conf.file, msg->conf.line, + sample_ckp_names(arg->expr->fetch->use), + sample_ckp_names(where)); + goto error; + } + } + + msg->agent = curagent; + LIST_APPEND(&curagent->events[msg->event], &msg->by_evt); + goto next_mph; + } + } + memprintf(err, "SPOE agent '%s' try to use undefined SPOE message '%s' at %s:%d", + curagent->id, ph->id, curagent->conf.file, curagent->conf.line); + goto error; + next_mph: + continue; + } + + /* Replace placeholders by the corresponding groups for the SPOE + * agent */ + list_for_each_entry(ph, &curgphs, list) { + list_for_each_entry_safe(grp, grpback, &curgrps, list) { + if (strcmp(grp->id, ph->id) == 0) { + grp->agent = curagent; + LIST_DELETE(&grp->list); + LIST_APPEND(&curagent->groups, &grp->list); + goto next_aph; + } + } + memprintf(err, "SPOE agent '%s' try to use undefined SPOE group '%s' at %s:%d", + curagent->id, ph->id, curagent->conf.file, curagent->conf.line); + goto error; + next_aph: + continue; + } + + /* Replace placeholders by the corresponding message for each SPOE + * group of the SPOE agent */ + list_for_each_entry(grp, &curagent->groups, list) { + list_for_each_entry_safe(ph, phback, &grp->phs, list) { + list_for_each_entry(msg, &curmsgs, list) { + if (strcmp(msg->id, ph->id) == 0) { + if (msg->group != NULL) { + memprintf(err, "SPOE message '%s' already belongs to " + "the SPOE group '%s' declare at %s:%d", + msg->id, msg->group->id, + msg->group->conf.file, + msg->group->conf.line); + goto error; + } + + /* Scope for arguments are not checked for now. We will check + * them only if a rule use the corresponding SPOE group. */ + msg->agent = curagent; + msg->group = grp; + LIST_DELETE(&ph->list); + LIST_APPEND(&grp->messages, &msg->by_grp); + goto next_mph_grp; + } + } + memprintf(err, "SPOE group '%s' try to use undefined SPOE message '%s' at %s:%d", + grp->id, ph->id, curagent->conf.file, curagent->conf.line); + goto error; + next_mph_grp: + continue; + } + } + + finish: + /* move curmsgs to the agent message list */ + curmsgs.n->p = &curagent->messages; + curmsgs.p->n = &curagent->messages; + curagent->messages = curmsgs; + LIST_INIT(&curmsgs); + + conf->id = strdup(engine ? engine : curagent->id); + conf->agent = curagent; + curagent->spoe_conf = conf; + + /* Start agent's proxy initialization here. It will be finished during + * the filter init. */ + memset(&conf->agent_fe, 0, sizeof(conf->agent_fe)); + init_new_proxy(&conf->agent_fe); + conf->agent_fe.id = conf->agent->id; + conf->agent_fe.parent = conf->agent; + conf->agent_fe.options |= curpxopts; + conf->agent_fe.options2 |= curpxopts2; + + list_for_each_entry_safe(logger, loggerback, &curloggers, list) { + LIST_DELETE(&logger->list); + LIST_APPEND(&conf->agent_fe.loggers, &logger->list); + } + + list_for_each_entry_safe(ph, phback, &curmphs, list) { + LIST_DELETE(&ph->list); + spoe_release_placeholder(ph); + } + list_for_each_entry_safe(ph, phback, &curgphs, list) { + LIST_DELETE(&ph->list); + spoe_release_placeholder(ph); + } + list_for_each_entry_safe(vph, vphback, &curvars, list) { + struct arg arg; + + trash.data = snprintf(trash.area, trash.size, "proc.%s.%s", + curagent->var_pfx, vph->name); + + arg.type = ARGT_STR; + arg.data.str.area = trash.area; + arg.data.str.data = trash.data; + arg.data.str.size = 0; /* Set it to 0 to not release it in vars_check_arg() */ + if (!vars_check_arg(&arg, err)) { + memprintf(err, "SPOE agent '%s': failed to register variable %s.%s (%s)", + curagent->id, curagent->var_pfx, vph->name, *err); + goto error; + } + + LIST_DELETE(&vph->list); + free(vph->name); + free(vph); + } + list_for_each_entry_safe(grp, grpback, &curgrps, list) { + LIST_DELETE(&grp->list); + spoe_release_group(grp); + } + *cur_arg = pos; + fconf->id = spoe_filter_id; + fconf->ops = &spoe_ops; + fconf->conf = conf; + return 0; + + error: + spoe_release_agent(curagent); + list_for_each_entry_safe(ph, phback, &curmphs, list) { + LIST_DELETE(&ph->list); + spoe_release_placeholder(ph); + } + list_for_each_entry_safe(ph, phback, &curgphs, list) { + LIST_DELETE(&ph->list); + spoe_release_placeholder(ph); + } + list_for_each_entry_safe(vph, vphback, &curvars, list) { + LIST_DELETE(&vph->list); + free(vph->name); + free(vph); + } + list_for_each_entry_safe(grp, grpback, &curgrps, list) { + LIST_DELETE(&grp->list); + spoe_release_group(grp); + } + list_for_each_entry_safe(msg, msgback, &curmsgs, list) { + LIST_DELETE(&msg->list); + spoe_release_message(msg); + } + list_for_each_entry_safe(logger, loggerback, &curloggers, list) { + LIST_DELETE(&logger->list); + free(logger); + } + free(conf); + return -1; +} + +/* Send message of a SPOE group. This is the action_ptr callback of a rule + * associated to a "send-spoe-group" action. + * + * It returns ACT_RET_CONT if processing is finished (with error or not), it returns + * ACT_RET_YIELD if the action is in progress. */ +static enum act_return +spoe_send_group(struct act_rule *rule, struct proxy *px, + struct session *sess, struct stream *s, int flags) +{ + struct filter *filter; + struct spoe_agent *agent = NULL; + struct spoe_group *group = NULL; + struct spoe_context *ctx = NULL; + int ret, dir; + + list_for_each_entry(filter, &s->strm_flt.filters, list) { + if (filter->config == rule->arg.act.p[0]) { + agent = rule->arg.act.p[2]; + group = rule->arg.act.p[3]; + ctx = filter->ctx; + break; + } + } + if (agent == NULL || group == NULL || ctx == NULL) + return ACT_RET_CONT; + if (ctx->state == SPOE_CTX_ST_NONE) + return ACT_RET_CONT; + + switch (rule->from) { + case ACT_F_TCP_REQ_SES: dir = SMP_OPT_DIR_REQ; break; + case ACT_F_TCP_REQ_CNT: dir = SMP_OPT_DIR_REQ; break; + case ACT_F_TCP_RES_CNT: dir = SMP_OPT_DIR_RES; break; + case ACT_F_HTTP_REQ: dir = SMP_OPT_DIR_REQ; break; + case ACT_F_HTTP_RES: dir = SMP_OPT_DIR_RES; break; + default: + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - internal error while execute spoe-send-group\n", + (int)date.tv_sec, (int)date.tv_usec, agent->id, + __FUNCTION__, s); + send_log(px, LOG_ERR, "SPOE: [%s] internal error while execute spoe-send-group\n", + agent->id); + return ACT_RET_CONT; + } + + ret = spoe_process_group(s, ctx, group, dir); + if (ret == 1) + return ACT_RET_CONT; + else if (ret == 0) { + if (flags & ACT_OPT_FINAL) { + SPOE_PRINTF(stderr, "%d.%06d [SPOE/%-15s] %s: stream=%p" + " - failed to process group '%s': interrupted by caller\n", + (int)date.tv_sec, (int)date.tv_usec, + agent->id, __FUNCTION__, s, group->id); + ctx->status_code = SPOE_CTX_ERR_INTERRUPT; + spoe_stop_processing(agent, ctx); + spoe_handle_processing_error(s, agent, ctx, dir); + return ACT_RET_CONT; + } + return ACT_RET_YIELD; + } + else + return ACT_RET_CONT; +} + +/* Check an "send-spoe-group" action. Here, we'll try to find the real SPOE + * group associated to <rule>. The format of an rule using 'send-spoe-group' + * action should be: + * + * (http|tcp)-(request|response) send-spoe-group <engine-id> <group-id> + * + * So, we'll loop on each configured SPOE filter for the proxy <px> to find the + * SPOE engine matching <engine-id>. And then, we'll try to find the good group + * matching <group-id>. Finally, we'll check all messages referenced by the SPOE + * group. + * + * The function returns 1 in success case, otherwise, it returns 0 and err is + * filled. + */ +static int +check_send_spoe_group(struct act_rule *rule, struct proxy *px, char **err) +{ + struct flt_conf *fconf; + struct spoe_config *conf; + struct spoe_agent *agent = NULL; + struct spoe_group *group; + struct spoe_message *msg; + char *engine_id = rule->arg.act.p[0]; + char *group_id = rule->arg.act.p[1]; + unsigned int where = 0; + + switch (rule->from) { + case ACT_F_TCP_REQ_SES: where = SMP_VAL_FE_SES_ACC; break; + case ACT_F_TCP_REQ_CNT: where = SMP_VAL_FE_REQ_CNT; break; + case ACT_F_TCP_RES_CNT: where = SMP_VAL_BE_RES_CNT; break; + case ACT_F_HTTP_REQ: where = SMP_VAL_FE_HRQ_HDR; break; + case ACT_F_HTTP_RES: where = SMP_VAL_BE_HRS_HDR; break; + default: + memprintf(err, + "internal error, unexpected rule->from=%d, please report this bug!", + rule->from); + goto error; + } + + /* Try to find the SPOE engine by checking all SPOE filters for proxy + * <px> */ + list_for_each_entry(fconf, &px->filter_configs, list) { + conf = fconf->conf; + + /* This is not an SPOE filter */ + if (fconf->id != spoe_filter_id) + continue; + + /* This is the good engine */ + if (strcmp(conf->id, engine_id) == 0) { + agent = conf->agent; + break; + } + } + if (agent == NULL) { + memprintf(err, "unable to find SPOE engine '%s' used by the send-spoe-group '%s'", + engine_id, group_id); + goto error; + } + + /* Try to find the right group */ + list_for_each_entry(group, &agent->groups, list) { + /* This is the good group */ + if (strcmp(group->id, group_id) == 0) + break; + } + if (&group->list == &agent->groups) { + memprintf(err, "unable to find SPOE group '%s' into SPOE engine '%s' configuration", + group_id, engine_id); + goto error; + } + + /* Ok, we found the group, we need to check messages and their + * arguments */ + list_for_each_entry(msg, &group->messages, by_grp) { + struct spoe_arg *arg; + + list_for_each_entry(arg, &msg->args, list) { + if (!(arg->expr->fetch->val & where)) { + memprintf(err, "Invalid SPOE message '%s' used by SPOE group '%s' at %s:%d: " + "some args extract information from '%s'," + "none of which is available here ('%s')", + msg->id, group->id, msg->conf.file, msg->conf.line, + sample_ckp_names(arg->expr->fetch->use), + sample_ckp_names(where)); + goto error; + } + } + } + + free(engine_id); + free(group_id); + rule->arg.act.p[0] = fconf; /* Associate filter config with the rule */ + rule->arg.act.p[1] = conf; /* Associate SPOE config with the rule */ + rule->arg.act.p[2] = agent; /* Associate SPOE agent with the rule */ + rule->arg.act.p[3] = group; /* Associate SPOE group with the rule */ + return 1; + + error: + free(engine_id); + free(group_id); + return 0; +} + +/* Parse 'send-spoe-group' action following the format: + * + * ... send-spoe-group <engine-id> <group-id> + * + * It returns ACT_RET_PRS_ERR if fails and <err> is filled with an error + * message. Otherwise, it returns ACT_RET_PRS_OK and parsing engine and group + * ids are saved and used later, when the rule will be checked. + */ +static enum act_parse_ret +parse_send_spoe_group(const char **args, int *orig_arg, struct proxy *px, + struct act_rule *rule, char **err) +{ + if (!*args[*orig_arg] || !*args[*orig_arg+1] || + (*args[*orig_arg+2] && strcmp(args[*orig_arg+2], "if") != 0 && strcmp(args[*orig_arg+2], "unless") != 0)) { + memprintf(err, "expects 2 arguments: <engine-id> <group-id>"); + return ACT_RET_PRS_ERR; + } + rule->arg.act.p[0] = strdup(args[*orig_arg]); /* Copy the SPOE engine id */ + rule->arg.act.p[1] = strdup(args[*orig_arg+1]); /* Cope the SPOE group id */ + + (*orig_arg) += 2; + + rule->action = ACT_CUSTOM; + rule->action_ptr = spoe_send_group; + rule->check_ptr = check_send_spoe_group; + return ACT_RET_PRS_OK; +} + + +/* Declare the filter parser for "spoe" keyword */ +static struct flt_kw_list flt_kws = { "SPOE", { }, { + { "spoe", parse_spoe_flt, NULL }, + { NULL, NULL, NULL }, + } +}; + +INITCALL1(STG_REGISTER, flt_register_keywords, &flt_kws); + +/* Delcate the action parser for "spoe-action" keyword */ +static struct action_kw_list tcp_req_action_kws = { { }, { + { "send-spoe-group", parse_send_spoe_group }, + { /* END */ }, + } +}; + +INITCALL1(STG_REGISTER, tcp_req_cont_keywords_register, &tcp_req_action_kws); + +static struct action_kw_list tcp_res_action_kws = { { }, { + { "send-spoe-group", parse_send_spoe_group }, + { /* END */ }, + } +}; + +INITCALL1(STG_REGISTER, tcp_res_cont_keywords_register, &tcp_res_action_kws); + +static struct action_kw_list http_req_action_kws = { { }, { + { "send-spoe-group", parse_send_spoe_group }, + { /* END */ }, + } +}; + +INITCALL1(STG_REGISTER, http_req_keywords_register, &http_req_action_kws); + +static struct action_kw_list http_res_action_kws = { { }, { + { "send-spoe-group", parse_send_spoe_group }, + { /* END */ }, + } +}; + +INITCALL1(STG_REGISTER, http_res_keywords_register, &http_res_action_kws); |