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