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