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>
42 #include <vppinfra/unix.h>
43 #include <vppinfra/stack.h>
44 #include <vppinfra/format_ansi.h>
48 #include <sys/ucontext.h>
50 #include <sys/types.h>
54 #include <sys/resource.h>
57 /** Default CLI pager limit is not configured in startup.conf */
58 #define UNIX_CLI_DEFAULT_PAGER_LIMIT 100000
60 /** Default CLI history depth if not configured in startup.conf */
61 #define UNIX_CLI_DEFAULT_HISTORY 50
63 char *vlib_default_runtime_dir __attribute__ ((weak));
64 char *vlib_default_runtime_dir = "vlib";
66 unix_main_t unix_main;
67 clib_file_main_t file_main;
70 unix_main_init (vlib_main_t * vm)
72 unix_main_t *um = &unix_main;
77 VLIB_INIT_FUNCTION (unix_main_init) =
79 .runs_before = VLIB_INITS ("unix_input_init"),
83 unsetup_signal_handlers (int sig)
87 sa.sa_handler = SIG_DFL;
89 sigemptyset (&sa.sa_mask);
90 return sigaction (sig, &sa, 0);
94 /* allocate this buffer from mheap when setting up the signal handler.
95 dangerous to vec_resize it when crashing, mheap itself might have been
97 static u8 *syslog_msg = 0;
98 int vlib_last_signum = 0;
99 uword vlib_last_faulting_address = 0;
104 vec_terminate_c_string (syslog_msg);
105 if (unix_main.flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG))
106 fprintf (stderr, "%s\n", syslog_msg);
108 syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
109 vec_reset_length (syslog_msg);
113 unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
117 (unix_main.flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG)) &&
118 (unix_main.flags & UNIX_FLAG_NOCOLOR) == 0;
120 /* These come in handy when looking at core files from optimized images */
121 vlib_last_signum = signum;
122 vlib_last_faulting_address = (uword) si->si_addr;
125 syslog_msg = format (syslog_msg, ANSI_FG_BR_RED);
127 syslog_msg = format (syslog_msg, "received signal %U, PC %U",
128 format_signal, signum, format_ucontext_pc, uc);
130 if (signum == SIGSEGV || signum == SIGBUS)
131 syslog_msg = format (syslog_msg, ", faulting address %p", si->si_addr);
134 syslog_msg = format (syslog_msg, ANSI_FG_DEFAULT);
140 /* these (caught) signals cause the application to exit */
143 * Ignore SIGTERM if it's sent before we're ready.
145 if (unix_main.vlib_main && unix_main.vlib_main->main_loop_exit_set)
147 syslog_msg = format (
148 syslog_msg, "received SIGTERM from PID %d UID %d, exiting...",
149 si->si_pid, si->si_uid);
151 unix_main.vlib_main->main_loop_exit_now = 1;
155 syslog_msg = format (syslog_msg, "IGNORE early SIGTERM...");
171 /* by default, print a message and continue */
180 int skip = 1, index = 0;
182 foreach_clib_stack_frame (sf)
184 if (sf->is_signal_frame)
187 const int n_bytes = 20;
188 u8 *ip = (void *) sf->ip;
190 if (pipe (pipefd) == 0)
192 /* check PC points to valid memory */
193 if (write (pipefd[1], ip, n_bytes) == n_bytes)
195 syslog_msg = format (syslog_msg, "Code: ");
197 syslog_msg = format (syslog_msg, ANSI_FG_CYAN);
198 for (int i = 0; i < n_bytes; i++)
199 syslog_msg = format (syslog_msg, " %02x", ip[i]);
201 syslog_msg = format (syslog_msg, ANSI_FG_DEFAULT);
205 syslog_msg = format (
206 syslog_msg, "PC contains invalid memory address");
209 foreach_int (i, 0, 1)
218 syslog_msg = format (syslog_msg, "#%-2d ", index++);
220 syslog_msg = format (syslog_msg, ANSI_FG_BLUE);
221 syslog_msg = format (syslog_msg, "0x%016lx", sf->ip);
223 syslog_msg = format (syslog_msg, ANSI_FG_DEFAULT);
228 syslog_msg = format (syslog_msg, ANSI_FG_YELLOW);
230 format (syslog_msg, " %s + 0x%x", sf->name, sf->offset);
232 syslog_msg = format (syslog_msg, ANSI_FG_DEFAULT);
240 syslog_msg = format (syslog_msg, ANSI_FG_GREEN);
241 syslog_msg = format (syslog_msg, " from %s", sf->file_name);
243 syslog_msg = format (syslog_msg, ANSI_FG_DEFAULT);
248 /* have to remove SIGABRT to avoid recursive - os_exit calling abort() */
249 unsetup_signal_handlers (SIGABRT);
251 /* os_exit(1) causes core generation, skip that for SIGINT, SIGHUP */
252 if (signum == SIGINT || signum == SIGHUP)
259 static clib_error_t *
260 setup_signal_handlers (unix_main_t * um)
265 /* give a big enough buffer for msg, most likely it can avoid vec_resize */
266 vec_alloc (syslog_msg, 2048);
268 for (i = 1; i < 32; i++)
270 clib_memset (&sa, 0, sizeof (sa));
271 sa.sa_sigaction = (void *) unix_signal_handler;
272 sa.sa_flags = SA_SIGINFO;
276 /* these signals take the default action */
285 /* ignore SIGPIPE, SIGCHLD */
288 sa.sa_sigaction = (void *) SIG_IGN;
291 /* catch and handle all other signals */
296 if (sigaction (i, &sa, 0) < 0)
297 return clib_error_return_unix (0, "sigaction %U", format_signal, i);
304 unix_error_handler (void *arg, u8 * msg, int msg_len)
306 unix_main_t *um = arg;
308 /* Echo to stderr when interactive or syslog is disabled. */
309 if (um->flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG))
311 CLIB_UNUSED (int r) = write (2, msg, msg_len);
315 syslog (LOG_ERR | LOG_DAEMON, "%.*s", msg_len, msg);
320 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
322 unix_main_t *um = &unix_main;
324 if (um->flags & UNIX_FLAG_INTERACTIVE || error == 0)
328 u8 *msg = error->what;
329 u32 len = vec_len (msg);
330 int msg_len = (len > INT_MAX) ? INT_MAX : len;
331 syslog (LOG_ERR | LOG_DAEMON, "%.*s", msg_len, msg);
336 startup_config_process (vlib_main_t * vm,
337 vlib_node_runtime_t * rt, vlib_frame_t * f)
339 unix_main_t *um = &unix_main;
342 vlib_process_suspend (vm, 2.0);
344 while (um->unix_config_complete == 0)
345 vlib_process_suspend (vm, 0.1);
347 if (!um->startup_config_filename)
352 unformat_init_vector (&in,
353 format (0, "exec %s", um->startup_config_filename));
355 vlib_cli_input (vm, &in, 0, 0);
362 VLIB_REGISTER_NODE (startup_config_node,static) = {
363 .function = startup_config_process,
364 .type = VLIB_NODE_TYPE_PROCESS,
365 .name = "startup-config-process",
366 .process_log2_n_stack_bytes = 18,
369 static clib_error_t *
370 unix_config (vlib_main_t * vm, unformat_input_t * input)
372 vlib_global_main_t *vgm = vlib_get_global_main ();
373 unix_main_t *um = &unix_main;
374 clib_error_t *error = 0;
379 um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
380 um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
382 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
385 if (unformat (input, "interactive"))
386 um->flags |= UNIX_FLAG_INTERACTIVE;
387 else if (unformat (input, "nodaemon"))
388 um->flags |= UNIX_FLAG_NODAEMON;
389 else if (unformat (input, "nosyslog"))
390 um->flags |= UNIX_FLAG_NOSYSLOG;
391 else if (unformat (input, "nocolor"))
392 um->flags |= UNIX_FLAG_NOCOLOR;
393 else if (unformat (input, "nobanner"))
394 um->flags |= UNIX_FLAG_NOBANNER;
395 else if (unformat (input, "cli-prompt %s", &cli_prompt))
396 vlib_unix_cli_set_prompt (cli_prompt);
398 if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
400 else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
402 else if (unformat (input, "cli-line-mode"))
403 um->cli_line_mode = 1;
404 else if (unformat (input, "cli-no-banner"))
405 um->cli_no_banner = 1;
406 else if (unformat (input, "cli-no-pager"))
407 um->cli_no_pager = 1;
408 else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
410 else if (unformat (input, "cli-pager-buffer-limit %d",
411 &um->cli_pager_buffer_limit))
414 if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
416 else if (unformat (input, "coredump-size"))
418 uword coredump_size = 0;
419 if (unformat (input, "unlimited"))
421 coredump_size = RLIM_INFINITY;
424 if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
426 return clib_error_return (0,
427 "invalid coredump-size parameter `%U'",
428 format_unformat_error, input);
430 const struct rlimit new_limit = { coredump_size, coredump_size };
431 if (0 != setrlimit (RLIMIT_CORE, &new_limit))
433 clib_unix_warning ("prlimit() failed");
436 else if (unformat (input, "full-coredump"))
440 fd = open ("/proc/self/coredump_filter", O_WRONLY);
443 if (write (fd, "0x6f\n", 5) != 5)
444 clib_unix_warning ("coredump filter write failed!");
448 clib_unix_warning ("couldn't open /proc/self/coredump_filter");
450 else if (unformat (input, "startup-config %s",
451 &um->startup_config_filename))
453 else if (unformat (input, "exec %s", &um->startup_config_filename))
455 else if (unformat (input, "log %s", &um->log_filename))
457 um->log_fd = open ((char *) um->log_filename,
458 O_CREAT | O_WRONLY | O_APPEND, 0644);
461 clib_warning ("couldn't open log '%s'\n", um->log_filename);
467 lv = format (0, "%U: ***** Start: PID %d *****\n",
468 format_timeval, NULL /* current bat-format */,
469 0 /* current bat-time */, getpid ());
471 int rv __attribute__ ((unused)) =
472 write (um->log_fd, lv, vec_len (lv));
477 else if (unformat (input, "gid %U", unformat_unix_gid, &gid))
479 if (setegid (gid) == -1)
480 return clib_error_return_unix (0, "setegid");
482 else if (unformat (input, "pidfile %s", &um->pidfile))
485 return clib_error_return (0, "unknown input `%U'",
486 format_unformat_error, input);
489 if (um->runtime_dir == 0)
491 uid_t uid = geteuid ();
493 um->runtime_dir = format (0, "/run/%s%c",
494 vlib_default_runtime_dir, 0);
496 um->runtime_dir = format (0, "/run/user/%u/%s%c", uid,
497 vlib_default_runtime_dir, 0);
500 /* Ensure the runtime directory is created */
501 error = vlib_unix_recursive_mkdir ((char *) um->runtime_dir);
505 if (chdir ((char *) um->runtime_dir) < 0)
506 return clib_error_return_unix (0, "chdir('%s')", um->runtime_dir);
508 error = setup_signal_handlers (um);
514 if ((error = vlib_unix_validate_runtime_file (um,
515 (char *) um->pidfile,
519 if (((pidfd = open ((char *) um->pidfile,
520 O_CREAT | O_WRONLY | O_TRUNC, 0644)) < 0))
522 return clib_error_return_unix (0, "open");
526 if (!(um->flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG)))
528 openlog (vgm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
529 clib_error_register_handler (unix_error_handler, um);
531 if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
532 /* stdin/stdout/stderr -> /dev/null */
534 clib_error_return (0, "daemon () fails");
539 u8 *lv = format (0, "%d", getpid ());
540 if (write (pidfd, (char *) lv, vec_len (lv)) != vec_len (lv))
544 return clib_error_return_unix (0, "write");
550 um->unix_config_complete = 1;
555 /* unix { ... } configuration. */
558 * @cfgcmd{interactive}
559 * Attach CLI to stdin/out and provide a debugging command line interface.
560 * Implies @c nodaemon.
563 * Do not fork or background the VPP process. Typically used when invoking
564 * VPP applications from a process monitor.
567 * Do not send e.g. clib_warning(...) output to syslog. Used
568 * when invoking VPP applications from a process monitor which
569 * pipe stdout/stderr to a dedicated logger service.
572 * Do not use colors in outputs.
575 * Do not display startup banner.
577 * @cfgcmd{exec, <filename>}
578 * @par <code>startup-config <filename></code>
579 * Read startup operational configuration from @c filename.
580 * The contents of the file will be performed as though entered at the CLI.
581 * The two keywords are aliases for the same function; if both are specified,
582 * only the last will have an effect.
584 * @cfgcmd{log, <filename>}
585 * Logs the startup configuration and all subsequent CLI commands in
587 * Very useful in situations where folks don't remember or can't be bothered
588 * to include CLI commands in bug reports.
590 * @cfgcmd{pidfile, <filename>}
591 * Writes the pid of the main thread in @c filename.
593 * @cfgcmd{full-coredump}
594 * Ask the Linux kernel to dump all memory-mapped address regions, instead
595 * of just text+data+bss.
597 * @cfgcmd{runtime-dir}
598 * Define directory where VPP is going to store all runtime files.
599 * Default is /run/vpp when running as root, /run/user/<UID>/vpp if running as
600 * an unprivileged user.
602 * @cfgcmd{cli-listen, <address:port>}
603 * Bind the CLI to listen at the address and port given. @c localhost
604 * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
607 * @cfgcmd{cli-line-mode}
608 * Disable character-by-character I/O on stdin. Useful when combined with,
609 * for example, <tt>emacs M-x gud-gdb</tt>.
611 * @cfgcmd{cli-prompt, <string>}
612 * Configure the CLI prompt to be @c string.
614 * @cfgcmd{cli-history-limit, <nn>}
615 * Limit command history to @c nn lines. A value of @c 0
616 * disables command history. Default value: @c 50
618 * @cfgcmd{cli-no-banner}
619 * Disable the login banner on stdin and Telnet connections.
621 * @cfgcmd{cli-no-pager}
622 * Disable the output pager.
624 * @cfgcmd{cli-pager-buffer-limit, <nn>}
625 * Limit pager buffer to @c nn lines of output.
626 * A value of @c 0 disables the pager. Default value: @c 100000
628 * @cfgcmd{gid, <nn>}
629 * Set the effective gid under which the vpp process is to run.
631 * @cfgcmd{poll-sleep-usec, <nn>}
632 * Set a fixed poll sleep interval between main loop polls.
634 VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
636 static clib_error_t *
637 unix_exit (vlib_main_t * vm)
639 /* Close syslog connection. */
644 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
646 u8 **vlib_thread_stacks;
651 vlib_main_t *vm = (vlib_main_t *) arg;
652 vlib_global_main_t *vgm = vlib_get_global_main ();
653 unformat_input_t input;
656 vlib_process_finish_switch_stack (vm);
658 unformat_init_command_line (&input, (char **) vgm->argv);
659 i = vlib_main (vm, &input);
660 unformat_free (&input);
666 vlib_thread_stack_init (uword thread_index)
669 ASSERT (thread_index < vec_len (vlib_thread_stacks));
670 stack = clib_mem_vm_map_stack (VLIB_THREAD_STACK_SIZE,
671 CLIB_MEM_PAGE_SZ_DEFAULT,
672 "thread stack: thread %u", thread_index);
674 if (stack == CLIB_MEM_VM_MAP_FAILED)
675 clib_panic ("failed to allocate thread %u stack", thread_index);
677 vlib_thread_stacks[thread_index] = stack;
682 #define PATH_MAX 4096
686 vlib_unix_main (int argc, char *argv[])
688 vlib_global_main_t *vgm = vlib_get_global_main ();
689 vlib_main_t *vm = vlib_get_first_main (); /* one and only time for this! */
690 unformat_input_t input;
694 vec_validate_aligned (vgm->vlib_mains, 0, CLIB_CACHE_LINE_BYTES);
696 vgm->exec_path = (char *) os_get_exec_path ();
700 for (i = vec_len (vgm->exec_path) - 1; i > 0; i--)
701 if (vgm->exec_path[i - 1] == '/')
706 vec_add (vgm->name, vgm->exec_path + i, vec_len (vgm->exec_path) - i);
707 vec_add1 (vgm->exec_path, 0);
708 vec_add1 (vgm->name, 0);
711 vgm->exec_path = vgm->name = argv[0];
713 vgm->argv = (u8 **) argv;
715 clib_time_init (&vm->clib_time);
717 /* Turn on the event logger at the first possible moment */
718 vgm->configured_elog_ring_size = 128 << 10;
719 elog_init (vlib_get_elog_main (), vgm->configured_elog_ring_size);
720 elog_enable_disable (vlib_get_elog_main (), 1);
722 unformat_init_command_line (&input, (char **) vgm->argv);
723 if ((e = vlib_plugin_config (vm, &input)))
725 clib_error_report (e);
728 unformat_free (&input);
730 i = vlib_plugin_early_init (vm);
734 unformat_init_command_line (&input, (char **) vgm->argv);
735 if (vgm->init_functions_called == 0)
736 vgm->init_functions_called = hash_create (0, /* value bytes */ 0);
737 e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
740 clib_error_report (e);
743 unformat_free (&input);
745 /* always load symbols, for signal handler and mheap memory get/put backtrace */
746 clib_elf_main_init (vgm->exec_path);
748 vec_validate (vlib_thread_stacks, 0);
749 vlib_thread_stack_init (0);
751 __os_thread_index = 0;
752 vm->thread_index = 0;
754 vlib_process_start_switch_stack (vm, 0);
755 i = clib_calljmp (thread0, (uword) vm,
756 (void *) (vlib_thread_stacks[0] +
757 VLIB_THREAD_STACK_SIZE));
762 * fd.io coding-style-patch-verification: ON
765 * eval: (c-set-style "gnu")