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"
30 #include "memory_vty.h"
40 #include "zebra/zebra_router.h"
41 #include "zebra/zebra_errors.h"
42 #include "zebra/rib.h"
43 #include "zebra/zserv.h"
44 #include "zebra/debug.h"
45 #include "zebra/router-id.h"
46 #include "zebra/irdp.h"
47 #include "zebra/rtadv.h"
48 #include "zebra/zebra_ptm.h"
49 #include "zebra/zebra_ns.h"
50 #include "zebra/redistribute.h"
51 #include "zebra/zebra_mpls.h"
52 #include "zebra/label_manager.h"
53 #include "zebra/zebra_netns_notify.h"
54 #include "zebra/zebra_rnh.h"
55 #include "zebra/zebra_pbr.h"
56 #include "zebra/zebra_vxlan.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 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
);
150 zebra_dplane_pre_finish();
152 for (ALL_LIST_ELEMENTS(zrouter
.client_list
, ln
, nn
, client
))
153 zserv_close_client(client
);
156 list_delete_all_node(zrouter
.client_list
);
161 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
164 SET_FLAG(zvrf
->flags
, ZEBRA_VRF_RETAIN
);
166 if (zrouter
.lsp_process_q
)
167 work_queue_free_and_null(&zrouter
.lsp_process_q
);
170 ns_walk_func(zebra_ns_early_shutdown
);
171 zebra_ns_notify_close();
177 list_delete(&zrouter
.client_list
);
179 /* Indicate that all new dplane work has been enqueued. When that
180 * work is complete, the dataplane will enqueue an event
181 * with the 'finalize' function.
183 zebra_dplane_finish();
187 * Final shutdown step for the zebra main thread. This is run after all
188 * async update processing has completed.
190 int zebra_finalize(struct thread
*dummy
)
192 zlog_info("Zebra final shutdown");
194 /* Final shutdown of ns resources */
195 ns_walk_func(zebra_ns_final_shutdown
);
197 /* Stop dplane thread and finish any cleanup */
198 zebra_dplane_shutdown();
200 zebra_router_terminate();
206 /* SIGUSR1 handler. */
207 static void sigusr1(void)
212 struct quagga_signal_t zebra_signals
[] = {
231 static const struct frr_yang_module_info
*zebra_yang_modules
[] = {
236 zebra
, ZEBRA
, .vty_port
= ZEBRA_VTY_PORT
, .flags
= FRR_NO_ZCLIENT
,
239 "Daemon which manages kernel routing table management "
240 "and\nredistribution between different routing protocols.",
242 .signals
= zebra_signals
, .n_signals
= array_size(zebra_signals
),
244 .privs
= &zserv_privs
,
246 .yang_modules
= zebra_yang_modules
,
247 .n_yang_modules
= array_size(zebra_yang_modules
), )
249 /* Main startup routine. */
250 int main(int argc
, char **argv
)
252 // int batch_mode = 0;
253 char *zserv_path
= NULL
;
254 char *vrf_default_name_configured
= NULL
;
255 struct sockaddr_storage dummy
;
257 #if defined(HANDLE_ZAPI_FUZZING)
258 char *zapi_fuzzing
= NULL
;
259 #endif /* HANDLE_ZAPI_FUZZING */
260 #if defined(HANDLE_NETLINK_FUZZING)
261 char *netlink_fuzzing
= NULL
;
262 #endif /* HANDLE_NETLINK_FUZZING */
264 graceful_restart
= 0;
265 vrf_configure_backend(VRF_BACKEND_VRF_LITE
);
267 frr_preinit(&zebra_di
, argc
, argv
);
274 #if defined(HANDLE_ZAPI_FUZZING)
276 #endif /* HANDLE_ZAPI_FUZZING */
277 #if defined(HANDLE_NETLINK_FUZZING)
279 #endif /* HANDLE_NETLINK_FUZZING */
282 " -b, --batch Runs in batch mode\n"
283 " -a, --allow_delete Allow other processes to delete zebra routes\n"
284 " -z, --socket Set path of zebra socket\n"
285 " -e, --ecmp Specify ECMP to use.\n"
286 " -r, --retain When program terminates, retain added route by zebra.\n"
287 " -o, --vrfdefaultname Set default VRF name.\n"
288 " -K, --graceful_restart Graceful restart at the kernel level, timer in seconds for expiration\n"
290 " -n, --vrfwnetns Use NetNS as VRF backend\n"
291 " -s, --nl-bufsize Set netlink receive buffer size\n"
292 " --v6-rr-semantics Use v6 RR semantics\n"
293 #endif /* HAVE_NETLINK */
294 #if defined(HANDLE_ZAPI_FUZZING)
295 " -c <file> Bypass normal startup and use this file for testing of zapi\n"
296 #endif /* HANDLE_ZAPI_FUZZING */
297 #if defined(HANDLE_NETLINK_FUZZING)
298 " -w <file> Bypass normal startup and use this file for testing of netlink input\n"
299 #endif /* HANDLE_NETLINK_FUZZING */
303 int opt
= frr_getopt(argc
, argv
, NULL
);
318 zrouter
.multipath_num
= atoi(optarg
);
319 if (zrouter
.multipath_num
> MULTIPATH_NUM
320 || zrouter
.multipath_num
<= 0) {
322 EC_ZEBRA_BAD_MULTIPATH_NUM
,
323 "Multipath Number specified must be less than %d and greater than 0",
329 vrf_default_name_configured
= optarg
;
333 if (!frr_zclient_addr(&dummy
, &dummylen
, optarg
)) {
335 "Invalid zserv socket path: %s\n",
344 graceful_restart
= atoi(optarg
);
348 nl_rcvbufsize
= atoi(optarg
);
351 vrf_configure_backend(VRF_BACKEND_NETNS
);
353 case OPTION_V6_RR_SEMANTICS
:
354 v6_rr_semantics
= true;
356 #endif /* HAVE_NETLINK */
357 #if defined(HANDLE_ZAPI_FUZZING)
359 zapi_fuzzing
= optarg
;
361 #endif /* HANDLE_ZAPI_FUZZING */
362 #if defined(HANDLE_NETLINK_FUZZING)
364 netlink_fuzzing
= optarg
;
365 /* This ensures we are aren't writing any of the
366 * startup netlink messages that happen when we
371 #endif /* HANDLE_NETLINK_FUZZING */
378 zrouter
.master
= frr_init();
380 /* Zebra related initialize. */
386 router_id_cmd_init();
389 * Initialize NS( and implicitly the VRF module), and make kernel
391 zebra_ns_init((const char *)vrf_default_name_configured
);
395 #if defined(HAVE_RTADV)
399 #ifdef ZEBRA_PTM_SUPPORT
404 zebra_mpls_vty_init();
408 /* For debug purpose. */
409 /* SET_FLAG (zebra_debug_event, ZEBRA_DEBUG_EVENT); */
411 /* Process the configuration file. Among other configuration
412 * directives we can meet those installing static routes. Such
413 * requests will not be executed immediately, but queued in
414 * zebra->ribq structure until we enter the main execution loop.
415 * The notifications from kernel will show originating PID equal
416 * to that after daemon() completes (if ever called).
420 /* After we have successfully acquired the pidfile, we can be sure
421 * about being the only copy of zebra process, which is submitting
422 * changes to the FIB.
423 * Clean up zebra-originated routes. The requests will be sent to OS
424 * immediately, so originating PID in notifications from kernel
425 * will be equal to the current getpid(). To know about such routes,
426 * we have to have route_read() called before.
428 zrouter
.startup_time
= monotime(NULL
);
429 thread_add_timer(zrouter
.master
, rib_sweep_route
,
430 NULL
, graceful_restart
, NULL
);
432 /* Needed for BSD routing socket. */
435 /* Start dataplane system */
436 zebra_dplane_start();
438 /* Start Zebra API server */
439 zserv_start(zserv_path
);
441 /* Init label manager */
442 label_manager_init();
447 /* Config handler Init */
453 #if defined(HANDLE_ZAPI_FUZZING)
455 zserv_read_file(zapi_fuzzing
);
458 #endif /* HANDLE_ZAPI_FUZZING */
459 #if defined(HANDLE_NETLINK_FUZZING)
460 if (netlink_fuzzing
) {
461 netlink_read_init(netlink_fuzzing
);
464 #endif /* HANDLE_NETLINK_FUZZING */
467 frr_run(zrouter
.master
);