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