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, 0 /* current bat-time */ ,
331 0 /* current bat-format */ ,
334 int rv __attribute__ ((unused)) =
335 write (um->log_fd, lv, vec_len (lv));
337 vec_reset_length (lv);
338 lv = format (lv, "%U: ***** End Startup Config *****\n",
339 format_timeval, 0 /* current bat-time */ ,
340 0 /* current bat-format */ );
342 int rv __attribute__ ((unused)) =
343 write (um->log_fd, lv, vec_len (lv));
351 unformat_init_vector (&sub_input, buf);
353 while (unformat_user (&sub_input, unformat_vlib_cli_line, &in))
355 if (vlib_cli_input (vm, &in, 0, 0) != 0)
357 /* cli failed - stop */
364 /* frees buf for us */
365 unformat_free (&sub_input);
373 VLIB_REGISTER_NODE (startup_config_node,static) = {
374 .function = startup_config_process,
375 .type = VLIB_NODE_TYPE_PROCESS,
376 .name = "startup-config-process",
377 .process_log2_n_stack_bytes = 18,
381 static clib_error_t *
382 unix_config (vlib_main_t * vm, unformat_input_t * input)
384 vlib_global_main_t *vgm = vlib_get_global_main ();
385 unix_main_t *um = &unix_main;
386 clib_error_t *error = 0;
391 um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
392 um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
394 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
397 if (unformat (input, "interactive"))
398 um->flags |= UNIX_FLAG_INTERACTIVE;
399 else if (unformat (input, "nodaemon"))
400 um->flags |= UNIX_FLAG_NODAEMON;
401 else if (unformat (input, "nosyslog"))
402 um->flags |= UNIX_FLAG_NOSYSLOG;
403 else if (unformat (input, "nocolor"))
404 um->flags |= UNIX_FLAG_NOCOLOR;
405 else if (unformat (input, "nobanner"))
406 um->flags |= UNIX_FLAG_NOBANNER;
407 else if (unformat (input, "cli-prompt %s", &cli_prompt))
408 vlib_unix_cli_set_prompt (cli_prompt);
410 if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
412 else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
414 else if (unformat (input, "cli-line-mode"))
415 um->cli_line_mode = 1;
416 else if (unformat (input, "cli-no-banner"))
417 um->cli_no_banner = 1;
418 else if (unformat (input, "cli-no-pager"))
419 um->cli_no_pager = 1;
420 else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
422 else if (unformat (input, "cli-pager-buffer-limit %d",
423 &um->cli_pager_buffer_limit))
426 if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
428 else if (unformat (input, "coredump-size"))
430 uword coredump_size = 0;
431 if (unformat (input, "unlimited"))
433 coredump_size = RLIM_INFINITY;
436 if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
438 return clib_error_return (0,
439 "invalid coredump-size parameter `%U'",
440 format_unformat_error, input);
442 const struct rlimit new_limit = { coredump_size, coredump_size };
443 if (0 != setrlimit (RLIMIT_CORE, &new_limit))
445 clib_unix_warning ("prlimit() failed");
448 else if (unformat (input, "full-coredump"))
452 fd = open ("/proc/self/coredump_filter", O_WRONLY);
455 if (write (fd, "0x6f\n", 5) != 5)
456 clib_unix_warning ("coredump filter write failed!");
460 clib_unix_warning ("couldn't open /proc/self/coredump_filter");
462 else if (unformat (input, "startup-config %s",
463 &um->startup_config_filename))
465 else if (unformat (input, "exec %s", &um->startup_config_filename))
467 else if (unformat (input, "log %s", &um->log_filename))
469 um->log_fd = open ((char *) um->log_filename,
470 O_CREAT | O_WRONLY | O_APPEND, 0644);
473 clib_warning ("couldn't open log '%s'\n", um->log_filename);
479 lv = format (0, "%U: ***** Start: PID %d *****\n",
480 format_timeval, 0 /* current bat-time */ ,
481 0 /* current bat-format */ ,
484 int rv __attribute__ ((unused)) =
485 write (um->log_fd, lv, vec_len (lv));
490 else if (unformat (input, "gid %U", unformat_unix_gid, &gid))
492 if (setegid (gid) == -1)
493 return clib_error_return_unix (0, "setegid");
495 else if (unformat (input, "pidfile %s", &um->pidfile))
498 return clib_error_return (0, "unknown input `%U'",
499 format_unformat_error, input);
502 if (um->runtime_dir == 0)
504 uid_t uid = geteuid ();
506 um->runtime_dir = format (0, "/run/%s%c",
507 vlib_default_runtime_dir, 0);
509 um->runtime_dir = format (0, "/run/user/%u/%s%c", uid,
510 vlib_default_runtime_dir, 0);
513 /* Ensure the runtime directory is created */
514 error = vlib_unix_recursive_mkdir ((char *) um->runtime_dir);
518 error = setup_signal_handlers (um);
524 if ((error = vlib_unix_validate_runtime_file (um,
525 (char *) um->pidfile,
529 if (((pidfd = open ((char *) um->pidfile,
530 O_CREAT | O_WRONLY | O_TRUNC, 0644)) < 0))
532 return clib_error_return_unix (0, "open");
536 if (!(um->flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG)))
538 openlog (vgm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
539 clib_error_register_handler (unix_error_handler, um);
541 if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
542 /* stdin/stdout/stderr -> /dev/null */
544 clib_error_return (0, "daemon () fails");
549 u8 *lv = format (0, "%d", getpid ());
550 if (write (pidfd, (char *) lv, vec_len (lv)) != vec_len (lv))
554 return clib_error_return_unix (0, "write");
560 um->unix_config_complete = 1;
565 /* unix { ... } configuration. */
568 * @cfgcmd{interactive}
569 * Attach CLI to stdin/out and provide a debugging command line interface.
570 * Implies @c nodaemon.
573 * Do not fork or background the VPP process. Typically used when invoking
574 * VPP applications from a process monitor.
577 * Do not send e.g. clib_warning(...) output to syslog. Used
578 * when invoking VPP applications from a process monitor which
579 * pipe stdout/stderr to a dedicated logger service.
582 * Do not use colors in outputs.
585 * Do not display startup banner.
587 * @cfgcmd{exec, <filename>}
588 * @par <code>startup-config <filename></code>
589 * Read startup operational configuration from @c filename.
590 * The contents of the file will be performed as though entered at the CLI.
591 * The two keywords are aliases for the same function; if both are specified,
592 * only the last will have an effect.
594 * @cfgcmd{log, <filename>}
595 * Logs the startup configuration and all subsequent CLI commands in
597 * Very useful in situations where folks don't remember or can't be bothered
598 * to include CLI commands in bug reports.
600 * @cfgcmd{pidfile, <filename>}
601 * Writes the pid of the main thread in @c filename.
603 * @cfgcmd{full-coredump}
604 * Ask the Linux kernel to dump all memory-mapped address regions, instead
605 * of just text+data+bss.
607 * @cfgcmd{runtime-dir}
608 * Define directory where VPP is going to store all runtime files.
609 * Default is /run/vpp when running as root, /run/user/<UID>/vpp if running as
610 * an unprivileged user.
612 * @cfgcmd{cli-listen, <address:port>}
613 * Bind the CLI to listen at the address and port given. @c localhost
614 * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
617 * @cfgcmd{cli-line-mode}
618 * Disable character-by-character I/O on stdin. Useful when combined with,
619 * for example, <tt>emacs M-x gud-gdb</tt>.
621 * @cfgcmd{cli-prompt, <string>}
622 * Configure the CLI prompt to be @c string.
624 * @cfgcmd{cli-history-limit, <nn>}
625 * Limit command history to @c nn lines. A value of @c 0
626 * disables command history. Default value: @c 50
628 * @cfgcmd{cli-no-banner}
629 * Disable the login banner on stdin and Telnet connections.
631 * @cfgcmd{cli-no-pager}
632 * Disable the output pager.
634 * @cfgcmd{cli-pager-buffer-limit, <nn>}
635 * Limit pager buffer to @c nn lines of output.
636 * A value of @c 0 disables the pager. Default value: @c 100000
638 * @cfgcmd{gid, <nn>}
639 * Set the effective gid under which the vpp process is to run.
641 * @cfgcmd{poll-sleep-usec, <nn>}
642 * Set a fixed poll sleep interval between main loop polls.
644 VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
646 static clib_error_t *
647 unix_exit (vlib_main_t * vm)
649 /* Close syslog connection. */
654 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
656 u8 **vlib_thread_stacks;
661 vlib_main_t *vm = (vlib_main_t *) arg;
662 vlib_global_main_t *vgm = vlib_get_global_main ();
663 unformat_input_t input;
666 vlib_process_finish_switch_stack (vm);
668 unformat_init_command_line (&input, (char **) vgm->argv);
669 i = vlib_main (vm, &input);
670 unformat_free (&input);
676 vlib_thread_stack_init (uword thread_index)
679 ASSERT (thread_index < vec_len (vlib_thread_stacks));
680 stack = clib_mem_vm_map_stack (VLIB_THREAD_STACK_SIZE,
681 CLIB_MEM_PAGE_SZ_DEFAULT,
682 "thread stack: thread %u", thread_index);
684 if (stack == CLIB_MEM_VM_MAP_FAILED)
685 clib_panic ("failed to allocate thread %u stack", thread_index);
687 vlib_thread_stacks[thread_index] = stack;
692 #define PATH_MAX 4096
696 vlib_unix_main (int argc, char *argv[])
698 vlib_global_main_t *vgm = vlib_get_global_main ();
699 vlib_main_t *vm = vlib_get_first_main (); /* one and only time for this! */
700 unformat_input_t input;
702 char buffer[PATH_MAX];
705 vec_validate_aligned (vgm->vlib_mains, 0, CLIB_CACHE_LINE_BYTES);
707 if ((i = readlink ("/proc/self/exe", buffer, sizeof (buffer) - 1)) > 0)
711 vgm->exec_path = vec_new (char, i + 1);
712 clib_memcpy_fast (vgm->exec_path, buffer, i + 1);
713 for (j = i - 1; j > 0; j--)
714 if (buffer[j - 1] == '/')
716 vgm->name = vec_new (char, i - j + 1);
717 clib_memcpy_fast (vgm->name, buffer + j, i - j + 1);
720 vgm->exec_path = vgm->name = argv[0];
722 vgm->argv = (u8 **) argv;
724 clib_time_init (&vm->clib_time);
726 /* Turn on the event logger at the first possible moment */
727 vgm->configured_elog_ring_size = 128 << 10;
728 elog_init (vlib_get_elog_main (), vgm->configured_elog_ring_size);
729 elog_enable_disable (vlib_get_elog_main (), 1);
731 unformat_init_command_line (&input, (char **) vgm->argv);
732 if ((e = vlib_plugin_config (vm, &input)))
734 clib_error_report (e);
737 unformat_free (&input);
739 i = vlib_plugin_early_init (vm);
743 unformat_init_command_line (&input, (char **) vgm->argv);
744 if (vgm->init_functions_called == 0)
745 vgm->init_functions_called = hash_create (0, /* value bytes */ 0);
746 e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
749 clib_error_report (e);
752 unformat_free (&input);
754 /* always load symbols, for signal handler and mheap memory get/put backtrace */
755 clib_elf_main_init (vgm->exec_path);
757 vec_validate (vlib_thread_stacks, 0);
758 vlib_thread_stack_init (0);
760 __os_thread_index = 0;
761 vm->thread_index = 0;
763 vlib_process_start_switch_stack (vm, 0);
764 i = clib_calljmp (thread0, (uword) vm,
765 (void *) (vlib_thread_stacks[0] +
766 VLIB_THREAD_STACK_SIZE));
771 * fd.io coding-style-patch-verification: ON
774 * eval: (c-set-style "gnu")