ВСё ещё дневник =)

ccpp/fxalloc/includes/FXAlloc.h

@@ -2,29 +2,43 @@
 /**
  * @file neurox/ccpp/fxalloc/includes/FXAlloc.h
  * @author felex67 (admin@felexdev.ru)
- * @version 1.0.0 beta 
+ * @version 1.0.0 dev-in-progress
  * @brief Публичный интерфейс модуля-аллокатора fxalloc(includes/FXAlloc.h)
  * 
  * @details Language: C11 (ISO/IEC 9899:2011).
- * Теоритический маскимальный размер блока `(1 << 32) - 25 = 4 294 967 271 байт`
- * Первый вызов `fxalloc()`(без предварительного вызова `fxalloc_init()`) в потоке/процессе крайне медленный
- * так как происходит инициализация пула, последующие вызовы будут работать с инициализированным
- * пулом памяти.
+ * Теоретический маскимальный размер блока `(1 << 32) - 25 = 4 294 967 271 байт`
+ * 
+ * При первом вызове `fxalloc()` до `fxalloc_init()` в глобальной облачти будет
+ * проинициализирован пул с градациями 
+ * 
+ * Первый вызов `fxalloc()`(без предварительного вызова `fxalloc_init()`) в
+ * потоке/процессе крайне медленный так как происходит инициализация пула,
+ * последующие вызовы будут работать с инициализированным пулом памяти.
+ * 
  * Изначально аллокатор работает в следующем режиме:
- * `fxalloc → выделение блока через malloc() с добавлением метаданных`,
- * `fxfree → анализ метаданных с последующим вызовом free()`. Такое поведение
- * помогает сборать статистику для профилирования, которые могут быть получены
- * переводом аллокатора в режим анализа(выполняется потоком-наблюдателем).
+ *     `fxalloc` → выделение блока через `malloc()` с добавлением метаданных,
+ *     `fxfree` → анализ метаданных с последующим вызовом `free()`.
+ * Такое поведение помогает сборать статистику для профилирования, которые могут
+ * быть получены переводом аллокатора в режим анализа(выполняется потоком-наблюдателем).
+ * 
  * При необходимости выделения отдельного пула для потока используйте `fxalloc_init()`,
  * в глобальном пуле(НЕ TLS!!!) будет выделен блок памяти для этого потока, что даст возможность
  * передачи данных по очередям между потоками без повторных выделений, функция `fxfree()`
  * из любого другого потока вернёт блок владельцу без накладных расходов на TLS, только
  * атомарная синхронизация.\
- * Изменение указателей `fxalloc` и `fxfree` строго запрещено!\
+ * 
+ * Изменение указателей `fxalloc` и `fxfree` строго запрещено!!!\
+ * 
  * Без оперделения макроса `_I_UNDERSTAND_THAT_I_SHOULD_NEVER_CHANGE_THESE_POINTERS_` модуль
- * не скомпилируется, возникнет ошибка компиляции, определение макроса = подписание конракта.\
+ * будет работать в режиме "кукурузник", для перехода в режим "3-я космическая", определение
+ * макроса = подписание контракта о невмешательстве в указатели `void* (*fxalloc)(size_t)` и
+ * `void (*fxfree)(void* Ptr)`.\
+ * 
  * По завершению работы потока/процесса в системах POSIX вся выделенная память
  * освобождается автоматически, в Windows необходимо вызвать `fxalloc_cleanup()`.
+ * 
+ * Подробное описание процесса разработки интерфейса и аллокатора вцелом можно найти в файле:
+ * `neurox/ccpp/fxalloc/DIARY.md`
  * */
 #include <stdint.h>
 
@@ -46,9 +60,27 @@ extern "C" {
     typedef enum eFXAllocProfile {
         FXALLOC_SPEED,      ///< Максимальная производительность без статистики
         FXALLOC_SUMMARY,    ///< Поверхностная статистика
-        FXALLOC_FULL        ///< Глубокий анализ расхода памяти
+        FXALLOC_FULL,       ///< Глубокий анализ расхода памяти
+        FXALLOC_GETPROFILE, ///< Используется для получения текущего профиля
     }  eFXAllocProfile;
 
+    /**
+     * @brief Задаёт шаг градаций по-умолчанию используемый в изначальной версии
+     * `fxalloc()`. Градации будут заполнены для блоков с шагом в
+     * `1 << FXALLOC_DEFAULT_GRADE_STEP_SHIFT` до размера 65 535 байт(~1024 грейда),
+     * все блоки будут сохраняться в LIFO каждого грейда до конца работы потока.
+     * Такой режим предусмотрен для профилирования.
+     * @details Если установить данный параметр  0 будет недоступен режим полного
+     * профилирования, статистика будет содержать только `malloced = N times`,
+     * `average_size = N bytes`, `min = N bytes` и `max = N bytes`.
+     * В случае по-умолчанию можно будет получить более подробную информацию по
+     * каждому грейду и использованию памяти в нём. Не рекомендуется снижать параметр,
+     * т.к. это напрямую повлияет на размер метаданных пула.
+     */
+    typedef enum eDefaultGradeStep {
+        FXALLOC_DEFAULT_GRADE_STEP_SHIFT = 6 ///< left bit shifts (1 << 6) = 64
+    } eDefaultGradeStep;
+
     /**
      * @brief Структура преднастройки аллокатора задающая градации и количество блоков памяти.
      * Массив должен быть отсортирован по возрастанию размера блока