1998-11-27 19:35:10 +00:00
|
|
|
/*
|
|
|
|
* BIRD Internet Routing Daemon -- Configuration File Handling
|
|
|
|
*
|
2000-01-16 16:44:50 +00:00
|
|
|
* (c) 1998--2000 Martin Mares <mj@ucw.cz>
|
1998-11-27 19:35:10 +00:00
|
|
|
*
|
|
|
|
* Can be freely distributed and used under the terms of the GNU GPL.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _BIRD_CONF_H_
|
|
|
|
#define _BIRD_CONF_H_
|
|
|
|
|
2016-11-09 15:36:34 +00:00
|
|
|
#include "sysdep/config.h"
|
|
|
|
#include "lib/ip.h"
|
2017-05-25 21:30:39 +00:00
|
|
|
#include "lib/hash.h"
|
1998-11-27 19:35:10 +00:00
|
|
|
#include "lib/resource.h"
|
2017-11-28 16:43:20 +00:00
|
|
|
#include "lib/timer.h"
|
1998-11-27 19:35:10 +00:00
|
|
|
|
2011-09-11 19:21:47 +00:00
|
|
|
|
1999-02-05 21:37:34 +00:00
|
|
|
/* Configuration structure */
|
|
|
|
|
|
|
|
struct config {
|
|
|
|
pool *pool; /* Pool the configuration is stored in */
|
|
|
|
linpool *mem; /* Linear pool containing configuration data */
|
|
|
|
list protos; /* Configured protocol instances (struct proto_config) */
|
1999-05-17 20:06:19 +00:00
|
|
|
list tables; /* Configured routing tables (struct rtable_config) */
|
2016-11-08 16:46:29 +00:00
|
|
|
list logfiles; /* Configured log files (sysdep) */
|
2016-11-30 09:21:43 +00:00
|
|
|
list tests; /* Configured unit tests (f_bt_test_suite) */
|
2012-03-18 16:32:30 +00:00
|
|
|
|
2010-01-03 11:17:52 +00:00
|
|
|
int mrtdump_file; /* Configured MRTDump file (sysdep, fd in unix) */
|
2010-04-07 09:00:36 +00:00
|
|
|
char *syslog_name; /* Name used for syslog (NULL -> no syslog) */
|
2016-01-26 10:48:58 +00:00
|
|
|
struct rtable_config *def_tables[NET_MAX]; /* Default routing tables for each network */
|
2012-12-27 11:56:23 +00:00
|
|
|
struct iface_patt *router_id_from; /* Configured list of router ID iface patterns */
|
2019-05-31 19:23:32 +00:00
|
|
|
struct rtable_config *local4;
|
|
|
|
struct rtable_config *local6;
|
2010-01-03 11:17:52 +00:00
|
|
|
|
1999-02-05 21:37:34 +00:00
|
|
|
u32 router_id; /* Our Router ID */
|
2010-01-03 11:17:52 +00:00
|
|
|
unsigned proto_default_debug; /* Default protocol debug mask */
|
|
|
|
unsigned proto_default_mrtdump; /* Default protocol mrtdump mask */
|
2010-02-02 23:19:24 +00:00
|
|
|
struct timeformat tf_route; /* Time format for 'show route' */
|
|
|
|
struct timeformat tf_proto; /* Time format for 'show protocol' */
|
|
|
|
struct timeformat tf_log; /* Time format for the logfile */
|
|
|
|
struct timeformat tf_base; /* Time format for other purposes */
|
2017-06-21 12:43:49 +00:00
|
|
|
u32 gr_wait; /* Graceful restart wait timeout (sec) */
|
2010-02-02 23:19:24 +00:00
|
|
|
|
2000-05-29 22:10:18 +00:00
|
|
|
int cli_debug; /* Tracing of CLI connections and commands */
|
2015-03-02 08:41:14 +00:00
|
|
|
int latency_debug; /* I/O loop tracks duration of each event */
|
|
|
|
u32 latency_limit; /* Events with longer duration are logged (us) */
|
|
|
|
u32 watchdog_warning; /* I/O loop watchdog limit for warning (us) */
|
|
|
|
u32 watchdog_timeout; /* Watchdog timeout (in seconds, 0 = disabled) */
|
1999-02-05 21:37:34 +00:00
|
|
|
char *err_msg; /* Parser error message */
|
|
|
|
int err_lino; /* Line containing error */
|
2011-09-11 19:21:47 +00:00
|
|
|
char *err_file_name; /* File name containing error */
|
|
|
|
char *file_name; /* Name of main configuration file */
|
|
|
|
int file_fd; /* File descriptor of main configuration file */
|
2017-05-25 21:30:39 +00:00
|
|
|
HASH(struct symbol) sym_hash; /* Lexer: symbol hash table */
|
|
|
|
struct config *fallback; /* Link to regular config for CLI parsing */
|
2000-01-16 16:44:50 +00:00
|
|
|
int obstacle_count; /* Number of items blocking freeing of this config */
|
2000-01-16 17:40:26 +00:00
|
|
|
int shutdown; /* This is a pseudo-config for daemon shutdown */
|
2019-06-30 20:15:24 +00:00
|
|
|
int gr_down; /* This is a pseudo-config for graceful restart */
|
2017-06-06 14:47:30 +00:00
|
|
|
btime load_time; /* When we've got this configuration */
|
1999-02-05 21:37:34 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/* Please don't use these variables in protocols. Use proto_config->global instead. */
|
2000-01-16 16:44:50 +00:00
|
|
|
extern struct config *config; /* Currently active configuration */
|
|
|
|
extern struct config *new_config; /* Configuration being parsed */
|
2000-01-16 17:40:26 +00:00
|
|
|
|
2016-11-09 15:36:34 +00:00
|
|
|
struct config *config_alloc(const char *name);
|
1999-02-05 21:37:34 +00:00
|
|
|
int config_parse(struct config *);
|
Parse CLI commands. We use the same parser as for configuration files (because
we want to allow filter and similar complex constructs to be used in commands
and we should avoid code duplication), only with CLI_MARKER token prepended
before the whole input.
Defined macro CF_CLI(cmd, args, help) for defining CLI commands in .Y files.
The first argument specifies the command itself, the remaining two arguments
are copied to the help file (er, will be copied after the help file starts
to exist). This macro automatically creates a skeleton rule for the command,
you only need to append arguments as in:
CF_CLI(STEAL MONEY, <$>, [[Steal <$> US dollars or equivalent in any other currency]]): NUM {
cli_msg(0, "%d$ stolen", $3);
} ;
Also don't forget to reset lexer state between inputs.
1999-10-31 17:47:47 +00:00
|
|
|
int cli_parse(struct config *);
|
1999-02-05 21:37:34 +00:00
|
|
|
void config_free(struct config *);
|
2017-06-21 12:43:49 +00:00
|
|
|
int config_commit(struct config *, int type, uint timeout);
|
2012-12-26 11:40:48 +00:00
|
|
|
int config_confirm(void);
|
|
|
|
int config_undo(void);
|
|
|
|
void config_init(void);
|
2016-03-09 15:48:28 +00:00
|
|
|
void cf_error(const char *msg, ...) NORET;
|
2000-01-16 16:44:50 +00:00
|
|
|
void config_add_obstacle(struct config *);
|
|
|
|
void config_del_obstacle(struct config *);
|
2019-06-30 20:15:24 +00:00
|
|
|
void order_shutdown(int gr);
|
2000-01-16 16:44:50 +00:00
|
|
|
|
2012-12-26 11:40:48 +00:00
|
|
|
#define RECONFIG_NONE 0
|
|
|
|
#define RECONFIG_HARD 1
|
|
|
|
#define RECONFIG_SOFT 2
|
|
|
|
#define RECONFIG_UNDO 3
|
|
|
|
|
|
|
|
#define CONF_DONE 0
|
|
|
|
#define CONF_PROGRESS 1
|
|
|
|
#define CONF_QUEUED 2
|
|
|
|
#define CONF_UNQUEUED 3
|
|
|
|
#define CONF_CONFIRM 4
|
|
|
|
#define CONF_SHUTDOWN -1
|
|
|
|
#define CONF_NOTHING -2
|
|
|
|
|
1999-02-05 21:37:34 +00:00
|
|
|
|
1998-11-29 21:59:37 +00:00
|
|
|
/* Pools */
|
|
|
|
|
1998-12-06 11:59:18 +00:00
|
|
|
extern linpool *cfg_mem;
|
1998-11-27 19:35:10 +00:00
|
|
|
|
1998-12-06 11:59:18 +00:00
|
|
|
#define cfg_alloc(size) lp_alloc(cfg_mem, size)
|
|
|
|
#define cfg_allocu(size) lp_allocu(cfg_mem, size)
|
|
|
|
#define cfg_allocz(size) lp_allocz(cfg_mem, size)
|
2016-11-08 16:46:29 +00:00
|
|
|
char *cfg_strdup(const char *c);
|
2011-11-06 23:31:23 +00:00
|
|
|
void cfg_copy_list(list *dest, list *src, unsigned node_size);
|
1998-11-29 21:59:37 +00:00
|
|
|
|
1998-11-27 19:35:10 +00:00
|
|
|
/* Lexer */
|
|
|
|
|
2015-05-19 06:53:34 +00:00
|
|
|
extern int (*cf_read_hook)(byte *buf, uint max, int fd);
|
1998-11-27 19:35:10 +00:00
|
|
|
|
|
|
|
struct symbol {
|
|
|
|
struct symbol *next;
|
1999-11-04 13:51:52 +00:00
|
|
|
struct sym_scope *scope;
|
1998-11-27 19:35:10 +00:00
|
|
|
int class;
|
1998-11-27 21:32:45 +00:00
|
|
|
int aux;
|
2008-12-25 10:55:27 +00:00
|
|
|
void *aux2;
|
1998-11-27 19:35:10 +00:00
|
|
|
void *def;
|
|
|
|
char name[1];
|
|
|
|
};
|
|
|
|
|
2017-05-25 21:30:39 +00:00
|
|
|
struct sym_scope {
|
|
|
|
struct sym_scope *next; /* Next on scope stack */
|
|
|
|
struct symbol *name; /* Name of this scope */
|
|
|
|
int active; /* Currently entered */
|
|
|
|
};
|
|
|
|
|
2015-02-21 11:42:31 +00:00
|
|
|
#define SYM_MAX_LEN 64
|
|
|
|
|
2000-06-03 16:56:00 +00:00
|
|
|
/* Remember to update cf_symbol_class_name() */
|
1998-11-27 19:35:10 +00:00
|
|
|
#define SYM_VOID 0
|
1998-11-27 21:07:02 +00:00
|
|
|
#define SYM_PROTO 1
|
2013-07-25 20:33:57 +00:00
|
|
|
#define SYM_TEMPLATE 2
|
1999-11-15 11:34:51 +00:00
|
|
|
#define SYM_FUNCTION 3
|
|
|
|
#define SYM_FILTER 4
|
|
|
|
#define SYM_TABLE 5
|
1998-11-27 19:35:10 +00:00
|
|
|
|
1999-11-15 11:34:51 +00:00
|
|
|
#define SYM_VARIABLE 0x100 /* 0x100-0x1ff are variable types */
|
2013-07-25 20:33:57 +00:00
|
|
|
#define SYM_CONSTANT 0x200 /* 0x200-0x2ff are variable types */
|
|
|
|
|
|
|
|
#define SYM_TYPE(s) (((struct f_val *) (s)->def)->type)
|
|
|
|
#define SYM_VAL(s) (((struct f_val *) (s)->def)->val)
|
1999-03-29 20:21:28 +00:00
|
|
|
|
2011-09-11 19:21:47 +00:00
|
|
|
struct include_file_stack {
|
2012-07-18 17:29:33 +00:00
|
|
|
void *buffer; /* Internal lexer state */
|
|
|
|
char *file_name; /* File name */
|
|
|
|
int fd; /* File descriptor */
|
|
|
|
int lino; /* Current line num */
|
|
|
|
int depth; /* Include depth, 0 = cannot include */
|
|
|
|
|
|
|
|
struct include_file_stack *prev; /* Previous record in stack */
|
|
|
|
struct include_file_stack *up; /* Parent (who included this file) */
|
2011-09-11 19:21:47 +00:00
|
|
|
};
|
|
|
|
|
2011-10-09 23:01:58 +00:00
|
|
|
extern struct include_file_stack *ifs;
|
2011-09-11 19:21:47 +00:00
|
|
|
|
1999-02-05 21:37:34 +00:00
|
|
|
|
1998-11-27 19:35:10 +00:00
|
|
|
int cf_lex(void);
|
2011-09-11 19:21:47 +00:00
|
|
|
void cf_lex_init(int is_cli, struct config *c);
|
2014-03-25 13:58:00 +00:00
|
|
|
void cf_lex_unwind(void);
|
|
|
|
|
2015-11-08 23:42:02 +00:00
|
|
|
struct symbol *cf_find_symbol(struct config *cfg, byte *c);
|
|
|
|
|
|
|
|
struct symbol *cf_get_symbol(byte *c);
|
2000-01-17 11:52:50 +00:00
|
|
|
struct symbol *cf_default_name(char *template, int *counter);
|
2000-06-04 19:30:13 +00:00
|
|
|
struct symbol *cf_define_symbol(struct symbol *symbol, int type, void *def);
|
1999-11-04 13:53:47 +00:00
|
|
|
void cf_push_scope(struct symbol *);
|
|
|
|
void cf_pop_scope(void);
|
2000-01-19 12:30:19 +00:00
|
|
|
char *cf_symbol_class_name(struct symbol *sym);
|
1998-11-27 19:35:10 +00:00
|
|
|
|
2014-10-02 09:02:14 +00:00
|
|
|
static inline int cf_symbol_is_constant(struct symbol *sym)
|
|
|
|
{ return (sym->class & 0xff00) == SYM_CONSTANT; }
|
|
|
|
|
|
|
|
|
1998-11-27 19:35:10 +00:00
|
|
|
/* Parser */
|
|
|
|
|
2016-11-09 15:36:34 +00:00
|
|
|
extern char *cf_text;
|
1998-11-27 19:35:10 +00:00
|
|
|
int cf_parse(void);
|
|
|
|
|
1999-12-06 13:44:45 +00:00
|
|
|
/* Sysdep hooks */
|
|
|
|
|
|
|
|
void sysdep_preconfig(struct config *);
|
2000-01-16 16:44:50 +00:00
|
|
|
int sysdep_commit(struct config *, struct config *);
|
2000-01-16 17:40:26 +00:00
|
|
|
void sysdep_shutdown_done(void);
|
1999-12-06 13:44:45 +00:00
|
|
|
|
1998-11-27 19:35:10 +00:00
|
|
|
#endif
|