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