From 88c57b41cd53a2ec7268a6c8b33713d1f8004855 Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Tue, 21 Apr 2026 19:40:02 +0300 Subject: [PATCH 01/18] made lib compare --- src/opencl/Compare.md | 109 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 src/opencl/Compare.md diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md new file mode 100644 index 000000000..17c9a5e07 --- /dev/null +++ b/src/opencl/Compare.md @@ -0,0 +1,109 @@ +# Сравнение библиотек для создания механизма конфигурирования +Вся информация взята из репозиториев соответствующих проектов. Дата обращения: 21.04.26. + +## Критерии сравнения + +| Критерий | Метрика | Единицы измерения | +|:---|:---|:---| +| **Зависимости** | количество, суммарный размер | n, MiB | +| **Источники** | CLI (argv) / env / файлы | +/-, форматы | +| **Стандарт C++** | минимальная версия | C++хх | +| **Пакетные менеджеры** | vcpkg / Conan / Conda / apt / brew / pacman | +/- | +| **Способ распространения** | header-only / статическая / динамическая | — | +| **ОС** | Linux / Windows / macOS | +/-, компиляторы | +| **Активность** | среднее число коммитов | коммитов/мес (за последний мес) | +| **Issues** | open, closed/open | n, коэффициент | +| **Сообщество** | GitHub Stars | n | + + + +## Сравнение парсеров командной строки (CLI) + +| Критерий | CLI11 | cxxopts | +|:---|:---:|:---:| +| Зависимости (n, MiB) | 0, 0 | 0, 0 | +| **Источники** | | | +|  CLI (argv) | + | + | +|  env | + | - | +|  Файлы | INI, TOML¹ | - | +| Стандарт C++ | ≥ C++11 | ≥ C++11 | +| **Пакетные менеджеры** | | | +|  vcpkg | + | + | +|  Conan | + | + | +|  Conda | + | ? | +|  apt | ? | ? | +|  brew | ? | + | +|  pacman | ? | ? | +| Способ распространения | header-only | header-only +| **ОС** | | | +|  Linux | + (GCC 4.8+, Clang 3.5+) | + (GCC ≥ 4.9, Clang ≥ 3.1) | +|  Windows | + (MSVC ≥ 2015) | + (MSVC ≥ 2015) | +|  macOS | + (AppleClang 7+) | + (Clang ≥ 3.1 с libc++) | +| **Сообщество** | | | +|  Активность (коммитов/мес) | 4 | 1 | +|  Issues всего | 506 | 307 | +|  Issues closed/open | 9 | 6 | +|  Stars | 4.3k | 4.7k | + + +> ¹ CLI11 поддерживает env с версии 2.4.0, файлы INI/TOML читает как опции командной строки. + +## Парсеры файлов + +| Критерий | nlohmann/json | yaml-cpp | toml++ | toml11 | +|:---|:---:|:---:|:---:|:---:| +| Зависимости (n, MiB) | 0, 0 | 0, 0 | 0, 0 | 0, 0 +| **Источники** | | | +|  CLI (argv) | - | - | - | - +|  env | - | - | - | - +|  Файлы | JSON | YAML | TOML | TOML +| Стандарт C++ | ≥ C++11 | ≥ C++11 | ≥ C++17 | ≥ C++11 +| **Пакетные менеджеры** | | | +|  vcpkg | + | + | + | + +|  Conan | + | + | + | ? +|  Conda | + | + | ? | ? +|  apt | + | + | ? | ? +|  brew | + | + | ? | ? +|  pacman | + | + | ? | ? | +| Способ распространения | header-only | статическая/динамическая¹ | header-only/статическая/динамическая¹ | header-only/статическая/динамическая¹ +| **ОС** | | | +|  Linux | + (GCC 4.8–14.2, Clang 3.4–21.0) | + (GCC, Clang) | + (Clang 8+, GCC 8+) | + (GCC, Clang) +|  Windows | + (MSVC 2015–2022) | + (MSVC) | + (MSVC VS2019+) | + (MSVC, MinGW) +|  macOS | + (AppleClang 9.1–16.0) | + (Xcode, AppleClang) | + (AppleClang) | + (AppleClang) +| **Сообщество** | | | +|  Активность (коммитов/мес) | 2 | 9 | 2 | 4 +|  Issues всего | 3271 | 905 | 193 | 194 +|  Issues closed/open | 68 | 3 | 8 | 5 +|  Stars | 49.4k | 15k | 2k | 1.3k + +> ¹ Опционально. + +## Сравнение универсальных инструментов + +| Критерий | Boost +|:---|:---:| +| Зависимости (n, MiB) | 0, ~192 | +| **Источники** | | | +|  CLI (argv) | + | + | +|  env | + | + | +|  Файлы | INI, JSON, XML, TOML | +| Стандарт C++ | ≥ C++11 | ≥ C++11 | +| **Пакетные менеджеры** | | | +|  vcpkg | + | +|  Conan | + | +|  Conda | + | +|  apt | + | +|  brew | + | +|  pacman | + | +| Способ распространения | header-only/статическая/динамическая¹ | +| **ОС** | | | +|  Linux | + (GCC 5+, Clang 3.6+) | +|  Windows | + (MSVC 2015 (vc140)) | +|  macOS | + (AppleClang) | +| **Сообщество** | | | +|  Активность (коммитов/мес) | 12 | +|  Issues всего | 400 | +|  Issues closed/open | 1 | +|  Stars | 9.4k | + +> ¹ Опционально. \ No newline at end of file From f6c9ff12a39f5bf03d106c10295243a238c529da Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Sat, 25 Apr 2026 22:59:16 +0300 Subject: [PATCH 02/18] added more comparison points --- src/opencl/Compare.md | 43 +++++++++++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 14 deletions(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index 17c9a5e07..7a6634642 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -5,9 +5,10 @@ | Критерий | Метрика | Единицы измерения | |:---|:---|:---| -| **Зависимости** | количество, суммарный размер | n, MiB | +| **Зависимости** | наличие | +/- | | **Источники** | CLI (argv) / env / файлы | +/-, форматы | | **Стандарт C++** | минимальная версия | C++хх | +| **Поддерживает стандарт иерархии** | Linux/Windows/MacOS | +/- | | **Пакетные менеджеры** | vcpkg / Conan / Conda / apt / brew / pacman | +/- | | **Способ распространения** | header-only / статическая / динамическая | — | | **ОС** | Linux / Windows / macOS | +/-, компиляторы | @@ -19,14 +20,18 @@ ## Сравнение парсеров командной строки (CLI) -| Критерий | CLI11 | cxxopts | +| Критерий | CLI11 | cxxopts | |:---|:---:|:---:| -| Зависимости (n, MiB) | 0, 0 | 0, 0 | +| Зависимости | - | - | | **Источники** | | | |  CLI (argv) | + | + | |  env | + | - | -|  Файлы | INI, TOML¹ | - | +|  Файлы | - | - | | Стандарт C++ | ≥ C++11 | ≥ C++11 | +| **Поддерживает стандарт иерархии** | | | +|  Linux | + | + | +|  Windows | + | + | +|  MacOS | + | + | | **Пакетные менеджеры** | | | |  vcpkg | + | + | |  Conan | + | + | @@ -46,18 +51,20 @@ |  Stars | 4.3k | 4.7k | -> ¹ CLI11 поддерживает env с версии 2.4.0, файлы INI/TOML читает как опции командной строки. - ## Парсеры файлов | Критерий | nlohmann/json | yaml-cpp | toml++ | toml11 | |:---|:---:|:---:|:---:|:---:| -| Зависимости (n, MiB) | 0, 0 | 0, 0 | 0, 0 | 0, 0 +| Зависимости | - | - | - | - | **Источники** | | | |  CLI (argv) | - | - | - | - |  env | - | - | - | - |  Файлы | JSON | YAML | TOML | TOML | Стандарт C++ | ≥ C++11 | ≥ C++11 | ≥ C++17 | ≥ C++11 +| **Поддерживает стандарт иерархии** | | | +|  Linux | + | + | + | + | +|  Windows | + | + | + | + | +|  MacOS | + | + | + | + | | **Пакетные менеджеры** | | | |  vcpkg | + | + | + | + |  Conan | + | + | + | ? @@ -80,14 +87,18 @@ ## Сравнение универсальных инструментов -| Критерий | Boost +| Критерий | Boost.Program_options |:---|:---:| -| Зависимости (n, MiB) | 0, ~192 | +| Зависимости | + | | **Источники** | | | |  CLI (argv) | + | + | |  env | + | + | -|  Файлы | INI, JSON, XML, TOML | -| Стандарт C++ | ≥ C++11 | ≥ C++11 | +|  Файлы | INI | +| Стандарт C++ | ≥ C++3 | +| **Поддерживает стандарт иерархии** | | | +|  Linux | + | +|  Windows | + | +|  MacOS | + | | **Пакетные менеджеры** | | | |  vcpkg | + | |  Conan | + | @@ -95,10 +106,10 @@ |  apt | + | |  brew | + | |  pacman | + | -| Способ распространения | header-only/статическая/динамическая¹ | +| Способ распространения | статическая/динамическая¹ | | **ОС** | | | |  Linux | + (GCC 5+, Clang 3.6+) | -|  Windows | + (MSVC 2015 (vc140)) | +|  Windows | + (MSVC 2015 (vc140)+) | |  macOS | + (AppleClang) | | **Сообщество** | | | |  Активность (коммитов/мес) | 12 | @@ -106,4 +117,8 @@ |  Issues closed/open | 1 | |  Stars | 9.4k | -> ¹ Опционально. \ No newline at end of file +> ¹ Опционально. + + +## Итог: +По результатам сравнения, вероятно, лучшим вариантом будет использование `CLI11` и `nlohmann/json`, так как они, в отличие от Boost.program_options, не требуют зависимостей и являются header-only. \ No newline at end of file From 7419e1637cad00d327c0e9a8ac596258d115be37 Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Tue, 28 Apr 2026 17:03:26 +0300 Subject: [PATCH 03/18] added list of dependences --- src/opencl/Compare.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index 7a6634642..705b1dbca 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -15,6 +15,7 @@ | **Активность** | среднее число коммитов | коммитов/мес (за последний мес) | | **Issues** | open, closed/open | n, коэффициент | | **Сообщество** | GitHub Stars | n | +| **Проходит ли CI** | CI | +/- | @@ -49,6 +50,7 @@ |  Issues всего | 506 | 307 | |  Issues closed/open | 9 | 6 | |  Stars | 4.3k | 4.7k | +| **Проходит ли CI** | CI | + | + | ## Парсеры файлов @@ -82,6 +84,7 @@ |  Issues всего | 3271 | 905 | 193 | 194 |  Issues closed/open | 68 | 3 | 8 | 5 |  Stars | 49.4k | 15k | 2k | 1.3k +| **Проходит ли CI** | CI | + | + | - | + | > ¹ Опционально. @@ -89,7 +92,7 @@ | Критерий | Boost.Program_options |:---|:---:| -| Зависимости | + | +| Зависимости | +¹ | | **Источники** | | | |  CLI (argv) | + | + | |  env | + | + | @@ -106,7 +109,7 @@ |  apt | + | |  brew | + | |  pacman | + | -| Способ распространения | статическая/динамическая¹ | +| Способ распространения | статическая/динамическая² | | **ОС** | | | |  Linux | + (GCC 5+, Clang 3.6+) | |  Windows | + (MSVC 2015 (vc140)+) | @@ -116,8 +119,23 @@ |  Issues всего | 400 | |  Issues closed/open | 1 | |  Stars | 9.4k | +| **Проходит ли CI** | CI | + | -> ¹ Опционально. +> ¹ Список зависимостей: +1. Boost.Any +2. Boost.Bind +3. Boost.Config +4. Boost.Core +5. Boost.Detail +6. Boost.Function +7. Boost.Iterator +8. Boost.Lexical Cast +9. Boost.Smart Ptr +10. Boost.ThrowException +11. Boost.Tokenizer +12. Boost.Type Traits + +> ² Опционально. ## Итог: From 21279b013f3d124a579a75f786f3cc7dcd1f36bf Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Wed, 29 Apr 2026 03:48:13 +0300 Subject: [PATCH 04/18] CI -> + --- src/opencl/Compare.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index 705b1dbca..e0d144d1e 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -50,7 +50,7 @@ |  Issues всего | 506 | 307 | |  Issues closed/open | 9 | 6 | |  Stars | 4.3k | 4.7k | -| **Проходит ли CI** | CI | + | + | +| **Проходит ли CI** | + | + | + | ## Парсеры файлов @@ -84,7 +84,7 @@ |  Issues всего | 3271 | 905 | 193 | 194 |  Issues closed/open | 68 | 3 | 8 | 5 |  Stars | 49.4k | 15k | 2k | 1.3k -| **Проходит ли CI** | CI | + | + | - | + | +| **Проходит ли CI** | + | + | + | - | + | > ¹ Опционально. @@ -119,7 +119,7 @@ |  Issues всего | 400 | |  Issues closed/open | 1 | |  Stars | 9.4k | -| **Проходит ли CI** | CI | + | +| **Проходит ли CI** | + | + | > ¹ Список зависимостей: 1. Boost.Any From e2a2ad1a96cb9c3a8984f296e292818ed903e9ca Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Wed, 29 Apr 2026 03:53:50 +0300 Subject: [PATCH 05/18] Just formatting changes to README --- src/opencl/Compare.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index e0d144d1e..96bfff750 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -122,21 +122,21 @@ | **Проходит ли CI** | + | + | > ¹ Список зависимостей: -1. Boost.Any -2. Boost.Bind -3. Boost.Config -4. Boost.Core -5. Boost.Detail -6. Boost.Function -7. Boost.Iterator -8. Boost.Lexical Cast -9. Boost.Smart Ptr -10. Boost.ThrowException -11. Boost.Tokenizer -12. Boost.Type Traits +> 1. Boost.Any +> 2. Boost.Bind +> 3. Boost.Config +> 4. Boost.Core +> 5. Boost.Detail +> 6. Boost.Function +> 7. Boost.Iterator +> 8. Boost.Lexical Cast +> 9. Boost.Smart Ptr +> 10. Boost.ThrowException +> 11. Boost.Tokenizer +> 12. Boost.Type Traits > ² Опционально. ## Итог: -По результатам сравнения, вероятно, лучшим вариантом будет использование `CLI11` и `nlohmann/json`, так как они, в отличие от Boost.program_options, не требуют зависимостей и являются header-only. \ No newline at end of file +По результатам сравнения, вероятно, лучшим вариантом будет использование `CLI11` и `nlohmann/json`, так как они, в отличие от `Boost.program_options`, не требуют зависимостей и являются header-only. \ No newline at end of file From 2ed3b039ffa9ef2d16b59aa24961341eb70642b1 Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Mon, 4 May 2026 05:53:20 +0300 Subject: [PATCH 06/18] added config params info --- src/opencl/Compare.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index 96bfff750..77ff795ee 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -139,4 +139,33 @@ ## Итог: -По результатам сравнения, вероятно, лучшим вариантом будет использование `CLI11` и `nlohmann/json`, так как они, в отличие от `Boost.program_options`, не требуют зависимостей и являются header-only. \ No newline at end of file +По результатам сравнения, вероятно, лучшим вариантом будет использование `CLI11` и `nlohmann/json`, так как они, в отличие от `Boost.program_options`, не требуют зависимостей и являются header-only. + + +# Что нужно конфигурировать +1. Выбор платформы +2. Выбор устройства +3. Количество очередей: сейчас создается только 1 очередь +4. Приоритеты очередей +5. Размер линейного аллокатора `DEFAULT_SIZE` +6. Стратегия выбора аллокатора: \ + NVIDIA используют общий аллокатор \ + Все остальные используем линейный аллокатор +7. Характеристики устройтсв:\ + `m_vendor_id` \ + `m_max_cu` \ + `m_default_wgs` \ + `m_max_local_mem` \ + `m_addr_align` \ + пороги `m_max_wgs`, `m_max_cu`, `m_wave_size` +8. Строковые паттерны проверки девайса: возможно только 3 вариаета `m_vendor_name` +6. Дефолтные значения характеристик \ + `m_addr_align` \ + `m_default_wgs` \ + `uint m_wave_size` \ + `uint m_num_of_mem_banks` +7. Суффикс и имя \ + `m_name` \ + `m_suffix ` +8. Тип устройства (чтобы можно было использовать CPU) + `getDevices` \ No newline at end of file From fc33885d6d39fed790e25d6d9a1e7ed27748ed13 Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Mon, 4 May 2026 22:18:32 +0300 Subject: [PATCH 07/18] added config structure --- src/opencl/Compare.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index 77ff795ee..7eaf8c6d3 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -168,4 +168,36 @@ `m_name` \ `m_suffix ` 8. Тип устройства (чтобы можно было использовать CPU) - `getDevices` \ No newline at end of file + `getDevices` + +# Структура конфига (JSON) + +```bash +config: + + "platform": + "selection": + "user_alias": string + "official_name": string + "vendor": "nvidia" | "amd" | "intel" | "img" | "" + "index": int + "priority": int + "fallback": (???) # Нужен ли fallback + + "device": { + "selection": + "user_alias": string + "official_name": string + "type": "gpu" | "cpu" | "accelerator" | "all" + "index": int + "priority": int + "naming": + "accelerator_name" # m_name + "cache_suffix" # m_suffix + "tuning": + "default_work_group_size": int # m_default_wgs + "wave_size": int # m_wave_size + "memory_banks": int # m_num_of_mem_banks + "memory_alignment": int # m_addr_align + "fallback": (???) # Нужен ли fallback +``` \ No newline at end of file From d6809498459635cc7f34f5a24fb0a62e01258776 Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Mon, 4 May 2026 22:23:01 +0300 Subject: [PATCH 08/18] formatting only --- src/opencl/Compare.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index 7eaf8c6d3..6145cccf4 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -188,7 +188,7 @@ config: "selection": "user_alias": string "official_name": string - "type": "gpu" | "cpu" | "accelerator" | "all" + "type": "gpu" | "cpu" "index": int "priority": int "naming": From de27aa71c3eee3f402d965257db681f20fb51b84 Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Mon, 4 May 2026 22:36:23 +0300 Subject: [PATCH 09/18] added performance parameter --- src/opencl/Compare.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index 6145cccf4..3d063e800 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -184,7 +184,7 @@ config: "priority": int "fallback": (???) # Нужен ли fallback - "device": { + "device": "selection": "user_alias": string "official_name": string @@ -200,4 +200,14 @@ config: "memory_banks": int # m_num_of_mem_banks "memory_alignment": int # m_addr_align "fallback": (???) # Нужен ли fallback + + "performance" + "memory" + "linear_allocator_size_mb": int # DEFAULT_SIZE + "allocator_strategy": string # "auto" | "linear" | "general" | "vendor" + "vendor_strategy": + "nvidia": string # "linear" | "general" + "amd": string # "linear" | "general" + "intel": string # "linear" | "general" + "img": strings # "linear" | "general" ``` \ No newline at end of file From e0c9b47137ba531a84748e1924946c31ce71cc6f Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Mon, 4 May 2026 22:38:09 +0300 Subject: [PATCH 10/18] formatting only --- src/opencl/Compare.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index 3d063e800..0763f1590 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -204,10 +204,10 @@ config: "performance" "memory" "linear_allocator_size_mb": int # DEFAULT_SIZE - "allocator_strategy": string # "auto" | "linear" | "general" | "vendor" + "allocator_strategy": "auto" | "linear" | "general" | "vendor" "vendor_strategy": - "nvidia": string # "linear" | "general" - "amd": string # "linear" | "general" - "intel": string # "linear" | "general" - "img": strings # "linear" | "general" + "nvidia": "linear" | "general" + "amd": "linear" | "general" + "intel": "linear" | "general" + "img": "linear" | "general" ``` \ No newline at end of file From 0b8ca4945d2a6e3b944b098e171bd02a368930fe Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Tue, 5 May 2026 18:35:26 +0300 Subject: [PATCH 11/18] formatting --- src/opencl/Compare.md | 52 +++++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 27 deletions(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index 0763f1590..d5ff3481e 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -183,31 +183,29 @@ config: "index": int "priority": int "fallback": (???) # Нужен ли fallback - - "device": - "selection": - "user_alias": string - "official_name": string - "type": "gpu" | "cpu" - "index": int - "priority": int - "naming": - "accelerator_name" # m_name - "cache_suffix" # m_suffix - "tuning": - "default_work_group_size": int # m_default_wgs - "wave_size": int # m_wave_size - "memory_banks": int # m_num_of_mem_banks - "memory_alignment": int # m_addr_align - "fallback": (???) # Нужен ли fallback - - "performance" - "memory" - "linear_allocator_size_mb": int # DEFAULT_SIZE - "allocator_strategy": "auto" | "linear" | "general" | "vendor" - "vendor_strategy": - "nvidia": "linear" | "general" - "amd": "linear" | "general" - "intel": "linear" | "general" - "img": "linear" | "general" + "device": + "selection": + "user_alias": string + "official_name": string + "type": "gpu" | "cpu" + "index": int + "priority": int + "naming": + "accelerator_name" # m_name + "cache_suffix" # m_suffix + "tuning": + "default_work_group_size": int # m_default_wgs + "wave_size": int # m_wave_size + "memory_banks": int # m_num_of_mem_banks + "memory_alignment": int # m_addr_align + "fallback": (???) # Нужен ли fallback + "performance" + "memory" + "linear_allocator_size_mb": int # DEFAULT_SIZE + "allocator_strategy": "auto" | "linear" | "general" | "vendor" + "vendor_strategy": + "nvidia": "linear" | "general" + "amd": "linear" | "general" + "intel": "linear" | "general" + "img": "linear" | "general" ``` \ No newline at end of file From b880e9eb83a28485a7efa538c78f950c518bf754 Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Tue, 5 May 2026 22:04:53 +0300 Subject: [PATCH 12/18] =?UTF-8?q?added=202=20libs,=20removed=20'=D0=9F?= =?UTF-8?q?=D0=B0=D0=BA=D0=B5=D1=82=D0=BD=D1=8B=D0=B5=20=D0=BC=D0=B5=D0=BD?= =?UTF-8?q?=D0=B5=D0=B4=D0=B6=D0=B5=D1=80=D1=8B'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/opencl/Compare.md | 69 +++++++++++++++---------------------------- 1 file changed, 24 insertions(+), 45 deletions(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index d5ff3481e..f8bad3444 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -9,7 +9,6 @@ | **Источники** | CLI (argv) / env / файлы | +/-, форматы | | **Стандарт C++** | минимальная версия | C++хх | | **Поддерживает стандарт иерархии** | Linux/Windows/MacOS | +/- | -| **Пакетные менеджеры** | vcpkg / Conan / Conda / apt / brew / pacman | +/- | | **Способ распространения** | header-only / статическая / динамическая | — | | **ОС** | Linux / Windows / macOS | +/-, компиляторы | | **Активность** | среднее число коммитов | коммитов/мес (за последний мес) | @@ -17,6 +16,7 @@ | **Сообщество** | GitHub Stars | n | | **Проходит ли CI** | CI | +/- | +> ? - не указано в README. ## Сравнение парсеров командной строки (CLI) @@ -33,13 +33,6 @@ |  Linux | + | + | |  Windows | + | + | |  MacOS | + | + | -| **Пакетные менеджеры** | | | -|  vcpkg | + | + | -|  Conan | + | + | -|  Conda | + | ? | -|  apt | ? | ? | -|  brew | ? | + | -|  pacman | ? | ? | | Способ распространения | header-only | header-only | **ОС** | | | |  Linux | + (GCC 4.8+, Clang 3.5+) | + (GCC ≥ 4.9, Clang ≥ 3.1) | @@ -50,41 +43,34 @@ |  Issues всего | 506 | 307 | |  Issues closed/open | 9 | 6 | |  Stars | 4.3k | 4.7k | -| **Проходит ли CI** | + | + | + | +| Проходит ли CI | + | + | + | ## Парсеры файлов -| Критерий | nlohmann/json | yaml-cpp | toml++ | toml11 | -|:---|:---:|:---:|:---:|:---:| -| Зависимости | - | - | - | - -| **Источники** | | | -|  CLI (argv) | - | - | - | - -|  env | - | - | - | - -|  Файлы | JSON | YAML | TOML | TOML -| Стандарт C++ | ≥ C++11 | ≥ C++11 | ≥ C++17 | ≥ C++11 -| **Поддерживает стандарт иерархии** | | | -|  Linux | + | + | + | + | -|  Windows | + | + | + | + | -|  MacOS | + | + | + | + | -| **Пакетные менеджеры** | | | -|  vcpkg | + | + | + | + -|  Conan | + | + | + | ? -|  Conda | + | + | ? | ? -|  apt | + | + | ? | ? -|  brew | + | + | ? | ? -|  pacman | + | + | ? | ? | -| Способ распространения | header-only | статическая/динамическая¹ | header-only/статическая/динамическая¹ | header-only/статическая/динамическая¹ +| Критерий | nlohmann/json | yaml-cpp | toml++ | toml11 | config-cxx | taocpp/config +|:---|:---:|:---:|:---:|:---:|:---:|:---:| +| Зависимости | - | - | - | - | - | - | +| **Источники** | +|  CLI (argv) | - | - | - | - | - | - | +|  env | - | - | - | - | + | + | +|  Файлы | JSON | YAML | TOML | TOML | JSON, YAML, XML | JSON, JAXN | +| Стандарт C++ | ≥ C++11 | ≥ C++11 | ≥ C++17 | ≥ C++11 | ≥ C++20 | ≥ C++17 | +| **Поддерживает стандарт иерархии** | +|  Linux | + | + | + | + | + | + | +|  Windows | + | + | + | + | + | + | +|  MacOS | + | + | + | + | + | + | +| Способ распространения | header-only | статическая/динамическая¹ | header-only/статическая/динамическая¹ | header-only/статическая/динамическая¹ | header-only | header-only | | **ОС** | | | -|  Linux | + (GCC 4.8–14.2, Clang 3.4–21.0) | + (GCC, Clang) | + (Clang 8+, GCC 8+) | + (GCC, Clang) -|  Windows | + (MSVC 2015–2022) | + (MSVC) | + (MSVC VS2019+) | + (MSVC, MinGW) -|  macOS | + (AppleClang 9.1–16.0) | + (Xcode, AppleClang) | + (AppleClang) | + (AppleClang) +|  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+) | + | **Сообщество** | | | -|  Активность (коммитов/мес) | 2 | 9 | 2 | 4 -|  Issues всего | 3271 | 905 | 193 | 194 -|  Issues closed/open | 68 | 3 | 8 | 5 -|  Stars | 49.4k | 15k | 2k | 1.3k -| **Проходит ли CI** | + | + | + | - | + | +|  Активность (коммитов/мес) | 2 | 9 | 2 | 4 | 2 | 13 | +|  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 | +| Проходит ли CI | + | + | + | - | + | ? | > ¹ Опционально. @@ -102,13 +88,6 @@ |  Linux | + | |  Windows | + | |  MacOS | + | -| **Пакетные менеджеры** | | | -|  vcpkg | + | -|  Conan | + | -|  Conda | + | -|  apt | + | -|  brew | + | -|  pacman | + | | Способ распространения | статическая/динамическая² | | **ОС** | | | |  Linux | + (GCC 5+, Clang 3.6+) | @@ -119,7 +98,7 @@ |  Issues всего | 400 | |  Issues closed/open | 1 | |  Stars | 9.4k | -| **Проходит ли CI** | + | + | +| Проходит ли CI | + | + | > ¹ Список зависимостей: > 1. Boost.Any From e0c730b9044224d95e85fb3ac15fb9306fd8721f Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Mon, 11 May 2026 16:17:12 +0300 Subject: [PATCH 13/18] added SPLA usage scenarios --- src/opencl/Compare.md | 61 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 60 insertions(+), 1 deletion(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index f8bad3444..2850c0048 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -120,6 +120,61 @@ ## Итог: По результатам сравнения, вероятно, лучшим вариантом будет использование `CLI11` и `nlohmann/json`, так как они, в отличие от `Boost.program_options`, не требуют зависимостей и являются header-only. +# Сценарии использования spla: +**Что важно всем:** возможность выбрать платформу и устройство + +1. Пользователь хочет решить свою задачу + - Неподготовленный пользователь + - важно: + - быстрая настройка через флаги + - что конфигурировать: + - уменьшить количество отладочной информации + - остальное - дефолтные параметры + - Опытный пользователь: + - важно: + - детальная ручная конфигурация параметров через конфигурационный файл + - ускорение вычислений с разреженными данными + - что конфигурировать: + - управление кэшем + - кастомные аллокаторы для разных форматов данных + - управление очередями команд + - Wave size override + - Work-group size + - оптимизация доступа к глобальной памяти + - управление логированием +2. Разработчик spla + - Отладчик, тестировик + - важно: + - верификация корректности работы на разных устройствах + - воспроизводимость ошибок + - что конфигурировать: + - возможность работать только на 1 гпу + - подробное логирование + - отключение кэша для принудительной перекомпиляции + - тестирование на неподдерживаемых вендорах без падения с ошибкой + - Бенчмаркер + - важно: + - минимизация шума при измерениях + - воспроизводимость результатов + - сравнение разных конфигураций + - что конфигурировать: + - профайлинг очередей `CL_QUEUE_PROFILING_ENABLE` + - сбор статистики и уменьшение шума `CLCounterPool` + - количество очередей для измерения параллелизма + - линейный аллокатор для предсказуемости памяти + - Wave size override + - Work-group size + - оптимизация доступа к глобальной памяти + - Расширяющий функциональность + - важно: + - возможность встроить код в существующую инфраструктуру + - чтобы новый код работал на всех устройтсвах + - что конфигурировать: + - включение кэша + - кастомные аллокаторы для разных форматов данных + - управление очередями + - Wave size override + - Work-group size # Что нужно конфигурировать 1. Выбор платформы @@ -187,4 +242,8 @@ config: "amd": "linear" | "general" "intel": "linear" | "general" "img": "linear" | "general" -``` \ No newline at end of file + "queues": + "count": int + +``` + From b5b7580f35e745752840db73949b0da1fc20e93a Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Tue, 19 May 2026 04:47:04 +0300 Subject: [PATCH 14/18] making defolt scenario --- src/opencl/Compare.md | 103 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 102 insertions(+), 1 deletion(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index 2850c0048..4baf8f051 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -121,8 +121,109 @@ По результатам сравнения, вероятно, лучшим вариантом будет использование `CLI11` и `nlohmann/json`, так как они, в отличие от `Boost.program_options`, не требуют зависимостей и являются header-only. # Сценарии использования spla: -**Что важно всем:** возможность выбрать платформу и устройство +## Дефолтный сценарий + +Дефолтный сценарий должен решать главную задачу библиотеки: ускорение вычислений. + +### Выбор платформы и устройства + +Сначала следует выбрать наиболее подходящий девайс. Для этого необходимо пройти по всем платформам, собрать все устройства каждой платформы и среди них выбрать лучший. + +Выбранное устройство должно удовлетворять следующим критериям: +1. физически существовать у пользователя + +2. проходить базовые проверки: \ + - запрос размера глобальной памяти \ + - попытка выделить и освободить буфер + +Из всех рабочих и доступных устройств необходимо выбрать наиболее быстрое. Выбор осуществляется по следующей иерархии: + +1. Внешняя GPU (eGPU) + +2. Дискретная GPU (dGPU) + +3. Интегрированная GPU (iGPU) + +4. Запуск на CPU (при отсутствии GPU) + +При наличии нескольких GPU одного типа на каждом из них запускаются микробенчмарки с эталонной задачей, характерной для SPLA. В итоге выбирается GPU, показавшая лучшие результаты, и соответствующая ей платформа. + +Данный подход решает потенциальную проблему, когда девайс указан в OpenCL-платформе, но фактически отсутствует в системе. + +-- + +Нужно ли как-то учитывать параметры платформ? + +Логирование: Выдавать всю информацию (какие стандарты логирования? какая иерархия ошибок?) + +Бенчмарки: \ +Какую задачу прогонять? \ +Как вести замеры? \ +Подбор колтчества очередей: k = (t_вычислений)/ t_общ \ +если k = 0.5 => 1 очередь \ +если k >> 0.5 => ускорять передачу данных? \ +еслм k << 0. => ускорять вычисления? + +как подбирать оптимально \ +пользовательское количество потоков work group size \ +способ аллокации памяти и размер аллокатора +### Настройка очередей команд + +### Логирование + +### Тестовые бенчмарки + + +## Пользователь, который хочет решить свою задачу, используя spla: +### 1. Быстрая настройка основных параметров + +Параметры для конфигурирования: +1. явное указание платформы +2. явное указание устройтсва +3. выбрать количество очередей +4. уменьшить количество отладочной информации до минимума: оставить только критические ошибки +5. выбор аллокатора + +### 2. Замер и сравнение производительности вычислений на разных GPU +Цель пользователя: +1. Минимизация шума при измерениях +2. Воспроизводимость результатов +3. Сравнение разных конфигураций + +Параметры для конфигурирования: +1. явное указание платформы +2. явное указание устройтсва +3. выбрать количество очередей +4. **увеличить количество отладочной информации** +5. выбор аллокатора +6. Wave size override +7. Work-group size +8. профайлинг очередей `CL_QUEUE_PROFILING_ENABLE` +9. сбор статистики и уменьшение шума `CLCounterPool`** + +### 3. Отладка алгоритма GPU +Цель пользователя: +1. верификация корректности работы на разных устройствах +2. воспроизводимость ошибок + +Параметры для конфигурирования: + +### 4. Тестирование GPU +Параметры для конфигурации: + +### 5. Пользователь знает, что некоторые вычисления лучше считаются на GPU +Параметры для конфигурации: + +### 6. Задачи, требующие воспроизводимости +Параметры для конфигурации: + + + + +# Сценарии использования spla: +**Что важно всем:** возможность выбрать платформу и устройство +**Цель:** 1. Пользователь хочет решить свою задачу - Неподготовленный пользователь - важно: From af09acdead6c9dc83f2004bb8960ad2232dd74dd Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Tue, 19 May 2026 05:42:31 +0300 Subject: [PATCH 15/18] added 1 question about errors --- src/opencl/Compare.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index 4baf8f051..c9c63b8d3 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -168,6 +168,8 @@ пользовательское количество потоков work group size \ способ аллокации памяти и размер аллокатора +Иерархия ошибок? + ### Настройка очередей команд ### Логирование From 627b027af87e7f87f81dcf13dba0842230827f0c Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Mon, 1 Jun 2026 09:11:02 +0300 Subject: [PATCH 16/18] added new scenaries --- src/opencl/Compare.md | 187 +++++++++++++----------------------------- 1 file changed, 55 insertions(+), 132 deletions(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index c9c63b8d3..acf2feed9 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -121,165 +121,88 @@ По результатам сравнения, вероятно, лучшим вариантом будет использование `CLI11` и `nlohmann/json`, так как они, в отличие от `Boost.program_options`, не требуют зависимостей и являются header-only. # Сценарии использования spla: -## Дефолтный сценарий - -Дефолтный сценарий должен решать главную задачу библиотеки: ускорение вычислений. - -### Выбор платформы и устройства - -Сначала следует выбрать наиболее подходящий девайс. Для этого необходимо пройти по всем платформам, собрать все устройства каждой платформы и среди них выбрать лучший. - -Выбранное устройство должно удовлетворять следующим критериям: -1. физически существовать у пользователя - -2. проходить базовые проверки: \ - - запрос размера глобальной памяти \ - - попытка выделить и освободить буфер - -Из всех рабочих и доступных устройств необходимо выбрать наиболее быстрое. Выбор осуществляется по следующей иерархии: - -1. Внешняя GPU (eGPU) - -2. Дискретная GPU (dGPU) - -3. Интегрированная GPU (iGPU) - -4. Запуск на CPU (при отсутствии GPU) - -При наличии нескольких GPU одного типа на каждом из них запускаются микробенчмарки с эталонной задачей, характерной для SPLA. В итоге выбирается GPU, показавшая лучшие результаты, и соответствующая ей платформа. - -Данный подход решает потенциальную проблему, когда девайс указан в OpenCL-платформе, но фактически отсутствует в системе. - --- - -Нужно ли как-то учитывать параметры платформ? - -Логирование: Выдавать всю информацию (какие стандарты логирования? какая иерархия ошибок?) - -Бенчмарки: \ -Какую задачу прогонять? \ -Как вести замеры? \ -Подбор колтчества очередей: k = (t_вычислений)/ t_общ \ -если k = 0.5 => 1 очередь \ -если k >> 0.5 => ускорять передачу данных? \ -еслм k << 0. => ускорять вычисления? - -как подбирать оптимально \ -пользовательское количество потоков work group size \ -способ аллокации памяти и размер аллокатора - -Иерархия ошибок? - -### Настройка очередей команд - -### Логирование - -### Тестовые бенчмарки - +Библиотека SPLA требует явного конфигурирования. \ +При установке поставляется дефолтный конфиг. Для запуска программы пользователь должен передать библиотеке путь к конфигу (дефолтному или своему) и опционально — идентификатор конфигурации. Если идентификатор не указан, используется конфигурация default. Без конфига библиотека не запускается. ## Пользователь, который хочет решить свою задачу, используя spla: ### 1. Быстрая настройка основных параметров Параметры для конфигурирования: -1. явное указание платформы -2. явное указание устройтсва -3. выбрать количество очередей +1. явное указание платформы `SPLA_OPENCL_PLATFORM` +2. явное указание устройтсва `SPLA_OPENCL_DEVICE` +3. выбрать количество очередей `queues_count` 4. уменьшить количество отладочной информации до минимума: оставить только критические ошибки -5. выбор аллокатора ### 2. Замер и сравнение производительности вычислений на разных GPU -Цель пользователя: -1. Минимизация шума при измерениях -2. Воспроизводимость результатов -3. Сравнение разных конфигураций +Цель пользователя: Сравнение производительности разных девайсов Параметры для конфигурирования: 1. явное указание платформы 2. явное указание устройтсва 3. выбрать количество очередей -4. **увеличить количество отладочной информации** -5. выбор аллокатора -6. Wave size override -7. Work-group size +4. увеличить количество отладочной информации +5. выбор аллокатора `allocator_type` +6. размер для линейного аллокатора `linear_allocator_size` или `block_size` и `block_count` для pool аллокатора +6. `default_wgs` +7. `wave_size` 8. профайлинг очередей `CL_QUEUE_PROFILING_ENABLE` -9. сбор статистики и уменьшение шума `CLCounterPool`** +9. сбор статистики ### 3. Отладка алгоритма GPU Цель пользователя: 1. верификация корректности работы на разных устройствах -2. воспроизводимость ошибок +2. поиск ошибок в алгоритме Параметры для конфигурирования: +1. явное указание платформы +2. явное указание устройтсва +3. выбрать количество очередей +4. увеличить количество отладочной информации +5. очищать кэш при запуске +6. отключение оптимизации при компиляции + ### 4. Тестирование GPU -Параметры для конфигурации: +Цель пользователя: +1. верификация корректности работы устройства +2. поиск ошибок в устройтсве -### 5. Пользователь знает, что некоторые вычисления лучше считаются на GPU Параметры для конфигурации: +1. явное указание платформы +2. явное указание устройтсва +3. выбрать количество очередей +4. увеличить количество отладочной информации -### 6. Задачи, требующие воспроизводимости -Параметры для конфигурации: - +## Разработчик spla: -# Сценарии использования spla: -**Что важно всем:** возможность выбрать платформу и устройство -**Цель:** -1. Пользователь хочет решить свою задачу - - Неподготовленный пользователь - - важно: - - быстрая настройка через флаги - - что конфигурировать: - - уменьшить количество отладочной информации - - остальное - дефолтные параметры - - Опытный пользователь: - - важно: - - детальная ручная конфигурация параметров через конфигурационный файл - - ускорение вычислений с разреженными данными - - что конфигурировать: - - управление кэшем - - кастомные аллокаторы для разных форматов данных - - управление очередями команд - - Wave size override - - Work-group size - - оптимизация доступа к глобальной памяти - - управление логированием -2. Разработчик spla - - Отладчик, тестировик - - важно: - - верификация корректности работы на разных устройствах - - воспроизводимость ошибок - - что конфигурировать: - - возможность работать только на 1 гпу - - подробное логирование - - отключение кэша для принудительной перекомпиляции - - тестирование на неподдерживаемых вендорах без падения с ошибкой - - Бенчмаркер - - важно: - - минимизация шума при измерениях - - воспроизводимость результатов - - сравнение разных конфигураций - - что конфигурировать: - - профайлинг очередей `CL_QUEUE_PROFILING_ENABLE` - - сбор статистики и уменьшение шума `CLCounterPool` - - количество очередей для измерения параллелизма - - линейный аллокатор для предсказуемости памяти - - Wave size override - - Work-group size - - оптимизация доступа к глобальной памяти - - Расширяющий функциональность - - важно: - - возможность встроить код в существующую инфраструктуру - - чтобы новый код работал на всех устройтсвах - - что конфигурировать: - - включение кэша - - кастомные аллокаторы для разных форматов данных - - управление очередями - - Wave size override - - Work-group size - -# Что нужно конфигурировать +### 1. Бенчмаркер + +Цели и параметры конфигурирования аналогичны [сценарию 2](#2-замер-и-сравнение-производительности-вычислений-на-разных-gpu) + + +### 2. Отладчик, тестировик + +Цели и параметры конфигурирования аналогичны [сценарию 3](#3-отладка-алгоритма-gpu) + + + +## Основные дефолтные значения + +платформа: первая платформа \ +девайс: первое устройство \ +queues_count = 1 \ +отладочная информация: критичнеские ошибки \ +аллокатор: general \ +default_wgs: 1\ +wave_size: 1\ +профайлинг: false +сбор статистики: false +очищать кэш при запуске: false +отключение оптимизации при компиляции: false + + # Структура конфига (JSON) From c1b7f2d7be1eec461b5c0de57d7574758a038590 Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Thu, 9 Jul 2026 23:04:18 +0500 Subject: [PATCH 17/18] added manual --- src/opencl/Compare.md | 395 ++++++++++++++++++++++++++---------------- 1 file changed, 246 insertions(+), 149 deletions(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index acf2feed9..1d51c5016 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -120,156 +120,253 @@ ## Итог: По результатам сравнения, вероятно, лучшим вариантом будет использование `CLI11` и `nlohmann/json`, так как они, в отличие от `Boost.program_options`, не требуют зависимостей и являются header-only. -# Сценарии использования spla: -Библиотека SPLA требует явного конфигурирования. \ -При установке поставляется дефолтный конфиг. Для запуска программы пользователь должен передать библиотеке путь к конфигу (дефолтному или своему) и опционально — идентификатор конфигурации. Если идентификатор не указан, используется конфигурация default. Без конфига библиотека не запускается. - -## Пользователь, который хочет решить свою задачу, используя spla: -### 1. Быстрая настройка основных параметров - -Параметры для конфигурирования: -1. явное указание платформы `SPLA_OPENCL_PLATFORM` -2. явное указание устройтсва `SPLA_OPENCL_DEVICE` -3. выбрать количество очередей `queues_count` -4. уменьшить количество отладочной информации до минимума: оставить только критические ошибки - -### 2. Замер и сравнение производительности вычислений на разных GPU -Цель пользователя: Сравнение производительности разных девайсов - -Параметры для конфигурирования: -1. явное указание платформы -2. явное указание устройтсва -3. выбрать количество очередей -4. увеличить количество отладочной информации -5. выбор аллокатора `allocator_type` -6. размер для линейного аллокатора `linear_allocator_size` или `block_size` и `block_count` для pool аллокатора -6. `default_wgs` -7. `wave_size` -8. профайлинг очередей `CL_QUEUE_PROFILING_ENABLE` -9. сбор статистики - -### 3. Отладка алгоритма GPU -Цель пользователя: -1. верификация корректности работы на разных устройствах -2. поиск ошибок в алгоритме - -Параметры для конфигурирования: -1. явное указание платформы -2. явное указание устройтсва -3. выбрать количество очередей -4. увеличить количество отладочной информации -5. очищать кэш при запуске -6. отключение оптимизации при компиляции - - -### 4. Тестирование GPU -Цель пользователя: -1. верификация корректности работы устройства -2. поиск ошибок в устройтсве - -Параметры для конфигурации: -1. явное указание платформы -2. явное указание устройтсва -3. выбрать количество очередей -4. увеличить количество отладочной информации - - - -## Разработчик spla: - -### 1. Бенчмаркер - -Цели и параметры конфигурирования аналогичны [сценарию 2](#2-замер-и-сравнение-производительности-вычислений-на-разных-gpu) - - -### 2. Отладчик, тестировик - -Цели и параметры конфигурирования аналогичны [сценарию 3](#3-отладка-алгоритма-gpu) - - - -## Основные дефолтные значения - -платформа: первая платформа \ -девайс: первое устройство \ -queues_count = 1 \ -отладочная информация: критичнеские ошибки \ -аллокатор: general \ -default_wgs: 1\ -wave_size: 1\ -профайлинг: false -сбор статистики: false -очищать кэш при запуске: false -отключение оптимизации при компиляции: false - - - -# Структура конфига (JSON) + +# Механизм конфигурирования библиотеки SPLA + +## МАНУАЛ: + +## НАЗВАНИЕ +spla - это фреймворк для математических вычислений с использованием GPU/ускорения + +## СИНОПСИС + +```cpp +#include + + +int main(int argc, char* argv[]) { + + spla_configure(argc, argv); + + return 0; +} +``` +Функция `spla_configure(argc, argv)` необходима для обработки аргументов командной строки, переменных окружения и конфигурационных файлов. + +(будет написана) + +## ОПИСАНИЕ +**spla** - это библиотека с открытым исходным кодом, предоставляющая примитивы разреженной линейной алгебры (матрицы, векторы, скаляры) для математических вычислений с ускорением на GPU. Библиотека поддерживает широкий спектр операций, включая умножение матрицы на вектор, решение систем линейных уравнений и другие алгоритмы разреженной алгебры. + +Для большинства пользователей важно, на каком ускорителе будет запускаться их проект, поэтому необходима возможность явного указания графического ускорителя, OpenCL платформы, количества очередей команд и других параметров, влияющих на производительность и удобство пользователя. + +Библиотека предоставляет механизмы конфигурирования, показанные в порядке убывания приоритета. + +1. Аргументы командной строки 1. +2. Переменные окружения 2. +3. Пользовательский конфигурационный TOML/INI файл 3. +4. Системный конфигурационный TOML/INI файл 3. + +Системный конфигурационный файл имеет наименьший приоритет. \ +Его настройки переопределяются пользовательским конфигурационным файлом, переменными окружения и аргументами командной строки. + +Пользовательский конфигурационный файл имеет приоритет над системным +конфигурационным файлом. \ +Его настройки переопределяются переменными +окружения и аргументами командной строки. + +Переменные окружения имеют приоритет над системным и пользовательским конфигурационными файлами, но уступают аргументам командной строки. + +Аргументы командной строки имеют наивысший приоритет и переопределяют любые настройки, определенные предыдущими способами. + +Если источника конфигурации с меньшим приоритетом не существует, библиотека игнорирует его и переходит к следующему источнику конфигурации. + +Библиотека требует настройки всех обязательных параметров. Без этого будет генерироваться исключение `IncompleteConfigError`.\ +Чтобы исключение не возникало, пользователь должен явно настроить все параметры любым [способом](#configuration_methods). + +> 1 Описание аргументов командной строки приведены в разделе [ПАРАМЕТРЫ КОМАНДНОЙ СТРОКИ](#options). \ +2 Описание переменнных окружения приведены в разделе [ПЕРЕМЕННЫЕ ОКРУЖЕНИЯ](#env_variables). \ +3 Шаблон конфигурационного файла с описанием приведен [здесь](#config). + +## ПАРАМЕТРЫ КОМАНДНОЙ СТРОКИ +```bash +-sh +--spla-help +``` +Выводит список всех доступных флагов spla с кратким описанием. + +```bash +-sv +--spla-version +``` +Показывает номер версии spla. + +```bash +-ss <путь> +--spla-sconf <путь> +``` +Путь к системному конфигурационному файлу. + +По умолчанию ищет файл в стандартном для данной ОС месте.\ +`/etc/spla/spla.toml` на Linux. \ +`/Library/Preferences/spla/spla.toml` на macOS. \ +`%ProgramData%\spla\spla.toml` на Windows. + +```bash +-su <путь> +--spla-uconf <путь> +``` +Путь к пользовательскому конфигурационному файлу. + +По умолчанию ищет файл в стандартном для данной ОС месте. \ +`~/.config/spla/spla.toml` на Linux. \ +`~/Library/Application Support/spla/spla.toml` на macOS. \ +`%APPDATA%\spla\spla.toml` на Windows. ```bash -config: - - "platform": - "selection": - "user_alias": string - "official_name": string - "vendor": "nvidia" | "amd" | "intel" | "img" | "" - "index": int - "priority": int - "fallback": (???) # Нужен ли fallback - "device": - "selection": - "user_alias": string - "official_name": string - "type": "gpu" | "cpu" - "index": int - "priority": int - "naming": - "accelerator_name" # m_name - "cache_suffix" # m_suffix - "tuning": - "default_work_group_size": int # m_default_wgs - "wave_size": int # m_wave_size - "memory_banks": int # m_num_of_mem_banks - "memory_alignment": int # m_addr_align - "fallback": (???) # Нужен ли fallback - "performance" - "memory" - "linear_allocator_size_mb": int # DEFAULT_SIZE - "allocator_strategy": "auto" | "linear" | "general" | "vendor" - "vendor_strategy": - "nvidia": "linear" | "general" - "amd": "linear" | "general" - "intel": "linear" | "general" - "img": "linear" | "general" - "queues": - "count": int - +-sp <индекс> +--spla-platform <индекс> +``` +Индекс OpenCL платформы. + +```bash +-sd <индекс> +--spla-device <индекс> +``` +Индекс OpenCL-устройства выбранной платформы (GPU/CPU). + +```bash +-sq <число> +--spla-queues <число> +``` +Количество очередей команд. + +Увеличение числа очередей может повысить производительность +за счет параллельного выполнения независимых задач, но слишком большое значение может снизить производительность из-за накладных расходов. \ +Рекомендуется начинать с 1 и экспериментально подбирать оптимальное значение. + +```bash +-sV <уровень> +--spla-verbosity <уровень> +``` +Уровень детализации отладочной информации, выводимой библиотекой. + +| Уровень | Значение | Описание | +|:-------:|:---------|:---------| +| **0** | OFF | Вывод отключён. Сообщения не выводятся. | +| **1** | ERROR | Только критические ошибки. | +| **2** | WARNING | Ошибки и предупреждения. | +| **3** | INFO | Основные этапы работы библиотеки. | + +Что выводится на каждом уровне: + +1. ERROR — `Error`, `NoAcceleration`, `PlatformNotFound`, `DeviceNotFound`, `InvalidState`, `InvalidArgument`, `CompilationError` + +2. WARNING — добавляет к ERROR: `NoValue`, `NotImplemented` + +3. INFO — добавляет к WARNING: `Ok` - информация об инициализации, выборе платформы/устройства, загрузке конфигурации + +```bash +-sp +--spla-profiling +``` +Профилирование очередей команд OpenCL. + +Bключение профилирования добавляет накладные расходы на каждую +операцию и может замедлить выполнение. + +```bash +-sa <тип> +--spla-allocator <тип> +``` +Тип аллокатора памяти для OpenCL-устройства. \ +Ожидает: lineral | general. + +Выбор аллокатора влияет на производительность операций с памятью. +Линейный аллокатор даёт прирост скорости за счёт последовательного выделения, +но может привести к фрагментации памяти при длительной работе. +Общий аллокатор более надёжен, но медленнее. + +```bash +-sS <размер> +--spla-allocator-size <размер> +``` +Размер линейного аллокатора в байтах. + +Увеличение размера позволяет выделять больше памяти за один раз, но увеличивает потребление ресурсов. \ +Этот параметр необходим только при использовании линейного аллокатора `--spla-allocator linear`. +При использовании общего аллокатора можно не указывать. + +Пример: +```bash +./my_program --spla-uconf ~/my_configs/spla.toml --spla-platform 1 -sd 0 --spla-verbosity 3 -sp true --spla-allocator linear --spla-allocator-size 1048576 +``` + +## ПЕРЕМЕННЫЕ ОКРУЖЕНИЯ +Для всех параметров командной строки (кроме --spla-help, --spla-version) существуют аналоги в виде переменных окружения. + +`SPLA_SYSTEM_CONFIG_PATH` \ +Путь к системному конфигурационному файлу. Аналог параметра --spla-sconf. + +`SPLA_USER_CONFIG_PATH` \ +Путь к пользовательскому конфигурационному файлу. Аналог параметра --spla-uconf. + +`SPLA_OPENCL_PLATFORM` \ +Индекс OpenCL платформы. Аналог параметра --spla-platform. + +`SPLA_OPENCL_DEVICE`\ +Индекс OpenCL-устройства на выбранной платформе. +Аналог параметра --spla-device. + +`SPLA_QUEUES`\ +Количество очередей команд OpenCL. +Аналог параметра --spla-queues. + +`SPLA_VERBOSITY`\ +Уровень детализации отладочной информации. +Аналог параметра --spla-verbosity.\ +Принимает значения от 0 до 3. + +`SPLA_PROFILING`\ +Включает профилирование очередей команд OpenCL. +Аналог параметра --spla-profiling. + +`SPLA_ALLOCATOR`\ +Тип аллокатора памяти для OpenCL-устройства. +Аналог параметра --spla-allocator.\ +Принимает значения: linear, general. + +`SPLA_ALLOCATOR_SIZE`\ +Размер линейного аллокатора в байтах. +Аналог параметра --spla-allocator-size.\ +Имеет смысл только при использовании линейного аллокатора. + + +## КОНФИГУРАЦИОННЫЕ ФАЙЛЫ +Для всех аргументов командной строки (кроме --spla-help, --spla-version, --spla-sconf, --spla-uconf) и всех переменных окружения существуют аналоги в виде параметров конфигурационного файла. + +Формат файла - TOML или INI. + +Типы значений. +1. platform = int +2. device = int +3. queues = int +4. verbosity = int +5. profiling = true | false +6. allocator = linear | general +7. allocator_size = int + +Примеры конфигурационных файлов.\ +Этот формат справедлив как для пользовательского, так и для системного конфигурационного файла. + +Формат INI. +```toml +platform = 1 +device = 0 +queues = 4 +verbosity = 2 +profiling = false +allocator = "linear" +allocator_size = 1048576 ``` +Формата ini. +```ini +platform = 1 +device = 0 +queues = 4 +verbosity = 2 +profiling = true +allocator = linear +allocator_size = 1048576 +``` \ No newline at end of file From 8c9ddff705025c412311a609cdd051ba01a2c542 Mon Sep 17 00:00:00 2001 From: Gitubrr Date: Fri, 10 Jul 2026 11:07:51 +0500 Subject: [PATCH 18/18] Fixed the incorrect format name in 1 example in CONFIGURATION FALE section (INI -> TOML) --- src/opencl/Compare.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/opencl/Compare.md b/src/opencl/Compare.md index 1d51c5016..6df361e57 100644 --- a/src/opencl/Compare.md +++ b/src/opencl/Compare.md @@ -349,7 +349,7 @@ Bключение профилирования добавляет накладн Примеры конфигурационных файлов.\ Этот формат справедлив как для пользовательского, так и для системного конфигурационного файла. -Формат INI. +Формат TOML. ```toml platform = 1 device = 0 @@ -360,7 +360,7 @@ allocator = "linear" allocator_size = 1048576 ``` -Формата ini. +Формата INI. ```ini platform = 1 device = 0