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/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
  57 #define ZEBRA_PTM_SUPPORT
  58
  59 /* Zebra instance */
  60 struct zebra_t zebrad = {
  61         .rtm_table_default = 0,
  62         .packets_to_process = ZEBRA_ZAPI_PACKETS_TO_PROCESS,
  63 };
  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 /* Allow non-quagga entities to delete quagga routes */
  75 int allow_delete = 0;
  76
  77 /* Don't delete kernel route. */
  78 int keep_kernel_mode = 0;
  79
  80 bool v6_rr_semantics = false;
  81
  82 #ifdef HAVE_NETLINK
  83 /* Receive buffer size for netlink socket */
  84 uint32_t nl_rcvbufsize = 4194304;
  85 #endif /* HAVE_NETLINK */
  86
  87 #define OPTION_V6_RR_SEMANTICS 2000
  88 /* Command line options. */
  89 struct option longopts[] = {
  90         {"batch", no_argument, NULL, 'b'},
  91         {"allow_delete", no_argument, NULL, 'a'},
  92         {"keep_kernel", no_argument, NULL, 'k'},
  93         {"socket", required_argument, NULL, 'z'},
  94         {"ecmp", required_argument, NULL, 'e'},
  95         {"label_socket", no_argument, NULL, 'l'},
  96         {"retain", no_argument, NULL, 'r'},
  97 #ifdef HAVE_NETLINK
  98         {"vrfwnetns", no_argument, NULL, 'n'},
  99         {"nl-bufsize", required_argument, NULL, 's'},
 100         {"v6-rr-semantics", no_argument, NULL, OPTION_V6_RR_SEMANTICS},
 101 #endif /* HAVE_NETLINK */
 102         {0}};
 103
 104 zebra_capabilities_t _caps_p[] = {
 105         ZCAP_NET_ADMIN, ZCAP_SYS_ADMIN, ZCAP_NET_RAW,
 106 };
 107
 108 /* zebra privileges to run with */
 109 struct zebra_privs_t zserv_privs = {
 110 #if defined(FRR_USER) && defined(FRR_GROUP)
 111         .user = FRR_USER,
 112         .group = FRR_GROUP,
 113 #endif
 114 #ifdef VTY_GROUP
 115         .vty_group = VTY_GROUP,
 116 #endif
 117         .caps_p = _caps_p,
 118         .cap_num_p = array_size(_caps_p),
 119         .cap_num_i = 0};
 120
 121 unsigned int multipath_num = MULTIPATH_NUM;
 122
 123 /* SIGHUP handler. */
 124 static void sighup(void)
 125 {
 126         zlog_info("SIGHUP received");
 127
 128         /* Reload of config file. */
 129         ;
 130 }
 131
 132 /* SIGINT handler. */
 133 static void sigint(void)
 134 {
 135         struct vrf *vrf;
 136         struct zebra_vrf *zvrf;
 137
 138         zlog_notice("Terminating on signal");
 139
 140         frr_early_fini();
 141
 142         list_delete_all_node(zebrad.client_list);
 143         zebra_ptm_finish();
 144
 145         if (retain_mode)
 146                 RB_FOREACH (vrf, vrf_name_head, &vrfs_by_name) {
 147                         zvrf = vrf->info;
 148                         if (zvrf)
 149                                 SET_FLAG(zvrf->flags, ZEBRA_VRF_RETAIN);
 150                 }
 151         if (zebrad.lsp_process_q)
 152                 work_queue_free_and_null(&zebrad.lsp_process_q);
 153         vrf_terminate();
 154
 155         ns_walk_func(zebra_ns_disabled);
 156         zebra_ns_notify_close();
 157
 158         access_list_reset();
 159         prefix_list_reset();
 160         route_map_finish();
 161
 162         list_delete_and_null(&zebrad.client_list);
 163         work_queue_free_and_null(&zebrad.ribq);
 164         meta_queue_free(zebrad.mq);
 165
 166         frr_fini();
 167         exit(0);
 168 }
 169
 170 /* SIGUSR1 handler. */
 171 static void sigusr1(void)
 172 {
 173         zlog_rotate();
 174 }
 175
 176 struct quagga_signal_t zebra_signals[] = {
 177         {
 178                 .signal = SIGHUP,
 179                 .handler = &sighup,
 180         },
 181         {
 182                 .signal = SIGUSR1,
 183                 .handler = &sigusr1,
 184         },
 185         {
 186                 .signal = SIGINT,
 187                 .handler = &sigint,
 188         },
 189         {
 190                 .signal = SIGTERM,
 191                 .handler = &sigint,
 192         },
 193 };
 194
 195 FRR_DAEMON_INFO(
 196         zebra, ZEBRA, .vty_port = ZEBRA_VTY_PORT, .flags = FRR_NO_ZCLIENT,
 197
 198         .proghelp =
 199                 "Daemon which manages kernel routing table management "
 200                 "and\nredistribution between different routing protocols.",
 201
 202         .signals = zebra_signals, .n_signals = array_size(zebra_signals),
 203
 204         .privs = &zserv_privs, )
 205
 206 /* Main startup routine. */
 207 int main(int argc, char **argv)
 208 {
 209         // int batch_mode = 0;
 210         char *zserv_path = NULL;
 211         /* Socket to external label manager */
 212         char *lblmgr_path = NULL;
 213         struct sockaddr_storage dummy;
 214         socklen_t dummylen;
 215 #if defined(HANDLE_ZAPI_FUZZING)
 216         char *fuzzing = NULL;
 217 #endif
 218
 219         vrf_configure_backend(VRF_BACKEND_VRF_LITE);
 220         logicalrouter_configure_backend(LOGICALROUTER_BACKEND_NETNS);
 221
 222         frr_preinit(&zebra_di, argc, argv);
 223
 224         frr_opt_add(
 225                 "bakz:e:l:r"
 226 #ifdef HAVE_NETLINK
 227                 "s:n"
 228 #endif
 229 #if defined(HANDLE_ZAPI_FUZZING)
 230                 "c:"
 231 #endif
 232                 ,
 233                 longopts,
 234                 "  -b, --batch           Runs in batch mode\n"
 235                 "  -a, --allow_delete    Allow other processes to delete zebra routes\n"
 236                 "  -z, --socket          Set path of zebra socket\n"
 237                 "  -e, --ecmp            Specify ECMP to use.\n"
 238                 "  -l, --label_socket    Socket to external label manager\n"
 239                 "  -k, --keep_kernel     Don't delete old routes which installed by zebra.\n"
 240                 "  -r, --retain          When program terminates, retain added route by zebra.\n"
 241 #ifdef HAVE_NETLINK
 242                 "  -n, --vrfwnetns       Set VRF with NetNS\n"
 243                 "  -s, --nl-bufsize      Set netlink receive buffer size\n"
 244                 "      --v6-rr-semantics Use v6 RR semantics\n"
 245 #endif /* HAVE_NETLINK */
 246 #if defined(HANDLE_ZAPI_FUZZING)
 247                 "  -c <file>             Bypass normal startup use this file for tetsting of zapi"
 248 #endif
 249         );
 250
 251         while (1) {
 252                 int opt = frr_getopt(argc, argv, NULL);
 253
 254                 if (opt == EOF)
 255                         break;
 256
 257                 switch (opt) {
 258                 case 0:
 259                         break;
 260                 case 'b':
 261                         // batch_mode = 1;
 262                         break;
 263                 case 'a':
 264                         allow_delete = 1;
 265                         break;
 266                 case 'k':
 267                         keep_kernel_mode = 1;
 268                         break;
 269                 case 'e':
 270                         multipath_num = atoi(optarg);
 271                         if (multipath_num > MULTIPATH_NUM
 272                             || multipath_num <= 0) {
 273                                 zlog_err(
 274                                         "Multipath Number specified must be less than %d and greater than 0",
 275                                         MULTIPATH_NUM);
 276                                 return 1;
 277                         }
 278                         break;
 279                 case 'z':
 280                         zserv_path = optarg;
 281                         if (!frr_zclient_addr(&dummy, &dummylen, optarg)) {
 282                                 fprintf(stderr,
 283                                         "Invalid zserv socket path: %s\n",
 284                                         optarg);
 285                                 exit(1);
 286                         }
 287                         break;
 288                 case 'l':
 289                         lblmgr_path = optarg;
 290                         break;
 291                 case 'r':
 292                         retain_mode = 1;
 293                         break;
 294 #ifdef HAVE_NETLINK
 295                 case 's':
 296                         nl_rcvbufsize = atoi(optarg);
 297                         break;
 298                 case 'n':
 299                         vrf_configure_backend(VRF_BACKEND_NETNS);
 300                         logicalrouter_configure_backend(
 301                                 LOGICALROUTER_BACKEND_OFF);
 302                         break;
 303                 case OPTION_V6_RR_SEMANTICS:
 304                         v6_rr_semantics = true;
 305                         break;
 306 #endif /* HAVE_NETLINK */
 307 #if defined(HANDLE_ZAPI_FUZZING)
 308                 case 'c':
 309                         fuzzing = optarg;
 310                         break;
 311 #endif
 312                 default:
 313                         frr_help_exit(1);
 314                         break;
 315                 }
 316         }
 317
 318         vty_config_lockless();
 319         zebrad.master = frr_init();
 320
 321         /* Zebra related initialize. */
 322         zserv_init();
 323         rib_init();
 324         zebra_if_init();
 325         zebra_debug_init();
 326         router_id_cmd_init();
 327
 328         /*
 329          * Initialize NS( and implicitly the VRF module), and make kernel
 330          * routing socket. */
 331         zebra_ns_init();
 332
 333         zebra_vty_init();
 334         access_list_init();
 335         prefix_list_init();
 336 #if defined(HAVE_RTADV)
 337         rtadv_cmd_init();
 338 #endif
 339 /* PTM socket */
 340 #ifdef ZEBRA_PTM_SUPPORT
 341         zebra_ptm_init();
 342 #endif
 343
 344         zebra_mpls_init();
 345         zebra_mpls_vty_init();
 346         zebra_pw_vty_init();
 347         zebra_pbr_init();
 348
 349 /* For debug purpose. */
 350 /* SET_FLAG (zebra_debug_event, ZEBRA_DEBUG_EVENT); */
 351
 352 #if defined(HANDLE_ZAPI_FUZZING)
 353         if (fuzzing) {
 354                 zserv_read_file(fuzzing);
 355                 exit(0);
 356         }
 357 #endif
 358
 359         /* Process the configuration file. Among other configuration
 360         *  directives we can meet those installing static routes. Such
 361         *  requests will not be executed immediately, but queued in
 362         *  zebra->ribq structure until we enter the main execution loop.
 363         *  The notifications from kernel will show originating PID equal
 364         *  to that after daemon() completes (if ever called).
 365         */
 366         frr_config_fork();
 367
 368         /* After we have successfully acquired the pidfile, we can be sure
 369         *  about being the only copy of zebra process, which is submitting
 370         *  changes to the FIB.
 371         *  Clean up zebra-originated routes. The requests will be sent to OS
 372         *  immediately, so originating PID in notifications from kernel
 373         *  will be equal to the current getpid(). To know about such routes,
 374         * we have to have route_read() called before.
 375         */
 376         if (!keep_kernel_mode)
 377                 rib_sweep_route();
 378
 379         /* Needed for BSD routing socket. */
 380         pid = getpid();
 381
 382         /* Intialize pthread library */
 383         frr_pthread_init();
 384
 385         /* Start Zebra API server */
 386         zserv_start(zserv_path);
 387
 388         /* Init label manager */
 389         label_manager_init(lblmgr_path);
 390
 391         /* RNH init */
 392         zebra_rnh_init();
 393
 394         frr_run(zebrad.master);
 395
 396         /* Not reached... */
 397         return 0;
 398 }