2 * Copyright (c) 2018-2019 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 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->segment_size = (256 << 20);
38 vcl_cfg->add_segment_size = (128 << 20);
39 vcl_cfg->preallocated_fifo_pairs = 8;
40 vcl_cfg->rx_fifo_size = (1 << 20);
41 vcl_cfg->tx_fifo_size = (1 << 20);
42 vcl_cfg->event_queue_size = 2048;
43 vcl_cfg->app_timeout = 10 * 60.0;
44 vcl_cfg->session_timeout = 10 * 60.0;
45 vcl_cfg->event_log_path = "/dev/shm";
48 #define VCFG_DBG(_lvl, _fmt, _args...) \
50 if (vcm->debug > _lvl) \
51 fprintf (stderr, _fmt "\n", ##_args); \
54 vppcom_cfg_heapsize (char *conf_fname)
56 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
69 fp = fopen (conf_fname, "r");
72 VCFG_DBG (0, "VCL<%d>: using default heapsize %lu (0x%lx)",
73 getpid (), (unsigned long) vcl_cfg->heapsize,
74 (unsigned long) vcl_cfg->heapsize);
78 argv = calloc (1, sizeof (char *));
81 VCFG_DBG (0, "VCL<%d>: calloc failed, using default heapsize %lu"
82 " (0x%lx)", getpid (), (unsigned long) vcl_cfg->heapsize,
83 (unsigned long) vcl_cfg->heapsize);
89 if (fgets (inbuf, 4096, fp) == 0)
91 p = strtok (inbuf, " \t\n");
97 char **tmp = realloc (argv, argc * sizeof (char *));
100 VCFG_DBG (0, "VCL<%d>: realloc failed, using default "
101 "heapsize %lu (0x%lx)", getpid (),
102 (unsigned long) vcl_cfg->heapsize,
103 (unsigned long) vcl_cfg->heapsize);
107 arg = strndup (p, 1024);
110 VCFG_DBG (0, "VCL<%d>: strndup failed, using default "
111 "heapsize %lu (0x%lx)", getpid (),
112 (unsigned long) vcl_cfg->heapsize,
113 (unsigned long) vcl_cfg->heapsize);
116 argv[argc - 1] = arg;
117 p = strtok (NULL, " \t\n");
124 char **tmp = realloc (argv, (argc + 1) * sizeof (char *));
127 VCFG_DBG (0, "VCL<%d>: realloc failed, using default heapsize %lu "
128 "(0x%lx)", getpid (), (unsigned long) vcl_cfg->heapsize,
129 (unsigned long) 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 %lu (0x%lx)", getpid (), argv[i],
157 argv[i + 1], (unsigned long) vcl_cfg->heapsize,
158 (unsigned long) vcl_cfg->heapsize);
162 if (*sizep == 'g' || *sizep == 'G')
163 vcl_cfg->heapsize = size << 30;
164 else if (*sizep == 'm' || *sizep == 'M')
165 vcl_cfg->heapsize = size << 20;
168 VCFG_DBG (0, "VCL<%d>: parse error '%s %s', using default "
169 "heapsize %lu (0x%lx)", getpid (), argv[i],
170 argv[i + 1], (unsigned long) vcl_cfg->heapsize,
171 (unsigned long) vcl_cfg->heapsize);
184 vcl_mem = mmap (0, vcl_cfg->heapsize, PROT_READ | PROT_WRITE,
185 MAP_SHARED | MAP_ANONYMOUS, -1, 0);
186 if (vcl_mem == MAP_FAILED)
188 VCFG_DBG (0, "VCL<%d>: ERROR: mmap(0, %lu == 0x%lx, "
189 "PROT_READ | PROT_WRITE,MAP_SHARED | MAP_ANONYMOUS, "
190 "-1, 0) failed!", getpid (),
191 (unsigned long) vcl_cfg->heapsize,
192 (unsigned long) vcl_cfg->heapsize);
193 ASSERT (vcl_mem != MAP_FAILED);
196 heap = clib_mem_init_thread_safe (vcl_mem, vcl_cfg->heapsize);
199 fprintf (stderr, "VCL<%d>: ERROR: clib_mem_init() failed!", getpid ());
203 vcl_mem = clib_mem_alloc (sizeof (_vppcom_main));
206 clib_warning ("VCL<%d>: ERROR: clib_mem_alloc() failed!", getpid ());
211 clib_memcpy (vcl_mem, &_vppcom_main, sizeof (_vppcom_main));
214 VCFG_DBG (0, "VCL<%d>: allocated VCL heap = %p, size %lu (0x%lx)",
215 getpid (), heap, (unsigned long) vcl_cfg->heapsize,
216 (unsigned long) vcl_cfg->heapsize);
220 vppcom_cfg_read_file (char *conf_fname)
222 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
224 unformat_input_t _input, *input = &_input;
225 unformat_input_t _line_input, *line_input = &_line_input;
230 fd = open (conf_fname, O_RDONLY);
233 VCFG_DBG (0, "VCL<%d>: using default configuration.", getpid ());
237 if (fstat (fd, &s) < 0)
239 VCFG_DBG (0, "VCL<%d>: failed to stat `%s' using default configuration",
240 getpid (), conf_fname);
244 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
246 VCFG_DBG (0, "VCL<%d>: not a regular file `%s', using default "
247 "configuration", getpid (), conf_fname);
251 unformat_init_clib_file (input, fd);
253 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
255 /* skip empty newlines as they confuse unformat_line_input */
256 unformat_skip_white_space (input);
257 (void) unformat_user (input, unformat_line_input, line_input);
258 unformat_skip_white_space (line_input);
260 if (unformat (line_input, "vcl {"))
263 unformat_free (line_input);
269 if (unformat (line_input, "heapsize %U", unformat_memory_size,
272 VCFG_DBG (0, "VCL<%d>: configured heapsize %lu", getpid (),
273 (unsigned long) vcl_cfg->heapsize);
277 (line_input, "max-workers %u", &vcl_cfg->max_workers))
279 VCFG_DBG (0, "VCL<%d>: configured max-workers %u", getpid (),
280 vcl_cfg->max_workers);
282 else if (unformat (line_input, "api-socket-name %s",
283 &vcl_cfg->vpp_bapi_socket_name))
285 vec_terminate_c_string (vcl_cfg->vpp_bapi_socket_name);
286 VCFG_DBG (0, "VCL<%d>: configured api-socket-name (%s)",
287 getpid (), vcl_cfg->vpp_bapi_socket_name);
289 else if (unformat (line_input, "app-socket-api %s",
290 &vcl_cfg->vpp_app_socket_api))
292 vec_terminate_c_string (vcl_cfg->vpp_app_socket_api);
293 VCFG_DBG (0, "VCL<%d>: configured app-socket-api (%s)",
294 getpid (), vcl_cfg->vpp_app_socket_api);
296 else if (unformat (line_input, "uid %d", &uid))
298 vl_set_memory_uid (uid);
299 VCFG_DBG (0, "VCL<%d>: configured uid %d", getpid (), uid);
301 else if (unformat (line_input, "gid %d", &gid))
303 vl_set_memory_gid (gid);
304 VCFG_DBG (0, "VCL<%d>: configured gid %d", getpid (), gid);
306 else if (unformat (line_input, "segment-size 0x%lx",
307 &vcl_cfg->segment_size))
309 VCFG_DBG (0, "VCL<%d>: configured segment_size 0x%lx (%lu)",
310 getpid (), vcl_cfg->segment_size,
311 vcl_cfg->segment_size);
313 else if (unformat (line_input, "segment-size %lu",
314 &vcl_cfg->segment_size))
316 VCFG_DBG (0, "VCL<%d>: configured segment_size %lu (0x%lx)",
317 getpid (), vcl_cfg->segment_size,
318 vcl_cfg->segment_size);
320 else if (unformat (line_input, "add-segment-size 0x%lx",
321 &vcl_cfg->add_segment_size))
323 VCFG_DBG (0, "VCL<%d>: configured add_segment_size 0x%lx (%lu)",
324 getpid (), vcl_cfg->add_segment_size,
325 vcl_cfg->add_segment_size);
327 else if (unformat (line_input, "add-segment-size %lu",
328 &vcl_cfg->add_segment_size))
330 VCFG_DBG (0, "VCL<%d>: configured add_segment_size %lu (0x%lx)",
331 getpid (), vcl_cfg->add_segment_size,
332 vcl_cfg->add_segment_size);
334 else if (unformat (line_input, "preallocated-fifo-pairs %u",
335 &vcl_cfg->preallocated_fifo_pairs))
337 VCFG_DBG (0, "VCL<%d>: configured preallocated_fifo_pairs %u "
338 "(0x%x)", getpid (), vcl_cfg->preallocated_fifo_pairs,
339 vcl_cfg->preallocated_fifo_pairs);
341 else if (unformat (line_input, "rx-fifo-size 0x%x",
342 &vcl_cfg->rx_fifo_size))
344 VCFG_DBG (0, "VCL<%d>: configured rx_fifo_size 0x%x (%u)",
345 getpid (), vcl_cfg->rx_fifo_size,
346 vcl_cfg->rx_fifo_size);
348 else if (unformat (line_input, "rx-fifo-size %u",
349 &vcl_cfg->rx_fifo_size))
351 VCFG_DBG (0, "VCL<%d>: configured rx_fifo_size %u (0x%x)",
352 getpid (), vcl_cfg->rx_fifo_size,
353 vcl_cfg->rx_fifo_size);
355 else if (unformat (line_input, "tx-fifo-size 0x%x",
356 &vcl_cfg->tx_fifo_size))
358 VCFG_DBG (0, "VCL<%d>: configured tx_fifo_size 0x%x (%u)",
359 getpid (), vcl_cfg->tx_fifo_size,
360 vcl_cfg->tx_fifo_size);
362 else if (unformat (line_input, "tx-fifo-size %u",
363 &vcl_cfg->tx_fifo_size))
365 VCFG_DBG (0, "VCL<%d>: configured tx_fifo_size %u (0x%x)",
366 getpid (), vcl_cfg->tx_fifo_size,
367 vcl_cfg->tx_fifo_size);
369 else if (unformat (line_input, "event-queue-size 0x%x",
370 &vcl_cfg->event_queue_size))
372 VCFG_DBG (0, "VCL<%d>: configured event_queue_size 0x%x (%u)",
373 getpid (), vcl_cfg->event_queue_size,
374 vcl_cfg->event_queue_size);
376 else if (unformat (line_input, "event-queue-size %u",
377 &vcl_cfg->event_queue_size))
379 VCFG_DBG (0, "VCL<%d>: configured event_queue_size %u (0x%x)",
380 getpid (), vcl_cfg->event_queue_size,
381 vcl_cfg->event_queue_size);
383 else if (unformat (line_input, "app-timeout %f",
384 &vcl_cfg->app_timeout))
386 VCFG_DBG (0, "VCL<%d>: configured app_timeout %f",
387 getpid (), vcl_cfg->app_timeout);
389 else if (unformat (line_input, "session-timeout %f",
390 &vcl_cfg->session_timeout))
392 VCFG_DBG (0, "VCL<%d>: configured session_timeout %f",
393 getpid (), vcl_cfg->session_timeout);
395 else if (unformat (line_input, "app-proxy-transport-tcp"))
397 vcl_cfg->app_proxy_transport_tcp = 1;
398 VCFG_DBG (0, "VCL<%d>: configured app_proxy_transport_tcp (%d)",
399 getpid (), vcl_cfg->app_proxy_transport_tcp);
401 else if (unformat (line_input, "app-proxy-transport-udp"))
403 vcl_cfg->app_proxy_transport_udp = 1;
404 VCFG_DBG (0, "VCL<%d>: configured app_proxy_transport_udp (%d)",
405 getpid (), vcl_cfg->app_proxy_transport_udp);
407 else if (unformat (line_input, "app-scope-local"))
409 vcl_cfg->app_scope_local = 1;
410 VCFG_DBG (0, "VCL<%d>: configured app_scope_local (%d)",
411 getpid (), vcl_cfg->app_scope_local);
413 else if (unformat (line_input, "app-scope-global"))
415 vcl_cfg->app_scope_global = 1;
416 VCFG_DBG (0, "VCL<%d>: configured app_scope_global (%d)",
417 getpid (), vcl_cfg->app_scope_global);
419 else if (unformat (line_input, "namespace-secret %lu",
420 &vcl_cfg->namespace_secret))
422 VCFG_DBG (0, "VCL<%d>: configured namespace_secret %llu "
423 "(0x%llx)", getpid (),
424 (unsigned long long) vcl_cfg->namespace_secret,
425 (unsigned long long) vcl_cfg->namespace_secret);
427 else if (unformat (line_input, "namespace-id %v",
428 &vcl_cfg->namespace_id))
430 u32 max_nsid_vec_len = vcl_bapi_max_nsid_len ();
431 u32 nsid_vec_len = vec_len (vcl_cfg->namespace_id);
432 if (nsid_vec_len > max_nsid_vec_len)
434 _vec_len (vcl_cfg->namespace_id) = max_nsid_vec_len;
435 VCFG_DBG (0, "VCL<%d>: configured namespace_id is too long,"
436 " truncated to %d characters!",
437 getpid (), max_nsid_vec_len);
440 VCFG_DBG (0, "VCL<%d>: configured namespace_id %s",
441 getpid (), (char *) vcl_cfg->namespace_id);
443 else if (unformat (line_input, "use-mq-eventfd"))
445 vcl_cfg->use_mq_eventfd = 1;
446 VCFG_DBG (0, "VCL<%d>: configured with mq with eventfd",
449 else if (unformat (line_input, "tls-engine %u",
450 &vcl_cfg->tls_engine))
452 VCFG_DBG (0, "VCL<%d>: configured tls-engine %u (0x%x)",
453 getpid (), vcl_cfg->tls_engine, vcl_cfg->tls_engine);
455 else if (unformat (line_input, "multi-thread-workers"))
457 vcl_cfg->mt_wrk_supported = 1;
458 VCFG_DBG (0, "VCL<%d>: configured with multithread workers",
461 else if (unformat (line_input, "}"))
464 VCFG_DBG (0, "VCL<%d>: completed parsing vppcom config!",
466 unformat_free (line_input);
471 if (line_input->buffer[line_input->index] != '#')
473 clib_warning ("VCL<%d>: Unknown vppcom config option: '%s'",
475 &line_input->buffer[line_input->index]);
478 unformat_free (line_input);
483 unformat_free (input);
491 vppcom_cfg (vppcom_cfg_t * vcl_cfg)
493 char *conf_fname, *env_var_str;
495 vppcom_cfg_init (vcl_cfg);
496 env_var_str = getenv (VPPCOM_ENV_DEBUG);
500 if (sscanf (env_var_str, "%u", &tmp) != 1)
502 VCFG_DBG (0, "VCL<%d>: WARNING: Invalid debug level specified "
503 "in the environment variable " VPPCOM_ENV_DEBUG
504 " (%s)!\n", getpid (), env_var_str);
509 VCFG_DBG (0, "VCL<%d>: configured VCL debug level (%u) from "
510 VPPCOM_ENV_DEBUG "!", getpid (), vcm->debug);
513 conf_fname = getenv (VPPCOM_ENV_CONF);
515 conf_fname = VPPCOM_CONF_DEFAULT;
516 vppcom_cfg_heapsize (conf_fname);
517 vppcom_cfg_read_file (conf_fname);
519 /* Regrab cfg after heap initialization */
521 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_ID);
524 u32 ns_id_vec_len = strlen (env_var_str);
526 vec_reset_length (vcm->cfg.namespace_id);
527 vec_validate (vcm->cfg.namespace_id, ns_id_vec_len - 1);
528 clib_memcpy (vcm->cfg.namespace_id, env_var_str, ns_id_vec_len);
530 VCFG_DBG (0, "VCL<%d>: configured namespace_id (%s) from "
531 VPPCOM_ENV_APP_NAMESPACE_ID "!", getpid (), env_var_str);
533 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_SECRET);
537 if (sscanf (env_var_str, "%llu", (unsigned long long *) &tmp) != 1)
539 VCFG_DBG (0, "VCL<%d>: WARNING: Invalid namespace secret specified"
540 " in the environment variable "
541 VPPCOM_ENV_APP_NAMESPACE_SECRET " (%s)!\n", getpid (),
546 vcm->cfg.namespace_secret = tmp;
547 VCFG_DBG (0, "VCL<%d>: configured namespace secret (%llu) from "
548 VPPCOM_ENV_APP_NAMESPACE_SECRET "!", getpid (),
549 (unsigned long long) vcm->cfg.namespace_secret);
552 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP))
554 vcm->cfg.app_proxy_transport_tcp = 1;
555 VCFG_DBG (0, "VCL<%d>: configured app_proxy_transport_tcp (%u) from "
556 VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP "!", getpid (),
557 vcm->cfg.app_proxy_transport_tcp);
559 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP))
561 vcm->cfg.app_proxy_transport_udp = 1;
562 VCFG_DBG (0, "VCL<%d>: configured app_proxy_transport_udp (%u) from "
563 VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP "!", getpid (),
564 vcm->cfg.app_proxy_transport_udp);
566 if (getenv (VPPCOM_ENV_APP_SCOPE_LOCAL))
568 vcm->cfg.app_scope_local = 1;
569 VCFG_DBG (0, "VCL<%d>: configured app_scope_local (%u) from "
570 VPPCOM_ENV_APP_SCOPE_LOCAL "!", getpid (),
571 vcm->cfg.app_scope_local);
573 if (getenv (VPPCOM_ENV_APP_SCOPE_GLOBAL))
575 vcm->cfg.app_scope_global = 1;
576 VCFG_DBG (0, "VCL<%d>: configured app_scope_global (%u) from "
577 VPPCOM_ENV_APP_SCOPE_GLOBAL "!", getpid (),
578 vcm->cfg.app_scope_global);
580 env_var_str = getenv (VPPCOM_ENV_VPP_API_SOCKET);
583 vcm->cfg.vpp_bapi_socket_name = format (0, "%s%c", env_var_str, 0);
584 VCFG_DBG (0, "VCL<%d>: configured api-socket-name (%s)", getpid (),
585 vcl_cfg->vpp_bapi_socket_name);
587 env_var_str = getenv (VPPCOM_ENV_VPP_SAPI_SOCKET);
590 vcm->cfg.vpp_app_socket_api = format (0, "%s%c", env_var_str, 0);
591 VCFG_DBG (0, "VCL<%d>: configured app-socket-api (%s)", getpid (),
592 vcl_cfg->vpp_app_socket_api);
594 env_var_str = getenv (VPPCOM_ENV_APP_USE_MQ_EVENTFD);
597 vcm->cfg.use_mq_eventfd = 1;
598 VCFG_DBG (0, "VCL<%d>: configured " VPPCOM_ENV_APP_USE_MQ_EVENTFD,
604 * fd.io coding-style-patch-verification: ON
607 * eval: (c-set-style "gnu")