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