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