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