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"
58 #if defined(HANDLE_NETLINK_FUZZING)
59 #include "zebra/kernel_netlink.h"
60 #endif /* HANDLE_NETLINK_FUZZING */
62 #define ZEBRA_PTM_SUPPORT
67 /* Pacify zclient.o in libfrr, which expects this variable. */
68 struct thread_master
*master
;
70 /* Route retain mode flag. */
73 /* Allow non-quagga entities to delete quagga routes */
78 bool v6_rr_semantics
= false;
81 /* Receive buffer size for netlink socket */
82 uint32_t nl_rcvbufsize
= 4194304;
83 #endif /* HAVE_NETLINK */
85 #define OPTION_V6_RR_SEMANTICS 2000
86 /* Command line options. */
87 const struct option longopts
[] = {
88 {"batch", no_argument
, NULL
, 'b'},
89 {"allow_delete", no_argument
, NULL
, 'a'},
90 {"keep_kernel", no_argument
, NULL
, 'k'},
91 {"socket", required_argument
, NULL
, 'z'},
92 {"ecmp", required_argument
, NULL
, 'e'},
93 {"retain", no_argument
, NULL
, 'r'},
94 {"vrfdefaultname", required_argument
, NULL
, 'o'},
95 {"graceful_restart", required_argument
, NULL
, 'K'},
97 {"vrfwnetns", no_argument
, NULL
, 'n'},
98 {"nl-bufsize", required_argument
, NULL
, 's'},
99 {"v6-rr-semantics", no_argument
, NULL
, OPTION_V6_RR_SEMANTICS
},
100 #endif /* HAVE_NETLINK */
103 zebra_capabilities_t _caps_p
[] = {
104 ZCAP_NET_ADMIN
, ZCAP_SYS_ADMIN
, ZCAP_NET_RAW
,
107 /* zebra privileges to run with */
108 struct zebra_privs_t zserv_privs
= {
109 #if defined(FRR_USER) && defined(FRR_GROUP)
114 .vty_group
= VTY_GROUP
,
117 .cap_num_p
= array_size(_caps_p
),
120 /* SIGHUP handler. */
121 static void sighup(void)
123 zlog_info("SIGHUP received");
125 /* Reload of config file. */
129 /* SIGINT handler. */
130 static void sigint(void)
133 struct zebra_vrf
*zvrf
;
134 struct listnode
*ln
, *nn
;
135 struct zserv
*client
;
136 static bool sigint_done
;
143 zlog_notice("Terminating on signal");
145 atomic_store_explicit(&zrouter
.in_shutdown
, true,
146 memory_order_relaxed
);
148 /* send RA lifetime of 0 before stopping. rfc4861/6.2.5 */
153 zebra_dplane_pre_finish();
155 /* Clean up GR related info. */
156 zebra_gr_stale_client_cleanup(zrouter
.stale_client_list
);
157 list_delete_all_node(zrouter
.stale_client_list
);
159 for (ALL_LIST_ELEMENTS(zrouter
.client_list
, ln
, nn
, client
))
160 zserv_close_client(client
);
163 list_delete_all_node(zrouter
.client_list
);
168 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
171 SET_FLAG(zvrf
->flags
, ZEBRA_VRF_RETAIN
);
173 if (zrouter
.lsp_process_q
)
174 work_queue_free_and_null(&zrouter
.lsp_process_q
);
178 ns_walk_func(zebra_ns_early_shutdown
);
179 zebra_ns_notify_close();
184 * zebra_routemap_finish will
185 * 1 set rmap upd timer to 0 so that rmap update wont be scheduled again
186 * 2 Put off the rmap update thread
189 zebra_routemap_finish();
191 list_delete(&zrouter
.client_list
);
193 /* Indicate that all new dplane work has been enqueued. When that
194 * work is complete, the dataplane will enqueue an event
195 * with the 'finalize' function.
197 zebra_dplane_finish();
201 * Final shutdown step for the zebra main thread. This is run after all
202 * async update processing has completed.
204 int zebra_finalize(struct thread
*dummy
)
206 zlog_info("Zebra final shutdown");
208 /* Final shutdown of ns resources */
209 ns_walk_func(zebra_ns_final_shutdown
);
211 /* Stop dplane thread and finish any cleanup */
212 zebra_dplane_shutdown();
214 zebra_router_terminate();
220 /* SIGUSR1 handler. */
221 static void sigusr1(void)
226 struct quagga_signal_t zebra_signals
[] = {
245 static const struct frr_yang_module_info
*const zebra_yang_modules
[] = {
252 zebra
, ZEBRA
, .vty_port
= ZEBRA_VTY_PORT
, .flags
= FRR_NO_ZCLIENT
,
255 "Daemon which manages kernel routing table management "
256 "and\nredistribution between different routing protocols.",
258 .signals
= zebra_signals
, .n_signals
= array_size(zebra_signals
),
260 .privs
= &zserv_privs
,
262 .yang_modules
= zebra_yang_modules
,
263 .n_yang_modules
= array_size(zebra_yang_modules
), )
265 /* Main startup routine. */
266 int main(int argc
, char **argv
)
268 // int batch_mode = 0;
269 char *zserv_path
= NULL
;
270 char *vrf_default_name_configured
= NULL
;
271 struct sockaddr_storage dummy
;
273 #if defined(HANDLE_ZAPI_FUZZING)
274 char *zapi_fuzzing
= NULL
;
275 #endif /* HANDLE_ZAPI_FUZZING */
276 #if defined(HANDLE_NETLINK_FUZZING)
277 char *netlink_fuzzing
= NULL
;
278 #endif /* HANDLE_NETLINK_FUZZING */
280 graceful_restart
= 0;
281 vrf_configure_backend(VRF_BACKEND_VRF_LITE
);
283 frr_preinit(&zebra_di
, argc
, argv
);
290 #if defined(HANDLE_ZAPI_FUZZING)
292 #endif /* HANDLE_ZAPI_FUZZING */
293 #if defined(HANDLE_NETLINK_FUZZING)
295 #endif /* HANDLE_NETLINK_FUZZING */
298 " -b, --batch Runs in batch mode\n"
299 " -a, --allow_delete Allow other processes to delete zebra routes\n"
300 " -z, --socket Set path of zebra socket\n"
301 " -e, --ecmp Specify ECMP to use.\n"
302 " -r, --retain When program terminates, retain added route by zebra.\n"
303 " -o, --vrfdefaultname Set default VRF name.\n"
304 " -K, --graceful_restart Graceful restart at the kernel level, timer in seconds for expiration\n"
306 " -n, --vrfwnetns Use NetNS as VRF backend\n"
307 " -s, --nl-bufsize Set netlink receive buffer size\n"
308 " --v6-rr-semantics Use v6 RR semantics\n"
309 #endif /* HAVE_NETLINK */
310 #if defined(HANDLE_ZAPI_FUZZING)
311 " -c <file> Bypass normal startup and use this file for testing of zapi\n"
312 #endif /* HANDLE_ZAPI_FUZZING */
313 #if defined(HANDLE_NETLINK_FUZZING)
314 " -w <file> Bypass normal startup and use this file for testing of netlink input\n"
315 #endif /* HANDLE_NETLINK_FUZZING */
319 int opt
= frr_getopt(argc
, argv
, NULL
);
334 zrouter
.multipath_num
= atoi(optarg
);
335 if (zrouter
.multipath_num
> MULTIPATH_NUM
336 || zrouter
.multipath_num
<= 0) {
338 EC_ZEBRA_BAD_MULTIPATH_NUM
,
339 "Multipath Number specified must be less than %d and greater than 0",
345 vrf_default_name_configured
= optarg
;
349 if (!frr_zclient_addr(&dummy
, &dummylen
, optarg
)) {
351 "Invalid zserv socket path: %s\n",
360 graceful_restart
= atoi(optarg
);
364 nl_rcvbufsize
= atoi(optarg
);
367 vrf_configure_backend(VRF_BACKEND_NETNS
);
369 case OPTION_V6_RR_SEMANTICS
:
370 v6_rr_semantics
= true;
372 #endif /* HAVE_NETLINK */
373 #if defined(HANDLE_ZAPI_FUZZING)
375 zapi_fuzzing
= optarg
;
377 #endif /* HANDLE_ZAPI_FUZZING */
378 #if defined(HANDLE_NETLINK_FUZZING)
380 netlink_fuzzing
= optarg
;
381 /* This ensures we are aren't writing any of the
382 * startup netlink messages that happen when we
387 #endif /* HANDLE_NETLINK_FUZZING */
394 zrouter
.master
= frr_init();
396 /* Zebra related initialize. */
402 router_id_cmd_init();
405 * Initialize NS( and implicitly the VRF module), and make kernel
407 zebra_ns_init((const char *)vrf_default_name_configured
);
411 #if defined(HAVE_RTADV)
415 #ifdef ZEBRA_PTM_SUPPORT
420 zebra_mpls_vty_init();
424 /* For debug purpose. */
425 /* SET_FLAG (zebra_debug_event, ZEBRA_DEBUG_EVENT); */
427 /* Process the configuration file. Among other configuration
428 * directives we can meet those installing static routes. Such
429 * requests will not be executed immediately, but queued in
430 * zebra->ribq structure until we enter the main execution loop.
431 * The notifications from kernel will show originating PID equal
432 * to that after daemon() completes (if ever called).
436 /* After we have successfully acquired the pidfile, we can be sure
437 * about being the only copy of zebra process, which is submitting
438 * changes to the FIB.
439 * Clean up zebra-originated routes. The requests will be sent to OS
440 * immediately, so originating PID in notifications from kernel
441 * will be equal to the current getpid(). To know about such routes,
442 * we have to have route_read() called before.
444 zrouter
.startup_time
= monotime(NULL
);
445 thread_add_timer(zrouter
.master
, rib_sweep_route
,
446 NULL
, graceful_restart
, NULL
);
448 /* Needed for BSD routing socket. */
451 /* Start dataplane system */
452 zebra_dplane_start();
454 /* Start Zebra API server */
455 zserv_start(zserv_path
);
457 /* Init label manager */
458 label_manager_init();
463 /* Config handler Init */
469 #if defined(HANDLE_ZAPI_FUZZING)
471 zserv_read_file(zapi_fuzzing
);
474 #endif /* HANDLE_ZAPI_FUZZING */
475 #if defined(HANDLE_NETLINK_FUZZING)
476 if (netlink_fuzzing
) {
477 netlink_read_init(netlink_fuzzing
);
480 #endif /* HANDLE_NETLINK_FUZZING */
483 frr_run(zrouter
.master
);