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>
52 /** Default CLI pager limit is not configured in startup.conf */
53 #define UNIX_CLI_DEFAULT_PAGER_LIMIT 100000
55 /** Default CLI history depth if not configured in startup.conf */
56 #define UNIX_CLI_DEFAULT_HISTORY 50
59 unix_main_t unix_main;
62 unix_main_init (vlib_main_t * vm)
64 unix_main_t *um = &unix_main;
66 return vlib_call_init_function (vm, unix_input_init);
69 VLIB_INIT_FUNCTION (unix_main_init);
72 unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
77 msg = format (msg, "received signal %U, PC %U",
78 format_signal, signum, format_ucontext_pc, uc);
80 if (signum == SIGSEGV)
81 msg = format (msg, ", faulting address %p", si->si_addr);
85 /* these (caught) signals cause the application to exit */
87 if (unix_main.vlib_main->main_loop_exit_set)
89 syslog (LOG_ERR | LOG_DAEMON, "received SIGTERM, exiting...");
91 clib_longjmp (&unix_main.vlib_main->main_loop_exit,
92 VLIB_MAIN_LOOP_EXIT_CLI);
105 /* by default, print a message and continue */
111 /* Null terminate. */
116 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
120 clib_warning ("%s", msg);
125 static clib_error_t *
126 setup_signal_handlers (unix_main_t * um)
131 for (i = 1; i < 32; i++)
133 memset (&sa, 0, sizeof (sa));
134 sa.sa_sigaction = (void *) unix_signal_handler;
135 sa.sa_flags = SA_SIGINFO;
139 /* these signals take the default action */
147 /* ignore SIGPIPE, SIGCHLD */
150 sa.sa_sigaction = (void *) SIG_IGN;
153 /* catch and handle all other signals */
158 if (sigaction (i, &sa, 0) < 0)
159 return clib_error_return_unix (0, "sigaction %U", format_signal, i);
166 unix_error_handler (void *arg, u8 * msg, int msg_len)
168 unix_main_t *um = arg;
170 /* Echo to stderr when interactive. */
171 if (um->flags & UNIX_FLAG_INTERACTIVE)
173 CLIB_UNUSED (int r) = write (2, msg, msg_len);
177 char save = msg[msg_len - 1];
179 /* Null Terminate. */
180 msg[msg_len - 1] = 0;
182 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
184 msg[msg_len - 1] = save;
189 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
191 unix_main_t *um = &unix_main;
193 if (um->flags & UNIX_FLAG_INTERACTIVE || error == 0)
202 msg_len = vec_len (msg);
204 /* Null Terminate. */
205 save = msg[msg_len - 1];
206 msg[msg_len - 1] = 0;
208 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
210 msg[msg_len - 1] = save;
215 startup_config_process (vlib_main_t * vm,
216 vlib_node_runtime_t * rt, vlib_frame_t * f)
218 unix_main_t *um = &unix_main;
222 vlib_process_suspend (vm, 2.0);
224 while (um->unix_config_complete == 0)
225 vlib_process_suspend (vm, 0.1);
227 if (um->startup_config_filename)
229 unformat_input_t sub_input;
232 char *fn = (char *) um->startup_config_filename;
234 fd = open (fn, O_RDONLY);
237 clib_warning ("failed to open `%s'", fn);
241 if (fstat (fd, &s) < 0)
243 clib_warning ("failed to stat `%s'", fn);
249 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
251 clib_warning ("not a regular file: `%s'", fn);
258 vec_resize (buf, 4096);
259 n = read (fd, buf + l, 4096);
262 _vec_len (buf) = l + n;
269 if (um->log_fd && vec_len (buf))
272 lv = format (lv, "%U: ***** Startup Config *****\n%v",
273 format_timeval, 0 /* current bat-time */ ,
274 0 /* current bat-format */ ,
277 int rv __attribute__ ((unused)) =
278 write (um->log_fd, lv, vec_len (lv));
280 vec_reset_length (lv);
281 lv = format (lv, "%U: ***** End Startup Config *****\n",
282 format_timeval, 0 /* current bat-time */ ,
283 0 /* current bat-format */ );
285 int rv __attribute__ ((unused)) =
286 write (um->log_fd, lv, vec_len (lv));
293 unformat_init_vector (&sub_input, buf);
294 vlib_cli_input (vm, &sub_input, 0, 0);
295 /* frees buf for us */
296 unformat_free (&sub_input);
304 VLIB_REGISTER_NODE (startup_config_node,static) = {
305 .function = startup_config_process,
306 .type = VLIB_NODE_TYPE_PROCESS,
307 .name = "startup-config-process",
311 static clib_error_t *
312 unix_config (vlib_main_t * vm, unformat_input_t * input)
314 unix_main_t *um = &unix_main;
315 clib_error_t *error = 0;
318 um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
319 um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
321 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
324 if (unformat (input, "interactive"))
325 um->flags |= UNIX_FLAG_INTERACTIVE;
326 else if (unformat (input, "nodaemon"))
327 um->flags |= UNIX_FLAG_NODAEMON;
328 else if (unformat (input, "cli-prompt %s", &cli_prompt))
329 vlib_unix_cli_set_prompt (cli_prompt);
331 if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
333 else if (unformat (input, "cli-line-mode"))
334 um->cli_line_mode = 1;
335 else if (unformat (input, "cli-no-banner"))
336 um->cli_no_banner = 1;
337 else if (unformat (input, "cli-no-pager"))
338 um->cli_no_pager = 1;
339 else if (unformat (input, "cli-pager-buffer-limit %d",
340 &um->cli_pager_buffer_limit))
343 if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
345 else if (unformat (input, "coredump-size"))
347 uword coredump_size = 0;
348 if (unformat (input, "unlimited"))
350 coredump_size = RLIM_INFINITY;
353 if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
355 return clib_error_return (0,
356 "invalid coredump-size parameter `%U'",
357 format_unformat_error, input);
359 const struct rlimit new_limit = { coredump_size, coredump_size };
360 if (0 != setrlimit (RLIMIT_CORE, &new_limit))
362 clib_unix_warning ("prlimit() failed");
365 else if (unformat (input, "full-coredump"))
369 fd = open ("/proc/self/coredump_filter", O_WRONLY);
372 if (write (fd, "0x6f\n", 5) != 5)
373 clib_unix_warning ("coredump filter write failed!");
377 clib_unix_warning ("couldn't open /proc/self/coredump_filter");
379 else if (unformat (input, "startup-config %s",
380 &um->startup_config_filename))
382 else if (unformat (input, "exec %s", &um->startup_config_filename))
384 else if (unformat (input, "log %s", &um->log_filename))
386 um->log_fd = open ((char *) um->log_filename,
387 O_CREAT | O_WRONLY | O_APPEND, 0644);
390 clib_warning ("couldn't open log '%s'\n", um->log_filename);
396 lv = format (0, "%U: ***** Start: PID %d *****\n",
397 format_timeval, 0 /* current bat-time */ ,
398 0 /* current bat-format */ ,
401 int rv __attribute__ ((unused)) =
402 write (um->log_fd, lv, vec_len (lv));
408 return clib_error_return (0, "unknown input `%U'",
409 format_unformat_error, input);
412 if (!(um->flags & UNIX_FLAG_INTERACTIVE))
414 error = setup_signal_handlers (um);
418 openlog (vm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
419 clib_error_register_handler (unix_error_handler, um);
421 if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
422 /* stdin/stdout/stderr -> /dev/null */
424 clib_error_return (0, "daemon () fails");
426 um->unix_config_complete = 1;
431 /* unix { ... } configuration. */
434 * @cfgcmd{interactive}
435 * Attach CLI to stdin/out and provide a debugging command line interface.
436 * Implies @c nodaemon.
439 * Do not fork or background the VPP process. Typically used when invoking
440 * VPP applications from a process monitor.
442 * @cfgcmd{exec, <filename>}
443 * @par <code>startup-config <filename></code>
444 * Read startup operational configuration from @c filename.
445 * The contents of the file will be performed as though entered at the CLI.
446 * The two keywords are aliases for the same function; if both are specified,
447 * only the last will have an effect.
449 * @cfgcmd{log, <filename>}
450 * Logs the startup configuration and all subsequent CLI commands in
452 * Very useful in situations where folks don't remember or can't be bothered
453 * to include CLI commands in bug reports.
455 * @cfgcmd{full-coredump}
456 * Ask the Linux kernel to dump all memory-mapped address regions, instead
457 * of just text+data+bss.
459 * @cfgcmd{cli-listen, <address:port>}
460 * Bind the CLI to listen at the address and port given. @clocalhost
461 * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
464 * @cfgcmd{cli-line-mode}
465 * Disable character-by-character I/O on stdin. Useful when combined with,
466 * for example, <tt>emacs M-x gud-gdb</tt>.
468 * @cfgcmd{cli-prompt, <string>}
469 * Configure the CLI prompt to be @c string.
471 * @cfgcmd{cli-history-limit, <nn>}
472 * Limit commmand history to @c nn lines. A value of @c 0
473 * disables command history. Default value: @c 50
475 * @cfgcmd{cli-no-banner}
476 * Disable the login banner on stdin and Telnet connections.
478 * @cfgcmd{cli-no-pager}
479 * Disable the output pager.
481 * @cfgcmd{cli-pager-buffer-limit, <nn>}
482 * Limit pager buffer to @c nn lines of output.
483 * A value of @c 0 disables the pager. Default value: @c 100000
485 VLIB_CONFIG_FUNCTION (unix_config, "unix");
487 static clib_error_t *
488 unix_exit (vlib_main_t * vm)
490 /* Close syslog connection. */
495 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
497 u8 **vlib_thread_stacks;
502 vlib_main_t *vm = (vlib_main_t *) arg;
503 unformat_input_t input;
506 unformat_init_command_line (&input, (char **) vm->argv);
507 i = vlib_main (vm, &input);
508 unformat_free (&input);
514 vlib_unix_main (int argc, char *argv[])
516 vlib_main_t *vm = &vlib_global_main; /* one and only time for this! */
517 vlib_thread_main_t *tm = &vlib_thread_main;
518 unformat_input_t input;
523 vm->argv = (u8 **) argv;
525 vm->heap_base = clib_mem_get_heap ();
526 ASSERT (vm->heap_base);
528 unformat_init_command_line (&input, (char **) vm->argv);
529 if ((e = vlib_plugin_config (vm, &input)))
531 clib_error_report (e);
534 unformat_free (&input);
536 i = vlib_plugin_early_init (vm);
540 unformat_init_command_line (&input, (char **) vm->argv);
541 if (vm->init_functions_called == 0)
542 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
543 e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
546 clib_error_report (e);
549 unformat_free (&input);
552 * allocate n x VLIB_THREAD_STACK_SIZE stacks, aligned to a
553 * VLIB_THREAD_STACK_SIZE boundary
554 * See also: os_get_cpu_number() in vlib/vlib/threads.c
556 thread_stacks = clib_mem_alloc_aligned
557 ((uword) tm->n_thread_stacks * VLIB_THREAD_STACK_SIZE,
558 VLIB_THREAD_STACK_SIZE);
560 vec_validate (vlib_thread_stacks, tm->n_thread_stacks - 1);
561 for (i = 0; i < vec_len (vlib_thread_stacks); i++)
563 vlib_thread_stacks[i] = thread_stacks;
566 * Disallow writes to the bottom page of the stack, to
567 * catch stack overflows.
569 if (mprotect (thread_stacks, clib_mem_get_page_size (), PROT_READ) < 0)
570 clib_unix_warning ("thread stack");
572 thread_stacks += VLIB_THREAD_STACK_SIZE;
575 i = clib_calljmp (thread0, (uword) vm,
576 (void *) (vlib_thread_stacks[0] +
577 VLIB_THREAD_STACK_SIZE));
582 * fd.io coding-style-patch-verification: ON
585 * eval: (c-set-style "gnu")