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