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->max_workers = 16;
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";
53 #define VCFG_DBG(_lvl, _fmt, _args...) \
55 if (vcm->debug > _lvl) \
56 fprintf (stderr, _fmt "\n", ##_args); \
59 vppcom_cfg_heapsize (char *conf_fname)
61 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
74 fp = fopen (conf_fname, "r");
77 VCFG_DBG (0, "VCL<%d>: using default heapsize %lu (0x%lx)",
78 getpid (), vcl_cfg->heapsize, vcl_cfg->heapsize);
82 argv = calloc (1, sizeof (char *));
85 VCFG_DBG (0, "VCL<%d>: calloc failed, using default heapsize %lu"
86 " (0x%lx)", getpid (), vcl_cfg->heapsize, vcl_cfg->heapsize);
92 if (fgets (inbuf, 4096, fp) == 0)
94 p = strtok (inbuf, " \t\n");
100 char **tmp = realloc (argv, argc * sizeof (char *));
103 VCFG_DBG (0, "VCL<%d>: realloc failed, using default "
104 "heapsize %lu (0x%lx)", getpid (),
105 vcl_cfg->heapsize, vcl_cfg->heapsize);
109 arg = strndup (p, 1024);
112 VCFG_DBG (0, "VCL<%d>: strndup failed, using default "
113 "heapsize %ld (0x%lx)", getpid (),
114 vcl_cfg->heapsize, vcl_cfg->heapsize);
117 argv[argc - 1] = arg;
118 p = strtok (NULL, " \t\n");
125 char **tmp = realloc (argv, (argc + 1) * sizeof (char *));
128 VCFG_DBG (0, "VCL<%d>: realloc failed, using default heapsize %ld "
129 "(0x%lx)", getpid (), vcl_cfg->heapsize, vcl_cfg->heapsize);
136 * Look for and parse the "heapsize" config parameter.
137 * Manual since none of the clib infra has been bootstrapped yet.
139 * Format: heapsize <nn>[mM][gG]
142 for (i = 1; i < (argc - 1); i++)
144 if (!strncmp (argv[i], "heapsize", 8))
146 sizep = (u8 *) argv[i + 1];
148 while (*sizep >= '0' && *sizep <= '9')
151 size += *sizep++ - '0';
155 VCFG_DBG (0, "VCL<%d>: parse error '%s %s', using default "
156 "heapsize %ld (0x%lx)", getpid (), argv[i],
157 argv[i + 1], vcl_cfg->heapsize, vcl_cfg->heapsize);
161 if (*sizep == 'g' || *sizep == 'G')
162 vcl_cfg->heapsize = size << 30;
163 else if (*sizep == 'm' || *sizep == 'M')
164 vcl_cfg->heapsize = size << 20;
167 VCFG_DBG (0, "VCL<%d>: parse error '%s %s', using default "
168 "heapsize %ld (0x%lx)", getpid (), argv[i],
169 argv[i + 1], vcl_cfg->heapsize, vcl_cfg->heapsize);
182 vcl_mem = mmap (0, vcl_cfg->heapsize, PROT_READ | PROT_WRITE,
183 MAP_SHARED | MAP_ANONYMOUS, -1, 0);
184 if (vcl_mem == MAP_FAILED)
186 VCFG_DBG (0, "VCL<%d>: ERROR: mmap(0, %ld == 0x%lx, "
187 "PROT_READ | PROT_WRITE,MAP_SHARED | MAP_ANONYMOUS, "
188 "-1, 0) failed!", getpid (), vcl_cfg->heapsize,
190 ASSERT (vcl_mem != MAP_FAILED);
193 heap = clib_mem_init_thread_safe (vcl_mem, vcl_cfg->heapsize);
196 fprintf (stderr, "VCL<%d>: ERROR: clib_mem_init() failed!", getpid ());
200 vcl_mem = clib_mem_alloc (sizeof (_vppcom_main));
203 clib_warning ("VCL<%d>: ERROR: clib_mem_alloc() failed!", getpid ());
208 clib_memcpy (vcl_mem, &_vppcom_main, sizeof (_vppcom_main));
211 VCFG_DBG (0, "VCL<%d>: allocated VCL heap = %p, size %ld (0x%lx)",
212 getpid (), heap, vcl_cfg->heapsize, vcl_cfg->heapsize);
216 vppcom_cfg_read_file (char *conf_fname)
218 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
220 unformat_input_t _input, *input = &_input;
221 unformat_input_t _line_input, *line_input = &_line_input;
222 u8 vc_cfg_input = 0, *chroot_path;
226 fd = open (conf_fname, O_RDONLY);
229 VCFG_DBG (0, "VCL<%d>: using default configuration.", getpid ());
233 if (fstat (fd, &s) < 0)
235 VCFG_DBG (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 VCFG_DBG (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 {"))
257 unformat_free (line_input);
263 if (unformat (line_input, "heapsize %U", unformat_memory_size,
266 VCFG_DBG (0, "VCL<%d>: configured heapsize %lu", getpid (),
271 (line_input, "max-workers %u", &vcl_cfg->max_workers))
273 VCFG_DBG (0, "VCL<%d>: configured max-workers %u", getpid (),
274 vcl_cfg->max_workers);
276 else if (unformat (line_input, "api-prefix %s", &chroot_path))
278 vec_terminate_c_string (chroot_path);
279 if (vcl_cfg->vpp_api_filename)
280 vec_free (vcl_cfg->vpp_api_filename);
281 vcl_cfg->vpp_api_filename = format (0, "/%s-vpe-api%c",
283 vl_set_memory_root_path ((char *) chroot_path);
285 VCFG_DBG (0, "VCL<%d>: configured api-prefix (%s) and api "
286 "filename (%s)", getpid (), chroot_path,
287 vcl_cfg->vpp_api_filename);
288 chroot_path = 0; /* Don't vec_free() it! */
290 else if (unformat (line_input, "api-socket-name %s",
291 &vcl_cfg->vpp_api_socket_name))
293 vec_terminate_c_string (vcl_cfg->vpp_api_socket_name);
294 VCFG_DBG (0, "VCL<%d>: configured api-socket-name (%s)",
295 getpid (), vcl_cfg->vpp_api_socket_name);
297 else if (unformat (line_input, "vpp-api-q-length %d", &q_len))
299 if (q_len < vcl_cfg->vpp_api_q_length)
302 "VCL<%d>: ERROR: configured vpp-api-q-length "
303 "(%u) is too small! Using default: %u ", getpid (),
304 q_len, vcl_cfg->vpp_api_q_length);
308 vcl_cfg->vpp_api_q_length = q_len;
310 VCFG_DBG (0, "VCL<%d>: configured vpp-api-q-length %u",
311 getpid (), vcl_cfg->vpp_api_q_length);
314 else if (unformat (line_input, "uid %d", &uid))
316 vl_set_memory_uid (uid);
317 VCFG_DBG (0, "VCL<%d>: configured uid %d", getpid (), uid);
319 else if (unformat (line_input, "gid %d", &gid))
321 vl_set_memory_gid (gid);
322 VCFG_DBG (0, "VCL<%d>: configured gid %d", getpid (), gid);
324 else if (unformat (line_input, "segment-baseva 0x%x",
325 &vcl_cfg->segment_baseva))
327 VCFG_DBG (0, "VCL<%d>: configured segment_baseva 0x%lx",
328 getpid (), vcl_cfg->segment_baseva);
330 else if (unformat (line_input, "segment-size 0x%x",
331 &vcl_cfg->segment_size))
333 VCFG_DBG (0, "VCL<%d>: configured segment_size 0x%x (%d)",
334 getpid (), vcl_cfg->segment_size,
335 vcl_cfg->segment_size);
337 else if (unformat (line_input, "segment-size %d",
338 &vcl_cfg->segment_size))
340 VCFG_DBG (0, "VCL<%d>: configured segment_size %d (0x%x)",
341 getpid (), vcl_cfg->segment_size,
342 vcl_cfg->segment_size);
344 else if (unformat (line_input, "add-segment-size 0x%x",
345 &vcl_cfg->add_segment_size))
347 VCFG_DBG (0, "VCL<%d>: configured add_segment_size 0x%x (%d)",
348 getpid (), vcl_cfg->add_segment_size,
349 vcl_cfg->add_segment_size);
351 else if (unformat (line_input, "add-segment-size %d",
352 &vcl_cfg->add_segment_size))
354 VCFG_DBG (0, "VCL<%d>: configured add_segment_size %d (0x%x)",
355 getpid (), vcl_cfg->add_segment_size,
356 vcl_cfg->add_segment_size);
358 else if (unformat (line_input, "preallocated-fifo-pairs %d",
359 &vcl_cfg->preallocated_fifo_pairs))
361 VCFG_DBG (0, "VCL<%d>: configured preallocated_fifo_pairs %d "
362 "(0x%x)", getpid (), vcl_cfg->preallocated_fifo_pairs,
363 vcl_cfg->preallocated_fifo_pairs);
365 else if (unformat (line_input, "rx-fifo-size 0x%lx",
366 &vcl_cfg->rx_fifo_size))
368 VCFG_DBG (0, "VCL<%d>: configured rx_fifo_size 0x%x (%d)",
369 getpid (), vcl_cfg->rx_fifo_size,
370 vcl_cfg->rx_fifo_size);
372 else if (unformat (line_input, "rx-fifo-size %d",
373 &vcl_cfg->rx_fifo_size))
375 VCFG_DBG (0, "VCL<%d>: configured rx_fifo_size %d (0x%x)",
376 getpid (), vcl_cfg->rx_fifo_size,
377 vcl_cfg->rx_fifo_size);
379 else if (unformat (line_input, "tx-fifo-size 0x%lx",
380 &vcl_cfg->tx_fifo_size))
382 VCFG_DBG (0, "VCL<%d>: configured tx_fifo_size 0x%x (%d)",
383 getpid (), vcl_cfg->tx_fifo_size,
384 vcl_cfg->tx_fifo_size);
386 else if (unformat (line_input, "tx-fifo-size %ld",
387 &vcl_cfg->tx_fifo_size))
389 VCFG_DBG (0, "VCL<%d>: configured tx_fifo_size %d (0x%x)",
390 getpid (), vcl_cfg->tx_fifo_size,
391 vcl_cfg->tx_fifo_size);
393 else if (unformat (line_input, "event-queue-size 0x%lx",
394 &vcl_cfg->event_queue_size))
396 VCFG_DBG (0, "VCL<%d>: configured event_queue_size 0x%x (%d)",
397 getpid (), vcl_cfg->event_queue_size,
398 vcl_cfg->event_queue_size);
400 else if (unformat (line_input, "event-queue-size %ld",
401 &vcl_cfg->event_queue_size))
403 VCFG_DBG (0, "VCL<%d>: configured event_queue_size %d (0x%x)",
404 getpid (), vcl_cfg->event_queue_size,
405 vcl_cfg->event_queue_size);
407 else if (unformat (line_input, "listen-queue-size 0x%lx",
408 &vcl_cfg->listen_queue_size))
410 VCFG_DBG (0, "VCL<%d>: configured listen_queue_size 0x%x (%u)",
411 getpid (), vcl_cfg->listen_queue_size,
412 vcl_cfg->listen_queue_size);
414 else if (unformat (line_input, "listen-queue-size %ld",
415 &vcl_cfg->listen_queue_size))
417 VCFG_DBG (0, "VCL<%d>: configured listen_queue_size %u (0x%x)",
418 getpid (), vcl_cfg->listen_queue_size,
419 vcl_cfg->listen_queue_size);
421 else if (unformat (line_input, "app-timeout %f",
422 &vcl_cfg->app_timeout))
424 VCFG_DBG (0, "VCL<%d>: configured app_timeout %f",
425 getpid (), vcl_cfg->app_timeout);
427 else if (unformat (line_input, "session-timeout %f",
428 &vcl_cfg->session_timeout))
430 VCFG_DBG (0, "VCL<%d>: configured session_timeout %f",
431 getpid (), vcl_cfg->session_timeout);
433 else if (unformat (line_input, "accept-timeout %f",
434 &vcl_cfg->accept_timeout))
436 VCFG_DBG (0, "VCL<%d>: configured accept_timeout %f",
437 getpid (), vcl_cfg->accept_timeout);
439 else if (unformat (line_input, "app-proxy-transport-tcp"))
441 vcl_cfg->app_proxy_transport_tcp = 1;
442 VCFG_DBG (0, "VCL<%d>: configured app_proxy_transport_tcp (%d)",
443 getpid (), vcl_cfg->app_proxy_transport_tcp);
445 else if (unformat (line_input, "app-proxy-transport-udp"))
447 vcl_cfg->app_proxy_transport_udp = 1;
448 VCFG_DBG (0, "VCL<%d>: configured app_proxy_transport_udp (%d)",
449 getpid (), vcl_cfg->app_proxy_transport_udp);
451 else if (unformat (line_input, "app-scope-local"))
453 vcl_cfg->app_scope_local = 1;
454 VCFG_DBG (0, "VCL<%d>: configured app_scope_local (%d)",
455 getpid (), vcl_cfg->app_scope_local);
457 else if (unformat (line_input, "app-scope-global"))
459 vcl_cfg->app_scope_global = 1;
460 VCFG_DBG (0, "VCL<%d>: configured app_scope_global (%d)",
461 getpid (), vcl_cfg->app_scope_global);
463 else if (unformat (line_input, "namespace-secret %lu",
464 &vcl_cfg->namespace_secret))
466 VCFG_DBG (0, "VCL<%d>: configured namespace_secret %lu (0x%lx)",
467 getpid (), vcl_cfg->namespace_secret,
468 vcl_cfg->namespace_secret);
470 else if (unformat (line_input, "namespace-id %v",
471 &vcl_cfg->namespace_id))
473 u32 max_nsid_vec_len = vcl_max_nsid_len ();
474 u32 nsid_vec_len = vec_len (vcl_cfg->namespace_id);
475 if (nsid_vec_len > max_nsid_vec_len)
477 _vec_len (vcl_cfg->namespace_id) = max_nsid_vec_len;
478 VCFG_DBG (0, "VCL<%d>: configured namespace_id is too long,"
479 " truncated to %d characters!",
480 getpid (), max_nsid_vec_len);
483 VCFG_DBG (0, "VCL<%d>: configured namespace_id %s",
484 getpid (), (char *) vcl_cfg->namespace_id);
486 else if (unformat (line_input, "use-mq-eventfd"))
488 vcl_cfg->use_mq_eventfd = 1;
489 VCFG_DBG (0, "VCL<%d>: configured with mq with eventfd",
492 else if (unformat (line_input, "}"))
495 VCFG_DBG (0, "VCL<%d>: completed parsing vppcom config!",
497 unformat_free (line_input);
502 if (line_input->buffer[line_input->index] != '#')
504 clib_warning ("VCL<%d>: Unknown vppcom config option: '%s'",
506 &line_input->buffer[line_input->index]);
509 unformat_free (line_input);
514 unformat_free (input);
522 vppcom_cfg (vppcom_cfg_t * vcl_cfg)
524 char *conf_fname, *env_var_str;
526 vppcom_cfg_init (vcl_cfg);
527 env_var_str = getenv (VPPCOM_ENV_DEBUG);
531 if (sscanf (env_var_str, "%u", &tmp) != 1)
533 VCFG_DBG (0, "VCL<%d>: WARNING: Invalid debug level specified "
534 "in the environment variable " VPPCOM_ENV_DEBUG
535 " (%s)!\n", getpid (), env_var_str);
540 VCFG_DBG (0, "VCL<%d>: configured VCL debug level (%u) from "
541 VPPCOM_ENV_DEBUG "!", getpid (), vcm->debug);
544 conf_fname = getenv (VPPCOM_ENV_CONF);
546 conf_fname = VPPCOM_CONF_DEFAULT;
547 vppcom_cfg_heapsize (conf_fname);
548 vppcom_cfg_read_file (conf_fname);
550 env_var_str = getenv (VPPCOM_ENV_API_PREFIX);
553 if (vcl_cfg->vpp_api_filename)
554 vec_free (vcl_cfg->vpp_api_filename);
555 vcl_cfg->vpp_api_filename = format (0, "/%s-vpe-api%c", env_var_str, 0);
556 vl_set_memory_root_path ((char *) env_var_str);
558 VCFG_DBG (0, "VCL<%d>: configured api prefix (%s) and filename (%s) "
559 "from " VPPCOM_ENV_API_PREFIX "!", getpid (), env_var_str,
560 vcl_cfg->vpp_api_filename);
562 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_ID);
565 u32 ns_id_vec_len = strlen (env_var_str);
567 vec_reset_length (vcm->cfg.namespace_id);
568 vec_validate (vcm->cfg.namespace_id, ns_id_vec_len - 1);
569 clib_memcpy (vcm->cfg.namespace_id, env_var_str, ns_id_vec_len);
571 VCFG_DBG (0, "VCL<%d>: configured namespace_id (%s) from "
572 VPPCOM_ENV_APP_NAMESPACE_ID "!", getpid (),
573 (char *) vcm->cfg.namespace_id);
575 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_SECRET);
579 if (sscanf (env_var_str, "%lu", &tmp) != 1)
581 VCFG_DBG (0, "VCL<%d>: WARNING: Invalid namespace secret specified"
582 " in the environment variable "
583 VPPCOM_ENV_APP_NAMESPACE_SECRET " (%s)!\n", getpid (),
588 vcm->cfg.namespace_secret = tmp;
589 VCFG_DBG (0, "VCL<%d>: configured namespace secret (%lu) from "
590 VPPCOM_ENV_APP_NAMESPACE_SECRET "!", getpid (),
591 vcm->cfg.namespace_secret);
594 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP))
596 vcm->cfg.app_proxy_transport_tcp = 1;
597 VCFG_DBG (0, "VCL<%d>: configured app_proxy_transport_tcp (%u) from "
598 VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP "!", getpid (),
599 vcm->cfg.app_proxy_transport_tcp);
601 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP))
603 vcm->cfg.app_proxy_transport_udp = 1;
604 VCFG_DBG (0, "VCL<%d>: configured app_proxy_transport_udp (%u) from "
605 VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP "!", getpid (),
606 vcm->cfg.app_proxy_transport_udp);
608 if (getenv (VPPCOM_ENV_APP_SCOPE_LOCAL))
610 vcm->cfg.app_scope_local = 1;
611 VCFG_DBG (0, "VCL<%d>: configured app_scope_local (%u) from "
612 VPPCOM_ENV_APP_SCOPE_LOCAL "!", getpid (),
613 vcm->cfg.app_scope_local);
615 if (getenv (VPPCOM_ENV_APP_SCOPE_GLOBAL))
617 vcm->cfg.app_scope_global = 1;
618 VCFG_DBG (0, "VCL<%d>: configured app_scope_global (%u) from "
619 VPPCOM_ENV_APP_SCOPE_GLOBAL "!", getpid (),
620 vcm->cfg.app_scope_global);
622 env_var_str = getenv (VPPCOM_ENV_VPP_API_SOCKET);
625 vcm->cfg.vpp_api_socket_name = format (0, "%s%c", env_var_str, 0);
626 VCFG_DBG (0, "VCL<%d>: configured api-socket-name (%s)", getpid (),
627 vcl_cfg->vpp_api_socket_name);
632 * fd.io coding-style-patch-verification: ON
635 * eval: (c-set-style "gnu")