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>
44 #include <sys/ucontext.h>
46 #include <sys/types.h>
50 #include <sys/resource.h>
53 /** Default CLI pager limit is not configured in startup.conf */
54 #define UNIX_CLI_DEFAULT_PAGER_LIMIT 100000
56 /** Default CLI history depth if not configured in startup.conf */
57 #define UNIX_CLI_DEFAULT_HISTORY 50
59 char *vlib_default_runtime_dir __attribute__ ((weak));
60 char *vlib_default_runtime_dir = "vlib";
62 unix_main_t unix_main;
63 clib_file_main_t file_main;
66 unix_main_init (vlib_main_t * vm)
68 unix_main_t *um = &unix_main;
74 VLIB_INIT_FUNCTION (unix_main_init) =
76 .runs_before = VLIB_INITS ("unix_input_init"),
81 unsetup_signal_handlers (int sig)
85 sa.sa_handler = SIG_DFL;
87 sigemptyset (&sa.sa_mask);
88 return sigaction (sig, &sa, 0);
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
95 static u8 *syslog_msg = 0;
96 int vlib_last_signum = 0;
97 uword vlib_last_faulting_address = 0;
100 unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
104 /* These come in handy when looking at core files from optimized images */
105 vlib_last_signum = signum;
106 vlib_last_faulting_address = (uword) si->si_addr;
108 syslog_msg = format (syslog_msg, "received signal %U, PC %U",
109 format_signal, signum, format_ucontext_pc, uc);
111 if (signum == SIGSEGV)
112 syslog_msg = format (syslog_msg, ", faulting address %p", si->si_addr);
116 /* these (caught) signals cause the application to exit */
119 * Ignore SIGTERM if it's sent before we're ready.
121 if (unix_main.vlib_main && unix_main.vlib_main->main_loop_exit_set)
123 syslog (LOG_ERR | LOG_DAEMON, "received SIGTERM, exiting...");
124 unix_main.vlib_main->main_loop_exit_now = 1;
127 syslog (LOG_ERR | LOG_DAEMON, "IGNORE early SIGTERM...");
141 /* by default, print a message and continue */
149 * Test framework sends SIGTERM, so we need to flush the
150 * code coverage stats here.
153 void __gcov_flush (void);
158 /* Null terminate. */
159 vec_add1 (syslog_msg, 0);
163 syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
165 /* Address of callers: outer first, inner last. */
167 uword n_callers = clib_backtrace (callers, ARRAY_LEN (callers), 0);
169 for (i = 0; i < n_callers; i++)
171 vec_reset_length (syslog_msg);
174 format (syslog_msg, "#%-2d 0x%016lx %U%c", i, callers[i],
175 format_clib_elf_symbol_with_address, callers[i], 0);
177 syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
180 /* have to remove SIGABRT to avoid recursive - os_exit calling abort() */
181 unsetup_signal_handlers (SIGABRT);
183 /* os_exit(1) causes core generation, skip that for SIGINT, SIGHUP */
184 if (signum == SIGINT || signum == SIGHUP)
190 clib_warning ("%s", syslog_msg);
194 static clib_error_t *
195 setup_signal_handlers (unix_main_t * um)
200 /* give a big enough buffer for msg, most likely it can avoid vec_resize */
201 vec_alloc (syslog_msg, 2048);
203 for (i = 1; i < 32; i++)
205 clib_memset (&sa, 0, sizeof (sa));
206 sa.sa_sigaction = (void *) unix_signal_handler;
207 sa.sa_flags = SA_SIGINFO;
211 /* these signals take the default action */
220 /* ignore SIGPIPE, SIGCHLD */
223 sa.sa_sigaction = (void *) SIG_IGN;
226 /* catch and handle all other signals */
231 if (sigaction (i, &sa, 0) < 0)
232 return clib_error_return_unix (0, "sigaction %U", format_signal, i);
239 unix_error_handler (void *arg, u8 * msg, int msg_len)
241 unix_main_t *um = arg;
243 /* Echo to stderr when interactive or syslog is disabled. */
244 if (um->flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG))
246 CLIB_UNUSED (int r) = write (2, msg, msg_len);
250 char save = msg[msg_len - 1];
252 /* Null Terminate. */
253 msg[msg_len - 1] = 0;
255 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
257 msg[msg_len - 1] = save;
262 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
264 unix_main_t *um = &unix_main;
266 if (um->flags & UNIX_FLAG_INTERACTIVE || error == 0)
275 msg_len = vec_len (msg);
277 /* Null Terminate. */
278 save = msg[msg_len - 1];
279 msg[msg_len - 1] = 0;
281 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
283 msg[msg_len - 1] = save;
288 startup_config_process (vlib_main_t * vm,
289 vlib_node_runtime_t * rt, vlib_frame_t * f)
291 unix_main_t *um = &unix_main;
295 vlib_process_suspend (vm, 2.0);
297 while (um->unix_config_complete == 0)
298 vlib_process_suspend (vm, 0.1);
300 if (um->startup_config_filename)
302 unformat_input_t sub_input;
305 char *fn = (char *) um->startup_config_filename;
307 fd = open (fn, O_RDONLY);
310 clib_warning ("failed to open `%s'", fn);
314 if (fstat (fd, &s) < 0)
316 clib_warning ("failed to stat `%s'", fn);
322 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
324 clib_warning ("not a regular file: `%s'", fn);
331 vec_resize (buf, 4096);
332 n = read (fd, buf + l, 4096);
335 _vec_len (buf) = l + n;
342 if (um->log_fd && vec_len (buf))
345 lv = format (lv, "%U: ***** Startup Config *****\n%v",
346 format_timeval, 0 /* current bat-time */ ,
347 0 /* current bat-format */ ,
350 int rv __attribute__ ((unused)) =
351 write (um->log_fd, lv, vec_len (lv));
353 vec_reset_length (lv);
354 lv = format (lv, "%U: ***** End Startup Config *****\n",
355 format_timeval, 0 /* current bat-time */ ,
356 0 /* current bat-format */ );
358 int rv __attribute__ ((unused)) =
359 write (um->log_fd, lv, vec_len (lv));
366 unformat_init_vector (&sub_input, buf);
367 vlib_cli_input (vm, &sub_input, 0, 0);
368 /* frees buf for us */
369 unformat_free (&sub_input);
377 VLIB_REGISTER_NODE (startup_config_node,static) = {
378 .function = startup_config_process,
379 .type = VLIB_NODE_TYPE_PROCESS,
380 .name = "startup-config-process",
381 .process_log2_n_stack_bytes = 18,
385 static clib_error_t *
386 unix_config (vlib_main_t * vm, unformat_input_t * input)
388 vlib_global_main_t *vgm = vlib_get_global_main ();
389 unix_main_t *um = &unix_main;
390 clib_error_t *error = 0;
395 um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
396 um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
398 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
401 if (unformat (input, "interactive"))
402 um->flags |= UNIX_FLAG_INTERACTIVE;
403 else if (unformat (input, "nodaemon"))
404 um->flags |= UNIX_FLAG_NODAEMON;
405 else if (unformat (input, "nosyslog"))
406 um->flags |= UNIX_FLAG_NOSYSLOG;
407 else if (unformat (input, "nocolor"))
408 um->flags |= UNIX_FLAG_NOCOLOR;
409 else if (unformat (input, "nobanner"))
410 um->flags |= UNIX_FLAG_NOBANNER;
411 else if (unformat (input, "cli-prompt %s", &cli_prompt))
412 vlib_unix_cli_set_prompt (cli_prompt);
414 if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
416 else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
418 else if (unformat (input, "cli-line-mode"))
419 um->cli_line_mode = 1;
420 else if (unformat (input, "cli-no-banner"))
421 um->cli_no_banner = 1;
422 else if (unformat (input, "cli-no-pager"))
423 um->cli_no_pager = 1;
424 else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
426 else if (unformat (input, "cli-pager-buffer-limit %d",
427 &um->cli_pager_buffer_limit))
430 if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
432 else if (unformat (input, "coredump-size"))
434 uword coredump_size = 0;
435 if (unformat (input, "unlimited"))
437 coredump_size = RLIM_INFINITY;
440 if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
442 return clib_error_return (0,
443 "invalid coredump-size parameter `%U'",
444 format_unformat_error, input);
446 const struct rlimit new_limit = { coredump_size, coredump_size };
447 if (0 != setrlimit (RLIMIT_CORE, &new_limit))
449 clib_unix_warning ("prlimit() failed");
452 else if (unformat (input, "full-coredump"))
456 fd = open ("/proc/self/coredump_filter", O_WRONLY);
459 if (write (fd, "0x6f\n", 5) != 5)
460 clib_unix_warning ("coredump filter write failed!");
464 clib_unix_warning ("couldn't open /proc/self/coredump_filter");
466 else if (unformat (input, "startup-config %s",
467 &um->startup_config_filename))
469 else if (unformat (input, "exec %s", &um->startup_config_filename))
471 else if (unformat (input, "log %s", &um->log_filename))
473 um->log_fd = open ((char *) um->log_filename,
474 O_CREAT | O_WRONLY | O_APPEND, 0644);
477 clib_warning ("couldn't open log '%s'\n", um->log_filename);
483 lv = format (0, "%U: ***** Start: PID %d *****\n",
484 format_timeval, 0 /* current bat-time */ ,
485 0 /* current bat-format */ ,
488 int rv __attribute__ ((unused)) =
489 write (um->log_fd, lv, vec_len (lv));
494 else if (unformat (input, "gid %U", unformat_unix_gid, &gid))
496 if (setegid (gid) == -1)
497 return clib_error_return_unix (0, "setegid");
499 else if (unformat (input, "pidfile %s", &um->pidfile))
502 return clib_error_return (0, "unknown input `%U'",
503 format_unformat_error, input);
506 if (um->runtime_dir == 0)
508 uid_t uid = geteuid ();
510 um->runtime_dir = format (0, "/run/%s%c",
511 vlib_default_runtime_dir, 0);
513 um->runtime_dir = format (0, "/run/user/%u/%s%c", uid,
514 vlib_default_runtime_dir, 0);
517 /* Ensure the runtime directory is created */
518 error = vlib_unix_recursive_mkdir ((char *) um->runtime_dir);
522 error = setup_signal_handlers (um);
528 if ((error = vlib_unix_validate_runtime_file (um,
529 (char *) um->pidfile,
533 if (((pidfd = open ((char *) um->pidfile,
534 O_CREAT | O_WRONLY | O_TRUNC, 0644)) < 0))
536 return clib_error_return_unix (0, "open");
540 if (!(um->flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG)))
542 openlog (vgm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
543 clib_error_register_handler (unix_error_handler, um);
545 if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
546 /* stdin/stdout/stderr -> /dev/null */
548 clib_error_return (0, "daemon () fails");
553 u8 *lv = format (0, "%d", getpid ());
554 if (write (pidfd, (char *) lv, vec_len (lv)) != vec_len (lv))
558 return clib_error_return_unix (0, "write");
564 um->unix_config_complete = 1;
569 /* unix { ... } configuration. */
572 * @cfgcmd{interactive}
573 * Attach CLI to stdin/out and provide a debugging command line interface.
574 * Implies @c nodaemon.
577 * Do not fork or background the VPP process. Typically used when invoking
578 * VPP applications from a process monitor.
581 * Do not send e.g. clib_warning(...) output to syslog. Used
582 * when invoking VPP applications from a process monitor which
583 * pipe stdout/stderr to a dedicated logger service.
586 * Do not use colors in outputs.
589 * Do not display startup banner.
591 * @cfgcmd{exec, <filename>}
592 * @par <code>startup-config <filename></code>
593 * Read startup operational configuration from @c filename.
594 * The contents of the file will be performed as though entered at the CLI.
595 * The two keywords are aliases for the same function; if both are specified,
596 * only the last will have an effect.
598 * @cfgcmd{log, <filename>}
599 * Logs the startup configuration and all subsequent CLI commands in
601 * Very useful in situations where folks don't remember or can't be bothered
602 * to include CLI commands in bug reports.
604 * @cfgcmd{pidfile, <filename>}
605 * Writes the pid of the main thread in @c filename.
607 * @cfgcmd{full-coredump}
608 * Ask the Linux kernel to dump all memory-mapped address regions, instead
609 * of just text+data+bss.
611 * @cfgcmd{runtime-dir}
612 * Define directory where VPP is going to store all runtime files.
613 * Default is /run/vpp when running as root, /run/user/<UID>/vpp if running as
614 * an unprivileged user.
616 * @cfgcmd{cli-listen, <address:port>}
617 * Bind the CLI to listen at the address and port given. @c localhost
618 * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
621 * @cfgcmd{cli-line-mode}
622 * Disable character-by-character I/O on stdin. Useful when combined with,
623 * for example, <tt>emacs M-x gud-gdb</tt>.
625 * @cfgcmd{cli-prompt, <string>}
626 * Configure the CLI prompt to be @c string.
628 * @cfgcmd{cli-history-limit, <nn>}
629 * Limit command history to @c nn lines. A value of @c 0
630 * disables command history. Default value: @c 50
632 * @cfgcmd{cli-no-banner}
633 * Disable the login banner on stdin and Telnet connections.
635 * @cfgcmd{cli-no-pager}
636 * Disable the output pager.
638 * @cfgcmd{cli-pager-buffer-limit, <nn>}
639 * Limit pager buffer to @c nn lines of output.
640 * A value of @c 0 disables the pager. Default value: @c 100000
642 * @cfgcmd{gid, <nn>}
643 * Set the effective gid under which the vpp process is to run.
645 * @cfgcmd{poll-sleep-usec, <nn>}
646 * Set a fixed poll sleep interval between main loop polls.
648 VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
650 static clib_error_t *
651 unix_exit (vlib_main_t * vm)
653 /* Close syslog connection. */
658 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
660 u8 **vlib_thread_stacks;
665 vlib_main_t *vm = (vlib_main_t *) arg;
666 unformat_input_t input;
669 vlib_process_finish_switch_stack (vm);
671 unformat_init_command_line (&input, (char **) vm->argv);
672 i = vlib_main (vm, &input);
673 unformat_free (&input);
679 vlib_thread_stack_init (uword thread_index)
682 ASSERT (thread_index < vec_len (vlib_thread_stacks));
683 stack = clib_mem_vm_map_stack (VLIB_THREAD_STACK_SIZE,
684 CLIB_MEM_PAGE_SZ_DEFAULT,
685 "thread stack: thread %u", thread_index);
687 if (stack == CLIB_MEM_VM_MAP_FAILED)
688 clib_panic ("failed to allocate thread %u stack", thread_index);
690 vlib_thread_stacks[thread_index] = stack;
695 vlib_unix_main (int argc, char *argv[])
697 vlib_global_main_t *vgm = vlib_get_global_main ();
698 vlib_main_t *vm = vlib_get_first_main (); /* one and only time for this! */
699 unformat_input_t input;
703 vec_validate_aligned (vgm->vlib_mains, 0, CLIB_CACHE_LINE_BYTES);
705 vm->argv = (u8 **) argv;
707 vm->heap_base = clib_mem_get_heap ();
708 vm->heap_aligned_base =
709 (void *) (((uword) vm->heap_base) & ~(CLIB_CACHE_LINE_BYTES - 1));
710 ASSERT (vm->heap_base);
712 clib_time_init (&vm->clib_time);
714 /* Turn on the event logger at the first possible moment */
715 vgm->configured_elog_ring_size = 128 << 10;
716 elog_init (vlib_get_elog_main (), vgm->configured_elog_ring_size);
717 elog_enable_disable (vlib_get_elog_main (), 1);
719 unformat_init_command_line (&input, (char **) vm->argv);
720 if ((e = vlib_plugin_config (vm, &input)))
722 clib_error_report (e);
725 unformat_free (&input);
727 i = vlib_plugin_early_init (vm);
731 unformat_init_command_line (&input, (char **) vm->argv);
732 if (vgm->init_functions_called == 0)
733 vgm->init_functions_called = hash_create (0, /* value bytes */ 0);
734 e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
737 clib_error_report (e);
740 unformat_free (&input);
742 /* always load symbols, for signal handler and mheap memory get/put backtrace */
743 clib_elf_main_init (vgm->name);
745 vec_validate (vlib_thread_stacks, 0);
746 vlib_thread_stack_init (0);
748 __os_thread_index = 0;
749 vm->thread_index = 0;
751 vlib_process_start_switch_stack (vm, 0);
752 i = clib_calljmp (thread0, (uword) vm,
753 (void *) (vlib_thread_stacks[0] +
754 VLIB_THREAD_STACK_SIZE));
759 * fd.io coding-style-patch-verification: ON
762 * eval: (c-set-style "gnu")