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;
91 static int last_signum = 0;
92 static uword last_faulting_address = 0;
95 unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
99 /* These come in handy when looking at core files from optimized images */
100 last_signum = signum;
101 last_faulting_address = (uword) si->si_addr;
103 syslog_msg = format (syslog_msg, "received signal %U, PC %U",
104 format_signal, signum, format_ucontext_pc, uc);
106 if (signum == SIGSEGV)
107 syslog_msg = format (syslog_msg, ", faulting address %p", si->si_addr);
111 /* these (caught) signals cause the application to exit */
114 * Ignore SIGTERM if it's sent before we're ready.
116 if (unix_main.vlib_main && unix_main.vlib_main->main_loop_exit_set)
118 syslog (LOG_ERR | LOG_DAEMON, "received SIGTERM, exiting...");
119 unix_main.vlib_main->main_loop_exit_now = 1;
122 syslog (LOG_ERR | LOG_DAEMON, "IGNORE early SIGTERM...");
136 /* by default, print a message and continue */
142 /* Null terminate. */
143 vec_add1 (syslog_msg, 0);
147 syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
149 /* Address of callers: outer first, inner last. */
151 uword n_callers = clib_backtrace (callers, ARRAY_LEN (callers), 0);
153 for (i = 0; i < n_callers; i++)
155 vec_reset_length (syslog_msg);
158 format (syslog_msg, "#%-2d 0x%016lx %U%c", i, callers[i],
159 format_clib_elf_symbol_with_address, callers[i], 0);
161 syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
164 /* have to remove SIGABRT to avoid recusive - os_exit calling abort() */
165 unsetup_signal_handlers (SIGABRT);
170 clib_warning ("%s", syslog_msg);
174 static clib_error_t *
175 setup_signal_handlers (unix_main_t * um)
180 /* give a big enough buffer for msg, most likely it can avoid vec_resize */
181 vec_alloc (syslog_msg, 2048);
183 for (i = 1; i < 32; i++)
185 clib_memset (&sa, 0, sizeof (sa));
186 sa.sa_sigaction = (void *) unix_signal_handler;
187 sa.sa_flags = SA_SIGINFO;
191 /* these signals take the default action */
198 /* ignore SIGPIPE, SIGCHLD */
201 sa.sa_sigaction = (void *) SIG_IGN;
204 /* catch and handle all other signals */
209 if (sigaction (i, &sa, 0) < 0)
210 return clib_error_return_unix (0, "sigaction %U", format_signal, i);
217 unix_error_handler (void *arg, u8 * msg, int msg_len)
219 unix_main_t *um = arg;
221 /* Echo to stderr when interactive. */
222 if (um->flags & UNIX_FLAG_INTERACTIVE)
224 CLIB_UNUSED (int r) = write (2, msg, msg_len);
228 char save = msg[msg_len - 1];
230 /* Null Terminate. */
231 msg[msg_len - 1] = 0;
233 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
235 msg[msg_len - 1] = save;
240 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
242 unix_main_t *um = &unix_main;
244 if (um->flags & UNIX_FLAG_INTERACTIVE || error == 0)
253 msg_len = vec_len (msg);
255 /* Null Terminate. */
256 save = msg[msg_len - 1];
257 msg[msg_len - 1] = 0;
259 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
261 msg[msg_len - 1] = save;
266 startup_config_process (vlib_main_t * vm,
267 vlib_node_runtime_t * rt, vlib_frame_t * f)
269 unix_main_t *um = &unix_main;
273 vlib_process_suspend (vm, 2.0);
275 while (um->unix_config_complete == 0)
276 vlib_process_suspend (vm, 0.1);
278 if (um->startup_config_filename)
280 unformat_input_t sub_input;
283 char *fn = (char *) um->startup_config_filename;
285 fd = open (fn, O_RDONLY);
288 clib_warning ("failed to open `%s'", fn);
292 if (fstat (fd, &s) < 0)
294 clib_warning ("failed to stat `%s'", fn);
300 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
302 clib_warning ("not a regular file: `%s'", fn);
309 vec_resize (buf, 4096);
310 n = read (fd, buf + l, 4096);
313 _vec_len (buf) = l + n;
320 if (um->log_fd && vec_len (buf))
323 lv = format (lv, "%U: ***** Startup Config *****\n%v",
324 format_timeval, 0 /* current bat-time */ ,
325 0 /* current bat-format */ ,
328 int rv __attribute__ ((unused)) =
329 write (um->log_fd, lv, vec_len (lv));
331 vec_reset_length (lv);
332 lv = format (lv, "%U: ***** End Startup Config *****\n",
333 format_timeval, 0 /* current bat-time */ ,
334 0 /* current bat-format */ );
336 int rv __attribute__ ((unused)) =
337 write (um->log_fd, lv, vec_len (lv));
344 unformat_init_vector (&sub_input, buf);
345 vlib_cli_input (vm, &sub_input, 0, 0);
346 /* frees buf for us */
347 unformat_free (&sub_input);
355 VLIB_REGISTER_NODE (startup_config_node,static) = {
356 .function = startup_config_process,
357 .type = VLIB_NODE_TYPE_PROCESS,
358 .name = "startup-config-process",
362 static clib_error_t *
363 unix_config (vlib_main_t * vm, unformat_input_t * input)
365 unix_main_t *um = &unix_main;
366 clib_error_t *error = 0;
371 um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
372 um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
374 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
377 if (unformat (input, "interactive"))
378 um->flags |= UNIX_FLAG_INTERACTIVE;
379 else if (unformat (input, "nodaemon"))
380 um->flags |= UNIX_FLAG_NODAEMON;
381 else if (unformat (input, "cli-prompt %s", &cli_prompt))
382 vlib_unix_cli_set_prompt (cli_prompt);
384 if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
386 else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
388 else if (unformat (input, "cli-line-mode"))
389 um->cli_line_mode = 1;
390 else if (unformat (input, "cli-no-banner"))
391 um->cli_no_banner = 1;
392 else if (unformat (input, "cli-no-pager"))
393 um->cli_no_pager = 1;
394 else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
396 else if (unformat (input, "cli-pager-buffer-limit %d",
397 &um->cli_pager_buffer_limit))
400 if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
402 else if (unformat (input, "coredump-size"))
404 uword coredump_size = 0;
405 if (unformat (input, "unlimited"))
407 coredump_size = RLIM_INFINITY;
410 if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
412 return clib_error_return (0,
413 "invalid coredump-size parameter `%U'",
414 format_unformat_error, input);
416 const struct rlimit new_limit = { coredump_size, coredump_size };
417 if (0 != setrlimit (RLIMIT_CORE, &new_limit))
419 clib_unix_warning ("prlimit() failed");
422 else if (unformat (input, "full-coredump"))
426 fd = open ("/proc/self/coredump_filter", O_WRONLY);
429 if (write (fd, "0x6f\n", 5) != 5)
430 clib_unix_warning ("coredump filter write failed!");
434 clib_unix_warning ("couldn't open /proc/self/coredump_filter");
436 else if (unformat (input, "startup-config %s",
437 &um->startup_config_filename))
439 else if (unformat (input, "exec %s", &um->startup_config_filename))
441 else if (unformat (input, "log %s", &um->log_filename))
443 um->log_fd = open ((char *) um->log_filename,
444 O_CREAT | O_WRONLY | O_APPEND, 0644);
447 clib_warning ("couldn't open log '%s'\n", um->log_filename);
453 lv = format (0, "%U: ***** Start: PID %d *****\n",
454 format_timeval, 0 /* current bat-time */ ,
455 0 /* current bat-format */ ,
458 int rv __attribute__ ((unused)) =
459 write (um->log_fd, lv, vec_len (lv));
464 else if (unformat (input, "gid %U", unformat_unix_gid, &gid))
466 if (setegid (gid) == -1)
467 return clib_error_return_unix (0, "setegid");
469 else if (unformat (input, "pidfile %s", &um->pidfile))
472 return clib_error_return (0, "unknown input `%U'",
473 format_unformat_error, input);
476 if (um->runtime_dir == 0)
478 uid_t uid = geteuid ();
480 um->runtime_dir = format (0, "/run/%s%c",
481 vlib_default_runtime_dir, 0);
483 um->runtime_dir = format (0, "/run/user/%u/%s%c", uid,
484 vlib_default_runtime_dir, 0);
487 error = setup_signal_handlers (um);
493 if ((error = vlib_unix_validate_runtime_file (um,
494 (char *) um->pidfile,
498 if (((pidfd = open ((char *) um->pidfile,
499 O_CREAT | O_WRONLY | O_TRUNC, 0644)) < 0))
501 return clib_error_return_unix (0, "open");
505 if (!(um->flags & UNIX_FLAG_INTERACTIVE))
507 openlog (vm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
508 clib_error_register_handler (unix_error_handler, um);
510 if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
511 /* stdin/stdout/stderr -> /dev/null */
513 clib_error_return (0, "daemon () fails");
518 u8 *lv = format (0, "%d", getpid ());
519 if (write (pidfd, (char *) lv, vec_len (lv)) != vec_len (lv))
523 return clib_error_return_unix (0, "write");
529 um->unix_config_complete = 1;
534 /* unix { ... } configuration. */
537 * @cfgcmd{interactive}
538 * Attach CLI to stdin/out and provide a debugging command line interface.
539 * Implies @c nodaemon.
542 * Do not fork or background the VPP process. Typically used when invoking
543 * VPP applications from a process monitor.
545 * @cfgcmd{exec, <filename>}
546 * @par <code>startup-config <filename></code>
547 * Read startup operational configuration from @c filename.
548 * The contents of the file will be performed as though entered at the CLI.
549 * The two keywords are aliases for the same function; if both are specified,
550 * only the last will have an effect.
552 * @cfgcmd{log, <filename>}
553 * Logs the startup configuration and all subsequent CLI commands in
555 * Very useful in situations where folks don't remember or can't be bothered
556 * to include CLI commands in bug reports.
558 * @cfgcmd{pidfile, <filename>}
559 * Writes the pid of the main thread in @c filename.
561 * @cfgcmd{full-coredump}
562 * Ask the Linux kernel to dump all memory-mapped address regions, instead
563 * of just text+data+bss.
565 * @cfgcmd{runtime-dir}
566 * Define directory where VPP is going to store all runtime files.
567 * Default is /run/vpp.
569 * @cfgcmd{cli-listen, <address:port>}
570 * Bind the CLI to listen at the address and port given. @clocalhost
571 * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
574 * @cfgcmd{cli-line-mode}
575 * Disable character-by-character I/O on stdin. Useful when combined with,
576 * for example, <tt>emacs M-x gud-gdb</tt>.
578 * @cfgcmd{cli-prompt, <string>}
579 * Configure the CLI prompt to be @c string.
581 * @cfgcmd{cli-history-limit, <nn>}
582 * Limit commmand history to @c nn lines. A value of @c 0
583 * disables command history. Default value: @c 50
585 * @cfgcmd{cli-no-banner}
586 * Disable the login banner on stdin and Telnet connections.
588 * @cfgcmd{cli-no-pager}
589 * Disable the output pager.
591 * @cfgcmd{cli-pager-buffer-limit, <nn>}
592 * Limit pager buffer to @c nn lines of output.
593 * A value of @c 0 disables the pager. Default value: @c 100000
595 VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
597 static clib_error_t *
598 unix_exit (vlib_main_t * vm)
600 /* Close syslog connection. */
605 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
607 u8 **vlib_thread_stacks;
612 vlib_main_t *vm = (vlib_main_t *) arg;
613 unformat_input_t input;
616 unformat_init_command_line (&input, (char **) vm->argv);
617 i = vlib_main (vm, &input);
618 unformat_free (&input);
624 vlib_thread_stack_init (uword thread_index)
626 vec_validate (vlib_thread_stacks, thread_index);
627 vlib_thread_stacks[thread_index] = clib_mem_alloc_aligned
628 (VLIB_THREAD_STACK_SIZE, VLIB_THREAD_STACK_SIZE);
631 * Disallow writes to the bottom page of the stack, to
632 * catch stack overflows.
634 if (mprotect (vlib_thread_stacks[thread_index],
635 clib_mem_get_page_size (), PROT_READ) < 0)
636 clib_unix_warning ("thread stack");
637 return vlib_thread_stacks[thread_index];
641 vlib_unix_main (int argc, char *argv[])
643 vlib_main_t *vm = &vlib_global_main; /* one and only time for this! */
644 unformat_input_t input;
648 vm->argv = (u8 **) argv;
650 vm->heap_base = clib_mem_get_heap ();
651 vm->heap_aligned_base = (void *)
652 (((uword) vm->heap_base) & ~(VLIB_FRAME_ALIGN - 1));
653 ASSERT (vm->heap_base);
655 unformat_init_command_line (&input, (char **) vm->argv);
656 if ((e = vlib_plugin_config (vm, &input)))
658 clib_error_report (e);
661 unformat_free (&input);
663 i = vlib_plugin_early_init (vm);
667 unformat_init_command_line (&input, (char **) vm->argv);
668 if (vm->init_functions_called == 0)
669 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
670 e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
673 clib_error_report (e);
676 unformat_free (&input);
678 /* always load symbols, for signal handler and mheap memory get/put backtrace */
679 clib_elf_main_init (vm->name);
681 vlib_thread_stack_init (0);
683 __os_thread_index = 0;
684 vm->thread_index = 0;
686 i = clib_calljmp (thread0, (uword) vm,
687 (void *) (vlib_thread_stacks[0] +
688 VLIB_THREAD_STACK_SIZE));
693 * fd.io coding-style-patch-verification: ON
696 * eval: (c-set-style "gnu")