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