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 "prefix.h"
  30 #include "log.h"
  31 #include "plist.h"
  32 #include "privs.h"
  33 #include "sigevent.h"
  34 #include "vrf.h"
  35 #include "libfrr.h"
  36 #include "routemap.h"
  37 #include "routing_nb.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 #include "zebra/zebra_nb.h"
  58 #include "zebra/zebra_opaque.h"
  59 #include "zebra/zebra_srte.h"
  60 #include "zebra/zebra_srv6.h"
  61 #include "zebra/zebra_srv6_vty.h"
  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 int graceful_restart;
  75
  76 bool v6_rr_semantics = false;
  77
  78 /* Receive buffer size for kernel control sockets */
  79 #define RCVBUFSIZE_MIN 4194304
  80 #ifdef HAVE_NETLINK
  81 uint32_t rcvbufsize = RCVBUFSIZE_MIN;
  82 #else
  83 uint32_t rcvbufsize = 128 * 1024;
  84 #endif
  85
  86 #define OPTION_V6_RR_SEMANTICS 2000
  87 #define OPTION_ASIC_OFFLOAD    2001
  88
  89 /* Command line options. */
  90 const struct option longopts[] = {
  91         {"batch", no_argument, NULL, 'b'},
  92         {"allow_delete", no_argument, NULL, 'a'},
  93         {"socket", required_argument, NULL, 'z'},
  94         {"ecmp", required_argument, NULL, 'e'},
  95         {"retain", no_argument, NULL, 'r'},
  96         {"graceful_restart", required_argument, NULL, 'K'},
  97         {"asic-offload", optional_argument, NULL, OPTION_ASIC_OFFLOAD},
  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[] = {ZCAP_NET_ADMIN, ZCAP_SYS_ADMIN,
 106                                   ZCAP_NET_RAW,
 107 #ifdef HAVE_DPDK
 108                                   ZCAP_IPC_LOCK,  ZCAP_READ_SEARCH,
 109                                   ZCAP_SYS_RAWIO
 110 #endif
 111 };
 112
 113 /* zebra privileges to run with */
 114 struct zebra_privs_t zserv_privs = {
 115 #if defined(FRR_USER) && defined(FRR_GROUP)
 116         .user = FRR_USER,
 117         .group = FRR_GROUP,
 118 #endif
 119 #ifdef VTY_GROUP
 120         .vty_group = VTY_GROUP,
 121 #endif
 122         .caps_p = _caps_p,
 123         .cap_num_p = array_size(_caps_p),
 124         .cap_num_i = 0};
 125
 126 /* SIGHUP handler. */
 127 static void sighup(void)
 128 {
 129         zlog_info("SIGHUP received");
 130
 131         /* Reload of config file. */
 132         ;
 133 }
 134
 135 /* SIGINT handler. */
 136 static void sigint(void)
 137 {
 138         struct vrf *vrf;
 139         struct zebra_vrf *zvrf;
 140         struct listnode *ln, *nn;
 141         struct zserv *client;
 142         static bool sigint_done;
 143
 144         if (sigint_done)
 145                 return;
 146
 147         sigint_done = true;
 148
 149         zlog_notice("Terminating on signal");
 150
 151         atomic_store_explicit(&zrouter.in_shutdown, true,
 152                               memory_order_relaxed);
 153
 154         /* send RA lifetime of 0 before stopping. rfc4861/6.2.5 */
 155         rtadv_stop_ra_all();
 156
 157         frr_early_fini();
 158
 159         /* Stop the opaque module pthread */
 160         zebra_opaque_stop();
 161
 162         zebra_dplane_pre_finish();
 163
 164         /* Clean up GR related info. */
 165         zebra_gr_stale_client_cleanup(zrouter.stale_client_list);
 166         list_delete_all_node(zrouter.stale_client_list);
 167
 168         /* Clean up zapi clients and server module */
 169         for (ALL_LIST_ELEMENTS(zrouter.client_list, ln, nn, client))
 170                 zserv_close_client(client);
 171
 172         zserv_close();
 173         list_delete_all_node(zrouter.client_list);
 174
 175         /* Once all the zclients are cleaned up, clean up the opaque module */
 176         zebra_opaque_finish();
 177
 178         zebra_ptm_finish();
 179
 180         if (retain_mode) {
 181                 zebra_nhg_mark_keep();
 182                 RB_FOREACH (vrf, vrf_name_head, &vrfs_by_name) {
 183                         zvrf = vrf->info;
 184                         if (zvrf)
 185                                 SET_FLAG(zvrf->flags, ZEBRA_VRF_RETAIN);
 186                 }
 187         }
 188
 189         if (zrouter.lsp_process_q)
 190                 work_queue_free_and_null(&zrouter.lsp_process_q);
 191
 192         vrf_terminate();
 193
 194         ns_walk_func(zebra_ns_early_shutdown, NULL, NULL);
 195         zebra_ns_notify_close();
 196
 197         access_list_reset();
 198         prefix_list_reset();
 199         /*
 200          * zebra_routemap_finish will
 201          * 1 set rmap upd timer to 0 so that rmap update wont be scheduled again
 202          * 2 Put off the rmap update thread
 203          * 3 route_map_finish
 204          */
 205         zebra_routemap_finish();
 206
 207         list_delete(&zrouter.client_list);
 208
 209         /* Indicate that all new dplane work has been enqueued. When that
 210          * work is complete, the dataplane will enqueue an event
 211          * with the 'finalize' function.
 212          */
 213         zebra_dplane_finish();
 214 }
 215
 216 /*
 217  * Final shutdown step for the zebra main thread. This is run after all
 218  * async update processing has completed.
 219  */
 220 void zebra_finalize(struct thread *dummy)
 221 {
 222         zlog_info("Zebra final shutdown");
 223
 224         /* Final shutdown of ns resources */
 225         ns_walk_func(zebra_ns_final_shutdown, NULL, NULL);
 226
 227         /* Stop dplane thread and finish any cleanup */
 228         zebra_dplane_shutdown();
 229
 230         zebra_router_terminate();
 231
 232         frr_fini();
 233         exit(0);
 234 }
 235
 236 /* SIGUSR1 handler. */
 237 static void sigusr1(void)
 238 {
 239         zlog_rotate();
 240 }
 241
 242 struct frr_signal_t zebra_signals[] = {
 243         {
 244                 .signal = SIGHUP,
 245                 .handler = &sighup,
 246         },
 247         {
 248                 .signal = SIGUSR1,
 249                 .handler = &sigusr1,
 250         },
 251         {
 252                 .signal = SIGINT,
 253                 .handler = &sigint,
 254         },
 255         {
 256                 .signal = SIGTERM,
 257                 .handler = &sigint,
 258         },
 259 };
 260
 261 static const struct frr_yang_module_info *const zebra_yang_modules[] = {
 262         &frr_filter_info,
 263         &frr_interface_info,
 264         &frr_route_map_info,
 265         &frr_zebra_info,
 266         &frr_vrf_info,
 267         &frr_routing_info,
 268         &frr_zebra_route_map_info,
 269 };
 270
 271 FRR_DAEMON_INFO(
 272         zebra, ZEBRA, .vty_port = ZEBRA_VTY_PORT, .flags = FRR_NO_ZCLIENT,
 273
 274         .proghelp =
 275                 "Daemon which manages kernel routing table management and\nredistribution between different routing protocols.",
 276
 277         .signals = zebra_signals, .n_signals = array_size(zebra_signals),
 278
 279         .privs = &zserv_privs,
 280
 281         .yang_modules = zebra_yang_modules,
 282         .n_yang_modules = array_size(zebra_yang_modules),
 283 );
 284
 285 /* Main startup routine. */
 286 int main(int argc, char **argv)
 287 {
 288         // int batch_mode = 0;
 289         char *zserv_path = NULL;
 290         struct sockaddr_storage dummy;
 291         socklen_t dummylen;
 292         bool asic_offload = false;
 293         bool notify_on_ack = true;
 294
 295         graceful_restart = 0;
 296         vrf_configure_backend(VRF_BACKEND_VRF_LITE);
 297
 298         frr_preinit(&zebra_di, argc, argv);
 299
 300         frr_opt_add(
 301                 "baz:e:rK:s:"
 302 #ifdef HAVE_NETLINK
 303                 "n"
 304 #endif
 305                 ,
 306                 longopts,
 307                 "  -b, --batch              Runs in batch mode\n"
 308                 "  -a, --allow_delete       Allow other processes to delete zebra routes\n"
 309                 "  -z, --socket             Set path of zebra socket\n"
 310                 "  -e, --ecmp               Specify ECMP to use.\n"
 311                 "  -r, --retain             When program terminates, retain added route by zebra.\n"
 312                 "  -K, --graceful_restart   Graceful restart at the kernel level, timer in seconds for expiration\n"
 313                 "  -A, --asic-offload       FRR is interacting with an asic underneath the linux kernel\n"
 314 #ifdef HAVE_NETLINK
 315                 "  -s, --nl-bufsize         Set netlink receive buffer size\n"
 316                 "  -n, --vrfwnetns          Use NetNS as VRF backend\n"
 317                 "      --v6-rr-semantics    Use v6 RR semantics\n"
 318 #else
 319                 "  -s,                      Set kernel socket receive buffer size\n"
 320 #endif /* HAVE_NETLINK */
 321         );
 322
 323         while (1) {
 324                 int opt = frr_getopt(argc, argv, NULL);
 325
 326                 if (opt == EOF)
 327                         break;
 328
 329                 switch (opt) {
 330                 case 0:
 331                         break;
 332                 case 'b':
 333                         // batch_mode = 1;
 334                         break;
 335                 case 'a':
 336                         zrouter.allow_delete = true;
 337                         break;
 338                 case 'e': {
 339                         unsigned long int parsed_multipath =
 340                                 strtoul(optarg, NULL, 10);
 341                         if (parsed_multipath == 0
 342                             || parsed_multipath > MULTIPATH_NUM
 343                             || parsed_multipath > UINT32_MAX) {
 344                                 flog_err(
 345                                         EC_ZEBRA_BAD_MULTIPATH_NUM,
 346                                         "Multipath Number specified must be less than %u and greater than 0",
 347                                         MULTIPATH_NUM);
 348                                 return 1;
 349                         }
 350                         zrouter.multipath_num = parsed_multipath;
 351                         break;
 352                 }
 353                 case 'z':
 354                         zserv_path = optarg;
 355                         if (!frr_zclient_addr(&dummy, &dummylen, optarg)) {
 356                                 fprintf(stderr,
 357                                         "Invalid zserv socket path: %s\n",
 358                                         optarg);
 359                                 exit(1);
 360                         }
 361                         break;
 362                 case 'r':
 363                         retain_mode = 1;
 364                         break;
 365                 case 'K':
 366                         graceful_restart = atoi(optarg);
 367                         break;
 368                 case 's':
 369                         rcvbufsize = atoi(optarg);
 370                         if (rcvbufsize < RCVBUFSIZE_MIN)
 371                                 fprintf(stderr,
 372                                         "Rcvbufsize is smaller than recommended value: %d\n",
 373                                         RCVBUFSIZE_MIN);
 374                         break;
 375 #ifdef HAVE_NETLINK
 376                 case 'n':
 377                         vrf_configure_backend(VRF_BACKEND_NETNS);
 378                         break;
 379                 case OPTION_V6_RR_SEMANTICS:
 380                         v6_rr_semantics = true;
 381                         break;
 382                 case OPTION_ASIC_OFFLOAD:
 383                         if (!strcmp(optarg, "notify_on_offload"))
 384                                 notify_on_ack = false;
 385                         if (!strcmp(optarg, "notify_on_ack"))
 386                                 notify_on_ack = true;
 387                         asic_offload = true;
 388                         break;
 389 #endif /* HAVE_NETLINK */
 390                 default:
 391                         frr_help_exit(1);
 392                 }
 393         }
 394
 395         zrouter.master = frr_init();
 396
 397         /* Zebra related initialize. */
 398         zebra_router_init(asic_offload, notify_on_ack);
 399         zserv_init();
 400         rib_init();
 401         zebra_if_init();
 402         zebra_debug_init();
 403
 404         /*
 405          * Initialize NS( and implicitly the VRF module), and make kernel
 406          * routing socket. */
 407         zebra_ns_init();
 408         router_id_cmd_init();
 409         zebra_vty_init();
 410         access_list_init();
 411         prefix_list_init();
 412         rtadv_cmd_init();
 413 /* PTM socket */
 414 #ifdef ZEBRA_PTM_SUPPORT
 415         zebra_ptm_init();
 416 #endif
 417
 418         zebra_mpls_init();
 419         zebra_mpls_vty_init();
 420         zebra_pw_vty_init();
 421         zebra_pbr_init();
 422         zebra_opaque_init();
 423         zebra_srte_init();
 424         zebra_srv6_init();
 425         zebra_srv6_vty_init();
 426
 427         /* For debug purpose. */
 428         /* SET_FLAG (zebra_debug_event, ZEBRA_DEBUG_EVENT); */
 429
 430         /* Process the configuration file. Among other configuration
 431         *  directives we can meet those installing static routes. Such
 432         *  requests will not be executed immediately, but queued in
 433         *  zebra->ribq structure until we enter the main execution loop.
 434         *  The notifications from kernel will show originating PID equal
 435         *  to that after daemon() completes (if ever called).
 436         */
 437         frr_config_fork();
 438
 439         /* After we have successfully acquired the pidfile, we can be sure
 440         *  about being the only copy of zebra process, which is submitting
 441         *  changes to the FIB.
 442         *  Clean up zebra-originated routes. The requests will be sent to OS
 443         *  immediately, so originating PID in notifications from kernel
 444         *  will be equal to the current getpid(). To know about such routes,
 445         * we have to have route_read() called before.
 446         */
 447         zrouter.startup_time = monotime(NULL);
 448         thread_add_timer(zrouter.master, rib_sweep_route, NULL,
 449                          graceful_restart, &zrouter.sweeper);
 450
 451         /* Needed for BSD routing socket. */
 452         pid = getpid();
 453
 454         /* Start dataplane system */
 455         zebra_dplane_start();
 456
 457         /* Start the ted module, before zserv */
 458         zebra_opaque_start();
 459
 460         /* Start Zebra API server */
 461         zserv_start(zserv_path);
 462
 463         /* Init label manager */
 464         label_manager_init();
 465
 466         /* RNH init */
 467         zebra_rnh_init();
 468
 469         /* Config handler Init */
 470         zebra_evpn_init();
 471
 472         /* Error init */
 473         zebra_error_init();
 474
 475         frr_run(zrouter.master);
 476
 477         /* Not reached... */
 478         return 0;
 479 }