path: root/platform/linux-generic/odp_libconfig.c

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2018 Linaro Limited
 * Copyright (c) 2020 Nokia
 * Copyright (c) 2021 Marvell
 */

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <libconfig.h>

#include <odp/api/version.h>
#include <odp_global_data.h>
#include <odp_debug_internal.h>
#include <odp_libconfig_internal.h>
#include <odp_libconfig_config.h>

int _odp_libconfig_init_global(void)
{
	const char *filename;
	const char *vers;
	const char *vers_rt;
	const char *impl;
	const char *impl_rt;
	config_t *config = &odp_global_ro.libconfig_default;
	config_t *config_rt = &odp_global_ro.libconfig_runtime;
	const char *impl_field = "odp_implementation";
	const char *vers_field = "config_file_version";

	config_init(config);
	config_init(config_rt);
	odp_global_ro.has_config_rt = 0;

	if (!config_read_string(config, config_builtin)) {
		_ODP_ERR("Failed to read default config: %s(%d): %s\n",
			 config_error_file(config), config_error_line(config),
			 config_error_text(config));
		goto fail;
	}

	filename = getenv("ODP_CONFIG_FILE");
	if (filename == NULL)
		return 0;

	_ODP_PRINT("ODP CONFIG FILE: %s\n", filename);

	if (!config_read_file(config_rt, filename)) {
		_ODP_PRINT("  ERROR: failed to read config file: %s(%d): %s\n\n",
			   config_error_file(config_rt),
			   config_error_line(config_rt),
			   config_error_text(config_rt));
		goto fail;
	}

	/* Check runtime configuration's implementation name and version */
	if (!config_lookup_string(config, impl_field, &impl) ||
	    !config_lookup_string(config_rt, impl_field, &impl_rt)) {
		_ODP_PRINT("  ERROR: missing mandatory field: %s\n\n", impl_field);
		goto fail;
	}
	if (!config_lookup_string(config, vers_field, &vers) ||
	    !config_lookup_string(config_rt, vers_field, &vers_rt)) {
		_ODP_PRINT("  ERROR: missing mandatory field: %s\n\n", vers_field);
		goto fail;
	}
	if (strcmp(impl, impl_rt)) {
		_ODP_PRINT("  ERROR: ODP implementation name mismatch:\n"
			   "    Expected: \"%s\"\n"
			   "    Found:    \"%s\"\n\n", impl, impl_rt);
		goto fail;
	}
	if (strcmp(vers, vers_rt)) {
		_ODP_PRINT("  ERROR: config file version number mismatch:\n"
			   "    Expected: \"%s\"\n"
			   "    Found:    \"%s\"\n\n", vers, vers_rt);
		goto fail;
	}

	odp_global_ro.has_config_rt = 1;
	return 0;
fail:
	_ODP_ERR("Config file failure\n");
	config_destroy(config);
	config_destroy(config_rt);
	return -1;
}

int _odp_libconfig_term_global(void)
{
	config_destroy(&odp_global_ro.libconfig_default);
	config_destroy(&odp_global_ro.libconfig_runtime);

	return 0;
}

/**
 * String setting value
 *
 * Returns a string from setting. A valid runtime setting overrides
 * default even if the string is empty.
 *
 * @param      path     Path of the setting
 * @param[out] value    String to be copied from the setting
 * @param      str_size Maximum string length to be copied
 *
 * @return     Size of the string copied
 * @retval     <0 on failure
*/
int _odp_libconfig_lookup_str(const char *path, char *value,
			      unsigned int str_size)
{
	const config_t *config;
	unsigned int length, i;
	const char *str;

	for (i = 0; i < 2; i++) {
		if (i == 0)
			config = &odp_global_ro.libconfig_runtime;
		else
			config = &odp_global_ro.libconfig_default;

		if (config_lookup_string(config, path, &str) == CONFIG_FALSE)
			continue;

		length = strlen(str);

		/* Runtime config overrides even if it's empty string */
		if (value == NULL || str_size == 0 || length == 0)
			return length;

		if (length > str_size) {
			_ODP_ERR("libconfig: length of %d bigger than size %u\n", length, str_size);
			return -1;
		}

		strcpy(value, str);
		return length;
	}

	_ODP_ERR("libconfig: %s is not defined in config files\n", path);
	return -1;
}

int _odp_libconfig_lookup_int(const char *path, int *value)
{
	int ret_def = CONFIG_FALSE;
	int ret_rt = CONFIG_FALSE;

	ret_def = config_lookup_int(&odp_global_ro.libconfig_default, path,
				    value);

	/* Runtime option overrides default value */
	ret_rt = config_lookup_int(&odp_global_ro.libconfig_runtime, path,
				   value);

	return  (ret_def == CONFIG_TRUE || ret_rt == CONFIG_TRUE) ? 1 : 0;
}

/**
 * String array setting values
 *
 * Returns the number of strings in a string array setting. A valid runtime
 * setting overrides default even if the array is empty. Outputs upto
 * 'count' strings when the 'value' array pointer is not NULL. If return
 * value is larger than 'count', there are more strings than the function was
 * allowed to output. If return value (N) is less than 'count', only
 * strings[0 ... N-1] have been written.
 *
 * @param      path     Path of the setting
 * @param[out] value    Array of strings to be copied from the setting
 * @param      count    Number of strings to be copied
 * @param      str_size Maximum string length to be copied
 *
 * @return     Number of strings in the setting
 * @retval     <0 on failure
*/
int _odp_libconfig_lookup_array_str(const char *path, char **value,
				    int count, unsigned int str_size)
{
	config_setting_t *setting, *elem;
	const config_t *config;
	int num, i, j;

	for (i = 0; i < 2; i++) {
		if (i == 0)
			config = &odp_global_ro.libconfig_runtime;
		else
			config = &odp_global_ro.libconfig_default;

		setting = config_lookup(config, path);

		if (setting == NULL)
			continue;

		/* invalid config if element is not an array */
		if (config_setting_is_array(setting) == CONFIG_FALSE) {
			_ODP_ERR("libconfig: %s is not an array\n", path);
			return -1;
		}
		num = config_setting_length(setting);

		if (num == 0 || count == 0 || value == NULL)
			return num;

		elem = config_setting_get_elem(setting, 0);
		if (config_setting_type(elem) != CONFIG_TYPE_STRING) {
			_ODP_ERR("libconfig: %s array is not of type string\n", path);
			return -1;
		}

		for (j = 0; j < num; j++) {
			elem = config_setting_get_elem(setting, j);
			if (strlen(elem->value.sval) > str_size) {
				_ODP_ERR("libconfig: length of %s bigger than size %u\n",
					 elem->value.sval, str_size);
				return -1;
			}
			strcpy(value[j], elem->value.sval);
		}

		return num;
	}

	_ODP_ERR("libconfig: %s is not defined in config files\n", path);
	return -1;
}

int _odp_libconfig_lookup_array(const char *path, int value[], int max_num)
{
	const config_t *config;
	config_setting_t *setting;
	int num, i, j;
	int num_out = 0;

	for (j = 0; j < 2; j++) {
		if (j == 0)
			config = &odp_global_ro.libconfig_default;
		else
			config = &odp_global_ro.libconfig_runtime;

		setting = config_lookup(config, path);

		/* Runtime config may not define the array, whereas
		 * the default config has it always defined. When the array
		 * is defined, it must be correctly formatted. */
		if (setting == NULL)
			continue;

		if (config_setting_is_array(setting) == CONFIG_FALSE)
			return 0;

		num = config_setting_length(setting);

		if (num <= 0 || num > max_num)
			return 0;

		for (i = 0; i < num; i++)
			value[i] = config_setting_get_int_elem(setting, i);

		num_out = num;
	}

	/* Number of elements copied */
	return num_out;
}

static int lookup_int(config_t *cfg,
		      const char *base_path,
		      const char *local_path,
		      const char *name,
		      int *value)
{
	char path[256];

	if (local_path) {
		snprintf(path, sizeof(path), "%s.%s.%s", base_path,
			 local_path, name);
		if (config_lookup_int(cfg, path, value) == CONFIG_TRUE)
			return 1;
	}

	snprintf(path, sizeof(path), "%s.%s", base_path, name);
	if (config_lookup_int(cfg, path, value) == CONFIG_TRUE)
		return 1;

	return 0;
}

int _odp_libconfig_lookup_ext_int(const char *base_path,
				  const char *local_path,
				  const char *name,
				  int *value)
{
	if (lookup_int(&odp_global_ro.libconfig_runtime,
		       base_path, local_path, name, value))
		return 1;

	if (lookup_int(&odp_global_ro.libconfig_default,
		       base_path, local_path, name, value))
		return 1;

	return 0;
}

int _odp_libconfig_print(void)
{
	int c;
	/* Temp file for config_write() output. Suppress Coverity warning about tmpfile() usage. */
	/* coverity[secure_temp] */
	FILE *file = tmpfile();

	if (file == NULL)
		return -1;

	if (fprintf(file,
		    "\nODP_CONFIG_FILE default values:\n"
		    "-------------------------------\n\n") < 0)
		goto fail;

	config_write(&odp_global_ro.libconfig_default, file);

	if (odp_global_ro.has_config_rt) {
		if (fprintf(file,
			    "\nODP_CONFIG_FILE override values:\n"
			    "--------------------------------\n\n") < 0)
			goto fail;

		config_write(&odp_global_ro.libconfig_runtime, file);
	}

	/* Print temp file to the log */
	rewind(file);
	while ((c = fgetc(file)) != EOF)
		_ODP_PRINT("%c", (char)c);

	fclose(file);
	return 0;

fail:
	fclose(file);
	return -1;
}