bgpd/bgp_main.c

   1 /* Main routine of bgpd.
   2    Copyright (C) 1996, 97, 98, 1999 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
  17 along with GNU Zebra; see the file COPYING.  If not, write to the Free
  18 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.  */
  20
  21 #include <zebra.h>
  22
  23 #include "vector.h"
  24 #include "vty.h"
  25 #include "command.h"
  26 #include "getopt.h"
  27 #include "thread.h"
  28 #include <lib/version.h>
  29 #include "memory.h"
  30 #include "prefix.h"
  31 #include "log.h"
  32 #include "privs.h"
  33 #include "sigevent.h"
  34
  35 #include "bgpd/bgpd.h"
  36 #include "bgpd/bgp_attr.h"
  37 #include "bgpd/bgp_mplsvpn.h"
  38
  39 /* bgpd options, we use GNU getopt library. */
  40 struct option longopts[] =
  41 {
  42   { "daemon",      no_argument,       NULL, 'd'},
  43   { "config_file", required_argument, NULL, 'f'},
  44   { "pid_file",    required_argument, NULL, 'i'},
  45   { "bgp_port",    required_argument, NULL, 'p'},
  46   { "listenon",    required_argument, NULL, 'l'},
  47   { "vty_addr",    required_argument, NULL, 'A'},
  48   { "vty_port",    required_argument, NULL, 'P'},
  49   { "retain",      no_argument,       NULL, 'r'},
  50   { "no_kernel",   no_argument,       NULL, 'n'},
  51   { "user",        required_argument, NULL, 'u'},
  52   { "group",       required_argument, NULL, 'g'},
  53   { "version",     no_argument,       NULL, 'v'},
  54   { "dryrun",      no_argument,       NULL, 'C'},
  55   { "help",        no_argument,       NULL, 'h'},
  56   { 0 }
  57 };
  58
  59 /* signal definitions */
  60 void sighup (void);
  61 void sigint (void);
  62 void sigusr1 (void);
  63
  64 struct quagga_signal_t bgp_signals[] =
  65 {
  66   {
  67     .signal = SIGHUP,
  68     .handler = &sighup,
  69   },
  70   {
  71     .signal = SIGUSR1,
  72     .handler = &sigusr1,
  73   },
  74   {
  75     .signal = SIGINT,
  76     .handler = &sigint,
  77   },
  78   {
  79     .signal = SIGTERM,
  80     .handler = &sigint,
  81   },
  82 };
  83
  84 /* Configuration file and directory. */
  85 char config_default[] = SYSCONFDIR BGP_DEFAULT_CONFIG;
  86
  87 /* Route retain mode flag. */
  88 int retain_mode = 0;
  89
  90 /* Master of threads. */
  91 struct thread_master *master;
  92
  93 /* Manually specified configuration file name.  */
  94 char *config_file = NULL;
  95
  96 /* Process ID saved for use by init system */
  97 const char *pid_file = PATH_BGPD_PID;
  98
  99 /* VTY port number and address.  */
 100 int vty_port = BGP_VTY_PORT;
 101 char *vty_addr = NULL;
 102
 103 /* privileges */
 104 zebra_capabilities_t _caps_p [] =
 105 {
 106     ZCAP_BIND,
 107     ZCAP_NET_RAW,
 108 };
 109
 110 struct zebra_privs_t bgpd_privs =
 111 {
 112 #if defined(QUAGGA_USER) && defined(QUAGGA_GROUP)
 113   .user = QUAGGA_USER,
 114   .group = QUAGGA_GROUP,
 115 #endif
 116 #ifdef VTY_GROUP
 117   .vty_group = VTY_GROUP,
 118 #endif
 119   .caps_p = _caps_p,
 120   .cap_num_p = sizeof(_caps_p)/sizeof(_caps_p[0]),
 121   .cap_num_i = 0,
 122 };
 123
 124 /* Help information display. */
 125 static void
 126 usage (char *progname, int status)
 127 {
 128   if (status != 0)
 129     fprintf (stderr, "Try `%s --help' for more information.\n", progname);
 130   else
 131     {
 132       printf ("Usage : %s [OPTION...]\n\n\
 133 Daemon which manages kernel routing table management and \
 134 redistribution between different routing protocols.\n\n\
 135 -d, --daemon       Runs in daemon mode\n\
 136 -f, --config_file  Set configuration file name\n\
 137 -i, --pid_file     Set process identifier file name\n\
 138 -p, --bgp_port     Set bgp protocol's port number\n\
 139 -l, --listenon     Listen on specified address (implies -n)\n\
 140 -A, --vty_addr     Set vty's bind address\n\
 141 -P, --vty_port     Set vty's port number\n\
 142 -r, --retain       When program terminates, retain added route by bgpd.\n\
 143 -n, --no_kernel    Do not install route to kernel.\n\
 144 -u, --user         User to run as\n\
 145 -g, --group        Group to run as\n\
 146 -v, --version      Print program version\n\
 147 -C, --dryrun       Check configuration for validity and exit\n\
 148 -h, --help         Display this help and exit\n\
 149 \n\
 150 Report bugs to %s\n", progname, ZEBRA_BUG_ADDRESS);
 151     }
 152
 153   exit (status);
 154 }
 155 \f
 156 /* SIGHUP handler. */
 157 void
 158 sighup (void)
 159 {
 160   zlog (NULL, LOG_INFO, "SIGHUP received");
 161
 162   /* Terminate all thread. */
 163   bgp_terminate ();
 164   bgp_reset ();
 165   zlog_info ("bgpd restarting!");
 166
 167   /* Reload config file. */
 168   vty_read_config (config_file, config_default);
 169
 170   /* Create VTY's socket */
 171   vty_serv_sock (vty_addr, vty_port, BGP_VTYSH_PATH);
 172
 173   /* Try to return to normal operation. */
 174 }
 175
 176 /* SIGINT handler. */
 177 void
 178 sigint (void)
 179 {
 180   zlog_notice ("Terminating on signal");
 181
 182   if (! retain_mode)
 183     bgp_terminate ();
 184
 185   exit (0);
 186 }
 187
 188 /* SIGUSR1 handler. */
 189 void
 190 sigusr1 (void)
 191 {
 192   zlog_rotate (NULL);
 193 }
 194 \f
 195 /* Main routine of bgpd. Treatment of argument and start bgp finite
 196    state machine is handled at here. */
 197 int
 198 main (int argc, char **argv)
 199 {
 200   char *p;
 201   int opt;
 202   int daemon_mode = 0;
 203   int dryrun = 0;
 204   char *progname;
 205   struct thread thread;
 206   int tmp_port;
 207
 208   /* Set umask before anything for security */
 209   umask (0027);
 210
 211   /* Preserve name of myself. */
 212   progname = ((p = strrchr (argv[0], '/')) ? ++p : argv[0]);
 213
 214   zlog_default = openzlog (progname, ZLOG_BGP,
 215                            LOG_CONS|LOG_NDELAY|LOG_PID, LOG_DAEMON);
 216
 217   /* BGP master init. */
 218   bgp_master_init ();
 219
 220   /* Command line argument treatment. */
 221   while (1)
 222     {
 223       opt = getopt_long (argc, argv, "df:i:hp:l:A:P:rnu:g:vC", longopts, 0);
 224
 225       if (opt == EOF)
 226         break;
 227
 228       switch (opt)
 229         {
 230         case 0:
 231           break;
 232         case 'd':
 233           daemon_mode = 1;
 234           break;
 235         case 'f':
 236           config_file = optarg;
 237           break;
 238         case 'i':
 239           pid_file = optarg;
 240           break;
 241         case 'p':
 242           tmp_port = atoi (optarg);
 243           if (tmp_port <= 0 || tmp_port > 0xffff)
 244             bm->port = BGP_PORT_DEFAULT;
 245           else
 246             bm->port = tmp_port;
 247           break;
 248         case 'A':
 249           vty_addr = optarg;
 250           break;
 251         case 'P':
 252           /* Deal with atoi() returning 0 on failure, and bgpd not
 253              listening on bgp port... */
 254           if (strcmp(optarg, "0") == 0)
 255             {
 256               vty_port = 0;
 257               break;
 258             }
 259           vty_port = atoi (optarg);
 260           if (vty_port <= 0 || vty_port > 0xffff)
 261             vty_port = BGP_VTY_PORT;
 262           break;
 263         case 'r':
 264           retain_mode = 1;
 265           break;
 266         case 'l':
 267           bm->address = optarg;
 268           /* listenon implies -n */
 269         case 'n':
 270           bgp_option_set (BGP_OPT_NO_FIB);
 271           break;
 272         case 'u':
 273           bgpd_privs.user = optarg;
 274           break;
 275         case 'g':
 276           bgpd_privs.group = optarg;
 277           break;
 278         case 'v':
 279           print_version (progname);
 280           exit (0);
 281           break;
 282         case 'C':
 283           dryrun = 1;
 284           break;
 285         case 'h':
 286           usage (progname, 0);
 287           break;
 288         default:
 289           usage (progname, 1);
 290           break;
 291         }
 292     }
 293
 294   /* Make thread master. */
 295   master = bm->master;
 296
 297   /* Initializations. */
 298   srand (time (NULL));
 299   signal_init (master, Q_SIGC(bgp_signals), bgp_signals);
 300   zprivs_init (&bgpd_privs);
 301   cmd_init (1);
 302   vty_init (master);
 303   memory_init ();
 304
 305   /* BGP related initialization.  */
 306   bgp_init ();
 307
 308   /* Sort CLI commands. */
 309   sort_node ();
 310
 311   /* Parse config file. */
 312   vty_read_config (config_file, config_default);
 313
 314   /* Start execution only if not in dry-run mode */
 315   if(dryrun)
 316     return(0);
 317
 318   /* Turn into daemon if daemon_mode is set. */
 319   if (daemon_mode)
 320     daemon (0, 0);
 321
 322   /* Process ID file creation. */
 323   pid_output (pid_file);
 324
 325   /* Make bgp vty socket. */
 326   vty_serv_sock (vty_addr, vty_port, BGP_VTYSH_PATH);
 327
 328   /* Print banner. */
 329   zlog_notice ("BGPd %s starting: vty@%d, bgp@%s:%d", QUAGGA_VERSION,
 330                vty_port,
 331                (bm->address ? bm->address : "<all>"),
 332                bm->port);
 333
 334   /* Start finite state machine, here we go! */
 335   while (thread_fetch (master, &thread))
 336     thread_call (&thread);
 337
 338   /* Not reached. */
 339   return (0);
 340 }