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"
58 #include "zebra/zebra_opaque.h"
60 #if defined(HANDLE_NETLINK_FUZZING)
61 #include "zebra/kernel_netlink.h"
62 #endif /* HANDLE_NETLINK_FUZZING */
64 #define ZEBRA_PTM_SUPPORT
69 /* Pacify zclient.o in libfrr, which expects this variable. */
70 struct thread_master
*master
;
72 /* Route retain mode flag. */
75 /* Allow non-quagga entities to delete quagga routes */
80 bool v6_rr_semantics
= false;
83 /* Receive buffer size for netlink socket */
84 uint32_t nl_rcvbufsize
= 4194304;
85 #endif /* HAVE_NETLINK */
87 #define OPTION_V6_RR_SEMANTICS 2000
88 /* Command line options. */
89 const struct option longopts
[] = {
90 {"batch", no_argument
, NULL
, 'b'},
91 {"allow_delete", no_argument
, NULL
, 'a'},
92 {"keep_kernel", no_argument
, NULL
, 'k'},
93 {"socket", required_argument
, NULL
, 'z'},
94 {"ecmp", required_argument
, NULL
, 'e'},
95 {"retain", no_argument
, NULL
, 'r'},
96 {"vrfdefaultname", required_argument
, NULL
, 'o'},
97 {"graceful_restart", required_argument
, NULL
, 'K'},
99 {"vrfwnetns", no_argument
, NULL
, 'n'},
100 {"nl-bufsize", required_argument
, NULL
, 's'},
101 {"v6-rr-semantics", no_argument
, NULL
, OPTION_V6_RR_SEMANTICS
},
102 #endif /* HAVE_NETLINK */
105 zebra_capabilities_t _caps_p
[] = {
106 ZCAP_NET_ADMIN
, ZCAP_SYS_ADMIN
, ZCAP_NET_RAW
,
109 /* zebra privileges to run with */
110 struct zebra_privs_t zserv_privs
= {
111 #if defined(FRR_USER) && defined(FRR_GROUP)
116 .vty_group
= VTY_GROUP
,
119 .cap_num_p
= array_size(_caps_p
),
122 /* SIGHUP handler. */
123 static void sighup(void)
125 zlog_info("SIGHUP received");
127 /* Reload of config file. */
131 /* SIGINT handler. */
132 static void sigint(void)
135 struct zebra_vrf
*zvrf
;
136 struct listnode
*ln
, *nn
;
137 struct zserv
*client
;
138 static bool sigint_done
;
145 zlog_notice("Terminating on signal");
147 atomic_store_explicit(&zrouter
.in_shutdown
, true,
148 memory_order_relaxed
);
150 /* send RA lifetime of 0 before stopping. rfc4861/6.2.5 */
155 /* Stop the opaque module pthread */
158 zebra_dplane_pre_finish();
160 /* Clean up GR related info. */
161 zebra_gr_stale_client_cleanup(zrouter
.stale_client_list
);
162 list_delete_all_node(zrouter
.stale_client_list
);
164 /* Clean up zapi clients and server module */
165 for (ALL_LIST_ELEMENTS(zrouter
.client_list
, ln
, nn
, client
))
166 zserv_close_client(client
);
169 list_delete_all_node(zrouter
.client_list
);
171 /* Once all the zclients are cleaned up, clean up the opaque module */
172 zebra_opaque_finish();
177 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
180 SET_FLAG(zvrf
->flags
, ZEBRA_VRF_RETAIN
);
182 if (zrouter
.lsp_process_q
)
183 work_queue_free_and_null(&zrouter
.lsp_process_q
);
188 ns_walk_func(zebra_ns_early_shutdown
, NULL
, NULL
);
189 zebra_ns_notify_close();
194 * zebra_routemap_finish will
195 * 1 set rmap upd timer to 0 so that rmap update wont be scheduled again
196 * 2 Put off the rmap update thread
199 zebra_routemap_finish();
201 list_delete(&zrouter
.client_list
);
203 /* Indicate that all new dplane work has been enqueued. When that
204 * work is complete, the dataplane will enqueue an event
205 * with the 'finalize' function.
207 zebra_dplane_finish();
211 * Final shutdown step for the zebra main thread. This is run after all
212 * async update processing has completed.
214 int zebra_finalize(struct thread
*dummy
)
216 zlog_info("Zebra final shutdown");
218 /* Final shutdown of ns resources */
219 ns_walk_func(zebra_ns_final_shutdown
, NULL
, NULL
);
221 /* Stop dplane thread and finish any cleanup */
222 zebra_dplane_shutdown();
224 zebra_router_terminate();
230 /* SIGUSR1 handler. */
231 static void sigusr1(void)
236 struct quagga_signal_t zebra_signals
[] = {
255 static const struct frr_yang_module_info
*const zebra_yang_modules
[] = {
263 zebra
, ZEBRA
, .vty_port
= ZEBRA_VTY_PORT
, .flags
= FRR_NO_ZCLIENT
,
266 "Daemon which manages kernel routing table management "
267 "and\nredistribution between different routing protocols.",
269 .signals
= zebra_signals
, .n_signals
= array_size(zebra_signals
),
271 .privs
= &zserv_privs
,
273 .yang_modules
= zebra_yang_modules
,
274 .n_yang_modules
= array_size(zebra_yang_modules
), )
276 /* Main startup routine. */
277 int main(int argc
, char **argv
)
279 // int batch_mode = 0;
280 char *zserv_path
= NULL
;
281 char *vrf_default_name_configured
= NULL
;
282 struct sockaddr_storage dummy
;
284 #if defined(HANDLE_ZAPI_FUZZING)
285 char *zapi_fuzzing
= NULL
;
286 #endif /* HANDLE_ZAPI_FUZZING */
287 #if defined(HANDLE_NETLINK_FUZZING)
288 char *netlink_fuzzing
= NULL
;
289 #endif /* HANDLE_NETLINK_FUZZING */
291 graceful_restart
= 0;
292 vrf_configure_backend(VRF_BACKEND_VRF_LITE
);
294 frr_preinit(&zebra_di
, argc
, argv
);
301 #if defined(HANDLE_ZAPI_FUZZING)
303 #endif /* HANDLE_ZAPI_FUZZING */
304 #if defined(HANDLE_NETLINK_FUZZING)
306 #endif /* HANDLE_NETLINK_FUZZING */
309 " -b, --batch Runs in batch mode\n"
310 " -a, --allow_delete Allow other processes to delete zebra routes\n"
311 " -z, --socket Set path of zebra socket\n"
312 " -e, --ecmp Specify ECMP to use.\n"
313 " -r, --retain When program terminates, retain added route by zebra.\n"
314 " -o, --vrfdefaultname Set default VRF name.\n"
315 " -K, --graceful_restart Graceful restart at the kernel level, timer in seconds for expiration\n"
317 " -n, --vrfwnetns Use NetNS as VRF backend\n"
318 " -s, --nl-bufsize Set netlink receive buffer size\n"
319 " --v6-rr-semantics Use v6 RR semantics\n"
320 #endif /* HAVE_NETLINK */
321 #if defined(HANDLE_ZAPI_FUZZING)
322 " -c <file> Bypass normal startup and use this file for testing of zapi\n"
323 #endif /* HANDLE_ZAPI_FUZZING */
324 #if defined(HANDLE_NETLINK_FUZZING)
325 " -w <file> Bypass normal startup and use this file for testing of netlink input\n"
326 #endif /* HANDLE_NETLINK_FUZZING */
330 int opt
= frr_getopt(argc
, argv
, NULL
);
345 unsigned long int parsed_multipath
=
346 strtoul(optarg
, NULL
, 10);
347 if (parsed_multipath
== 0
348 || parsed_multipath
> MULTIPATH_NUM
349 || parsed_multipath
> UINT32_MAX
) {
351 EC_ZEBRA_BAD_MULTIPATH_NUM
,
352 "Multipath Number specified must be less than %u and greater than 0",
356 zrouter
.multipath_num
= parsed_multipath
;
360 vrf_default_name_configured
= optarg
;
364 if (!frr_zclient_addr(&dummy
, &dummylen
, optarg
)) {
366 "Invalid zserv socket path: %s\n",
375 graceful_restart
= atoi(optarg
);
379 nl_rcvbufsize
= atoi(optarg
);
382 vrf_configure_backend(VRF_BACKEND_NETNS
);
384 case OPTION_V6_RR_SEMANTICS
:
385 v6_rr_semantics
= true;
387 #endif /* HAVE_NETLINK */
388 #if defined(HANDLE_ZAPI_FUZZING)
390 zapi_fuzzing
= optarg
;
392 #endif /* HANDLE_ZAPI_FUZZING */
393 #if defined(HANDLE_NETLINK_FUZZING)
395 netlink_fuzzing
= optarg
;
396 /* This ensures we are aren't writing any of the
397 * startup netlink messages that happen when we
402 #endif /* HANDLE_NETLINK_FUZZING */
409 zrouter
.master
= frr_init();
411 /* Zebra related initialize. */
417 router_id_cmd_init();
420 * Initialize NS( and implicitly the VRF module), and make kernel
422 zebra_ns_init((const char *)vrf_default_name_configured
);
426 #if defined(HAVE_RTADV)
430 #ifdef ZEBRA_PTM_SUPPORT
435 zebra_mpls_vty_init();
440 /* For debug purpose. */
441 /* SET_FLAG (zebra_debug_event, ZEBRA_DEBUG_EVENT); */
443 /* Process the configuration file. Among other configuration
444 * directives we can meet those installing static routes. Such
445 * requests will not be executed immediately, but queued in
446 * zebra->ribq structure until we enter the main execution loop.
447 * The notifications from kernel will show originating PID equal
448 * to that after daemon() completes (if ever called).
452 /* After we have successfully acquired the pidfile, we can be sure
453 * about being the only copy of zebra process, which is submitting
454 * changes to the FIB.
455 * Clean up zebra-originated routes. The requests will be sent to OS
456 * immediately, so originating PID in notifications from kernel
457 * will be equal to the current getpid(). To know about such routes,
458 * we have to have route_read() called before.
460 zrouter
.startup_time
= monotime(NULL
);
461 thread_add_timer(zrouter
.master
, rib_sweep_route
,
462 NULL
, graceful_restart
, NULL
);
464 /* Needed for BSD routing socket. */
467 /* Start dataplane system */
468 zebra_dplane_start();
470 /* Start the ted module, before zserv */
471 zebra_opaque_start();
473 /* Start Zebra API server */
474 zserv_start(zserv_path
);
476 /* Init label manager */
477 label_manager_init();
482 /* Config handler Init */
488 #if defined(HANDLE_ZAPI_FUZZING)
490 zserv_read_file(zapi_fuzzing
);
493 #endif /* HANDLE_ZAPI_FUZZING */
494 #if defined(HANDLE_NETLINK_FUZZING)
495 if (netlink_fuzzing
) {
496 netlink_read_init(netlink_fuzzing
);
499 #endif /* HANDLE_NETLINK_FUZZING */
502 frr_run(zrouter
.master
);