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"
37 #include "logicalrouter.h"
40 #include "frr_pthread.h"
42 #include "zebra/zebra_router.h"
43 #include "zebra/zebra_errors.h"
44 #include "zebra/rib.h"
45 #include "zebra/zserv.h"
46 #include "zebra/debug.h"
47 #include "zebra/router-id.h"
48 #include "zebra/irdp.h"
49 #include "zebra/rtadv.h"
50 #include "zebra/zebra_ptm.h"
51 #include "zebra/zebra_ns.h"
52 #include "zebra/redistribute.h"
53 #include "zebra/zebra_mpls.h"
54 #include "zebra/label_manager.h"
55 #include "zebra/zebra_netns_notify.h"
56 #include "zebra/zebra_rnh.h"
57 #include "zebra/zebra_pbr.h"
59 #if defined(HANDLE_NETLINK_FUZZING)
60 #include "zebra/kernel_netlink.h"
61 #endif /* HANDLE_NETLINK_FUZZING */
63 #define ZEBRA_PTM_SUPPORT
66 struct zebra_t zebrad
= {
67 .rtm_table_default
= 0,
68 .packets_to_process
= ZEBRA_ZAPI_PACKETS_TO_PROCESS
,
74 /* Pacify zclient.o in libfrr, which expects this variable. */
75 struct thread_master
*master
;
77 /* Route retain mode flag. */
80 /* Allow non-quagga entities to delete quagga routes */
83 /* Don't delete kernel route. */
84 int keep_kernel_mode
= 0;
86 bool v6_rr_semantics
= false;
89 /* Receive buffer size for netlink socket */
90 uint32_t nl_rcvbufsize
= 4194304;
91 #endif /* HAVE_NETLINK */
93 #define OPTION_V6_RR_SEMANTICS 2000
94 /* Command line options. */
95 struct option longopts
[] = {
96 {"batch", no_argument
, NULL
, 'b'},
97 {"allow_delete", no_argument
, NULL
, 'a'},
98 {"keep_kernel", no_argument
, NULL
, 'k'},
99 {"socket", required_argument
, NULL
, 'z'},
100 {"ecmp", required_argument
, NULL
, 'e'},
101 {"label_socket", no_argument
, NULL
, 'l'},
102 {"retain", no_argument
, NULL
, 'r'},
103 {"vrfdefaultname", required_argument
, NULL
, 'o'},
105 {"vrfwnetns", no_argument
, NULL
, 'n'},
106 {"nl-bufsize", required_argument
, NULL
, 's'},
107 {"v6-rr-semantics", no_argument
, NULL
, OPTION_V6_RR_SEMANTICS
},
108 #endif /* HAVE_NETLINK */
111 zebra_capabilities_t _caps_p
[] = {
112 ZCAP_NET_ADMIN
, ZCAP_SYS_ADMIN
, ZCAP_NET_RAW
,
115 /* zebra privileges to run with */
116 struct zebra_privs_t zserv_privs
= {
117 #if defined(FRR_USER) && defined(FRR_GROUP)
122 .vty_group
= VTY_GROUP
,
125 .cap_num_p
= array_size(_caps_p
),
128 unsigned int multipath_num
= MULTIPATH_NUM
;
130 /* SIGHUP handler. */
131 static void sighup(void)
133 zlog_info("SIGHUP received");
135 /* Reload of config file. */
139 /* SIGINT handler. */
140 static void sigint(void)
143 struct zebra_vrf
*zvrf
;
144 struct listnode
*ln
, *nn
;
145 struct zserv
*client
;
146 static bool sigint_done
;
153 zlog_notice("Terminating on signal");
157 zebra_dplane_pre_finish();
159 for (ALL_LIST_ELEMENTS(zebrad
.client_list
, ln
, nn
, client
))
160 zserv_close_client(client
);
162 list_delete_all_node(zebrad
.client_list
);
166 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
169 SET_FLAG(zvrf
->flags
, ZEBRA_VRF_RETAIN
);
171 if (zebrad
.lsp_process_q
)
172 work_queue_free_and_null(&zebrad
.lsp_process_q
);
175 ns_walk_func(zebra_ns_disabled
);
176 zebra_ns_notify_close();
182 list_delete(&zebrad
.client_list
);
184 /* Indicate that all new dplane work has been enqueued. When that
185 * work is complete, the dataplane will enqueue an event
186 * with the 'finalize' function.
188 zebra_dplane_finish();
192 * Final shutdown step for the zebra main thread. This is run after all
193 * async update processing has completed.
195 int zebra_finalize(struct thread
*dummy
)
197 zlog_info("Zebra final shutdown");
199 /* Stop dplane thread and finish any cleanup */
200 zebra_dplane_shutdown();
202 work_queue_free_and_null(&zebrad
.ribq
);
203 meta_queue_free(zebrad
.mq
);
205 zebra_router_terminate();
211 /* SIGUSR1 handler. */
212 static void sigusr1(void)
217 struct quagga_signal_t zebra_signals
[] = {
236 static const struct frr_yang_module_info
*zebra_yang_modules
[] = {
241 zebra
, ZEBRA
, .vty_port
= ZEBRA_VTY_PORT
, .flags
= FRR_NO_ZCLIENT
,
244 "Daemon which manages kernel routing table management "
245 "and\nredistribution between different routing protocols.",
247 .signals
= zebra_signals
, .n_signals
= array_size(zebra_signals
),
249 .privs
= &zserv_privs
,
251 .yang_modules
= zebra_yang_modules
,
252 .n_yang_modules
= array_size(zebra_yang_modules
), )
254 /* Main startup routine. */
255 int main(int argc
, char **argv
)
257 // int batch_mode = 0;
258 char *zserv_path
= NULL
;
259 /* Socket to external label manager */
260 char *lblmgr_path
= NULL
;
261 struct sockaddr_storage dummy
;
263 #if defined(HANDLE_ZAPI_FUZZING)
264 char *zapi_fuzzing
= NULL
;
265 #endif /* HANDLE_ZAPI_FUZZING */
266 #if defined(HANDLE_NETLINK_FUZZING)
267 char *netlink_fuzzing
= NULL
;
268 #endif /* HANDLE_NETLINK_FUZZING */
270 vrf_configure_backend(VRF_BACKEND_VRF_LITE
);
271 logicalrouter_configure_backend(LOGICALROUTER_BACKEND_NETNS
);
273 frr_preinit(&zebra_di
, argc
, argv
);
280 #if defined(HANDLE_ZAPI_FUZZING)
282 #endif /* HANDLE_ZAPI_FUZZING */
283 #if defined(HANDLE_NETLINK_FUZZING)
285 #endif /* HANDLE_NETLINK_FUZZING */
288 " -b, --batch Runs in batch mode\n"
289 " -a, --allow_delete Allow other processes to delete zebra routes\n"
290 " -z, --socket Set path of zebra socket\n"
291 " -e, --ecmp Specify ECMP to use.\n"
292 " -l, --label_socket Socket to external label manager\n"
293 " -k, --keep_kernel Don't delete old routes which were installed by zebra.\n"
294 " -r, --retain When program terminates, retain added route by zebra.\n"
295 " -o, --vrfdefaultname Set default VRF name.\n"
297 " -n, --vrfwnetns Use NetNS as VRF backend\n"
298 " -s, --nl-bufsize Set netlink receive buffer size\n"
299 " --v6-rr-semantics Use v6 RR semantics\n"
300 #endif /* HAVE_NETLINK */
301 #if defined(HANDLE_ZAPI_FUZZING)
302 " -c <file> Bypass normal startup and use this file for testing of zapi\n"
303 #endif /* HANDLE_ZAPI_FUZZING */
304 #if defined(HANDLE_NETLINK_FUZZING)
305 " -w <file> Bypass normal startup and use this file for testing of netlink input\n"
306 #endif /* HANDLE_NETLINK_FUZZING */
310 int opt
= frr_getopt(argc
, argv
, NULL
);
325 keep_kernel_mode
= 1;
328 multipath_num
= atoi(optarg
);
329 if (multipath_num
> MULTIPATH_NUM
330 || multipath_num
<= 0) {
332 EC_ZEBRA_BAD_MULTIPATH_NUM
,
333 "Multipath Number specified must be less than %d and greater than 0",
339 vrf_set_default_name(optarg
);
343 if (!frr_zclient_addr(&dummy
, &dummylen
, optarg
)) {
345 "Invalid zserv socket path: %s\n",
351 lblmgr_path
= optarg
;
358 nl_rcvbufsize
= atoi(optarg
);
361 vrf_configure_backend(VRF_BACKEND_NETNS
);
362 logicalrouter_configure_backend(
363 LOGICALROUTER_BACKEND_OFF
);
365 case OPTION_V6_RR_SEMANTICS
:
366 v6_rr_semantics
= true;
368 #endif /* HAVE_NETLINK */
369 #if defined(HANDLE_ZAPI_FUZZING)
371 zapi_fuzzing
= optarg
;
373 #endif /* HANDLE_ZAPI_FUZZING */
374 #if defined(HANDLE_NETLINK_FUZZING)
376 netlink_fuzzing
= optarg
;
377 /* This ensures we are aren't writing any of the
378 * startup netlink messages that happen when we
383 #endif /* HANDLE_NETLINK_FUZZING */
390 zebrad
.master
= frr_init();
392 /* Zebra related initialize. */
398 router_id_cmd_init();
401 * Initialize NS( and implicitly the VRF module), and make kernel
408 #if defined(HAVE_RTADV)
412 #ifdef ZEBRA_PTM_SUPPORT
417 zebra_mpls_vty_init();
421 /* For debug purpose. */
422 /* SET_FLAG (zebra_debug_event, ZEBRA_DEBUG_EVENT); */
424 /* Process the configuration file. Among other configuration
425 * directives we can meet those installing static routes. Such
426 * requests will not be executed immediately, but queued in
427 * zebra->ribq structure until we enter the main execution loop.
428 * The notifications from kernel will show originating PID equal
429 * to that after daemon() completes (if ever called).
433 /* After we have successfully acquired the pidfile, we can be sure
434 * about being the only copy of zebra process, which is submitting
435 * changes to the FIB.
436 * Clean up zebra-originated routes. The requests will be sent to OS
437 * immediately, so originating PID in notifications from kernel
438 * will be equal to the current getpid(). To know about such routes,
439 * we have to have route_read() called before.
441 if (!keep_kernel_mode
)
444 /* Needed for BSD routing socket. */
447 /* Intialize pthread library */
450 /* Start Zebra API server */
451 zserv_start(zserv_path
);
453 /* Init label manager */
454 label_manager_init(lblmgr_path
);
462 #if defined(HANDLE_ZAPI_FUZZING)
464 zserv_read_file(zapi_fuzzing
);
467 #endif /* HANDLE_ZAPI_FUZZING */
468 #if defined(HANDLE_NETLINK_FUZZING)
469 if (netlink_fuzzing
) {
470 netlink_read_init(netlink_fuzzing
);
473 #endif /* HANDLE_NETLINK_FUZZING */
476 frr_run(zebrad
.master
);