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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * main.c: Unix main routine
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
39 #include <vlib/vlib.h>
40 #include <vlib/unix/unix.h>
41 #include <vlib/unix/plugin.h>
45 #include <sys/ucontext.h>
47 #include <sys/types.h>
51 #include <sys/resource.h>
54 /** Default CLI pager limit is not configured in startup.conf */
55 #define UNIX_CLI_DEFAULT_PAGER_LIMIT 100000
57 /** Default CLI history depth if not configured in startup.conf */
58 #define UNIX_CLI_DEFAULT_HISTORY 50
60 char *vlib_default_runtime_dir __attribute__ ((weak));
61 char *vlib_default_runtime_dir = "vlib";
63 unix_main_t unix_main;
64 clib_file_main_t file_main;
67 unix_main_init (vlib_main_t * vm)
69 unix_main_t *um = &unix_main;
75 VLIB_INIT_FUNCTION (unix_main_init) =
77 .runs_before = VLIB_INITS ("unix_input_init"),
82 unsetup_signal_handlers (int sig)
86 sa.sa_handler = SIG_DFL;
88 sigemptyset (&sa.sa_mask);
89 return sigaction (sig, &sa, 0);
93 /* allocate this buffer from mheap when setting up the signal handler.
94 dangerous to vec_resize it when crashing, mheap itself might have been
96 static u8 *syslog_msg = 0;
97 int vlib_last_signum = 0;
98 uword vlib_last_faulting_address = 0;
101 unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
105 /* These come in handy when looking at core files from optimized images */
106 vlib_last_signum = signum;
107 vlib_last_faulting_address = (uword) si->si_addr;
109 syslog_msg = format (syslog_msg, "received signal %U, PC %U",
110 format_signal, signum, format_ucontext_pc, uc);
112 if (signum == SIGSEGV)
113 syslog_msg = format (syslog_msg, ", faulting address %p", si->si_addr);
117 /* these (caught) signals cause the application to exit */
120 * Ignore SIGTERM if it's sent before we're ready.
122 if (unix_main.vlib_main && unix_main.vlib_main->main_loop_exit_set)
124 syslog (LOG_ERR | LOG_DAEMON, "received SIGTERM, exiting...");
125 unix_main.vlib_main->main_loop_exit_now = 1;
128 syslog (LOG_ERR | LOG_DAEMON, "IGNORE early SIGTERM...");
142 /* by default, print a message and continue */
150 * Test framework sends SIGTERM, so we need to flush the
151 * code coverage stats here.
154 void __gcov_flush (void);
159 /* Null terminate. */
160 vec_add1 (syslog_msg, 0);
164 syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
166 /* Address of callers: outer first, inner last. */
168 uword n_callers = clib_backtrace (callers, ARRAY_LEN (callers), 0);
170 for (i = 0; i < n_callers; i++)
172 vec_reset_length (syslog_msg);
175 format (syslog_msg, "#%-2d 0x%016lx %U%c", i, callers[i],
176 format_clib_elf_symbol_with_address, callers[i], 0);
178 syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
181 /* have to remove SIGABRT to avoid recursive - os_exit calling abort() */
182 unsetup_signal_handlers (SIGABRT);
184 /* os_exit(1) causes core generation, skip that for SIGINT, SIGHUP */
185 if (signum == SIGINT || signum == SIGHUP)
191 clib_warning ("%s", syslog_msg);
195 static clib_error_t *
196 setup_signal_handlers (unix_main_t * um)
201 /* give a big enough buffer for msg, most likely it can avoid vec_resize */
202 vec_alloc (syslog_msg, 2048);
204 for (i = 1; i < 32; i++)
206 clib_memset (&sa, 0, sizeof (sa));
207 sa.sa_sigaction = (void *) unix_signal_handler;
208 sa.sa_flags = SA_SIGINFO;
212 /* these signals take the default action */
221 /* ignore SIGPIPE, SIGCHLD */
224 sa.sa_sigaction = (void *) SIG_IGN;
227 /* catch and handle all other signals */
232 if (sigaction (i, &sa, 0) < 0)
233 return clib_error_return_unix (0, "sigaction %U", format_signal, i);
240 unix_error_handler (void *arg, u8 * msg, int msg_len)
242 unix_main_t *um = arg;
244 /* Echo to stderr when interactive or syslog is disabled. */
245 if (um->flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG))
247 CLIB_UNUSED (int r) = write (2, msg, msg_len);
251 syslog (LOG_ERR | LOG_DAEMON, "%.*s", msg_len, msg);
256 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
258 unix_main_t *um = &unix_main;
260 if (um->flags & UNIX_FLAG_INTERACTIVE || error == 0)
264 u8 *msg = error->what;
265 u32 len = vec_len (msg);
266 int msg_len = (len > INT_MAX) ? INT_MAX : len;
267 syslog (LOG_ERR | LOG_DAEMON, "%.*s", msg_len, msg);
272 startup_config_process (vlib_main_t * vm,
273 vlib_node_runtime_t * rt, vlib_frame_t * f)
275 unix_main_t *um = &unix_main;
279 vlib_process_suspend (vm, 2.0);
281 while (um->unix_config_complete == 0)
282 vlib_process_suspend (vm, 0.1);
284 if (um->startup_config_filename)
286 unformat_input_t sub_input;
289 char *fn = (char *) um->startup_config_filename;
291 fd = open (fn, O_RDONLY);
294 clib_warning ("failed to open `%s'", fn);
298 if (fstat (fd, &s) < 0)
300 clib_warning ("failed to stat `%s'", fn);
306 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
308 clib_warning ("not a regular file: `%s'", fn);
315 vec_resize (buf, 4096);
316 n = read (fd, buf + l, 4096);
319 vec_set_len (buf, l + n);
326 if (um->log_fd && vec_len (buf))
329 lv = format (lv, "%U: ***** Startup Config *****\n%v",
330 format_timeval, NULL /* current bat-format */,
331 0 /* current bat-time */, buf);
333 int rv __attribute__ ((unused)) =
334 write (um->log_fd, lv, vec_len (lv));
336 vec_reset_length (lv);
338 format (lv, "%U: ***** End Startup Config *****\n", format_timeval,
339 NULL /* current bat-format */, 0 /* current bat-time */);
341 int rv __attribute__ ((unused)) =
342 write (um->log_fd, lv, vec_len (lv));
350 unformat_init_vector (&sub_input, buf);
352 while (unformat_user (&sub_input, unformat_vlib_cli_line, &in))
354 if (vlib_cli_input (vm, &in, 0, 0) != 0)
356 /* cli failed - stop */
363 /* frees buf for us */
364 unformat_free (&sub_input);
372 VLIB_REGISTER_NODE (startup_config_node,static) = {
373 .function = startup_config_process,
374 .type = VLIB_NODE_TYPE_PROCESS,
375 .name = "startup-config-process",
376 .process_log2_n_stack_bytes = 18,
380 static clib_error_t *
381 unix_config (vlib_main_t * vm, unformat_input_t * input)
383 vlib_global_main_t *vgm = vlib_get_global_main ();
384 unix_main_t *um = &unix_main;
385 clib_error_t *error = 0;
390 um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
391 um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
393 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
396 if (unformat (input, "interactive"))
397 um->flags |= UNIX_FLAG_INTERACTIVE;
398 else if (unformat (input, "nodaemon"))
399 um->flags |= UNIX_FLAG_NODAEMON;
400 else if (unformat (input, "nosyslog"))
401 um->flags |= UNIX_FLAG_NOSYSLOG;
402 else if (unformat (input, "nocolor"))
403 um->flags |= UNIX_FLAG_NOCOLOR;
404 else if (unformat (input, "nobanner"))
405 um->flags |= UNIX_FLAG_NOBANNER;
406 else if (unformat (input, "cli-prompt %s", &cli_prompt))
407 vlib_unix_cli_set_prompt (cli_prompt);
409 if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
411 else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
413 else if (unformat (input, "cli-line-mode"))
414 um->cli_line_mode = 1;
415 else if (unformat (input, "cli-no-banner"))
416 um->cli_no_banner = 1;
417 else if (unformat (input, "cli-no-pager"))
418 um->cli_no_pager = 1;
419 else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
421 else if (unformat (input, "cli-pager-buffer-limit %d",
422 &um->cli_pager_buffer_limit))
425 if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
427 else if (unformat (input, "coredump-size"))
429 uword coredump_size = 0;
430 if (unformat (input, "unlimited"))
432 coredump_size = RLIM_INFINITY;
435 if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
437 return clib_error_return (0,
438 "invalid coredump-size parameter `%U'",
439 format_unformat_error, input);
441 const struct rlimit new_limit = { coredump_size, coredump_size };
442 if (0 != setrlimit (RLIMIT_CORE, &new_limit))
444 clib_unix_warning ("prlimit() failed");
447 else if (unformat (input, "full-coredump"))
451 fd = open ("/proc/self/coredump_filter", O_WRONLY);
454 if (write (fd, "0x6f\n", 5) != 5)
455 clib_unix_warning ("coredump filter write failed!");
459 clib_unix_warning ("couldn't open /proc/self/coredump_filter");
461 else if (unformat (input, "startup-config %s",
462 &um->startup_config_filename))
464 else if (unformat (input, "exec %s", &um->startup_config_filename))
466 else if (unformat (input, "log %s", &um->log_filename))
468 um->log_fd = open ((char *) um->log_filename,
469 O_CREAT | O_WRONLY | O_APPEND, 0644);
472 clib_warning ("couldn't open log '%s'\n", um->log_filename);
478 lv = format (0, "%U: ***** Start: PID %d *****\n",
479 format_timeval, NULL /* current bat-format */,
480 0 /* current bat-time */, getpid ());
482 int rv __attribute__ ((unused)) =
483 write (um->log_fd, lv, vec_len (lv));
488 else if (unformat (input, "gid %U", unformat_unix_gid, &gid))
490 if (setegid (gid) == -1)
491 return clib_error_return_unix (0, "setegid");
493 else if (unformat (input, "pidfile %s", &um->pidfile))
496 return clib_error_return (0, "unknown input `%U'",
497 format_unformat_error, input);
500 if (um->runtime_dir == 0)
502 uid_t uid = geteuid ();
504 um->runtime_dir = format (0, "/run/%s%c",
505 vlib_default_runtime_dir, 0);
507 um->runtime_dir = format (0, "/run/user/%u/%s%c", uid,
508 vlib_default_runtime_dir, 0);
511 /* Ensure the runtime directory is created */
512 error = vlib_unix_recursive_mkdir ((char *) um->runtime_dir);
516 error = setup_signal_handlers (um);
522 if ((error = vlib_unix_validate_runtime_file (um,
523 (char *) um->pidfile,
527 if (((pidfd = open ((char *) um->pidfile,
528 O_CREAT | O_WRONLY | O_TRUNC, 0644)) < 0))
530 return clib_error_return_unix (0, "open");
534 if (!(um->flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG)))
536 openlog (vgm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
537 clib_error_register_handler (unix_error_handler, um);
539 if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
540 /* stdin/stdout/stderr -> /dev/null */
542 clib_error_return (0, "daemon () fails");
547 u8 *lv = format (0, "%d", getpid ());
548 if (write (pidfd, (char *) lv, vec_len (lv)) != vec_len (lv))
552 return clib_error_return_unix (0, "write");
558 um->unix_config_complete = 1;
563 /* unix { ... } configuration. */
566 * @cfgcmd{interactive}
567 * Attach CLI to stdin/out and provide a debugging command line interface.
568 * Implies @c nodaemon.
571 * Do not fork or background the VPP process. Typically used when invoking
572 * VPP applications from a process monitor.
575 * Do not send e.g. clib_warning(...) output to syslog. Used
576 * when invoking VPP applications from a process monitor which
577 * pipe stdout/stderr to a dedicated logger service.
580 * Do not use colors in outputs.
583 * Do not display startup banner.
585 * @cfgcmd{exec, <filename>}
586 * @par <code>startup-config <filename></code>
587 * Read startup operational configuration from @c filename.
588 * The contents of the file will be performed as though entered at the CLI.
589 * The two keywords are aliases for the same function; if both are specified,
590 * only the last will have an effect.
592 * @cfgcmd{log, <filename>}
593 * Logs the startup configuration and all subsequent CLI commands in
595 * Very useful in situations where folks don't remember or can't be bothered
596 * to include CLI commands in bug reports.
598 * @cfgcmd{pidfile, <filename>}
599 * Writes the pid of the main thread in @c filename.
601 * @cfgcmd{full-coredump}
602 * Ask the Linux kernel to dump all memory-mapped address regions, instead
603 * of just text+data+bss.
605 * @cfgcmd{runtime-dir}
606 * Define directory where VPP is going to store all runtime files.
607 * Default is /run/vpp when running as root, /run/user/<UID>/vpp if running as
608 * an unprivileged user.
610 * @cfgcmd{cli-listen, <address:port>}
611 * Bind the CLI to listen at the address and port given. @c localhost
612 * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
615 * @cfgcmd{cli-line-mode}
616 * Disable character-by-character I/O on stdin. Useful when combined with,
617 * for example, <tt>emacs M-x gud-gdb</tt>.
619 * @cfgcmd{cli-prompt, <string>}
620 * Configure the CLI prompt to be @c string.
622 * @cfgcmd{cli-history-limit, <nn>}
623 * Limit command history to @c nn lines. A value of @c 0
624 * disables command history. Default value: @c 50
626 * @cfgcmd{cli-no-banner}
627 * Disable the login banner on stdin and Telnet connections.
629 * @cfgcmd{cli-no-pager}
630 * Disable the output pager.
632 * @cfgcmd{cli-pager-buffer-limit, <nn>}
633 * Limit pager buffer to @c nn lines of output.
634 * A value of @c 0 disables the pager. Default value: @c 100000
636 * @cfgcmd{gid, <nn>}
637 * Set the effective gid under which the vpp process is to run.
639 * @cfgcmd{poll-sleep-usec, <nn>}
640 * Set a fixed poll sleep interval between main loop polls.
642 VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
644 static clib_error_t *
645 unix_exit (vlib_main_t * vm)
647 /* Close syslog connection. */
652 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
654 u8 **vlib_thread_stacks;
659 vlib_main_t *vm = (vlib_main_t *) arg;
660 vlib_global_main_t *vgm = vlib_get_global_main ();
661 unformat_input_t input;
664 vlib_process_finish_switch_stack (vm);
666 unformat_init_command_line (&input, (char **) vgm->argv);
667 i = vlib_main (vm, &input);
668 unformat_free (&input);
674 vlib_thread_stack_init (uword thread_index)
677 ASSERT (thread_index < vec_len (vlib_thread_stacks));
678 stack = clib_mem_vm_map_stack (VLIB_THREAD_STACK_SIZE,
679 CLIB_MEM_PAGE_SZ_DEFAULT,
680 "thread stack: thread %u", thread_index);
682 if (stack == CLIB_MEM_VM_MAP_FAILED)
683 clib_panic ("failed to allocate thread %u stack", thread_index);
685 vlib_thread_stacks[thread_index] = stack;
690 #define PATH_MAX 4096
694 vlib_unix_main (int argc, char *argv[])
696 vlib_global_main_t *vgm = vlib_get_global_main ();
697 vlib_main_t *vm = vlib_get_first_main (); /* one and only time for this! */
698 unformat_input_t input;
700 char buffer[PATH_MAX];
703 vec_validate_aligned (vgm->vlib_mains, 0, CLIB_CACHE_LINE_BYTES);
705 if ((i = readlink ("/proc/self/exe", buffer, sizeof (buffer) - 1)) > 0)
709 vgm->exec_path = vec_new (char, i + 1);
710 clib_memcpy_fast (vgm->exec_path, buffer, i + 1);
711 for (j = i - 1; j > 0; j--)
712 if (buffer[j - 1] == '/')
714 vgm->name = vec_new (char, i - j + 1);
715 clib_memcpy_fast (vgm->name, buffer + j, i - j + 1);
718 vgm->exec_path = vgm->name = argv[0];
720 vgm->argv = (u8 **) argv;
722 clib_time_init (&vm->clib_time);
724 /* Turn on the event logger at the first possible moment */
725 vgm->configured_elog_ring_size = 128 << 10;
726 elog_init (vlib_get_elog_main (), vgm->configured_elog_ring_size);
727 elog_enable_disable (vlib_get_elog_main (), 1);
729 unformat_init_command_line (&input, (char **) vgm->argv);
730 if ((e = vlib_plugin_config (vm, &input)))
732 clib_error_report (e);
735 unformat_free (&input);
737 i = vlib_plugin_early_init (vm);
741 unformat_init_command_line (&input, (char **) vgm->argv);
742 if (vgm->init_functions_called == 0)
743 vgm->init_functions_called = hash_create (0, /* value bytes */ 0);
744 e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
747 clib_error_report (e);
750 unformat_free (&input);
752 /* always load symbols, for signal handler and mheap memory get/put backtrace */
753 clib_elf_main_init (vgm->exec_path);
755 vec_validate (vlib_thread_stacks, 0);
756 vlib_thread_stack_init (0);
758 __os_thread_index = 0;
759 vm->thread_index = 0;
761 vlib_process_start_switch_stack (vm, 0);
762 i = clib_calljmp (thread0, (uword) vm,
763 (void *) (vlib_thread_stacks[0] +
764 VLIB_THREAD_STACK_SIZE));
769 * fd.io coding-style-patch-verification: ON
772 * eval: (c-set-style "gnu")