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 static int last_signum = 0;
97 static uword 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 last_signum = signum;
106 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, do not do this for SIGINT */
184 if (signum == SIGINT)
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 */
219 /* ignore SIGPIPE, SIGCHLD */
222 sa.sa_sigaction = (void *) SIG_IGN;
225 /* catch and handle all other signals */
230 if (sigaction (i, &sa, 0) < 0)
231 return clib_error_return_unix (0, "sigaction %U", format_signal, i);
238 unix_error_handler (void *arg, u8 * msg, int msg_len)
240 unix_main_t *um = arg;
242 /* Echo to stderr when interactive or syslog is disabled. */
243 if (um->flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG))
245 CLIB_UNUSED (int r) = write (2, msg, msg_len);
249 char save = msg[msg_len - 1];
251 /* Null Terminate. */
252 msg[msg_len - 1] = 0;
254 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
256 msg[msg_len - 1] = save;
261 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
263 unix_main_t *um = &unix_main;
265 if (um->flags & UNIX_FLAG_INTERACTIVE || error == 0)
274 msg_len = vec_len (msg);
276 /* Null Terminate. */
277 save = msg[msg_len - 1];
278 msg[msg_len - 1] = 0;
280 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
282 msg[msg_len - 1] = save;
287 startup_config_process (vlib_main_t * vm,
288 vlib_node_runtime_t * rt, vlib_frame_t * f)
290 unix_main_t *um = &unix_main;
294 vlib_process_suspend (vm, 2.0);
296 while (um->unix_config_complete == 0)
297 vlib_process_suspend (vm, 0.1);
299 if (um->startup_config_filename)
301 unformat_input_t sub_input;
304 char *fn = (char *) um->startup_config_filename;
306 fd = open (fn, O_RDONLY);
309 clib_warning ("failed to open `%s'", fn);
313 if (fstat (fd, &s) < 0)
315 clib_warning ("failed to stat `%s'", fn);
321 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
323 clib_warning ("not a regular file: `%s'", fn);
330 vec_resize (buf, 4096);
331 n = read (fd, buf + l, 4096);
334 _vec_len (buf) = l + n;
341 if (um->log_fd && vec_len (buf))
344 lv = format (lv, "%U: ***** Startup Config *****\n%v",
345 format_timeval, 0 /* current bat-time */ ,
346 0 /* current bat-format */ ,
349 int rv __attribute__ ((unused)) =
350 write (um->log_fd, lv, vec_len (lv));
352 vec_reset_length (lv);
353 lv = format (lv, "%U: ***** End Startup Config *****\n",
354 format_timeval, 0 /* current bat-time */ ,
355 0 /* current bat-format */ );
357 int rv __attribute__ ((unused)) =
358 write (um->log_fd, lv, vec_len (lv));
365 unformat_init_vector (&sub_input, buf);
366 vlib_cli_input (vm, &sub_input, 0, 0);
367 /* frees buf for us */
368 unformat_free (&sub_input);
376 VLIB_REGISTER_NODE (startup_config_node,static) = {
377 .function = startup_config_process,
378 .type = VLIB_NODE_TYPE_PROCESS,
379 .name = "startup-config-process",
380 .process_log2_n_stack_bytes = 18,
384 static clib_error_t *
385 unix_config (vlib_main_t * vm, unformat_input_t * input)
387 unix_main_t *um = &unix_main;
388 clib_error_t *error = 0;
393 um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
394 um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
396 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
399 if (unformat (input, "interactive"))
400 um->flags |= UNIX_FLAG_INTERACTIVE;
401 else if (unformat (input, "nodaemon"))
402 um->flags |= UNIX_FLAG_NODAEMON;
403 else if (unformat (input, "nosyslog"))
404 um->flags |= UNIX_FLAG_NOSYSLOG;
405 else if (unformat (input, "cli-prompt %s", &cli_prompt))
406 vlib_unix_cli_set_prompt (cli_prompt);
408 if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
410 else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
412 else if (unformat (input, "cli-line-mode"))
413 um->cli_line_mode = 1;
414 else if (unformat (input, "cli-no-banner"))
415 um->cli_no_banner = 1;
416 else if (unformat (input, "cli-no-pager"))
417 um->cli_no_pager = 1;
418 else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
420 else if (unformat (input, "cli-pager-buffer-limit %d",
421 &um->cli_pager_buffer_limit))
424 if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
426 else if (unformat (input, "coredump-size"))
428 uword coredump_size = 0;
429 if (unformat (input, "unlimited"))
431 coredump_size = RLIM_INFINITY;
434 if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
436 return clib_error_return (0,
437 "invalid coredump-size parameter `%U'",
438 format_unformat_error, input);
440 const struct rlimit new_limit = { coredump_size, coredump_size };
441 if (0 != setrlimit (RLIMIT_CORE, &new_limit))
443 clib_unix_warning ("prlimit() failed");
446 else if (unformat (input, "full-coredump"))
450 fd = open ("/proc/self/coredump_filter", O_WRONLY);
453 if (write (fd, "0x6f\n", 5) != 5)
454 clib_unix_warning ("coredump filter write failed!");
458 clib_unix_warning ("couldn't open /proc/self/coredump_filter");
460 else if (unformat (input, "startup-config %s",
461 &um->startup_config_filename))
463 else if (unformat (input, "exec %s", &um->startup_config_filename))
465 else if (unformat (input, "log %s", &um->log_filename))
467 um->log_fd = open ((char *) um->log_filename,
468 O_CREAT | O_WRONLY | O_APPEND, 0644);
471 clib_warning ("couldn't open log '%s'\n", um->log_filename);
477 lv = format (0, "%U: ***** Start: PID %d *****\n",
478 format_timeval, 0 /* current bat-time */ ,
479 0 /* current bat-format */ ,
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 (vm->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.
579 * @cfgcmd{exec, <filename>}
580 * @par <code>startup-config <filename></code>
581 * Read startup operational configuration from @c filename.
582 * The contents of the file will be performed as though entered at the CLI.
583 * The two keywords are aliases for the same function; if both are specified,
584 * only the last will have an effect.
586 * @cfgcmd{log, <filename>}
587 * Logs the startup configuration and all subsequent CLI commands in
589 * Very useful in situations where folks don't remember or can't be bothered
590 * to include CLI commands in bug reports.
592 * @cfgcmd{pidfile, <filename>}
593 * Writes the pid of the main thread in @c filename.
595 * @cfgcmd{full-coredump}
596 * Ask the Linux kernel to dump all memory-mapped address regions, instead
597 * of just text+data+bss.
599 * @cfgcmd{runtime-dir}
600 * Define directory where VPP is going to store all runtime files.
601 * Default is /run/vpp when running as root, /run/user/<UID>/vpp if running as
602 * an unprivileged user.
604 * @cfgcmd{cli-listen, <address:port>}
605 * Bind the CLI to listen at the address and port given. @c localhost
606 * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
609 * @cfgcmd{cli-line-mode}
610 * Disable character-by-character I/O on stdin. Useful when combined with,
611 * for example, <tt>emacs M-x gud-gdb</tt>.
613 * @cfgcmd{cli-prompt, <string>}
614 * Configure the CLI prompt to be @c string.
616 * @cfgcmd{cli-history-limit, <nn>}
617 * Limit command history to @c nn lines. A value of @c 0
618 * disables command history. Default value: @c 50
620 * @cfgcmd{cli-no-banner}
621 * Disable the login banner on stdin and Telnet connections.
623 * @cfgcmd{cli-no-pager}
624 * Disable the output pager.
626 * @cfgcmd{cli-pager-buffer-limit, <nn>}
627 * Limit pager buffer to @c nn lines of output.
628 * A value of @c 0 disables the pager. Default value: @c 100000
630 * @cfgcmd{gid, <nn>}
631 * Set the effective gid under which the vpp process is to run.
633 * @cfgcmd{poll-sleep-usec, <nn>}
634 * Set a fixed poll sleep interval between main loop polls.
636 VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
638 static clib_error_t *
639 unix_exit (vlib_main_t * vm)
641 /* Close syslog connection. */
646 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
648 u8 **vlib_thread_stacks;
653 vlib_main_t *vm = (vlib_main_t *) arg;
654 unformat_input_t input;
657 vlib_process_finish_switch_stack (vm);
659 unformat_init_command_line (&input, (char **) vm->argv);
660 i = vlib_main (vm, &input);
661 unformat_free (&input);
667 vlib_thread_stack_init (uword thread_index)
669 ASSERT (thread_index < vec_len (vlib_thread_stacks));
670 vlib_thread_stacks[thread_index] = clib_mem_alloc_aligned
671 (VLIB_THREAD_STACK_SIZE, clib_mem_get_page_size ());
674 * Disallow writes to the bottom page of the stack, to
675 * catch stack overflows.
677 if (mprotect (vlib_thread_stacks[thread_index],
678 clib_mem_get_page_size (), PROT_READ) < 0)
679 clib_unix_warning ("thread stack");
680 return vlib_thread_stacks[thread_index];
684 vlib_unix_main (int argc, char *argv[])
686 vlib_main_t *vm = &vlib_global_main; /* one and only time for this! */
687 unformat_input_t input;
691 vm->argv = (u8 **) argv;
693 vm->heap_base = clib_mem_get_heap ();
694 vm->heap_aligned_base = (void *)
695 (((uword) vm->heap_base) & ~(VLIB_FRAME_ALIGN - 1));
696 ASSERT (vm->heap_base);
698 clib_time_init (&vm->clib_time);
700 unformat_init_command_line (&input, (char **) vm->argv);
701 if ((e = vlib_plugin_config (vm, &input)))
703 clib_error_report (e);
706 unformat_free (&input);
708 i = vlib_plugin_early_init (vm);
712 unformat_init_command_line (&input, (char **) vm->argv);
713 if (vm->init_functions_called == 0)
714 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
715 e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
718 clib_error_report (e);
721 unformat_free (&input);
723 /* always load symbols, for signal handler and mheap memory get/put backtrace */
724 clib_elf_main_init (vm->name);
726 vec_validate (vlib_thread_stacks, 0);
727 vlib_thread_stack_init (0);
729 __os_thread_index = 0;
730 vm->thread_index = 0;
732 vlib_process_start_switch_stack (vm, 0);
733 i = clib_calljmp (thread0, (uword) vm,
734 (void *) (vlib_thread_stacks[0] +
735 VLIB_THREAD_STACK_SIZE));
740 * fd.io coding-style-patch-verification: ON
743 * eval: (c-set-style "gnu")