zebra/main.c

   1 /* zebra daemon main routine.
   2  * Copyright (C) 1997, 98 Kunihiro Ishiguro
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   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
   9  * later version.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 #include <zebra.h>
  22
  23 #include <lib/version.h>
  24 #include "getopt.h"
  25 #include "command.h"
  26 #include "thread.h"
  27 #include "filter.h"
  28 #include "memory.h"
  29 #include "zebra_memory.h"
  30 #include "prefix.h"
  31 #include "log.h"
  32 #include "plist.h"
  33 #include "privs.h"
  34 #include "sigevent.h"
  35 #include "vrf.h"
  36 #include "libfrr.h"
  37 #include "routemap.h"
  38
  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
  57 #if defined(HANDLE_NETLINK_FUZZING)
  58 #include "zebra/kernel_netlink.h"
  59 #endif /* HANDLE_NETLINK_FUZZING */
  60
  61 #define ZEBRA_PTM_SUPPORT
  62
  63 /* process id. */
  64 pid_t pid;
  65
  66 /* Pacify zclient.o in libfrr, which expects this variable. */
  67 struct thread_master *master;
  68
  69 /* Route retain mode flag. */
  70 int retain_mode = 0;
  71
  72 /* Allow non-quagga entities to delete quagga routes */
  73 int allow_delete = 0;
  74
  75 int graceful_restart;
  76
  77 bool v6_rr_semantics = false;
  78
  79 #ifdef HAVE_NETLINK
  80 /* Receive buffer size for netlink socket */
  81 uint32_t nl_rcvbufsize = 4194304;
  82 #endif /* HAVE_NETLINK */
  83
  84 #define OPTION_V6_RR_SEMANTICS 2000
  85 /* Command line options. */
  86 const struct option longopts[] = {
  87         {"batch", no_argument, NULL, 'b'},
  88         {"allow_delete", no_argument, NULL, 'a'},
  89         {"keep_kernel", no_argument, NULL, 'k'},
  90         {"socket", required_argument, NULL, 'z'},
  91         {"ecmp", required_argument, NULL, 'e'},
  92         {"retain", no_argument, NULL, 'r'},
  93         {"vrfdefaultname", required_argument, NULL, 'o'},
  94         {"graceful_restart", required_argument, NULL, 'K'},
  95 #ifdef HAVE_NETLINK
  96         {"vrfwnetns", no_argument, NULL, 'n'},
  97         {"nl-bufsize", required_argument, NULL, 's'},
  98         {"v6-rr-semantics", no_argument, NULL, OPTION_V6_RR_SEMANTICS},
  99 #endif /* HAVE_NETLINK */
 100         {0}};
 101
 102 zebra_capabilities_t _caps_p[] = {
 103         ZCAP_NET_ADMIN, ZCAP_SYS_ADMIN, ZCAP_NET_RAW,
 104 };
 105
 106 /* zebra privileges to run with */
 107 struct zebra_privs_t zserv_privs = {
 108 #if defined(FRR_USER) && defined(FRR_GROUP)
 109         .user = FRR_USER,
 110         .group = FRR_GROUP,
 111 #endif
 112 #ifdef VTY_GROUP
 113         .vty_group = VTY_GROUP,
 114 #endif
 115         .caps_p = _caps_p,
 116         .cap_num_p = array_size(_caps_p),
 117         .cap_num_i = 0};
 118
 119 /* SIGHUP handler. */
 120 static void sighup(void)
 121 {
 122         zlog_info("SIGHUP received");
 123
 124         /* Reload of config file. */
 125         ;
 126 }
 127
 128 /* SIGINT handler. */
 129 static void sigint(void)
 130 {
 131         struct vrf *vrf;
 132         struct zebra_vrf *zvrf;
 133         struct listnode *ln, *nn;
 134         struct zserv *client;
 135         static bool sigint_done;
 136
 137         if (sigint_done)
 138                 return;
 139
 140         sigint_done = true;
 141
 142         zlog_notice("Terminating on signal");
 143
 144         atomic_store_explicit(&zrouter.in_shutdown, true,
 145                               memory_order_relaxed);
 146
 147         /* send RA lifetime of 0 before stopping. rfc4861/6.2.5 */
 148         rtadv_stop_ra_all();
 149
 150         frr_early_fini();
 151
 152         zebra_dplane_pre_finish();
 153
 154         /* Clean up GR related info. */
 155         zebra_gr_stale_client_cleanup(zrouter.stale_client_list);
 156         list_delete_all_node(zrouter.stale_client_list);
 157
 158         for (ALL_LIST_ELEMENTS(zrouter.client_list, ln, nn, client))
 159                 zserv_close_client(client);
 160
 161         zserv_close();
 162         list_delete_all_node(zrouter.client_list);
 163
 164         zebra_ptm_finish();
 165
 166         if (retain_mode)
 167                 RB_FOREACH (vrf, vrf_name_head, &vrfs_by_name) {
 168                         zvrf = vrf->info;
 169                         if (zvrf)
 170                                 SET_FLAG(zvrf->flags, ZEBRA_VRF_RETAIN);
 171                 }
 172         if (zrouter.lsp_process_q)
 173                 work_queue_free_and_null(&zrouter.lsp_process_q);
 174
 175         vrf_terminate();
 176
 177         ns_walk_func(zebra_ns_early_shutdown);
 178         zebra_ns_notify_close();
 179
 180         access_list_reset();
 181         prefix_list_reset();
 182         route_map_finish();
 183
 184         list_delete(&zrouter.client_list);
 185
 186         /* Indicate that all new dplane work has been enqueued. When that
 187          * work is complete, the dataplane will enqueue an event
 188          * with the 'finalize' function.
 189          */
 190         zebra_dplane_finish();
 191 }
 192
 193 /*
 194  * Final shutdown step for the zebra main thread. This is run after all
 195  * async update processing has completed.
 196  */
 197 int zebra_finalize(struct thread *dummy)
 198 {
 199         zlog_info("Zebra final shutdown");
 200
 201         /* Final shutdown of ns resources */
 202         ns_walk_func(zebra_ns_final_shutdown);
 203
 204         /* Stop dplane thread and finish any cleanup */
 205         zebra_dplane_shutdown();
 206
 207         zebra_router_terminate();
 208
 209         frr_fini();
 210         exit(0);
 211 }
 212
 213 /* SIGUSR1 handler. */
 214 static void sigusr1(void)
 215 {
 216         zlog_rotate();
 217 }
 218
 219 struct quagga_signal_t zebra_signals[] = {
 220         {
 221                 .signal = SIGHUP,
 222                 .handler = &sighup,
 223         },
 224         {
 225                 .signal = SIGUSR1,
 226                 .handler = &sigusr1,
 227         },
 228         {
 229                 .signal = SIGINT,
 230                 .handler = &sigint,
 231         },
 232         {
 233                 .signal = SIGTERM,
 234                 .handler = &sigint,
 235         },
 236 };
 237
 238 static const struct frr_yang_module_info *const zebra_yang_modules[] = {
 239         &frr_interface_info,
 240 };
 241
 242 FRR_DAEMON_INFO(
 243         zebra, ZEBRA, .vty_port = ZEBRA_VTY_PORT, .flags = FRR_NO_ZCLIENT,
 244
 245         .proghelp =
 246                 "Daemon which manages kernel routing table management "
 247                 "and\nredistribution between different routing protocols.",
 248
 249         .signals = zebra_signals, .n_signals = array_size(zebra_signals),
 250
 251         .privs = &zserv_privs,
 252
 253         .yang_modules = zebra_yang_modules,
 254         .n_yang_modules = array_size(zebra_yang_modules), )
 255
 256 /* Main startup routine. */
 257 int main(int argc, char **argv)
 258 {
 259         // int batch_mode = 0;
 260         char *zserv_path = NULL;
 261         char *vrf_default_name_configured = NULL;
 262         struct sockaddr_storage dummy;
 263         socklen_t dummylen;
 264 #if defined(HANDLE_ZAPI_FUZZING)
 265         char *zapi_fuzzing = NULL;
 266 #endif /* HANDLE_ZAPI_FUZZING */
 267 #if defined(HANDLE_NETLINK_FUZZING)
 268         char *netlink_fuzzing = NULL;
 269 #endif /* HANDLE_NETLINK_FUZZING */
 270
 271         graceful_restart = 0;
 272         vrf_configure_backend(VRF_BACKEND_VRF_LITE);
 273
 274         frr_preinit(&zebra_di, argc, argv);
 275
 276         frr_opt_add(
 277                 "baz:e:o:rK:"
 278 #ifdef HAVE_NETLINK
 279                 "s:n"
 280 #endif
 281 #if defined(HANDLE_ZAPI_FUZZING)
 282                 "c:"
 283 #endif /* HANDLE_ZAPI_FUZZING */
 284 #if defined(HANDLE_NETLINK_FUZZING)
 285                 "w:"
 286 #endif /* HANDLE_NETLINK_FUZZING */
 287                 ,
 288                 longopts,
 289                 "  -b, --batch              Runs in batch mode\n"
 290                 "  -a, --allow_delete       Allow other processes to delete zebra routes\n"
 291                 "  -z, --socket             Set path of zebra socket\n"
 292                 "  -e, --ecmp               Specify ECMP to use.\n"
 293                 "  -r, --retain             When program terminates, retain added route by zebra.\n"
 294                 "  -o, --vrfdefaultname     Set default VRF name.\n"
 295                 "  -K, --graceful_restart   Graceful restart at the kernel level, timer in seconds for expiration\n"
 296 #ifdef HAVE_NETLINK
 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 */
 307         );
 308
 309         while (1) {
 310                 int opt = frr_getopt(argc, argv, NULL);
 311
 312                 if (opt == EOF)
 313                         break;
 314
 315                 switch (opt) {
 316                 case 0:
 317                         break;
 318                 case 'b':
 319                         // batch_mode = 1;
 320                         break;
 321                 case 'a':
 322                         allow_delete = 1;
 323                         break;
 324                 case 'e':
 325                         zrouter.multipath_num = atoi(optarg);
 326                         if (zrouter.multipath_num > MULTIPATH_NUM
 327                             || zrouter.multipath_num <= 0) {
 328                                 flog_err(
 329                                         EC_ZEBRA_BAD_MULTIPATH_NUM,
 330                                         "Multipath Number specified must be less than %d and greater than 0",
 331                                         MULTIPATH_NUM);
 332                                 return 1;
 333                         }
 334                         break;
 335                 case 'o':
 336                         vrf_default_name_configured = optarg;
 337                         break;
 338                 case 'z':
 339                         zserv_path = optarg;
 340                         if (!frr_zclient_addr(&dummy, &dummylen, optarg)) {
 341                                 fprintf(stderr,
 342                                         "Invalid zserv socket path: %s\n",
 343                                         optarg);
 344                                 exit(1);
 345                         }
 346                         break;
 347                 case 'r':
 348                         retain_mode = 1;
 349                         break;
 350                 case 'K':
 351                         graceful_restart = atoi(optarg);
 352                         break;
 353 #ifdef HAVE_NETLINK
 354                 case 's':
 355                         nl_rcvbufsize = atoi(optarg);
 356                         break;
 357                 case 'n':
 358                         vrf_configure_backend(VRF_BACKEND_NETNS);
 359                         break;
 360                 case OPTION_V6_RR_SEMANTICS:
 361                         v6_rr_semantics = true;
 362                         break;
 363 #endif /* HAVE_NETLINK */
 364 #if defined(HANDLE_ZAPI_FUZZING)
 365                 case 'c':
 366                         zapi_fuzzing = optarg;
 367                         break;
 368 #endif /* HANDLE_ZAPI_FUZZING */
 369 #if defined(HANDLE_NETLINK_FUZZING)
 370                 case 'w':
 371                         netlink_fuzzing = optarg;
 372                         /* This ensures we are aren't writing any of the
 373                          * startup netlink messages that happen when we
 374                          * just want to read.
 375                          */
 376                         netlink_read = true;
 377                         break;
 378 #endif /* HANDLE_NETLINK_FUZZING */
 379                 default:
 380                         frr_help_exit(1);
 381                         break;
 382                 }
 383         }
 384
 385         zrouter.master = frr_init();
 386
 387         /* Zebra related initialize. */
 388         zebra_router_init();
 389         zserv_init();
 390         rib_init();
 391         zebra_if_init();
 392         zebra_debug_init();
 393         router_id_cmd_init();
 394
 395         /*
 396          * Initialize NS( and implicitly the VRF module), and make kernel
 397          * routing socket. */
 398         zebra_ns_init((const char *)vrf_default_name_configured);
 399         zebra_vty_init();
 400         access_list_init();
 401         prefix_list_init();
 402 #if defined(HAVE_RTADV)
 403         rtadv_cmd_init();
 404 #endif
 405 /* PTM socket */
 406 #ifdef ZEBRA_PTM_SUPPORT
 407         zebra_ptm_init();
 408 #endif
 409
 410         zebra_mpls_init();
 411         zebra_mpls_vty_init();
 412         zebra_pw_vty_init();
 413         zebra_pbr_init();
 414
 415 /* For debug purpose. */
 416 /* SET_FLAG (zebra_debug_event, ZEBRA_DEBUG_EVENT); */
 417
 418         /* Process the configuration file. Among other configuration
 419         *  directives we can meet those installing static routes. Such
 420         *  requests will not be executed immediately, but queued in
 421         *  zebra->ribq structure until we enter the main execution loop.
 422         *  The notifications from kernel will show originating PID equal
 423         *  to that after daemon() completes (if ever called).
 424         */
 425         frr_config_fork();
 426
 427         /* After we have successfully acquired the pidfile, we can be sure
 428         *  about being the only copy of zebra process, which is submitting
 429         *  changes to the FIB.
 430         *  Clean up zebra-originated routes. The requests will be sent to OS
 431         *  immediately, so originating PID in notifications from kernel
 432         *  will be equal to the current getpid(). To know about such routes,
 433         * we have to have route_read() called before.
 434         */
 435         zrouter.startup_time = monotime(NULL);
 436         thread_add_timer(zrouter.master, rib_sweep_route,
 437                          NULL, graceful_restart, NULL);
 438
 439         /* Needed for BSD routing socket. */
 440         pid = getpid();
 441
 442         /* Start dataplane system */
 443         zebra_dplane_start();
 444
 445         /* Start Zebra API server */
 446         zserv_start(zserv_path);
 447
 448         /* Init label manager */
 449         label_manager_init();
 450
 451         /* RNH init */
 452         zebra_rnh_init();
 453
 454         /* Config handler Init */
 455         zebra_evpn_init();
 456
 457         /* Error init */
 458         zebra_error_init();
 459
 460 #if defined(HANDLE_ZAPI_FUZZING)
 461         if (zapi_fuzzing) {
 462                 zserv_read_file(zapi_fuzzing);
 463                 exit(0);
 464         }
 465 #endif /* HANDLE_ZAPI_FUZZING */
 466 #if defined(HANDLE_NETLINK_FUZZING)
 467         if (netlink_fuzzing) {
 468                 netlink_read_init(netlink_fuzzing);
 469                 exit(0);
 470         }
 471 #endif /* HANDLE_NETLINK_FUZZING */
 472
 473
 474         frr_run(zrouter.master);
 475
 476         /* Not reached... */
 477         return 0;
 478 }