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