You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
224 lines
9.4 KiB
224 lines
9.4 KiB
5 months ago
|
/*
|
||
|
|
* include/haproxy/applet-t.h
|
||
|
|
* This file describes the applet struct and associated constants.
|
||
|
|
*
|
||
|
|
* Copyright (C) 2000-2020 Willy Tarreau - w@1wt.eu
|
||
|
|
*
|
||
|
|
* This library is free software; you can redistribute it and/or
|
||
|
|
* modify it under the terms of the GNU Lesser General Public
|
||
|
|
* License as published by the Free Software Foundation, version 2.1
|
||
|
|
* exclusively.
|
||
|
|
*
|
||
|
|
* This library is distributed in the hope that it will be useful,
|
||
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||
|
|
* Lesser General Public License for more details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU Lesser General Public
|
||
|
|
* License along with this library; if not, write to the Free Software
|
||
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef _HAPROXY_APPLET_T_H
|
||
|
|
#define _HAPROXY_APPLET_T_H
|
||
|
|
|
||
|
|
#include <haproxy/api-t.h>
|
||
|
|
#include <haproxy/buf-t.h>
|
||
|
|
#include <haproxy/dynbuf-t.h>
|
||
|
|
#include <haproxy/freq_ctr-t.h>
|
||
|
|
#include <haproxy/hlua-t.h>
|
||
|
|
#include <haproxy/obj_type-t.h>
|
||
|
|
#include <haproxy/proxy-t.h>
|
||
|
|
#include <haproxy/stream-t.h>
|
||
|
|
#include <haproxy/xref-t.h>
|
||
|
|
|
||
|
|
#include <nuster/common.h>
|
||
|
|
|
||
|
|
/* flags for appctx->state */
|
||
|
|
#define APPLET_WANT_DIE 0x01 /* applet was running and requested to die */
|
||
|
|
|
||
|
|
struct appctx;
|
||
|
|
|
||
|
|
/* Applet descriptor */
|
||
|
|
struct applet {
|
||
|
|
enum obj_type obj_type; /* object type = OBJ_TYPE_APPLET */
|
||
|
|
/* 3 unused bytes here */
|
||
|
|
char *name; /* applet's name to report in logs */
|
||
|
|
int (*init)(struct appctx *, struct proxy *px, struct stream *strm); /* callback to init resources, may be NULL.
|
||
|
|
expect 1 if ok, 0 if an error occurs, -1 if miss data. */
|
||
|
|
void (*fct)(struct appctx *); /* internal I/O handler, may never be NULL */
|
||
|
|
void (*release)(struct appctx *); /* callback to release resources, may be NULL */
|
||
|
|
unsigned int timeout; /* execution timeout. */
|
||
|
|
};
|
||
|
|
|
||
|
|
/* Context of a running applet. */
|
||
|
|
struct appctx {
|
||
|
|
enum obj_type obj_type; /* OBJ_TYPE_APPCTX */
|
||
|
|
/* 3 unused bytes here */
|
||
|
|
unsigned short state; /* Internal appctx state */
|
||
|
|
unsigned int st0; /* CLI state for stats, session state for peers */
|
||
|
|
unsigned int st1; /* prompt/payload (bitwise OR of APPCTX_CLI_ST1_*) for stats, session error for peers */
|
||
|
|
struct buffer *chunk; /* used to store unfinished commands */
|
||
|
|
unsigned int st2; /* output state for stats, unused by peers */
|
||
|
|
struct applet *applet; /* applet this context refers to */
|
||
|
|
void *owner; /* pointer to upper layer's entity (eg: stream interface) */
|
||
|
|
struct act_rule *rule; /* rule associated with the applet. */
|
||
|
|
int (*io_handler)(struct appctx *appctx); /* used within the cli_io_handler when st0 = CLI_ST_CALLBACK */
|
||
|
|
void (*io_release)(struct appctx *appctx); /* used within the cli_io_handler when st0 = CLI_ST_CALLBACK,
|
||
|
|
if the command is terminated or the session released */
|
||
|
|
int cli_severity_output; /* used within the cli_io_handler to format severity output of informational feedback */
|
||
|
|
int cli_level; /* the level of CLI which can be lowered dynamically */
|
||
|
|
struct buffer_wait buffer_wait; /* position in the list of objects waiting for a buffer */
|
||
|
|
unsigned long thread_mask; /* mask of thread IDs authorized to process the applet */
|
||
|
|
struct task *t; /* task associated to the applet */
|
||
|
|
struct freq_ctr call_rate; /* appctx call rate */
|
||
|
|
struct list wait_entry; /* entry in a list of waiters for an event (e.g. ring events) */
|
||
|
|
|
||
|
|
union {
|
||
|
|
union {
|
||
|
|
union {
|
||
|
|
struct {
|
||
|
|
struct nst_memory_object *obj;
|
||
|
|
struct nst_memory_item *item;
|
||
|
|
} memory;
|
||
|
|
struct {
|
||
|
|
int fd;
|
||
|
|
int header_len;
|
||
|
|
uint64_t payload_len;
|
||
|
|
uint64_t offset;
|
||
|
|
} disk;
|
||
|
|
} store;
|
||
|
|
struct {
|
||
|
|
struct nst_dict *dict;
|
||
|
|
uint64_t idx;
|
||
|
|
struct buffer buf;
|
||
|
|
struct ist name;
|
||
|
|
struct ist host;
|
||
|
|
struct ist path;
|
||
|
|
struct my_regex *regex;
|
||
|
|
} manager;
|
||
|
|
} nuster;
|
||
|
|
struct {
|
||
|
|
void *ptr; /* current peer or NULL, do not use for something else */
|
||
|
|
} peers; /* used by the peers applet */
|
||
|
|
struct {
|
||
|
|
int connected;
|
||
|
|
struct xref xref; /* cross reference with the Lua object owner. */
|
||
|
|
struct list wake_on_read;
|
||
|
|
struct list wake_on_write;
|
||
|
|
int die;
|
||
|
|
} hlua_cosocket; /* used by the Lua cosockets */
|
||
|
|
struct {
|
||
|
|
struct hlua *hlua;
|
||
|
|
int flags;
|
||
|
|
struct task *task;
|
||
|
|
} hlua_apptcp; /* used by the Lua TCP services */
|
||
|
|
struct {
|
||
|
|
struct hlua *hlua;
|
||
|
|
int left_bytes; /* The max amount of bytes that we can read. */
|
||
|
|
int flags;
|
||
|
|
int status;
|
||
|
|
const char *reason;
|
||
|
|
struct task *task;
|
||
|
|
} hlua_apphttp; /* used by the Lua HTTP services */
|
||
|
|
struct {
|
||
|
|
void *ptr; /* private pointer for SPOE filter */
|
||
|
|
} spoe; /* used by SPOE filter */
|
||
|
|
struct {
|
||
|
|
const char *msg; /* pointer to a persistent message to be returned in CLI_ST_PRINT state */
|
||
|
|
int severity; /* severity of the message to be returned according to (syslog) rfc5424 */
|
||
|
|
char *err; /* pointer to a 'must free' message to be returned in CLI_ST_PRINT_FREE state */
|
||
|
|
void *p0, *p1, *p2; /* ...registered commands, initialized to 0 by the CLI before first... */
|
||
|
|
size_t o0, o1; /* ...invocation of the keyword parser, except for the list element which... */
|
||
|
|
int i0, i1; /* ...is initialized with LIST_INIT(). */
|
||
|
|
} cli; /* context used by the CLI */
|
||
|
|
struct {
|
||
|
|
struct cache_entry *entry; /* Entry to be sent from cache. */
|
||
|
|
unsigned int sent; /* The number of bytes already sent for this cache entry. */
|
||
|
|
unsigned int offset; /* start offset of remaining data relative to beginning of the next block */
|
||
|
|
unsigned int rem_data; /* Remaining bytes for the last data block (HTX only, 0 means process next block) */
|
||
|
|
unsigned int send_notmodified:1; /* In case of conditional request, we might want to send a "304 Not Modified"
|
||
|
|
* response instead of the stored data. */
|
||
|
|
unsigned int unused:31;
|
||
|
|
struct shared_block *next; /* The next block of data to be sent for this cache entry. */
|
||
|
|
} cache;
|
||
|
|
/* all entries below are used by various CLI commands, please
|
||
|
|
* keep the grouped together and avoid adding new ones.
|
||
|
|
*/
|
||
|
|
struct {
|
||
|
|
void *obj1; /* context pointer used in stats dump */
|
||
|
|
void *obj2; /* context pointer used in stats dump */
|
||
|
|
uint32_t domain; /* set the stats to used, for now only proxy stats are supported */
|
||
|
|
int scope_str; /* limit scope to a frontend/backend substring */
|
||
|
|
int scope_len; /* length of the string above in the buffer */
|
||
|
|
int px_st; /* STAT_PX_ST* */
|
||
|
|
unsigned int flags; /* STAT_* */
|
||
|
|
int iid, type, sid; /* proxy id, type and service id if bounding of stats is enabled */
|
||
|
|
int st_code; /* the status code returned by an action */
|
||
|
|
} stats;
|
||
|
|
struct {
|
||
|
|
struct bref bref; /* back-reference from the session being dumped */
|
||
|
|
void *target; /* session we want to dump, or NULL for all */
|
||
|
|
unsigned int uid; /* if non-null, the uniq_id of the session being dumped */
|
||
|
|
int section; /* section of the session being dumped */
|
||
|
|
int pos; /* last position of the current session's buffer */
|
||
|
|
} sess;
|
||
|
|
struct {
|
||
|
|
int iid; /* if >= 0, ID of the proxy to filter on */
|
||
|
|
struct proxy *px; /* current proxy being dumped, NULL = not started yet. */
|
||
|
|
unsigned int flag; /* bit0: buffer being dumped, 0 = req, 1 = resp ; bit1=skip req ; bit2=skip resp. */
|
||
|
|
unsigned int ev_id; /* event ID of error being dumped */
|
||
|
|
int ptr; /* <0: headers, >=0 : text pointer to restart from */
|
||
|
|
int bol; /* pointer to beginning of current line */
|
||
|
|
} errors;
|
||
|
|
struct {
|
||
|
|
void *target; /* table we want to dump, or NULL for all */
|
||
|
|
struct stktable *t; /* table being currently dumped (first if NULL) */
|
||
|
|
struct stksess *entry; /* last entry we were trying to dump (or first if NULL) */
|
||
|
|
long long value[STKTABLE_FILTER_LEN]; /* value to compare against */
|
||
|
|
signed char data_type[STKTABLE_FILTER_LEN]; /* type of data to compare, or -1 if none */
|
||
|
|
signed char data_op[STKTABLE_FILTER_LEN]; /* operator (STD_OP_*) when data_type set */
|
||
|
|
char action; /* action on the table : one of STK_CLI_ACT_* */
|
||
|
|
} table;
|
||
|
|
struct {
|
||
|
|
unsigned int display_flags;
|
||
|
|
struct pat_ref *ref;
|
||
|
|
struct bref bref; /* back-reference from the pat_ref_elt being dumped */
|
||
|
|
struct pattern_expr *expr;
|
||
|
|
struct buffer chunk;
|
||
|
|
} map;
|
||
|
|
struct {
|
||
|
|
struct hlua *hlua;
|
||
|
|
struct task *task;
|
||
|
|
struct hlua_function *fcn;
|
||
|
|
} hlua_cli;
|
||
|
|
struct {
|
||
|
|
void *target;
|
||
|
|
struct peers *peers; /* "peers" section being currently dumped. */
|
||
|
|
struct peer *peer; /* "peer" being currently dumped. */
|
||
|
|
} cfgpeers;
|
||
|
|
struct {
|
||
|
|
char *path;
|
||
|
|
struct ckch_store *old_ckchs;
|
||
|
|
struct ckch_store *new_ckchs;
|
||
|
|
struct ckch_inst *next_ckchi;
|
||
|
|
} ssl;
|
||
|
|
struct {
|
||
|
|
void *ptr;
|
||
|
|
} sft; /* sink forward target */
|
||
|
|
|
||
|
|
/* NOTE: please add regular applet contexts (ie: not
|
||
|
|
* CLI-specific ones) above, before "cli".
|
||
|
|
*/
|
||
|
|
} ctx; /* context-specific variables used by any applet */
|
||
|
|
};
|
||
|
|
|
||
|
|
#endif /* _HAPROXY_APPLET_T_H */
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Local variables:
|
||
|
|
* c-indent-level: 8
|
||
|
|
* c-basic-offset: 8
|
||
|
|
* End:
|
||
|
|
*/
|