1 /* 2 * BIRD Internet Routing Daemon -- Configuration File Handling 3 * 4 * (c) 1998--2000 Martin Mares <mj@ucw.cz> 5 * 6 * Can be freely distributed and used under the terms of the GNU GPL. 7 */ 8 9 #ifndef _BIRD_CONF_H_ 10 #define _BIRD_CONF_H_ 11 12 #include "sysdep/config.h" 13 #include "lib/ip.h" 14 #include "lib/hash.h" 15 #include "lib/resource.h" 16 #include "lib/timer.h" 17 18 /* Configuration structure */ 19 20 struct config { 21 pool *pool; /* Pool the configuration is stored in */ 22 linpool *mem; /* Linear pool containing configuration data */ 23 list protos; /* Configured protocol instances (struct proto_config) */ 24 list tables; /* Configured routing tables (struct rtable_config) */ 25 list logfiles; /* Configured log files (sysdep) */ 26 list tests; /* Configured unit tests (f_bt_test_suite) */ 27 list symbols; /* Configured symbols in config order */ 28 29 int mrtdump_file; /* Configured MRTDump file (sysdep, fd in unix) */ 30 const char *syslog_name; /* Name used for syslog (NULL -> no syslog) */ 31 struct rtable_config *def_tables[NET_MAX]; /* Default routing tables for each network */ 32 struct iface_patt *router_id_from; /* Configured list of router ID iface patterns */ 33 34 u32 router_id; /* Our Router ID */ 35 u32 proto_default_debug; /* Default protocol debug mask */ 36 u32 proto_default_mrtdump; /* Default protocol mrtdump mask */ 37 u32 channel_default_debug; /* Default channel debug mask */ 38 struct timeformat tf_route; /* Time format for 'show route' */ 39 struct timeformat tf_proto; /* Time format for 'show protocol' */ 40 struct timeformat tf_log; /* Time format for the logfile */ 41 struct timeformat tf_base; /* Time format for other purposes */ 42 u32 gr_wait; /* Graceful restart wait timeout (sec) */ 43 const char *hostname; /* Hostname */ 44 45 int cli_debug; /* Tracing of CLI connections and commands */ 46 int latency_debug; /* I/O loop tracks duration of each event */ 47 u32 latency_limit; /* Events with longer duration are logged (us) */ 48 u32 watchdog_warning; /* I/O loop watchdog limit for warning (us) */ 49 u32 watchdog_timeout; /* Watchdog timeout (in seconds, 0 = disabled) */ 50 char *err_msg; /* Parser error message */ 51 int err_lino; /* Line containing error */ 52 int err_chno; /* Character where the parser stopped */ 53 char *err_file_name; /* File name containing error */ 54 char *file_name; /* Name of main configuration file */ 55 int file_fd; /* File descriptor of main configuration file */ 56 HASH(struct symbol) sym_hash; /* Lexer: symbol hash table */ 57 struct config *fallback; /* Link to regular config for CLI parsing */ 58 struct sym_scope *root_scope; /* Scope for root symbols */ 59 int obstacle_count; /* Number of items blocking freeing of this config */ 60 int shutdown; /* This is a pseudo-config for daemon shutdown */ 61 int gr_down; /* This is a pseudo-config for graceful restart */ 62 btime load_time; /* When we've got this configuration */ 63 }; 64 65 /* Please don't use these variables in protocols. Use proto_config->global instead. */ 66 extern struct config *config; /* Currently active configuration */ 67 extern struct config *new_config; /* Configuration being parsed */ 68 69 struct config *config_alloc(const char *name); 70 int config_parse(struct config *); 71 int cli_parse(struct config *); 72 void config_free(struct config *); 73 int config_commit(struct config *, int type, uint timeout); 74 int config_confirm(void); 75 int config_undo(void); 76 int config_status(void); 77 btime config_timer_status(void); 78 void config_init(void); 79 void cf_error(const char *msg, ...) NORET; 80 void config_add_obstacle(struct config *); 81 void config_del_obstacle(struct config *); 82 void order_shutdown(int gr); 83 84 #define RECONFIG_NONE 0 85 #define RECONFIG_HARD 1 86 #define RECONFIG_SOFT 2 87 #define RECONFIG_UNDO 3 88 89 #define CONF_DONE 0 90 #define CONF_PROGRESS 1 91 #define CONF_QUEUED 2 92 #define CONF_UNQUEUED 3 93 #define CONF_CONFIRM 4 94 #define CONF_SHUTDOWN -1 95 #define CONF_NOTHING -2 96 97 98 /* Pools */ 99 100 extern linpool *cfg_mem; 101 102 #define cfg_alloc(size) lp_alloc(cfg_mem, size) 103 #define cfg_allocu(size) lp_allocu(cfg_mem, size) 104 #define cfg_allocz(size) lp_allocz(cfg_mem, size) 105 char *cfg_strdup(const char *c); 106 void cfg_copy_list(list *dest, list *src, unsigned node_size); 107 108 /* Lexer */ 109 110 extern int (*cf_read_hook)(byte *buf, uint max, int fd); 111 112 struct symbol { 113 node n; /* In list of symbols in config */ 114 struct symbol *next; 115 struct sym_scope *scope; 116 int class; /* SYM_* */ 117 uint flags; /* SYM_FLAG_* */ 118 119 union { 120 struct proto_config *proto; /* For SYM_PROTO and SYM_TEMPLATE */ 121 const struct f_line *function; /* For SYM_FUNCTION */ 122 const struct filter *filter; /* For SYM_FILTER */ 123 struct rtable_config *table; /* For SYM_TABLE */ 124 struct f_dynamic_attr *attribute; /* For SYM_ATTRIBUTE */ 125 struct f_val *val; /* For SYM_CONSTANT */ 126 uint offset; /* For SYM_VARIABLE */ 127 }; 128 129 char name[0]; 130 }; 131 132 struct sym_scope { 133 struct sym_scope *next; /* Next on scope stack */ 134 struct symbol *name; /* Name of this scope */ 135 uint slots; /* Variable slots */ 136 int active; /* Currently entered */ 137 }; 138 139 #define SYM_MAX_LEN 64 140 141 /* Remember to update cf_symbol_class_name() */ 142 #define SYM_VOID 0 143 #define SYM_PROTO 1 144 #define SYM_TEMPLATE 2 145 #define SYM_FUNCTION 3 146 #define SYM_FILTER 4 147 #define SYM_TABLE 5 148 #define SYM_ATTRIBUTE 6 149 150 #define SYM_VARIABLE 0x100 /* 0x100-0x1ff are variable types */ 151 #define SYM_VARIABLE_RANGE SYM_VARIABLE ... (SYM_VARIABLE | 0xff) 152 #define SYM_CONSTANT 0x200 /* 0x200-0x2ff are variable types */ 153 #define SYM_CONSTANT_RANGE SYM_CONSTANT ... (SYM_CONSTANT | 0xff) 154 155 #define SYM_TYPE(s) ((s)->val->type) 156 #define SYM_VAL(s) ((s)->val->val) 157 158 /* Symbol flags */ 159 #define SYM_FLAG_SAME 0x1 /* For SYM_FUNCTION and SYM_FILTER */ 160 161 struct include_file_stack { 162 void *buffer; /* Internal lexer state */ 163 char *file_name; /* File name */ 164 int fd; /* File descriptor */ 165 int lino; /* Current line num */ 166 int chno; /* Current char num (on current line) */ 167 int toklen; /* Current token length */ 168 int depth; /* Include depth, 0 = cannot include */ 169 170 struct include_file_stack *prev; /* Previous record in stack */ 171 struct include_file_stack *up; /* Parent (who included this file) */ 172 }; 173 174 extern struct include_file_stack *ifs; 175 176 extern struct sym_scope *conf_this_scope; 177 178 int cf_lex(void); 179 void cf_lex_init(int is_cli, struct config *c); 180 void cf_lex_unwind(void); 181 182 struct symbol *cf_find_symbol(const struct config *cfg, const byte *c); 183 184 struct symbol *cf_get_symbol(const byte *c); 185 struct symbol *cf_default_name(char *template, int *counter); 186 struct symbol *cf_localize_symbol(struct symbol *sym); 187 188 /** 189 * cf_define_symbol - define meaning of a symbol 190 * @sym: symbol to be defined 191 * @type: symbol class to assign 192 * @def: class dependent data 193 * 194 * Defines new meaning of a symbol. If the symbol is an undefined 195 * one (%SYM_VOID), it's just re-defined to the new type. If it's defined 196 * in different scope, a new symbol in current scope is created and the 197 * meaning is assigned to it. If it's already defined in the current scope, 198 * an error is reported via cf_error(). 199 * 200 * Result: Pointer to the newly defined symbol. If we are in the top-level 201 * scope, it's the same @sym as passed to the function. 202 */ 203 #define cf_define_symbol(osym_, type_, var_, def_) ({ \ 204 struct symbol *sym_ = cf_localize_symbol(osym_); \ 205 sym_->class = type_; \ 206 sym_->var_ = def_; \ 207 sym_; }) 208 209 void cf_push_scope(struct symbol *); 210 void cf_pop_scope(void); 211 char *cf_symbol_class_name(struct symbol *sym); 212 213 /* Parser */ 214 215 extern char *cf_text; 216 int cf_parse(void); 217 218 /* Sysdep hooks */ 219 220 void sysdep_preconfig(struct config *); 221 int sysdep_commit(struct config *, struct config *); 222 void sysdep_shutdown_done(void); 223 224 #endif 225