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