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,
27 vppcom_main_t *vcm = &_vppcom_main;
30 vppcom_cfg_init (vppcom_cfg_t * vcl_cfg)
36 vcl_cfg->heapsize = (256ULL << 20);
37 vcl_cfg->vpp_api_q_length = 1024;
38 vcl_cfg->segment_baseva = 0x200000000ULL;
39 vcl_cfg->segment_size = (256 << 20);
40 vcl_cfg->add_segment_size = (128 << 20);
41 vcl_cfg->preallocated_fifo_pairs = 8;
42 vcl_cfg->rx_fifo_size = (1 << 20);
43 vcl_cfg->tx_fifo_size = (1 << 20);
44 vcl_cfg->event_queue_size = 2048;
45 vcl_cfg->listen_queue_size = CLIB_CACHE_LINE_BYTES / sizeof (u32);
46 vcl_cfg->app_timeout = 10 * 60.0;
47 vcl_cfg->session_timeout = 10 * 60.0;
48 vcl_cfg->accept_timeout = 60.0;
49 vcl_cfg->event_ring_size = (128 << 10);
50 vcl_cfg->event_log_path = "/dev/shm";
52 env_var_str = getenv (VPPCOM_ENV_DEBUG);
56 if (sscanf (env_var_str, "%u", &tmp) != 1)
57 clib_warning ("VCL<%d>: WARNING: Invalid debug level specified in the"
58 " environment variable " VPPCOM_ENV_DEBUG " (%s)!\n",
59 getpid (), env_var_str);
63 VDBG (0, "VCL<%d>: configured VCL debug level (%u) from "
64 VPPCOM_ENV_DEBUG "!", getpid (), vcm->debug);
70 vppcom_cfg_heapsize (char *conf_fname)
72 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
85 fp = fopen (conf_fname, "r");
88 VDBG (0, "VCL<%d>: using default heapsize %lld (0x%llx)", getpid (),
89 vcl_cfg->heapsize, vcl_cfg->heapsize);
93 argv = calloc (1, sizeof (char *));
96 VDBG (0, "VCL<%d>: calloc failed, using default heapsize %lld (0x%llx)",
97 getpid (), vcl_cfg->heapsize, vcl_cfg->heapsize);
103 if (fgets (inbuf, 4096, fp) == 0)
105 p = strtok (inbuf, " \t\n");
111 char **tmp = realloc (argv, argc * sizeof (char *));
114 VDBG (0, "VCL<%d>: realloc failed, using default heapsize %lld "
115 "(0x%llx)", getpid (), vcl_cfg->heapsize,
120 arg = strndup (p, 1024);
123 VDBG (0, "VCL<%d>: strndup failed, using default heapsize %lld "
124 "(0x%llx)", getpid (), vcl_cfg->heapsize,
128 argv[argc - 1] = arg;
129 p = strtok (NULL, " \t\n");
136 char **tmp = realloc (argv, (argc + 1) * sizeof (char *));
139 VDBG (0, "VCL<%d>: realloc failed, using default heapsize %lld "
140 "(0x%llx)", getpid (), vcl_cfg->heapsize, vcl_cfg->heapsize);
147 * Look for and parse the "heapsize" config parameter.
148 * Manual since none of the clib infra has been bootstrapped yet.
150 * Format: heapsize <nn>[mM][gG]
153 for (i = 1; i < (argc - 1); i++)
155 if (!strncmp (argv[i], "heapsize", 8))
157 sizep = (u8 *) argv[i + 1];
159 while (*sizep >= '0' && *sizep <= '9')
162 size += *sizep++ - '0';
166 VDBG (0, "VCL<%d>: parse error '%s %s', using default "
167 "heapsize %lld (0x%llx)", getpid (), argv[i], argv[i + 1],
168 vcl_cfg->heapsize, vcl_cfg->heapsize);
172 if (*sizep == 'g' || *sizep == 'G')
173 vcl_cfg->heapsize = size << 30;
174 else if (*sizep == 'm' || *sizep == 'M')
175 vcl_cfg->heapsize = size << 20;
178 VDBG (0, "VCL<%d>: parse error '%s %s', using default "
179 "heapsize %lld (0x%llx)", getpid (), argv[i], argv[i + 1],
180 vcl_cfg->heapsize, vcl_cfg->heapsize);
192 vcl_mem = mmap (0, vcl_cfg->heapsize, PROT_READ | PROT_WRITE,
193 MAP_SHARED | MAP_ANONYMOUS, -1, 0);
194 if (vcl_mem == MAP_FAILED)
196 clib_unix_error ("VCL<%d>: ERROR: mmap(0, %lld == 0x%llx, "
197 "PROT_READ | PROT_WRITE,MAP_SHARED | MAP_ANONYMOUS, "
199 getpid (), vcl_cfg->heapsize, vcl_cfg->heapsize);
200 ASSERT (vcl_mem != MAP_FAILED);
203 heap = clib_mem_init_thread_safe (vcl_mem, vcl_cfg->heapsize);
206 clib_warning ("VCL<%d>: ERROR: clib_mem_init() failed!", getpid ());
210 vcl_mem = clib_mem_alloc (sizeof (_vppcom_main));
213 clib_warning ("VCL<%d>: ERROR: clib_mem_alloc() failed!", getpid ());
218 clib_memcpy (vcl_mem, &_vppcom_main, sizeof (_vppcom_main));
221 VDBG (0, "VCL<%d>: allocated VCL heap = %p, size %lld (0x%llx)", getpid (),
222 heap, vcl_cfg->heapsize, vcl_cfg->heapsize);
226 vppcom_cfg_read_file (char *conf_fname)
228 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
230 unformat_input_t _input, *input = &_input;
231 unformat_input_t _line_input, *line_input = &_line_input;
237 fd = open (conf_fname, O_RDONLY);
240 VDBG (0, "VCL<%d>: using default configuration.", getpid (),
245 if (fstat (fd, &s) < 0)
247 VDBG (0, "VCL<%d>: failed to stat `%s', using default configuration",
248 getpid (), conf_fname);
252 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
254 VDBG (0, "VCL<%d>: not a regular file `%s', using default "
255 "configuration", getpid (), conf_fname);
259 unformat_init_clib_file (input, fd);
261 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
263 (void) unformat_user (input, unformat_line_input, line_input);
264 unformat_skip_white_space (line_input);
266 if (unformat (line_input, "vcl {"))
274 if (unformat (line_input, "heapsize %s", &chroot_path))
276 vec_terminate_c_string (chroot_path);
277 VDBG (0, "VCL<%d>: configured heapsize %s, actual heapsize %lld"
278 " (0x%llx)", getpid (), chroot_path, vcl_cfg->heapsize,
280 vec_free (chroot_path);
282 else if (unformat (line_input, "api-prefix %s", &chroot_path))
284 vec_terminate_c_string (chroot_path);
285 if (vcl_cfg->vpp_api_filename)
286 vec_free (vcl_cfg->vpp_api_filename);
287 vcl_cfg->vpp_api_filename = format (0, "/%s-vpe-api%c",
289 vl_set_memory_root_path ((char *) chroot_path);
291 VDBG (0, "VCL<%d>: configured api-prefix (%s) and api filename"
292 " (%s)", getpid (), chroot_path,
293 vcl_cfg->vpp_api_filename);
294 chroot_path = 0; /* Don't vec_free() it! */
296 else if (unformat (line_input, "vpp-api-q-length %d", &q_len))
298 if (q_len < vcl_cfg->vpp_api_q_length)
300 clib_warning ("VCL<%d>: ERROR: configured vpp-api-q-length "
301 "(%u) is too small! Using default: %u ",
302 getpid (), q_len, vcl_cfg->vpp_api_q_length);
306 vcl_cfg->vpp_api_q_length = q_len;
308 VDBG (0, "VCL<%d>: configured vpp-api-q-length %u",
309 getpid (), vcl_cfg->vpp_api_q_length);
312 else if (unformat (line_input, "uid %d", &uid))
314 vl_set_memory_uid (uid);
315 VDBG (0, "VCL<%d>: configured uid %d", getpid (), uid);
317 else if (unformat (line_input, "gid %d", &gid))
319 vl_set_memory_gid (gid);
320 VDBG (0, "VCL<%d>: configured gid %d", getpid (), gid);
322 else if (unformat (line_input, "segment-baseva 0x%lx",
323 &vcl_cfg->segment_baseva))
325 VDBG (0, "VCL<%d>: configured segment_baseva 0x%lx", getpid (),
326 vcl_cfg->segment_baseva);
328 else if (unformat (line_input, "segment-size 0x%lx",
329 &vcl_cfg->segment_size))
331 VDBG (0, "VCL<%d>: configured segment_size 0x%lx (%ld)",
332 getpid (), vcl_cfg->segment_size, vcl_cfg->segment_size);
334 else if (unformat (line_input, "segment-size %ld",
335 &vcl_cfg->segment_size))
337 VDBG (0, "VCL<%d>: configured segment_size %ld (0x%lx)",
338 getpid (), vcl_cfg->segment_size, vcl_cfg->segment_size);
340 else if (unformat (line_input, "add-segment-size 0x%lx",
341 &vcl_cfg->add_segment_size))
343 VDBG (0, "VCL<%d>: configured add_segment_size 0x%lx (%ld)",
344 getpid (), vcl_cfg->add_segment_size,
345 vcl_cfg->add_segment_size);
347 else if (unformat (line_input, "add-segment-size %ld",
348 &vcl_cfg->add_segment_size))
350 VDBG (0, "VCL<%d>: configured add_segment_size %ld (0x%lx)",
351 getpid (), vcl_cfg->add_segment_size,
352 vcl_cfg->add_segment_size);
354 else if (unformat (line_input, "preallocated-fifo-pairs %d",
355 &vcl_cfg->preallocated_fifo_pairs))
357 VDBG (0, "VCL<%d>: configured preallocated_fifo_pairs %d "
358 "(0x%x)", getpid (), vcl_cfg->preallocated_fifo_pairs,
359 vcl_cfg->preallocated_fifo_pairs);
361 else if (unformat (line_input, "rx-fifo-size 0x%lx",
362 &vcl_cfg->rx_fifo_size))
364 VDBG (0, "VCL<%d>: configured rx_fifo_size 0x%lx (%ld)",
365 getpid (), vcl_cfg->rx_fifo_size, vcl_cfg->rx_fifo_size);
367 else if (unformat (line_input, "rx-fifo-size %ld",
368 &vcl_cfg->rx_fifo_size))
370 VDBG (0, "VCL<%d>: configured rx_fifo_size %ld (0x%lx)",
371 getpid (), vcl_cfg->rx_fifo_size, vcl_cfg->rx_fifo_size);
373 else if (unformat (line_input, "tx-fifo-size 0x%lx",
374 &vcl_cfg->tx_fifo_size))
376 VDBG (0, "VCL<%d>: configured tx_fifo_size 0x%lx (%ld)",
377 getpid (), vcl_cfg->tx_fifo_size, vcl_cfg->tx_fifo_size);
379 else if (unformat (line_input, "tx-fifo-size %ld",
380 &vcl_cfg->tx_fifo_size))
382 VDBG (0, "VCL<%d>: configured tx_fifo_size %ld (0x%lx)",
383 getpid (), vcl_cfg->tx_fifo_size, vcl_cfg->tx_fifo_size);
385 else if (unformat (line_input, "event-queue-size 0x%lx",
386 &vcl_cfg->event_queue_size))
388 VDBG (0, "VCL<%d>: configured event_queue_size 0x%lx (%ld)",
389 getpid (), vcl_cfg->event_queue_size,
390 vcl_cfg->event_queue_size);
392 else if (unformat (line_input, "event-queue-size %ld",
393 &vcl_cfg->event_queue_size))
395 VDBG (0, "VCL<%d>: configured event_queue_size %ld (0x%lx)",
396 getpid (), vcl_cfg->event_queue_size,
397 vcl_cfg->event_queue_size);
399 else if (unformat (line_input, "listen-queue-size 0x%lx",
400 &vcl_cfg->listen_queue_size))
402 VDBG (0, "VCL<%d>: configured listen_queue_size 0x%lx (%ld)",
403 getpid (), vcl_cfg->listen_queue_size,
404 vcl_cfg->listen_queue_size);
406 else if (unformat (line_input, "listen-queue-size %ld",
407 &vcl_cfg->listen_queue_size))
409 VDBG (0, "VCL<%d>: configured listen_queue_size %ld (0x%lx)",
410 getpid (), vcl_cfg->listen_queue_size,
411 vcl_cfg->listen_queue_size);
413 else if (unformat (line_input, "app-timeout %f",
414 &vcl_cfg->app_timeout))
416 VDBG (0, "VCL<%d>: configured app_timeout %f",
417 getpid (), vcl_cfg->app_timeout);
419 else if (unformat (line_input, "session-timeout %f",
420 &vcl_cfg->session_timeout))
422 VDBG (0, "VCL<%d>: configured session_timeout %f",
423 getpid (), vcl_cfg->session_timeout);
425 else if (unformat (line_input, "accept-timeout %f",
426 &vcl_cfg->accept_timeout))
428 VDBG (0, "VCL<%d>: configured accept_timeout %f",
429 getpid (), vcl_cfg->accept_timeout);
431 else if (unformat (line_input, "app-proxy-transport-tcp"))
433 vcl_cfg->app_proxy_transport_tcp = 1;
434 VDBG (0, "VCL<%d>: configured app_proxy_transport_tcp (%d)",
435 getpid (), vcl_cfg->app_proxy_transport_tcp);
437 else if (unformat (line_input, "app-proxy-transport-udp"))
439 vcl_cfg->app_proxy_transport_udp = 1;
440 VDBG (0, "VCL<%d>: configured app_proxy_transport_udp (%d)",
441 getpid (), vcl_cfg->app_proxy_transport_udp);
443 else if (unformat (line_input, "app-scope-local"))
445 vcl_cfg->app_scope_local = 1;
446 VDBG (0, "VCL<%d>: configured app_scope_local (%d)",
447 getpid (), vcl_cfg->app_scope_local);
449 else if (unformat (line_input, "app-scope-global"))
451 vcl_cfg->app_scope_global = 1;
452 VDBG (0, "VCL<%d>: configured app_scope_global (%d)",
453 getpid (), vcl_cfg->app_scope_global);
455 else if (unformat (line_input, "namespace-secret %lu",
456 &vcl_cfg->namespace_secret))
458 VDBG (0, "VCL<%d>: configured namespace_secret %lu (0x%lx)",
459 getpid (), vcl_cfg->namespace_secret,
460 vcl_cfg->namespace_secret);
462 else if (unformat (line_input, "namespace-id %v",
463 &vcl_cfg->namespace_id))
465 u32 max_nsid_vec_len = vcl_max_nsid_len ();
466 u32 nsid_vec_len = vec_len (vcl_cfg->namespace_id);
467 if (nsid_vec_len > max_nsid_vec_len)
469 _vec_len (vcl_cfg->namespace_id) = max_nsid_vec_len;
470 VDBG (0, "VCL<%d>: configured namespace_id is too long,"
471 " truncated to %d characters!",
472 getpid (), max_nsid_vec_len);
475 VDBG (0, "VCL<%d>: configured namespace_id %v",
476 getpid (), vcl_cfg->namespace_id);
478 else if (unformat (line_input, "}"))
481 VDBG (0, "VCL<%d>: completed parsing vppcom config!",
487 if (line_input->buffer[line_input->index] != '#')
489 clib_warning ("VCL<%d>: Unknown vppcom config option: '%s'",
491 &line_input->buffer[line_input->index]);
498 unformat_free (input);
506 vppcom_cfg (vppcom_cfg_t * vcl_cfg)
508 char *conf_fname, *env_var_str;
510 vppcom_cfg_init (vcl_cfg);
511 env_var_str = getenv (VPPCOM_ENV_DEBUG);
515 if (sscanf (env_var_str, "%u", &tmp) != 1)
516 clib_warning ("VCL<%d>: WARNING: Invalid debug level specified "
517 "in the environment variable " VPPCOM_ENV_DEBUG
518 " (%s)!\n", getpid (), env_var_str);
522 VDBG (0, "VCL<%d>: configured VCL debug level (%u) from "
523 VPPCOM_ENV_DEBUG "!", getpid (), vcm->debug);
526 conf_fname = getenv (VPPCOM_ENV_CONF);
528 conf_fname = VPPCOM_CONF_DEFAULT;
529 vppcom_cfg_heapsize (conf_fname);
530 vppcom_cfg_read_file (conf_fname);
532 env_var_str = getenv (VPPCOM_ENV_API_PREFIX);
535 if (vcl_cfg->vpp_api_filename)
536 vec_free (vcl_cfg->vpp_api_filename);
537 vcl_cfg->vpp_api_filename = format (0, "/%s-vpe-api%c", env_var_str, 0);
538 vl_set_memory_root_path ((char *) env_var_str);
540 VDBG (0, "VCL<%d>: configured api prefix (%s) and filename (%s) "
541 "from " VPPCOM_ENV_API_PREFIX "!",
542 getpid (), env_var_str, vcl_cfg->vpp_api_filename);
544 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_ID);
547 u32 ns_id_vec_len = strlen (env_var_str);
549 vec_reset_length (vcm->cfg.namespace_id);
550 vec_validate (vcm->cfg.namespace_id, ns_id_vec_len - 1);
551 clib_memcpy (vcm->cfg.namespace_id, env_var_str, ns_id_vec_len);
553 VDBG (0, "VCL<%d>: configured namespace_id (%v) from "
554 VPPCOM_ENV_APP_NAMESPACE_ID "!", getpid (),
555 vcm->cfg.namespace_id);
557 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_SECRET);
561 if (sscanf (env_var_str, "%lu", &tmp) != 1)
562 clib_warning ("VCL<%d>: WARNING: Invalid namespace secret "
563 "specified in the environment variable "
564 VPPCOM_ENV_APP_NAMESPACE_SECRET
565 " (%s)!\n", getpid (), env_var_str);
568 vcm->cfg.namespace_secret = tmp;
569 VDBG (0, "VCL<%d>: configured namespace secret (%lu) from "
570 VPPCOM_ENV_APP_NAMESPACE_SECRET "!", getpid (),
571 vcm->cfg.namespace_secret);
574 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP))
576 vcm->cfg.app_proxy_transport_tcp = 1;
577 VDBG (0, "VCL<%d>: configured app_proxy_transport_tcp (%u) from "
578 VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP "!", getpid (),
579 vcm->cfg.app_proxy_transport_tcp);
581 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP))
583 vcm->cfg.app_proxy_transport_udp = 1;
584 VDBG (0, "VCL<%d>: configured app_proxy_transport_udp (%u) from "
585 VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP "!", getpid (),
586 vcm->cfg.app_proxy_transport_udp);
588 if (getenv (VPPCOM_ENV_APP_SCOPE_LOCAL))
590 vcm->cfg.app_scope_local = 1;
591 VDBG (0, "VCL<%d>: configured app_scope_local (%u) from "
592 VPPCOM_ENV_APP_SCOPE_LOCAL "!", getpid (),
593 vcm->cfg.app_scope_local);
595 if (getenv (VPPCOM_ENV_APP_SCOPE_GLOBAL))
597 vcm->cfg.app_scope_global = 1;
598 VDBG (0, "VCL<%d>: configured app_scope_global (%u) from "
599 VPPCOM_ENV_APP_SCOPE_GLOBAL "!", getpid (),
600 vcm->cfg.app_scope_global);
605 * fd.io coding-style-patch-verification: ON
608 * eval: (c-set-style "gnu")