2 * Copyright (c) 2018 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (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 #include <vcl/vcl_private.h>
18 /* NOTE: _vppcom_main is only used until the heap is allocated.
19 * Do not access it directly -- use vcm which will point to
20 * the heap allocated copy after init.
22 static vppcom_main_t _vppcom_main = {
23 .debug = VPPCOM_DEBUG_INIT,
28 vppcom_main_t *vcm = &_vppcom_main;
31 vppcom_cfg_init (vppcom_cfg_t * vcl_cfg)
35 vcl_cfg->heapsize = (256ULL << 20);
36 vcl_cfg->vpp_api_q_length = 1024;
37 vcl_cfg->segment_baseva = 0x200000000ULL;
38 vcl_cfg->segment_size = (256 << 20);
39 vcl_cfg->add_segment_size = (128 << 20);
40 vcl_cfg->preallocated_fifo_pairs = 8;
41 vcl_cfg->rx_fifo_size = (1 << 20);
42 vcl_cfg->tx_fifo_size = (1 << 20);
43 vcl_cfg->event_queue_size = 2048;
44 vcl_cfg->listen_queue_size = CLIB_CACHE_LINE_BYTES / sizeof (u32);
45 vcl_cfg->app_timeout = 10 * 60.0;
46 vcl_cfg->session_timeout = 10 * 60.0;
47 vcl_cfg->accept_timeout = 60.0;
48 vcl_cfg->event_ring_size = (128 << 10);
49 vcl_cfg->event_log_path = "/dev/shm";
52 #define VCL_CFG_DBG(_lvl, _fmt, _args...) \
53 if (vcm->debug > _lvl) \
54 fprintf (stderr, _fmt, ##_args)
56 vppcom_cfg_heapsize (char *conf_fname)
58 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
71 fp = fopen (conf_fname, "r");
74 VCL_CFG_DBG (0, "VCL<%d>: using default heapsize %lu (0x%lx)",
75 getpid (), vcl_cfg->heapsize, vcl_cfg->heapsize);
79 argv = calloc (1, sizeof (char *));
82 VCL_CFG_DBG (0, "VCL<%d>: calloc failed, using default heapsize %lu"
83 " (0x%lx)", getpid (), vcl_cfg->heapsize,
90 if (fgets (inbuf, 4096, fp) == 0)
92 p = strtok (inbuf, " \t\n");
98 char **tmp = realloc (argv, argc * sizeof (char *));
101 VCL_CFG_DBG (0, "VCL<%d>: realloc failed, using default "
102 "heapsize %lu (0x%lx)", getpid (),
103 vcl_cfg->heapsize, vcl_cfg->heapsize);
107 arg = strndup (p, 1024);
110 VCL_CFG_DBG (0, "VCL<%d>: strndup failed, using default "
111 "heapsize %ld (0x%lx)", getpid (),
112 vcl_cfg->heapsize, vcl_cfg->heapsize);
115 argv[argc - 1] = arg;
116 p = strtok (NULL, " \t\n");
123 char **tmp = realloc (argv, (argc + 1) * sizeof (char *));
126 VCL_CFG_DBG (0, "VCL<%d>: realloc failed, using default heapsize %ld "
127 "(0x%lx)", getpid (), vcl_cfg->heapsize,
135 * Look for and parse the "heapsize" config parameter.
136 * Manual since none of the clib infra has been bootstrapped yet.
138 * Format: heapsize <nn>[mM][gG]
141 for (i = 1; i < (argc - 1); i++)
143 if (!strncmp (argv[i], "heapsize", 8))
145 sizep = (u8 *) argv[i + 1];
147 while (*sizep >= '0' && *sizep <= '9')
150 size += *sizep++ - '0';
154 VCL_CFG_DBG (0, "VCL<%d>: parse error '%s %s', using default "
155 "heapsize %ld (0x%lx)", getpid (), argv[i],
156 argv[i + 1], vcl_cfg->heapsize, vcl_cfg->heapsize);
160 if (*sizep == 'g' || *sizep == 'G')
161 vcl_cfg->heapsize = size << 30;
162 else if (*sizep == 'm' || *sizep == 'M')
163 vcl_cfg->heapsize = size << 20;
166 VCL_CFG_DBG (0, "VCL<%d>: parse error '%s %s', using default "
167 "heapsize %ld (0x%lx)", getpid (), argv[i],
168 argv[i + 1], vcl_cfg->heapsize, vcl_cfg->heapsize);
180 vcl_mem = mmap (0, vcl_cfg->heapsize, PROT_READ | PROT_WRITE,
181 MAP_SHARED | MAP_ANONYMOUS, -1, 0);
182 if (vcl_mem == MAP_FAILED)
184 VCL_CFG_DBG (0, "VCL<%d>: ERROR: mmap(0, %ld == 0x%lx, "
185 "PROT_READ | PROT_WRITE,MAP_SHARED | MAP_ANONYMOUS, "
186 "-1, 0) failed!", getpid (), vcl_cfg->heapsize,
188 ASSERT (vcl_mem != MAP_FAILED);
191 heap = clib_mem_init_thread_safe (vcl_mem, vcl_cfg->heapsize);
194 fprintf (stderr, "VCL<%d>: ERROR: clib_mem_init() failed!", getpid ());
198 vcl_mem = clib_mem_alloc (sizeof (_vppcom_main));
201 clib_warning ("VCL<%d>: ERROR: clib_mem_alloc() failed!", getpid ());
206 clib_memcpy (vcl_mem, &_vppcom_main, sizeof (_vppcom_main));
209 VDBG (0, "VCL<%d>: allocated VCL heap = %p, size %lld (0x%llx)", getpid (),
210 heap, vcl_cfg->heapsize, vcl_cfg->heapsize);
214 vppcom_cfg_read_file (char *conf_fname)
216 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
218 unformat_input_t _input, *input = &_input;
219 unformat_input_t _line_input, *line_input = &_line_input;
225 fd = open (conf_fname, O_RDONLY);
228 VDBG (0, "VCL<%d>: using default configuration.", getpid (),
233 if (fstat (fd, &s) < 0)
235 VDBG (0, "VCL<%d>: failed to stat `%s', using default configuration",
236 getpid (), conf_fname);
240 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
242 VDBG (0, "VCL<%d>: not a regular file `%s', using default "
243 "configuration", getpid (), conf_fname);
247 unformat_init_clib_file (input, fd);
249 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
251 (void) unformat_user (input, unformat_line_input, line_input);
252 unformat_skip_white_space (line_input);
254 if (unformat (line_input, "vcl {"))
262 if (unformat (line_input, "heapsize %s", &chroot_path))
264 vec_terminate_c_string (chroot_path);
265 VDBG (0, "VCL<%d>: configured heapsize %s, actual heapsize %lld"
266 " (0x%llx)", getpid (), chroot_path, vcl_cfg->heapsize,
268 vec_free (chroot_path);
270 else if (unformat (line_input, "api-prefix %s", &chroot_path))
272 vec_terminate_c_string (chroot_path);
273 if (vcl_cfg->vpp_api_filename)
274 vec_free (vcl_cfg->vpp_api_filename);
275 vcl_cfg->vpp_api_filename = format (0, "/%s-vpe-api%c",
277 vl_set_memory_root_path ((char *) chroot_path);
279 VDBG (0, "VCL<%d>: configured api-prefix (%s) and api filename"
280 " (%s)", getpid (), chroot_path,
281 vcl_cfg->vpp_api_filename);
282 chroot_path = 0; /* Don't vec_free() it! */
284 else if (unformat (line_input, "vpp-api-q-length %d", &q_len))
286 if (q_len < vcl_cfg->vpp_api_q_length)
288 clib_warning ("VCL<%d>: ERROR: configured vpp-api-q-length "
289 "(%u) is too small! Using default: %u ",
290 getpid (), q_len, vcl_cfg->vpp_api_q_length);
294 vcl_cfg->vpp_api_q_length = q_len;
296 VDBG (0, "VCL<%d>: configured vpp-api-q-length %u",
297 getpid (), vcl_cfg->vpp_api_q_length);
300 else if (unformat (line_input, "uid %d", &uid))
302 vl_set_memory_uid (uid);
303 VDBG (0, "VCL<%d>: configured uid %d", getpid (), uid);
305 else if (unformat (line_input, "gid %d", &gid))
307 vl_set_memory_gid (gid);
308 VDBG (0, "VCL<%d>: configured gid %d", getpid (), gid);
310 else if (unformat (line_input, "segment-baseva 0x%lx",
311 &vcl_cfg->segment_baseva))
313 VDBG (0, "VCL<%d>: configured segment_baseva 0x%lx", getpid (),
314 vcl_cfg->segment_baseva);
316 else if (unformat (line_input, "segment-size 0x%lx",
317 &vcl_cfg->segment_size))
319 VDBG (0, "VCL<%d>: configured segment_size 0x%lx (%ld)",
320 getpid (), vcl_cfg->segment_size, vcl_cfg->segment_size);
322 else if (unformat (line_input, "segment-size %ld",
323 &vcl_cfg->segment_size))
325 VDBG (0, "VCL<%d>: configured segment_size %ld (0x%lx)",
326 getpid (), vcl_cfg->segment_size, vcl_cfg->segment_size);
328 else if (unformat (line_input, "add-segment-size 0x%lx",
329 &vcl_cfg->add_segment_size))
331 VDBG (0, "VCL<%d>: configured add_segment_size 0x%lx (%ld)",
332 getpid (), vcl_cfg->add_segment_size,
333 vcl_cfg->add_segment_size);
335 else if (unformat (line_input, "add-segment-size %ld",
336 &vcl_cfg->add_segment_size))
338 VDBG (0, "VCL<%d>: configured add_segment_size %ld (0x%lx)",
339 getpid (), vcl_cfg->add_segment_size,
340 vcl_cfg->add_segment_size);
342 else if (unformat (line_input, "preallocated-fifo-pairs %d",
343 &vcl_cfg->preallocated_fifo_pairs))
345 VDBG (0, "VCL<%d>: configured preallocated_fifo_pairs %d "
346 "(0x%x)", getpid (), vcl_cfg->preallocated_fifo_pairs,
347 vcl_cfg->preallocated_fifo_pairs);
349 else if (unformat (line_input, "rx-fifo-size 0x%lx",
350 &vcl_cfg->rx_fifo_size))
352 VDBG (0, "VCL<%d>: configured rx_fifo_size 0x%lx (%ld)",
353 getpid (), vcl_cfg->rx_fifo_size, vcl_cfg->rx_fifo_size);
355 else if (unformat (line_input, "rx-fifo-size %ld",
356 &vcl_cfg->rx_fifo_size))
358 VDBG (0, "VCL<%d>: configured rx_fifo_size %ld (0x%lx)",
359 getpid (), vcl_cfg->rx_fifo_size, vcl_cfg->rx_fifo_size);
361 else if (unformat (line_input, "tx-fifo-size 0x%lx",
362 &vcl_cfg->tx_fifo_size))
364 VDBG (0, "VCL<%d>: configured tx_fifo_size 0x%lx (%ld)",
365 getpid (), vcl_cfg->tx_fifo_size, vcl_cfg->tx_fifo_size);
367 else if (unformat (line_input, "tx-fifo-size %ld",
368 &vcl_cfg->tx_fifo_size))
370 VDBG (0, "VCL<%d>: configured tx_fifo_size %ld (0x%lx)",
371 getpid (), vcl_cfg->tx_fifo_size, vcl_cfg->tx_fifo_size);
373 else if (unformat (line_input, "event-queue-size 0x%lx",
374 &vcl_cfg->event_queue_size))
376 VDBG (0, "VCL<%d>: configured event_queue_size 0x%lx (%ld)",
377 getpid (), vcl_cfg->event_queue_size,
378 vcl_cfg->event_queue_size);
380 else if (unformat (line_input, "event-queue-size %ld",
381 &vcl_cfg->event_queue_size))
383 VDBG (0, "VCL<%d>: configured event_queue_size %ld (0x%lx)",
384 getpid (), vcl_cfg->event_queue_size,
385 vcl_cfg->event_queue_size);
387 else if (unformat (line_input, "listen-queue-size 0x%lx",
388 &vcl_cfg->listen_queue_size))
390 VDBG (0, "VCL<%d>: configured listen_queue_size 0x%lx (%ld)",
391 getpid (), vcl_cfg->listen_queue_size,
392 vcl_cfg->listen_queue_size);
394 else if (unformat (line_input, "listen-queue-size %ld",
395 &vcl_cfg->listen_queue_size))
397 VDBG (0, "VCL<%d>: configured listen_queue_size %ld (0x%lx)",
398 getpid (), vcl_cfg->listen_queue_size,
399 vcl_cfg->listen_queue_size);
401 else if (unformat (line_input, "app-timeout %f",
402 &vcl_cfg->app_timeout))
404 VDBG (0, "VCL<%d>: configured app_timeout %f",
405 getpid (), vcl_cfg->app_timeout);
407 else if (unformat (line_input, "session-timeout %f",
408 &vcl_cfg->session_timeout))
410 VDBG (0, "VCL<%d>: configured session_timeout %f",
411 getpid (), vcl_cfg->session_timeout);
413 else if (unformat (line_input, "accept-timeout %f",
414 &vcl_cfg->accept_timeout))
416 VDBG (0, "VCL<%d>: configured accept_timeout %f",
417 getpid (), vcl_cfg->accept_timeout);
419 else if (unformat (line_input, "app-proxy-transport-tcp"))
421 vcl_cfg->app_proxy_transport_tcp = 1;
422 VDBG (0, "VCL<%d>: configured app_proxy_transport_tcp (%d)",
423 getpid (), vcl_cfg->app_proxy_transport_tcp);
425 else if (unformat (line_input, "app-proxy-transport-udp"))
427 vcl_cfg->app_proxy_transport_udp = 1;
428 VDBG (0, "VCL<%d>: configured app_proxy_transport_udp (%d)",
429 getpid (), vcl_cfg->app_proxy_transport_udp);
431 else if (unformat (line_input, "app-scope-local"))
433 vcl_cfg->app_scope_local = 1;
434 VDBG (0, "VCL<%d>: configured app_scope_local (%d)",
435 getpid (), vcl_cfg->app_scope_local);
437 else if (unformat (line_input, "app-scope-global"))
439 vcl_cfg->app_scope_global = 1;
440 VDBG (0, "VCL<%d>: configured app_scope_global (%d)",
441 getpid (), vcl_cfg->app_scope_global);
443 else if (unformat (line_input, "namespace-secret %lu",
444 &vcl_cfg->namespace_secret))
446 VDBG (0, "VCL<%d>: configured namespace_secret %lu (0x%lx)",
447 getpid (), vcl_cfg->namespace_secret,
448 vcl_cfg->namespace_secret);
450 else if (unformat (line_input, "namespace-id %v",
451 &vcl_cfg->namespace_id))
453 u32 max_nsid_vec_len = vcl_max_nsid_len ();
454 u32 nsid_vec_len = vec_len (vcl_cfg->namespace_id);
455 if (nsid_vec_len > max_nsid_vec_len)
457 _vec_len (vcl_cfg->namespace_id) = max_nsid_vec_len;
458 VDBG (0, "VCL<%d>: configured namespace_id is too long,"
459 " truncated to %d characters!",
460 getpid (), max_nsid_vec_len);
463 VDBG (0, "VCL<%d>: configured namespace_id %v",
464 getpid (), vcl_cfg->namespace_id);
466 else if (unformat (line_input, "}"))
469 VDBG (0, "VCL<%d>: completed parsing vppcom config!",
475 if (line_input->buffer[line_input->index] != '#')
477 clib_warning ("VCL<%d>: Unknown vppcom config option: '%s'",
479 &line_input->buffer[line_input->index]);
486 unformat_free (input);
494 vppcom_cfg (vppcom_cfg_t * vcl_cfg)
496 char *conf_fname, *env_var_str;
498 vppcom_cfg_init (vcl_cfg);
499 env_var_str = getenv (VPPCOM_ENV_DEBUG);
503 if (sscanf (env_var_str, "%u", &tmp) != 1)
505 VCL_CFG_DBG (0, "VCL<%d>: WARNING: Invalid debug level specified "
506 "in the environment variable " VPPCOM_ENV_DEBUG
507 " (%s)!\n", getpid (), env_var_str);
512 VCL_CFG_DBG (0, "VCL<%d>: configured VCL debug level (%u) from "
513 VPPCOM_ENV_DEBUG "!", getpid (), vcm->debug);
516 conf_fname = getenv (VPPCOM_ENV_CONF);
518 conf_fname = VPPCOM_CONF_DEFAULT;
519 vppcom_cfg_heapsize (conf_fname);
520 vppcom_cfg_read_file (conf_fname);
522 env_var_str = getenv (VPPCOM_ENV_API_PREFIX);
525 if (vcl_cfg->vpp_api_filename)
526 vec_free (vcl_cfg->vpp_api_filename);
527 vcl_cfg->vpp_api_filename = format (0, "/%s-vpe-api%c", env_var_str, 0);
528 vl_set_memory_root_path ((char *) env_var_str);
530 VDBG (0, "VCL<%d>: configured api prefix (%s) and filename (%s) "
531 "from " VPPCOM_ENV_API_PREFIX "!",
532 getpid (), env_var_str, vcl_cfg->vpp_api_filename);
534 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_ID);
537 u32 ns_id_vec_len = strlen (env_var_str);
539 vec_reset_length (vcm->cfg.namespace_id);
540 vec_validate (vcm->cfg.namespace_id, ns_id_vec_len - 1);
541 clib_memcpy (vcm->cfg.namespace_id, env_var_str, ns_id_vec_len);
543 VDBG (0, "VCL<%d>: configured namespace_id (%v) from "
544 VPPCOM_ENV_APP_NAMESPACE_ID "!", getpid (),
545 vcm->cfg.namespace_id);
547 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_SECRET);
551 if (sscanf (env_var_str, "%lu", &tmp) != 1)
552 clib_warning ("VCL<%d>: WARNING: Invalid namespace secret "
553 "specified in the environment variable "
554 VPPCOM_ENV_APP_NAMESPACE_SECRET
555 " (%s)!\n", getpid (), env_var_str);
558 vcm->cfg.namespace_secret = tmp;
559 VDBG (0, "VCL<%d>: configured namespace secret (%lu) from "
560 VPPCOM_ENV_APP_NAMESPACE_SECRET "!", getpid (),
561 vcm->cfg.namespace_secret);
564 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP))
566 vcm->cfg.app_proxy_transport_tcp = 1;
567 VDBG (0, "VCL<%d>: configured app_proxy_transport_tcp (%u) from "
568 VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP "!", getpid (),
569 vcm->cfg.app_proxy_transport_tcp);
571 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP))
573 vcm->cfg.app_proxy_transport_udp = 1;
574 VDBG (0, "VCL<%d>: configured app_proxy_transport_udp (%u) from "
575 VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP "!", getpid (),
576 vcm->cfg.app_proxy_transport_udp);
578 if (getenv (VPPCOM_ENV_APP_SCOPE_LOCAL))
580 vcm->cfg.app_scope_local = 1;
581 VDBG (0, "VCL<%d>: configured app_scope_local (%u) from "
582 VPPCOM_ENV_APP_SCOPE_LOCAL "!", getpid (),
583 vcm->cfg.app_scope_local);
585 if (getenv (VPPCOM_ENV_APP_SCOPE_GLOBAL))
587 vcm->cfg.app_scope_global = 1;
588 VDBG (0, "VCL<%d>: configured app_scope_global (%u) from "
589 VPPCOM_ENV_APP_SCOPE_GLOBAL "!", getpid (),
590 vcm->cfg.app_scope_global);
595 * fd.io coding-style-patch-verification: ON
598 * eval: (c-set-style "gnu")