blob: 11d0cb1160cb09632b3c81e4d19d4109b10ff6e6 [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>
Tom Jonesab479932024-04-24 10:30:20 +000042#include <vppinfra/unix.h>
Damjan Marion78925602024-05-23 13:06:39 +000043#include <vppinfra/stack.h>
44#include <vppinfra/format_ansi.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070045
Jing Peng4859d8d2022-03-04 17:43:50 -050046#include <limits.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070047#include <signal.h>
48#include <sys/ucontext.h>
49#include <syslog.h>
50#include <sys/types.h>
51#include <sys/stat.h>
52#include <fcntl.h>
Klement Sekerac8c44eb2017-03-02 11:13:30 +010053#include <sys/time.h>
54#include <sys/resource.h>
Damjan Mariona54230d2017-06-21 11:57:07 +020055#include <unistd.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070056
Chris Luke7afda3a2016-04-25 13:49:22 -040057/** Default CLI pager limit is not configured in startup.conf */
58#define UNIX_CLI_DEFAULT_PAGER_LIMIT 100000
59
60/** Default CLI history depth if not configured in startup.conf */
61#define UNIX_CLI_DEFAULT_HISTORY 50
62
Damjan Marion57d963f2017-07-20 19:17:06 +020063char *vlib_default_runtime_dir __attribute__ ((weak));
Damjan Marionc67787b2017-08-30 17:12:25 +020064char *vlib_default_runtime_dir = "vlib";
Chris Luke7afda3a2016-04-25 13:49:22 -040065
Ed Warnickecb9cada2015-12-08 15:45:58 -070066unix_main_t unix_main;
Damjan Marion56dd5432017-09-08 19:52:02 +020067clib_file_main_t file_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -070068
69static clib_error_t *
70unix_main_init (vlib_main_t * vm)
71{
Dave Barach9b8ffd92016-07-08 08:13:45 -040072 unix_main_t *um = &unix_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -070073 um->vlib_main = vm;
Dave Barachf8d50682019-05-14 18:01:44 -040074 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -070075}
76
Dave Barachf8d50682019-05-14 18:01:44 -040077VLIB_INIT_FUNCTION (unix_main_init) =
78{
79 .runs_before = VLIB_INITS ("unix_input_init"),
80};
Ed Warnickecb9cada2015-12-08 15:45:58 -070081
Kingwel Xie497deaf2018-06-15 04:56:24 -040082static int
83unsetup_signal_handlers (int sig)
84{
85 struct sigaction sa;
86
87 sa.sa_handler = SIG_DFL;
88 sa.sa_flags = 0;
89 sigemptyset (&sa.sa_mask);
90 return sigaction (sig, &sa, 0);
91}
92
93
94/* allocate this buffer from mheap when setting up the signal handler.
95 dangerous to vec_resize it when crashing, mheap itself might have been
Paul Vinciguerrad29422c2019-10-27 14:00:53 -040096 corrupted already */
Kingwel Xie497deaf2018-06-15 04:56:24 -040097static u8 *syslog_msg = 0;
Dave Barach695eb932020-10-09 10:17:22 -040098int vlib_last_signum = 0;
99uword vlib_last_faulting_address = 0;
Kingwel Xie497deaf2018-06-15 04:56:24 -0400100
Dave Barach9b8ffd92016-07-08 08:13:45 -0400101static void
Damjan Marion78925602024-05-23 13:06:39 +0000102log_one_line ()
103{
104 vec_terminate_c_string (syslog_msg);
105 if (unix_main.flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG))
106 fprintf (stderr, "%s\n", syslog_msg);
107 else
108 syslog (LOG_ERR | LOG_DAEMON, "%s", syslog_msg);
109 vec_reset_length (syslog_msg);
110}
111
112static void
Dave Barach9b8ffd92016-07-08 08:13:45 -0400113unix_signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700114{
Dave Barach903651c2017-10-13 19:16:56 -0400115 uword fatal = 0;
Damjan Marion78925602024-05-23 13:06:39 +0000116 int color =
117 (unix_main.flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG)) &&
118 (unix_main.flags & UNIX_FLAG_NOCOLOR) == 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700119
Dave Barach9e52ef62019-02-28 17:52:57 -0500120 /* These come in handy when looking at core files from optimized images */
Dave Barach695eb932020-10-09 10:17:22 -0400121 vlib_last_signum = signum;
122 vlib_last_faulting_address = (uword) si->si_addr;
Dave Barach9e52ef62019-02-28 17:52:57 -0500123
Damjan Marion78925602024-05-23 13:06:39 +0000124 if (color)
125 syslog_msg = format (syslog_msg, ANSI_FG_BR_RED);
126
Kingwel Xie497deaf2018-06-15 04:56:24 -0400127 syslog_msg = format (syslog_msg, "received signal %U, PC %U",
128 format_signal, signum, format_ucontext_pc, uc);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700129
Damjan Marion78925602024-05-23 13:06:39 +0000130 if (signum == SIGSEGV || signum == SIGBUS)
Kingwel Xie497deaf2018-06-15 04:56:24 -0400131 syslog_msg = format (syslog_msg, ", faulting address %p", si->si_addr);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700132
Damjan Marion78925602024-05-23 13:06:39 +0000133 if (color)
134 syslog_msg = format (syslog_msg, ANSI_FG_DEFAULT);
135
136 log_one_line ();
137
Ed Warnickecb9cada2015-12-08 15:45:58 -0700138 switch (signum)
139 {
140 /* these (caught) signals cause the application to exit */
141 case SIGTERM:
Dave Barachd1e17d02019-03-21 18:01:48 -0400142 /*
143 * Ignore SIGTERM if it's sent before we're ready.
144 */
145 if (unix_main.vlib_main && unix_main.vlib_main->main_loop_exit_set)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400146 {
Damjan Marion78925602024-05-23 13:06:39 +0000147 syslog_msg = format (
148 syslog_msg, "received SIGTERM from PID %d UID %d, exiting...",
149 si->si_pid, si->si_uid);
150 log_one_line ();
Dave Barach903651c2017-10-13 19:16:56 -0400151 unix_main.vlib_main->main_loop_exit_now = 1;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400152 }
Dave Barachd1e17d02019-03-21 18:01:48 -0400153 else
Damjan Marion78925602024-05-23 13:06:39 +0000154 {
155 syslog_msg = format (syslog_msg, "IGNORE early SIGTERM...");
156 log_one_line ();
157 }
Dave Barach903651c2017-10-13 19:16:56 -0400158 break;
Dave Barachb2a6e252016-07-27 10:00:58 -0400159 /* fall through */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700160 case SIGQUIT:
161 case SIGINT:
162 case SIGILL:
163 case SIGBUS:
164 case SIGSEGV:
165 case SIGHUP:
166 case SIGFPE:
Kingwel Xie497deaf2018-06-15 04:56:24 -0400167 case SIGABRT:
Ed Warnickecb9cada2015-12-08 15:45:58 -0700168 fatal = 1;
169 break;
170
171 /* by default, print a message and continue */
172 default:
173 fatal = 0;
174 break;
175 }
176
Ed Warnickecb9cada2015-12-08 15:45:58 -0700177
178 if (fatal)
179 {
Damjan Marion78925602024-05-23 13:06:39 +0000180 int skip = 1, index = 0;
Kingwel Xie497deaf2018-06-15 04:56:24 -0400181
Damjan Marion78925602024-05-23 13:06:39 +0000182 foreach_clib_stack_frame (sf)
Kingwel Xie497deaf2018-06-15 04:56:24 -0400183 {
Damjan Marion78925602024-05-23 13:06:39 +0000184 if (sf->is_signal_frame)
185 {
186 int pipefd[2];
187 const int n_bytes = 20;
188 u8 *ip = (void *) sf->ip;
Kingwel Xie497deaf2018-06-15 04:56:24 -0400189
Damjan Marion78925602024-05-23 13:06:39 +0000190 if (pipe (pipefd) == 0)
191 {
192 /* check PC points to valid memory */
193 if (write (pipefd[1], ip, n_bytes) == n_bytes)
194 {
195 syslog_msg = format (syslog_msg, "Code: ");
196 if (color)
197 syslog_msg = format (syslog_msg, ANSI_FG_CYAN);
198 for (int i = 0; i < n_bytes; i++)
199 syslog_msg = format (syslog_msg, " %02x", ip[i]);
200 if (color)
201 syslog_msg = format (syslog_msg, ANSI_FG_DEFAULT);
202 }
203 else
204 {
205 syslog_msg = format (
206 syslog_msg, "PC contains invalid memory address");
207 }
208 log_one_line ();
209 foreach_int (i, 0, 1)
210 close (pipefd[i]);
211 }
212 skip = 0;
213 }
Kingwel Xie497deaf2018-06-15 04:56:24 -0400214
Damjan Marion78925602024-05-23 13:06:39 +0000215 if (skip)
216 continue;
217
218 syslog_msg = format (syslog_msg, "#%-2d ", index++);
219 if (color)
220 syslog_msg = format (syslog_msg, ANSI_FG_BLUE);
221 syslog_msg = format (syslog_msg, "0x%016lx", sf->ip);
222 if (color)
223 syslog_msg = format (syslog_msg, ANSI_FG_DEFAULT);
224
225 if (sf->name[0])
226 {
227 if (color)
228 syslog_msg = format (syslog_msg, ANSI_FG_YELLOW);
229 syslog_msg =
230 format (syslog_msg, " %s + 0x%x", sf->name, sf->offset);
231 if (color)
232 syslog_msg = format (syslog_msg, ANSI_FG_DEFAULT);
233 }
234
235 log_one_line ();
236
237 if (sf->file_name)
238 {
239 if (color)
240 syslog_msg = format (syslog_msg, ANSI_FG_GREEN);
241 syslog_msg = format (syslog_msg, " from %s", sf->file_name);
242 if (color)
243 syslog_msg = format (syslog_msg, ANSI_FG_DEFAULT);
244 log_one_line ();
245 }
Kingwel Xie497deaf2018-06-15 04:56:24 -0400246 }
247
Paul Vinciguerrad29422c2019-10-27 14:00:53 -0400248 /* have to remove SIGABRT to avoid recursive - os_exit calling abort() */
Kingwel Xie497deaf2018-06-15 04:56:24 -0400249 unsetup_signal_handlers (SIGABRT);
250
Christian Hopps1da08192020-04-24 04:39:59 -0400251 /* os_exit(1) causes core generation, skip that for SIGINT, SIGHUP */
252 if (signum == SIGINT || signum == SIGHUP)
Christian E. Hopps10a8bda2019-09-27 13:52:50 -0400253 os_exit (0);
254 else
255 os_exit (1);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700256 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700257}
258
259static clib_error_t *
260setup_signal_handlers (unix_main_t * um)
261{
262 uword i;
263 struct sigaction sa;
264
Kingwel Xie497deaf2018-06-15 04:56:24 -0400265 /* give a big enough buffer for msg, most likely it can avoid vec_resize */
266 vec_alloc (syslog_msg, 2048);
267
Ed Warnickecb9cada2015-12-08 15:45:58 -0700268 for (i = 1; i < 32; i++)
269 {
Dave Barachb7b92992018-10-17 10:38:51 -0400270 clib_memset (&sa, 0, sizeof (sa));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700271 sa.sa_sigaction = (void *) unix_signal_handler;
272 sa.sa_flags = SA_SIGINFO;
273
274 switch (i)
275 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400276 /* these signals take the default action */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700277 case SIGKILL:
Vladislav Grishenko84862832022-03-21 02:21:42 +0500278 case SIGCONT:
Ed Warnickecb9cada2015-12-08 15:45:58 -0700279 case SIGSTOP:
Dave Barach9b8ffd92016-07-08 08:13:45 -0400280 case SIGUSR1:
281 case SIGUSR2:
Jieqiang Wang6f533d72020-01-20 13:43:38 +0800282 case SIGPROF:
Ed Warnickecb9cada2015-12-08 15:45:58 -0700283 continue;
284
Dave Barach9b8ffd92016-07-08 08:13:45 -0400285 /* ignore SIGPIPE, SIGCHLD */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700286 case SIGPIPE:
287 case SIGCHLD:
288 sa.sa_sigaction = (void *) SIG_IGN;
289 break;
290
Dave Barach9b8ffd92016-07-08 08:13:45 -0400291 /* catch and handle all other signals */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700292 default:
293 break;
294 }
295
296 if (sigaction (i, &sa, 0) < 0)
297 return clib_error_return_unix (0, "sigaction %U", format_signal, i);
298 }
299
300 return 0;
301}
302
Dave Barach9b8ffd92016-07-08 08:13:45 -0400303static void
304unix_error_handler (void *arg, u8 * msg, int msg_len)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700305{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400306 unix_main_t *um = arg;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700307
Ruslan Babayeve31820a2020-02-14 17:45:02 -0800308 /* Echo to stderr when interactive or syslog is disabled. */
309 if (um->flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700310 {
311 CLIB_UNUSED (int r) = write (2, msg, msg_len);
312 }
313 else
314 {
Jing Peng4859d8d2022-03-04 17:43:50 -0500315 syslog (LOG_ERR | LOG_DAEMON, "%.*s", msg_len, msg);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700316 }
317}
318
Dave Barach9b8ffd92016-07-08 08:13:45 -0400319void
320vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700321{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400322 unix_main_t *um = &unix_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700323
Dave Barach9b8ffd92016-07-08 08:13:45 -0400324 if (um->flags & UNIX_FLAG_INTERACTIVE || error == 0)
325 return;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700326
Dave Barach9b8ffd92016-07-08 08:13:45 -0400327 {
Jing Peng4859d8d2022-03-04 17:43:50 -0500328 u8 *msg = error->what;
329 u32 len = vec_len (msg);
330 int msg_len = (len > INT_MAX) ? INT_MAX : len;
331 syslog (LOG_ERR | LOG_DAEMON, "%.*s", msg_len, msg);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400332 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700333}
334
335static uword
336startup_config_process (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400337 vlib_node_runtime_t * rt, vlib_frame_t * f)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700338{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400339 unix_main_t *um = &unix_main;
Xiaoming Jiang4d830d22022-12-08 07:54:06 +0000340 unformat_input_t in;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700341
342 vlib_process_suspend (vm, 2.0);
343
344 while (um->unix_config_complete == 0)
345 vlib_process_suspend (vm, 0.1);
346
Xiaoming Jiang4d830d22022-12-08 07:54:06 +0000347 if (!um->startup_config_filename)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400348 {
Xiaoming Jiang4d830d22022-12-08 07:54:06 +0000349 return 0;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400350 }
Xiaoming Jiang4d830d22022-12-08 07:54:06 +0000351
352 unformat_init_vector (&in,
353 format (0, "exec %s", um->startup_config_filename));
354
355 vlib_cli_input (vm, &in, 0, 0);
356
357 unformat_free (&in);
358
Ed Warnickecb9cada2015-12-08 15:45:58 -0700359 return 0;
360}
361
362VLIB_REGISTER_NODE (startup_config_node,static) = {
363 .function = startup_config_process,
364 .type = VLIB_NODE_TYPE_PROCESS,
365 .name = "startup-config-process",
GordonNoonanb2dbb362019-12-04 15:16:40 +0000366 .process_log2_n_stack_bytes = 18,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700367};
368
369static clib_error_t *
370unix_config (vlib_main_t * vm, unformat_input_t * input)
371{
Damjan Marionfd8deb42021-03-06 12:26:28 +0100372 vlib_global_main_t *vgm = vlib_get_global_main ();
Dave Barach9b8ffd92016-07-08 08:13:45 -0400373 unix_main_t *um = &unix_main;
374 clib_error_t *error = 0;
Damjan Mariona54230d2017-06-21 11:57:07 +0200375 gid_t gid;
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400376 int pidfd = -1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700377
Chris Luke7afda3a2016-04-25 13:49:22 -0400378 /* Defaults */
379 um->cli_pager_buffer_limit = UNIX_CLI_DEFAULT_PAGER_LIMIT;
380 um->cli_history_limit = UNIX_CLI_DEFAULT_HISTORY;
381
Ed Warnickecb9cada2015-12-08 15:45:58 -0700382 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
383 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400384 char *cli_prompt;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700385 if (unformat (input, "interactive"))
386 um->flags |= UNIX_FLAG_INTERACTIVE;
387 else if (unformat (input, "nodaemon"))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400388 um->flags |= UNIX_FLAG_NODAEMON;
Ruslan Babayeve31820a2020-02-14 17:45:02 -0800389 else if (unformat (input, "nosyslog"))
390 um->flags |= UNIX_FLAG_NOSYSLOG;
Damjan Marion06d82262020-10-21 12:43:40 +0200391 else if (unformat (input, "nocolor"))
392 um->flags |= UNIX_FLAG_NOCOLOR;
393 else if (unformat (input, "nobanner"))
394 um->flags |= UNIX_FLAG_NOBANNER;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700395 else if (unformat (input, "cli-prompt %s", &cli_prompt))
396 vlib_unix_cli_set_prompt (cli_prompt);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400397 else
398 if (unformat (input, "cli-listen %s", &um->cli_listen_socket.config))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700399 ;
Damjan Marion57d963f2017-07-20 19:17:06 +0200400 else if (unformat (input, "runtime-dir %s", &um->runtime_dir))
401 ;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700402 else if (unformat (input, "cli-line-mode"))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400403 um->cli_line_mode = 1;
Chris Luke572d8122016-04-25 13:49:07 -0400404 else if (unformat (input, "cli-no-banner"))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400405 um->cli_no_banner = 1;
Chris Luke7afda3a2016-04-25 13:49:22 -0400406 else if (unformat (input, "cli-no-pager"))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400407 um->cli_no_pager = 1;
Dave Barach85aa4902018-06-14 18:52:46 -0400408 else if (unformat (input, "poll-sleep-usec %d", &um->poll_sleep_usec))
409 ;
Chris Luke7afda3a2016-04-25 13:49:22 -0400410 else if (unformat (input, "cli-pager-buffer-limit %d",
Dave Barach9b8ffd92016-07-08 08:13:45 -0400411 &um->cli_pager_buffer_limit))
412 ;
413 else
414 if (unformat (input, "cli-history-limit %d", &um->cli_history_limit))
415 ;
Klement Sekerac8c44eb2017-03-02 11:13:30 +0100416 else if (unformat (input, "coredump-size"))
417 {
418 uword coredump_size = 0;
419 if (unformat (input, "unlimited"))
420 {
421 coredump_size = RLIM_INFINITY;
422 }
423 else
424 if (!unformat (input, "%U", unformat_memory_size, &coredump_size))
425 {
426 return clib_error_return (0,
427 "invalid coredump-size parameter `%U'",
428 format_unformat_error, input);
429 }
430 const struct rlimit new_limit = { coredump_size, coredump_size };
431 if (0 != setrlimit (RLIMIT_CORE, &new_limit))
432 {
433 clib_unix_warning ("prlimit() failed");
434 }
435 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700436 else if (unformat (input, "full-coredump"))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400437 {
438 int fd;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700439
Dave Barach9b8ffd92016-07-08 08:13:45 -0400440 fd = open ("/proc/self/coredump_filter", O_WRONLY);
Dave Barachb2a6e252016-07-27 10:00:58 -0400441 if (fd >= 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400442 {
443 if (write (fd, "0x6f\n", 5) != 5)
444 clib_unix_warning ("coredump filter write failed!");
445 close (fd);
446 }
447 else
448 clib_unix_warning ("couldn't open /proc/self/coredump_filter");
449 }
450 else if (unformat (input, "startup-config %s",
451 &um->startup_config_filename))
452 ;
453 else if (unformat (input, "exec %s", &um->startup_config_filename))
454 ;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700455 else if (unformat (input, "log %s", &um->log_filename))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400456 {
457 um->log_fd = open ((char *) um->log_filename,
458 O_CREAT | O_WRONLY | O_APPEND, 0644);
459 if (um->log_fd < 0)
460 {
461 clib_warning ("couldn't open log '%s'\n", um->log_filename);
462 um->log_fd = 0;
463 }
464 else
465 {
466 u8 *lv = 0;
467 lv = format (0, "%U: ***** Start: PID %d *****\n",
Andreas Schultz972dc172020-05-15 11:50:07 +0200468 format_timeval, NULL /* current bat-format */,
469 0 /* current bat-time */, getpid ());
Ed Warnickecb9cada2015-12-08 15:45:58 -0700470 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400471 int rv __attribute__ ((unused)) =
472 write (um->log_fd, lv, vec_len (lv));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700473 }
Dave Barach9b8ffd92016-07-08 08:13:45 -0400474 vec_free (lv);
475 }
476 }
Damjan Mariona54230d2017-06-21 11:57:07 +0200477 else if (unformat (input, "gid %U", unformat_unix_gid, &gid))
478 {
479 if (setegid (gid) == -1)
480 return clib_error_return_unix (0, "setegid");
481 }
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400482 else if (unformat (input, "pidfile %s", &um->pidfile))
483 ;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700484 else
485 return clib_error_return (0, "unknown input `%U'",
486 format_unformat_error, input);
487 }
488
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400489 if (um->runtime_dir == 0)
490 {
491 uid_t uid = geteuid ();
492 if (uid == 00)
493 um->runtime_dir = format (0, "/run/%s%c",
494 vlib_default_runtime_dir, 0);
495 else
496 um->runtime_dir = format (0, "/run/user/%u/%s%c", uid,
497 vlib_default_runtime_dir, 0);
498 }
499
Ole Troand991a792019-08-19 14:51:45 +0200500 /* Ensure the runtime directory is created */
501 error = vlib_unix_recursive_mkdir ((char *) um->runtime_dir);
502 if (error)
503 return error;
504
Damjan Mariona254de42023-01-26 20:23:11 +0100505 if (chdir ((char *) um->runtime_dir) < 0)
506 return clib_error_return_unix (0, "chdir('%s')", um->runtime_dir);
507
Chris Lukeab7b8d92017-09-07 07:40:13 -0400508 error = setup_signal_handlers (um);
509 if (error)
510 return error;
511
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400512 if (um->pidfile)
513 {
514 if ((error = vlib_unix_validate_runtime_file (um,
515 (char *) um->pidfile,
516 &um->pidfile)))
517 return error;
518
519 if (((pidfd = open ((char *) um->pidfile,
520 O_CREAT | O_WRONLY | O_TRUNC, 0644)) < 0))
521 {
522 return clib_error_return_unix (0, "open");
523 }
524 }
525
Ruslan Babayeve31820a2020-02-14 17:45:02 -0800526 if (!(um->flags & (UNIX_FLAG_INTERACTIVE | UNIX_FLAG_NOSYSLOG)))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700527 {
Damjan Marionfd8deb42021-03-06 12:26:28 +0100528 openlog (vgm->name, LOG_CONS | LOG_PERROR | LOG_PID, LOG_DAEMON);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700529 clib_error_register_handler (unix_error_handler, um);
530
Dave Barach9b8ffd92016-07-08 08:13:45 -0400531 if (!(um->flags & UNIX_FLAG_NODAEMON) && daemon ( /* chdir to / */ 0,
532 /* stdin/stdout/stderr -> /dev/null */
533 0) < 0)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700534 clib_error_return (0, "daemon () fails");
535 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700536
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400537 if (pidfd >= 0)
Damjan Marionc67787b2017-08-30 17:12:25 +0200538 {
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400539 u8 *lv = format (0, "%d", getpid ());
540 if (write (pidfd, (char *) lv, vec_len (lv)) != vec_len (lv))
541 {
542 vec_free (lv);
543 close (pidfd);
544 return clib_error_return_unix (0, "write");
545 }
546 vec_free (lv);
547 close (pidfd);
Damjan Marionc67787b2017-08-30 17:12:25 +0200548 }
549
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400550 um->unix_config_complete = 1;
Damjan Marion57d963f2017-07-20 19:17:06 +0200551
Ed Warnickecb9cada2015-12-08 15:45:58 -0700552 return 0;
553}
554
555/* unix { ... } configuration. */
Chris Luke90f52bf2016-09-12 08:55:13 -0400556/*?
557 *
558 * @cfgcmd{interactive}
559 * Attach CLI to stdin/out and provide a debugging command line interface.
560 * Implies @c nodaemon.
561 *
562 * @cfgcmd{nodaemon}
563 * Do not fork or background the VPP process. Typically used when invoking
564 * VPP applications from a process monitor.
565 *
Ruslan Babayeve31820a2020-02-14 17:45:02 -0800566 * @cfgcmd{nosyslog}
567 * Do not send e.g. clib_warning(...) output to syslog. Used
568 * when invoking VPP applications from a process monitor which
569 * pipe stdout/stderr to a dedicated logger service.
570 *
Damjan Marion06d82262020-10-21 12:43:40 +0200571 * @cfgcmd{nocolor}
572 * Do not use colors in outputs.
573 * *
574 * @cfgcmd{nobanner}
575 * Do not display startup banner.
576 *
Chris Luke90f52bf2016-09-12 08:55:13 -0400577 * @cfgcmd{exec, &lt;filename&gt;}
578 * @par <code>startup-config &lt;filename&gt;</code>
579 * Read startup operational configuration from @c filename.
580 * The contents of the file will be performed as though entered at the CLI.
581 * The two keywords are aliases for the same function; if both are specified,
582 * only the last will have an effect.
583 *
584 * @cfgcmd{log, &lt;filename&gt;}
585 * Logs the startup configuration and all subsequent CLI commands in
586 * @c filename.
587 * Very useful in situations where folks don't remember or can't be bothered
588 * to include CLI commands in bug reports.
589 *
Pierre Pfister9a244bb2017-07-27 22:57:34 -0400590 * @cfgcmd{pidfile, &lt;filename&gt;}
591 * Writes the pid of the main thread in @c filename.
592 *
Chris Luke90f52bf2016-09-12 08:55:13 -0400593 * @cfgcmd{full-coredump}
594 * Ask the Linux kernel to dump all memory-mapped address regions, instead
595 * of just text+data+bss.
596 *
Damjan Marion57d963f2017-07-20 19:17:06 +0200597 * @cfgcmd{runtime-dir}
598 * Define directory where VPP is going to store all runtime files.
Paul Vinciguerrad54815c2019-04-11 06:32:19 -0700599 * Default is /run/vpp when running as root, /run/user/<UID>/vpp if running as
600 * an unprivileged user.
Damjan Marion57d963f2017-07-20 19:17:06 +0200601 *
Chris Luke90f52bf2016-09-12 08:55:13 -0400602 * @cfgcmd{cli-listen, &lt;address:port&gt;}
Paul Vinciguerrad54815c2019-04-11 06:32:19 -0700603 * Bind the CLI to listen at the address and port given. @c localhost
Chris Luke90f52bf2016-09-12 08:55:13 -0400604 * on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
605 * is typical.
606 *
607 * @cfgcmd{cli-line-mode}
608 * Disable character-by-character I/O on stdin. Useful when combined with,
609 * for example, <tt>emacs M-x gud-gdb</tt>.
610 *
611 * @cfgcmd{cli-prompt, &lt;string&gt;}
612 * Configure the CLI prompt to be @c string.
613 *
614 * @cfgcmd{cli-history-limit, &lt;nn&gt;}
Paul Vinciguerrad54815c2019-04-11 06:32:19 -0700615 * Limit command history to @c nn lines. A value of @c 0
Chris Luke90f52bf2016-09-12 08:55:13 -0400616 * disables command history. Default value: @c 50
617 *
618 * @cfgcmd{cli-no-banner}
619 * Disable the login banner on stdin and Telnet connections.
620 *
621 * @cfgcmd{cli-no-pager}
622 * Disable the output pager.
623 *
624 * @cfgcmd{cli-pager-buffer-limit, &lt;nn&gt;}
625 * Limit pager buffer to @c nn lines of output.
626 * A value of @c 0 disables the pager. Default value: @c 100000
Paul Vinciguerrad54815c2019-04-11 06:32:19 -0700627 *
628 * @cfgcmd{gid, &lt;nn&gt;}
629 * Set the effective gid under which the vpp process is to run.
630 *
631 * @cfgcmd{poll-sleep-usec, &lt;nn&gt;}
632 * Set a fixed poll sleep interval between main loop polls.
Chris Luke90f52bf2016-09-12 08:55:13 -0400633?*/
Damjan Marion57d963f2017-07-20 19:17:06 +0200634VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");
Ed Warnickecb9cada2015-12-08 15:45:58 -0700635
636static clib_error_t *
637unix_exit (vlib_main_t * vm)
638{
639 /* Close syslog connection. */
640 closelog ();
641 return 0;
642}
643
644VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_exit);
645
646u8 **vlib_thread_stacks;
647
Dave Barach9b8ffd92016-07-08 08:13:45 -0400648static uword
649thread0 (uword arg)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700650{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400651 vlib_main_t *vm = (vlib_main_t *) arg;
Damjan Marion2e90b292022-04-04 18:48:11 +0200652 vlib_global_main_t *vgm = vlib_get_global_main ();
Ed Warnickecb9cada2015-12-08 15:45:58 -0700653 unformat_input_t input;
654 int i;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400655
Damjan Marioncea46522020-05-21 16:47:05 +0200656 vlib_process_finish_switch_stack (vm);
657
Damjan Marion2e90b292022-04-04 18:48:11 +0200658 unformat_init_command_line (&input, (char **) vgm->argv);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700659 i = vlib_main (vm, &input);
660 unformat_free (&input);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700661
Dave Barach9b8ffd92016-07-08 08:13:45 -0400662 return i;
663}
664
Damjan Marion586afd72017-04-05 19:18:20 +0200665u8 *
666vlib_thread_stack_init (uword thread_index)
667{
Damjan Marionfc639ff2020-09-11 22:25:34 +0200668 void *stack;
Dave Barach2180bac2019-05-10 15:25:10 -0400669 ASSERT (thread_index < vec_len (vlib_thread_stacks));
Damjan Marionfc639ff2020-09-11 22:25:34 +0200670 stack = clib_mem_vm_map_stack (VLIB_THREAD_STACK_SIZE,
671 CLIB_MEM_PAGE_SZ_DEFAULT,
672 "thread stack: thread %u", thread_index);
Damjan Marion586afd72017-04-05 19:18:20 +0200673
Damjan Marionfc639ff2020-09-11 22:25:34 +0200674 if (stack == CLIB_MEM_VM_MAP_FAILED)
675 clib_panic ("failed to allocate thread %u stack", thread_index);
676
677 vlib_thread_stacks[thread_index] = stack;
678 return stack;
Damjan Marion586afd72017-04-05 19:18:20 +0200679}
680
Damjan Marion2e90b292022-04-04 18:48:11 +0200681#ifndef PATH_MAX
682#define PATH_MAX 4096
683#endif
684
Dave Barach9b8ffd92016-07-08 08:13:45 -0400685int
686vlib_unix_main (int argc, char *argv[])
Ed Warnickecb9cada2015-12-08 15:45:58 -0700687{
Damjan Marionfd8deb42021-03-06 12:26:28 +0100688 vlib_global_main_t *vgm = vlib_get_global_main ();
Damjan Marion6ffb7c62021-03-26 13:06:13 +0100689 vlib_main_t *vm = vlib_get_first_main (); /* one and only time for this! */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700690 unformat_input_t input;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400691 clib_error_t *e;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700692 int i;
693
Damjan Marionfd8deb42021-03-06 12:26:28 +0100694 vec_validate_aligned (vgm->vlib_mains, 0, CLIB_CACHE_LINE_BYTES);
695
Tom Jonesab479932024-04-24 10:30:20 +0000696 vgm->exec_path = (char *) os_get_exec_path ();
697
698 if (vgm->exec_path)
Damjan Marion2e90b292022-04-04 18:48:11 +0200699 {
Tom Jonesab479932024-04-24 10:30:20 +0000700 for (i = vec_len (vgm->exec_path) - 1; i > 0; i--)
701 if (vgm->exec_path[i - 1] == '/')
Damjan Marion2e90b292022-04-04 18:48:11 +0200702 break;
Tom Jonesab479932024-04-24 10:30:20 +0000703
704 vgm->name = 0;
705
706 vec_add (vgm->name, vgm->exec_path + i, vec_len (vgm->exec_path) - i);
707 vec_add1 (vgm->exec_path, 0);
708 vec_add1 (vgm->name, 0);
Damjan Marion2e90b292022-04-04 18:48:11 +0200709 }
710 else
711 vgm->exec_path = vgm->name = argv[0];
712
713 vgm->argv = (u8 **) argv;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700714
Dave Barach8dc954a2020-02-05 17:31:09 -0500715 clib_time_init (&vm->clib_time);
716
Dave Barachbc867c32020-11-25 10:07:09 -0500717 /* Turn on the event logger at the first possible moment */
Damjan Marionfd8deb42021-03-06 12:26:28 +0100718 vgm->configured_elog_ring_size = 128 << 10;
719 elog_init (vlib_get_elog_main (), vgm->configured_elog_ring_size);
Damjan Marionf553a2c2021-03-26 13:45:37 +0100720 elog_enable_disable (vlib_get_elog_main (), 1);
Dave Barachbc867c32020-11-25 10:07:09 -0500721
Damjan Marion2e90b292022-04-04 18:48:11 +0200722 unformat_init_command_line (&input, (char **) vgm->argv);
Damjan Marion3b46cba2017-01-23 21:13:45 +0100723 if ((e = vlib_plugin_config (vm, &input)))
724 {
725 clib_error_report (e);
726 return 1;
727 }
728 unformat_free (&input);
729
Ed Warnickecb9cada2015-12-08 15:45:58 -0700730 i = vlib_plugin_early_init (vm);
731 if (i)
732 return i;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400733
Damjan Marion2e90b292022-04-04 18:48:11 +0200734 unformat_init_command_line (&input, (char **) vgm->argv);
Damjan Marionfd8deb42021-03-06 12:26:28 +0100735 if (vgm->init_functions_called == 0)
736 vgm->init_functions_called = hash_create (0, /* value bytes */ 0);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400737 e = vlib_call_all_config_functions (vm, &input, 1 /* early */ );
Ed Warnickecb9cada2015-12-08 15:45:58 -0700738 if (e != 0)
739 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400740 clib_error_report (e);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700741 return 1;
742 }
743 unformat_free (&input);
744
Kingwel Xie497deaf2018-06-15 04:56:24 -0400745 /* always load symbols, for signal handler and mheap memory get/put backtrace */
Damjan Marion2e90b292022-04-04 18:48:11 +0200746 clib_elf_main_init (vgm->exec_path);
Kingwel Xie497deaf2018-06-15 04:56:24 -0400747
Dave Barach2180bac2019-05-10 15:25:10 -0400748 vec_validate (vlib_thread_stacks, 0);
Damjan Marion586afd72017-04-05 19:18:20 +0200749 vlib_thread_stack_init (0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700750
Damjan Marionf55f9b82017-05-10 21:06:28 +0200751 __os_thread_index = 0;
Keith Burns (alagalah)0bda0f42017-10-20 13:55:18 -0700752 vm->thread_index = 0;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400753
Damjan Marioncea46522020-05-21 16:47:05 +0200754 vlib_process_start_switch_stack (vm, 0);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400755 i = clib_calljmp (thread0, (uword) vm,
756 (void *) (vlib_thread_stacks[0] +
757 VLIB_THREAD_STACK_SIZE));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700758 return i;
759}
Dave Barach9b8ffd92016-07-08 08:13:45 -0400760
761/*
762 * fd.io coding-style-patch-verification: ON
763 *
764 * Local Variables:
765 * eval: (c-set-style "gnu")
766 * End:
767 */