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.
144 lines
4.9 KiB
144 lines
4.9 KiB
/*
|
|
* include/haproxy/arg-t.h
|
|
* This file contains structure declarations for generaic argument parsing.
|
|
*
|
|
* Copyright 2012 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_ARG_T_H
|
|
#define _HAPROXY_ARG_T_H
|
|
|
|
#include <sys/socket.h>
|
|
#include <netinet/in.h>
|
|
|
|
#include <haproxy/buf-t.h>
|
|
#include <haproxy/protobuf-t.h>
|
|
#include <haproxy/stick_table-t.h>
|
|
#include <haproxy/vars-t.h>
|
|
|
|
/* encoding of each arg type : up to 31 types are supported */
|
|
#define ARGT_BITS 5
|
|
#define ARGT_NBTYPES (1 << ARGT_BITS)
|
|
#define ARGT_MASK (ARGT_NBTYPES - 1)
|
|
|
|
/* encoding of the arg count : up to 12 args are possible. 4 bits are left
|
|
* unused at the top.
|
|
*/
|
|
#define ARGM_MASK ((1 << ARGM_BITS) - 1)
|
|
#define ARGM_BITS 4
|
|
#define ARGM_NBARGS (sizeof(uint64_t) * 8 - ARGM_BITS) / ARGT_BITS
|
|
|
|
enum {
|
|
ARGT_STOP = 0, /* end of the arg list */
|
|
ARGT_SINT, /* signed 64 bit integer. */
|
|
ARGT_STR, /* string */
|
|
ARGT_IPV4, /* an IPv4 address */
|
|
ARGT_MSK4, /* an IPv4 address mask (integer or dotted), stored as ARGT_IPV4 */
|
|
ARGT_IPV6, /* an IPv6 address */
|
|
ARGT_MSK6, /* an IPv6 address mask (integer or dotted), stored as ARGT_IPV6 */
|
|
ARGT_TIME, /* a delay in ms by default, stored as ARGT_UINT */
|
|
ARGT_SIZE, /* a size in bytes by default, stored as ARGT_UINT */
|
|
ARGT_FE, /* a pointer to a frontend only */
|
|
ARGT_BE, /* a pointer to a backend only */
|
|
ARGT_TAB, /* a pointer to a stick table */
|
|
ARGT_SRV, /* a pointer to a server */
|
|
ARGT_USR, /* a pointer to a user list */
|
|
ARGT_MAP, /* a pointer to a map descriptor */
|
|
ARGT_REG, /* a pointer to a regex */
|
|
ARGT_VAR, /* contains a variable description. */
|
|
ARGT_PBUF_FNUM, /* a protocol buffer field number */
|
|
ARGT_PTR, /* a pointer to opaque data */
|
|
/* please update arg_type_names[] in args.c if you add entries here */
|
|
};
|
|
|
|
/* context where arguments are used, in order to help error reporting */
|
|
enum {
|
|
ARGC_ACL = 0, /* ACL */
|
|
ARGC_STK, /* sticking rule */
|
|
ARGC_TRK, /* tracking rule */
|
|
ARGC_LOG, /* log-format */
|
|
ARGC_LOGSD, /* log-format-sd */
|
|
ARGC_HRQ, /* http-request */
|
|
ARGC_HRS, /* http-response */
|
|
ARGC_UIF, /* unique-id-format */
|
|
ARGC_RDR, /* redirect */
|
|
ARGC_CAP, /* capture rule */
|
|
ARGC_SRV, /* server line */
|
|
ARGC_SPOE, /* spoe message args */
|
|
ARGC_UBK, /* use_backend message */
|
|
ARGC_USRV, /* use-server message */
|
|
ARGC_HERR, /* http-error */
|
|
ARGC_OT, /* opentracing scope args */
|
|
};
|
|
|
|
/* flags used when compiling and executing regex */
|
|
#define ARGF_REG_ICASE 1
|
|
#define ARGF_REG_GLOB 2
|
|
|
|
/* some types that are externally defined */
|
|
struct proxy;
|
|
struct server;
|
|
struct userlist;
|
|
struct my_regex;
|
|
|
|
union arg_data {
|
|
long long int sint;
|
|
struct buffer str;
|
|
struct in_addr ipv4;
|
|
struct in6_addr ipv6;
|
|
struct proxy *prx; /* used for fe, be, tables */
|
|
struct server *srv;
|
|
struct stktable *t;
|
|
struct userlist *usr;
|
|
struct map_descriptor *map;
|
|
struct my_regex *reg;
|
|
struct pbuf_fid fid;
|
|
struct var_desc var;
|
|
void *ptr;
|
|
};
|
|
|
|
struct arg {
|
|
unsigned char type; /* argument type, ARGT_* */
|
|
unsigned char unresolved; /* argument contains a string in <str> that must be resolved and freed */
|
|
unsigned char type_flags; /* type-specific extra flags (eg: case sensitivity for regex), ARGF_* */
|
|
union arg_data data; /* argument data */
|
|
};
|
|
|
|
/* arg lists are used to store information about arguments that could not be
|
|
* resolved when parsing the configuration. The head is an arg_list which
|
|
* serves as a template to create new entries. Nothing here is allocated,
|
|
* so plain copies are OK.
|
|
*/
|
|
struct arg_list {
|
|
struct list list; /* chaining with other arg_list, or list head */
|
|
struct arg *arg; /* pointer to the arg, NULL on list head */
|
|
int arg_pos; /* argument position */
|
|
int ctx; /* context where the arg is used (ARGC_*) */
|
|
const char *kw; /* keyword making use of these args */
|
|
const char *conv; /* conv keyword when in conv, otherwise NULL */
|
|
const char *file; /* file name where the args are referenced */
|
|
int line; /* line number where the args are referenced */
|
|
};
|
|
|
|
#endif /* _HAPROXY_ARG_T_H */
|
|
|
|
/*
|
|
* Local variables:
|
|
* c-indent-level: 8
|
|
* c-basic-offset: 8
|
|
* End:
|
|
*/
|
|
|