src/vlib/unix/main.c

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16  * main.c: Unix main routine
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39 #include <vlib/vlib.h>
  40 #include <vlib/unix/unix.h>
  41 #include <vlib/unix/plugin.h>
  42
  43 #include <signal.h>
  44 #include <sys/ucontext.h>
  45 #include <syslog.h>
  46 #include <sys/types.h>
  47 #include <sys/stat.h>
  48 #include <fcntl.h>
  49 #include <sys/time.h>
  50 #include <sys/resource.h>
  51 #include <unistd.h>
  52
  53 /** Default CLI pager limit is not configured in startup.conf */
  54 #define UNIX_CLI_DEFAULT_PAGER_LIMIT 100000
  55
  56 /** Default CLI history depth if not configured in startup.conf */
  57 #define UNIX_CLI_DEFAULT_HISTORY 50
  58
  59 char *vlib_default_runtime_dir __attribute__ ((weak));
  60 char *vlib_default_runtime_dir = "vlib";
  61
  62 unix_main_t unix_main;
  63 clib_file_main_t file_main;
  64 vlib_physmem_main_t physmem_main;
  65
  66 static clib_error_t *
  67 unix_main_init (vlib_main_t * vm)
  68 {
  69   unix_main_t *um = &unix_main;
  70   um->vlib_main = vm;
  71   return vlib_call_init_function (vm, unix_input_init);
  72 }
  73
  74 VLIB_INIT_FUNCTION (unix_main_init);
  75
  76 static void
  77 unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
  78 {
  79   uword fatal = 0;
  80   u8 *msg = 0;
  81
  82   msg = format (msg, "received signal %U, PC %U",
  83                 format_signal, signum, format_ucontext_pc, uc);
  84
  85   if (signum == SIGSEGV)
  86     msg = format (msg, ", faulting address %p", si->si_addr);
  87
  88   switch (signum)
  89     {
  90       /* these (caught) signals cause the application to exit */
  91     case SIGTERM:
  92       if (unix_main.vlib_main->main_loop_exit_set)
  93         {
  94           syslog (LOG_ERR | LOG_DAEMON, "received SIGTERM, exiting...");
  95           unix_main.vlib_main->main_loop_exit_now = 1;
  96         }
  97       break;
  98       /* fall through */
  99     case SIGQUIT:
 100     case SIGINT:
 101     case SIGILL:
 102     case SIGBUS:
 103     case SIGSEGV:
 104     case SIGHUP:
 105     case SIGFPE:
 106       fatal = 1;
 107       break;
 108
 109       /* by default, print a message and continue */
 110     default:
 111       fatal = 0;
 112       break;
 113     }
 114
 115   /* Null terminate. */
 116   vec_add1 (msg, 0);
 117
 118   if (fatal)
 119     {
 120       syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
 121       os_exit (1);
 122     }
 123   else
 124     clib_warning ("%s", msg);
 125
 126   vec_free (msg);
 127 }
 128
 129 static clib_error_t *
 130 setup_signal_handlers (unix_main_t * um)
 131 {
 132   uword i;
 133   struct sigaction sa;
 134
 135   for (i = 1; i < 32; i++)
 136     {
 137       memset (&sa, 0, sizeof (sa));
 138       sa.sa_sigaction = (void *) unix_signal_handler;
 139       sa.sa_flags = SA_SIGINFO;
 140
 141       switch (i)
 142         {
 143           /* these signals take the default action */
 144         case SIGABRT:
 145         case SIGKILL:
 146         case SIGSTOP:
 147         case SIGUSR1:
 148         case SIGUSR2:
 149           continue;
 150
 151           /* ignore SIGPIPE, SIGCHLD */
 152         case SIGPIPE:
 153         case SIGCHLD:
 154           sa.sa_sigaction = (void *) SIG_IGN;
 155           break;
 156
 157           /* catch and handle all other signals */
 158         default:
 159           break;
 160         }
 161
 162       if (sigaction (i, &sa, 0) < 0)
 163         return clib_error_return_unix (0, "sigaction %U", format_signal, i);
 164     }
 165
 166   return 0;
 167 }
 168
 169 static void
 170 unix_error_handler (void *arg, u8 * msg, int msg_len)
 171 {
 172   unix_main_t *um = arg;
 173
 174   /* Echo to stderr when interactive. */
 175   if (um->flags & UNIX_FLAG_INTERACTIVE)
 176     {
 177       CLIB_UNUSED (int r) = write (2, msg, msg_len);
 178     }
 179   else
 180     {
 181       char save = msg[msg_len - 1];
 182
 183       /* Null Terminate. */
 184       msg[msg_len - 1] = 0;
 185
 186       syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
 187
 188       msg[msg_len - 1] = save;
 189     }
 190 }
 191
 192 void
 193 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
 194 {
 195   unix_main_t *um = &unix_main;
 196
 197   if (um->flags & UNIX_FLAG_INTERACTIVE || error == 0)
 198     return;
 199
 200   {
 201     char save;
 202     u8 *msg;
 203     u32 msg_len;
 204
 205     msg = error->what;
 206     msg_len = vec_len (msg);
 207
 208     /* Null Terminate. */
 209     save = msg[msg_len - 1];
 210     msg[msg_len - 1] = 0;
 211
 212     syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
 213
 214     msg[msg_len - 1] = save;
 215   }
 216 }
 217
 218 static uword
 219 startup_config_process (vlib_main_t * vm,
 220                         vlib_node_runtime_t * rt, vlib_frame_t * f)
 221 {
 222   unix_main_t *um = &unix_main;
 223   u8 *buf = 0;
 224   uword l, n = 1;
 225
 226   vlib_process_suspend (vm, 2.0);
 227
 228   while (um->unix_config_complete == 0)
 229     vlib_process_suspend (vm, 0.1);
 230
 231   if (um->startup_config_filename)
 232     {
 233       unformat_input_t sub_input;
 234       int fd;
 235       struct stat s;
 236       char *fn = (char *) um->startup_config_filename;
 237
 238       fd = open (fn, O_RDONLY);
 239       if (fd < 0)
 240         {
 241           clib_warning ("failed to open `%s'", fn);
 242           return 0;
 243         }
 244
 245       if (fstat (fd, &s) < 0)
 246         {
 247           clib_warning ("failed to stat `%s'", fn);
 248         bail:
 249           close (fd);
 250           return 0;
 251         }
 252
 253       if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
 254         {
 255           clib_warning ("not a regular file: `%s'", fn);
 256           goto bail;
 257         }
 258
 259       while (n > 0)
 260         {
 261           l = vec_len (buf);
 262           vec_resize (buf, 4096);
 263           n = read (fd, buf + l, 4096);
 264           if (n > 0)
 265             {
 266               _vec_len (buf) = l + n;
 267               if (n < 4096)
 268                 break;
 269             }
 270           else
 271             break;
 272         }
 273       if (um->log_fd && vec_len (buf))
 274         {
 275           u8 *lv = 0;
 276           lv = format (lv, "%U: ***** Startup Config *****\n%v",
 277                        format_timeval, 0 /* current bat-time */ ,
 278                        0 /* current bat-format */ ,
 279                        buf);
 280           {
 281             int rv __attribute__ ((unused)) =
 282               write (um->log_fd, lv, vec_len (lv));
 283           }
 284           vec_reset_length (lv);
 285           lv = format (lv, "%U: ***** End Startup Config *****\n",
 286                        format_timeval, 0 /* current bat-time */ ,
 287                        0 /* current bat-format */ );
 288           {
 289             int rv __attribute__ ((unused)) =
 290               write (um->log_fd, lv, vec_len (lv));
 291           }
 292           vec_free (lv);
 293         }
 294
 295       if (vec_len (buf))
 296         {
 297           unformat_init_vector (&sub_input, buf);
 298           vlib_cli_input (vm, &sub_input, 0, 0);
 299           /* frees buf for us */
 300           unformat_free (&sub_input);
 301         }
 302       close (fd);
 303     }
 304   return 0;
 305 }
 306
 307 /* *INDENT-OFF* */
 308 VLIB_REGISTER_NODE (startup_config_node,static) = {
 309     .function = startup_config_process,
 310     .type = VLIB_NODE_TYPE_PROCESS,
 311     .name = "startup-config-process",
 312 };
 313 /* *INDENT-ON* */
 314
 315 static clib_error_t *
 316 unix_config (vlib_main_t * vm, unformat_input_t * input)
 317 {
 318   unix_main_t *um = &unix_main;
 319   clib_error_t *error = 0;
 320   gid_t gid;
 321   int pidfd = -1;
 322
 323   /* Defaults */
 324   um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
 325   um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
 326
 327   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 328     {
 329       char *cli_prompt;
 330       if (unformat (input, "interactive"))
 331         um->flags |= UNIX_FLAG_INTERACTIVE;
 332       else if (unformat (input, "nodaemon"))
 333         um->flags |= UNIX_FLAG_NODAEMON;
 334       else if (unformat (input, "cli-prompt %s", &cli_prompt))
 335         vlib_unix_cli_set_prompt (cli_prompt);
 336       else
 337         if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
 338         ;
 339       else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
 340         ;
 341       else if (unformat (input, "cli-line-mode"))
 342         um->cli_line_mode = 1;
 343       else if (unformat (input, "cli-no-banner"))
 344         um->cli_no_banner = 1;
 345       else if (unformat (input, "cli-no-pager"))
 346         um->cli_no_pager = 1;
 347       else if (unformat (input, "cli-pager-buffer-limit %d",
 348                          &um->cli_pager_buffer_limit))
 349         ;
 350       else
 351         if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
 352         ;
 353       else if (unformat (input, "coredump-size"))
 354         {
 355           uword coredump_size = 0;
 356           if (unformat (input, "unlimited"))
 357             {
 358               coredump_size = RLIM_INFINITY;
 359             }
 360           else
 361             if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
 362             {
 363               return clib_error_return (0,
 364                                         "invalid coredump-size parameter `%U'",
 365                                         format_unformat_error, input);
 366             }
 367           const struct rlimit new_limit = { coredump_size, coredump_size };
 368           if (0 != setrlimit (RLIMIT_CORE, &new_limit))
 369             {
 370               clib_unix_warning ("prlimit() failed");
 371             }
 372         }
 373       else if (unformat (input, "full-coredump"))
 374         {
 375           int fd;
 376
 377           fd = open ("/proc/self/coredump_filter", O_WRONLY);
 378           if (fd >= 0)
 379             {
 380               if (write (fd, "0x6f\n", 5) != 5)
 381                 clib_unix_warning ("coredump filter write failed!");
 382               close (fd);
 383             }
 384           else
 385             clib_unix_warning ("couldn't open /proc/self/coredump_filter");
 386         }
 387       else if (unformat (input, "startup-config %s",
 388                          &um->startup_config_filename))
 389         ;
 390       else if (unformat (input, "exec %s", &um->startup_config_filename))
 391         ;
 392       else if (unformat (input, "log %s", &um->log_filename))
 393         {
 394           um->log_fd = open ((char *) um->log_filename,
 395                              O_CREAT | O_WRONLY | O_APPEND, 0644);
 396           if (um->log_fd < 0)
 397             {
 398               clib_warning ("couldn't open log '%s'\n", um->log_filename);
 399               um->log_fd = 0;
 400             }
 401           else
 402             {
 403               u8 *lv = 0;
 404               lv = format (0, "%U: ***** Start: PID %d *****\n",
 405                            format_timeval, 0 /* current bat-time */ ,
 406                            0 /* current bat-format */ ,
 407                            getpid ());
 408               {
 409                 int rv __attribute__ ((unused)) =
 410                   write (um->log_fd, lv, vec_len (lv));
 411               }
 412               vec_free (lv);
 413             }
 414         }
 415       else if (unformat (input, "gid %U", unformat_unix_gid, &gid))
 416         {
 417           if (setegid (gid) == -1)
 418             return clib_error_return_unix (0, "setegid");
 419         }
 420       else if (unformat (input, "pidfile %s", &um->pidfile))
 421         ;
 422       else
 423         return clib_error_return (0, "unknown input `%U'",
 424                                   format_unformat_error, input);
 425     }
 426
 427   if (um->runtime_dir == 0)
 428     {
 429       uid_t uid = geteuid ();
 430       if (uid == 00)
 431         um->runtime_dir = format (0, "/run/%s%c",
 432                                   vlib_default_runtime_dir, 0);
 433       else
 434         um->runtime_dir = format (0, "/run/user/%u/%s%c", uid,
 435                                   vlib_default_runtime_dir, 0);
 436     }
 437
 438   error = setup_signal_handlers (um);
 439   if (error)
 440     return error;
 441
 442   if (um->pidfile)
 443     {
 444       if ((error = vlib_unix_validate_runtime_file (um,
 445                                                     (char *) um->pidfile,
 446                                                     &um->pidfile)))
 447         return error;
 448
 449       if (((pidfd = open ((char *) um->pidfile,
 450                           O_CREAT | O_WRONLY | O_TRUNC, 0644)) < 0))
 451         {
 452           return clib_error_return_unix (0, "open");
 453         }
 454     }
 455
 456   if (!(um->flags & UNIX_FLAG_INTERACTIVE))
 457     {
 458       openlog (vm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
 459       clib_error_register_handler (unix_error_handler, um);
 460
 461       if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
 462                                                        /* stdin/stdout/stderr -> /dev/null */
 463                                                        0) < 0)
 464         clib_error_return (0, "daemon () fails");
 465     }
 466
 467   if (pidfd >= 0)
 468     {
 469       u8 *lv = format (0, "%d", getpid ());
 470       if (write (pidfd, (char *) lv, vec_len (lv)) != vec_len (lv))
 471         {
 472           vec_free (lv);
 473           close (pidfd);
 474           return clib_error_return_unix (0, "write");
 475         }
 476       vec_free (lv);
 477       close (pidfd);
 478     }
 479
 480   um->unix_config_complete = 1;
 481
 482   return 0;
 483 }
 484
 485 /* unix { ... } configuration. */
 486 /*?
 487  *
 488  * @cfgcmd{interactive}
 489  * Attach CLI to stdin/out and provide a debugging command line interface.
 490  * Implies @c nodaemon.
 491  *
 492  * @cfgcmd{nodaemon}
 493  * Do not fork or background the VPP process. Typically used when invoking
 494  * VPP applications from a process monitor.
 495  *
 496  * @cfgcmd{exec, &lt;filename&gt;}
 497  * @par <code>startup-config &lt;filename&gt;</code>
 498  * Read startup operational configuration from @c filename.
 499  * The contents of the file will be performed as though entered at the CLI.
 500  * The two keywords are aliases for the same function; if both are specified,
 501  * only the last will have an effect.
 502  *
 503  * @cfgcmd{log, &lt;filename&gt;}
 504  * Logs the startup configuration and all subsequent CLI commands in
 505  * @c filename.
 506  * Very useful in situations where folks don't remember or can't be bothered
 507  * to include CLI commands in bug reports.
 508  *
 509  * @cfgcmd{pidfile, &lt;filename&gt;}
 510  * Writes the pid of the main thread in @c filename.
 511  *
 512  * @cfgcmd{full-coredump}
 513  * Ask the Linux kernel to dump all memory-mapped address regions, instead
 514  * of just text+data+bss.
 515  *
 516  * @cfgcmd{runtime-dir}
 517  * Define directory where VPP is going to store all runtime files.
 518  * Default is /run/vpp.
 519  *
 520  * @cfgcmd{cli-listen, &lt;address:port&gt;}
 521  * Bind the CLI to listen at the address and port given. @clocalhost
 522  * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
 523  * is typical.
 524  *
 525  * @cfgcmd{cli-line-mode}
 526  * Disable character-by-character I/O on stdin. Useful when combined with,
 527  * for example, <tt>emacs M-x gud-gdb</tt>.
 528  *
 529  * @cfgcmd{cli-prompt, &lt;string&gt;}
 530  * Configure the CLI prompt to be @c string.
 531  *
 532  * @cfgcmd{cli-history-limit, &lt;nn&gt;}
 533  * Limit commmand history to @c nn  lines. A value of @c 0
 534  * disables command history. Default value: @c 50
 535  *
 536  * @cfgcmd{cli-no-banner}
 537  * Disable the login banner on stdin and Telnet connections.
 538  *
 539  * @cfgcmd{cli-no-pager}
 540  * Disable the output pager.
 541  *
 542  * @cfgcmd{cli-pager-buffer-limit, &lt;nn&gt;}
 543  * Limit pager buffer to @c nn lines of output.
 544  * A value of @c 0 disables the pager. Default value: @c 100000
 545 ?*/
 546 VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
 547
 548 static clib_error_t *
 549 unix_exit (vlib_main_t * vm)
 550 {
 551   /* Close syslog connection. */
 552   closelog ();
 553   return 0;
 554 }
 555
 556 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
 557
 558 u8 **vlib_thread_stacks;
 559
 560 static uword
 561 thread0 (uword arg)
 562 {
 563   vlib_main_t *vm = (vlib_main_t *) arg;
 564   unformat_input_t input;
 565   int i;
 566
 567   unformat_init_command_line (&input, (char **) vm->argv);
 568   i = vlib_main (vm, &input);
 569   unformat_free (&input);
 570
 571   return i;
 572 }
 573
 574 u8 *
 575 vlib_thread_stack_init (uword thread_index)
 576 {
 577   vec_validate (vlib_thread_stacks, thread_index);
 578   vlib_thread_stacks[thread_index] = clib_mem_alloc_aligned
 579     (VLIB_THREAD_STACK_SIZE, VLIB_THREAD_STACK_SIZE);
 580
 581   /*
 582    * Disallow writes to the bottom page of the stack, to
 583    * catch stack overflows.
 584    */
 585   if (mprotect (vlib_thread_stacks[thread_index],
 586                 clib_mem_get_page_size (), PROT_READ) < 0)
 587     clib_unix_warning ("thread stack");
 588   return vlib_thread_stacks[thread_index];
 589 }
 590
 591 int
 592 vlib_unix_main (int argc, char *argv[])
 593 {
 594   vlib_main_t *vm = &vlib_global_main;  /* one and only time for this! */
 595   unformat_input_t input;
 596   clib_error_t *e;
 597   int i;
 598
 599   vm->argv = (u8 **) argv;
 600   vm->name = argv[0];
 601   vm->heap_base = clib_mem_get_heap ();
 602   ASSERT (vm->heap_base);
 603
 604   unformat_init_command_line (&input, (char **) vm->argv);
 605   if ((e = vlib_plugin_config (vm, &input)))
 606     {
 607       clib_error_report (e);
 608       return 1;
 609     }
 610   unformat_free (&input);
 611
 612   i = vlib_plugin_early_init (vm);
 613   if (i)
 614     return i;
 615
 616   unformat_init_command_line (&input, (char **) vm->argv);
 617   if (vm->init_functions_called == 0)
 618     vm->init_functions_called = hash_create (0, /* value bytes */ 0);
 619   e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
 620   if (e != 0)
 621     {
 622       clib_error_report (e);
 623       return 1;
 624     }
 625   unformat_free (&input);
 626
 627   vlib_thread_stack_init (0);
 628
 629   __os_thread_index = 0;
 630   vm->thread_index = 0;
 631
 632   i = clib_calljmp (thread0, (uword) vm,
 633                     (void *) (vlib_thread_stacks[0] +
 634                               VLIB_THREAD_STACK_SIZE));
 635   return i;
 636 }
 637
 638 /*
 639  * fd.io coding-style-patch-verification: ON
 640  *
 641  * Local Variables:
 642  * eval: (c-set-style "gnu")
 643  * End:
 644  */