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 "logicalrouter.h"
  38 #include "libfrr.h"
  39 #include "routemap.h"
  40 #include "frr_pthread.h"
  41
  42 #include "zebra/zebra_router.h"
  43 #include "zebra/zebra_errors.h"
  44 #include "zebra/rib.h"
  45 #include "zebra/zserv.h"
  46 #include "zebra/debug.h"
  47 #include "zebra/router-id.h"
  48 #include "zebra/irdp.h"
  49 #include "zebra/rtadv.h"
  50 #include "zebra/zebra_ptm.h"
  51 #include "zebra/zebra_ns.h"
  52 #include "zebra/redistribute.h"
  53 #include "zebra/zebra_mpls.h"
  54 #include "zebra/label_manager.h"
  55 #include "zebra/zebra_netns_notify.h"
  56 #include "zebra/zebra_rnh.h"
  57 #include "zebra/zebra_pbr.h"
  58 #include "zebra/zebra_vxlan.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 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         {"label_socket", no_argument, NULL, 'l'},
  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         frr_early_fini();
 149
 150         zebra_dplane_pre_finish();
 151
 152         for (ALL_LIST_ELEMENTS(zrouter.client_list, ln, nn, client))
 153                 zserv_close_client(client);
 154
 155         zserv_close();
 156         list_delete_all_node(zrouter.client_list);
 157
 158         zebra_ptm_finish();
 159
 160         if (retain_mode)
 161                 RB_FOREACH (vrf, vrf_name_head, &vrfs_by_name) {
 162                         zvrf = vrf->info;
 163                         if (zvrf)
 164                                 SET_FLAG(zvrf->flags, ZEBRA_VRF_RETAIN);
 165                 }
 166         if (zrouter.lsp_process_q)
 167                 work_queue_free_and_null(&zrouter.lsp_process_q);
 168         vrf_terminate();
 169
 170         ns_walk_func(zebra_ns_early_shutdown);
 171         zebra_ns_notify_close();
 172
 173         access_list_reset();
 174         prefix_list_reset();
 175         route_map_finish();
 176
 177         list_delete(&zrouter.client_list);
 178
 179         /* Indicate that all new dplane work has been enqueued. When that
 180          * work is complete, the dataplane will enqueue an event
 181          * with the 'finalize' function.
 182          */
 183         zebra_dplane_finish();
 184 }
 185
 186 /*
 187  * Final shutdown step for the zebra main thread. This is run after all
 188  * async update processing has completed.
 189  */
 190 int zebra_finalize(struct thread *dummy)
 191 {
 192         zlog_info("Zebra final shutdown");
 193
 194         /* Final shutdown of ns resources */
 195         ns_walk_func(zebra_ns_final_shutdown);
 196
 197         /* Stop dplane thread and finish any cleanup */
 198         zebra_dplane_shutdown();
 199
 200         zebra_router_terminate();
 201
 202         frr_fini();
 203         exit(0);
 204 }
 205
 206 /* SIGUSR1 handler. */
 207 static void sigusr1(void)
 208 {
 209         zlog_rotate();
 210 }
 211
 212 struct quagga_signal_t zebra_signals[] = {
 213         {
 214                 .signal = SIGHUP,
 215                 .handler = &sighup,
 216         },
 217         {
 218                 .signal = SIGUSR1,
 219                 .handler = &sigusr1,
 220         },
 221         {
 222                 .signal = SIGINT,
 223                 .handler = &sigint,
 224         },
 225         {
 226                 .signal = SIGTERM,
 227                 .handler = &sigint,
 228         },
 229 };
 230
 231 static const struct frr_yang_module_info *zebra_yang_modules[] = {
 232         &frr_interface_info,
 233 };
 234
 235 FRR_DAEMON_INFO(
 236         zebra, ZEBRA, .vty_port = ZEBRA_VTY_PORT, .flags = FRR_NO_ZCLIENT,
 237
 238         .proghelp =
 239                 "Daemon which manages kernel routing table management "
 240                 "and\nredistribution between different routing protocols.",
 241
 242         .signals = zebra_signals, .n_signals = array_size(zebra_signals),
 243
 244         .privs = &zserv_privs,
 245
 246         .yang_modules = zebra_yang_modules,
 247         .n_yang_modules = array_size(zebra_yang_modules), )
 248
 249 /* Main startup routine. */
 250 int main(int argc, char **argv)
 251 {
 252         // int batch_mode = 0;
 253         char *zserv_path = NULL;
 254         char *vrf_default_name_configured = NULL;
 255         /* Socket to external label manager */
 256         char *lblmgr_path = NULL;
 257         struct sockaddr_storage dummy;
 258         socklen_t dummylen;
 259 #if defined(HANDLE_ZAPI_FUZZING)
 260         char *zapi_fuzzing = NULL;
 261 #endif /* HANDLE_ZAPI_FUZZING */
 262 #if defined(HANDLE_NETLINK_FUZZING)
 263         char *netlink_fuzzing = NULL;
 264 #endif /* HANDLE_NETLINK_FUZZING */
 265
 266         graceful_restart = 0;
 267         vrf_configure_backend(VRF_BACKEND_VRF_LITE);
 268         logicalrouter_configure_backend(LOGICALROUTER_BACKEND_NETNS);
 269
 270         frr_preinit(&zebra_di, argc, argv);
 271
 272         frr_opt_add(
 273                 "baz:e:l:o:rK:"
 274 #ifdef HAVE_NETLINK
 275                 "s:n"
 276 #endif
 277 #if defined(HANDLE_ZAPI_FUZZING)
 278                 "c:"
 279 #endif /* HANDLE_ZAPI_FUZZING */
 280 #if defined(HANDLE_NETLINK_FUZZING)
 281                 "w:"
 282 #endif /* HANDLE_NETLINK_FUZZING */
 283                 ,
 284                 longopts,
 285                 "  -b, --batch              Runs in batch mode\n"
 286                 "  -a, --allow_delete       Allow other processes to delete zebra routes\n"
 287                 "  -z, --socket             Set path of zebra socket\n"
 288                 "  -e, --ecmp               Specify ECMP to use.\n"
 289                 "  -l, --label_socket       Socket to external label manager\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 'l':
 345                         lblmgr_path = optarg;
 346                         break;
 347                 case 'r':
 348                         retain_mode = 1;
 349                         break;
 350                 case 'K':
 351                         graceful_restart = atoi(optarg);
 352                         break;
 353 #ifdef HAVE_NETLINK
 354                 case 's':
 355                         nl_rcvbufsize = atoi(optarg);
 356                         break;
 357                 case 'n':
 358                         vrf_configure_backend(VRF_BACKEND_NETNS);
 359                         logicalrouter_configure_backend(
 360                                 LOGICALROUTER_BACKEND_OFF);
 361                         break;
 362                 case OPTION_V6_RR_SEMANTICS:
 363                         v6_rr_semantics = true;
 364                         break;
 365 #endif /* HAVE_NETLINK */
 366 #if defined(HANDLE_ZAPI_FUZZING)
 367                 case 'c':
 368                         zapi_fuzzing = optarg;
 369                         break;
 370 #endif /* HANDLE_ZAPI_FUZZING */
 371 #if defined(HANDLE_NETLINK_FUZZING)
 372                 case 'w':
 373                         netlink_fuzzing = optarg;
 374                         /* This ensures we are aren't writing any of the
 375                          * startup netlink messages that happen when we
 376                          * just want to read.
 377                          */
 378                         netlink_read = true;
 379                         break;
 380 #endif /* HANDLE_NETLINK_FUZZING */
 381                 default:
 382                         frr_help_exit(1);
 383                         break;
 384                 }
 385         }
 386
 387         zrouter.master = frr_init();
 388
 389         /* Initialize pthread library */
 390         frr_pthread_init();
 391
 392         /* Zebra related initialize. */
 393         zebra_router_init();
 394         zserv_init();
 395         rib_init();
 396         zebra_if_init();
 397         zebra_debug_init();
 398         router_id_cmd_init();
 399
 400         /*
 401          * Initialize NS( and implicitly the VRF module), and make kernel
 402          * routing socket. */
 403         zebra_ns_init((const char *)vrf_default_name_configured);
 404         zebra_vty_init();
 405         access_list_init();
 406         prefix_list_init();
 407 #if defined(HAVE_RTADV)
 408         rtadv_cmd_init();
 409 #endif
 410 /* PTM socket */
 411 #ifdef ZEBRA_PTM_SUPPORT
 412         zebra_ptm_init();
 413 #endif
 414
 415         zebra_mpls_init();
 416         zebra_mpls_vty_init();
 417         zebra_pw_vty_init();
 418         zebra_pbr_init();
 419
 420 /* For debug purpose. */
 421 /* SET_FLAG (zebra_debug_event, ZEBRA_DEBUG_EVENT); */
 422
 423         /* Process the configuration file. Among other configuration
 424         *  directives we can meet those installing static routes. Such
 425         *  requests will not be executed immediately, but queued in
 426         *  zebra->ribq structure until we enter the main execution loop.
 427         *  The notifications from kernel will show originating PID equal
 428         *  to that after daemon() completes (if ever called).
 429         */
 430         frr_config_fork();
 431
 432         /* After we have successfully acquired the pidfile, we can be sure
 433         *  about being the only copy of zebra process, which is submitting
 434         *  changes to the FIB.
 435         *  Clean up zebra-originated routes. The requests will be sent to OS
 436         *  immediately, so originating PID in notifications from kernel
 437         *  will be equal to the current getpid(). To know about such routes,
 438         * we have to have route_read() called before.
 439         */
 440         zrouter.startup_time = monotime(NULL);
 441         thread_add_timer(zrouter.master, rib_sweep_route,
 442                          NULL, graceful_restart, NULL);
 443
 444         /* Needed for BSD routing socket. */
 445         pid = getpid();
 446
 447         /* Start dataplane system */
 448         zebra_dplane_start();
 449
 450         /* Start Zebra API server */
 451         zserv_start(zserv_path);
 452
 453         /* Init label manager */
 454         label_manager_init(lblmgr_path);
 455
 456         /* RNH init */
 457         zebra_rnh_init();
 458
 459         /* Config handler Init */
 460         zebra_evpn_init();
 461
 462         /* Error init */
 463         zebra_error_init();
 464
 465 #if defined(HANDLE_ZAPI_FUZZING)
 466         if (zapi_fuzzing) {
 467                 zserv_read_file(zapi_fuzzing);
 468                 exit(0);
 469         }
 470 #endif /* HANDLE_ZAPI_FUZZING */
 471 #if defined(HANDLE_NETLINK_FUZZING)
 472         if (netlink_fuzzing) {
 473                 netlink_read_init(netlink_fuzzing);
 474                 exit(0);
 475         }
 476 #endif /* HANDLE_NETLINK_FUZZING */
 477
 478
 479         frr_run(zrouter.master);
 480
 481         /* Not reached... */
 482         return 0;
 483 }