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);
181 vcl_mem = mmap (0, vcl_cfg->heapsize, PROT_READ | PROT_WRITE,
182 MAP_SHARED | MAP_ANONYMOUS, -1, 0);
183 if (vcl_mem == MAP_FAILED)
185 VCFG_DBG (0, "VCL<%d>: ERROR: mmap(0, %ld == 0x%lx, "
186 "PROT_READ | PROT_WRITE,MAP_SHARED | MAP_ANONYMOUS, "
187 "-1, 0) failed!", getpid (), vcl_cfg->heapsize,
189 ASSERT (vcl_mem != MAP_FAILED);
192 heap = clib_mem_init_thread_safe (vcl_mem, vcl_cfg->heapsize);
195 fprintf (stderr, "VCL<%d>: ERROR: clib_mem_init() failed!", getpid ());
199 vcl_mem = clib_mem_alloc (sizeof (_vppcom_main));
202 clib_warning ("VCL<%d>: ERROR: clib_mem_alloc() failed!", getpid ());
207 clib_memcpy (vcl_mem, &_vppcom_main, sizeof (_vppcom_main));
210 VCFG_DBG (0, "VCL<%d>: allocated VCL heap = %p, size %ld (0x%lx)",
211 getpid (), heap, vcl_cfg->heapsize, vcl_cfg->heapsize);
215 vppcom_cfg_read_file (char *conf_fname)
217 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
219 unformat_input_t _input, *input = &_input;
220 unformat_input_t _line_input, *line_input = &_line_input;
221 u8 vc_cfg_input = 0, *chroot_path;
225 fd = open (conf_fname, O_RDONLY);
228 VCFG_DBG (0, "VCL<%d>: using default configuration.", getpid ());
232 if (fstat (fd, &s) < 0)
235 "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 {"))
262 if (unformat (line_input, "heapsize %lu", &vcl_cfg->heapsize))
264 VCFG_DBG (0, "VCL<%d>: configured heapsize %lu", getpid (),
267 if (unformat (line_input, "max-workers %u", &vcl_cfg->max_workers))
269 VCFG_DBG (0, "VCL<%d>: configured max-workers %u", getpid (),
270 vcl_cfg->max_workers);
272 else if (unformat (line_input, "api-prefix %s", &chroot_path))
274 vec_terminate_c_string (chroot_path);
275 if (vcl_cfg->vpp_api_filename)
276 vec_free (vcl_cfg->vpp_api_filename);
277 vcl_cfg->vpp_api_filename = format (0, "/%s-vpe-api%c",
279 vl_set_memory_root_path ((char *) chroot_path);
281 VCFG_DBG (0, "VCL<%d>: configured api-prefix (%s) and api "
282 "filename (%s)", getpid (), chroot_path,
283 vcl_cfg->vpp_api_filename);
284 chroot_path = 0; /* Don't vec_free() it! */
286 else if (unformat (line_input, "api-socket-name %s",
287 &vcl_cfg->vpp_api_socket_name))
289 vec_terminate_c_string (vcl_cfg->vpp_api_socket_name);
290 VCFG_DBG (0, "VCL<%d>: configured api-socket-name (%s)",
291 getpid (), vcl_cfg->vpp_api_socket_name);
293 else if (unformat (line_input, "vpp-api-q-length %d", &q_len))
295 if (q_len < vcl_cfg->vpp_api_q_length)
298 "VCL<%d>: ERROR: configured vpp-api-q-length "
299 "(%u) is too small! Using default: %u ", getpid (),
300 q_len, vcl_cfg->vpp_api_q_length);
304 vcl_cfg->vpp_api_q_length = q_len;
306 VCFG_DBG (0, "VCL<%d>: configured vpp-api-q-length %u",
307 getpid (), vcl_cfg->vpp_api_q_length);
310 else if (unformat (line_input, "uid %d", &uid))
312 vl_set_memory_uid (uid);
313 VCFG_DBG (0, "VCL<%d>: configured uid %d", getpid (), uid);
315 else if (unformat (line_input, "gid %d", &gid))
317 vl_set_memory_gid (gid);
318 VCFG_DBG (0, "VCL<%d>: configured gid %d", getpid (), gid);
320 else if (unformat (line_input, "segment-baseva 0x%x",
321 &vcl_cfg->segment_baseva))
323 VCFG_DBG (0, "VCL<%d>: configured segment_baseva 0x%lx",
324 getpid (), vcl_cfg->segment_baseva);
326 else if (unformat (line_input, "segment-size 0x%x",
327 &vcl_cfg->segment_size))
329 VCFG_DBG (0, "VCL<%d>: configured segment_size 0x%x (%d)",
330 getpid (), vcl_cfg->segment_size,
331 vcl_cfg->segment_size);
333 else if (unformat (line_input, "segment-size %d",
334 &vcl_cfg->segment_size))
336 VCFG_DBG (0, "VCL<%d>: configured segment_size %d (0x%x)",
337 getpid (), vcl_cfg->segment_size,
338 vcl_cfg->segment_size);
340 else if (unformat (line_input, "add-segment-size 0x%x",
341 &vcl_cfg->add_segment_size))
343 VCFG_DBG (0, "VCL<%d>: configured add_segment_size 0x%x (%d)",
344 getpid (), vcl_cfg->add_segment_size,
345 vcl_cfg->add_segment_size);
347 else if (unformat (line_input, "add-segment-size %d",
348 &vcl_cfg->add_segment_size))
350 VCFG_DBG (0, "VCL<%d>: configured add_segment_size %d (0x%x)",
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 VCFG_DBG (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 VCFG_DBG (0, "VCL<%d>: configured rx_fifo_size 0x%x (%d)",
365 getpid (), vcl_cfg->rx_fifo_size,
366 vcl_cfg->rx_fifo_size);
368 else if (unformat (line_input, "rx-fifo-size %d",
369 &vcl_cfg->rx_fifo_size))
371 VCFG_DBG (0, "VCL<%d>: configured rx_fifo_size %d (0x%x)",
372 getpid (), vcl_cfg->rx_fifo_size,
373 vcl_cfg->rx_fifo_size);
375 else if (unformat (line_input, "tx-fifo-size 0x%lx",
376 &vcl_cfg->tx_fifo_size))
378 VCFG_DBG (0, "VCL<%d>: configured tx_fifo_size 0x%x (%d)",
379 getpid (), vcl_cfg->tx_fifo_size,
380 vcl_cfg->tx_fifo_size);
382 else if (unformat (line_input, "tx-fifo-size %ld",
383 &vcl_cfg->tx_fifo_size))
385 VCFG_DBG (0, "VCL<%d>: configured tx_fifo_size %d (0x%x)",
386 getpid (), vcl_cfg->tx_fifo_size,
387 vcl_cfg->tx_fifo_size);
389 else if (unformat (line_input, "event-queue-size 0x%lx",
390 &vcl_cfg->event_queue_size))
392 VCFG_DBG (0, "VCL<%d>: configured event_queue_size 0x%x (%d)",
393 getpid (), vcl_cfg->event_queue_size,
394 vcl_cfg->event_queue_size);
396 else if (unformat (line_input, "event-queue-size %ld",
397 &vcl_cfg->event_queue_size))
399 VCFG_DBG (0, "VCL<%d>: configured event_queue_size %d (0x%x)",
400 getpid (), vcl_cfg->event_queue_size,
401 vcl_cfg->event_queue_size);
403 else if (unformat (line_input, "listen-queue-size 0x%lx",
404 &vcl_cfg->listen_queue_size))
406 VCFG_DBG (0, "VCL<%d>: configured listen_queue_size 0x%x (%u)",
407 getpid (), vcl_cfg->listen_queue_size,
408 vcl_cfg->listen_queue_size);
410 else if (unformat (line_input, "listen-queue-size %ld",
411 &vcl_cfg->listen_queue_size))
413 VCFG_DBG (0, "VCL<%d>: configured listen_queue_size %u (0x%x)",
414 getpid (), vcl_cfg->listen_queue_size,
415 vcl_cfg->listen_queue_size);
417 else if (unformat (line_input, "app-timeout %f",
418 &vcl_cfg->app_timeout))
420 VCFG_DBG (0, "VCL<%d>: configured app_timeout %f",
421 getpid (), vcl_cfg->app_timeout);
423 else if (unformat (line_input, "session-timeout %f",
424 &vcl_cfg->session_timeout))
426 VCFG_DBG (0, "VCL<%d>: configured session_timeout %f",
427 getpid (), vcl_cfg->session_timeout);
429 else if (unformat (line_input, "accept-timeout %f",
430 &vcl_cfg->accept_timeout))
432 VCFG_DBG (0, "VCL<%d>: configured accept_timeout %f",
433 getpid (), vcl_cfg->accept_timeout);
435 else if (unformat (line_input, "app-proxy-transport-tcp"))
437 vcl_cfg->app_proxy_transport_tcp = 1;
438 VCFG_DBG (0, "VCL<%d>: configured app_proxy_transport_tcp (%d)",
439 getpid (), vcl_cfg->app_proxy_transport_tcp);
441 else if (unformat (line_input, "app-proxy-transport-udp"))
443 vcl_cfg->app_proxy_transport_udp = 1;
444 VCFG_DBG (0, "VCL<%d>: configured app_proxy_transport_udp (%d)",
445 getpid (), vcl_cfg->app_proxy_transport_udp);
447 else if (unformat (line_input, "app-scope-local"))
449 vcl_cfg->app_scope_local = 1;
450 VCFG_DBG (0, "VCL<%d>: configured app_scope_local (%d)",
451 getpid (), vcl_cfg->app_scope_local);
453 else if (unformat (line_input, "app-scope-global"))
455 vcl_cfg->app_scope_global = 1;
456 VCFG_DBG (0, "VCL<%d>: configured app_scope_global (%d)",
457 getpid (), vcl_cfg->app_scope_global);
459 else if (unformat (line_input, "namespace-secret %lu",
460 &vcl_cfg->namespace_secret))
462 VCFG_DBG (0, "VCL<%d>: configured namespace_secret %lu (0x%lx)",
463 getpid (), vcl_cfg->namespace_secret,
464 vcl_cfg->namespace_secret);
466 else if (unformat (line_input, "namespace-id %v",
467 &vcl_cfg->namespace_id))
469 u32 max_nsid_vec_len = vcl_max_nsid_len ();
470 u32 nsid_vec_len = vec_len (vcl_cfg->namespace_id);
471 if (nsid_vec_len > max_nsid_vec_len)
473 _vec_len (vcl_cfg->namespace_id) = max_nsid_vec_len;
474 VCFG_DBG (0, "VCL<%d>: configured namespace_id is too long,"
475 " truncated to %d characters!",
476 getpid (), max_nsid_vec_len);
479 VCFG_DBG (0, "VCL<%d>: configured namespace_id %s",
480 getpid (), (char *) vcl_cfg->namespace_id);
482 else if (unformat (line_input, "use-mq-eventfd"))
484 vcl_cfg->use_mq_eventfd = 1;
485 VCFG_DBG (0, "VCL<%d>: configured with mq with eventfd",
488 else if (unformat (line_input, "}"))
491 VCFG_DBG (0, "VCL<%d>: completed parsing vppcom config!",
497 if (line_input->buffer[line_input->index] != '#')
499 clib_warning ("VCL<%d>: Unknown vppcom config option: '%s'",
501 &line_input->buffer[line_input->index]);
508 unformat_free (input);
516 vppcom_cfg (vppcom_cfg_t * vcl_cfg)
518 char *conf_fname, *env_var_str;
520 vppcom_cfg_init (vcl_cfg);
521 env_var_str = getenv (VPPCOM_ENV_DEBUG);
525 if (sscanf (env_var_str, "%u", &tmp) != 1)
527 VCFG_DBG (0, "VCL<%d>: WARNING: Invalid debug level specified "
528 "in the environment variable " VPPCOM_ENV_DEBUG
529 " (%s)!\n", getpid (), env_var_str);
534 VCFG_DBG (0, "VCL<%d>: configured VCL debug level (%u) from "
535 VPPCOM_ENV_DEBUG "!", getpid (), vcm->debug);
538 conf_fname = getenv (VPPCOM_ENV_CONF);
540 conf_fname = VPPCOM_CONF_DEFAULT;
541 vppcom_cfg_heapsize (conf_fname);
542 vppcom_cfg_read_file (conf_fname);
544 env_var_str = getenv (VPPCOM_ENV_API_PREFIX);
547 if (vcl_cfg->vpp_api_filename)
548 vec_free (vcl_cfg->vpp_api_filename);
549 vcl_cfg->vpp_api_filename = format (0, "/%s-vpe-api%c", env_var_str, 0);
550 vl_set_memory_root_path ((char *) env_var_str);
552 VCFG_DBG (0, "VCL<%d>: configured api prefix (%s) and filename (%s) "
553 "from " VPPCOM_ENV_API_PREFIX "!", getpid (), env_var_str,
554 vcl_cfg->vpp_api_filename);
556 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_ID);
559 u32 ns_id_vec_len = strlen (env_var_str);
561 vec_reset_length (vcm->cfg.namespace_id);
562 vec_validate (vcm->cfg.namespace_id, ns_id_vec_len - 1);
563 clib_memcpy (vcm->cfg.namespace_id, env_var_str, ns_id_vec_len);
565 VCFG_DBG (0, "VCL<%d>: configured namespace_id (%s) from "
566 VPPCOM_ENV_APP_NAMESPACE_ID "!", getpid (),
567 (char *) vcm->cfg.namespace_id);
569 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_SECRET);
573 if (sscanf (env_var_str, "%lu", &tmp) != 1)
575 VCFG_DBG (0, "VCL<%d>: WARNING: Invalid namespace secret specified"
576 " in the environment variable "
577 VPPCOM_ENV_APP_NAMESPACE_SECRET " (%s)!\n", getpid (),
582 vcm->cfg.namespace_secret = tmp;
583 VCFG_DBG (0, "VCL<%d>: configured namespace secret (%lu) from "
584 VPPCOM_ENV_APP_NAMESPACE_SECRET "!", getpid (),
585 vcm->cfg.namespace_secret);
588 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP))
590 vcm->cfg.app_proxy_transport_tcp = 1;
591 VCFG_DBG (0, "VCL<%d>: configured app_proxy_transport_tcp (%u) from "
592 VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP "!", getpid (),
593 vcm->cfg.app_proxy_transport_tcp);
595 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP))
597 vcm->cfg.app_proxy_transport_udp = 1;
598 VCFG_DBG (0, "VCL<%d>: configured app_proxy_transport_udp (%u) from "
599 VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP "!", getpid (),
600 vcm->cfg.app_proxy_transport_udp);
602 if (getenv (VPPCOM_ENV_APP_SCOPE_LOCAL))
604 vcm->cfg.app_scope_local = 1;
605 VCFG_DBG (0, "VCL<%d>: configured app_scope_local (%u) from "
606 VPPCOM_ENV_APP_SCOPE_LOCAL "!", getpid (),
607 vcm->cfg.app_scope_local);
609 if (getenv (VPPCOM_ENV_APP_SCOPE_GLOBAL))
611 vcm->cfg.app_scope_global = 1;
612 VCFG_DBG (0, "VCL<%d>: configured app_scope_global (%u) from "
613 VPPCOM_ENV_APP_SCOPE_GLOBAL "!", getpid (),
614 vcm->cfg.app_scope_global);
616 env_var_str = getenv (VPPCOM_ENV_VPP_API_SOCKET);
619 vcm->cfg.vpp_api_socket_name = format (0, "%s%c", env_var_str, 0);
620 VCFG_DBG (0, "VCL<%d>: configured api-socket-name (%s)", getpid (),
621 vcl_cfg->vpp_api_socket_name);
626 * fd.io coding-style-patch-verification: ON
629 * eval: (c-set-style "gnu")