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"
57 #if defined(HANDLE_NETLINK_FUZZING)
58 #include "zebra/kernel_netlink.h"
59 #endif /* HANDLE_NETLINK_FUZZING */
61 #define ZEBRA_PTM_SUPPORT
66 /* Pacify zclient.o in libfrr, which expects this variable. */
67 struct thread_master
*master
;
69 /* Route retain mode flag. */
72 /* Allow non-quagga entities to delete quagga routes */
77 bool v6_rr_semantics
= false;
80 /* Receive buffer size for netlink socket */
81 uint32_t nl_rcvbufsize
= 4194304;
82 #endif /* HAVE_NETLINK */
84 #define OPTION_V6_RR_SEMANTICS 2000
85 /* Command line options. */
86 const struct option longopts
[] = {
87 {"batch", no_argument
, NULL
, 'b'},
88 {"allow_delete", no_argument
, NULL
, 'a'},
89 {"keep_kernel", no_argument
, NULL
, 'k'},
90 {"socket", required_argument
, NULL
, 'z'},
91 {"ecmp", required_argument
, NULL
, 'e'},
92 {"retain", no_argument
, NULL
, 'r'},
93 {"vrfdefaultname", required_argument
, NULL
, 'o'},
94 {"graceful_restart", required_argument
, NULL
, 'K'},
96 {"vrfwnetns", no_argument
, NULL
, 'n'},
97 {"nl-bufsize", required_argument
, NULL
, 's'},
98 {"v6-rr-semantics", no_argument
, NULL
, OPTION_V6_RR_SEMANTICS
},
99 #endif /* HAVE_NETLINK */
102 zebra_capabilities_t _caps_p
[] = {
103 ZCAP_NET_ADMIN
, ZCAP_SYS_ADMIN
, ZCAP_NET_RAW
,
106 /* zebra privileges to run with */
107 struct zebra_privs_t zserv_privs
= {
108 #if defined(FRR_USER) && defined(FRR_GROUP)
113 .vty_group
= VTY_GROUP
,
116 .cap_num_p
= array_size(_caps_p
),
119 /* SIGHUP handler. */
120 static void sighup(void)
122 zlog_info("SIGHUP received");
124 /* Reload of config file. */
128 /* SIGINT handler. */
129 static void sigint(void)
132 struct zebra_vrf
*zvrf
;
133 struct listnode
*ln
, *nn
;
134 struct zserv
*client
;
135 static bool sigint_done
;
142 zlog_notice("Terminating on signal");
144 atomic_store_explicit(&zrouter
.in_shutdown
, true,
145 memory_order_relaxed
);
147 /* send RA lifetime of 0 before stopping. rfc4861/6.2.5 */
152 zebra_dplane_pre_finish();
154 for (ALL_LIST_ELEMENTS(zrouter
.client_list
, ln
, nn
, client
))
155 zserv_close_client(client
);
158 list_delete_all_node(zrouter
.client_list
);
163 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
166 SET_FLAG(zvrf
->flags
, ZEBRA_VRF_RETAIN
);
168 if (zrouter
.lsp_process_q
)
169 work_queue_free_and_null(&zrouter
.lsp_process_q
);
173 ns_walk_func(zebra_ns_early_shutdown
);
174 zebra_ns_notify_close();
180 list_delete(&zrouter
.client_list
);
182 /* Indicate that all new dplane work has been enqueued. When that
183 * work is complete, the dataplane will enqueue an event
184 * with the 'finalize' function.
186 zebra_dplane_finish();
190 * Final shutdown step for the zebra main thread. This is run after all
191 * async update processing has completed.
193 int zebra_finalize(struct thread
*dummy
)
195 zlog_info("Zebra final shutdown");
197 /* Final shutdown of ns resources */
198 ns_walk_func(zebra_ns_final_shutdown
);
200 /* Stop dplane thread and finish any cleanup */
201 zebra_dplane_shutdown();
203 zebra_router_terminate();
209 /* SIGUSR1 handler. */
210 static void sigusr1(void)
215 struct quagga_signal_t zebra_signals
[] = {
234 static const struct frr_yang_module_info
*const zebra_yang_modules
[] = {
239 zebra
, ZEBRA
, .vty_port
= ZEBRA_VTY_PORT
, .flags
= FRR_NO_ZCLIENT
,
242 "Daemon which manages kernel routing table management "
243 "and\nredistribution between different routing protocols.",
245 .signals
= zebra_signals
, .n_signals
= array_size(zebra_signals
),
247 .privs
= &zserv_privs
,
249 .yang_modules
= zebra_yang_modules
,
250 .n_yang_modules
= array_size(zebra_yang_modules
), )
252 /* Main startup routine. */
253 int main(int argc
, char **argv
)
255 // int batch_mode = 0;
256 char *zserv_path
= NULL
;
257 char *vrf_default_name_configured
= NULL
;
258 struct sockaddr_storage dummy
;
260 #if defined(HANDLE_ZAPI_FUZZING)
261 char *zapi_fuzzing
= NULL
;
262 #endif /* HANDLE_ZAPI_FUZZING */
263 #if defined(HANDLE_NETLINK_FUZZING)
264 char *netlink_fuzzing
= NULL
;
265 #endif /* HANDLE_NETLINK_FUZZING */
267 graceful_restart
= 0;
268 vrf_configure_backend(VRF_BACKEND_VRF_LITE
);
270 frr_preinit(&zebra_di
, argc
, argv
);
277 #if defined(HANDLE_ZAPI_FUZZING)
279 #endif /* HANDLE_ZAPI_FUZZING */
280 #if defined(HANDLE_NETLINK_FUZZING)
282 #endif /* HANDLE_NETLINK_FUZZING */
285 " -b, --batch Runs in batch mode\n"
286 " -a, --allow_delete Allow other processes to delete zebra routes\n"
287 " -z, --socket Set path of zebra socket\n"
288 " -e, --ecmp Specify ECMP to use.\n"
289 " -r, --retain When program terminates, retain added route by zebra.\n"
290 " -o, --vrfdefaultname Set default VRF name.\n"
291 " -K, --graceful_restart Graceful restart at the kernel level, timer in seconds for expiration\n"
293 " -n, --vrfwnetns Use NetNS as VRF backend\n"
294 " -s, --nl-bufsize Set netlink receive buffer size\n"
295 " --v6-rr-semantics Use v6 RR semantics\n"
296 #endif /* HAVE_NETLINK */
297 #if defined(HANDLE_ZAPI_FUZZING)
298 " -c <file> Bypass normal startup and use this file for testing of zapi\n"
299 #endif /* HANDLE_ZAPI_FUZZING */
300 #if defined(HANDLE_NETLINK_FUZZING)
301 " -w <file> Bypass normal startup and use this file for testing of netlink input\n"
302 #endif /* HANDLE_NETLINK_FUZZING */
306 int opt
= frr_getopt(argc
, argv
, NULL
);
321 zrouter
.multipath_num
= atoi(optarg
);
322 if (zrouter
.multipath_num
> MULTIPATH_NUM
323 || zrouter
.multipath_num
<= 0) {
325 EC_ZEBRA_BAD_MULTIPATH_NUM
,
326 "Multipath Number specified must be less than %d and greater than 0",
332 vrf_default_name_configured
= optarg
;
336 if (!frr_zclient_addr(&dummy
, &dummylen
, optarg
)) {
338 "Invalid zserv socket path: %s\n",
347 graceful_restart
= atoi(optarg
);
351 nl_rcvbufsize
= atoi(optarg
);
354 vrf_configure_backend(VRF_BACKEND_NETNS
);
356 case OPTION_V6_RR_SEMANTICS
:
357 v6_rr_semantics
= true;
359 #endif /* HAVE_NETLINK */
360 #if defined(HANDLE_ZAPI_FUZZING)
362 zapi_fuzzing
= optarg
;
364 #endif /* HANDLE_ZAPI_FUZZING */
365 #if defined(HANDLE_NETLINK_FUZZING)
367 netlink_fuzzing
= optarg
;
368 /* This ensures we are aren't writing any of the
369 * startup netlink messages that happen when we
374 #endif /* HANDLE_NETLINK_FUZZING */
381 zrouter
.master
= frr_init();
383 /* Zebra related initialize. */
389 router_id_cmd_init();
392 * Initialize NS( and implicitly the VRF module), and make kernel
394 zebra_ns_init((const char *)vrf_default_name_configured
);
398 #if defined(HAVE_RTADV)
402 #ifdef ZEBRA_PTM_SUPPORT
407 zebra_mpls_vty_init();
411 /* For debug purpose. */
412 /* SET_FLAG (zebra_debug_event, ZEBRA_DEBUG_EVENT); */
414 /* Process the configuration file. Among other configuration
415 * directives we can meet those installing static routes. Such
416 * requests will not be executed immediately, but queued in
417 * zebra->ribq structure until we enter the main execution loop.
418 * The notifications from kernel will show originating PID equal
419 * to that after daemon() completes (if ever called).
423 /* After we have successfully acquired the pidfile, we can be sure
424 * about being the only copy of zebra process, which is submitting
425 * changes to the FIB.
426 * Clean up zebra-originated routes. The requests will be sent to OS
427 * immediately, so originating PID in notifications from kernel
428 * will be equal to the current getpid(). To know about such routes,
429 * we have to have route_read() called before.
431 zrouter
.startup_time
= monotime(NULL
);
432 thread_add_timer(zrouter
.master
, rib_sweep_route
,
433 NULL
, graceful_restart
, NULL
);
435 /* Needed for BSD routing socket. */
438 /* Start dataplane system */
439 zebra_dplane_start();
441 /* Start Zebra API server */
442 zserv_start(zserv_path
);
444 /* Init label manager */
445 label_manager_init();
450 /* Config handler Init */
456 #if defined(HANDLE_ZAPI_FUZZING)
458 zserv_read_file(zapi_fuzzing
);
461 #endif /* HANDLE_ZAPI_FUZZING */
462 #if defined(HANDLE_NETLINK_FUZZING)
463 if (netlink_fuzzing
) {
464 netlink_read_init(netlink_fuzzing
);
467 #endif /* HANDLE_NETLINK_FUZZING */
470 frr_run(zrouter
.master
);