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