blob: 24208617fa4488171771fb8e0540d7dca1ed2b61 [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
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>
Klement Sekerac8c44eb2017-03-02 11:13:30 +010049#include <sys/time.h>
50#include <sys/resource.h>
Damjan Mariona54230d2017-06-21 11:57:07 +020051#include <unistd.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070052
Chris Luke7afda3a2016-04-25 13:49:22 -040053/** 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
Damjan Marion57d963f2017-07-20 19:17:06 +020059char *vlib_default_runtime_dir __attribute__ ((weak));
Damjan Marionc67787b2017-08-30 17:12:25 +020060char *vlib_default_runtime_dir = "vlib";
Chris Luke7afda3a2016-04-25 13:49:22 -040061
Ed Warnickecb9cada2015-12-08 15:45:58 -070062unix_main_t unix_main;
Damjan Marion56dd5432017-09-08 19:52:02 +020063clib_file_main_t file_main;
Damjan Marion88c06212018-03-05 20:08:28 +010064vlib_physmem_main_t physmem_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -070065
66static clib_error_t *
67unix_main_init (vlib_main_t * vm)
68{
Dave Barach9b8ffd92016-07-08 08:13:45 -040069 unix_main_t *um = &unix_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -070070 um->vlib_main = vm;
71 return vlib_call_init_function (vm, unix_input_init);
72}
73
74VLIB_INIT_FUNCTION (unix_main_init);
75
Kingwel Xie497deaf2018-06-15 04:56:24 -040076static int
77unsetup_signal_handlers (int sig)
78{
79 struct sigaction sa;
80
81 sa.sa_handler = SIG_DFL;
82 sa.sa_flags = 0;
83 sigemptyset (&sa.sa_mask);
84 return sigaction (sig, &sa, 0);
85}
86
87
88/* allocate this buffer from mheap when setting up the signal handler.
89 dangerous to vec_resize it when crashing, mheap itself might have been
90 corruptted already */
91static u8 *syslog_msg = 0;
92
Dave Barach9b8ffd92016-07-08 08:13:45 -040093static void
94unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
Ed Warnickecb9cada2015-12-08 15:45:58 -070095{
Dave Barach903651c2017-10-13 19:16:56 -040096 uword fatal = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -070097
Kingwel Xie497deaf2018-06-15 04:56:24 -040098 syslog_msg = format (syslog_msg, "received signal %U, PC %U",
99 format_signal, signum, format_ucontext_pc, uc);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700100
101 if (signum == SIGSEGV)
Kingwel Xie497deaf2018-06-15 04:56:24 -0400102 syslog_msg = format (syslog_msg, ", faulting address %p", si->si_addr);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700103
104 switch (signum)
105 {
106 /* these (caught) signals cause the application to exit */
107 case SIGTERM:
Dave Barach9b8ffd92016-07-08 08:13:45 -0400108 if (unix_main.vlib_main->main_loop_exit_set)
109 {
110 syslog (LOG_ERR | LOG_DAEMON, "received SIGTERM, exiting...");
Dave Barach903651c2017-10-13 19:16:56 -0400111 unix_main.vlib_main->main_loop_exit_now = 1;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400112 }
Dave Barach903651c2017-10-13 19:16:56 -0400113 break;
Dave Barachb2a6e252016-07-27 10:00:58 -0400114 /* fall through */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700115 case SIGQUIT:
116 case SIGINT:
117 case SIGILL:
118 case SIGBUS:
119 case SIGSEGV:
120 case SIGHUP:
121 case SIGFPE:
Kingwel Xie497deaf2018-06-15 04:56:24 -0400122 case SIGABRT:
Ed Warnickecb9cada2015-12-08 15:45:58 -0700123 fatal = 1;
124 break;
125
126 /* by default, print a message and continue */
127 default:
128 fatal = 0;
129 break;
130 }
131
132 /* Null terminate. */
Kingwel Xie497deaf2018-06-15 04:56:24 -0400133 vec_add1 (syslog_msg, 0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700134
135 if (fatal)
136 {
Kingwel Xie497deaf2018-06-15 04:56:24 -0400137 syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
138
139 /* Address of callers: outer first, inner last. */
140 uword callers[15];
141 uword n_callers = clib_backtrace (callers, ARRAY_LEN (callers), 0);
142 int i;
143 for (i = 0; i < n_callers; i++)
144 {
145 vec_reset_length (syslog_msg);
146
147 syslog_msg =
148 format (syslog_msg, "#%-2d 0x%016lx %U%c", i, callers[i],
149 format_clib_elf_symbol_with_address, callers[i], 0);
150
151 syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
152 }
153
154 /* have to remove SIGABRT to avoid recusive - os_exit calling abort() */
155 unsetup_signal_handlers (SIGABRT);
156
Ed Warnickecb9cada2015-12-08 15:45:58 -0700157 os_exit (1);
158 }
159 else
Kingwel Xie497deaf2018-06-15 04:56:24 -0400160 clib_warning ("%s", syslog_msg);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700161
Ed Warnickecb9cada2015-12-08 15:45:58 -0700162}
163
164static clib_error_t *
165setup_signal_handlers (unix_main_t * um)
166{
167 uword i;
168 struct sigaction sa;
169
Kingwel Xie497deaf2018-06-15 04:56:24 -0400170 /* give a big enough buffer for msg, most likely it can avoid vec_resize */
171 vec_alloc (syslog_msg, 2048);
172
Ed Warnickecb9cada2015-12-08 15:45:58 -0700173 for (i = 1; i < 32; i++)
174 {
175 memset (&sa, 0, sizeof (sa));
176 sa.sa_sigaction = (void *) unix_signal_handler;
177 sa.sa_flags = SA_SIGINFO;
178
179 switch (i)
180 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400181 /* these signals take the default action */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700182 case SIGKILL:
183 case SIGSTOP:
Dave Barach9b8ffd92016-07-08 08:13:45 -0400184 case SIGUSR1:
185 case SIGUSR2:
Ed Warnickecb9cada2015-12-08 15:45:58 -0700186 continue;
187
Dave Barach9b8ffd92016-07-08 08:13:45 -0400188 /* ignore SIGPIPE, SIGCHLD */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700189 case SIGPIPE:
190 case SIGCHLD:
191 sa.sa_sigaction = (void *) SIG_IGN;
192 break;
193
Dave Barach9b8ffd92016-07-08 08:13:45 -0400194 /* catch and handle all other signals */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700195 default:
196 break;
197 }
198
199 if (sigaction (i, &sa, 0) < 0)
200 return clib_error_return_unix (0, "sigaction %U", format_signal, i);
201 }
202
203 return 0;
204}
205
Dave Barach9b8ffd92016-07-08 08:13:45 -0400206static void
207unix_error_handler (void *arg, u8 * msg, int msg_len)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700208{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400209 unix_main_t *um = arg;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700210
211 /* Echo to stderr when interactive. */
212 if (um->flags & UNIX_FLAG_INTERACTIVE)
213 {
214 CLIB_UNUSED (int r) = write (2, msg, msg_len);
215 }
216 else
217 {
218 char save = msg[msg_len - 1];
219
220 /* Null Terminate. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400221 msg[msg_len - 1] = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700222
223 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
224
Dave Barach9b8ffd92016-07-08 08:13:45 -0400225 msg[msg_len - 1] = save;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700226 }
227}
228
Dave Barach9b8ffd92016-07-08 08:13:45 -0400229void
230vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700231{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400232 unix_main_t *um = &unix_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700233
Dave Barach9b8ffd92016-07-08 08:13:45 -0400234 if (um->flags & UNIX_FLAG_INTERACTIVE || error == 0)
235 return;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700236
Dave Barach9b8ffd92016-07-08 08:13:45 -0400237 {
238 char save;
239 u8 *msg;
240 u32 msg_len;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700241
Dave Barach9b8ffd92016-07-08 08:13:45 -0400242 msg = error->what;
243 msg_len = vec_len (msg);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700244
Dave Barach9b8ffd92016-07-08 08:13:45 -0400245 /* Null Terminate. */
246 save = msg[msg_len - 1];
247 msg[msg_len - 1] = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700248
Dave Barach9b8ffd92016-07-08 08:13:45 -0400249 syslog (LOG_ERR | LOG_DAEMON, "%s", msg);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700250
Dave Barach9b8ffd92016-07-08 08:13:45 -0400251 msg[msg_len - 1] = save;
252 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700253}
254
255static uword
256startup_config_process (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400257 vlib_node_runtime_t * rt, vlib_frame_t * f)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700258{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400259 unix_main_t *um = &unix_main;
260 u8 *buf = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700261 uword l, n = 1;
262
263 vlib_process_suspend (vm, 2.0);
264
265 while (um->unix_config_complete == 0)
266 vlib_process_suspend (vm, 0.1);
267
Dave Barach9b8ffd92016-07-08 08:13:45 -0400268 if (um->startup_config_filename)
269 {
270 unformat_input_t sub_input;
271 int fd;
272 struct stat s;
273 char *fn = (char *) um->startup_config_filename;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700274
Dave Barach9b8ffd92016-07-08 08:13:45 -0400275 fd = open (fn, O_RDONLY);
276 if (fd < 0)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700277 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400278 clib_warning ("failed to open `%s'", fn);
279 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700280 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700281
Dave Barach9b8ffd92016-07-08 08:13:45 -0400282 if (fstat (fd, &s) < 0)
283 {
284 clib_warning ("failed to stat `%s'", fn);
285 bail:
286 close (fd);
287 return 0;
288 }
289
290 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
291 {
292 clib_warning ("not a regular file: `%s'", fn);
293 goto bail;
294 }
295
296 while (n > 0)
297 {
298 l = vec_len (buf);
299 vec_resize (buf, 4096);
300 n = read (fd, buf + l, 4096);
301 if (n > 0)
302 {
303 _vec_len (buf) = l + n;
304 if (n < 4096)
305 break;
306 }
307 else
308 break;
309 }
310 if (um->log_fd && vec_len (buf))
311 {
312 u8 *lv = 0;
313 lv = format (lv, "%U: ***** Startup Config *****\n%v",
314 format_timeval, 0 /* current bat-time */ ,
315 0 /* current bat-format */ ,
316 buf);
317 {
318 int rv __attribute__ ((unused)) =
319 write (um->log_fd, lv, vec_len (lv));
320 }
321 vec_reset_length (lv);
322 lv = format (lv, "%U: ***** End Startup Config *****\n",
323 format_timeval, 0 /* current bat-time */ ,
324 0 /* current bat-format */ );
325 {
326 int rv __attribute__ ((unused)) =
327 write (um->log_fd, lv, vec_len (lv));
328 }
329 vec_free (lv);
330 }
331
332 if (vec_len (buf))
333 {
334 unformat_init_vector (&sub_input, buf);
335 vlib_cli_input (vm, &sub_input, 0, 0);
336 /* frees buf for us */
337 unformat_free (&sub_input);
338 }
339 close (fd);
340 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700341 return 0;
342}
343
Dave Barach9b8ffd92016-07-08 08:13:45 -0400344/* *INDENT-OFF* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700345VLIB_REGISTER_NODE (startup_config_node,static) = {
346 .function = startup_config_process,
347 .type = VLIB_NODE_TYPE_PROCESS,
348 .name = "startup-config-process",
349};
Dave Barach9b8ffd92016-07-08 08:13:45 -0400350/* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700351
352static clib_error_t *
353unix_config (vlib_main_t * vm, unformat_input_t * input)
354{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400355 unix_main_t *um = &unix_main;
356 clib_error_t *error = 0;
Damjan Mariona54230d2017-06-21 11:57:07 +0200357 gid_t gid;
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400358 int pidfd = -1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700359
Chris Luke7afda3a2016-04-25 13:49:22 -0400360 /* Defaults */
361 um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
362 um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
363
Ed Warnickecb9cada2015-12-08 15:45:58 -0700364 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
365 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400366 char *cli_prompt;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700367 if (unformat (input, "interactive"))
368 um->flags |= UNIX_FLAG_INTERACTIVE;
369 else if (unformat (input, "nodaemon"))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400370 um->flags |= UNIX_FLAG_NODAEMON;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700371 else if (unformat (input, "cli-prompt %s", &cli_prompt))
372 vlib_unix_cli_set_prompt (cli_prompt);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400373 else
374 if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700375 ;
Damjan Marion57d963f2017-07-20 19:17:06 +0200376 else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
377 ;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700378 else if (unformat (input, "cli-line-mode"))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400379 um->cli_line_mode = 1;
Chris Luke572d8122016-04-25 13:49:07 -0400380 else if (unformat (input, "cli-no-banner"))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400381 um->cli_no_banner = 1;
Chris Luke7afda3a2016-04-25 13:49:22 -0400382 else if (unformat (input, "cli-no-pager"))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400383 um->cli_no_pager = 1;
Dave Barach85aa4902018-06-14 18:52:46 -0400384 else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
385 ;
Chris Luke7afda3a2016-04-25 13:49:22 -0400386 else if (unformat (input, "cli-pager-buffer-limit %d",
Dave Barach9b8ffd92016-07-08 08:13:45 -0400387 &um->cli_pager_buffer_limit))
388 ;
389 else
390 if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
391 ;
Klement Sekerac8c44eb2017-03-02 11:13:30 +0100392 else if (unformat (input, "coredump-size"))
393 {
394 uword coredump_size = 0;
395 if (unformat (input, "unlimited"))
396 {
397 coredump_size = RLIM_INFINITY;
398 }
399 else
400 if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
401 {
402 return clib_error_return (0,
403 "invalid coredump-size parameter `%U'",
404 format_unformat_error, input);
405 }
406 const struct rlimit new_limit = { coredump_size, coredump_size };
407 if (0 != setrlimit (RLIMIT_CORE, &new_limit))
408 {
409 clib_unix_warning ("prlimit() failed");
410 }
411 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700412 else if (unformat (input, "full-coredump"))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400413 {
414 int fd;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700415
Dave Barach9b8ffd92016-07-08 08:13:45 -0400416 fd = open ("/proc/self/coredump_filter", O_WRONLY);
Dave Barachb2a6e252016-07-27 10:00:58 -0400417 if (fd >= 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400418 {
419 if (write (fd, "0x6f\n", 5) != 5)
420 clib_unix_warning ("coredump filter write failed!");
421 close (fd);
422 }
423 else
424 clib_unix_warning ("couldn't open /proc/self/coredump_filter");
425 }
426 else if (unformat (input, "startup-config %s",
427 &um->startup_config_filename))
428 ;
429 else if (unformat (input, "exec %s", &um->startup_config_filename))
430 ;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700431 else if (unformat (input, "log %s", &um->log_filename))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400432 {
433 um->log_fd = open ((char *) um->log_filename,
434 O_CREAT | O_WRONLY | O_APPEND, 0644);
435 if (um->log_fd < 0)
436 {
437 clib_warning ("couldn't open log '%s'\n", um->log_filename);
438 um->log_fd = 0;
439 }
440 else
441 {
442 u8 *lv = 0;
443 lv = format (0, "%U: ***** Start: PID %d *****\n",
444 format_timeval, 0 /* current bat-time */ ,
445 0 /* current bat-format */ ,
446 getpid ());
Ed Warnickecb9cada2015-12-08 15:45:58 -0700447 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400448 int rv __attribute__ ((unused)) =
449 write (um->log_fd, lv, vec_len (lv));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700450 }
Dave Barach9b8ffd92016-07-08 08:13:45 -0400451 vec_free (lv);
452 }
453 }
Damjan Mariona54230d2017-06-21 11:57:07 +0200454 else if (unformat (input, "gid %U", unformat_unix_gid, &gid))
455 {
456 if (setegid (gid) == -1)
457 return clib_error_return_unix (0, "setegid");
458 }
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400459 else if (unformat (input, "pidfile %s", &um->pidfile))
460 ;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700461 else
462 return clib_error_return (0, "unknown input `%U'",
463 format_unformat_error, input);
464 }
465
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400466 if (um->runtime_dir == 0)
467 {
468 uid_t uid = geteuid ();
469 if (uid == 00)
470 um->runtime_dir = format (0, "/run/%s%c",
471 vlib_default_runtime_dir, 0);
472 else
473 um->runtime_dir = format (0, "/run/user/%u/%s%c", uid,
474 vlib_default_runtime_dir, 0);
475 }
476
Chris Lukeab7b8d92017-09-07 07:40:13 -0400477 error = setup_signal_handlers (um);
478 if (error)
479 return error;
480
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400481 if (um->pidfile)
482 {
483 if ((error = vlib_unix_validate_runtime_file (um,
484 (char *) um->pidfile,
485 &um->pidfile)))
486 return error;
487
488 if (((pidfd = open ((char *) um->pidfile,
489 O_CREAT | O_WRONLY | O_TRUNC, 0644)) < 0))
490 {
491 return clib_error_return_unix (0, "open");
492 }
493 }
494
Dave Barach9b8ffd92016-07-08 08:13:45 -0400495 if (!(um->flags & UNIX_FLAG_INTERACTIVE))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700496 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700497 openlog (vm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
498 clib_error_register_handler (unix_error_handler, um);
499
Dave Barach9b8ffd92016-07-08 08:13:45 -0400500 if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
501 /* stdin/stdout/stderr -> /dev/null */
502 0) < 0)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700503 clib_error_return (0, "daemon () fails");
504 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700505
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400506 if (pidfd >= 0)
Damjan Marionc67787b2017-08-30 17:12:25 +0200507 {
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400508 u8 *lv = format (0, "%d", getpid ());
509 if (write (pidfd, (char *) lv, vec_len (lv)) != vec_len (lv))
510 {
511 vec_free (lv);
512 close (pidfd);
513 return clib_error_return_unix (0, "write");
514 }
515 vec_free (lv);
516 close (pidfd);
Damjan Marionc67787b2017-08-30 17:12:25 +0200517 }
518
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400519 um->unix_config_complete = 1;
Damjan Marion57d963f2017-07-20 19:17:06 +0200520
Ed Warnickecb9cada2015-12-08 15:45:58 -0700521 return 0;
522}
523
524/* unix { ... } configuration. */
Chris Luke90f52bf2016-09-12 08:55:13 -0400525/*?
526 *
527 * @cfgcmd{interactive}
528 * Attach CLI to stdin/out and provide a debugging command line interface.
529 * Implies @c nodaemon.
530 *
531 * @cfgcmd{nodaemon}
532 * Do not fork or background the VPP process. Typically used when invoking
533 * VPP applications from a process monitor.
534 *
535 * @cfgcmd{exec, &lt;filename&gt;}
536 * @par <code>startup-config &lt;filename&gt;</code>
537 * Read startup operational configuration from @c filename.
538 * The contents of the file will be performed as though entered at the CLI.
539 * The two keywords are aliases for the same function; if both are specified,
540 * only the last will have an effect.
541 *
542 * @cfgcmd{log, &lt;filename&gt;}
543 * Logs the startup configuration and all subsequent CLI commands in
544 * @c filename.
545 * Very useful in situations where folks don't remember or can't be bothered
546 * to include CLI commands in bug reports.
547 *
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400548 * @cfgcmd{pidfile, &lt;filename&gt;}
549 * Writes the pid of the main thread in @c filename.
550 *
Chris Luke90f52bf2016-09-12 08:55:13 -0400551 * @cfgcmd{full-coredump}
552 * Ask the Linux kernel to dump all memory-mapped address regions, instead
553 * of just text+data+bss.
554 *
Damjan Marion57d963f2017-07-20 19:17:06 +0200555 * @cfgcmd{runtime-dir}
556 * Define directory where VPP is going to store all runtime files.
557 * Default is /run/vpp.
558 *
Chris Luke90f52bf2016-09-12 08:55:13 -0400559 * @cfgcmd{cli-listen, &lt;address:port&gt;}
560 * Bind the CLI to listen at the address and port given. @clocalhost
561 * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
562 * is typical.
563 *
564 * @cfgcmd{cli-line-mode}
565 * Disable character-by-character I/O on stdin. Useful when combined with,
566 * for example, <tt>emacs M-x gud-gdb</tt>.
567 *
568 * @cfgcmd{cli-prompt, &lt;string&gt;}
569 * Configure the CLI prompt to be @c string.
570 *
571 * @cfgcmd{cli-history-limit, &lt;nn&gt;}
572 * Limit commmand history to @c nn lines. A value of @c 0
573 * disables command history. Default value: @c 50
574 *
575 * @cfgcmd{cli-no-banner}
576 * Disable the login banner on stdin and Telnet connections.
577 *
578 * @cfgcmd{cli-no-pager}
579 * Disable the output pager.
580 *
581 * @cfgcmd{cli-pager-buffer-limit, &lt;nn&gt;}
582 * Limit pager buffer to @c nn lines of output.
583 * A value of @c 0 disables the pager. Default value: @c 100000
584?*/
Damjan Marion57d963f2017-07-20 19:17:06 +0200585VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
Ed Warnickecb9cada2015-12-08 15:45:58 -0700586
587static clib_error_t *
588unix_exit (vlib_main_t * vm)
589{
590 /* Close syslog connection. */
591 closelog ();
592 return 0;
593}
594
595VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
596
597u8 **vlib_thread_stacks;
598
Dave Barach9b8ffd92016-07-08 08:13:45 -0400599static uword
600thread0 (uword arg)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700601{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400602 vlib_main_t *vm = (vlib_main_t *) arg;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700603 unformat_input_t input;
604 int i;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400605
606 unformat_init_command_line (&input, (char **) vm->argv);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700607 i = vlib_main (vm, &input);
608 unformat_free (&input);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700609
Dave Barach9b8ffd92016-07-08 08:13:45 -0400610 return i;
611}
612
Damjan Marion586afd72017-04-05 19:18:20 +0200613u8 *
614vlib_thread_stack_init (uword thread_index)
615{
616 vec_validate (vlib_thread_stacks, thread_index);
617 vlib_thread_stacks[thread_index] = clib_mem_alloc_aligned
618 (VLIB_THREAD_STACK_SIZE, VLIB_THREAD_STACK_SIZE);
619
620 /*
621 * Disallow writes to the bottom page of the stack, to
622 * catch stack overflows.
623 */
624 if (mprotect (vlib_thread_stacks[thread_index],
625 clib_mem_get_page_size (), PROT_READ) < 0)
626 clib_unix_warning ("thread stack");
627 return vlib_thread_stacks[thread_index];
628}
629
Dave Barach9b8ffd92016-07-08 08:13:45 -0400630int
631vlib_unix_main (int argc, char *argv[])
Ed Warnickecb9cada2015-12-08 15:45:58 -0700632{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400633 vlib_main_t *vm = &vlib_global_main; /* one and only time for this! */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700634 unformat_input_t input;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400635 clib_error_t *e;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700636 int i;
637
Dave Barach9b8ffd92016-07-08 08:13:45 -0400638 vm->argv = (u8 **) argv;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700639 vm->name = argv[0];
640 vm->heap_base = clib_mem_get_heap ();
Dave Barach6a5adc32018-07-04 10:56:23 -0400641 vm->heap_aligned_base = (void *)
642 (((uword) vm->heap_base) & ~(VLIB_FRAME_ALIGN - 1));
Dave Barach9b8ffd92016-07-08 08:13:45 -0400643 ASSERT (vm->heap_base);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700644
Damjan Marion3b46cba2017-01-23 21:13:45 +0100645 unformat_init_command_line (&input, (char **) vm->argv);
646 if ((e = vlib_plugin_config (vm, &input)))
647 {
648 clib_error_report (e);
649 return 1;
650 }
651 unformat_free (&input);
652
Ed Warnickecb9cada2015-12-08 15:45:58 -0700653 i = vlib_plugin_early_init (vm);
654 if (i)
655 return i;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400656
657 unformat_init_command_line (&input, (char **) vm->argv);
Dave Barach1f49ed62016-02-24 11:29:06 -0500658 if (vm->init_functions_called == 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400659 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
660 e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
Ed Warnickecb9cada2015-12-08 15:45:58 -0700661 if (e != 0)
662 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400663 clib_error_report (e);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700664 return 1;
665 }
666 unformat_free (&input);
667
Kingwel Xie497deaf2018-06-15 04:56:24 -0400668 /* always load symbols, for signal handler and mheap memory get/put backtrace */
669 clib_elf_main_init (vm->name);
670
Damjan Marion586afd72017-04-05 19:18:20 +0200671 vlib_thread_stack_init (0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700672
Damjan Marionf55f9b82017-05-10 21:06:28 +0200673 __os_thread_index = 0;
Keith Burns (alagalah)0bda0f42017-10-20 13:55:18 -0700674 vm->thread_index = 0;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400675
676 i = clib_calljmp (thread0, (uword) vm,
677 (void *) (vlib_thread_stacks[0] +
678 VLIB_THREAD_STACK_SIZE));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700679 return i;
680}
Dave Barach9b8ffd92016-07-08 08:13:45 -0400681
682/*
683 * fd.io coding-style-patch-verification: ON
684 *
685 * Local Variables:
686 * eval: (c-set-style "gnu")
687 * End:
688 */