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