vlib: add plugin override support
[vpp.git] / src / vlib / unix / main.c
old mode 100644 (file)
new mode 100755 (executable)
index 786addf..e40a462
@@ -61,39 +61,70 @@ char *vlib_default_runtime_dir = "vlib";
 
 unix_main_t unix_main;
 clib_file_main_t file_main;
-vlib_physmem_main_t physmem_main;
 
 static clib_error_t *
 unix_main_init (vlib_main_t * vm)
 {
   unix_main_t *um = &unix_main;
   um->vlib_main = vm;
-  return vlib_call_init_function (vm, unix_input_init);
+  return 0;
 }
 
-VLIB_INIT_FUNCTION (unix_main_init);
+/* *INDENT-OFF* */
+VLIB_INIT_FUNCTION (unix_main_init) =
+{
+  .runs_before = VLIB_INITS ("unix_input_init"),
+};
+/* *INDENT-ON* */
+
+static int
+unsetup_signal_handlers (int sig)
+{
+  struct sigaction sa;
+
+  sa.sa_handler = SIG_DFL;
+  sa.sa_flags = 0;
+  sigemptyset (&sa.sa_mask);
+  return sigaction (sig, &sa, 0);
+}
+
+
+/* allocate this buffer from mheap when setting up the signal handler.
+    dangerous to vec_resize it when crashing, mheap itself might have been
+    corrupted already */
+static u8 *syslog_msg = 0;
+static int last_signum = 0;
+static uword last_faulting_address = 0;
 
 static void
 unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
 {
   uword fatal = 0;
-  u8 *msg = 0;
 
-  msg = format (msg, "received signal %U, PC %U",
-               format_signal, signum, format_ucontext_pc, uc);
+  /* These come in handy when looking at core files from optimized images */
+  last_signum = signum;
+  last_faulting_address = (uword) si->si_addr;
+
+  syslog_msg = format (syslog_msg, "received signal %U, PC %U",
+                      format_signal, signum, format_ucontext_pc, uc);
 
   if (signum == SIGSEGV)
-    msg = format (msg, ", faulting address %p", si->si_addr);
+    syslog_msg = format (syslog_msg, ", faulting address %p", si->si_addr);
 
   switch (signum)
     {
       /* these (caught) signals cause the application to exit */
     case SIGTERM:
-      if (unix_main.vlib_main->main_loop_exit_set)
+      /*
+       * Ignore SIGTERM if it's sent before we're ready.
+       */
+      if (unix_main.vlib_main && unix_main.vlib_main->main_loop_exit_set)
        {
          syslog (LOG_ERR | LOG_DAEMON, "received SIGTERM, exiting...");
          unix_main.vlib_main->main_loop_exit_now = 1;
        }
+      else
+       syslog (LOG_ERR | LOG_DAEMON, "IGNORE early SIGTERM...");
       break;
       /* fall through */
     case SIGQUIT:
@@ -103,6 +134,7 @@ unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
     case SIGSEGV:
     case SIGHUP:
     case SIGFPE:
+    case SIGABRT:
       fatal = 1;
       break;
 
@@ -112,18 +144,51 @@ unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
       break;
     }
 
+#ifdef CLIB_GCOV
+  /*
+   * Test framework sends SIGTERM, so we need to flush the
+   * code coverage stats here.
+   */
+  {
+    void __gcov_flush (void);
+    __gcov_flush ();
+  }
+#endif
+
   /* Null terminate. */
-  vec_add1 (msg, 0);
+  vec_add1 (syslog_msg, 0);
 
   if (fatal)
     {
-      syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
-      os_exit (1);
+      syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
+
+      /* Address of callers: outer first, inner last. */
+      uword callers[15];
+      uword n_callers = clib_backtrace (callers, ARRAY_LEN (callers), 0);
+      int i;
+      for (i = 0; i < n_callers; i++)
+       {
+         vec_reset_length (syslog_msg);
+
+         syslog_msg =
+           format (syslog_msg, "#%-2d 0x%016lx %U%c", i, callers[i],
+                   format_clib_elf_symbol_with_address, callers[i], 0);
+
+         syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
+       }
+
+      /* have to remove SIGABRT to avoid recursive - os_exit calling abort() */
+      unsetup_signal_handlers (SIGABRT);
+
+      /* os_exit(1) causes core generation, do not do this for SIGINT */
+      if (signum == SIGINT)
+       os_exit (0);
+      else
+       os_exit (1);
     }
   else
-    clib_warning ("%s", msg);
+    clib_warning ("%s", syslog_msg);
 
-  vec_free (msg);
 }
 
 static clib_error_t *
@@ -132,16 +197,18 @@ setup_signal_handlers (unix_main_t * um)
   uword i;
   struct sigaction sa;
 
+  /* give a big enough buffer for msg, most likely it can avoid vec_resize  */
+  vec_alloc (syslog_msg, 2048);
+
   for (i = 1; i < 32; i++)
     {
-      memset (&sa, 0, sizeof (sa));
+      clib_memset (&sa, 0, sizeof (sa));
       sa.sa_sigaction = (void *) unix_signal_handler;
       sa.sa_flags = SA_SIGINFO;
 
       switch (i)
        {
          /* these signals take the default action */
-       case SIGABRT:
        case SIGKILL:
        case SIGSTOP:
        case SIGUSR1:
@@ -309,6 +376,7 @@ VLIB_REGISTER_NODE (startup_config_node,static) = {
     .function = startup_config_process,
     .type = VLIB_NODE_TYPE_PROCESS,
     .name = "startup-config-process",
+    .process_log2_n_stack_bytes = 18,
 };
 /* *INDENT-ON* */
 
@@ -344,6 +412,8 @@ unix_config (vlib_main_t * vm, unformat_input_t * input)
        um->cli_no_banner = 1;
       else if (unformat (input, "cli-no-pager"))
        um->cli_no_pager = 1;
+      else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
+       ;
       else if (unformat (input, "cli-pager-buffer-limit %d",
                         &um->cli_pager_buffer_limit))
        ;
@@ -435,6 +505,11 @@ unix_config (vlib_main_t * vm, unformat_input_t * input)
                                  vlib_default_runtime_dir, 0);
     }
 
+  /* Ensure the runtime directory is created */
+  error = vlib_unix_recursive_mkdir ((char *) um->runtime_dir);
+  if (error)
+    return error;
+
   error = setup_signal_handlers (um);
   if (error)
     return error;
@@ -515,10 +590,11 @@ unix_config (vlib_main_t * vm, unformat_input_t * input)
  *
  * @cfgcmd{runtime-dir}
  * Define directory where VPP is going to store all runtime files.
- * Default is /run/vpp.
+ * Default is /run/vpp when running as root, /run/user/<UID>/vpp if running as
+ * an unprivileged user.
  *
  * @cfgcmd{cli-listen, &lt;address:port&gt;}
- * Bind the CLI to listen at the address and port given. @clocalhost
+ * Bind the CLI to listen at the address and port given. @c localhost
  * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
  * is typical.
  *
@@ -530,7 +606,7 @@ unix_config (vlib_main_t * vm, unformat_input_t * input)
  * Configure the CLI prompt to be @c string.
  *
  * @cfgcmd{cli-history-limit, &lt;nn&gt;}
- * Limit commmand history to @c nn  lines. A value of @c 0
+ * Limit command history to @c nn  lines. A value of @c 0
  * disables command history. Default value: @c 50
  *
  * @cfgcmd{cli-no-banner}
@@ -542,6 +618,12 @@ unix_config (vlib_main_t * vm, unformat_input_t * input)
  * @cfgcmd{cli-pager-buffer-limit, &lt;nn&gt;}
  * Limit pager buffer to @c nn lines of output.
  * A value of @c 0 disables the pager. Default value: @c 100000
+ *
+ * @cfgcmd{gid, &lt;nn&gt;}
+ * Set the effective gid under which the vpp process is to run.
+ *
+ * @cfgcmd{poll-sleep-usec, &lt;nn&gt;}
+ * Set a fixed poll sleep interval between main loop polls.
 ?*/
 VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
 
@@ -574,9 +656,9 @@ thread0 (uword arg)
 u8 *
 vlib_thread_stack_init (uword thread_index)
 {
-  vec_validate (vlib_thread_stacks, thread_index);
+  ASSERT (thread_index < vec_len (vlib_thread_stacks));
   vlib_thread_stacks[thread_index] = clib_mem_alloc_aligned
-    (VLIB_THREAD_STACK_SIZE, VLIB_THREAD_STACK_SIZE);
+    (VLIB_THREAD_STACK_SIZE, clib_mem_get_page_size ());
 
   /*
    * Disallow writes to the bottom page of the stack, to
@@ -599,8 +681,12 @@ vlib_unix_main (int argc, char *argv[])
   vm->argv = (u8 **) argv;
   vm->name = argv[0];
   vm->heap_base = clib_mem_get_heap ();
+  vm->heap_aligned_base = (void *)
+    (((uword) vm->heap_base) & ~(VLIB_FRAME_ALIGN - 1));
   ASSERT (vm->heap_base);
 
+  clib_time_init (&vm->clib_time);
+
   unformat_init_command_line (&input, (char **) vm->argv);
   if ((e = vlib_plugin_config (vm, &input)))
     {
@@ -624,6 +710,10 @@ vlib_unix_main (int argc, char *argv[])
     }
   unformat_free (&input);
 
+  /* always load symbols, for signal handler and mheap memory get/put backtrace */
+  clib_elf_main_init (vm->name);
+
+  vec_validate (vlib_thread_stacks, 0);
   vlib_thread_stack_init (0);
 
   __os_thread_index = 0;