]> git.ipfire.org Git - thirdparty/bird.git/blobdiff - conf/conf.h
Merge branch 'master' into mq-filter-stack
[thirdparty/bird.git] / conf / conf.h
index 8c2d5491d097668d20b4f79a59e8c393d29db278..21dc3fa1fbecef0e4f9086c172e8e5c6905ff3cc 100644 (file)
@@ -9,6 +9,9 @@
 #ifndef _BIRD_CONF_H_
 #define _BIRD_CONF_H_
 
+#include "sysdep/config.h"
+#include "lib/ip.h"
+#include "lib/hash.h"
 #include "lib/resource.h"
 #include "lib/timer.h"
 
@@ -19,49 +22,76 @@ struct config {
   linpool *mem;                                /* Linear pool containing configuration data */
   list protos;                         /* Configured protocol instances (struct proto_config) */
   list tables;                         /* Configured routing tables (struct rtable_config) */
-  list logfiles;                       /* Configured log fils (sysdep) */
-  struct rtable_config *master_rtc;    /* Configuration of master routing table */
+  list logfiles;                       /* Configured log files (sysdep) */
+  list tests;                          /* Configured unit tests (f_bt_test_suite) */
+  list symbols;                                /* Configured symbols in config order */
+
+  int mrtdump_file;                    /* Configured MRTDump file (sysdep, fd in unix) */
+  char *syslog_name;                   /* Name used for syslog (NULL -> no syslog) */
+  struct rtable_config *def_tables[NET_MAX]; /* Default routing tables for each network */
+  struct iface_patt *router_id_from;   /* Configured list of router ID iface patterns */
+
   u32 router_id;                       /* Our Router ID */
-  ip_addr bind_bgp_addr;               /* Listening BGP socket should use this address */
-  unsigned bind_bgp_port;              /* Listening BGP socket should use this port (0 is default) */
-  u32 bind_bgp_flags;                  /* Listening BGP socket should use these flags */
-  unsigned int proto_default_debug;    /* Default protocol debug mask */
+  unsigned proto_default_debug;                /* Default protocol debug mask */
+  unsigned proto_default_mrtdump;      /* Default protocol mrtdump mask */
+  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 */
+  u32 gr_wait;                         /* Graceful restart wait timeout (sec) */
+
   int cli_debug;                       /* Tracing of CLI connections and commands */
+  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) */
   char *err_msg;                       /* Parser error message */
   int err_lino;                                /* Line containing error */
-  char *file_name;                     /* Name of configuration file */
-  struct symbol **sym_hash;            /* Lexer: symbol hash table */
-  struct symbol **sym_fallback;                /* Lexer: fallback symbol hash table */
+  int err_chno;                                /* Character where the parser stopped */
+  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 */
+  HASH(struct symbol) sym_hash;                /* Lexer: symbol hash table */
+  struct config *fallback;             /* Link to regular config for CLI parsing */
+  struct sym_scope *root_scope;                /* Scope for root symbols */
   int obstacle_count;                  /* Number of items blocking freeing of this config */
   int shutdown;                                /* This is a pseudo-config for daemon shutdown */
-  bird_clock_t load_time;              /* When we've got this configuration */
+  int gr_down;                         /* This is a pseudo-config for graceful restart */
+  btime load_time;                     /* When we've got this configuration */
 };
 
 /* Please don't use these variables in protocols. Use proto_config->global instead. */
 extern struct config *config;          /* Currently active configuration */
 extern struct config *new_config;      /* Configuration being parsed */
-extern struct config *old_config;      /* Old configuration when reconfiguration is in progress */
-extern struct config *future_config;   /* New config held here if recon requested during recon */
 
-extern int shutting_down;
-extern bird_clock_t boot_time;
-
-struct config *config_alloc(byte *name);
+struct config *config_alloc(const char *name);
 int config_parse(struct config *);
 int cli_parse(struct config *);
 void config_free(struct config *);
-int config_commit(struct config *, int type);
-#define RECONFIG_HARD 0
-#define RECONFIG_SOFT 1
-void cf_error(char *msg, ...) NORET;
+int config_commit(struct config *, int type, uint timeout);
+int config_confirm(void);
+int config_undo(void);
+int config_status(void);
+btime config_timer_status(void);
+void config_init(void);
+void cf_error(const char *msg, ...) NORET;
 void config_add_obstacle(struct config *);
 void config_del_obstacle(struct config *);
-void order_shutdown(void);
+void order_shutdown(int gr);
+
+#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
 
-#define CONF_DONE 0
-#define CONF_PROGRESS 1
-#define CONF_QUEUED 2
-#define CONF_SHUTDOWN 3
 
 /* Pools */
 
@@ -70,47 +100,117 @@ extern linpool *cfg_mem;
 #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)
-char *cfg_strdup(char *c);
+char *cfg_strdup(const char *c);
+void cfg_copy_list(list *dest, list *src, unsigned node_size);
 
 /* Lexer */
 
-extern int (*cf_read_hook)(byte *buf, unsigned int max);
+extern int (*cf_read_hook)(byte *buf, uint max, int fd);
 
 struct symbol {
+  node n;                              /* In list of symbols in config */
   struct symbol *next;
   struct sym_scope *scope;
-  int class;
-  int aux;
-  void *aux2;
-  void *def;
-  char name[1];
+  int class;                           /* SYM_* */
+  uint flags;                          /* SYM_FLAG_* */
+
+  union {
+    struct proto_config *proto;                /* For SYM_PROTO and SYM_TEMPLATE */
+    const struct f_line *function;     /* For SYM_FUNCTION */
+    const struct filter *filter;       /* For SYM_FILTER */
+    struct rtable_config *table;       /* For SYM_TABLE */
+    struct f_dynamic_attr *attribute;  /* For SYM_ATTRIBUTE */
+    struct f_val *val;                 /* For SYM_CONSTANT */
+    uint offset;                       /* For SYM_VARIABLE */
+  };
+
+  char name[0];
+};
+
+struct sym_scope {
+  struct sym_scope *next;              /* Next on scope stack */
+  struct symbol *name;                 /* Name of this scope */
+  uint slots;                          /* Variable slots */
+  int active;                          /* Currently entered */
 };
 
+#define SYM_MAX_LEN 64
+
 /* Remember to update cf_symbol_class_name() */
 #define SYM_VOID 0
 #define SYM_PROTO 1
-#define SYM_NUMBER 2
+#define SYM_TEMPLATE 2
 #define SYM_FUNCTION 3
 #define SYM_FILTER 4
 #define SYM_TABLE 5
-#define SYM_IPA 6
+#define SYM_ATTRIBUTE 6
 
 #define SYM_VARIABLE 0x100     /* 0x100-0x1ff are variable types */
+#define SYM_VARIABLE_RANGE SYM_VARIABLE ... (SYM_VARIABLE | 0xff)
+#define SYM_CONSTANT 0x200     /* 0x200-0x2ff are variable types */
+#define SYM_CONSTANT_RANGE SYM_CONSTANT ... (SYM_CONSTANT | 0xff)
+
+#define SYM_TYPE(s) ((s)->val->type)
+#define SYM_VAL(s) ((s)->val->val)
+
+/* Symbol flags */
+#define SYM_FLAG_SAME 0x1      /* For SYM_FUNCTION and SYM_FILTER */
+
+struct include_file_stack {
+  void *buffer;                                /* Internal lexer state */
+  char *file_name;                     /* File name */
+  int fd;                              /* File descriptor */
+  int lino;                            /* Current line num */
+  int chno;                            /* Current char num (on current line) */
+  int toklen;                          /* Current token length */
+  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) */
+};
+
+extern struct include_file_stack *ifs;
 
-extern int conf_lino;
+extern struct sym_scope *conf_this_scope;
 
 int cf_lex(void);
-void cf_lex_init(int is_cli);
-struct symbol *cf_find_symbol(byte *c);
+void cf_lex_init(int is_cli, struct config *c);
+void cf_lex_unwind(void);
+
+struct symbol *cf_find_symbol(const struct config *cfg, const byte *c);
+
+struct symbol *cf_get_symbol(const byte *c);
 struct symbol *cf_default_name(char *template, int *counter);
-struct symbol *cf_define_symbol(struct symbol *symbol, int type, void *def);
+struct symbol *cf_localize_symbol(struct symbol *sym);
+
+/**
+ * cf_define_symbol - define meaning of a symbol
+ * @sym: symbol to be defined
+ * @type: symbol class to assign
+ * @def: class dependent data
+ *
+ * Defines new meaning of a symbol. If the symbol is an undefined
+ * one (%SYM_VOID), it's just re-defined to the new type. If it's defined
+ * in different scope, a new symbol in current scope is created and the
+ * meaning is assigned to it. If it's already defined in the current scope,
+ * an error is reported via cf_error().
+ *
+ * Result: Pointer to the newly defined symbol. If we are in the top-level
+ * scope, it's the same @sym as passed to the function.
+ */
+#define cf_define_symbol(sym_, type_, var_, def_) ({ \
+    struct symbol *sym = cf_localize_symbol(sym_); \
+    sym->class = type_; \
+    sym->var_ = def_; \
+    sym; })
+
 void cf_push_scope(struct symbol *);
 void cf_pop_scope(void);
-struct symbol *cf_walk_symbols(struct config *cf, struct symbol *sym, int *pos);
 char *cf_symbol_class_name(struct symbol *sym);
 
 /* Parser */
 
+extern char *cf_text;
 int cf_parse(void);
 
 /* Sysdep hooks */