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