]>
git.ipfire.org Git - thirdparty/bird.git/blob - conf/conf.c
2 * BIRD Internet Routing Daemon -- Configuration File Handling
4 * (c) 1998--2000 Martin Mares <mj@ucw.cz>
6 * Can be freely distributed and used under the terms of the GNU GPL.
10 * DOC: Configuration manager
12 * Configuration of BIRD is complex, yet straightforward. There are three
13 * modules taking care of the configuration: config manager (which takes care
14 * of storage of the config information and controls switching between configs),
15 * lexical analyzer and parser.
17 * The configuration manager stores each config as a &config structure
18 * accompanied by a linear pool from which all information associated
19 * with the config and pointed to by the &config structure is allocated.
21 * There can exist up to four different configurations at one time: an active
22 * one (pointed to by @config), configuration we are just switching from
23 * (@old_config), one queued for the next reconfiguration (@future_config;
24 * if there is one and the user wants to reconfigure once again, we just
25 * free the previous queued config and replace it with the new one) and
26 * finally a config being parsed (@new_config). The stored @old_config
27 * is also used for undo reconfiguration, which works in a similar way.
28 * Reconfiguration could also have timeout (using @config_timer) and undo
29 * is automatically called if the new configuration is not confirmed later.
31 * Loading of new configuration is very simple: just call config_alloc()
32 * to get a new &config structure, then use config_parse() to parse a
33 * configuration file and fill all fields of the structure
34 * and finally ask the config manager to switch to the new
35 * config by calling config_commit().
37 * CLI commands are parsed in a very similar way -- there is also a stripped-down
38 * &config structure associated with them and they are lex-ed and parsed by the
39 * same functions, only a special fake token is prepended before the command
40 * text to make the parser recognize only the rules corresponding to CLI commands.
48 #include "nest/bird.h"
49 #include "nest/route.h"
50 #include "nest/protocol.h"
51 #include "nest/iface.h"
52 #include "lib/resource.h"
53 #include "lib/string.h"
54 #include "lib/event.h"
55 #include "lib/timer.h"
56 #include "conf/conf.h"
57 #include "filter/filter.h"
59 static jmp_buf conf_jmpbuf
;
61 struct config
*config
, *new_config
;
63 static struct config
*old_config
; /* Old configuration */
64 static struct config
*future_config
; /* New config held here if recon requested during recon */
65 static int old_cftype
; /* Type of transition old_config -> config (RECONFIG_SOFT/HARD) */
66 static int future_cftype
; /* Type of scheduled transition, may also be RECONFIG_UNDO */
67 /* Note that when future_cftype is RECONFIG_UNDO, then future_config is NULL,
68 therefore proper check for future scheduled config checks future_cftype */
70 static event
*config_event
; /* Event for finalizing reconfiguration */
71 static timer
*config_timer
; /* Timer for scheduled configuration rollback */
73 /* These are public just for cmd_show_status(), should not be accessed elsewhere */
74 int shutting_down
; /* Shutdown requested, do not accept new config changes */
75 int configuring
; /* Reconfiguration is running */
76 int undo_available
; /* Undo was not requested from last reconfiguration */
77 /* Note that both shutting_down and undo_available are related to requests, not processing */
80 * config_alloc - allocate a new configuration
81 * @name: name of the config
83 * This function creates new &config structure, attaches a resource
84 * pool and a linear memory pool to it and makes it available for
85 * further use. Returns a pointer to the structure.
88 config_alloc(byte
*name
)
90 pool
*p
= rp_new(&root_pool
, "Config");
91 linpool
*l
= lp_new(p
, 4080);
92 struct config
*c
= lp_allocz(l
, sizeof(struct config
));
94 c
->mrtdump_file
= -1; /* Hack, this should be sysdep-specific */
97 c
->file_name
= cfg_strdup(name
);
99 c
->tf_base
.fmt1
= c
->tf_log
.fmt1
= "%d-%m-%Y %T";
105 * config_parse - parse a configuration
108 * config_parse() reads input by calling a hook function pointed to
109 * by @cf_read_hook and parses it according to the configuration
110 * grammar. It also calls all the preconfig and postconfig hooks
111 * before, resp. after parsing.
113 * Result: 1 if the config has been parsed successfully, 0 if any
114 * error has occurred (such as anybody calling cf_error()) and
115 * the @err_msg field has been set to the error message.
118 config_parse(struct config
*c
)
120 DBG("Parsing configuration file `%s'\n", c
->file_name
);
123 if (setjmp(conf_jmpbuf
))
131 protos_postconfig(c
);
132 if (EMPTY_LIST(c
->protos
))
133 cf_error("No protocol is specified in the config file");
136 cf_error("Router ID must be configured manually on IPv6 routers");
142 * cli_parse - parse a CLI command
143 * @c: temporary config structure
145 * cli_parse() is similar to config_parse(), but instead of a configuration,
146 * it parses a CLI command. See the CLI module for more information.
149 cli_parse(struct config
*c
)
152 c
->sym_fallback
= config
->sym_hash
;
154 if (setjmp(conf_jmpbuf
))
162 * config_free - free a configuration
163 * @c: configuration to be freed
165 * This function takes a &config structure and frees all resources
166 * associated with it.
169 config_free(struct config
*c
)
176 config_add_obstacle(struct config
*c
)
178 DBG("+++ adding obstacle %d\n", c
->obstacle_count
);
183 config_del_obstacle(struct config
*c
)
185 DBG("+++ deleting obstacle %d\n", c
->obstacle_count
);
187 if (!c
->obstacle_count
)
188 ev_schedule(config_event
);
192 global_commit(struct config
*new, struct config
*old
)
197 if (!ipa_equal(old
->listen_bgp_addr
, new->listen_bgp_addr
) ||
198 (old
->listen_bgp_port
!= new->listen_bgp_port
) ||
199 (old
->listen_bgp_flags
!= new->listen_bgp_flags
))
200 log(L_WARN
"Reconfiguration of BGP listening socket not implemented, please restart BIRD.");
204 new->router_id
= old
->router_id
;
206 if (new->router_id_from
)
208 u32 id
= if_choose_router_id(new->router_id_from
, old
->router_id
);
210 log(L_WARN
"Cannot determine router ID, using old one");
220 config_do_commit(struct config
*c
, int type
)
222 if (type
== RECONFIG_UNDO
)
228 config_free(old_config
);
235 if (old_config
&& !config
->shutdown
)
236 log(L_INFO
"Reconfiguring");
238 /* This should not be necessary, but it seems there are some
239 functions that access new_config instead of config */
243 old_config
->obstacle_count
++;
245 DBG("sysdep_commit\n");
246 int force_restart
= sysdep_commit(c
, old_config
);
247 DBG("global_commit\n");
248 force_restart
|= global_commit(c
, old_config
);
250 rt_commit(c
, old_config
);
251 roa_commit(c
, old_config
);
252 DBG("protos_commit\n");
253 protos_commit(c
, old_config
, force_restart
, type
);
255 /* Just to be sure nobody uses that now */
260 obs
= --old_config
->obstacle_count
;
262 DBG("do_commit finished with %d obstacles remaining\n", obs
);
267 config_done(void *unused UNUSED
)
269 if (config
->shutdown
)
270 sysdep_shutdown_done();
274 log(L_INFO
"Reconfigured");
278 int type
= future_cftype
;
279 struct config
*conf
= future_config
;
280 future_cftype
= RECONFIG_NONE
;
281 future_config
= NULL
;
283 log(L_INFO
"Reconfiguring to queued configuration");
284 if (config_do_commit(conf
, type
))
290 * config_commit - commit a configuration
291 * @c: new configuration
292 * @type: type of reconfiguration (RECONFIG_SOFT or RECONFIG_HARD)
293 * @timeout: timeout for undo (or 0 for no timeout)
295 * When a configuration is parsed and prepared for use, the
296 * config_commit() function starts the process of reconfiguration.
297 * It checks whether there is already a reconfiguration in progress
298 * in which case it just queues the new config for later processing.
299 * Else it notifies all modules about the new configuration by calling
300 * their commit() functions which can either accept it immediately
301 * or call config_add_obstacle() to report that they need some time
302 * to complete the reconfiguration. After all such obstacles are removed
303 * using config_del_obstacle(), the old configuration is freed and
304 * everything runs according to the new one.
306 * When @timeout is nonzero, the undo timer is activated with given
307 * timeout. The timer is deactivated when config_commit(),
308 * config_confirm() or config_undo() is called.
310 * Result: %CONF_DONE if the configuration has been accepted immediately,
311 * %CONF_PROGRESS if it will take some time to switch to it, %CONF_QUEUED
312 * if it's been queued due to another reconfiguration being in progress now
313 * or %CONF_SHUTDOWN if BIRD is in shutdown mode and no new configurations
317 config_commit(struct config
*c
, int type
, int timeout
)
322 return CONF_SHUTDOWN
;
327 tm_start(config_timer
, timeout
);
329 tm_stop(config_timer
);
335 log(L_INFO
"Queueing new configuration, ignoring the one already queued");
336 config_free(future_config
);
339 log(L_INFO
"Queueing new configuration");
341 future_cftype
= type
;
346 if (config_do_commit(c
, type
))
351 return CONF_PROGRESS
;
355 * config_confirm - confirm a commited configuration
357 * When the undo timer is activated by config_commit() with nonzero timeout,
358 * this function can be used to deactivate it and therefore confirm
359 * the current configuration.
361 * Result: %CONF_CONFIRM when the current configuration is confirmed,
362 * %CONF_NONE when there is nothing to confirm (i.e. undo timer is not active).
367 if (config_timer
->expires
== 0)
370 tm_stop(config_timer
);
376 * config_undo - undo a configuration
378 * Function config_undo() can be used to change the current
379 * configuration back to stored %old_config. If no reconfiguration is
380 * running, this stored configuration is commited in the same way as a
381 * new configuration in config_commit(). If there is already a
382 * reconfiguration in progress and no next reconfiguration is
383 * scheduled, then the undo is scheduled for later processing as
384 * usual, but if another reconfiguration is already scheduled, then
385 * such reconfiguration is removed instead (i.e. undo is applied on
386 * the last commit that scheduled it).
388 * Result: %CONF_DONE if the configuration has been accepted immediately,
389 * %CONF_PROGRESS if it will take some time to switch to it, %CONF_QUEUED
390 * if it's been queued due to another reconfiguration being in progress now,
391 * %CONF_UNQUEUED if a scheduled reconfiguration is removed, %CONF_NOTHING
392 * if there is no relevant configuration to undo (the previous config request
393 * was config_undo() too) or %CONF_SHUTDOWN if BIRD is in shutdown mode and
394 * no new configuration changes are accepted.
400 return CONF_SHUTDOWN
;
402 if (!undo_available
|| !old_config
)
406 tm_stop(config_timer
);
412 config_free(future_config
);
413 future_config
= NULL
;
415 log(L_INFO
"Removing queued configuration");
416 future_cftype
= RECONFIG_NONE
;
417 return CONF_UNQUEUED
;
421 log(L_INFO
"Queueing undo configuration");
422 future_cftype
= RECONFIG_UNDO
;
427 if (config_do_commit(NULL
, RECONFIG_UNDO
))
432 return CONF_PROGRESS
;
435 extern void cmd_reconfig_undo_notify(void);
438 config_timeout(struct timer
*t
)
440 log(L_INFO
"Config timeout expired, starting undo");
441 cmd_reconfig_undo_notify();
443 int r
= config_undo();
445 log(L_ERR
"Undo request failed");
451 config_event
= ev_new(&root_pool
);
452 config_event
->hook
= config_done
;
454 config_timer
= tm_new(&root_pool
);
455 config_timer
->hook
= config_timeout
;
459 * order_shutdown - order BIRD shutdown
461 * This function initiates shutdown of BIRD. It's accomplished by asking
462 * for switching to an empty configuration.
472 log(L_INFO
"Shutting down");
473 c
= lp_alloc(config
->mem
, sizeof(struct config
));
474 memcpy(c
, config
, sizeof(struct config
));
475 init_list(&c
->protos
);
476 init_list(&c
->tables
);
479 config_commit(c
, RECONFIG_HARD
, 0);
484 * cf_error - report a configuration error
485 * @msg: printf-like format string
487 * cf_error() can be called during execution of config_parse(), that is
488 * from the parser, a preconfig hook or a postconfig hook, to report an
489 * error in the configuration.
492 cf_error(char *msg
, ...)
498 if (bvsnprintf(buf
, sizeof(buf
), msg
, args
) < 0)
499 strcpy(buf
, "<bug: error message too long>");
500 new_config
->err_msg
= cfg_strdup(buf
);
501 new_config
->err_lino
= ifs
->lino
;
502 new_config
->err_file_name
= ifs
->file_name
;
503 longjmp(conf_jmpbuf
, 1);
507 * cfg_strdup - copy a string to config memory
510 * cfg_strdup() creates a new copy of the string in the memory
511 * pool associated with the configuration being currently parsed.
512 * It's often used when a string literal occurs in the configuration
513 * and we want to preserve it for further use.
518 int l
= strlen(c
) + 1;
519 char *z
= cfg_allocu(l
);
526 cfg_copy_list(list
*dest
, list
*src
, unsigned node_size
)
533 dn
= cfg_alloc(node_size
);
534 memcpy(dn
, sn
, node_size
);