configuration mechanism by Gitubrr · Pull Request #242 · SparseLinearAlgebra/spla

Gitubrr · 2026-04-25T18:46:12Z

Comparison of libraries for creating a configuration mechanism

All information is taken from the repositories of the corresponding projects. Access date: 21.04.26.

Comparison criteria

Criterion	Metric	Units
Dependencies	presence	+/-
Sources	CLI (argv) / env / files	+/-, formats
C++ standard	minimum version	C++xx
Supports standard hierarchy	Linux/Windows/MacOS	+/-
Distribution	header-only / static / dynamic	-
OS	Linux / Windows / macOS	+/-, compilers
Activity	average number of commits	commits/month (last month)
Issues	open, closed/open	n, ratio
Community	GitHub Stars	n
Passes CI	CI	+/-

? - not specified in the README.

Comparison of command line parsers (CLI)

Criterion	CLI11	cxxopts
Dependencies	-	-
Sources
CLI (argv)	+	+
env	+	-
Files	-	-
C++ standard	≥ C++11	≥ C++11
Supports standard hierarchy
Linux	+	+
Windows	+	+
MacOS	+	+
Distribution	header-only	header-only
OS
Linux	+ (GCC 4.8+, Clang 3.5+)	+ (GCC ≥ 4.9, Clang ≥ 3.1)
Windows	+ (MSVC ≥ 2015)	+ (MSVC ≥ 2015)
macOS	+ (AppleClang 7+)	+ (Clang ≥ 3.1 with libc++)
Community
Activity (commits/month)	4	1
Total issues	506	307
Issues closed/open	9	6
Stars	4.3k	4.7k
Passes CI	+	+

File parsers

Criterion	nlohmann/json	yaml-cpp	toml++	toml11	config-cxx	taocpp/config
Dependencies	-	-	-	-	-	-
Sources
CLI (argv)	-	-	-	-	-	-
env	-	-	-	-	+	+
Files	JSON	YAML	TOML	TOML	JSON, YAML, XML	JSON, JAXN
C++ standard	≥ C++11	≥ C++11	≥ C++17	≥ C++11	≥ C++20	≥ C++17
Supports standard hierarchy
Linux	+	+	+	+	+	+
Windows	+	+	+	+	+	+
MacOS	+	+	+	+	+	+
Distribution	header-only	static/dynamic¹	header-only/static/dynamic¹	header-only/static/dynamic¹	header-only	header-only
OS
Linux	+ (GCC 4.8–14.2, Clang 3.4–21.0)	+ (GCC, Clang)	+ (Clang 8+, GCC 8+)	+ (GCC, Clang)	+ (GCC 13+, Clang 16+)	+
Windows	+ (MSVC 2015–2022)	+ (MSVC)	+ (MSVC VS2019+)	+ (MSVC, MinGW)	+ (MSVC 143+ (VS 2022))	+
macOS	+ (AppleClang 9.1–16.0)	+ (Xcode, AppleClang)	+ (AppleClang)	+ (AppleClang)	+ (AppleClang 16+)	+
Community
Activity (commits/month)	2	9	2	4	2	13
Total issues	3271	905	193	194	24	5
Issues closed/open	68	3	8	5	0 open	0 open
Stars	49.4k	15k	2k	1.3k	31	194
Passes CI	+	+	+	-	+	?

¹ Optional.

Comparison of universal tools

Criterion	Boost.Program_options
Dependencies	+¹
Sources
CLI (argv)	+
env	+
Files	INI
C++ standard	≥ C++3
Supports standard hierarchy
Linux	+
Windows	+
MacOS	+
Distribution	static/dynamic²
OS
Linux	+ (GCC 5+, Clang 3.6+)
Windows	+ (MSVC 2015 (vc140)+)
macOS	+ (AppleClang)
Community
Activity (commits/month)	12
Total issues	400
Issues closed/open	1
Stars	9.4k
Passes CI	+

¹ Dependency list:

Boost.Any

Boost.Bind

Boost.Config

Boost.Core

Boost.Detail

Boost.Function

Boost.Iterator

Boost.Lexical Cast

Boost.Smart Ptr

Boost.ThrowException

Boost.Tokenizer

Boost.Type Traits

² Optional.

Conclusion:

Based on the comparison results, the best choice is likely to use CLI11 and nlohmann/json, since, unlike Boost.program_options, they require no dependencies and are header-only.

gsvgit · 2026-05-05T09:31:13Z

+        "priority": int
+        "fallback": (???)                           # Нужен ли fallback
+
+    "device":


А почму устройство никак не свзянос оптимизациями? Предположим, я хочу сранвить, как разные параметры влияют на производительность.

gsvgit

Не вполне опнятне сценарий использования конфига. Кажется, один из возможных такой. В файле (или в нескольких) описываются списки со сконфигурированными устройствами. При зввпуске пользовательского приложения ему передаётся конфиг и (опционально) идентификатор конфигурации, на которой запутиться. Если конфигурация не указана, выбирается дефолтная (решить, как её выбирать).

gsvgit · 2026-05-07T13:38:48Z

+
+
+## Итог:
+По результатам сравнения, вероятно, лучшим вариантом будет использование `CLI11` и `nlohmann/json`, так как они, в отличие от `Boost.program_options`, не требуют зависимостей и являются header-only.


А что не так с config-cxx?

Меньше issues и как будто активность поменьше. Я помню, Вы говорнили, что это дискуссионная характеристика. Всетаки config-cxx взять?

gsvgit · 2026-05-07T13:42:29Z

+config:
+
+    "platform":
+        "selection":


Не понимаю по названию, что это за блок и почему он так назван.

способ выбора платформы: можно по названию пользователя, по официальному имени и по вендору. Мне кажется, это естественные поля

для устройства то же самое

gsvgit · 2026-05-07T13:42:50Z

+        "priority": int
+        "fallback": (???)                           # Нужен ли fallback
+        "device":
+            "selection": 


Такая же история.

gsvgit · 2026-05-07T13:43:18Z

+                "official_name": string
+                "type": "gpu" | "cpu" 
+            "index": int
+            "priority": int


Кажется, про очериди ничего нету.

priority не достаточно?

Я вот про эти очереди: Количество очередей: сейчас создается только 1 очередь При чём тут priority?

тогда я не очень понимаю, что в контексте спла значит очередь и какие у нее параметры

gsvgit · 2026-07-10T05:31:16Z

+allocator_size = 1048576
 ```

+Формата ini.


Откуда тут ini. Ещё и на линуксах. Ещё и в 26 году...

Сейчас здесь примеры того, как могут выглядеть конфигурационные файлы в разных форматах. Исходный формат зависит от того, какую библиотеку для парсинга файлов выберем

Кроме этого все впорядке?
Можно уже начать писать сам механизм?
Если комментарии выше больше не актуальны, пометьте, пожалуйста, их как resolved

это пример для toml, а не для ini

…ction (INI -> TOML)

…_of_mem_banks param

gsvgit · 2026-10-05T09:53:57Z

+Файл конфигурации, предоставляющийся библиотекой, имеет следующую структуру:
+```json
+{
+    "current_config": "default",


Strange name. Current will be selected by user at the start.

Почему странное? Пользователь может и не выбирать конфигурацию, но чтобы программа не падала этот параметр имеет дефолтное значение. Если пользователь выберет конфигурацию явно, то оно переопределится значением пользователя
Если пользователь не выбрал конфигурацию, то "текущая конфигурация" - дефолтная, если выбрал, "текущая конфигурация" - выбранная пользоватеоем. На мой взгляд название отражает смысл

gsvgit · 2026-10-05T09:57:42Z

+            },
+
+        "debug_gpu0": {
+            "extends": ["debug", "gpu0"]


Can extends be used not for list of configurations, but to redefine fields for particular configuration? As a way to say "I want to set profiling = true for gpu0 config".

Да.
Можно сделать так:

"current_config": "gpu_profiling_true", "gpu0": { "backend": "by_index", "platform_index": 0, "device_index": 0, "if_gpu_unavailable": "abort", "queues_count": 1, "profiling": false "allocator_type": "general", "verbosity": 3 }, "gpu_profiling_true": { "extends": ["gpu0"], "profiling": true }

В этом случае параметры конфигурации "gpu0" переопределятся параметрами конфигурации "gpu_profiling_true" ( "profiling": false станет true)

gsvgit · 2026-10-05T09:58:32Z

+
+    "configs": {
+        "default": {
+            "backend": "gpu", // переопределен


Why? I see only one configuration in the file.

Конфигурация "gpu0" включает конфигурацию "default", как базовую. Ее параметры будут переопределены параметрами конфигурации "gpu0". Поэтому "backend": "gpu" переопределяется "backend": "by_index". В extends можно записывать конфигурации, которые находятся в конфигурационных файлах с меньшим приоритетом. (в системном файле пользователь может указать конфигурацию из дефолтного файла, в юзер файле - конфигурацию из системного)
Например:
1 Файл, который идет с библиотекой имеет конфигурацию "default"
2 Файл, созданный пользователем имеет конфигурацию "gpu0"
В поле extends конфигурации "gpu0" пользователь может добавить конфигурацию "default", несмотря на то, что она в дефолтном файле бибилиотеки, а не в файле, который создал пользователь
Это сделано для того, чтобы не нудно было дублировать параметры

gsvgit · 2026-10-08T07:00:28Z

+
+      - name: Run tests
+        env:
+          SPLA_CONFIG_FILE: ${{ github.workspace }}/.github/workflows/ci_spla_conf.json


Нет. Так делать в описываемом сценарии нельзя. Подумайте, почему.

gsvgit · 2026-10-13T07:03:45Z

      - name: Check for tests results
        run: |
-          ! grep -qi "FAILED" ${{ env.test-file }}
+          ! grep -qE "\[  FAILED  \]" ${{ env.test-file }}


Why this changes needed?

gsvgit · 2026-10-13T07:05:24Z

@@ -0,0 +1,121 @@
+# Сравнение библиотек для создания механизма конфигурирования


Convert to English

gsvgit · 2026-10-13T07:08:50Z

        m_max_wgs       = m_device.getInfo<CL_DEVICE_MAX_WORK_GROUP_SIZE>();
        m_max_local_mem = m_device.getInfo<CL_DEVICE_LOCAL_MEM_SIZE>();
-        m_addr_align    = m_device.getInfo<CL_DEVICE_MEM_BASE_ADDR_ALIGN>() / 8;// from bits to bytes
+        m_addr_align    = m_device.getInfo<CL_DEVICE_MEM_BASE_ADDR_ALIGN>() / 8;


Why you remove this comment?

They seemed unnecessary. You mentioned that code comments aren't exactly a best practice

Except cases when it is hard to extract some information from code directly.

gsvgit · 2026-10-13T07:08:58Z

            m_wave_size   = 64;
            m_is_amd      = true;

-            // Likely, it is an integrated amd device


gsvgit · 2026-10-13T07:09:35Z


        for (int i = 0; i < count; i++) {
            cl_command_queue_properties properties = 0;
-#ifndef SPLA_RELEASE


Why this change needed?

Queue profiling can now be explicitly specified

gsvgit · 2026-10-13T07:11:47Z

+                ->envname("SPLA_PROFILING");
+
+        app.add_option("-sa,--spla-allocator-type", cfg.allocator_type,
+                       "Allocator type:\n"


Yet another description of flags/ Why?

Files src/opencl/cl_configure.cpp and src/opencl/cl_configure.hpp were moved to src/core, but I forgot to delete these ones

gsvgit · 2026-10-13T12:04:51Z

-        MessageCallback m_callback;
-
+        MessageCallback    m_callback;
+        int                m_verbosity = 3;


gsvgit · 2026-10-14T05:26:39Z

@@ -0,0 +1,121 @@
+# Comparison of libraries for creating a configuration mechanism


Move this to PR description.

gsvgit · 2026-10-14T05:30:13Z

    print(f"pyspla: [{decoded_file}:{line}] {_status_mapping[status]}: {decoded_msg}")


+def filter_spla_args(argv):


Can you use standard Python any package for arguments processing?

gsvgit · 2026-10-14T05:32:24Z

+    auto* lib = spla::Library::get();
+    if (!lib) return SPLA_STATUS_ERROR;
+
+    if (spla::config_final.backend.has_value() &&


What this condition means? Why you check manually only this condition?

gsvgit · 2026-10-14T05:37:14Z

-            LOG_MSG(Status::DeviceNotFound, "index out of list of available devices");
-            return Status::DeviceNotFound;
-        }
+        m_platform.getDevices(CL_DEVICE_TYPE_ALL, &available_devices);


Why we request all types always instead of GPU?

gsvgit · 2026-10-14T05:38:28Z

        m_max_wgs       = m_device.getInfo<CL_DEVICE_MAX_WORK_GROUP_SIZE>();
        m_max_local_mem = m_device.getInfo<CL_DEVICE_LOCAL_MEM_SIZE>();
-        m_addr_align    = m_device.getInfo<CL_DEVICE_MEM_BASE_ADDR_ALIGN>() / 8;// from bits to bytes
+        m_addr_align    = m_device.getInfo<CL_DEVICE_MEM_BASE_ADDR_ALIGN>() / 8;


Except cases when it is hard to extract some information from code directly.

gsvgit · 2026-10-14T05:42:27Z

+        return spla_Configure(static_cast<int>(args.size()), args.data());
+    }
+
+    void print_usage() {


Really? C++ has no library that can automatically infer usage from registered CLI arguments?

gsvgit · 2026-10-14T05:43:31Z

+
 if (SPLA_BUILD_OPENCL)
    if (SPLA_TARGET_MACOSX)
-        message(STATUS "Add standard Apple OpenCL package")


Why these changes required?

gsvgit · 2026-10-14T05:44:59Z


        add_library(OpenCLHeaders INTERFACE)
        add_library(OpenCL::Headers ALIAS OpenCLHeaders)
-        target_include_directories(OpenCLHeaders INTERFACE ${OpenCL_INCLUDE_DIRS})


gsvgit · 2026-10-14T05:45:21Z

-    endif ()

-
-    message(STATUS "Add Khronos OpenCL HPP bindings")


gsvgit · 2026-10-14T05:45:47Z

 if (SPLA_BUILD_OPENCL)
    target_link_libraries(spla PUBLIC OpenCL)
    target_link_libraries(spla PUBLIC OpenCL::HeadersCpp)
-    target_compile_definitions(spla PUBLIC CL_TARGET_OPENCL_VERSION=120)


What the reason of these changes?

Gitubrr added 10 commits April 21, 2026 19:40

made lib compare

88c57b4

added more comparison points

f6c9ff1

added list of dependences

7419e16

CI -> +

21279b0

Just formatting changes to README

e2a2ad1

added config params info

2ed3b03

added config structure

fc33885

formatting only

d680949

added performance parameter

de27aa7

formatting only

e0c9b47

gsvgit reviewed May 5, 2026

View reviewed changes

Gitubrr added 2 commits May 5, 2026 18:35

formatting

0b8ca49

added 2 libs, removed 'Пакетные менеджеры'

b880e9e

Gitubrr requested a review from gsvgit May 5, 2026 19:05

gsvgit reviewed May 7, 2026

View reviewed changes

added SPLA usage scenarios

e0c730b

Gitubrr requested a review from gsvgit May 11, 2026 13:18

Gitubrr added 4 commits May 19, 2026 04:47

making defolt scenario

b5b7580

added 1 question about errors

af09acd

added new scenaries

627b027

added manual

c1b7f2d

gsvgit requested changes Jul 10, 2026

View reviewed changes

Gitubrr added 4 commits July 10, 2026 11:07

Fixed the incorrect format name in 1 example in CONFIGURATION FALE se…

8c9ddff

…ction (INI -> TOML)

add parsers

c90f185

fixed formatting errors

82028eb

changed cli parser, file parser, made validate

464aaa0

Gitubrr requested a review from gsvgit July 28, 2026 15:26

Gitubrr added 3 commits July 28, 2026 20:37

changed init

f8cea29

made apply() and started changing cl_accelerator.cpp,.hpp + added num…

0af1432

…_of_mem_banks param

removed apply(), changed init() -> init(conf)

73045f1

Gitubrr added 12 commits September 23, 2026 02:55

made verbosity

2291458

added MIT license back

3082114

add MIT license to cl_configure

0b14b37

made new user guide

48613f8

chanjed config structure

ac5f337

added new params to cnfig

60f09aa

fixed build err

7586978

CL_TARGET_OPENCL_VERSION=300 -> 120 back

ec9897a

fixed CL_HPP_MINIMUM_OPENCL_VERSION

788e7b4

for deps

b895cd9

for formatter

3e7f817

removed base from UserGuide

17ec47a

gsvgit reviewed Oct 5, 2026

View reviewed changes

Gitubrr requested a review from gsvgit October 5, 2026 13:21

Gitubrr added 4 commits October 6, 2026 21:25

removed "configs" and "current_config"

73a39f6

added about how to run with user conf

103f80e

fixed ci scenar

4f9309f

Запуск с -> Запуск ci с

e6a8c45

gsvgit reviewed Oct 8, 2026

View reviewed changes

Gitubrr added 3 commits October 13, 2026 09:12

added new configuration func

0dc7fba

removed comment

ae1209d

fix for windows

2b2448e

gsvgit requested changes Oct 13, 2026

View reviewed changes

Gitubrr added 4 commits October 13, 2026 11:48

deleted and renamed files

66f1a3a

cl_config_status.hpp -> config_status.hpp

14c6bf1

chanjed ci back

e31094b

chanjed lang to english

0a82109

gsvgit reviewed Oct 13, 2026

View reviewed changes

Comment thread src/core/logger.hpp

MessageCallback m_callback;

MessageCallback m_callback;

int m_verbosity = 3;

gsvgit Oct 13, 2026

Copy link
Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why?

gsvgit requested changes Oct 14, 2026

View reviewed changes

chacged logs

6042947



		## Итог:
		По результатам сравнения, вероятно, лучшим вариантом будет использование `CLI11` и `nlohmann/json`, так как они, в отличие от `Boost.program_options`, не требуют зависимостей и являются header-only.

		@@ -0,0 +1,121 @@
		# Сравнение библиотек для создания механизма конфигурирования

		@@ -0,0 +1,121 @@
		# Comparison of libraries for creating a configuration mechanism

		print(f"pyspla: [{decoded_file}:{line}] {_status_mapping[status]}: {decoded_msg}")


		def filter_spla_args(argv):

Conversation

Gitubrr commented Apr 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comparison of libraries for creating a configuration mechanism

Comparison criteria

Comparison of command line parsers (CLI)

File parsers

Comparison of universal tools

Conclusion:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gsvgit left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Gitubrr Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Gitubrr Oct 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Gitubrr commented Apr 25, 2026 •

edited

Loading

Gitubrr Jul 10, 2026 •

edited

Loading

Gitubrr Oct 5, 2026 •

edited

Loading