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
  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 /* Don't delete kernel route. */
  78 int keep_kernel_mode = 0;
  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 #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 unsigned int multipath_num = MULTIPATH_NUM;
 123
 124 /* SIGHUP handler. */
 125 static void sighup(void)
 126 {
 127         zlog_info("SIGHUP received");
 128
 129         /* Reload of config file. */
 130         ;
 131 }
 132
 133 /* SIGINT handler. */
 134 static void sigint(void)
 135 {
 136         struct vrf *vrf;
 137         struct zebra_vrf *zvrf;
 138         struct listnode *ln, *nn;
 139         struct zserv *client;
 140         static bool sigint_done;
 141
 142         if (sigint_done)
 143                 return;
 144
 145         sigint_done = true;
 146
 147         zlog_notice("Terminating on signal");
 148
 149         frr_early_fini();
 150
 151         zebra_dplane_pre_finish();
 152
 153         for (ALL_LIST_ELEMENTS(zrouter.client_list, ln, nn, client))
 154                 zserv_close_client(client);
 155
 156         zserv_close();
 157         list_delete_all_node(zrouter.client_list);
 158
 159         zebra_ptm_finish();
 160
 161         if (retain_mode)
 162                 RB_FOREACH (vrf, vrf_name_head, &vrfs_by_name) {
 163                         zvrf = vrf->info;
 164                         if (zvrf)
 165                                 SET_FLAG(zvrf->flags, ZEBRA_VRF_RETAIN);
 166                 }
 167         if (zrouter.lsp_process_q)
 168                 work_queue_free_and_null(&zrouter.lsp_process_q);
 169         vrf_terminate();
 170
 171         ns_walk_func(zebra_ns_early_shutdown);
 172         zebra_ns_notify_close();
 173
 174         access_list_reset();
 175         prefix_list_reset();
 176         route_map_finish();
 177
 178         list_delete(&zrouter.client_list);
 179
 180         /* Indicate that all new dplane work has been enqueued. When that
 181          * work is complete, the dataplane will enqueue an event
 182          * with the 'finalize' function.
 183          */
 184         zebra_dplane_finish();
 185 }
 186
 187 /*
 188  * Final shutdown step for the zebra main thread. This is run after all
 189  * async update processing has completed.
 190  */
 191 int zebra_finalize(struct thread *dummy)
 192 {
 193         zlog_info("Zebra final shutdown");
 194
 195         /* Final shutdown of ns resources */
 196         ns_walk_func(zebra_ns_final_shutdown);
 197
 198         /* Stop dplane thread and finish any cleanup */
 199         zebra_dplane_shutdown();
 200
 201         zebra_router_terminate();
 202
 203         frr_fini();
 204         exit(0);
 205 }
 206
 207 /* SIGUSR1 handler. */
 208 static void sigusr1(void)
 209 {
 210         zlog_rotate();
 211 }
 212
 213 struct quagga_signal_t zebra_signals[] = {
 214         {
 215                 .signal = SIGHUP,
 216                 .handler = &sighup,
 217         },
 218         {
 219                 .signal = SIGUSR1,
 220                 .handler = &sigusr1,
 221         },
 222         {
 223                 .signal = SIGINT,
 224                 .handler = &sigint,
 225         },
 226         {
 227                 .signal = SIGTERM,
 228                 .handler = &sigint,
 229         },
 230 };
 231
 232 static const struct frr_yang_module_info *zebra_yang_modules[] = {
 233         &frr_interface_info,
 234 };
 235
 236 FRR_DAEMON_INFO(
 237         zebra, ZEBRA, .vty_port = ZEBRA_VTY_PORT, .flags = FRR_NO_ZCLIENT,
 238
 239         .proghelp =
 240                 "Daemon which manages kernel routing table management "
 241                 "and\nredistribution between different routing protocols.",
 242
 243         .signals = zebra_signals, .n_signals = array_size(zebra_signals),
 244
 245         .privs = &zserv_privs,
 246
 247         .yang_modules = zebra_yang_modules,
 248         .n_yang_modules = array_size(zebra_yang_modules), )
 249
 250 /* Main startup routine. */
 251 int main(int argc, char **argv)
 252 {
 253         // int batch_mode = 0;
 254         char *zserv_path = NULL;
 255         char *vrf_default_name_configured = NULL;
 256         /* Socket to external label manager */
 257         char *lblmgr_path = NULL;
 258         struct sockaddr_storage dummy;
 259         socklen_t dummylen;
 260 #if defined(HANDLE_ZAPI_FUZZING)
 261         char *zapi_fuzzing = NULL;
 262 #endif /* HANDLE_ZAPI_FUZZING */
 263 #if defined(HANDLE_NETLINK_FUZZING)
 264         char *netlink_fuzzing = NULL;
 265 #endif /* HANDLE_NETLINK_FUZZING */
 266
 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                 "bakz:e:l:o:r"
 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                 "  -k, --keep_kernel     Don't delete old routes which were installed by zebra.\n"
 291                 "  -r, --retain          When program terminates, retain added route by zebra.\n"
 292                 "  -o, --vrfdefaultname  Set default VRF name.\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 'k':
 322                         keep_kernel_mode = 1;
 323                         break;
 324                 case 'e':
 325                         multipath_num = atoi(optarg);
 326                         if (multipath_num > MULTIPATH_NUM
 327                             || multipath_num <= 0) {
 328                                 flog_err(
 329                                         EC_ZEBRA_BAD_MULTIPATH_NUM,
 330                                         "Multipath Number specified must be less than %d and greater than 0",
 331                                         MULTIPATH_NUM);
 332                                 return 1;
 333                         }
 334                         break;
 335                 case 'o':
 336                         vrf_default_name_configured = optarg;
 337                         break;
 338                 case 'z':
 339                         zserv_path = optarg;
 340                         if (!frr_zclient_addr(&dummy, &dummylen, optarg)) {
 341                                 fprintf(stderr,
 342                                         "Invalid zserv socket path: %s\n",
 343                                         optarg);
 344                                 exit(1);
 345                         }
 346                         break;
 347                 case 'l':
 348                         lblmgr_path = optarg;
 349                         break;
 350                 case 'r':
 351                         retain_mode = 1;
 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         if (!keep_kernel_mode)
 441                 rib_sweep_route();
 442
 443         /* Needed for BSD routing socket. */
 444         pid = getpid();
 445
 446         /* Start dataplane system */
 447         zebra_dplane_start();
 448
 449         /* Start Zebra API server */
 450         zserv_start(zserv_path);
 451
 452         /* Init label manager */
 453         label_manager_init(lblmgr_path);
 454
 455         /* RNH init */
 456         zebra_rnh_init();
 457
 458         /* Error init */
 459         zebra_error_init();
 460
 461 #if defined(HANDLE_ZAPI_FUZZING)
 462         if (zapi_fuzzing) {
 463                 zserv_read_file(zapi_fuzzing);
 464                 exit(0);
 465         }
 466 #endif /* HANDLE_ZAPI_FUZZING */
 467 #if defined(HANDLE_NETLINK_FUZZING)
 468         if (netlink_fuzzing) {
 469                 netlink_read_init(netlink_fuzzing);
 470                 exit(0);
 471         }
 472 #endif /* HANDLE_NETLINK_FUZZING */
 473
 474
 475         frr_run(zrouter.master);
 476
 477         /* Not reached... */
 478         return 0;
 479 }