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;
70 return vlib_call_init_function (vm, unix_input_init);
73 VLIB_INIT_FUNCTION (unix_main_init);
76 unsetup_signal_handlers (int sig)
80 sa.sa_handler = SIG_DFL;
82 sigemptyset (&sa.sa_mask);
83 return sigaction (sig, &sa, 0);
87 /* allocate this buffer from mheap when setting up the signal handler.
88 dangerous to vec_resize it when crashing, mheap itself might have been
90 static u8 *syslog_msg = 0;
93 unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
97 syslog_msg = format (syslog_msg, "received signal %U, PC %U",
98 format_signal, signum, format_ucontext_pc, uc);
100 if (signum == SIGSEGV)
101 syslog_msg = format (syslog_msg, ", faulting address %p", si->si_addr);
105 /* these (caught) signals cause the application to exit */
107 if (unix_main.vlib_main->main_loop_exit_set)
109 syslog (LOG_ERR | LOG_DAEMON, "received SIGTERM, exiting...");
110 unix_main.vlib_main->main_loop_exit_now = 1;
125 /* by default, print a message and continue */
131 /* Null terminate. */
132 vec_add1 (syslog_msg, 0);
136 syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
138 /* Address of callers: outer first, inner last. */
140 uword n_callers = clib_backtrace (callers, ARRAY_LEN (callers), 0);
142 for (i = 0; i < n_callers; i++)
144 vec_reset_length (syslog_msg);
147 format (syslog_msg, "#%-2d 0x%016lx %U%c", i, callers[i],
148 format_clib_elf_symbol_with_address, callers[i], 0);
150 syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
153 /* have to remove SIGABRT to avoid recusive - os_exit calling abort() */
154 unsetup_signal_handlers (SIGABRT);
159 clib_warning ("%s", syslog_msg);
163 static clib_error_t *
164 setup_signal_handlers (unix_main_t * um)
169 /* give a big enough buffer for msg, most likely it can avoid vec_resize */
170 vec_alloc (syslog_msg, 2048);
172 for (i = 1; i < 32; i++)
174 clib_memset (&sa, 0, sizeof (sa));
175 sa.sa_sigaction = (void *) unix_signal_handler;
176 sa.sa_flags = SA_SIGINFO;
180 /* these signals take the default action */
187 /* ignore SIGPIPE, SIGCHLD */
190 sa.sa_sigaction = (void *) SIG_IGN;
193 /* catch and handle all other signals */
198 if (sigaction (i, &sa, 0) < 0)
199 return clib_error_return_unix (0, "sigaction %U", format_signal, i);
206 unix_error_handler (void *arg, u8 * msg, int msg_len)
208 unix_main_t *um = arg;
210 /* Echo to stderr when interactive. */
211 if (um->flags & UNIX_FLAG_INTERACTIVE)
213 CLIB_UNUSED (int r) = write (2, msg, msg_len);
217 char save = msg[msg_len - 1];
219 /* Null Terminate. */
220 msg[msg_len - 1] = 0;
222 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
224 msg[msg_len - 1] = save;
229 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
231 unix_main_t *um = &unix_main;
233 if (um->flags & UNIX_FLAG_INTERACTIVE || error == 0)
242 msg_len = vec_len (msg);
244 /* Null Terminate. */
245 save = msg[msg_len - 1];
246 msg[msg_len - 1] = 0;
248 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
250 msg[msg_len - 1] = save;
255 startup_config_process (vlib_main_t * vm,
256 vlib_node_runtime_t * rt, vlib_frame_t * f)
258 unix_main_t *um = &unix_main;
262 vlib_process_suspend (vm, 2.0);
264 while (um->unix_config_complete == 0)
265 vlib_process_suspend (vm, 0.1);
267 if (um->startup_config_filename)
269 unformat_input_t sub_input;
272 char *fn = (char *) um->startup_config_filename;
274 fd = open (fn, O_RDONLY);
277 clib_warning ("failed to open `%s'", fn);
281 if (fstat (fd, &s) < 0)
283 clib_warning ("failed to stat `%s'", fn);
289 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
291 clib_warning ("not a regular file: `%s'", fn);
298 vec_resize (buf, 4096);
299 n = read (fd, buf + l, 4096);
302 _vec_len (buf) = l + n;
309 if (um->log_fd && vec_len (buf))
312 lv = format (lv, "%U: ***** Startup Config *****\n%v",
313 format_timeval, 0 /* current bat-time */ ,
314 0 /* current bat-format */ ,
317 int rv __attribute__ ((unused)) =
318 write (um->log_fd, lv, vec_len (lv));
320 vec_reset_length (lv);
321 lv = format (lv, "%U: ***** End Startup Config *****\n",
322 format_timeval, 0 /* current bat-time */ ,
323 0 /* current bat-format */ );
325 int rv __attribute__ ((unused)) =
326 write (um->log_fd, lv, vec_len (lv));
333 unformat_init_vector (&sub_input, buf);
334 vlib_cli_input (vm, &sub_input, 0, 0);
335 /* frees buf for us */
336 unformat_free (&sub_input);
344 VLIB_REGISTER_NODE (startup_config_node,static) = {
345 .function = startup_config_process,
346 .type = VLIB_NODE_TYPE_PROCESS,
347 .name = "startup-config-process",
351 static clib_error_t *
352 unix_config (vlib_main_t * vm, unformat_input_t * input)
354 unix_main_t *um = &unix_main;
355 clib_error_t *error = 0;
360 um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
361 um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
363 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
366 if (unformat (input, "interactive"))
367 um->flags |= UNIX_FLAG_INTERACTIVE;
368 else if (unformat (input, "nodaemon"))
369 um->flags |= UNIX_FLAG_NODAEMON;
370 else if (unformat (input, "cli-prompt %s", &cli_prompt))
371 vlib_unix_cli_set_prompt (cli_prompt);
373 if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
375 else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
377 else if (unformat (input, "cli-line-mode"))
378 um->cli_line_mode = 1;
379 else if (unformat (input, "cli-no-banner"))
380 um->cli_no_banner = 1;
381 else if (unformat (input, "cli-no-pager"))
382 um->cli_no_pager = 1;
383 else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
385 else if (unformat (input, "cli-pager-buffer-limit %d",
386 &um->cli_pager_buffer_limit))
389 if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
391 else if (unformat (input, "coredump-size"))
393 uword coredump_size = 0;
394 if (unformat (input, "unlimited"))
396 coredump_size = RLIM_INFINITY;
399 if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
401 return clib_error_return (0,
402 "invalid coredump-size parameter `%U'",
403 format_unformat_error, input);
405 const struct rlimit new_limit = { coredump_size, coredump_size };
406 if (0 != setrlimit (RLIMIT_CORE, &new_limit))
408 clib_unix_warning ("prlimit() failed");
411 else if (unformat (input, "full-coredump"))
415 fd = open ("/proc/self/coredump_filter", O_WRONLY);
418 if (write (fd, "0x6f\n", 5) != 5)
419 clib_unix_warning ("coredump filter write failed!");
423 clib_unix_warning ("couldn't open /proc/self/coredump_filter");
425 else if (unformat (input, "startup-config %s",
426 &um->startup_config_filename))
428 else if (unformat (input, "exec %s", &um->startup_config_filename))
430 else if (unformat (input, "log %s", &um->log_filename))
432 um->log_fd = open ((char *) um->log_filename,
433 O_CREAT | O_WRONLY | O_APPEND, 0644);
436 clib_warning ("couldn't open log '%s'\n", um->log_filename);
442 lv = format (0, "%U: ***** Start: PID %d *****\n",
443 format_timeval, 0 /* current bat-time */ ,
444 0 /* current bat-format */ ,
447 int rv __attribute__ ((unused)) =
448 write (um->log_fd, lv, vec_len (lv));
453 else if (unformat (input, "gid %U", unformat_unix_gid, &gid))
455 if (setegid (gid) == -1)
456 return clib_error_return_unix (0, "setegid");
458 else if (unformat (input, "pidfile %s", &um->pidfile))
461 return clib_error_return (0, "unknown input `%U'",
462 format_unformat_error, input);
465 if (um->runtime_dir == 0)
467 uid_t uid = geteuid ();
469 um->runtime_dir = format (0, "/run/%s%c",
470 vlib_default_runtime_dir, 0);
472 um->runtime_dir = format (0, "/run/user/%u/%s%c", uid,
473 vlib_default_runtime_dir, 0);
476 error = setup_signal_handlers (um);
482 if ((error = vlib_unix_validate_runtime_file (um,
483 (char *) um->pidfile,
487 if (((pidfd = open ((char *) um->pidfile,
488 O_CREAT | O_WRONLY | O_TRUNC, 0644)) < 0))
490 return clib_error_return_unix (0, "open");
494 if (!(um->flags & UNIX_FLAG_INTERACTIVE))
496 openlog (vm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
497 clib_error_register_handler (unix_error_handler, um);
499 if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
500 /* stdin/stdout/stderr -> /dev/null */
502 clib_error_return (0, "daemon () fails");
507 u8 *lv = format (0, "%d", getpid ());
508 if (write (pidfd, (char *) lv, vec_len (lv)) != vec_len (lv))
512 return clib_error_return_unix (0, "write");
518 um->unix_config_complete = 1;
523 /* unix { ... } configuration. */
526 * @cfgcmd{interactive}
527 * Attach CLI to stdin/out and provide a debugging command line interface.
528 * Implies @c nodaemon.
531 * Do not fork or background the VPP process. Typically used when invoking
532 * VPP applications from a process monitor.
534 * @cfgcmd{exec, <filename>}
535 * @par <code>startup-config <filename></code>
536 * Read startup operational configuration from @c filename.
537 * The contents of the file will be performed as though entered at the CLI.
538 * The two keywords are aliases for the same function; if both are specified,
539 * only the last will have an effect.
541 * @cfgcmd{log, <filename>}
542 * Logs the startup configuration and all subsequent CLI commands in
544 * Very useful in situations where folks don't remember or can't be bothered
545 * to include CLI commands in bug reports.
547 * @cfgcmd{pidfile, <filename>}
548 * Writes the pid of the main thread in @c filename.
550 * @cfgcmd{full-coredump}
551 * Ask the Linux kernel to dump all memory-mapped address regions, instead
552 * of just text+data+bss.
554 * @cfgcmd{runtime-dir}
555 * Define directory where VPP is going to store all runtime files.
556 * Default is /run/vpp.
558 * @cfgcmd{cli-listen, <address:port>}
559 * Bind the CLI to listen at the address and port given. @clocalhost
560 * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
563 * @cfgcmd{cli-line-mode}
564 * Disable character-by-character I/O on stdin. Useful when combined with,
565 * for example, <tt>emacs M-x gud-gdb</tt>.
567 * @cfgcmd{cli-prompt, <string>}
568 * Configure the CLI prompt to be @c string.
570 * @cfgcmd{cli-history-limit, <nn>}
571 * Limit commmand history to @c nn lines. A value of @c 0
572 * disables command history. Default value: @c 50
574 * @cfgcmd{cli-no-banner}
575 * Disable the login banner on stdin and Telnet connections.
577 * @cfgcmd{cli-no-pager}
578 * Disable the output pager.
580 * @cfgcmd{cli-pager-buffer-limit, <nn>}
581 * Limit pager buffer to @c nn lines of output.
582 * A value of @c 0 disables the pager. Default value: @c 100000
584 VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
586 static clib_error_t *
587 unix_exit (vlib_main_t * vm)
589 /* Close syslog connection. */
594 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
596 u8 **vlib_thread_stacks;
601 vlib_main_t *vm = (vlib_main_t *) arg;
602 unformat_input_t input;
605 unformat_init_command_line (&input, (char **) vm->argv);
606 i = vlib_main (vm, &input);
607 unformat_free (&input);
613 vlib_thread_stack_init (uword thread_index)
615 vec_validate (vlib_thread_stacks, thread_index);
616 vlib_thread_stacks[thread_index] = clib_mem_alloc_aligned
617 (VLIB_THREAD_STACK_SIZE, VLIB_THREAD_STACK_SIZE);
620 * Disallow writes to the bottom page of the stack, to
621 * catch stack overflows.
623 if (mprotect (vlib_thread_stacks[thread_index],
624 clib_mem_get_page_size (), PROT_READ) < 0)
625 clib_unix_warning ("thread stack");
626 return vlib_thread_stacks[thread_index];
630 vlib_unix_main (int argc, char *argv[])
632 vlib_main_t *vm = &vlib_global_main; /* one and only time for this! */
633 unformat_input_t input;
637 vm->argv = (u8 **) argv;
639 vm->heap_base = clib_mem_get_heap ();
640 vm->heap_aligned_base = (void *)
641 (((uword) vm->heap_base) & ~(VLIB_FRAME_ALIGN - 1));
642 ASSERT (vm->heap_base);
644 unformat_init_command_line (&input, (char **) vm->argv);
645 if ((e = vlib_plugin_config (vm, &input)))
647 clib_error_report (e);
650 unformat_free (&input);
652 i = vlib_plugin_early_init (vm);
656 unformat_init_command_line (&input, (char **) vm->argv);
657 if (vm->init_functions_called == 0)
658 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
659 e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
662 clib_error_report (e);
665 unformat_free (&input);
667 /* always load symbols, for signal handler and mheap memory get/put backtrace */
668 clib_elf_main_init (vm->name);
670 vlib_thread_stack_init (0);
672 __os_thread_index = 0;
673 vm->thread_index = 0;
675 i = clib_calljmp (thread0, (uword) vm,
676 (void *) (vlib_thread_stacks[0] +
677 VLIB_THREAD_STACK_SIZE));
682 * fd.io coding-style-patch-verification: ON
685 * eval: (c-set-style "gnu")