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);
186 clib_warning ("%s", syslog_msg);
190 static clib_error_t *
191 setup_signal_handlers (unix_main_t * um)
196 /* give a big enough buffer for msg, most likely it can avoid vec_resize */
197 vec_alloc (syslog_msg, 2048);
199 for (i = 1; i < 32; i++)
201 clib_memset (&sa, 0, sizeof (sa));
202 sa.sa_sigaction = (void *) unix_signal_handler;
203 sa.sa_flags = SA_SIGINFO;
207 /* these signals take the default action */
214 /* ignore SIGPIPE, SIGCHLD */
217 sa.sa_sigaction = (void *) SIG_IGN;
220 /* catch and handle all other signals */
225 if (sigaction (i, &sa, 0) < 0)
226 return clib_error_return_unix (0, "sigaction %U", format_signal, i);
233 unix_error_handler (void *arg, u8 * msg, int msg_len)
235 unix_main_t *um = arg;
237 /* Echo to stderr when interactive. */
238 if (um->flags & UNIX_FLAG_INTERACTIVE)
240 CLIB_UNUSED (int r) = write (2, msg, msg_len);
244 char save = msg[msg_len - 1];
246 /* Null Terminate. */
247 msg[msg_len - 1] = 0;
249 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
251 msg[msg_len - 1] = save;
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)
269 msg_len = vec_len (msg);
271 /* Null Terminate. */
272 save = msg[msg_len - 1];
273 msg[msg_len - 1] = 0;
275 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
277 msg[msg_len - 1] = save;
282 startup_config_process (vlib_main_t * vm,
283 vlib_node_runtime_t * rt, vlib_frame_t * f)
285 unix_main_t *um = &unix_main;
289 vlib_process_suspend (vm, 2.0);
291 while (um->unix_config_complete == 0)
292 vlib_process_suspend (vm, 0.1);
294 if (um->startup_config_filename)
296 unformat_input_t sub_input;
299 char *fn = (char *) um->startup_config_filename;
301 fd = open (fn, O_RDONLY);
304 clib_warning ("failed to open `%s'", fn);
308 if (fstat (fd, &s) < 0)
310 clib_warning ("failed to stat `%s'", fn);
316 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
318 clib_warning ("not a regular file: `%s'", fn);
325 vec_resize (buf, 4096);
326 n = read (fd, buf + l, 4096);
329 _vec_len (buf) = l + n;
336 if (um->log_fd && vec_len (buf))
339 lv = format (lv, "%U: ***** Startup Config *****\n%v",
340 format_timeval, 0 /* current bat-time */ ,
341 0 /* current bat-format */ ,
344 int rv __attribute__ ((unused)) =
345 write (um->log_fd, lv, vec_len (lv));
347 vec_reset_length (lv);
348 lv = format (lv, "%U: ***** End Startup Config *****\n",
349 format_timeval, 0 /* current bat-time */ ,
350 0 /* current bat-format */ );
352 int rv __attribute__ ((unused)) =
353 write (um->log_fd, lv, vec_len (lv));
360 unformat_init_vector (&sub_input, buf);
361 vlib_cli_input (vm, &sub_input, 0, 0);
362 /* frees buf for us */
363 unformat_free (&sub_input);
371 VLIB_REGISTER_NODE (startup_config_node,static) = {
372 .function = startup_config_process,
373 .type = VLIB_NODE_TYPE_PROCESS,
374 .name = "startup-config-process",
375 .process_log2_n_stack_bytes = 18,
379 static clib_error_t *
380 unix_config (vlib_main_t * vm, unformat_input_t * input)
382 unix_main_t *um = &unix_main;
383 clib_error_t *error = 0;
388 um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
389 um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
391 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
394 if (unformat (input, "interactive"))
395 um->flags |= UNIX_FLAG_INTERACTIVE;
396 else if (unformat (input, "nodaemon"))
397 um->flags |= UNIX_FLAG_NODAEMON;
398 else if (unformat (input, "cli-prompt %s", &cli_prompt))
399 vlib_unix_cli_set_prompt (cli_prompt);
401 if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
403 else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
405 else if (unformat (input, "cli-line-mode"))
406 um->cli_line_mode = 1;
407 else if (unformat (input, "cli-no-banner"))
408 um->cli_no_banner = 1;
409 else if (unformat (input, "cli-no-pager"))
410 um->cli_no_pager = 1;
411 else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
413 else if (unformat (input, "cli-pager-buffer-limit %d",
414 &um->cli_pager_buffer_limit))
417 if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
419 else if (unformat (input, "coredump-size"))
421 uword coredump_size = 0;
422 if (unformat (input, "unlimited"))
424 coredump_size = RLIM_INFINITY;
427 if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
429 return clib_error_return (0,
430 "invalid coredump-size parameter `%U'",
431 format_unformat_error, input);
433 const struct rlimit new_limit = { coredump_size, coredump_size };
434 if (0 != setrlimit (RLIMIT_CORE, &new_limit))
436 clib_unix_warning ("prlimit() failed");
439 else if (unformat (input, "full-coredump"))
443 fd = open ("/proc/self/coredump_filter", O_WRONLY);
446 if (write (fd, "0x6f\n", 5) != 5)
447 clib_unix_warning ("coredump filter write failed!");
451 clib_unix_warning ("couldn't open /proc/self/coredump_filter");
453 else if (unformat (input, "startup-config %s",
454 &um->startup_config_filename))
456 else if (unformat (input, "exec %s", &um->startup_config_filename))
458 else if (unformat (input, "log %s", &um->log_filename))
460 um->log_fd = open ((char *) um->log_filename,
461 O_CREAT | O_WRONLY | O_APPEND, 0644);
464 clib_warning ("couldn't open log '%s'\n", um->log_filename);
470 lv = format (0, "%U: ***** Start: PID %d *****\n",
471 format_timeval, 0 /* current bat-time */ ,
472 0 /* current bat-format */ ,
475 int rv __attribute__ ((unused)) =
476 write (um->log_fd, lv, vec_len (lv));
481 else if (unformat (input, "gid %U", unformat_unix_gid, &gid))
483 if (setegid (gid) == -1)
484 return clib_error_return_unix (0, "setegid");
486 else if (unformat (input, "pidfile %s", &um->pidfile))
489 return clib_error_return (0, "unknown input `%U'",
490 format_unformat_error, input);
493 if (um->runtime_dir == 0)
495 uid_t uid = geteuid ();
497 um->runtime_dir = format (0, "/run/%s%c",
498 vlib_default_runtime_dir, 0);
500 um->runtime_dir = format (0, "/run/user/%u/%s%c", uid,
501 vlib_default_runtime_dir, 0);
504 /* Ensure the runtime directory is created */
505 error = vlib_unix_recursive_mkdir ((char *) um->runtime_dir);
509 error = setup_signal_handlers (um);
515 if ((error = vlib_unix_validate_runtime_file (um,
516 (char *) um->pidfile,
520 if (((pidfd = open ((char *) um->pidfile,
521 O_CREAT | O_WRONLY | O_TRUNC, 0644)) < 0))
523 return clib_error_return_unix (0, "open");
527 if (!(um->flags & UNIX_FLAG_INTERACTIVE))
529 openlog (vm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
530 clib_error_register_handler (unix_error_handler, um);
532 if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
533 /* stdin/stdout/stderr -> /dev/null */
535 clib_error_return (0, "daemon () fails");
540 u8 *lv = format (0, "%d", getpid ());
541 if (write (pidfd, (char *) lv, vec_len (lv)) != vec_len (lv))
545 return clib_error_return_unix (0, "write");
551 um->unix_config_complete = 1;
556 /* unix { ... } configuration. */
559 * @cfgcmd{interactive}
560 * Attach CLI to stdin/out and provide a debugging command line interface.
561 * Implies @c nodaemon.
564 * Do not fork or background the VPP process. Typically used when invoking
565 * VPP applications from a process monitor.
567 * @cfgcmd{exec, <filename>}
568 * @par <code>startup-config <filename></code>
569 * Read startup operational configuration from @c filename.
570 * The contents of the file will be performed as though entered at the CLI.
571 * The two keywords are aliases for the same function; if both are specified,
572 * only the last will have an effect.
574 * @cfgcmd{log, <filename>}
575 * Logs the startup configuration and all subsequent CLI commands in
577 * Very useful in situations where folks don't remember or can't be bothered
578 * to include CLI commands in bug reports.
580 * @cfgcmd{pidfile, <filename>}
581 * Writes the pid of the main thread in @c filename.
583 * @cfgcmd{full-coredump}
584 * Ask the Linux kernel to dump all memory-mapped address regions, instead
585 * of just text+data+bss.
587 * @cfgcmd{runtime-dir}
588 * Define directory where VPP is going to store all runtime files.
589 * Default is /run/vpp when running as root, /run/user/<UID>/vpp if running as
590 * an unprivileged user.
592 * @cfgcmd{cli-listen, <address:port>}
593 * Bind the CLI to listen at the address and port given. @c localhost
594 * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
597 * @cfgcmd{cli-line-mode}
598 * Disable character-by-character I/O on stdin. Useful when combined with,
599 * for example, <tt>emacs M-x gud-gdb</tt>.
601 * @cfgcmd{cli-prompt, <string>}
602 * Configure the CLI prompt to be @c string.
604 * @cfgcmd{cli-history-limit, <nn>}
605 * Limit command history to @c nn lines. A value of @c 0
606 * disables command history. Default value: @c 50
608 * @cfgcmd{cli-no-banner}
609 * Disable the login banner on stdin and Telnet connections.
611 * @cfgcmd{cli-no-pager}
612 * Disable the output pager.
614 * @cfgcmd{cli-pager-buffer-limit, <nn>}
615 * Limit pager buffer to @c nn lines of output.
616 * A value of @c 0 disables the pager. Default value: @c 100000
618 * @cfgcmd{gid, <nn>}
619 * Set the effective gid under which the vpp process is to run.
621 * @cfgcmd{poll-sleep-usec, <nn>}
622 * Set a fixed poll sleep interval between main loop polls.
624 VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
626 static clib_error_t *
627 unix_exit (vlib_main_t * vm)
629 /* Close syslog connection. */
634 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
636 u8 **vlib_thread_stacks;
641 vlib_main_t *vm = (vlib_main_t *) arg;
642 unformat_input_t input;
645 unformat_init_command_line (&input, (char **) vm->argv);
646 i = vlib_main (vm, &input);
647 unformat_free (&input);
653 vlib_thread_stack_init (uword thread_index)
655 ASSERT (thread_index < vec_len (vlib_thread_stacks));
656 vlib_thread_stacks[thread_index] = clib_mem_alloc_aligned
657 (VLIB_THREAD_STACK_SIZE, clib_mem_get_page_size ());
660 * Disallow writes to the bottom page of the stack, to
661 * catch stack overflows.
663 if (mprotect (vlib_thread_stacks[thread_index],
664 clib_mem_get_page_size (), PROT_READ) < 0)
665 clib_unix_warning ("thread stack");
666 return vlib_thread_stacks[thread_index];
670 vlib_unix_main (int argc, char *argv[])
672 vlib_main_t *vm = &vlib_global_main; /* one and only time for this! */
673 unformat_input_t input;
677 vm->argv = (u8 **) argv;
679 vm->heap_base = clib_mem_get_heap ();
680 vm->heap_aligned_base = (void *)
681 (((uword) vm->heap_base) & ~(VLIB_FRAME_ALIGN - 1));
682 ASSERT (vm->heap_base);
684 unformat_init_command_line (&input, (char **) vm->argv);
685 if ((e = vlib_plugin_config (vm, &input)))
687 clib_error_report (e);
690 unformat_free (&input);
692 i = vlib_plugin_early_init (vm);
696 unformat_init_command_line (&input, (char **) vm->argv);
697 if (vm->init_functions_called == 0)
698 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
699 e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
702 clib_error_report (e);
705 unformat_free (&input);
707 /* always load symbols, for signal handler and mheap memory get/put backtrace */
708 clib_elf_main_init (vm->name);
710 vec_validate (vlib_thread_stacks, 0);
711 vlib_thread_stack_init (0);
713 __os_thread_index = 0;
714 vm->thread_index = 0;
716 i = clib_calljmp (thread0, (uword) vm,
717 (void *) (vlib_thread_stacks[0] +
718 VLIB_THREAD_STACK_SIZE));
723 * fd.io coding-style-patch-verification: ON
726 * eval: (c-set-style "gnu")