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