1 /* 2 * include/types/arg.h 3 * This file contains structure declarations for generaic argument parsing. 4 * 5 * Copyright 2012 Willy Tarreau <w@1wt.eu> 6 * 7 * This library is free software; you can redistribute it and/or 8 * modify it under the terms of the GNU Lesser General Public 9 * License as published by the Free Software Foundation, version 2.1 10 * exclusively. 11 * 12 * This library is distributed in the hope that it will be useful, 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 15 * Lesser General Public License for more details. 16 * 17 * You should have received a copy of the GNU Lesser General Public 18 * License along with this library; if not, write to the Free Software 19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 20 */ 21 22 #ifndef _TYPES_ARG_H 23 #define _TYPES_ARG_H 24 25 #include <sys/socket.h> 26 #include <netinet/in.h> 27 28 #include <common/chunk.h> 29 #include <common/mini-clist.h> 30 31 #include <types/vars.h> 32 33 /* encoding of each arg type : up to 31 types are supported */ 34 #define ARGT_BITS 5 35 #define ARGT_NBTYPES (1 << ARGT_BITS) 36 #define ARGT_MASK (ARGT_NBTYPES - 1) 37 38 /* encoding of the arg count : up to 12 args are possible. 4 bits are left 39 * unused at the top. 40 */ 41 #define ARGM_MASK ((1 << ARGM_BITS) - 1) 42 #define ARGM_BITS 4 43 #define ARGM_NBARGS (sizeof(uint64_t) * 8 - ARGM_BITS) / ARGT_BITS 44 45 enum { 46 ARGT_STOP = 0, /* end of the arg list */ 47 ARGT_SINT, /* signed 64 bit integer. */ 48 ARGT_STR, /* string */ 49 ARGT_IPV4, /* an IPv4 address */ 50 ARGT_MSK4, /* an IPv4 address mask (integer or dotted), stored as ARGT_IPV4 */ 51 ARGT_IPV6, /* an IPv6 address */ 52 ARGT_MSK6, /* an IPv6 address mask (integer or dotted), stored as ARGT_IPV6 */ 53 ARGT_TIME, /* a delay in ms by default, stored as ARGT_UINT */ 54 ARGT_SIZE, /* a size in bytes by default, stored as ARGT_UINT */ 55 ARGT_FE, /* a pointer to a frontend only */ 56 ARGT_BE, /* a pointer to a backend only */ 57 ARGT_TAB, /* a pointer to a stick table */ 58 ARGT_SRV, /* a pointer to a server */ 59 ARGT_USR, /* a pointer to a user list */ 60 ARGT_MAP, /* a pointer to a map descriptor */ 61 ARGT_REG, /* a pointer to a regex */ 62 ARGT_VAR, /* contains a variable description. */ 63 /* please update arg_type_names[] in args.c if you add entries here */ 64 }; 65 66 /* context where arguments are used, in order to help error reporting */ 67 enum { 68 ARGC_ACL = 0, /* ACL */ 69 ARGC_STK, /* sticking rule */ 70 ARGC_TRK, /* tracking rule */ 71 ARGC_LOG, /* log-format */ 72 ARGC_LOGSD, /* log-format-sd */ 73 ARGC_HRQ, /* http-request */ 74 ARGC_HRS, /* http-response */ 75 ARGC_UIF, /* unique-id-format */ 76 ARGC_RDR, /* redirect */ 77 ARGC_CAP, /* capture rule */ 78 ARGC_SRV, /* server line */ 79 ARGC_SPOE, /* spoe message args */ 80 ARGC_UBK, /* use_backend message */ 81 }; 82 83 /* flags used when compiling and executing regex */ 84 #define ARGF_REG_ICASE 1 85 #define ARGF_REG_GLOB 2 86 87 /* some types that are externally defined */ 88 struct proxy; 89 struct server; 90 struct userlist; 91 struct my_regex; 92 93 union arg_data { 94 long long int sint; 95 struct chunk str; 96 struct in_addr ipv4; 97 struct in6_addr ipv6; 98 struct proxy *prx; /* used for fe, be, tables */ 99 struct server *srv; 100 struct userlist *usr; 101 struct map_descriptor *map; 102 struct my_regex *reg; 103 struct var_desc var; 104 }; 105 106 struct arg { 107 unsigned char type; /* argument type, ARGT_* */ 108 unsigned char unresolved; /* argument contains a string in <str> that must be resolved and freed */ 109 unsigned char type_flags; /* type-specific extra flags (eg: case sensitivity for regex), ARGF_* */ 110 union arg_data data; /* argument data */ 111 }; 112 113 /* arg lists are used to store information about arguments that could not be 114 * resolved when parsing the configuration. The head is an arg_list which 115 * serves as a template to create new entries. Nothing here is allocated, 116 * so plain copies are OK. 117 */ 118 struct arg_list { 119 struct list list; /* chaining with other arg_list, or list head */ 120 struct arg *arg; /* pointer to the arg, NULL on list head */ 121 int arg_pos; /* argument position */ 122 int ctx; /* context where the arg is used (ARGC_*) */ 123 const char *kw; /* keyword making use of these args */ 124 const char *conv; /* conv keyword when in conv, otherwise NULL */ 125 const char *file; /* file name where the args are referenced */ 126 int line; /* line number where the args are referenced */ 127 }; 128 129 #endif /* _TYPES_ARG_H */ 130 131 /* 132 * Local variables: 133 * c-indent-level: 8 134 * c-basic-offset: 8 135 * End: 136 */ 137