tomoaki/hakmem
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: Update ENV variable documentation after Ultra HEAP deletion

Browse Source 
Updated documentation to reflect commit 6b791b97d deletions:

Removed ENV variables (6):
- HAKMEM_TINY_ULTRA_FRONT
- HAKMEM_TINY_ULTRA_L0
- HAKMEM_TINY_ULTRA_HEAP_DUMP
- HAKMEM_TINY_ULTRA_PAGE_DUMP
- HAKMEM_TINY_BG_REMOTE (no getenv, dead code)
- HAKMEM_TINY_BG_REMOTE_BATCH (no getenv, dead code)

Files updated (5):
- docs/analysis/ENV_CLEANUP_ANALYSIS.md: Updated BG/Ultra counts
- docs/analysis/ENV_QUICK_REFERENCE.md: Updated verification sections
- docs/analysis/ENV_CLEANUP_PLAN.md: Added REMOVED category
- docs/archive/TINY_LEARNING_LAYER.md: Added archive notice
- docs/archive/MAINLINE_INTEGRATION.md: Added archive notice

Changes: +71/-32 lines

Preserved ENV variables:
- HAKMEM_TINY_ULTRA_SLIM (active 4-layer fast path)
- HAKMEM_ULTRA_SLIM_STATS (Ultra SLIM statistics)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Moe Charm (CI)
2025-11-27 04:51:59 +09:00
parent 6b791b97d4
commit 2ec6689dee
5 changed files with 71 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/analysis/ENV_CLEANUP_ANALYSIS.md
View File

@ -20,7 +20,7 @@ Generated: 2025年 11月 26日 水曜日 16:58:53 JST
These variables control removed/deprecated features and should be deleted:
### 1.1 Background Processing (BG) - 11 vars
### 1.1 Background Processing (BG) - 9 vars
**Status**: BG system removed in 2025-12 cleanup
```
HAKMEM_BATCH_BG
@ -28,6 +28,12 @@ HAKMEM_L25_BG_DRAIN
HAKMEM_L25_BG_MS
```
**Note**: The following 2 Tiny BG vars were removed in commit 6b791b97d (2025-11-26):
```
HAKMEM_TINY_BG_REMOTE (deleted)
HAKMEM_TINY_BG_REMOTE_BATCH (deleted)
```
### 1.2 SFC (Shared Frontend Cache) - 7 vars
**Status**: SFC removed, replaced by UNIFIED_CACHE
```
@ -40,21 +46,23 @@ HAKMEM_SFC_STATS_DUMP
HAKMEM_TINY_SFC_CASCADE
```
### 1.3 HotMag/UltraHot/Quick - 10 vars
### 1.3 HotMag/UltraHot/Quick - 4 vars
**Status**: Experimental caches removed
```
HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT
HAKMEM_TINY_QUICK
HAKMEM_TINY_ULTRA
HAKMEM_TINY_ULTRA_DEBUG
HAKMEM_TINY_ULTRA_FRONT
HAKMEM_TINY_ULTRA_HEAP_DUMP
HAKMEM_TINY_ULTRA_L0
HAKMEM_TINY_ULTRA_PAGE_DUMP
HAKMEM_TINY_ULTRA_SIMPLE
HAKMEM_TINY_ULTRA_SLIM
HAKMEM_TINY_ULTRA_VALIDATE
HAKMEM_ULTRA_SLIM_STATS
HAKMEM_TINY_ULTRA_SLIM
```
**Note**: The following 6 vars were removed in commit 6b791b97d (2025-11-26):
```
HAKMEM_TINY_ULTRA_FRONT (deleted)
HAKMEM_TINY_ULTRA_L0 (deleted)
HAKMEM_TINY_ULTRA_HEAP_DUMP (deleted)
HAKMEM_TINY_ULTRA_PAGE_DUMP (deleted)
HAKMEM_TINY_BG_REMOTE (deleted)
HAKMEM_TINY_BG_REMOTE_BATCH (deleted)
```
### 1.4 Ring Cache - 4 vars
@ -380,20 +388,16 @@ HAKMEM_SFC_STATS_DUMP
HAKMEM_TINY_SFC_CASCADE
```
**Experimental Caches** (10 vars):
**Experimental Caches** (4 vars):
```
HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT
HAKMEM_TINY_QUICK
HAKMEM_TINY_ULTRA
HAKMEM_TINY_ULTRA_DEBUG
HAKMEM_TINY_ULTRA_FRONT
HAKMEM_TINY_ULTRA_HEAP_DUMP
HAKMEM_TINY_ULTRA_L0
HAKMEM_TINY_ULTRA_PAGE_DUMP
HAKMEM_TINY_ULTRA_SIMPLE
HAKMEM_TINY_ULTRA_VALIDATE
HAKMEM_TINY_ULTRA_SLIM
```
**Note**: 6 Ultra/BG vars removed in commit 6b791b97d (see section 1.3 above)
**Ring/TC/Frontend** (18 vars):
```
HAKMEM_L25_RING_TRIGGER

14
docs/analysis/ENV_CLEANUP_PLAN.md
View File

@ -14,9 +14,16 @@
4. **Verification guardrails**: keep Ultra/BG/HeapV2 toggles intact; any deprecation must be #ifdef/A-B gated with a rollback env.
## Feature Decisions (keep vs. change)
- **KEEP (active)**: Ultra (`core/ultra/*`, `core/box/ultra_slim_alloc_box.h`), BG (`core/hakmem_batch.c`, `core/hakmem_l25_pool.c`), HeapV2/FrontV2 (`core/front/tiny_heap_v2.h`, `core/tiny_alloc_fast.inc.h`), SFC (`core/hakmem_tiny_sfc.c`), TC/Ring (`core/hakmem_l25_pool.c`, `core/box/pool_init_api.inc.h`).
- **KEEP (active)**: Ultra (`core/box/ultra_slim_alloc_box.h`), BG (`core/hakmem_batch.c`, `core/hakmem_l25_pool.c`), HeapV2/FrontV2 (`core/front/tiny_heap_v2.h`, `core/tiny_alloc_fast.inc.h`), SFC (`core/hakmem_tiny_sfc.c`), TC/Ring (`core/hakmem_l25_pool.c`, `core/box/pool_init_api.inc.h`).
- **CLEAN**: Duplicate `HAKMEM_SFC_DEBUG` getenvs; legacy doc-only set (21 vars) from specs/papers.
- **DEFER**: Any removal of Ultra/HeapV2/BG toggles until explicit user approval; these are part of the active Box stack.
- **REMOVED (commit 6b791b97d, 2025-11-26)**: 6 Ultra/BG ENV vars:
- `HAKMEM_TINY_ULTRA_FRONT`
- `HAKMEM_TINY_ULTRA_L0`
- `HAKMEM_TINY_ULTRA_HEAP_DUMP`
- `HAKMEM_TINY_ULTRA_PAGE_DUMP`
- `HAKMEM_TINY_BG_REMOTE`
- `HAKMEM_TINY_BG_REMOTE_BATCH`
- **DEFER**: Any removal of remaining Ultra/HeapV2/BG toggles until explicit user approval; these are part of the active Box stack.
## File-by-File Checkpoints (actionable)
- **SFC (Shared Frontend Cache)**
@ -31,7 +38,8 @@
- `core/tiny_alloc_fast.inc.h:167,352` and `core/hakmem_tiny.c:578` — stats/enable toggles; keep.
- `core/box/front_metrics_box.*` — metrics/dump toggles; keep.
- **Ultra**
- `core/front/tiny_ultrafront.h:39`, `core/ultra/tiny_ultra_heap.c:23,180`, `core/ultra/tiny_ultra_page_arena.c:71`, `core/box/ultra_slim_alloc_box.h:87,226`, `core/box/hak_core_init.inc.h:279` — keep experimental toggles; require #ifdef rollback if changed.
- `core/box/ultra_slim_alloc_box.h:87,226`, `core/box/hak_core_init.inc.h:279` — keep experimental toggles; require #ifdef rollback if changed.
- **Removed in commit 6b791b97d**: `HAKMEM_TINY_ULTRA_FRONT`, `HAKMEM_TINY_ULTRA_L0`, `HAKMEM_TINY_ULTRA_HEAP_DUMP`, `HAKMEM_TINY_ULTRA_PAGE_DUMP` (files deleted: `core/front/tiny_ultrafront.h`, `core/ultra/tiny_ultra_heap.c`, `core/ultra/tiny_ultra_page_arena.c`).
- **Ring/TC**
- `core/hakmem_l25_pool.c:718,724,745`, `core/box/pool_init_api.inc.h:60,66` — ring controls (active).
- `core/hakmem_l25_pool.c:737,739`, `core/box/pool_init_api.inc.h:72-78` — TC controls (active); no removal.

24
docs/analysis/ENV_QUICK_REFERENCE.md
View File

@ -67,18 +67,22 @@ File: core/box/hak_wrappers.inc.h:89
### Ask Maintainer/User:
#### 1. Ultra Features (8 vars) - Experimental or Dead?
#### 1. Ultra Features (3 vars) - Experimental or Dead?
```
HAKMEM_TINY_ULTRA_FRONT core/front/tiny_ultrafront.h
HAKMEM_TINY_ULTRA_L0 core/ultra/tiny_ultra_heap.c
HAKMEM_TINY_ULTRA_HEAP_DUMP core/ultra/tiny_ultra_heap.c
HAKMEM_TINY_ULTRA_PAGE_DUMP core/ultra/tiny_ultra_page_arena.c
HAKMEM_TINY_ULTRA_SLIM core/box/ultra_slim_alloc_box.h
HAKMEM_ULTRA_SLIM_STATS core/box/ultra_slim_alloc_box.h
HAKMEM_TINY_ULTRA_DEBUG core/box/hak_core_init.inc.h
```
**Question**: Are Ultra features still being developed/used?
**Note**: The following 4 vars were removed in commit 6b791b97d (2025-11-26):
```
HAKMEM_TINY_ULTRA_FRONT (deleted)
HAKMEM_TINY_ULTRA_L0 (deleted)
HAKMEM_TINY_ULTRA_HEAP_DUMP (deleted)
HAKMEM_TINY_ULTRA_PAGE_DUMP (deleted)
```
#### 2. Heap V2 (7 vars) - Active or Replaced?
```
HAKMEM_TINY_HEAP_V2_CLASS_MASK core/front/tiny_heap_v2.h
@ -91,16 +95,20 @@ HAKMEM_TINY_FRONT_DISABLE_HEAPV2 core/box/front_metrics_box.h
```
**Question**: Is Heap V2 frontend still used or replaced by newer code?
#### 3. BG System (5 vars) - Keep or Deprecate?
#### 3. BG System (3 vars) - Keep or Deprecate?
```
HAKMEM_BATCH_BG core/hakmem_batch.c (g_bg_enabled=1)
HAKMEM_L25_BG_DRAIN core/hakmem_l25_pool.c
HAKMEM_L25_BG_MS core/hakmem_l25_pool.c
HAKMEM_TINY_BG_REMOTE core/hakmem_tiny_remote_target.c
HAKMEM_TINY_BG_REMOTE_BATCH core/hakmem_tiny_remote_target.c
```
**Question**: Is background drain still needed or deprecated?
**Note**: The following 2 Tiny BG vars were removed in commit 6b791b97d (2025-11-26):
```
HAKMEM_TINY_BG_REMOTE (deleted)
HAKMEM_TINY_BG_REMOTE_BATCH (deleted)
```
#### 4. HotMag/SmallMag (1 var) - Used?
```
HAKMEM_TINY_SMALL_MAG core/hakmem_tiny_smallmag.inc.h

7
docs/archive/MAINLINE_INTEGRATION.md
View File

@ -1,5 +1,12 @@
Mainline Integration Plan (Tiny focus)
> **⚠️ ARCHIVE NOTICE (2025-11-26)**
> Several ENV variables and files referenced in this document were removed in commit 6b791b97d:
> - `HAKMEM_TINY_BG_REMOTE` (deleted)
> - `HAKMEM_TINY_BG_REMOTE_BATCH` (deleted)
>
> This document is kept for historical reference but may contain outdated information.
What we promoted to mainline (safe, general)
- Safer tiny refill into SLL (already integrated)
- `sll_refill_small_from_ss(class_idx, max_take)` now caps refill by the actual SLL free capacity, avoiding overtake and wasted meta->used increments.

12
docs/archive/TINY_LEARNING_LAYER.md
View File

@ -1,5 +1,17 @@
# Tiny Learning Layer & Backend Integration (Phase 27 Snapshot)
> **⚠️ ARCHIVE NOTICE (2025-11-26)**
> Several ENV variables and files referenced in this document were removed in commit 6b791b97d:
> - `HAKMEM_TINY_ULTRA_FRONT` (deleted)
> - `HAKMEM_TINY_ULTRA_L0` (deleted)
> - `HAKMEM_TINY_ULTRA_HEAP_DUMP` (deleted)
> - `HAKMEM_TINY_ULTRA_PAGE_DUMP` (deleted)
> - `HAKMEM_TINY_BG_REMOTE` (deleted)
> - `HAKMEM_TINY_BG_REMOTE_BATCH` (deleted)
> - Files deleted: `core/front/tiny_ultrafront.h`, `core/ultra/tiny_ultra_heap.c`, `core/ultra/tiny_ultra_page_arena.c`
>
> This document is kept for historical reference but may contain outdated information.
**Date**: 2025-11-21
**Scope**: Tiny (0–1KB) / Shared Superslab Pool / FrozenPolicy / Ultra* Boxes
**Goal**: 学習層（FrozenPolicy / Learner）を活かして、Tiny の backend を「自動でそれなりに最適」な状態に保つための箱と境界を整理する。