FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
main.c
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 /*
16  * main.c: Unix main routine
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
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:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
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.
38  */
39 #include <vlib/vlib.h>
40 #include <vlib/unix/unix.h>
41 #include <vlib/unix/plugin.h>
42 
43 #include <signal.h>
44 #include <sys/ucontext.h>
45 #include <syslog.h>
46 #include <sys/types.h>
47 #include <sys/stat.h>
48 #include <fcntl.h>
49 #include <sys/time.h>
50 #include <sys/resource.h>
51 #include <unistd.h>
52 
53 /** Default CLI pager limit is not configured in startup.conf */
54 #define UNIX_CLI_DEFAULT_PAGER_LIMIT 100000
55 
56 /** Default CLI history depth if not configured in startup.conf */
57 #define UNIX_CLI_DEFAULT_HISTORY 50
58 
59 char *vlib_default_runtime_dir __attribute__ ((weak));
60 char *vlib_default_runtime_dir = "vlib";
61 
64 
65 static clib_error_t *
67 {
68  unix_main_t *um = &unix_main;
69  um->vlib_main = vm;
70  return 0;
71 }
72 
73 /* *INDENT-OFF* */
75 {
76  .runs_before = VLIB_INITS ("unix_input_init"),
77 };
78 /* *INDENT-ON* */
79 
80 static int
82 {
83  struct sigaction sa;
84 
85  sa.sa_handler = SIG_DFL;
86  sa.sa_flags = 0;
87  sigemptyset (&sa.sa_mask);
88  return sigaction (sig, &sa, 0);
89 }
90 
91 
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
94  corrupted already */
95 static u8 *syslog_msg = 0;
98 
99 static void
100 unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
101 {
102  uword fatal = 0;
103 
104  /* These come in handy when looking at core files from optimized images */
105  vlib_last_signum = signum;
106  vlib_last_faulting_address = (uword) si->si_addr;
107 
108  syslog_msg = format (syslog_msg, "received signal %U, PC %U",
109  format_signal, signum, format_ucontext_pc, uc);
110 
111  if (signum == SIGSEGV)
112  syslog_msg = format (syslog_msg, ", faulting address %p", si->si_addr);
113 
114  switch (signum)
115  {
116  /* these (caught) signals cause the application to exit */
117  case SIGTERM:
118  /*
119  * Ignore SIGTERM if it's sent before we're ready.
120  */
122  {
123  syslog (LOG_ERR | LOG_DAEMON, "received SIGTERM, exiting...");
125  }
126  else
127  syslog (LOG_ERR | LOG_DAEMON, "IGNORE early SIGTERM...");
128  break;
129  /* fall through */
130  case SIGQUIT:
131  case SIGINT:
132  case SIGILL:
133  case SIGBUS:
134  case SIGSEGV:
135  case SIGHUP:
136  case SIGFPE:
137  case SIGABRT:
138  fatal = 1;
139  break;
140 
141  /* by default, print a message and continue */
142  default:
143  fatal = 0;
144  break;
145  }
146 
147 #ifdef CLIB_GCOV
148  /*
149  * Test framework sends SIGTERM, so we need to flush the
150  * code coverage stats here.
151  */
152  {
153  void __gcov_flush (void);
154  __gcov_flush ();
155  }
156 #endif
157 
158  /* Null terminate. */
159  vec_add1 (syslog_msg, 0);
160 
161  if (fatal)
162  {
163  syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
164 
165  /* Address of callers: outer first, inner last. */
166  uword callers[15];
167  uword n_callers = clib_backtrace (callers, ARRAY_LEN (callers), 0);
168  int i;
169  for (i = 0; i < n_callers; i++)
170  {
172 
173  syslog_msg =
174  format (syslog_msg, "#%-2d 0x%016lx %U%c", i, callers[i],
176 
177  syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
178  }
179 
180  /* have to remove SIGABRT to avoid recursive - os_exit calling abort() */
181  unsetup_signal_handlers (SIGABRT);
182 
183  /* os_exit(1) causes core generation, skip that for SIGINT, SIGHUP */
184  if (signum == SIGINT || signum == SIGHUP)
185  os_exit (0);
186  else
187  os_exit (1);
188  }
189  else
190  clib_warning ("%s", syslog_msg);
191 
192 }
193 
194 static clib_error_t *
196 {
197  uword i;
198  struct sigaction sa;
199 
200  /* give a big enough buffer for msg, most likely it can avoid vec_resize */
201  vec_alloc (syslog_msg, 2048);
202 
203  for (i = 1; i < 32; i++)
204  {
205  clib_memset (&sa, 0, sizeof (sa));
206  sa.sa_sigaction = (void *) unix_signal_handler;
207  sa.sa_flags = SA_SIGINFO;
208 
209  switch (i)
210  {
211  /* these signals take the default action */
212  case SIGKILL:
213  case SIGSTOP:
214  case SIGUSR1:
215  case SIGUSR2:
216  case SIGPROF:
217  continue;
218 
219  /* ignore SIGPIPE, SIGCHLD */
220  case SIGPIPE:
221  case SIGCHLD:
222  sa.sa_sigaction = (void *) SIG_IGN;
223  break;
224 
225  /* catch and handle all other signals */
226  default:
227  break;
228  }
229 
230  if (sigaction (i, &sa, 0) < 0)
231  return clib_error_return_unix (0, "sigaction %U", format_signal, i);
232  }
233 
234  return 0;
235 }
236 
237 static void
238 unix_error_handler (void *arg, u8 * msg, int msg_len)
239 {
240  unix_main_t *um = arg;
241 
242  /* Echo to stderr when interactive or syslog is disabled. */
244  {
245  CLIB_UNUSED (int r) = write (2, msg, msg_len);
246  }
247  else
248  {
249  char save = msg[msg_len - 1];
250 
251  /* Null Terminate. */
252  msg[msg_len - 1] = 0;
253 
254  syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
255 
256  msg[msg_len - 1] = save;
257  }
258 }
259 
260 void
262 {
263  unix_main_t *um = &unix_main;
264 
265  if (um->flags & UNIX_FLAG_INTERACTIVE || error == 0)
266  return;
267 
268  {
269  char save;
270  u8 *msg;
271  u32 msg_len;
272 
273  msg = error->what;
274  msg_len = vec_len (msg);
275 
276  /* Null Terminate. */
277  save = msg[msg_len - 1];
278  msg[msg_len - 1] = 0;
279 
280  syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
281 
282  msg[msg_len - 1] = save;
283  }
284 }
285 
286 static uword
289 {
290  unix_main_t *um = &unix_main;
291  u8 *buf = 0;
292  uword l, n = 1;
293 
294  vlib_process_suspend (vm, 2.0);
295 
296  while (um->unix_config_complete == 0)
297  vlib_process_suspend (vm, 0.1);
298 
299  if (um->startup_config_filename)
300  {
301  unformat_input_t sub_input;
302  int fd;
303  struct stat s;
304  char *fn = (char *) um->startup_config_filename;
305 
306  fd = open (fn, O_RDONLY);
307  if (fd < 0)
308  {
309  clib_warning ("failed to open `%s'", fn);
310  return 0;
311  }
312 
313  if (fstat (fd, &s) < 0)
314  {
315  clib_warning ("failed to stat `%s'", fn);
316  bail:
317  close (fd);
318  return 0;
319  }
320 
321  if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
322  {
323  clib_warning ("not a regular file: `%s'", fn);
324  goto bail;
325  }
326 
327  while (n > 0)
328  {
329  l = vec_len (buf);
330  vec_resize (buf, 4096);
331  n = read (fd, buf + l, 4096);
332  if (n > 0)
333  {
334  _vec_len (buf) = l + n;
335  if (n < 4096)
336  break;
337  }
338  else
339  break;
340  }
341  if (um->log_fd && vec_len (buf))
342  {
343  u8 *lv = 0;
344  lv = format (lv, "%U: ***** Startup Config *****\n%v",
345  format_timeval, 0 /* current bat-time */ ,
346  0 /* current bat-format */ ,
347  buf);
348  {
349  int rv __attribute__ ((unused)) =
350  write (um->log_fd, lv, vec_len (lv));
351  }
352  vec_reset_length (lv);
353  lv = format (lv, "%U: ***** End Startup Config *****\n",
354  format_timeval, 0 /* current bat-time */ ,
355  0 /* current bat-format */ );
356  {
357  int rv __attribute__ ((unused)) =
358  write (um->log_fd, lv, vec_len (lv));
359  }
360  vec_free (lv);
361  }
362 
363  if (vec_len (buf))
364  {
365  unformat_init_vector (&sub_input, buf);
366  vlib_cli_input (vm, &sub_input, 0, 0);
367  /* frees buf for us */
368  unformat_free (&sub_input);
369  }
370  close (fd);
371  }
372  return 0;
373 }
374 
375 /* *INDENT-OFF* */
377  .function = startup_config_process,
378  .type = VLIB_NODE_TYPE_PROCESS,
379  .name = "startup-config-process",
380  .process_log2_n_stack_bytes = 18,
381 };
382 /* *INDENT-ON* */
383 
384 static clib_error_t *
386 {
388  unix_main_t *um = &unix_main;
389  clib_error_t *error = 0;
390  gid_t gid;
391  int pidfd = -1;
392 
393  /* Defaults */
396 
398  {
399  char *cli_prompt;
400  if (unformat (input, "interactive"))
402  else if (unformat (input, "nodaemon"))
403  um->flags |= UNIX_FLAG_NODAEMON;
404  else if (unformat (input, "nosyslog"))
405  um->flags |= UNIX_FLAG_NOSYSLOG;
406  else if (unformat (input, "nocolor"))
407  um->flags |= UNIX_FLAG_NOCOLOR;
408  else if (unformat (input, "nobanner"))
409  um->flags |= UNIX_FLAG_NOBANNER;
410  else if (unformat (input, "cli-prompt %s", &cli_prompt))
411  vlib_unix_cli_set_prompt (cli_prompt);
412  else
413  if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
414  ;
415  else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
416  ;
417  else if (unformat (input, "cli-line-mode"))
418  um->cli_line_mode = 1;
419  else if (unformat (input, "cli-no-banner"))
420  um->cli_no_banner = 1;
421  else if (unformat (input, "cli-no-pager"))
422  um->cli_no_pager = 1;
423  else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
424  ;
425  else if (unformat (input, "cli-pager-buffer-limit %d",
427  ;
428  else
429  if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
430  ;
431  else if (unformat (input, "coredump-size"))
432  {
433  uword coredump_size = 0;
434  if (unformat (input, "unlimited"))
435  {
436  coredump_size = RLIM_INFINITY;
437  }
438  else
439  if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
440  {
441  return clib_error_return (0,
442  "invalid coredump-size parameter `%U'",
443  format_unformat_error, input);
444  }
445  const struct rlimit new_limit = { coredump_size, coredump_size };
446  if (0 != setrlimit (RLIMIT_CORE, &new_limit))
447  {
448  clib_unix_warning ("prlimit() failed");
449  }
450  }
451  else if (unformat (input, "full-coredump"))
452  {
453  int fd;
454 
455  fd = open ("/proc/self/coredump_filter", O_WRONLY);
456  if (fd >= 0)
457  {
458  if (write (fd, "0x6f\n", 5) != 5)
459  clib_unix_warning ("coredump filter write failed!");
460  close (fd);
461  }
462  else
463  clib_unix_warning ("couldn't open /proc/self/coredump_filter");
464  }
465  else if (unformat (input, "startup-config %s",
467  ;
468  else if (unformat (input, "exec %s", &um->startup_config_filename))
469  ;
470  else if (unformat (input, "log %s", &um->log_filename))
471  {
472  um->log_fd = open ((char *) um->log_filename,
473  O_CREAT | O_WRONLY | O_APPEND, 0644);
474  if (um->log_fd < 0)
475  {
476  clib_warning ("couldn't open log '%s'\n", um->log_filename);
477  um->log_fd = 0;
478  }
479  else
480  {
481  u8 *lv = 0;
482  lv = format (0, "%U: ***** Start: PID %d *****\n",
483  format_timeval, 0 /* current bat-time */ ,
484  0 /* current bat-format */ ,
485  getpid ());
486  {
487  int rv __attribute__ ((unused)) =
488  write (um->log_fd, lv, vec_len (lv));
489  }
490  vec_free (lv);
491  }
492  }
493  else if (unformat (input, "gid %U", unformat_unix_gid, &gid))
494  {
495  if (setegid (gid) == -1)
496  return clib_error_return_unix (0, "setegid");
497  }
498  else if (unformat (input, "pidfile %s", &um->pidfile))
499  ;
500  else
501  return clib_error_return (0, "unknown input `%U'",
502  format_unformat_error, input);
503  }
504 
505  if (um->runtime_dir == 0)
506  {
507  uid_t uid = geteuid ();
508  if (uid == 00)
509  um->runtime_dir = format (0, "/run/%s%c",
511  else
512  um->runtime_dir = format (0, "/run/user/%u/%s%c", uid,
514  }
515 
516  /* Ensure the runtime directory is created */
518  if (error)
519  return error;
520 
522  if (error)
523  return error;
524 
525  if (um->pidfile)
526  {
528  (char *) um->pidfile,
529  &um->pidfile)))
530  return error;
531 
532  if (((pidfd = open ((char *) um->pidfile,
533  O_CREAT | O_WRONLY | O_TRUNC, 0644)) < 0))
534  {
535  return clib_error_return_unix (0, "open");
536  }
537  }
538 
540  {
541  openlog (vgm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
543 
544  if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
545  /* stdin/stdout/stderr -> /dev/null */
546  0) < 0)
547  clib_error_return (0, "daemon () fails");
548  }
549 
550  if (pidfd >= 0)
551  {
552  u8 *lv = format (0, "%d", getpid ());
553  if (write (pidfd, (char *) lv, vec_len (lv)) != vec_len (lv))
554  {
555  vec_free (lv);
556  close (pidfd);
557  return clib_error_return_unix (0, "write");
558  }
559  vec_free (lv);
560  close (pidfd);
561  }
562 
563  um->unix_config_complete = 1;
564 
565  return 0;
566 }
567 
568 /* unix { ... } configuration. */
569 /*?
570  *
571  * @cfgcmd{interactive}
572  * Attach CLI to stdin/out and provide a debugging command line interface.
573  * Implies @c nodaemon.
574  *
575  * @cfgcmd{nodaemon}
576  * Do not fork or background the VPP process. Typically used when invoking
577  * VPP applications from a process monitor.
578  *
579  * @cfgcmd{nosyslog}
580  * Do not send e.g. clib_warning(...) output to syslog. Used
581  * when invoking VPP applications from a process monitor which
582  * pipe stdout/stderr to a dedicated logger service.
583  *
584  * @cfgcmd{nocolor}
585  * Do not use colors in outputs.
586  * *
587  * @cfgcmd{nobanner}
588  * Do not display startup banner.
589  *
590  * @cfgcmd{exec, &lt;filename&gt;}
591  * @par <code>startup-config &lt;filename&gt;</code>
592  * Read startup operational configuration from @c filename.
593  * The contents of the file will be performed as though entered at the CLI.
594  * The two keywords are aliases for the same function; if both are specified,
595  * only the last will have an effect.
596  *
597  * @cfgcmd{log, &lt;filename&gt;}
598  * Logs the startup configuration and all subsequent CLI commands in
599  * @c filename.
600  * Very useful in situations where folks don't remember or can't be bothered
601  * to include CLI commands in bug reports.
602  *
603  * @cfgcmd{pidfile, &lt;filename&gt;}
604  * Writes the pid of the main thread in @c filename.
605  *
606  * @cfgcmd{full-coredump}
607  * Ask the Linux kernel to dump all memory-mapped address regions, instead
608  * of just text+data+bss.
609  *
610  * @cfgcmd{runtime-dir}
611  * Define directory where VPP is going to store all runtime files.
612  * Default is /run/vpp when running as root, /run/user/<UID>/vpp if running as
613  * an unprivileged user.
614  *
615  * @cfgcmd{cli-listen, &lt;address:port&gt;}
616  * Bind the CLI to listen at the address and port given. @c localhost
617  * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
618  * is typical.
619  *
620  * @cfgcmd{cli-line-mode}
621  * Disable character-by-character I/O on stdin. Useful when combined with,
622  * for example, <tt>emacs M-x gud-gdb</tt>.
623  *
624  * @cfgcmd{cli-prompt, &lt;string&gt;}
625  * Configure the CLI prompt to be @c string.
626  *
627  * @cfgcmd{cli-history-limit, &lt;nn&gt;}
628  * Limit command history to @c nn lines. A value of @c 0
629  * disables command history. Default value: @c 50
630  *
631  * @cfgcmd{cli-no-banner}
632  * Disable the login banner on stdin and Telnet connections.
633  *
634  * @cfgcmd{cli-no-pager}
635  * Disable the output pager.
636  *
637  * @cfgcmd{cli-pager-buffer-limit, &lt;nn&gt;}
638  * Limit pager buffer to @c nn lines of output.
639  * A value of @c 0 disables the pager. Default value: @c 100000
640  *
641  * @cfgcmd{gid, &lt;nn&gt;}
642  * Set the effective gid under which the vpp process is to run.
643  *
644  * @cfgcmd{poll-sleep-usec, &lt;nn&gt;}
645  * Set a fixed poll sleep interval between main loop polls.
646 ?*/
648 
649 static clib_error_t *
651 {
652  /* Close syslog connection. */
653  closelog ();
654  return 0;
655 }
656 
658 
660 
661 static uword
663 {
664  vlib_main_t *vm = (vlib_main_t *) arg;
665  unformat_input_t input;
666  int i;
667 
669 
670  unformat_init_command_line (&input, (char **) vm->argv);
671  i = vlib_main (vm, &input);
672  unformat_free (&input);
673 
674  return i;
675 }
676 
677 u8 *
679 {
680  void *stack;
684  "thread stack: thread %u", thread_index);
685 
686  if (stack == CLIB_MEM_VM_MAP_FAILED)
687  clib_panic ("failed to allocate thread %u stack", thread_index);
688 
690  return stack;
691 }
692 
693 int
694 vlib_unix_main (int argc, char *argv[])
695 {
697  vlib_main_t *vm = vlib_get_first_main (); /* one and only time for this! */
698  unformat_input_t input;
699  clib_error_t *e;
700  int i;
701 
703 
704  vm->argv = (u8 **) argv;
705  vgm->name = argv[0];
707  vm->heap_aligned_base = (void *)
708  (((uword) vm->heap_base) & ~(VLIB_FRAME_ALIGN - 1));
709  ASSERT (vm->heap_base);
710 
712 
713  /* Turn on the event logger at the first possible moment */
714  vgm->configured_elog_ring_size = 128 << 10;
717 
718  unformat_init_command_line (&input, (char **) vm->argv);
719  if ((e = vlib_plugin_config (vm, &input)))
720  {
721  clib_error_report (e);
722  return 1;
723  }
724  unformat_free (&input);
725 
727  if (i)
728  return i;
729 
730  unformat_init_command_line (&input, (char **) vm->argv);
731  if (vgm->init_functions_called == 0)
732  vgm->init_functions_called = hash_create (0, /* value bytes */ 0);
733  e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
734  if (e != 0)
735  {
736  clib_error_report (e);
737  return 1;
738  }
739  unformat_free (&input);
740 
741  /* always load symbols, for signal handler and mheap memory get/put backtrace */
742  clib_elf_main_init (vgm->name);
743 
746 
747  __os_thread_index = 0;
748  vm->thread_index = 0;
749 
751  i = clib_calljmp (thread0, (uword) vm,
752  (void *) (vlib_thread_stacks[0] +
754  return i;
755 }
756 
757 /*
758  * fd.io coding-style-patch-verification: ON
759  *
760  * Local Variables:
761  * eval: (c-set-style "gnu")
762  * End:
763  */
vec_reset_length
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
Definition: vec_bootstrap.h:194
vlib_thread_stacks
u8 ** vlib_thread_stacks
Definition: main.c:659
vlib.h
clib_calljmp
uword clib_calljmp(uword(*func)(uword func_arg), uword func_arg, void *stack)
unix_main_t::unix_config_complete
volatile int unix_config_complete
Definition: unix.h:85
unix_main_t::flags
u32 flags
Definition: unix.h:58
file_main
clib_file_main_t file_main
Definition: main.c:63
format_timeval
u8 * format_timeval(u8 *s, va_list *args)
Definition: unix-formats.c:288
unformat_init_vector
void unformat_init_vector(unformat_input_t *input, u8 *vector_string)
Definition: unformat.c:1037
thread_index
u32 thread_index
Definition: nat44_ei_hairpinning.c:492
vlib_global_main_t
Definition: main.h:274
setup_signal_handlers
static clib_error_t * setup_signal_handlers(unix_main_t *um)
Definition: main.c:195
clib_mem_get_heap
static clib_mem_heap_t * clib_mem_get_heap(void)
Definition: mem.h:359
vlib_main_t::clib_time
clib_time_t clib_time
Definition: main.h:106
UNIX_FLAG_NOCOLOR
#define UNIX_FLAG_NOCOLOR
Definition: unix.h:63
vlib_last_faulting_address
uword vlib_last_faulting_address
Definition: main.c:97
format_signal
u8 * format_signal(u8 *s, va_list *args)
Definition: unix-formats.c:375
vlib_process_finish_switch_stack
static_always_inline void vlib_process_finish_switch_stack(vlib_main_t *vm)
Definition: node_funcs.h:67
f
vlib_frame_t * f
Definition: interface_output.c:1080
unix_main
unix_main_t unix_main
Definition: main.c:62
vlib_unix_validate_runtime_file
clib_error_t * vlib_unix_validate_runtime_file(unix_main_t *um, const char *path, u8 **full_path)
Definition: util.c:138
syslog_msg
static u8 * syslog_msg
Definition: main.c:95
unix_config
static clib_error_t * unix_config(vlib_main_t *vm, unformat_input_t *input)
Definition: main.c:385
vlib_main_t::heap_aligned_base
void * heap_aligned_base
Definition: main.h:159
clib_error_return
#define clib_error_return(e, args...)
Definition: error.h:99
vec_alloc
#define vec_alloc(V, N)
Allocate space for N more elements (no header, unspecified alignment)
Definition: vec.h:334
unix_main_t
Definition: unix.h:53
startup_config_process
static uword startup_config_process(vlib_main_t *vm, vlib_node_runtime_t *rt, vlib_frame_t *f)
Definition: main.c:287
vm
vlib_main_t * vm
X-connect all packets from the HOST to the PHY.
Definition: nat44_ei.c:3047
plugin.h
clib_file_main_t
Definition: file.h:85
clib_error_report
#define clib_error_report(e)
Definition: error.h:113
unformat_input_t
struct _unformat_input_t unformat_input_t
CLIB_MEM_VM_MAP_FAILED
#define CLIB_MEM_VM_MAP_FAILED
Definition: mem.h:54
r
vnet_hw_if_output_node_runtime_t * r
Definition: interface_output.c:1071
vlib_frame_t
Definition: node.h:372
hash_create
#define hash_create(elts, value_bytes)
Definition: hash.h:695
unix_main_t::runtime_dir
u8 * runtime_dir
Definition: unix.h:79
unix_main_init
static clib_error_t * unix_main_init(vlib_main_t *vm)
Definition: main.c:66
unix_main_t::log_fd
int log_fd
Definition: unix.h:89
vlib_get_global_main
static vlib_global_main_t * vlib_get_global_main(void)
Definition: global_funcs.h:50
clib_unix_warning
#define clib_unix_warning(format, args...)
Definition: error.h:68
error
Definition: cJSON.c:88
vlib_global_main_t::name
char * name
Definition: main.h:282
VLIB_EARLY_CONFIG_FUNCTION
#define VLIB_EARLY_CONFIG_FUNCTION(x, n,...)
Definition: init.h:220
unix_exit
static clib_error_t * unix_exit(vlib_main_t *vm)
Definition: main.c:650
clib_time_init
__clib_export void clib_time_init(clib_time_t *c)
Definition: time.c:207
UNIX_CLI_DEFAULT_PAGER_LIMIT
#define UNIX_CLI_DEFAULT_PAGER_LIMIT
Default CLI pager limit is not configured in startup.conf.
Definition: main.c:54
format_ucontext_pc
u8 * format_ucontext_pc(u8 *s, va_list *args)
Definition: unix-formats.c:426
vlib_unix_main
int vlib_unix_main(int argc, char *argv[])
Definition: main.c:694
unformat
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
UNIX_FLAG_NOSYSLOG
#define UNIX_FLAG_NOSYSLOG
Definition: unix.h:62
unix_main_t::vlib_main
vlib_main_t * vlib_main
Definition: unix.h:56
unix_main_t::pidfile
u8 * pidfile
Definition: unix.h:82
vlib_main_t::argv
u8 ** argv
Definition: main.h:221
unix_main_t::cli_listen_socket
clib_socket_t cli_listen_socket
Definition: unix.h:68
unformat_memory_size
unformat_function_t unformat_memory_size
Definition: format.h:288
vec_len
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
Definition: vec_bootstrap.h:142
unformat_free
static void unformat_free(unformat_input_t *i)
Definition: format.h:155
vlib_main_t::main_loop_exit_now
volatile u32 main_loop_exit_now
Definition: main.h:145
vec_add1
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:606
CLIB_UNUSED
#define CLIB_UNUSED(x)
Definition: clib.h:90
ARRAY_LEN
#define ARRAY_LEN(x)
Definition: clib.h:70
unformat_check_input
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:163
vlib_config_function_runtime_t
Definition: init.h:68
vec_validate_aligned
#define vec_validate_aligned(V, I, A)
Make sure vector is long enough for given index (no header, specified alignment)
Definition: vec.h:534
unix_main_t::cli_pager_buffer_limit
u32 cli_pager_buffer_limit
Definition: unix.h:101
vlib_thread_stack_init
u8 * vlib_thread_stack_init(uword thread_index)
Definition: main.c:678
uword
u64 uword
Definition: types.h:112
vlib_cli_input
int vlib_cli_input(vlib_main_t *vm, unformat_input_t *input, vlib_cli_output_function_t *function, uword function_arg)
Definition: cli.c:675
unix_main_t::poll_sleep_usec
u32 poll_sleep_usec
Definition: unix.h:110
vlib_main_t::thread_index
u32 thread_index
Definition: main.h:213
vlib_get_elog_main
static elog_main_t * vlib_get_elog_main()
Definition: global_funcs.h:62
i
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:261
unix_signal_handler
static void unix_signal_handler(int signum, siginfo_t *si, ucontext_t *uc)
Definition: main.c:100
UNIX_CLI_DEFAULT_HISTORY
#define UNIX_CLI_DEFAULT_HISTORY
Default CLI history depth if not configured in startup.conf.
Definition: main.c:57
vlib_process_start_switch_stack
static_always_inline void vlib_process_start_switch_stack(vlib_main_t *vm, vlib_process_t *p)
Definition: node_funcs.h:57
format_unformat_error
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
unix_error_handler
static void unix_error_handler(void *arg, u8 *msg, int msg_len)
Definition: main.c:238
clib_error_register_handler
__clib_export void clib_error_register_handler(clib_error_handler_func_t func, void *arg)
Definition: error.c:75
vec_validate
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment)
Definition: vec.h:523
vlib_unix_recursive_mkdir
clib_error_t * vlib_unix_recursive_mkdir(char *path)
Definition: util.c:103
vlib_plugin_early_init
int vlib_plugin_early_init(vlib_main_t *vm)
Definition: plugin.c:587
unix_main_t::log_filename
u8 * log_filename
Definition: unix.h:88
format_clib_elf_symbol_with_address
format_function_t format_clib_elf_symbol_with_address
Definition: elf_clib.h:134
startup_config_node
static vlib_node_registration_t startup_config_node
(constructor) VLIB_REGISTER_NODE (startup_config_node)
Definition: main.c:376
CLIB_CACHE_LINE_BYTES
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
vlib_node_registration_t
struct _vlib_node_registration vlib_node_registration_t
syslog.h
unsetup_signal_handlers
static int unsetup_signal_handlers(int sig)
Definition: main.c:81
vlib_last_signum
int vlib_last_signum
Definition: main.c:96
vlib_call_all_config_functions
clib_error_t * vlib_call_all_config_functions(vlib_main_t *vm, unformat_input_t *input, int is_early)
Definition: init.c:423
unformat_unix_gid
unformat_function_t unformat_unix_gid
Definition: format.h:315
vec_free
#define vec_free(V)
Free vector's memory (no header).
Definition: vec.h:395
unix_main_t::startup_config_filename
u8 * startup_config_filename
Definition: unix.h:76
VLIB_FRAME_ALIGN
#define VLIB_FRAME_ALIGN
Definition: node.h:369
format
description fragment has unexpected format
Definition: map.api:433
ASSERT
#define ASSERT(truth)
Definition: error_bootstrap.h:69
VLIB_THREAD_STACK_SIZE
#define VLIB_THREAD_STACK_SIZE
Definition: threads.h:65
vlib_process_suspend
static uword vlib_process_suspend(vlib_main_t *vm, f64 dt)
Suspend a vlib cooperative multi-tasking thread for a period of time.
Definition: node_funcs.h:486
buf
u64 buf
Definition: application.c:493
u32
unsigned int u32
Definition: types.h:88
VLIB_INIT_FUNCTION
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:172
unix_main_t::cli_history_limit
u32 cli_history_limit
Definition: unix.h:95
CLIB_MEM_PAGE_SZ_DEFAULT
@ CLIB_MEM_PAGE_SZ_DEFAULT
Definition: mem.h:60
clib_elf_main_init
__clib_export void clib_elf_main_init(char *exec_path)
Definition: elf_clib.c:263
clib_backtrace
__clib_export uword clib_backtrace(uword *callers, uword max_callers, uword n_frames_to_skip)
Definition: backtrace.c:226
vlib_get_first_main
static vlib_main_t * vlib_get_first_main(void)
Definition: global_funcs.h:44
si
vnet_sw_interface_t * si
Definition: interface_output.c:398
elog_init
__clib_export void elog_init(elog_main_t *em, u32 n_events)
Definition: elog.c:513
VLIB_NODE_TYPE_PROCESS
@ VLIB_NODE_TYPE_PROCESS
Definition: node.h:84
clib_error_return_unix
#define clib_error_return_unix(e, args...)
Definition: error.h:102
vec_resize
#define vec_resize(V, N)
Resize a vector (no header, unspecified alignment) Add N elements to end of given vector V,...
Definition: vec.h:296
unix_main_t::cli_no_banner
int cli_no_banner
Definition: unix.h:98
vlib_main_t::heap_base
void * heap_base
Definition: main.h:156
clib_memset
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
vlib_main_t
Definition: main.h:102
VLIB_INITS
#define VLIB_INITS(...)
Definition: init.h:352
u8
unsigned char u8
Definition: types.h:56
clib_error_t
Definition: clib_error.h:21
unix.h
rt
vnet_interface_output_runtime_t * rt
Definition: interface_output.c:399
vlib_init_function_t
clib_error_t *() vlib_init_function_t(struct vlib_main_t *vm)
Definition: init.h:51
unix_main_t::cli_no_pager
int cli_no_pager
Definition: unix.h:104
unformat_init_command_line
void unformat_init_command_line(unformat_input_t *input, char *argv[])
Definition: unformat.c:1013
UNIX_FLAG_NODAEMON
#define UNIX_FLAG_NODAEMON
Definition: unix.h:61
clib_warning
#define clib_warning(format, args...)
Definition: error.h:59
clib_mem_vm_map_stack
__clib_export void * clib_mem_vm_map_stack(uword size, clib_mem_page_sz_t log2_page_sz, char *fmt,...)
Definition: mem.c:42
UNIX_FLAG_INTERACTIVE
#define UNIX_FLAG_INTERACTIVE
Definition: unix.h:60
rv
int __clib_unused rv
Definition: application.c:491
vlib_global_main_t::init_functions_called
uword * init_functions_called
Definition: main.h:315
vlib_main
int vlib_main(vlib_main_t *volatile vm, unformat_input_t *input)
Definition: main.c:1914
VLIB_MAIN_LOOP_EXIT_FUNCTION
#define VLIB_MAIN_LOOP_EXIT_FUNCTION(x)
Definition: init.h:177
os_exit
void os_exit(int code)
Definition: main.c:417
UNIX_FLAG_NOBANNER
#define UNIX_FLAG_NOBANNER
Definition: unix.h:64
vlib_unix_error_report
void vlib_unix_error_report(vlib_main_t *vm, clib_error_t *error)
Definition: main.c:261
vlib_node_runtime_t
Definition: node.h:454
clib_panic
#define clib_panic(format, args...)
Definition: error.h:72
vlib_plugin_config
clib_error_t * vlib_plugin_config(vlib_main_t *vm, unformat_input_t *input)
Definition: plugin.c:720
vlib_main_t::main_loop_exit_set
u32 main_loop_exit_set
Definition: main.h:143
unix_main_t::cli_line_mode
int cli_line_mode
Definition: unix.h:92
vlib_global_main_t::vlib_mains
vlib_main_t ** vlib_mains
Definition: main.h:279
elog_enable_disable
static void elog_enable_disable(elog_main_t *em, int is_enabled)
Enable or disable event logging.
Definition: elog.h:220
vlib_unix_cli_set_prompt
void vlib_unix_cli_set_prompt(char *prompt)
Set the CLI prompt.
Definition: cli.c:3277
vlib_global_main_t::configured_elog_ring_size
u32 configured_elog_ring_size
Definition: main.h:301
UNFORMAT_END_OF_INPUT
#define UNFORMAT_END_OF_INPUT
Definition: format.h:137
vlib_default_runtime_dir
char * vlib_default_runtime_dir
Definition: main.c:59
thread0
static uword thread0(uword arg)
Definition: main.c:662
VLIB_REGISTER_NODE
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169