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