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 /* Zebra instance */
  66 struct zebra_t zebrad = {
  67         .rtm_table_default = 0,
  68         .packets_to_process = ZEBRA_ZAPI_PACKETS_TO_PROCESS,
  69 };
  70
  71 /* process id. */
  72 pid_t pid;
  73
  74 /* Pacify zclient.o in libfrr, which expects this variable. */
  75 struct thread_master *master;
  76
  77 /* Route retain mode flag. */
  78 int retain_mode = 0;
  79
  80 /* Allow non-quagga entities to delete quagga routes */
  81 int allow_delete = 0;
  82
  83 /* Don't delete kernel route. */
  84 int keep_kernel_mode = 0;
  85
  86 bool v6_rr_semantics = false;
  87
  88 #ifdef HAVE_NETLINK
  89 /* Receive buffer size for netlink socket */
  90 uint32_t nl_rcvbufsize = 4194304;
  91 #endif /* HAVE_NETLINK */
  92
  93 #define OPTION_V6_RR_SEMANTICS 2000
  94 /* Command line options. */
  95 struct option longopts[] = {
  96         {"batch", no_argument, NULL, 'b'},
  97         {"allow_delete", no_argument, NULL, 'a'},
  98         {"keep_kernel", no_argument, NULL, 'k'},
  99         {"socket", required_argument, NULL, 'z'},
 100         {"ecmp", required_argument, NULL, 'e'},
 101         {"label_socket", no_argument, NULL, 'l'},
 102         {"retain", no_argument, NULL, 'r'},
 103         {"vrfdefaultname", required_argument, NULL, 'o'},
 104 #ifdef HAVE_NETLINK
 105         {"vrfwnetns", no_argument, NULL, 'n'},
 106         {"nl-bufsize", required_argument, NULL, 's'},
 107         {"v6-rr-semantics", no_argument, NULL, OPTION_V6_RR_SEMANTICS},
 108 #endif /* HAVE_NETLINK */
 109         {0}};
 110
 111 zebra_capabilities_t _caps_p[] = {
 112         ZCAP_NET_ADMIN, ZCAP_SYS_ADMIN, ZCAP_NET_RAW,
 113 };
 114
 115 /* zebra privileges to run with */
 116 struct zebra_privs_t zserv_privs = {
 117 #if defined(FRR_USER) && defined(FRR_GROUP)
 118         .user = FRR_USER,
 119         .group = FRR_GROUP,
 120 #endif
 121 #ifdef VTY_GROUP
 122         .vty_group = VTY_GROUP,
 123 #endif
 124         .caps_p = _caps_p,
 125         .cap_num_p = array_size(_caps_p),
 126         .cap_num_i = 0};
 127
 128 unsigned int multipath_num = MULTIPATH_NUM;
 129
 130 /* SIGHUP handler. */
 131 static void sighup(void)
 132 {
 133         zlog_info("SIGHUP received");
 134
 135         /* Reload of config file. */
 136         ;
 137 }
 138
 139 /* SIGINT handler. */
 140 static void sigint(void)
 141 {
 142         struct vrf *vrf;
 143         struct zebra_vrf *zvrf;
 144         struct listnode *ln, *nn;
 145         struct zserv *client;
 146         static bool sigint_done;
 147
 148         if (sigint_done)
 149                 return;
 150
 151         sigint_done = true;
 152
 153         zlog_notice("Terminating on signal");
 154
 155         frr_early_fini();
 156
 157         zebra_dplane_pre_finish();
 158
 159         for (ALL_LIST_ELEMENTS(zebrad.client_list, ln, nn, client))
 160                 zserv_close_client(client);
 161
 162         list_delete_all_node(zebrad.client_list);
 163         zebra_ptm_finish();
 164
 165         if (retain_mode)
 166                 RB_FOREACH (vrf, vrf_name_head, &vrfs_by_name) {
 167                         zvrf = vrf->info;
 168                         if (zvrf)
 169                                 SET_FLAG(zvrf->flags, ZEBRA_VRF_RETAIN);
 170                 }
 171         if (zebrad.lsp_process_q)
 172                 work_queue_free_and_null(&zebrad.lsp_process_q);
 173         vrf_terminate();
 174
 175         ns_walk_func(zebra_ns_early_shutdown);
 176         zebra_ns_notify_close();
 177
 178         access_list_reset();
 179         prefix_list_reset();
 180         route_map_finish();
 181
 182         list_delete(&zebrad.client_list);
 183
 184         /* Indicate that all new dplane work has been enqueued. When that
 185          * work is complete, the dataplane will enqueue an event
 186          * with the 'finalize' function.
 187          */
 188         zebra_dplane_finish();
 189 }
 190
 191 /*
 192  * Final shutdown step for the zebra main thread. This is run after all
 193  * async update processing has completed.
 194  */
 195 int zebra_finalize(struct thread *dummy)
 196 {
 197         zlog_info("Zebra final shutdown");
 198
 199         /* Final shutdown of ns resources */
 200         ns_walk_func(zebra_ns_final_shutdown);
 201
 202         /* Stop dplane thread and finish any cleanup */
 203         zebra_dplane_shutdown();
 204
 205         work_queue_free_and_null(&zebrad.ribq);
 206         meta_queue_free(zebrad.mq);
 207
 208         zebra_router_terminate();
 209
 210         frr_fini();
 211         exit(0);
 212 }
 213
 214 /* SIGUSR1 handler. */
 215 static void sigusr1(void)
 216 {
 217         zlog_rotate();
 218 }
 219
 220 struct quagga_signal_t zebra_signals[] = {
 221         {
 222                 .signal = SIGHUP,
 223                 .handler = &sighup,
 224         },
 225         {
 226                 .signal = SIGUSR1,
 227                 .handler = &sigusr1,
 228         },
 229         {
 230                 .signal = SIGINT,
 231                 .handler = &sigint,
 232         },
 233         {
 234                 .signal = SIGTERM,
 235                 .handler = &sigint,
 236         },
 237 };
 238
 239 static const struct frr_yang_module_info *zebra_yang_modules[] = {
 240         &frr_interface_info,
 241 };
 242
 243 FRR_DAEMON_INFO(
 244         zebra, ZEBRA, .vty_port = ZEBRA_VTY_PORT, .flags = FRR_NO_ZCLIENT,
 245
 246         .proghelp =
 247                 "Daemon which manages kernel routing table management "
 248                 "and\nredistribution between different routing protocols.",
 249
 250         .signals = zebra_signals, .n_signals = array_size(zebra_signals),
 251
 252         .privs = &zserv_privs,
 253
 254         .yang_modules = zebra_yang_modules,
 255         .n_yang_modules = array_size(zebra_yang_modules), )
 256
 257 /* Main startup routine. */
 258 int main(int argc, char **argv)
 259 {
 260         // int batch_mode = 0;
 261         char *zserv_path = NULL;
 262         char *vrf_default_name_configured = NULL;
 263         /* Socket to external label manager */
 264         char *lblmgr_path = NULL;
 265         struct sockaddr_storage dummy;
 266         socklen_t dummylen;
 267 #if defined(HANDLE_ZAPI_FUZZING)
 268         char *zapi_fuzzing = NULL;
 269 #endif /* HANDLE_ZAPI_FUZZING */
 270 #if defined(HANDLE_NETLINK_FUZZING)
 271         char *netlink_fuzzing = NULL;
 272 #endif /* HANDLE_NETLINK_FUZZING */
 273
 274         vrf_configure_backend(VRF_BACKEND_VRF_LITE);
 275         logicalrouter_configure_backend(LOGICALROUTER_BACKEND_NETNS);
 276
 277         frr_preinit(&zebra_di, argc, argv);
 278
 279         frr_opt_add(
 280                 "bakz:e:l:o:r"
 281 #ifdef HAVE_NETLINK
 282                 "s:n"
 283 #endif
 284 #if defined(HANDLE_ZAPI_FUZZING)
 285                 "c:"
 286 #endif /* HANDLE_ZAPI_FUZZING */
 287 #if defined(HANDLE_NETLINK_FUZZING)
 288                 "w:"
 289 #endif /* HANDLE_NETLINK_FUZZING */
 290                 ,
 291                 longopts,
 292                 "  -b, --batch           Runs in batch mode\n"
 293                 "  -a, --allow_delete    Allow other processes to delete zebra routes\n"
 294                 "  -z, --socket          Set path of zebra socket\n"
 295                 "  -e, --ecmp            Specify ECMP to use.\n"
 296                 "  -l, --label_socket    Socket to external label manager\n"
 297                 "  -k, --keep_kernel     Don't delete old routes which were installed by zebra.\n"
 298                 "  -r, --retain          When program terminates, retain added route by zebra.\n"
 299                 "  -o, --vrfdefaultname  Set default VRF name.\n"
 300 #ifdef HAVE_NETLINK
 301                 "  -n, --vrfwnetns       Use NetNS as VRF backend\n"
 302                 "  -s, --nl-bufsize      Set netlink receive buffer size\n"
 303                 "      --v6-rr-semantics Use v6 RR semantics\n"
 304 #endif /* HAVE_NETLINK */
 305 #if defined(HANDLE_ZAPI_FUZZING)
 306                 "  -c <file>             Bypass normal startup and use this file for testing of zapi\n"
 307 #endif /* HANDLE_ZAPI_FUZZING */
 308 #if defined(HANDLE_NETLINK_FUZZING)
 309                 "  -w <file>             Bypass normal startup and use this file for testing of netlink input\n"
 310 #endif /* HANDLE_NETLINK_FUZZING */
 311         );
 312
 313         while (1) {
 314                 int opt = frr_getopt(argc, argv, NULL);
 315
 316                 if (opt == EOF)
 317                         break;
 318
 319                 switch (opt) {
 320                 case 0:
 321                         break;
 322                 case 'b':
 323                         // batch_mode = 1;
 324                         break;
 325                 case 'a':
 326                         allow_delete = 1;
 327                         break;
 328                 case 'k':
 329                         keep_kernel_mode = 1;
 330                         break;
 331                 case 'e':
 332                         multipath_num = atoi(optarg);
 333                         if (multipath_num > MULTIPATH_NUM
 334                             || multipath_num <= 0) {
 335                                 flog_err(
 336                                         EC_ZEBRA_BAD_MULTIPATH_NUM,
 337                                         "Multipath Number specified must be less than %d and greater than 0",
 338                                         MULTIPATH_NUM);
 339                                 return 1;
 340                         }
 341                         break;
 342                 case 'o':
 343                         vrf_default_name_configured = optarg;
 344                         break;
 345                 case 'z':
 346                         zserv_path = optarg;
 347                         if (!frr_zclient_addr(&dummy, &dummylen, optarg)) {
 348                                 fprintf(stderr,
 349                                         "Invalid zserv socket path: %s\n",
 350                                         optarg);
 351                                 exit(1);
 352                         }
 353                         break;
 354                 case 'l':
 355                         lblmgr_path = optarg;
 356                         break;
 357                 case 'r':
 358                         retain_mode = 1;
 359                         break;
 360 #ifdef HAVE_NETLINK
 361                 case 's':
 362                         nl_rcvbufsize = atoi(optarg);
 363                         break;
 364                 case 'n':
 365                         vrf_configure_backend(VRF_BACKEND_NETNS);
 366                         logicalrouter_configure_backend(
 367                                 LOGICALROUTER_BACKEND_OFF);
 368                         break;
 369                 case OPTION_V6_RR_SEMANTICS:
 370                         v6_rr_semantics = true;
 371                         break;
 372 #endif /* HAVE_NETLINK */
 373 #if defined(HANDLE_ZAPI_FUZZING)
 374                 case 'c':
 375                         zapi_fuzzing = optarg;
 376                         break;
 377 #endif /* HANDLE_ZAPI_FUZZING */
 378 #if defined(HANDLE_NETLINK_FUZZING)
 379                 case 'w':
 380                         netlink_fuzzing = optarg;
 381                         /* This ensures we are aren't writing any of the
 382                          * startup netlink messages that happen when we
 383                          * just want to read.
 384                          */
 385                         netlink_read = true;
 386                         break;
 387 #endif /* HANDLE_NETLINK_FUZZING */
 388                 default:
 389                         frr_help_exit(1);
 390                         break;
 391                 }
 392         }
 393
 394         zebrad.master = frr_init();
 395
 396         /* Initialize pthread library */
 397         frr_pthread_init();
 398
 399         /* Zebra related initialize. */
 400         zebra_router_init();
 401         zserv_init();
 402         rib_init();
 403         zebra_if_init();
 404         zebra_debug_init();
 405         router_id_cmd_init();
 406
 407         /*
 408          * Initialize NS( and implicitly the VRF module), and make kernel
 409          * routing socket. */
 410         zebra_ns_init();
 411         if (vrf_default_name_configured)
 412                 vrf_set_default_name(vrf_default_name_configured,
 413                                      true);
 414         zebra_vty_init();
 415         access_list_init();
 416         prefix_list_init();
 417 #if defined(HAVE_RTADV)
 418         rtadv_cmd_init();
 419 #endif
 420 /* PTM socket */
 421 #ifdef ZEBRA_PTM_SUPPORT
 422         zebra_ptm_init();
 423 #endif
 424
 425         zebra_mpls_init();
 426         zebra_mpls_vty_init();
 427         zebra_pw_vty_init();
 428         zebra_pbr_init();
 429
 430 /* For debug purpose. */
 431 /* SET_FLAG (zebra_debug_event, ZEBRA_DEBUG_EVENT); */
 432
 433         /* Process the configuration file. Among other configuration
 434         *  directives we can meet those installing static routes. Such
 435         *  requests will not be executed immediately, but queued in
 436         *  zebra->ribq structure until we enter the main execution loop.
 437         *  The notifications from kernel will show originating PID equal
 438         *  to that after daemon() completes (if ever called).
 439         */
 440         frr_config_fork();
 441
 442         /* After we have successfully acquired the pidfile, we can be sure
 443         *  about being the only copy of zebra process, which is submitting
 444         *  changes to the FIB.
 445         *  Clean up zebra-originated routes. The requests will be sent to OS
 446         *  immediately, so originating PID in notifications from kernel
 447         *  will be equal to the current getpid(). To know about such routes,
 448         * we have to have route_read() called before.
 449         */
 450         if (!keep_kernel_mode)
 451                 rib_sweep_route();
 452
 453         /* Needed for BSD routing socket. */
 454         pid = getpid();
 455
 456         /* Start dataplane system */
 457         zebra_dplane_start();
 458
 459         /* Start Zebra API server */
 460         zserv_start(zserv_path);
 461
 462         /* Init label manager */
 463         label_manager_init(lblmgr_path);
 464
 465         /* RNH init */
 466         zebra_rnh_init();
 467
 468         /* Error init */
 469         zebra_error_init();
 470
 471 #if defined(HANDLE_ZAPI_FUZZING)
 472         if (zapi_fuzzing) {
 473                 zserv_read_file(zapi_fuzzing);
 474                 exit(0);
 475         }
 476 #endif /* HANDLE_ZAPI_FUZZING */
 477 #if defined(HANDLE_NETLINK_FUZZING)
 478         if (netlink_fuzzing) {
 479                 netlink_read_init(netlink_fuzzing);
 480                 exit(0);
 481         }
 482 #endif /* HANDLE_NETLINK_FUZZING */
 483
 484
 485         frr_run(zebrad.master);
 486
 487         /* Not reached... */
 488         return 0;
 489 }