1 /* zebra daemon main routine.
2 * Copyright (C) 1997, 98 Kunihiro Ishiguro
4 * This file is part of GNU Zebra.
6 * GNU Zebra is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2, or (at your option) any
11 * GNU Zebra is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; see the file COPYING; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 #include <lib/version.h>
29 #include "zebra_memory.h"
39 #include "zebra/zebra_router.h"
40 #include "zebra/zebra_errors.h"
41 #include "zebra/rib.h"
42 #include "zebra/zserv.h"
43 #include "zebra/debug.h"
44 #include "zebra/router-id.h"
45 #include "zebra/irdp.h"
46 #include "zebra/rtadv.h"
47 #include "zebra/zebra_ptm.h"
48 #include "zebra/zebra_ns.h"
49 #include "zebra/redistribute.h"
50 #include "zebra/zebra_mpls.h"
51 #include "zebra/label_manager.h"
52 #include "zebra/zebra_netns_notify.h"
53 #include "zebra/zebra_rnh.h"
54 #include "zebra/zebra_pbr.h"
55 #include "zebra/zebra_vxlan.h"
56 #include "zebra/zebra_routemap.h"
57 #include "zebra/zebra_nb.h"
59 #if defined(HANDLE_NETLINK_FUZZING)
60 #include "zebra/kernel_netlink.h"
61 #endif /* HANDLE_NETLINK_FUZZING */
63 #define ZEBRA_PTM_SUPPORT
68 /* Pacify zclient.o in libfrr, which expects this variable. */
69 struct thread_master
*master
;
71 /* Route retain mode flag. */
74 /* Allow non-quagga entities to delete quagga routes */
79 bool v6_rr_semantics
= false;
82 /* Receive buffer size for netlink socket */
83 uint32_t nl_rcvbufsize
= 4194304;
84 #endif /* HAVE_NETLINK */
86 #define OPTION_V6_RR_SEMANTICS 2000
87 /* Command line options. */
88 const struct option longopts
[] = {
89 {"batch", no_argument
, NULL
, 'b'},
90 {"allow_delete", no_argument
, NULL
, 'a'},
91 {"keep_kernel", no_argument
, NULL
, 'k'},
92 {"socket", required_argument
, NULL
, 'z'},
93 {"ecmp", required_argument
, NULL
, 'e'},
94 {"retain", no_argument
, NULL
, 'r'},
95 {"vrfdefaultname", required_argument
, NULL
, 'o'},
96 {"graceful_restart", required_argument
, NULL
, 'K'},
98 {"vrfwnetns", no_argument
, NULL
, 'n'},
99 {"nl-bufsize", required_argument
, NULL
, 's'},
100 {"v6-rr-semantics", no_argument
, NULL
, OPTION_V6_RR_SEMANTICS
},
101 #endif /* HAVE_NETLINK */
104 zebra_capabilities_t _caps_p
[] = {
105 ZCAP_NET_ADMIN
, ZCAP_SYS_ADMIN
, ZCAP_NET_RAW
,
108 /* zebra privileges to run with */
109 struct zebra_privs_t zserv_privs
= {
110 #if defined(FRR_USER) && defined(FRR_GROUP)
115 .vty_group
= VTY_GROUP
,
118 .cap_num_p
= array_size(_caps_p
),
121 /* SIGHUP handler. */
122 static void sighup(void)
124 zlog_info("SIGHUP received");
126 /* Reload of config file. */
130 /* SIGINT handler. */
131 static void sigint(void)
134 struct zebra_vrf
*zvrf
;
135 struct listnode
*ln
, *nn
;
136 struct zserv
*client
;
137 static bool sigint_done
;
144 zlog_notice("Terminating on signal");
146 atomic_store_explicit(&zrouter
.in_shutdown
, true,
147 memory_order_relaxed
);
149 /* send RA lifetime of 0 before stopping. rfc4861/6.2.5 */
154 zebra_dplane_pre_finish();
156 /* Clean up GR related info. */
157 zebra_gr_stale_client_cleanup(zrouter
.stale_client_list
);
158 list_delete_all_node(zrouter
.stale_client_list
);
160 for (ALL_LIST_ELEMENTS(zrouter
.client_list
, ln
, nn
, client
))
161 zserv_close_client(client
);
164 list_delete_all_node(zrouter
.client_list
);
169 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
172 SET_FLAG(zvrf
->flags
, ZEBRA_VRF_RETAIN
);
174 if (zrouter
.lsp_process_q
)
175 work_queue_free_and_null(&zrouter
.lsp_process_q
);
180 ns_walk_func(zebra_ns_early_shutdown
);
181 zebra_ns_notify_close();
186 * zebra_routemap_finish will
187 * 1 set rmap upd timer to 0 so that rmap update wont be scheduled again
188 * 2 Put off the rmap update thread
191 zebra_routemap_finish();
193 list_delete(&zrouter
.client_list
);
195 /* Indicate that all new dplane work has been enqueued. When that
196 * work is complete, the dataplane will enqueue an event
197 * with the 'finalize' function.
199 zebra_dplane_finish();
203 * Final shutdown step for the zebra main thread. This is run after all
204 * async update processing has completed.
206 int zebra_finalize(struct thread
*dummy
)
208 zlog_info("Zebra final shutdown");
210 /* Final shutdown of ns resources */
211 ns_walk_func(zebra_ns_final_shutdown
);
213 /* Stop dplane thread and finish any cleanup */
214 zebra_dplane_shutdown();
216 zebra_router_terminate();
222 /* SIGUSR1 handler. */
223 static void sigusr1(void)
228 struct quagga_signal_t zebra_signals
[] = {
247 static const struct frr_yang_module_info
*const zebra_yang_modules
[] = {
255 zebra
, ZEBRA
, .vty_port
= ZEBRA_VTY_PORT
, .flags
= FRR_NO_ZCLIENT
,
258 "Daemon which manages kernel routing table management "
259 "and\nredistribution between different routing protocols.",
261 .signals
= zebra_signals
, .n_signals
= array_size(zebra_signals
),
263 .privs
= &zserv_privs
,
265 .yang_modules
= zebra_yang_modules
,
266 .n_yang_modules
= array_size(zebra_yang_modules
), )
268 /* Main startup routine. */
269 int main(int argc
, char **argv
)
271 // int batch_mode = 0;
272 char *zserv_path
= NULL
;
273 char *vrf_default_name_configured
= NULL
;
274 struct sockaddr_storage dummy
;
276 #if defined(HANDLE_ZAPI_FUZZING)
277 char *zapi_fuzzing
= NULL
;
278 #endif /* HANDLE_ZAPI_FUZZING */
279 #if defined(HANDLE_NETLINK_FUZZING)
280 char *netlink_fuzzing
= NULL
;
281 #endif /* HANDLE_NETLINK_FUZZING */
283 graceful_restart
= 0;
284 vrf_configure_backend(VRF_BACKEND_VRF_LITE
);
286 frr_preinit(&zebra_di
, argc
, argv
);
293 #if defined(HANDLE_ZAPI_FUZZING)
295 #endif /* HANDLE_ZAPI_FUZZING */
296 #if defined(HANDLE_NETLINK_FUZZING)
298 #endif /* HANDLE_NETLINK_FUZZING */
301 " -b, --batch Runs in batch mode\n"
302 " -a, --allow_delete Allow other processes to delete zebra routes\n"
303 " -z, --socket Set path of zebra socket\n"
304 " -e, --ecmp Specify ECMP to use.\n"
305 " -r, --retain When program terminates, retain added route by zebra.\n"
306 " -o, --vrfdefaultname Set default VRF name.\n"
307 " -K, --graceful_restart Graceful restart at the kernel level, timer in seconds for expiration\n"
309 " -n, --vrfwnetns Use NetNS as VRF backend\n"
310 " -s, --nl-bufsize Set netlink receive buffer size\n"
311 " --v6-rr-semantics Use v6 RR semantics\n"
312 #endif /* HAVE_NETLINK */
313 #if defined(HANDLE_ZAPI_FUZZING)
314 " -c <file> Bypass normal startup and use this file for testing of zapi\n"
315 #endif /* HANDLE_ZAPI_FUZZING */
316 #if defined(HANDLE_NETLINK_FUZZING)
317 " -w <file> Bypass normal startup and use this file for testing of netlink input\n"
318 #endif /* HANDLE_NETLINK_FUZZING */
322 int opt
= frr_getopt(argc
, argv
, NULL
);
337 unsigned long int parsed_multipath
=
338 strtoul(optarg
, NULL
, 10);
339 if (parsed_multipath
== 0
340 || parsed_multipath
> MULTIPATH_NUM
341 || parsed_multipath
> UINT32_MAX
) {
343 EC_ZEBRA_BAD_MULTIPATH_NUM
,
344 "Multipath Number specified must be less than %u and greater than 0",
348 zrouter
.multipath_num
= parsed_multipath
;
352 vrf_default_name_configured
= optarg
;
356 if (!frr_zclient_addr(&dummy
, &dummylen
, optarg
)) {
358 "Invalid zserv socket path: %s\n",
367 graceful_restart
= atoi(optarg
);
371 nl_rcvbufsize
= atoi(optarg
);
374 vrf_configure_backend(VRF_BACKEND_NETNS
);
376 case OPTION_V6_RR_SEMANTICS
:
377 v6_rr_semantics
= true;
379 #endif /* HAVE_NETLINK */
380 #if defined(HANDLE_ZAPI_FUZZING)
382 zapi_fuzzing
= optarg
;
384 #endif /* HANDLE_ZAPI_FUZZING */
385 #if defined(HANDLE_NETLINK_FUZZING)
387 netlink_fuzzing
= optarg
;
388 /* This ensures we are aren't writing any of the
389 * startup netlink messages that happen when we
394 #endif /* HANDLE_NETLINK_FUZZING */
401 zrouter
.master
= frr_init();
403 /* Zebra related initialize. */
409 router_id_cmd_init();
412 * Initialize NS( and implicitly the VRF module), and make kernel
414 zebra_ns_init((const char *)vrf_default_name_configured
);
418 #if defined(HAVE_RTADV)
422 #ifdef ZEBRA_PTM_SUPPORT
427 zebra_mpls_vty_init();
431 /* For debug purpose. */
432 /* SET_FLAG (zebra_debug_event, ZEBRA_DEBUG_EVENT); */
434 /* Process the configuration file. Among other configuration
435 * directives we can meet those installing static routes. Such
436 * requests will not be executed immediately, but queued in
437 * zebra->ribq structure until we enter the main execution loop.
438 * The notifications from kernel will show originating PID equal
439 * to that after daemon() completes (if ever called).
443 /* After we have successfully acquired the pidfile, we can be sure
444 * about being the only copy of zebra process, which is submitting
445 * changes to the FIB.
446 * Clean up zebra-originated routes. The requests will be sent to OS
447 * immediately, so originating PID in notifications from kernel
448 * will be equal to the current getpid(). To know about such routes,
449 * we have to have route_read() called before.
451 zrouter
.startup_time
= monotime(NULL
);
452 thread_add_timer(zrouter
.master
, rib_sweep_route
,
453 NULL
, graceful_restart
, NULL
);
455 /* Needed for BSD routing socket. */
458 /* Start dataplane system */
459 zebra_dplane_start();
461 /* Start Zebra API server */
462 zserv_start(zserv_path
);
464 /* Init label manager */
465 label_manager_init();
470 /* Config handler Init */
476 #if defined(HANDLE_ZAPI_FUZZING)
478 zserv_read_file(zapi_fuzzing
);
481 #endif /* HANDLE_ZAPI_FUZZING */
482 #if defined(HANDLE_NETLINK_FUZZING)
483 if (netlink_fuzzing
) {
484 netlink_read_init(netlink_fuzzing
);
487 #endif /* HANDLE_NETLINK_FUZZING */
490 frr_run(zrouter
.master
);