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
68 /* Pacify zclient.o in libfrr, which expects this variable. */
69 struct thread_master
*master
;
71 /* Route retain mode flag. */
74 /* Allow non-quagga entities to delete quagga routes */
77 /* Don't delete kernel route. */
78 int keep_kernel_mode
= 0;
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 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 {"label_socket", no_argument
, NULL
, 'l'},
96 {"retain", no_argument
, NULL
, 'r'},
97 {"vrfdefaultname", required_argument
, NULL
, 'o'},
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 unsigned int multipath_num
= MULTIPATH_NUM
;
124 /* SIGHUP handler. */
125 static void sighup(void)
127 zlog_info("SIGHUP received");
129 /* Reload of config file. */
133 /* SIGINT handler. */
134 static void sigint(void)
137 struct zebra_vrf
*zvrf
;
138 struct listnode
*ln
, *nn
;
139 struct zserv
*client
;
140 static bool sigint_done
;
147 zlog_notice("Terminating on signal");
151 zebra_dplane_pre_finish();
153 for (ALL_LIST_ELEMENTS(zrouter
.client_list
, ln
, nn
, client
))
154 zserv_close_client(client
);
157 list_delete_all_node(zrouter
.client_list
);
162 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
165 SET_FLAG(zvrf
->flags
, ZEBRA_VRF_RETAIN
);
167 if (zrouter
.lsp_process_q
)
168 work_queue_free_and_null(&zrouter
.lsp_process_q
);
171 ns_walk_func(zebra_ns_early_shutdown
);
172 zebra_ns_notify_close();
178 list_delete(&zrouter
.client_list
);
180 /* Indicate that all new dplane work has been enqueued. When that
181 * work is complete, the dataplane will enqueue an event
182 * with the 'finalize' function.
184 zebra_dplane_finish();
188 * Final shutdown step for the zebra main thread. This is run after all
189 * async update processing has completed.
191 int zebra_finalize(struct thread
*dummy
)
193 zlog_info("Zebra final shutdown");
195 /* Final shutdown of ns resources */
196 ns_walk_func(zebra_ns_final_shutdown
);
198 /* Stop dplane thread and finish any cleanup */
199 zebra_dplane_shutdown();
201 zebra_router_terminate();
207 /* SIGUSR1 handler. */
208 static void sigusr1(void)
213 struct quagga_signal_t zebra_signals
[] = {
232 static const struct frr_yang_module_info
*zebra_yang_modules
[] = {
237 zebra
, ZEBRA
, .vty_port
= ZEBRA_VTY_PORT
, .flags
= FRR_NO_ZCLIENT
,
240 "Daemon which manages kernel routing table management "
241 "and\nredistribution between different routing protocols.",
243 .signals
= zebra_signals
, .n_signals
= array_size(zebra_signals
),
245 .privs
= &zserv_privs
,
247 .yang_modules
= zebra_yang_modules
,
248 .n_yang_modules
= array_size(zebra_yang_modules
), )
250 /* Main startup routine. */
251 int main(int argc
, char **argv
)
253 // int batch_mode = 0;
254 char *zserv_path
= NULL
;
255 char *vrf_default_name_configured
= NULL
;
256 /* Socket to external label manager */
257 char *lblmgr_path
= 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 vrf_configure_backend(VRF_BACKEND_VRF_LITE
);
268 logicalrouter_configure_backend(LOGICALROUTER_BACKEND_NETNS
);
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 " -l, --label_socket Socket to external label manager\n"
290 " -k, --keep_kernel Don't delete old routes which were installed by zebra.\n"
291 " -r, --retain When program terminates, retain added route by zebra.\n"
292 " -o, --vrfdefaultname Set default VRF name.\n"
294 " -n, --vrfwnetns Use NetNS as VRF backend\n"
295 " -s, --nl-bufsize Set netlink receive buffer size\n"
296 " --v6-rr-semantics Use v6 RR semantics\n"
297 #endif /* HAVE_NETLINK */
298 #if defined(HANDLE_ZAPI_FUZZING)
299 " -c <file> Bypass normal startup and use this file for testing of zapi\n"
300 #endif /* HANDLE_ZAPI_FUZZING */
301 #if defined(HANDLE_NETLINK_FUZZING)
302 " -w <file> Bypass normal startup and use this file for testing of netlink input\n"
303 #endif /* HANDLE_NETLINK_FUZZING */
307 int opt
= frr_getopt(argc
, argv
, NULL
);
322 keep_kernel_mode
= 1;
325 multipath_num
= atoi(optarg
);
326 if (multipath_num
> MULTIPATH_NUM
327 || multipath_num
<= 0) {
329 EC_ZEBRA_BAD_MULTIPATH_NUM
,
330 "Multipath Number specified must be less than %d and greater than 0",
336 vrf_default_name_configured
= optarg
;
340 if (!frr_zclient_addr(&dummy
, &dummylen
, optarg
)) {
342 "Invalid zserv socket path: %s\n",
348 lblmgr_path
= optarg
;
355 nl_rcvbufsize
= atoi(optarg
);
358 vrf_configure_backend(VRF_BACKEND_NETNS
);
359 logicalrouter_configure_backend(
360 LOGICALROUTER_BACKEND_OFF
);
362 case OPTION_V6_RR_SEMANTICS
:
363 v6_rr_semantics
= true;
365 #endif /* HAVE_NETLINK */
366 #if defined(HANDLE_ZAPI_FUZZING)
368 zapi_fuzzing
= optarg
;
370 #endif /* HANDLE_ZAPI_FUZZING */
371 #if defined(HANDLE_NETLINK_FUZZING)
373 netlink_fuzzing
= optarg
;
374 /* This ensures we are aren't writing any of the
375 * startup netlink messages that happen when we
380 #endif /* HANDLE_NETLINK_FUZZING */
387 zrouter
.master
= frr_init();
389 /* Initialize pthread library */
392 /* Zebra related initialize. */
398 router_id_cmd_init();
401 * Initialize NS( and implicitly the VRF module), and make kernel
403 zebra_ns_init((const char *)vrf_default_name_configured
);
407 #if defined(HAVE_RTADV)
411 #ifdef ZEBRA_PTM_SUPPORT
416 zebra_mpls_vty_init();
420 /* For debug purpose. */
421 /* SET_FLAG (zebra_debug_event, ZEBRA_DEBUG_EVENT); */
423 /* Process the configuration file. Among other configuration
424 * directives we can meet those installing static routes. Such
425 * requests will not be executed immediately, but queued in
426 * zebra->ribq structure until we enter the main execution loop.
427 * The notifications from kernel will show originating PID equal
428 * to that after daemon() completes (if ever called).
432 /* After we have successfully acquired the pidfile, we can be sure
433 * about being the only copy of zebra process, which is submitting
434 * changes to the FIB.
435 * Clean up zebra-originated routes. The requests will be sent to OS
436 * immediately, so originating PID in notifications from kernel
437 * will be equal to the current getpid(). To know about such routes,
438 * we have to have route_read() called before.
440 if (!keep_kernel_mode
)
443 /* Needed for BSD routing socket. */
446 /* Start dataplane system */
447 zebra_dplane_start();
449 /* Start Zebra API server */
450 zserv_start(zserv_path
);
452 /* Init label manager */
453 label_manager_init(lblmgr_path
);
461 #if defined(HANDLE_ZAPI_FUZZING)
463 zserv_read_file(zapi_fuzzing
);
466 #endif /* HANDLE_ZAPI_FUZZING */
467 #if defined(HANDLE_NETLINK_FUZZING)
468 if (netlink_fuzzing
) {
469 netlink_read_init(netlink_fuzzing
);
472 #endif /* HANDLE_NETLINK_FUZZING */
475 frr_run(zrouter
.master
);