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
  65 static clib_error_t *
  66 unix_main_init (vlib_main_t * vm)
  67 {
  68   unix_main_t *um = &unix_main;
  69   um->vlib_main = vm;
  70   return vlib_call_init_function (vm, unix_input_init);
  71 }
  72
  73 VLIB_INIT_FUNCTION (unix_main_init);
  74
  75 static int
  76 unsetup_signal_handlers (int sig)
  77 {
  78   struct sigaction sa;
  79
  80   sa.sa_handler = SIG_DFL;
  81   sa.sa_flags = 0;
  82   sigemptyset (&sa.sa_mask);
  83   return sigaction (sig, &sa, 0);
  84 }
  85
  86
  87 /* allocate this buffer from mheap when setting up the signal handler.
  88     dangerous to vec_resize it when crashing, mheap itself might have been
  89     corruptted already */
  90 static u8 *syslog_msg = 0;
  91
  92 static void
  93 unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
  94 {
  95   uword fatal = 0;
  96
  97   syslog_msg = format (syslog_msg, "received signal %U, PC %U",
  98                        format_signal, signum, format_ucontext_pc, uc);
  99
 100   if (signum == SIGSEGV)
 101     syslog_msg = format (syslog_msg, ", faulting address %p", si->si_addr);
 102
 103   switch (signum)
 104     {
 105       /* these (caught) signals cause the application to exit */
 106     case SIGTERM:
 107       if (unix_main.vlib_main->main_loop_exit_set)
 108         {
 109           syslog (LOG_ERR | LOG_DAEMON, "received SIGTERM, exiting...");
 110           unix_main.vlib_main->main_loop_exit_now = 1;
 111         }
 112       break;
 113       /* fall through */
 114     case SIGQUIT:
 115     case SIGINT:
 116     case SIGILL:
 117     case SIGBUS:
 118     case SIGSEGV:
 119     case SIGHUP:
 120     case SIGFPE:
 121     case SIGABRT:
 122       fatal = 1;
 123       break;
 124
 125       /* by default, print a message and continue */
 126     default:
 127       fatal = 0;
 128       break;
 129     }
 130
 131   /* Null terminate. */
 132   vec_add1 (syslog_msg, 0);
 133
 134   if (fatal)
 135     {
 136       syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
 137
 138       /* Address of callers: outer first, inner last. */
 139       uword callers[15];
 140       uword n_callers = clib_backtrace (callers, ARRAY_LEN (callers), 0);
 141       int i;
 142       for (i = 0; i < n_callers; i++)
 143         {
 144           vec_reset_length (syslog_msg);
 145
 146           syslog_msg =
 147             format (syslog_msg, "#%-2d 0x%016lx %U%c", i, callers[i],
 148                     format_clib_elf_symbol_with_address, callers[i], 0);
 149
 150           syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
 151         }
 152
 153       /* have to remove SIGABRT to avoid recusive - os_exit calling abort() */
 154       unsetup_signal_handlers (SIGABRT);
 155
 156       os_exit (1);
 157     }
 158   else
 159     clib_warning ("%s", syslog_msg);
 160
 161 }
 162
 163 static clib_error_t *
 164 setup_signal_handlers (unix_main_t * um)
 165 {
 166   uword i;
 167   struct sigaction sa;
 168
 169   /* give a big enough buffer for msg, most likely it can avoid vec_resize  */
 170   vec_alloc (syslog_msg, 2048);
 171
 172   for (i = 1; i < 32; i++)
 173     {
 174       clib_memset (&sa, 0, sizeof (sa));
 175       sa.sa_sigaction = (void *) unix_signal_handler;
 176       sa.sa_flags = SA_SIGINFO;
 177
 178       switch (i)
 179         {
 180           /* these signals take the default action */
 181         case SIGKILL:
 182         case SIGSTOP:
 183         case SIGUSR1:
 184         case SIGUSR2:
 185           continue;
 186
 187           /* ignore SIGPIPE, SIGCHLD */
 188         case SIGPIPE:
 189         case SIGCHLD:
 190           sa.sa_sigaction = (void *) SIG_IGN;
 191           break;
 192
 193           /* catch and handle all other signals */
 194         default:
 195           break;
 196         }
 197
 198       if (sigaction (i, &sa, 0) < 0)
 199         return clib_error_return_unix (0, "sigaction %U", format_signal, i);
 200     }
 201
 202   return 0;
 203 }
 204
 205 static void
 206 unix_error_handler (void *arg, u8 * msg, int msg_len)
 207 {
 208   unix_main_t *um = arg;
 209
 210   /* Echo to stderr when interactive. */
 211   if (um->flags & UNIX_FLAG_INTERACTIVE)
 212     {
 213       CLIB_UNUSED (int r) = write (2, msg, msg_len);
 214     }
 215   else
 216     {
 217       char save = msg[msg_len - 1];
 218
 219       /* Null Terminate. */
 220       msg[msg_len - 1] = 0;
 221
 222       syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
 223
 224       msg[msg_len - 1] = save;
 225     }
 226 }
 227
 228 void
 229 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
 230 {
 231   unix_main_t *um = &unix_main;
 232
 233   if (um->flags & UNIX_FLAG_INTERACTIVE || error == 0)
 234     return;
 235
 236   {
 237     char save;
 238     u8 *msg;
 239     u32 msg_len;
 240
 241     msg = error->what;
 242     msg_len = vec_len (msg);
 243
 244     /* Null Terminate. */
 245     save = msg[msg_len - 1];
 246     msg[msg_len - 1] = 0;
 247
 248     syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
 249
 250     msg[msg_len - 1] = save;
 251   }
 252 }
 253
 254 static uword
 255 startup_config_process (vlib_main_t * vm,
 256                         vlib_node_runtime_t * rt, vlib_frame_t * f)
 257 {
 258   unix_main_t *um = &unix_main;
 259   u8 *buf = 0;
 260   uword l, n = 1;
 261
 262   vlib_process_suspend (vm, 2.0);
 263
 264   while (um->unix_config_complete == 0)
 265     vlib_process_suspend (vm, 0.1);
 266
 267   if (um->startup_config_filename)
 268     {
 269       unformat_input_t sub_input;
 270       int fd;
 271       struct stat s;
 272       char *fn = (char *) um->startup_config_filename;
 273
 274       fd = open (fn, O_RDONLY);
 275       if (fd < 0)
 276         {
 277           clib_warning ("failed to open `%s'", fn);
 278           return 0;
 279         }
 280
 281       if (fstat (fd, &s) < 0)
 282         {
 283           clib_warning ("failed to stat `%s'", fn);
 284         bail:
 285           close (fd);
 286           return 0;
 287         }
 288
 289       if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
 290         {
 291           clib_warning ("not a regular file: `%s'", fn);
 292           goto bail;
 293         }
 294
 295       while (n > 0)
 296         {
 297           l = vec_len (buf);
 298           vec_resize (buf, 4096);
 299           n = read (fd, buf + l, 4096);
 300           if (n > 0)
 301             {
 302               _vec_len (buf) = l + n;
 303               if (n < 4096)
 304                 break;
 305             }
 306           else
 307             break;
 308         }
 309       if (um->log_fd && vec_len (buf))
 310         {
 311           u8 *lv = 0;
 312           lv = format (lv, "%U: ***** Startup Config *****\n%v",
 313                        format_timeval, 0 /* current bat-time */ ,
 314                        0 /* current bat-format */ ,
 315                        buf);
 316           {
 317             int rv __attribute__ ((unused)) =
 318               write (um->log_fd, lv, vec_len (lv));
 319           }
 320           vec_reset_length (lv);
 321           lv = format (lv, "%U: ***** End Startup Config *****\n",
 322                        format_timeval, 0 /* current bat-time */ ,
 323                        0 /* current bat-format */ );
 324           {
 325             int rv __attribute__ ((unused)) =
 326               write (um->log_fd, lv, vec_len (lv));
 327           }
 328           vec_free (lv);
 329         }
 330
 331       if (vec_len (buf))
 332         {
 333           unformat_init_vector (&sub_input, buf);
 334           vlib_cli_input (vm, &sub_input, 0, 0);
 335           /* frees buf for us */
 336           unformat_free (&sub_input);
 337         }
 338       close (fd);
 339     }
 340   return 0;
 341 }
 342
 343 /* *INDENT-OFF* */
 344 VLIB_REGISTER_NODE (startup_config_node,static) = {
 345     .function = startup_config_process,
 346     .type = VLIB_NODE_TYPE_PROCESS,
 347     .name = "startup-config-process",
 348 };
 349 /* *INDENT-ON* */
 350
 351 static clib_error_t *
 352 unix_config (vlib_main_t * vm, unformat_input_t * input)
 353 {
 354   unix_main_t *um = &unix_main;
 355   clib_error_t *error = 0;
 356   gid_t gid;
 357   int pidfd = -1;
 358
 359   /* Defaults */
 360   um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
 361   um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
 362
 363   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 364     {
 365       char *cli_prompt;
 366       if (unformat (input, "interactive"))
 367         um->flags |= UNIX_FLAG_INTERACTIVE;
 368       else if (unformat (input, "nodaemon"))
 369         um->flags |= UNIX_FLAG_NODAEMON;
 370       else if (unformat (input, "cli-prompt %s", &cli_prompt))
 371         vlib_unix_cli_set_prompt (cli_prompt);
 372       else
 373         if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
 374         ;
 375       else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
 376         ;
 377       else if (unformat (input, "cli-line-mode"))
 378         um->cli_line_mode = 1;
 379       else if (unformat (input, "cli-no-banner"))
 380         um->cli_no_banner = 1;
 381       else if (unformat (input, "cli-no-pager"))
 382         um->cli_no_pager = 1;
 383       else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
 384         ;
 385       else if (unformat (input, "cli-pager-buffer-limit %d",
 386                          &um->cli_pager_buffer_limit))
 387         ;
 388       else
 389         if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
 390         ;
 391       else if (unformat (input, "coredump-size"))
 392         {
 393           uword coredump_size = 0;
 394           if (unformat (input, "unlimited"))
 395             {
 396               coredump_size = RLIM_INFINITY;
 397             }
 398           else
 399             if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
 400             {
 401               return clib_error_return (0,
 402                                         "invalid coredump-size parameter `%U'",
 403                                         format_unformat_error, input);
 404             }
 405           const struct rlimit new_limit = { coredump_size, coredump_size };
 406           if (0 != setrlimit (RLIMIT_CORE, &new_limit))
 407             {
 408               clib_unix_warning ("prlimit() failed");
 409             }
 410         }
 411       else if (unformat (input, "full-coredump"))
 412         {
 413           int fd;
 414
 415           fd = open ("/proc/self/coredump_filter", O_WRONLY);
 416           if (fd >= 0)
 417             {
 418               if (write (fd, "0x6f\n", 5) != 5)
 419                 clib_unix_warning ("coredump filter write failed!");
 420               close (fd);
 421             }
 422           else
 423             clib_unix_warning ("couldn't open /proc/self/coredump_filter");
 424         }
 425       else if (unformat (input, "startup-config %s",
 426                          &um->startup_config_filename))
 427         ;
 428       else if (unformat (input, "exec %s", &um->startup_config_filename))
 429         ;
 430       else if (unformat (input, "log %s", &um->log_filename))
 431         {
 432           um->log_fd = open ((char *) um->log_filename,
 433                              O_CREAT | O_WRONLY | O_APPEND, 0644);
 434           if (um->log_fd < 0)
 435             {
 436               clib_warning ("couldn't open log '%s'\n", um->log_filename);
 437               um->log_fd = 0;
 438             }
 439           else
 440             {
 441               u8 *lv = 0;
 442               lv = format (0, "%U: ***** Start: PID %d *****\n",
 443                            format_timeval, 0 /* current bat-time */ ,
 444                            0 /* current bat-format */ ,
 445                            getpid ());
 446               {
 447                 int rv __attribute__ ((unused)) =
 448                   write (um->log_fd, lv, vec_len (lv));
 449               }
 450               vec_free (lv);
 451             }
 452         }
 453       else if (unformat (input, "gid %U", unformat_unix_gid, &gid))
 454         {
 455           if (setegid (gid) == -1)
 456             return clib_error_return_unix (0, "setegid");
 457         }
 458       else if (unformat (input, "pidfile %s", &um->pidfile))
 459         ;
 460       else
 461         return clib_error_return (0, "unknown input `%U'",
 462                                   format_unformat_error, input);
 463     }
 464
 465   if (um->runtime_dir == 0)
 466     {
 467       uid_t uid = geteuid ();
 468       if (uid == 00)
 469         um->runtime_dir = format (0, "/run/%s%c",
 470                                   vlib_default_runtime_dir, 0);
 471       else
 472         um->runtime_dir = format (0, "/run/user/%u/%s%c", uid,
 473                                   vlib_default_runtime_dir, 0);
 474     }
 475
 476   error = setup_signal_handlers (um);
 477   if (error)
 478     return error;
 479
 480   if (um->pidfile)
 481     {
 482       if ((error = vlib_unix_validate_runtime_file (um,
 483                                                     (char *) um->pidfile,
 484                                                     &um->pidfile)))
 485         return error;
 486
 487       if (((pidfd = open ((char *) um->pidfile,
 488                           O_CREAT | O_WRONLY | O_TRUNC, 0644)) < 0))
 489         {
 490           return clib_error_return_unix (0, "open");
 491         }
 492     }
 493
 494   if (!(um->flags & UNIX_FLAG_INTERACTIVE))
 495     {
 496       openlog (vm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
 497       clib_error_register_handler (unix_error_handler, um);
 498
 499       if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
 500                                                        /* stdin/stdout/stderr -> /dev/null */
 501                                                        0) < 0)
 502         clib_error_return (0, "daemon () fails");
 503     }
 504
 505   if (pidfd >= 0)
 506     {
 507       u8 *lv = format (0, "%d", getpid ());
 508       if (write (pidfd, (char *) lv, vec_len (lv)) != vec_len (lv))
 509         {
 510           vec_free (lv);
 511           close (pidfd);
 512           return clib_error_return_unix (0, "write");
 513         }
 514       vec_free (lv);
 515       close (pidfd);
 516     }
 517
 518   um->unix_config_complete = 1;
 519
 520   return 0;
 521 }
 522
 523 /* unix { ... } configuration. */
 524 /*?
 525  *
 526  * @cfgcmd{interactive}
 527  * Attach CLI to stdin/out and provide a debugging command line interface.
 528  * Implies @c nodaemon.
 529  *
 530  * @cfgcmd{nodaemon}
 531  * Do not fork or background the VPP process. Typically used when invoking
 532  * VPP applications from a process monitor.
 533  *
 534  * @cfgcmd{exec, &lt;filename&gt;}
 535  * @par <code>startup-config &lt;filename&gt;</code>
 536  * Read startup operational configuration from @c filename.
 537  * The contents of the file will be performed as though entered at the CLI.
 538  * The two keywords are aliases for the same function; if both are specified,
 539  * only the last will have an effect.
 540  *
 541  * @cfgcmd{log, &lt;filename&gt;}
 542  * Logs the startup configuration and all subsequent CLI commands in
 543  * @c filename.
 544  * Very useful in situations where folks don't remember or can't be bothered
 545  * to include CLI commands in bug reports.
 546  *
 547  * @cfgcmd{pidfile, &lt;filename&gt;}
 548  * Writes the pid of the main thread in @c filename.
 549  *
 550  * @cfgcmd{full-coredump}
 551  * Ask the Linux kernel to dump all memory-mapped address regions, instead
 552  * of just text+data+bss.
 553  *
 554  * @cfgcmd{runtime-dir}
 555  * Define directory where VPP is going to store all runtime files.
 556  * Default is /run/vpp.
 557  *
 558  * @cfgcmd{cli-listen, &lt;address:port&gt;}
 559  * Bind the CLI to listen at the address and port given. @clocalhost
 560  * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
 561  * is typical.
 562  *
 563  * @cfgcmd{cli-line-mode}
 564  * Disable character-by-character I/O on stdin. Useful when combined with,
 565  * for example, <tt>emacs M-x gud-gdb</tt>.
 566  *
 567  * @cfgcmd{cli-prompt, &lt;string&gt;}
 568  * Configure the CLI prompt to be @c string.
 569  *
 570  * @cfgcmd{cli-history-limit, &lt;nn&gt;}
 571  * Limit commmand history to @c nn  lines. A value of @c 0
 572  * disables command history. Default value: @c 50
 573  *
 574  * @cfgcmd{cli-no-banner}
 575  * Disable the login banner on stdin and Telnet connections.
 576  *
 577  * @cfgcmd{cli-no-pager}
 578  * Disable the output pager.
 579  *
 580  * @cfgcmd{cli-pager-buffer-limit, &lt;nn&gt;}
 581  * Limit pager buffer to @c nn lines of output.
 582  * A value of @c 0 disables the pager. Default value: @c 100000
 583 ?*/
 584 VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
 585
 586 static clib_error_t *
 587 unix_exit (vlib_main_t * vm)
 588 {
 589   /* Close syslog connection. */
 590   closelog ();
 591   return 0;
 592 }
 593
 594 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
 595
 596 u8 **vlib_thread_stacks;
 597
 598 static uword
 599 thread0 (uword arg)
 600 {
 601   vlib_main_t *vm = (vlib_main_t *) arg;
 602   unformat_input_t input;
 603   int i;
 604
 605   unformat_init_command_line (&input, (char **) vm->argv);
 606   i = vlib_main (vm, &input);
 607   unformat_free (&input);
 608
 609   return i;
 610 }
 611
 612 u8 *
 613 vlib_thread_stack_init (uword thread_index)
 614 {
 615   vec_validate (vlib_thread_stacks, thread_index);
 616   vlib_thread_stacks[thread_index] = clib_mem_alloc_aligned
 617     (VLIB_THREAD_STACK_SIZE, VLIB_THREAD_STACK_SIZE);
 618
 619   /*
 620    * Disallow writes to the bottom page of the stack, to
 621    * catch stack overflows.
 622    */
 623   if (mprotect (vlib_thread_stacks[thread_index],
 624                 clib_mem_get_page_size (), PROT_READ) < 0)
 625     clib_unix_warning ("thread stack");
 626   return vlib_thread_stacks[thread_index];
 627 }
 628
 629 int
 630 vlib_unix_main (int argc, char *argv[])
 631 {
 632   vlib_main_t *vm = &vlib_global_main;  /* one and only time for this! */
 633   unformat_input_t input;
 634   clib_error_t *e;
 635   int i;
 636
 637   vm->argv = (u8 **) argv;
 638   vm->name = argv[0];
 639   vm->heap_base = clib_mem_get_heap ();
 640   vm->heap_aligned_base = (void *)
 641     (((uword) vm->heap_base) & ~(VLIB_FRAME_ALIGN - 1));
 642   ASSERT (vm->heap_base);
 643
 644   unformat_init_command_line (&input, (char **) vm->argv);
 645   if ((e = vlib_plugin_config (vm, &input)))
 646     {
 647       clib_error_report (e);
 648       return 1;
 649     }
 650   unformat_free (&input);
 651
 652   i = vlib_plugin_early_init (vm);
 653   if (i)
 654     return i;
 655
 656   unformat_init_command_line (&input, (char **) vm->argv);
 657   if (vm->init_functions_called == 0)
 658     vm->init_functions_called = hash_create (0, /* value bytes */ 0);
 659   e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
 660   if (e != 0)
 661     {
 662       clib_error_report (e);
 663       return 1;
 664     }
 665   unformat_free (&input);
 666
 667   /* always load symbols, for signal handler and mheap memory get/put backtrace */
 668   clib_elf_main_init (vm->name);
 669
 670   vlib_thread_stack_init (0);
 671
 672   __os_thread_index = 0;
 673   vm->thread_index = 0;
 674
 675   i = clib_calljmp (thread0, (uword) vm,
 676                     (void *) (vlib_thread_stacks[0] +
 677                               VLIB_THREAD_STACK_SIZE));
 678   return i;
 679 }
 680
 681 /*
 682  * fd.io coding-style-patch-verification: ON
 683  *
 684  * Local Variables:
 685  * eval: (c-set-style "gnu")
 686  * End:
 687  */