issue: 4207451 Move from env params to config file

MVP: Move from env params to config file.

This change introduces a new configuration file that will be used to
configure the system.

The configuration file is a JSON file that
contains all the configuration parameters that were previously passed
as environment variables.

In the case of a failure to load the configuration file,
the system will fall back to the old environment variables method.

See HLD and LLD for more information.

This patch also adds unit-tests for the new configuration system.

Signed-off-by: Tomer Cabouly <[email protected]>

Author: tomerdbz

.gitignore

@@ -21,7 +21,8 @@ Makefile.in
 Makefile
 aclocal.m4
 autom4te.cache/
-config.h
+json_descriptor.h
+/config.h
 config.h.in
 config.h.in~
 config.log
@@ -77,3 +78,6 @@ docs/man/xlio.7
 docs/man/xlio_stats.8
 docs/man/xliod.8
 tools/daemon/xliod
+
+tests/unit_tests/unit_tests
+*.pyc

Makefile.am

@@ -38,6 +38,7 @@ uninstall-all: uninstall
 tests:
 	$(MAKE)
 	$(MAKE) -C tests/gtest
+	$(MAKE) -C tests/unit_tests
 	$(MAKE) -C tests/latency_test
 	$(MAKE) -C tests/throughput_test
 	$(MAKE) -C tests/pps_test

config/m4/json.m4

@@ -0,0 +1,48 @@
+#
+# SPDX-FileCopyrightText: NVIDIA CORPORATION & AFFILIATES
+# Copyright (c) 2001-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: GPL-2.0-oJSONy or BSD-3-Clause
+#
+# This software is available to you under a choice of one of two
+# licenses.  You may choose to be licensed under the terms of the GNU
+# General Public License (GPL) Version 2, available from the file
+# COPYING in the main directory of this source tree, or the
+# BSD license below:
+#
+#     Redistribution and use in source and binary forms, with or
+#     without modification, are permitted provided that the following
+#     conditions are met:
+#
+#      - Redistributions of source code must retain the above
+#        copyright notice, this list of conditions and the following
+#        disclaimer.
+#
+#      - Redistributions in binary form must reproduce the above
+#        copyright notice, this list of conditions and the following
+#        disclaimer in the documentation and/or other materials
+#        provided with the distribution.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+# json.m4 - Detect json-c package
+#
+
+##########################
+# Checking json-c library
+#
+AC_DEFUN([CHECK_JSON_LIB],
+[
+PKG_CHECK_MODULES([JSON_C], [json-c])
+
+AC_SUBST([LIBJSON_LIBS], "$LIBJSON_C_LIBS")
+AC_SUBST([LIBJSON_CFLAGS], "$LIBJSON_C_CFLAGS")
+
+])

configure.ac

@@ -84,6 +84,7 @@ m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])])
 m4_include([config/m4/func.m4])
 m4_include([config/m4/opt.m4])
 m4_include([config/m4/verbs.m4])
+m4_include([config/m4/json.m4])
 m4_include([config/m4/dpcp.m4])
 m4_include([config/m4/nl.m4])
 m4_include([config/m4/prof.m4])
@@ -312,6 +313,7 @@ AC_CHECK_LIB([rt], [clock_gettime])
 AC_CHECK_LIB([pthread], [pthread_create])
 
 CHECK_NL_LIB()
+CHECK_JSON_LIB()
 
 dnl===-----------------------------------------------------------------------===
 dnl===
@@ -413,6 +415,7 @@ AC_CONFIG_FILES([
 		src/state_machine/Makefile
 		tests/Makefile
 		tests/gtest/Makefile
+        tests/unit_tests/Makefile
 		tools/Makefile
 		tools/daemon/Makefile
 		docs/man/Makefile

src/core/Makefile.am

@@ -1,8 +1,6 @@
 
 noinst_LTLIBRARIES = \
 	libconfig_parser.la
-libconfig_parser_la_SOURCES =
-BUILT_SOURCES =
 
 AM_LFLAGS = -Plibxlio_yy
 AM_YFLAGS = -plibxlio_yy -d
@@ -15,10 +13,8 @@ LEX_OUTPUT_ROOT=lex.libxlio_yy
 #
 #BUILT_SOURCES += config_scanner.c config_parser.h config_parser.c
 #libconfig_parser_la_SOURCES += util/config_scanner.l util/config_parser.y
-libconfig_parser_la_SOURCES += config_scanner.c config_parser.c
+libconfig_parser_la_SOURCES = config_scanner.c config_parser.c
 
-
-CLEANFILES = $(BUILT_SOURCES)
 dist-hook:
 	cd $(distdir); rm -f $(BUILT_SOURCES)
 
@@ -56,14 +52,24 @@ libxlio_la_LDFLAGS := $(XLIO_LTO) $(XLIO_PROFILE) -no-undefined \
 	-version-number @PRJ_LIBRARY_MAJOR@:@PRJ_LIBRARY_MINOR@:@PRJ_LIBRARY_REVISION@
 
 libxlio_la_LIBADD = \
-	-lrt -ldl -lpthread $(LIBNL_LIBS) $(VERBS_LIBS) $(DPCP_LIBS) $(XLIO_GCOV) \
+	-lrt -ldl -lpthread $(LIBNL_LIBS) $(VERBS_LIBS) $(DPCP_LIBS) $(XLIO_GCOV) $(JSON_C_LIBS) \
 	$(top_builddir)/src/utils/libutils.la \
 	$(top_builddir)/src/vlogger/libvlogger.la \
 	$(top_builddir)/src/state_machine/libstate_machine.la \
 	$(top_builddir)/src/stats/libstats.la \
 	$(top_builddir)/src/core/netlink/libnetlink.la \
 	$(top_builddir)/src/core/infra/libinfra.la \
 	libconfig_parser.la
+
+dist_noinst_DATA = config/descriptor_providers/json_descriptor.json
+
+BUILT_SOURCES = config/descriptor_providers/json_descriptor.h
+
+config/descriptor_providers/json_descriptor.h: config/descriptor_providers/json_descriptor.json
+	xxd -i config/descriptor_providers/json_descriptor.json > $@
+
+CLEANFILES = $(BUILT_SOURCES)
+
 
 libxlio_la_SOURCES := \
 	dev/allocator.cpp \
@@ -169,6 +175,14 @@ libxlio_la_SOURCES := \
 	util/agent.cpp \
 	util/data_updater.cpp \
 	\
+	config/config_manager.cpp \
+	config/loaders/inline_loader.cpp \
+	config/loaders/json_loader.cpp \
+	config/descriptors/parameter_descriptor.cpp \
+	config/descriptors/config_descriptor.cpp \
+	config/descriptor_providers/json_descriptor_provider.cpp \
+	config/utils/json_parsing.cpp \
+	\
 	libxlio.c \
 	main.cpp \
 	\

src/core/config/config.h

@@ -0,0 +1,59 @@
+/*
+ * SPDX-FileCopyrightText: NVIDIA CORPORATION & AFFILIATES
+ * Copyright (c) 2001-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+ * SPDX-License-Identifier: GPL-2.0-only or BSD-3-Clause
+ *
+ * This software is available to you under a choice of one of two
+ * licenses.  You may choose to be licensed under the terms of the GNU
+ * General Public License (GPL) Version 2, available from the file
+ * COPYING in the main directory of this source tree, or the
+ * BSD license below:
+ *
+ *     Redistribution and use in source and binary forms, with or
+ *     without modification, are permitted provided that the following
+ *     conditions are met:
+ *
+ *      - Redistributions of source code must retain the above
+ *        copyright notice, this list of conditions and the following
+ *        disclaimer.
+ *
+ *      - Redistributions in binary form must reproduce the above
+ *        copyright notice, this list of conditions and the following
+ *        disclaimer in the documentation and/or other materials
+ *        provided with the distribution.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#pragma once
+#include <experimental/any>
+#include <string>
+#include <stdexcept>
+
+class config {
+public:
+    virtual ~config() noexcept = default;
+    template <typename T> T get_value(const std::string &key) const
+    {
+        // Defer to a pure virtual function to retrieve the raw value.
+        std::experimental::any raw_value = get_value_as_any(key);
+
+        // Attempt to cast to the requested type T.
+        try {
+            return std::experimental::any_cast<T>(raw_value);
+        } catch (const std::experimental::bad_any_cast &e) {
+            throw std::runtime_error("config::get_value - Bad any_cast for key: " + key + " - " +
+                                     e.what());
+        }
+    }
+
+protected:
+    virtual std::experimental::any get_value_as_any(const std::string &key) const = 0;
+};

src/core/config/config_bundle.h

@@ -0,0 +1,42 @@
+/*
+ * SPDX-FileCopyrightText: NVIDIA CORPORATION & AFFILIATES
+ * Copyright (c) 2001-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+ * SPDX-License-Identifier: GPL-2.0-only or BSD-3-Clause
+ *
+ * This software is available to you under a choice of one of two
+ * licenses.  You may choose to be licensed under the terms of the GNU
+ * General Public License (GPL) Version 2, available from the file
+ * COPYING in the main directory of this source tree, or the
+ * BSD license below:
+ *
+ *     Redistribution and use in source and binary forms, with or
+ *     without modification, are permitted provided that the following
+ *     conditions are met:
+ *
+ *      - Redistributions of source code must retain the above
+ *        copyright notice, this list of conditions and the following
+ *        disclaimer.
+ *
+ *      - Redistributions in binary form must reproduce the above
+ *        copyright notice, this list of conditions and the following
+ *        disclaimer in the documentation and/or other materials
+ *        provided with the distribution.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#pragma once
+
+#include "descriptors/config_descriptor.h"
+
+struct config_bundle {
+    std::map<std::string, std::experimental::any> m_config_data;
+    config_descriptor m_config_descriptor;
+};