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