Доработка архитектуры
This commit is contained in:
+60
-23
@@ -1,6 +1,6 @@
|
||||
#pragma once
|
||||
/**
|
||||
* @file neurox/ccpp/fxalloc/includes/FXAlloc.h
|
||||
* @file fxalloc/includes/FXAlloc.h
|
||||
* @author felex67 (admin@felexdev.ru)
|
||||
* @version 1.0.0 dev-in-progress
|
||||
*
|
||||
@@ -31,10 +31,16 @@
|
||||
*
|
||||
* Изменение указателей `fxalloc` и `fxfree` строго запрещено!!!\
|
||||
*
|
||||
* Без оперделения макроса `_I_UNDERSTAND_THAT_I_SHOULD_NEVER_CHANGE_THESE_POINTERS_` модуль
|
||||
* будет работать в режиме "кукурузник", для перехода в режим "3-я космическая", определение
|
||||
* макроса = подписание контракта о невмешательстве в указатели `void* (*fxalloc)(size_t)` и
|
||||
* `void (*fxfree)(void* Ptr)`.\
|
||||
* Зачем нужен макрос `_I_UNDERSTAND_THAT_I_SHOULD_NEVER_CHANGE_THESE_POINTERS_`:
|
||||
* В случае когда макрос определён модульне может изменять `(*fxalloc)()/(*fxfree)()` напрямую
|
||||
* и вынужден работать через прокси-функцию, что добавляет +-25 такстов к каждому вызову
|
||||
* пользователем `(*fxaloc)()/(*fxfree)()`, т.к. оба указывают на прокси-функции. При
|
||||
* рпределении макроса необходимость в проксировании отсутствует, т.к. модуль может менять
|
||||
* `(*fxaloc)()/(*fxfree)()` напрямую. Однако даже при определении макроса пользователь никогда
|
||||
* ни в коем случае не должен изменять эти указатели!!!
|
||||
* Определение макроса `_I_UNDERSTAND_THAT_I_SHOULD_NEVER_CHANGE_THESE_POINTERS_` равно
|
||||
* подписанию контракта. Если в дальнейшем код пользователя изменит любой из этих указателей
|
||||
* вся вина лежит исключительно на нём!
|
||||
*
|
||||
* По завершению работы потока/процесса в системах POSIX вся выделенная память
|
||||
* освобождается автоматически, в Windows необходимо вызвать `fxalloc_cleanup()`.
|
||||
@@ -42,23 +48,31 @@
|
||||
* Подробное описание процесса разработки интерфейса и аллокатора вцелом можно найти в файле:
|
||||
* `neurox/ccpp/fxalloc/DIARY.md`
|
||||
* */
|
||||
#include <stdint.h>
|
||||
|
||||
#ifdef _WIN32
|
||||
// Windows
|
||||
#include <windows.h>
|
||||
#define thread_local __declspec(thread)
|
||||
#else
|
||||
// Linux
|
||||
#include <pthread.h>
|
||||
#define thread_local __thread
|
||||
#endif //_WIN32
|
||||
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif //__cplusplus
|
||||
#include <stdint.h>
|
||||
|
||||
#if (defined(__GNUC__) && (__GNUC__ >= 5)) || defined(__clang__)
|
||||
#include <stdatomic.h>
|
||||
#include <pthread.h>
|
||||
#define TLS __thread
|
||||
typedef pthread_mutex_t fxsync_t;
|
||||
typedef pthread_t thread_id_t;
|
||||
#elif defined(_MSC_VER) && _MSC_VER >= 1930
|
||||
#include <stdatomic.h>
|
||||
#include <windows.h>
|
||||
#define TLS __declspec(thread)
|
||||
typedef HANDLE fxsync_t;
|
||||
typedef HANDLE thread_id_t;
|
||||
#else
|
||||
#error "Unsupported compiler. Only Clang, GCC >=5.0 and MSVC VS 2022+ support _Atomic in C11"
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Перечисление режимов работы аллокатора
|
||||
*/
|
||||
@@ -75,6 +89,9 @@ extern "C" {
|
||||
* `1 << FXALLOC_DEFAULT_GRADE_STEP_SHIFT` до размера 65 535 байт(~1024 грейда),
|
||||
* все блоки будут сохраняться в LIFO каждого грейда до конца работы потока.
|
||||
* Такой режим предусмотрен для профилирования.
|
||||
* @note Изменение шага напрямую влияет на количество грейдов и размер метаданных
|
||||
* при увеличении на 1(7): шаг грейда - 128 байт, размер пула - 512 грейдов и т.д.
|
||||
* при уменьшении на 1(5): шаг грейда - 32 байта, размер пула - 2048 грейдов и т.д.
|
||||
* @details Если установить данный параметр 0 будет недоступен режим полного
|
||||
* профилирования, статистика будет содержать только `malloced = N times`,
|
||||
* `average_size = N bytes`, `min = N bytes` и `max = N bytes`.
|
||||
@@ -82,9 +99,28 @@ extern "C" {
|
||||
* каждому грейду и использованию памяти в нём. Не рекомендуется снижать параметр,
|
||||
* т.к. это напрямую повлияет на размер метаданных пула.
|
||||
*/
|
||||
typedef enum eDefaultGradeStep {
|
||||
FXALLOC_DEFAULT_GRADE_STEP_SHIFT = 6 ///< left bit shifts (1 << 6) = 64
|
||||
} eDefaultGradeStep;
|
||||
typedef enum eFXAllocConfig {
|
||||
FXALLOC_GRADE_STEP_SHIFT = 6,///< left bit shifts (1 << 6) = 64 - hf
|
||||
FXALLOC_LIFO_HEAD_ALIGN = 64,///< Задаёт выравнивание LIFO по L1 cache
|
||||
} eFXAllocConfig;
|
||||
/**
|
||||
* @brief Варианты настройки алгоритма поиска грейдов для данного потока
|
||||
* В случае если первой в потоке вызывается функция `fxalloc` режим автоматически
|
||||
* устанавливается в сдвиговый, т.к. Инициализируется пул согласно
|
||||
* `FXALLOC_GRADE_STEP_SHIFT` в своём алгоритме функции сдвигового поиска опираются
|
||||
* именно на это значение.
|
||||
* В противном случае(первый вызов - `fxalloc_init`) вы можете сами задать тип поиска.
|
||||
* Рекомендации под задачу:
|
||||
* * Высокая вариативность - оставить градации по умолчанию откалибровав `FXALLOC_GRADE_STEP_SHIFT`
|
||||
* * Низкая вариативность(очереди) - линейный поиск
|
||||
* * Средняя вариативность(запросы и т.д.) - бираный поиск
|
||||
*/
|
||||
typedef enum eXFAllocSearchType {
|
||||
FXSEARCH_AUTO, ///< Выберется Бинарный/линейный в зависимости от длины массива градаций(>= 7)
|
||||
FXSEARCH_LINEAR, ///< Линейный поиск
|
||||
FXSEARCH_BINARY, ///< Бинарный поиск
|
||||
FXSEARCH_SHIFTED, ///< Поиск сдвигом вправо(`idx = (NBytes - 1) >> FXALLOC_GRADE_STEP_SHIFT;`)
|
||||
} eXFAllocSearchType;
|
||||
|
||||
/**
|
||||
* @brief Структура преднастройки аллокатора задающая градации и количество блоков памяти.
|
||||
@@ -112,10 +148,11 @@ extern "C" {
|
||||
* @brief Инициализирует локальный пулл памяти исходя из заданных параметров блоков
|
||||
* @param[in] Grades: const FXGrade* - Указатель на массив градаций
|
||||
* @param[in] ThreadName: const char* - Наименование потока, используется при профилировании
|
||||
* @param[in] SearchType: eXFAllocSearchType - Тип поиска по градациям
|
||||
* в следующем виде: `[thread_id] 'thread_name': blocks: total=1024 used=64...`.
|
||||
* Если передан `NULL` - выводится только ID потока, т.е.: `[thread_id]: ...`
|
||||
*/
|
||||
int fxalloc_init(const FXGrade* Grades, const char* ThreadName);
|
||||
int fxalloc_init(const FXGrade* Grades, const char* ThreadName, eXFAllocSearchType SearchType);
|
||||
|
||||
#ifndef _I_UNDERSTAND_THAT_I_SHOULD_NEVER_CHANGE_THESE_POINTERS_
|
||||
/**
|
||||
@@ -126,7 +163,7 @@ extern "C" {
|
||||
* @retval `NULL` - В случае единственно возможной ошибки `ENOMEM` результат сохранён в `errno`
|
||||
* подробное описание `strerror(errno)`
|
||||
*/
|
||||
extern thread_local void (*const fxalloc)(size_t NBytes);
|
||||
extern TLS void (*const fxalloc)(size_t NBytes);
|
||||
#else
|
||||
/**
|
||||
* @brief Указатель на функцию выделения памяти
|
||||
@@ -135,7 +172,7 @@ extern "C" {
|
||||
* @retval !0 - Кратный размеру(sizeof(size_t)) указатель выровненный для любого типа данных
|
||||
* @retval NULL - В случае единственно возможной ошибки ENOMEM результат сохранён в errno
|
||||
*/
|
||||
extern thread_local void (*fxalloc)(size_t NBytes);
|
||||
extern TLS void (*fxalloc)(size_t NBytes);
|
||||
#endif
|
||||
|
||||
#ifndef _I_UNDERSTAND_THAT_I_SHOULD_NEVER_CHANGE_THESE_POINTERS_
|
||||
@@ -145,7 +182,7 @@ extern "C" {
|
||||
* @note Ни в коем разе не должен изменяться из вызывающего кода!!!
|
||||
* @param[in] Ptr: void* - Указатель на блок памяти
|
||||
*/
|
||||
extern thread_local void (*const fxfree)(void* Ptr);
|
||||
extern TLS void (*const fxfree)(void* Ptr);
|
||||
#else
|
||||
/**
|
||||
* @brief Указатель на функцию высвобождения памяти выделенной исключительно fxalloc
|
||||
@@ -153,7 +190,7 @@ extern "C" {
|
||||
* @note Ни в коем разе не должен изменяться из вызывающего кода!!!
|
||||
* @param[in] Ptr: void* - Указатель на блок памяти
|
||||
*/
|
||||
extern thread_local void (*fxfree)(void* Ptr);
|
||||
extern TLS void (*fxfree)(void* Ptr);
|
||||
#endif
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user