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;
64 vlib_physmem_main_t physmem_main;
67 unix_main_init (vlib_main_t * vm)
69 unix_main_t *um = &unix_main;
71 return vlib_call_init_function (vm, unix_input_init);
74 VLIB_INIT_FUNCTION (unix_main_init);
77 unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
82 msg = format (msg, "received signal %U, PC %U",
83 format_signal, signum, format_ucontext_pc, uc);
85 if (signum == SIGSEGV)
86 msg = format (msg, ", faulting address %p", si->si_addr);
90 /* these (caught) signals cause the application to exit */
92 if (unix_main.vlib_main->main_loop_exit_set)
94 syslog (LOG_ERR | LOG_DAEMON, "received SIGTERM, exiting...");
95 unix_main.vlib_main->main_loop_exit_now = 1;
109 /* by default, print a message and continue */
115 /* Null terminate. */
120 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
124 clib_warning ("%s", msg);
129 static clib_error_t *
130 setup_signal_handlers (unix_main_t * um)
135 for (i = 1; i < 32; i++)
137 memset (&sa, 0, sizeof (sa));
138 sa.sa_sigaction = (void *) unix_signal_handler;
139 sa.sa_flags = SA_SIGINFO;
143 /* these signals take the default action */
151 /* ignore SIGPIPE, SIGCHLD */
154 sa.sa_sigaction = (void *) SIG_IGN;
157 /* catch and handle all other signals */
162 if (sigaction (i, &sa, 0) < 0)
163 return clib_error_return_unix (0, "sigaction %U", format_signal, i);
170 unix_error_handler (void *arg, u8 * msg, int msg_len)
172 unix_main_t *um = arg;
174 /* Echo to stderr when interactive. */
175 if (um->flags & UNIX_FLAG_INTERACTIVE)
177 CLIB_UNUSED (int r) = write (2, msg, msg_len);
181 char save = msg[msg_len - 1];
183 /* Null Terminate. */
184 msg[msg_len - 1] = 0;
186 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
188 msg[msg_len - 1] = save;
193 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
195 unix_main_t *um = &unix_main;
197 if (um->flags & UNIX_FLAG_INTERACTIVE || error == 0)
206 msg_len = vec_len (msg);
208 /* Null Terminate. */
209 save = msg[msg_len - 1];
210 msg[msg_len - 1] = 0;
212 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
214 msg[msg_len - 1] = save;
219 startup_config_process (vlib_main_t * vm,
220 vlib_node_runtime_t * rt, vlib_frame_t * f)
222 unix_main_t *um = &unix_main;
226 vlib_process_suspend (vm, 2.0);
228 while (um->unix_config_complete == 0)
229 vlib_process_suspend (vm, 0.1);
231 if (um->startup_config_filename)
233 unformat_input_t sub_input;
236 char *fn = (char *) um->startup_config_filename;
238 fd = open (fn, O_RDONLY);
241 clib_warning ("failed to open `%s'", fn);
245 if (fstat (fd, &s) < 0)
247 clib_warning ("failed to stat `%s'", fn);
253 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
255 clib_warning ("not a regular file: `%s'", fn);
262 vec_resize (buf, 4096);
263 n = read (fd, buf + l, 4096);
266 _vec_len (buf) = l + n;
273 if (um->log_fd && vec_len (buf))
276 lv = format (lv, "%U: ***** Startup Config *****\n%v",
277 format_timeval, 0 /* current bat-time */ ,
278 0 /* current bat-format */ ,
281 int rv __attribute__ ((unused)) =
282 write (um->log_fd, lv, vec_len (lv));
284 vec_reset_length (lv);
285 lv = format (lv, "%U: ***** End Startup Config *****\n",
286 format_timeval, 0 /* current bat-time */ ,
287 0 /* current bat-format */ );
289 int rv __attribute__ ((unused)) =
290 write (um->log_fd, lv, vec_len (lv));
297 unformat_init_vector (&sub_input, buf);
298 vlib_cli_input (vm, &sub_input, 0, 0);
299 /* frees buf for us */
300 unformat_free (&sub_input);
308 VLIB_REGISTER_NODE (startup_config_node,static) = {
309 .function = startup_config_process,
310 .type = VLIB_NODE_TYPE_PROCESS,
311 .name = "startup-config-process",
315 static clib_error_t *
316 unix_config (vlib_main_t * vm, unformat_input_t * input)
318 unix_main_t *um = &unix_main;
319 clib_error_t *error = 0;
324 um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
325 um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
327 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
330 if (unformat (input, "interactive"))
331 um->flags |= UNIX_FLAG_INTERACTIVE;
332 else if (unformat (input, "nodaemon"))
333 um->flags |= UNIX_FLAG_NODAEMON;
334 else if (unformat (input, "cli-prompt %s", &cli_prompt))
335 vlib_unix_cli_set_prompt (cli_prompt);
337 if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
339 else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
341 else if (unformat (input, "cli-line-mode"))
342 um->cli_line_mode = 1;
343 else if (unformat (input, "cli-no-banner"))
344 um->cli_no_banner = 1;
345 else if (unformat (input, "cli-no-pager"))
346 um->cli_no_pager = 1;
347 else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
349 else if (unformat (input, "cli-pager-buffer-limit %d",
350 &um->cli_pager_buffer_limit))
353 if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
355 else if (unformat (input, "coredump-size"))
357 uword coredump_size = 0;
358 if (unformat (input, "unlimited"))
360 coredump_size = RLIM_INFINITY;
363 if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
365 return clib_error_return (0,
366 "invalid coredump-size parameter `%U'",
367 format_unformat_error, input);
369 const struct rlimit new_limit = { coredump_size, coredump_size };
370 if (0 != setrlimit (RLIMIT_CORE, &new_limit))
372 clib_unix_warning ("prlimit() failed");
375 else if (unformat (input, "full-coredump"))
379 fd = open ("/proc/self/coredump_filter", O_WRONLY);
382 if (write (fd, "0x6f\n", 5) != 5)
383 clib_unix_warning ("coredump filter write failed!");
387 clib_unix_warning ("couldn't open /proc/self/coredump_filter");
389 else if (unformat (input, "startup-config %s",
390 &um->startup_config_filename))
392 else if (unformat (input, "exec %s", &um->startup_config_filename))
394 else if (unformat (input, "log %s", &um->log_filename))
396 um->log_fd = open ((char *) um->log_filename,
397 O_CREAT | O_WRONLY | O_APPEND, 0644);
400 clib_warning ("couldn't open log '%s'\n", um->log_filename);
406 lv = format (0, "%U: ***** Start: PID %d *****\n",
407 format_timeval, 0 /* current bat-time */ ,
408 0 /* current bat-format */ ,
411 int rv __attribute__ ((unused)) =
412 write (um->log_fd, lv, vec_len (lv));
417 else if (unformat (input, "gid %U", unformat_unix_gid, &gid))
419 if (setegid (gid) == -1)
420 return clib_error_return_unix (0, "setegid");
422 else if (unformat (input, "pidfile %s", &um->pidfile))
425 return clib_error_return (0, "unknown input `%U'",
426 format_unformat_error, input);
429 if (um->runtime_dir == 0)
431 uid_t uid = geteuid ();
433 um->runtime_dir = format (0, "/run/%s%c",
434 vlib_default_runtime_dir, 0);
436 um->runtime_dir = format (0, "/run/user/%u/%s%c", uid,
437 vlib_default_runtime_dir, 0);
440 error = setup_signal_handlers (um);
446 if ((error = vlib_unix_validate_runtime_file (um,
447 (char *) um->pidfile,
451 if (((pidfd = open ((char *) um->pidfile,
452 O_CREAT | O_WRONLY | O_TRUNC, 0644)) < 0))
454 return clib_error_return_unix (0, "open");
458 if (!(um->flags & UNIX_FLAG_INTERACTIVE))
460 openlog (vm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
461 clib_error_register_handler (unix_error_handler, um);
463 if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
464 /* stdin/stdout/stderr -> /dev/null */
466 clib_error_return (0, "daemon () fails");
471 u8 *lv = format (0, "%d", getpid ());
472 if (write (pidfd, (char *) lv, vec_len (lv)) != vec_len (lv))
476 return clib_error_return_unix (0, "write");
482 um->unix_config_complete = 1;
487 /* unix { ... } configuration. */
490 * @cfgcmd{interactive}
491 * Attach CLI to stdin/out and provide a debugging command line interface.
492 * Implies @c nodaemon.
495 * Do not fork or background the VPP process. Typically used when invoking
496 * VPP applications from a process monitor.
498 * @cfgcmd{exec, <filename>}
499 * @par <code>startup-config <filename></code>
500 * Read startup operational configuration from @c filename.
501 * The contents of the file will be performed as though entered at the CLI.
502 * The two keywords are aliases for the same function; if both are specified,
503 * only the last will have an effect.
505 * @cfgcmd{log, <filename>}
506 * Logs the startup configuration and all subsequent CLI commands in
508 * Very useful in situations where folks don't remember or can't be bothered
509 * to include CLI commands in bug reports.
511 * @cfgcmd{pidfile, <filename>}
512 * Writes the pid of the main thread in @c filename.
514 * @cfgcmd{full-coredump}
515 * Ask the Linux kernel to dump all memory-mapped address regions, instead
516 * of just text+data+bss.
518 * @cfgcmd{runtime-dir}
519 * Define directory where VPP is going to store all runtime files.
520 * Default is /run/vpp.
522 * @cfgcmd{cli-listen, <address:port>}
523 * Bind the CLI to listen at the address and port given. @clocalhost
524 * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
527 * @cfgcmd{cli-line-mode}
528 * Disable character-by-character I/O on stdin. Useful when combined with,
529 * for example, <tt>emacs M-x gud-gdb</tt>.
531 * @cfgcmd{cli-prompt, <string>}
532 * Configure the CLI prompt to be @c string.
534 * @cfgcmd{cli-history-limit, <nn>}
535 * Limit commmand history to @c nn lines. A value of @c 0
536 * disables command history. Default value: @c 50
538 * @cfgcmd{cli-no-banner}
539 * Disable the login banner on stdin and Telnet connections.
541 * @cfgcmd{cli-no-pager}
542 * Disable the output pager.
544 * @cfgcmd{cli-pager-buffer-limit, <nn>}
545 * Limit pager buffer to @c nn lines of output.
546 * A value of @c 0 disables the pager. Default value: @c 100000
548 VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
550 static clib_error_t *
551 unix_exit (vlib_main_t * vm)
553 /* Close syslog connection. */
558 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
560 u8 **vlib_thread_stacks;
565 vlib_main_t *vm = (vlib_main_t *) arg;
566 unformat_input_t input;
569 unformat_init_command_line (&input, (char **) vm->argv);
570 i = vlib_main (vm, &input);
571 unformat_free (&input);
577 vlib_thread_stack_init (uword thread_index)
579 vec_validate (vlib_thread_stacks, thread_index);
580 vlib_thread_stacks[thread_index] = clib_mem_alloc_aligned
581 (VLIB_THREAD_STACK_SIZE, VLIB_THREAD_STACK_SIZE);
584 * Disallow writes to the bottom page of the stack, to
585 * catch stack overflows.
587 if (mprotect (vlib_thread_stacks[thread_index],
588 clib_mem_get_page_size (), PROT_READ) < 0)
589 clib_unix_warning ("thread stack");
590 return vlib_thread_stacks[thread_index];
594 vlib_unix_main (int argc, char *argv[])
596 vlib_main_t *vm = &vlib_global_main; /* one and only time for this! */
597 unformat_input_t input;
601 vm->argv = (u8 **) argv;
603 vm->heap_base = clib_mem_get_heap ();
604 ASSERT (vm->heap_base);
606 unformat_init_command_line (&input, (char **) vm->argv);
607 if ((e = vlib_plugin_config (vm, &input)))
609 clib_error_report (e);
612 unformat_free (&input);
614 i = vlib_plugin_early_init (vm);
618 unformat_init_command_line (&input, (char **) vm->argv);
619 if (vm->init_functions_called == 0)
620 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
621 e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
624 clib_error_report (e);
627 unformat_free (&input);
629 vlib_thread_stack_init (0);
631 __os_thread_index = 0;
632 vm->thread_index = 0;
634 i = clib_calljmp (thread0, (uword) vm,
635 (void *) (vlib_thread_stacks[0] +
636 VLIB_THREAD_STACK_SIZE));
641 * fd.io coding-style-patch-verification: ON
644 * eval: (c-set-style "gnu")