ENV cleanup: Remove obsolete ULTRAHOT variable + organize docs
Changes:
1. Removed HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT variable
- Deleted front_prune_ultrahot_enabled() function
- UltraHot feature was removed in commit bcfb4f6b5
- Variable was dead code, no longer referenced
2. Organized ENV cleanup analysis documents
- Moved 5 ENV analysis docs to docs/analysis/
- ENV_CLEANUP_PLAN.md - detailed file-by-file plan
- ENV_CLEANUP_SUMMARY.md - executive summary
- ENV_CLEANUP_ANALYSIS.md - categorized analysis
- ENV_CONSOLIDATION_PLAN.md - consolidation proposals
- ENV_QUICK_REFERENCE.md - quick reference guide
Impact:
- ENV variables: 221 → 220 (-1)
- Build: ✅ Successful
- Risk: Zero (dead code removal)
Next steps (documented in ENV_CLEANUP_SUMMARY.md):
- 21 variables need verification (Ultra/HeapV2/BG/HotMag)
- SFC_DEBUG deduplication opportunity (7 callsites)
File: core/box/front_metrics_box.h
Status: SAVEPOINT - stable baseline for future ENV cleanup
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Moe Charm (CI)
@ -15,8 +15,7 @@ core/box/front_gate_classifier.o: core/box/front_gate_classifier.c \
|
||||
core/box/../hakmem_build_flags.h core/box/../hakmem_internal.h \
|
||||
core/box/../hakmem.h core/box/../hakmem_config.h \
|
||||
core/box/../hakmem_features.h core/box/../hakmem_sys.h \
|
||||
core/box/../hakmem_whale.h core/box/../hakmem_tiny_config.h \
|
||||
core/box/../pool_tls_registry.h
|
||||
core/box/../hakmem_whale.h core/box/../hakmem_tiny_config.h
|
||||
core/box/front_gate_classifier.h:
|
||||
core/box/../tiny_region_id.h:
|
||||
core/box/../hakmem_build_flags.h:
|
||||
@ -43,4 +42,3 @@ core/box/../hakmem_features.h:
|
||||
core/box/../hakmem_sys.h:
|
||||
core/box/../hakmem_whale.h:
|
||||
core/box/../hakmem_tiny_config.h:
|
||||
core/box/../pool_tls_registry.h:
|
||||
|
||||
@ -133,21 +133,11 @@ static inline void front_metrics_class5_miss(int cls) {
|
||||
// ============================================================================
|
||||
// Purpose: Allow selective enabling/disabling of frontend layers
|
||||
// ENV Controls:
|
||||
// HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT=1 - Enable UltraHot magazine (C2-C5) [DEFAULT: OFF]
|
||||
// HAKMEM_TINY_FRONT_DISABLE_HEAPV2=1 - Disable HeapV2 magazine (C0-C3) [DEFAULT: ON]
|
||||
//
|
||||
// Phase 19-4 A/B Test Result: UltraHot default OFF for +12.9% performance gain
|
||||
// Note: HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT removed - UltraHot feature deleted in bcfb4f6b5
|
||||
// ============================================================================
|
||||
|
||||
static inline int front_prune_ultrahot_enabled(void) {
|
||||
static int cached = -1;
|
||||
if (__builtin_expect(cached == -1, 0)) {
|
||||
const char* env = getenv("HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT");
|
||||
cached = (env && *env && *env != '0') ? 1 : 0; // DEFAULT: OFF (0) for best performance
|
||||
}
|
||||
return cached;
|
||||
}
|
||||
|
||||
static inline int front_prune_heapv2_enabled(void) {
|
||||
static int cached = -1;
|
||||
if (__builtin_expect(cached == -1, 0)) {
|
||||
|
||||
508
docs/analysis/ENV_CLEANUP_ANALYSIS.md
Normal file
508
docs/analysis/ENV_CLEANUP_ANALYSIS.md
Normal file
@ -0,0 +1,508 @@
|
||||
# HAKMEM ENV Variables - Comprehensive Cleanup Analysis
|
||||
**Total Variables: 282 → Target: <50**
|
||||
|
||||
Generated: 2025年 11月 26日 水曜日 16:58:53 JST
|
||||
|
||||
## Executive Summary
|
||||
|
||||
| Category | Count | Percentage | Action |
|
||||
|----------|-------|------------|--------|
|
||||
| OBSOLETE | 54 | 19% | **REMOVE** (defunct features) |
|
||||
| DEBUG | 59 | 21% | **GATE** (#if !HAKMEM_BUILD_RELEASE) |
|
||||
| ESSENTIAL | 20 | 7% | **KEEP** (core functionality) |
|
||||
| POLICY | 149 | 53% | **CONSOLIDATE** (reduce to ~30) |
|
||||
|
||||
**Reduction Path**: 282 → 113 (remove obsolete) → 54 (gate debug) → **~50** (consolidate policy)
|
||||
|
||||
---
|
||||
|
||||
## Category 1: OBSOLETE (54 vars - REMOVE)
|
||||
|
||||
These variables control removed/deprecated features and should be deleted:
|
||||
|
||||
### 1.1 Background Processing (BG) - 11 vars
|
||||
**Status**: BG system removed in 2025-12 cleanup
|
||||
```
|
||||
HAKMEM_BATCH_BG
|
||||
HAKMEM_L25_BG_DRAIN
|
||||
HAKMEM_L25_BG_MS
|
||||
```
|
||||
|
||||
### 1.2 SFC (Shared Frontend Cache) - 7 vars
|
||||
**Status**: SFC removed, replaced by UNIFIED_CACHE
|
||||
```
|
||||
HAKMEM_SFC_CAPACITY
|
||||
HAKMEM_SFC_CASCADE_PCT
|
||||
HAKMEM_SFC_DEBUG
|
||||
HAKMEM_SFC_ENABLE
|
||||
HAKMEM_SFC_REFILL_COUNT
|
||||
HAKMEM_SFC_STATS_DUMP
|
||||
HAKMEM_TINY_SFC_CASCADE
|
||||
```
|
||||
|
||||
### 1.3 HotMag/UltraHot/Quick - 10 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
|
||||
```
|
||||
|
||||
### 1.4 Ring Cache - 4 vars
|
||||
**Status**: Ring system removed
|
||||
```
|
||||
HAKMEM_L25_RING_TRIGGER
|
||||
HAKMEM_POOL_TLS_RING
|
||||
HAKMEM_RING_RETURN_DIV
|
||||
HAKMEM_TINY_ALLOC_RING
|
||||
HAKMEM_TINY_DUMP_RING_ATEXIT
|
||||
HAKMEM_TINY_SLL_RING
|
||||
HAKMEM_TINY_TRACE_RING
|
||||
```
|
||||
|
||||
### 1.5 Thread Cache (TC) - 4 vars
|
||||
**Status**: TC system deprecated
|
||||
```
|
||||
```
|
||||
|
||||
### 1.6 L25 BigCache - 8 vars
|
||||
**Status**: BigCache system removed
|
||||
```
|
||||
HAKMEM_BIGCACHE_L25
|
||||
HAKMEM_DISABLE_BIGCACHE
|
||||
HAKMEM_L25_BG_DRAIN
|
||||
HAKMEM_L25_BG_MS
|
||||
HAKMEM_L25_RING_TRIGGER
|
||||
HAKMEM_L25_TC_CAP
|
||||
HAKMEM_L25_TC_SPILL
|
||||
```
|
||||
|
||||
### 1.7 Frontend Experiments - 10 vars
|
||||
**Status**: Experimental frontends (V2, Heap, Slim) removed
|
||||
```
|
||||
HAKMEM_TINY_FASTCACHE
|
||||
HAKMEM_TINY_FRONTEND
|
||||
HAKMEM_TINY_FRONT_DISABLE_HEAPV2
|
||||
HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT
|
||||
HAKMEM_TINY_FRONT_SLIM
|
||||
HAKMEM_TINY_FRONT_V2
|
||||
HAKMEM_TINY_HEAP_V2_CLASS_MASK
|
||||
HAKMEM_TINY_HEAP_V2_DEBUG
|
||||
HAKMEM_TINY_HEAP_V2_LEFTOVER_MODE
|
||||
HAKMEM_TINY_HEAP_V2_STATS
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Category 2: DEBUG_ONLY (59 vars - COMPILE-TIME GATE)
|
||||
|
||||
These should be gated with `#if !HAKMEM_BUILD_RELEASE` and removed from production:
|
||||
|
||||
### 2.1 Tracing/Logging - 20 vars
|
||||
```
|
||||
HAKMEM_ADAPTIVE_LOG
|
||||
HAKMEM_EXTERNAL_GUARD_LOG
|
||||
HAKMEM_FREE_ROUTE_TRACE
|
||||
HAKMEM_FREE_WRAP_TRACE
|
||||
HAKMEM_INVALID_FREE_LOG
|
||||
HAKMEM_LOG_FILE
|
||||
HAKMEM_PTR_TRACE_DUMP
|
||||
HAKMEM_PTR_TRACE_VERBOSE
|
||||
HAKMEM_SUPER_REG_REQTRACE
|
||||
HAKMEM_TIMING
|
||||
HAKMEM_TINY_MAILBOX_TRACE
|
||||
HAKMEM_TINY_MAILBOX_TRACE_LIMIT
|
||||
HAKMEM_TINY_RF_TRACE
|
||||
HAKMEM_TINY_SUPERSLAB_TRACE
|
||||
HAKMEM_TINY_TRACE_RING
|
||||
HAKMEM_VERBOSE
|
||||
```
|
||||
|
||||
### 2.2 Statistics/Profiling - 18 vars
|
||||
```
|
||||
HAKMEM_ACE_PROFILE
|
||||
HAKMEM_ACE_SAMPLE
|
||||
HAKMEM_EVO_SAMPLE
|
||||
HAKMEM_EXTERNAL_GUARD_STATS
|
||||
HAKMEM_HIST_SAMPLE
|
||||
HAKMEM_INT_SAMPLE
|
||||
HAKMEM_LEARN_SAMPLE
|
||||
HAKMEM_POOL_COUNT_SAMPLE
|
||||
HAKMEM_PROF
|
||||
HAKMEM_PROF_SAMPLE
|
||||
HAKMEM_ROUTE_SAMPLE_LG
|
||||
HAKMEM_SFC_STATS_DUMP
|
||||
HAKMEM_SHARED_POOL_LOCK_STATS
|
||||
HAKMEM_SHARED_POOL_STAGE_STATS
|
||||
HAKMEM_TINY_ALLOC_1024_METRIC
|
||||
HAKMEM_TINY_COUNT_SAMPLE
|
||||
HAKMEM_TINY_FAST_STATS
|
||||
HAKMEM_TINY_FRONT_METRICS
|
||||
```
|
||||
|
||||
### 2.3 Debug/Validation - 21 vars
|
||||
```
|
||||
HAKMEM_ACE_DEBUG
|
||||
HAKMEM_ACE_OBSERVE
|
||||
HAKMEM_DEBUG_SEGV
|
||||
HAKMEM_EXTERNAL_GUARD_LOG
|
||||
HAKMEM_EXTERNAL_GUARD_MINCORE
|
||||
HAKMEM_EXTERNAL_GUARD_STATS
|
||||
HAKMEM_PTR_TRACE_DUMP
|
||||
HAKMEM_SFC_DEBUG
|
||||
HAKMEM_SFC_STATS_DUMP
|
||||
HAKMEM_SS_ACQUIRE_DEBUG
|
||||
HAKMEM_SS_FREE_DEBUG
|
||||
HAKMEM_SS_LRU_DEBUG
|
||||
HAKMEM_SS_PREWARM_DEBUG
|
||||
HAKMEM_SUPER_LOOKUP_DEBUG
|
||||
HAKMEM_SUPER_REG_DEBUG
|
||||
HAKMEM_TINY_ALLOC_DEBUG
|
||||
HAKMEM_TINY_COUNTERS_DUMP
|
||||
HAKMEM_TINY_DEBUG_FAST0
|
||||
HAKMEM_TINY_DEBUG_REMOTE_GUARD
|
||||
HAKMEM_TINY_DUMP_ATEXIT_ONLY
|
||||
HAKMEM_TINY_DUMP_RING_ATEXIT
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Category 3: ESSENTIAL (20 vars - KEEP)
|
||||
|
||||
Core functionality that must remain:
|
||||
|
||||
### 3.1 Major Features (8 vars)
|
||||
```
|
||||
HAKMEM_TINY_UNIFIED_CACHE=1 # Phase 3d-B (default ON)
|
||||
HAKMEM_SS_EMPTY_REUSE=1 # Phase 12-1.1 (default ON)
|
||||
HAKMEM_FRONT_GATE_UNIFIED=1 # Phase 26 (default ON)
|
||||
HAKMEM_WRAP_TINY=1 # Enable Tiny Pool
|
||||
HAKMEM_TINY_USE_SUPERSLAB=1 # SuperSlab backend
|
||||
HAKMEM_TINY_TLS_SLL=1 # TLS cache layer
|
||||
HAKMEM_TINY_FREE_FAST=1 # Fast free path
|
||||
HAKMEM_POOL_TLS_FREE=1 # Pool TLS free
|
||||
```
|
||||
|
||||
### 3.2 Pool TLS Arena (3 vars)
|
||||
```
|
||||
HAKMEM_POOL_TLS_ARENA_MB_INIT=1 # Initial arena size
|
||||
HAKMEM_POOL_TLS_ARENA_MB_MAX=8 # Max arena size
|
||||
HAKMEM_POOL_TLS_ARENA_GROWTH_LEVELS=3 # Growth stages
|
||||
```
|
||||
|
||||
### 3.3 Page Arena (5 vars)
|
||||
```
|
||||
HAKMEM_PAGE_ARENA_ENABLE=1 # Page arena system
|
||||
HAKMEM_PAGE_ARENA_HOT_SIZE=... # Hot size threshold
|
||||
HAKMEM_PAGE_ARENA_WARM_64K=... # Warm level 1
|
||||
HAKMEM_PAGE_ARENA_WARM_128K=... # Warm level 2
|
||||
HAKMEM_PAGE_ARENA_WARM_2M=... # Warm level 3
|
||||
```
|
||||
|
||||
### 3.4 Misc Essential (4 vars)
|
||||
```
|
||||
HAKMEM_PREWARM_SUPERSLABS=1 # Phase 11 prewarm
|
||||
HAKMEM_TINY_PREWARM_ALL=1 # Full prewarm
|
||||
HAKMEM_WRAP_TINY_REFILL=1 # Wrapper refill
|
||||
HAKMEM_SMALLMID_ENABLE=1 # SmallMid allocator
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Category 4: POLICY (149 vars - CONSOLIDATE to ~30)
|
||||
|
||||
### 4.1 Duplicate/Similar Functionality
|
||||
|
||||
#### Refill Parameters (18 vars → 3 vars)
|
||||
**Current**:
|
||||
```
|
||||
HAKMEM_INT_ADAPT_REFILL
|
||||
HAKMEM_SFC_REFILL_COUNT
|
||||
HAKMEM_TINY_MID_REFILL_SIMPLE
|
||||
HAKMEM_TINY_REFILL_COUNT
|
||||
HAKMEM_TINY_REFILL_COUNT_HOT
|
||||
HAKMEM_TINY_REFILL_COUNT_MID
|
||||
HAKMEM_TINY_REFILL_DUMP
|
||||
HAKMEM_TINY_REFILL_FAILFAST
|
||||
HAKMEM_TINY_REFILL_MAX
|
||||
HAKMEM_TINY_REFILL_MAX_HOT
|
||||
HAKMEM_TINY_REFILL_ONE_ON_MISS
|
||||
HAKMEM_TINY_REFILL_OPT_DEBUG
|
||||
HAKMEM_WRAP_TINY_REFILL
|
||||
```
|
||||
**Proposal**: Consolidate to:
|
||||
```
|
||||
HAKMEM_TINY_REFILL_BATCH=64 # Default batch size
|
||||
HAKMEM_TINY_REFILL_HOT_BATCH=192 # Hot class batch
|
||||
HAKMEM_TINY_REFILL_MAX=1024 # Global max
|
||||
```
|
||||
|
||||
#### Capacity Parameters (25 vars → 5 vars)
|
||||
**Current**:
|
||||
```
|
||||
HAKMEM_CAP_LARGE
|
||||
HAKMEM_CAP_MID
|
||||
HAKMEM_CAP_MID_DYN1
|
||||
HAKMEM_CAP_MID_DYN2
|
||||
HAKMEM_L25_MIN_BUNDLE
|
||||
HAKMEM_MF2_MAX_QUEUES
|
||||
HAKMEM_POOL_MIN_BUNDLE
|
||||
HAKMEM_SUPERSLAB_MAX_CACHED
|
||||
HAKMEM_SUPERSLAB_MAX_MEMORY_MB
|
||||
HAKMEM_TINY_MAX_CLASS
|
||||
HAKMEM_TINY_REFILL_MAX_HOT
|
||||
HAKMEM_TINY_SS_MAX_MB
|
||||
HAKMEM_TINY_SS_MIN_MB
|
||||
...(25 total)
|
||||
```
|
||||
**Proposal**: Use tiered approach:
|
||||
```
|
||||
HAKMEM_TINY_CACHE_SIZE=small|medium|large # Preset
|
||||
HAKMEM_MID_CACHE_SIZE=small|medium|large
|
||||
HAKMEM_LARGE_CACHE_SIZE=small|medium|large
|
||||
HAKMEM_SS_MEMORY_LIMIT_MB=512 # Global limit
|
||||
HAKMEM_POOL_MEMORY_LIMIT_MB=256 # Pool limit
|
||||
```
|
||||
|
||||
#### Learning/Adaptation (35 vars → 8 vars)
|
||||
**Current**: ACE, INT, WMAX, THP, ELO, LEARN, ADAPTIVE, HOT, DYN systems
|
||||
```
|
||||
HAKMEM_ACE_DEBUG
|
||||
HAKMEM_ACE_ENABLED
|
||||
HAKMEM_ACE_OBSERVE
|
||||
HAKMEM_ACE_PROFILE
|
||||
HAKMEM_ACE_SAMPLE
|
||||
HAKMEM_ADAPTIVE_LOG
|
||||
HAKMEM_ADAPTIVE_SIZING
|
||||
HAKMEM_CAP_MID_DYN1
|
||||
HAKMEM_CAP_MID_DYN2
|
||||
HAKMEM_DISABLE_ELO
|
||||
HAKMEM_DYN1_AUTO
|
||||
HAKMEM_DYN2_AUTO
|
||||
HAKMEM_INT_ADAPT_CAPS
|
||||
HAKMEM_INT_ADAPT_REFILL
|
||||
HAKMEM_INT_ENGINE
|
||||
...(35 total)
|
||||
```
|
||||
**Proposal**: Unified learning system:
|
||||
```
|
||||
HAKMEM_LEARN_MODE=off|observe|active # Master switch
|
||||
HAKMEM_LEARN_TARGETS=caps,refill,wmax # What to tune
|
||||
HAKMEM_LEARN_INTERVAL_MS=1000 # Update rate
|
||||
HAKMEM_LEARN_AGGRESSIVENESS=0.1 # Tuning rate
|
||||
HAKMEM_THP_POLICY=off|auto|on # THP
|
||||
HAKMEM_ADAPTIVE_CAPS=1 # Enable cap adaptation
|
||||
HAKMEM_ADAPTIVE_REFILL=1 # Enable refill adaptation
|
||||
HAKMEM_ADAPTIVE_WMAX=1 # Enable wmax adaptation
|
||||
```
|
||||
|
||||
#### Drain/Threshold Parameters (20 vars → 5 vars)
|
||||
**Current**:
|
||||
```
|
||||
HAKMEM_L25_BG_DRAIN
|
||||
HAKMEM_L25_RING_TRIGGER
|
||||
HAKMEM_MF2_IDLE_THRESHOLD_US
|
||||
HAKMEM_TC_DRAIN_MAX
|
||||
HAKMEM_TC_DRAIN_TRIGGER
|
||||
HAKMEM_TINY_DRAIN_TO_SLL
|
||||
HAKMEM_TINY_REMOTE_DRAIN_THRESHOLD
|
||||
HAKMEM_TINY_REMOTE_DRAIN_TRYRATE
|
||||
HAKMEM_TINY_SLL_DRAIN_DEBUG
|
||||
HAKMEM_TINY_SLL_DRAIN_ENABLE
|
||||
HAKMEM_TINY_SLL_DRAIN_INTERVAL
|
||||
HAKMEM_TINY_TENSION_DRAIN_ENABLE
|
||||
HAKMEM_TINY_TENSION_DRAIN_THRESHOLD
|
||||
...(20 total)
|
||||
```
|
||||
**Proposal**: Unified thresholds:
|
||||
```
|
||||
HAKMEM_REMOTE_DRAIN_THRESHOLD=32 # When to drain
|
||||
HAKMEM_REMOTE_DRAIN_BATCH=16 # Drain batch size
|
||||
HAKMEM_SPILL_THRESHOLD_PCT=90 # Cache spill %
|
||||
HAKMEM_TRIM_INTERVAL_MS=1000 # Memory trim rate
|
||||
HAKMEM_IDLE_TIMEOUT_MS=5000 # Idle detection
|
||||
```
|
||||
|
||||
### 4.2 Recommended Consolidation Summary
|
||||
|
||||
| Area | Current | Proposed | Reduction |
|
||||
|------|---------|----------|-----------|
|
||||
| Refill params | 18 | 3 | -83% |
|
||||
| Capacity params | 25 | 5 | -80% |
|
||||
| Learning/Adapt | 35 | 8 | -77% |
|
||||
| Drain/Threshold | 20 | 5 | -75% |
|
||||
| L25/Pool config | 15 | 5 | -67% |
|
||||
| Misc policy | 36 | 4 | -89% |
|
||||
| **TOTAL** | **149** | **30** | **-80%** |
|
||||
|
||||
---
|
||||
|
||||
## Final Reduction Path
|
||||
|
||||
```
|
||||
Step 1: Remove OBSOLETE 282 → 228 (-54)
|
||||
Step 2: Gate DEBUG with #if 228 → 169 (-59)
|
||||
Step 3: Keep ESSENTIAL as-is 169 → 149 (-20)
|
||||
Step 4: Consolidate POLICY 149 → 30 (-119)
|
||||
|
||||
FINAL COUNT: 20 (essential) + 30 (policy) = 50 variables
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Top Removal Candidates (By Priority)
|
||||
|
||||
### Priority 1: Dead Code (Immediate Removal) - 54 vars
|
||||
|
||||
**BG System** (11 vars):
|
||||
```
|
||||
HAKMEM_L25_BG_DRAIN
|
||||
HAKMEM_L25_BG_MS
|
||||
```
|
||||
|
||||
**SFC System** (7 vars):
|
||||
```
|
||||
HAKMEM_SFC_CAPACITY
|
||||
HAKMEM_SFC_CASCADE_PCT
|
||||
HAKMEM_SFC_DEBUG
|
||||
HAKMEM_SFC_ENABLE
|
||||
HAKMEM_SFC_REFILL_COUNT
|
||||
HAKMEM_SFC_STATS_DUMP
|
||||
HAKMEM_TINY_SFC_CASCADE
|
||||
```
|
||||
|
||||
**Experimental Caches** (10 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_SLIM
|
||||
```
|
||||
|
||||
**Ring/TC/Frontend** (18 vars):
|
||||
```
|
||||
HAKMEM_L25_RING_TRIGGER
|
||||
HAKMEM_L25_TC_CAP
|
||||
HAKMEM_L25_TC_SPILL
|
||||
HAKMEM_MID_TC_CAP
|
||||
HAKMEM_POOL_TLS_RING
|
||||
HAKMEM_RING_RETURN_DIV
|
||||
HAKMEM_TC_DRAIN_MAX
|
||||
HAKMEM_TC_DRAIN_TRIGGER
|
||||
HAKMEM_TC_ENABLE
|
||||
HAKMEM_TC_UNBOUNDED
|
||||
HAKMEM_TINY_ALLOC_RING
|
||||
HAKMEM_TINY_DUMP_RING_ATEXIT
|
||||
HAKMEM_TINY_FASTCACHE
|
||||
HAKMEM_TINY_FRONT_V2
|
||||
HAKMEM_TINY_HEAP_V2_CLASS_MASK
|
||||
HAKMEM_TINY_HEAP_V2_DEBUG
|
||||
HAKMEM_TINY_HEAP_V2_LEFTOVER_MODE
|
||||
HAKMEM_TINY_HEAP_V2_STATS
|
||||
```
|
||||
|
||||
### Priority 2: Debug Gate (Next Phase) - 59 vars
|
||||
|
||||
Move to `#if !HAKMEM_BUILD_RELEASE` block:
|
||||
```
|
||||
HAKMEM_ACE_DEBUG
|
||||
HAKMEM_ACE_OBSERVE
|
||||
HAKMEM_ACE_PROFILE
|
||||
HAKMEM_ADAPTIVE_LOG
|
||||
HAKMEM_DEBUG_SEGV
|
||||
HAKMEM_EXTERNAL_GUARD_LOG
|
||||
HAKMEM_EXTERNAL_GUARD_MINCORE
|
||||
HAKMEM_EXTERNAL_GUARD_STATS
|
||||
HAKMEM_FREE_ROUTE_TRACE
|
||||
HAKMEM_FREE_WRAP_TRACE
|
||||
HAKMEM_INVALID_FREE_LOG
|
||||
HAKMEM_LOG_FILE
|
||||
HAKMEM_PROF
|
||||
HAKMEM_PROF_SAMPLE
|
||||
HAKMEM_PTR_TRACE_DUMP
|
||||
HAKMEM_PTR_TRACE_VERBOSE
|
||||
HAKMEM_SFC_DEBUG
|
||||
HAKMEM_SFC_STATS_DUMP
|
||||
HAKMEM_SHARED_POOL_LOCK_STATS
|
||||
HAKMEM_SHARED_POOL_STAGE_STATS
|
||||
HAKMEM_SS_ACQUIRE_DEBUG
|
||||
HAKMEM_SS_FREE_DEBUG
|
||||
HAKMEM_SS_LRU_DEBUG
|
||||
HAKMEM_SS_PREWARM_DEBUG
|
||||
HAKMEM_SUPER_LOOKUP_DEBUG
|
||||
HAKMEM_SUPER_REG_DEBUG
|
||||
HAKMEM_SUPER_REG_REQTRACE
|
||||
HAKMEM_TINY_ALLOC_DEBUG
|
||||
HAKMEM_TINY_COUNTERS_DUMP
|
||||
HAKMEM_TINY_DEBUG_FAST0
|
||||
...(59 total)
|
||||
```
|
||||
|
||||
### Priority 3: Policy Consolidation (Final Phase) - 119 vars
|
||||
|
||||
**High-impact consolidation targets**:
|
||||
|
||||
1. **Per-class overrides** (30+ vars): Remove HAKMEM_TINY_*_C{0..7}, use class-agnostic tuning
|
||||
2. **Learning systems** (35 vars): Unify ACE/INT/WMAX/ELO into HAKMEM_LEARN_*
|
||||
3. **Capacity limits** (25 vars): Use tiered presets (small/medium/large)
|
||||
4. **Drain thresholds** (20 vars): Unify under HAKMEM_DRAIN_* namespace
|
||||
|
||||
---
|
||||
|
||||
## Undocumented Variables
|
||||
|
||||
Variables in code but not in ENV_VARS.md:
|
||||
```
|
||||
(Run: comm -13 <(grep -o 'HAKMEM_[A-Z_0-9]*' ENV_VARS.md | sort -u) <(grep -rh 'getenv("HAKMEM_' core/ | grep -o 'HAKMEM_[A-Z_0-9]*' | sort -u))
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Recommended Actions
|
||||
|
||||
### Phase 1: Remove OBSOLETE (Week 1)
|
||||
- [ ] Remove all BG system ENV vars (11 vars)
|
||||
- [ ] Remove all SFC system ENV vars (7 vars)
|
||||
- [ ] Remove HotMag/Ultra/Quick ENV vars (10 vars)
|
||||
- [ ] Remove Ring/TC ENV vars (8 vars)
|
||||
- [ ] Remove experimental frontend ENV vars (18 vars)
|
||||
- [ ] **Result**: 282 → 228 vars (-19%)
|
||||
|
||||
### Phase 2: Gate DEBUG (Week 2)
|
||||
- [ ] Create `core/hakmem_debug_env.h` with #if !HAKMEM_BUILD_RELEASE
|
||||
- [ ] Move all *_DEBUG, *_TRACE, *_STATS, *_DUMP vars
|
||||
- [ ] Move all *_LOG, *_PROF, *_OBSERVE vars
|
||||
- [ ] Update build.sh to strip debug ENV in release
|
||||
- [ ] **Result**: 228 → 169 vars (-21% production)
|
||||
|
||||
### Phase 3: Consolidate POLICY (Week 3-4)
|
||||
- [ ] Consolidate REFILL_* params (18 → 3)
|
||||
- [ ] Consolidate CAP_/MAX_/MIN_ params (25 → 5)
|
||||
- [ ] Unify learning systems (35 → 8)
|
||||
- [ ] Consolidate drain thresholds (20 → 5)
|
||||
- [ ] Simplify L25/Pool config (15 → 5)
|
||||
- [ ] Merge misc policy vars (36 → 4)
|
||||
- [ ] **Result**: 169 → 50 vars (-82% total)
|
||||
|
||||
### Phase 4: Document & Test (Week 5)
|
||||
- [ ] Update ENV_VARS.md with final 50 vars
|
||||
- [ ] Create ENV_MIGRATION_GUIDE.md for old→new mapping
|
||||
- [ ] Add ENV validation warnings for removed vars
|
||||
- [ ] Regression test all 50 vars
|
||||
- [ ] Update CLAUDE.md with new ENV list
|
||||
|
||||
411
docs/analysis/ENV_CLEANUP_PLAN.md
Normal file
411
docs/analysis/ENV_CLEANUP_PLAN.md
Normal file
@ -0,0 +1,411 @@
|
||||
# OBSOLETE ENV Cleanup Plan
|
||||
|
||||
## Summary
|
||||
- **Total ENV vars in codebase**: 221
|
||||
- **Potentially OBSOLETE vars**: 54
|
||||
- **Files affected**: 73
|
||||
- **Safe to remove immediately**: 18 (Priority 1)
|
||||
- **Need verification**: 36 (Priority 2-3)
|
||||
|
||||
---
|
||||
|
||||
## Priority 1: 100% Safe Removals (Already Removed Code)
|
||||
|
||||
These ENV variables reference features that were **completely removed** in commits bcfb4f6b5 and 225b6fcc7 but ENV checks were left behind:
|
||||
|
||||
### Removed Features:
|
||||
- **UltraHot** (core/front/tiny_ultra_hot.h - removed bcfb4f6b5)
|
||||
- **RingCache** (core/front/tiny_ring_cache.* - removed bcfb4f6b5)
|
||||
- **FrontC23** (core/front/tiny_front_c23.h - removed bcfb4f6b5)
|
||||
- **Class5 Hotpath** (removed bcfb4f6b5)
|
||||
|
||||
### ENV Variables (18 vars, SAFE TO DELETE):
|
||||
|
||||
**No references found in current codebase** - these can be removed immediately:
|
||||
|
||||
```
|
||||
HAKMEM_TINY_ULTRA_HOT ✅ Removed
|
||||
HAKMEM_TINY_ULTRA_HOT_MAX_SIZE ✅ Removed
|
||||
HAKMEM_TINY_ULTRA_HOT_STATS ✅ Removed
|
||||
HAKMEM_TINY_HOT_RING_ENABLE ✅ Removed
|
||||
HAKMEM_TINY_HOT_RING_C2 ✅ Removed
|
||||
HAKMEM_TINY_HOT_RING_C3 ✅ Removed
|
||||
HAKMEM_TINY_HOT_RING_C5 ✅ Removed
|
||||
HAKMEM_TINY_HOT_RING_CASCADE ✅ Removed
|
||||
HAKMEM_TINY_FRONT_C23 ✅ Removed
|
||||
HAKMEM_TINY_CLASS5_HOTPATH ✅ Removed
|
||||
HAKMEM_TINY_CLASS5_STATS_DUMP ✅ Removed
|
||||
```
|
||||
|
||||
**RESULT**: No cleanup needed - already removed! ✅
|
||||
|
||||
---
|
||||
|
||||
## Priority 2: Features Still Compiled But Possibly Unused
|
||||
|
||||
These features exist as files and are compiled into binaries, but may be disabled by default or experimental:
|
||||
|
||||
### 2A. SFC (Shared Frontend Cache) - ⚠️ **ACTIVE** (Default: ON)
|
||||
|
||||
**Status**: ACTIVE and compiled into all binaries (hakmem_tiny_sfc.o)
|
||||
**Default**: `g_sfc_enabled = 1` (ON by default!)
|
||||
**Decision**: **KEEP** - This is an active optimization
|
||||
|
||||
**ENV Variables** (6 vars):
|
||||
```
|
||||
File: core/hakmem_tiny_sfc.c
|
||||
- Line 51: getenv("HAKMEM_SFC_ENABLE") # A/B toggle
|
||||
- Line 62: getenv("HAKMEM_SFC_CAPACITY") # Tuning
|
||||
- Line 71: getenv("HAKMEM_SFC_REFILL_COUNT") # Tuning
|
||||
- Line 123: getenv("HAKMEM_SFC_DEBUG") # Debug
|
||||
- Line 144: getenv("HAKMEM_SFC_STATS_DUMP") # Stats
|
||||
|
||||
File: core/tiny_alloc_fast.inc.h
|
||||
- Line 477: getenv("HAKMEM_SFC_CASCADE_PCT") # Advanced tuning
|
||||
|
||||
File: core/tiny_alloc_fast_sfc.inc.h
|
||||
- Line 114: getenv("HAKMEM_SFC_DEBUG") # Debug (duplicate)
|
||||
|
||||
File: core/tiny_free_fast.inc.h
|
||||
- Line 104: getenv("HAKMEM_SFC_DEBUG") # Debug (duplicate)
|
||||
|
||||
File: core/box/hak_wrappers.inc.h
|
||||
- Line 89: getenv("HAKMEM_SFC_DEBUG") # Debug (duplicate)
|
||||
```
|
||||
|
||||
**Action**: KEEP ALL (active feature)
|
||||
|
||||
---
|
||||
|
||||
### 2B. BG (Background System) - ⚠️ **PARTIALLY ACTIVE**
|
||||
|
||||
**Status**: Files exist, compiled in (hakmem_tiny_bg_spill.o, hakmem_batch.o)
|
||||
**Default**: `g_bg_enabled = 1` in hakmem_batch.c
|
||||
**Compiled**: YES (hakmem_batch.o, hakmem_tiny_bg_spill.o in OBJS_BASE)
|
||||
|
||||
**ENV Variables** (5+ vars):
|
||||
```
|
||||
File: core/hakmem_batch.c
|
||||
- Line 73: getenv("HAKMEM_BATCH_BG") # Enable/disable
|
||||
|
||||
File: core/hakmem_l25_pool.c (L25 BG drain)
|
||||
- Line 741: getenv("HAKMEM_L25_BG_DRAIN") # L25 specific
|
||||
- Line 743: getenv("HAKMEM_L25_BG_MS") # Interval
|
||||
|
||||
File: core/hakmem_tiny_remote_target.c
|
||||
- HAKMEM_TINY_BG_REMOTE (referenced in comments, no getenv found)
|
||||
- HAKMEM_TINY_BG_REMOTE_BATCH (referenced in comments)
|
||||
```
|
||||
|
||||
**Action**: VERIFY with user - if BG system is deprecated, can remove 5 vars
|
||||
|
||||
---
|
||||
|
||||
### 2C. TC (Thread Cache for L25/MidPool) - ⚠️ **ACTIVE**
|
||||
|
||||
**Status**: ACTIVE for Pool/L25 allocations
|
||||
**Compiled**: YES (part of hakmem_l25_pool.o, mid_tcache.h)
|
||||
**Default**: Enabled in some paths
|
||||
|
||||
**ENV Variables** (10 vars):
|
||||
```
|
||||
File: core/hakmem_l25_pool.c (L25 Pool TC)
|
||||
- Line 737: getenv("HAKMEM_L25_TC_SPILL") # Spill threshold
|
||||
- Line 739: getenv("HAKMEM_L25_TC_CAP") # TC capacity
|
||||
|
||||
File: core/mid_tcache.h (Mid Pool TC)
|
||||
- Line 16: getenv("HAKMEM_MID_TC") # Enable
|
||||
- Line 25: getenv("HAKMEM_MID_TC_CAP") # Capacity
|
||||
|
||||
File: core/box/pool_init_api.inc.h (Generic TC)
|
||||
- Line 72: getenv("HAKMEM_TC_ENABLE") # Enable
|
||||
- Line 74: getenv("HAKMEM_TC_UNBOUNDED") # Mode
|
||||
- Line 76: getenv("HAKMEM_TC_DRAIN_MAX") # Drain max
|
||||
- Line 78: getenv("HAKMEM_TC_DRAIN_TRIGGER") # Drain trigger
|
||||
|
||||
File: core/hakmem_batch.c (Batch system)
|
||||
- HAKMEM_DISABLE_BATCH (referenced, may relate to TC)
|
||||
```
|
||||
|
||||
**Action**: KEEP - TC is active for Pool allocations
|
||||
|
||||
---
|
||||
|
||||
### 2D. Ultra Features - ⚠️ **EXPERIMENTAL/GATED**
|
||||
|
||||
**Status**: Files exist but ENV-gated (disabled by default)
|
||||
**Compiled**: Files exist but likely inactive
|
||||
**Default**: Disabled/experimental
|
||||
|
||||
**ENV Variables** (8 vars):
|
||||
```
|
||||
File: core/front/tiny_ultrafront.h
|
||||
- getenv("HAKMEM_TINY_ULTRA_FRONT") # UltraFront variant
|
||||
|
||||
File: core/ultra/tiny_ultra_heap.c
|
||||
- getenv("HAKMEM_TINY_ULTRA_L0") # Ultra L0 layer
|
||||
- getenv("HAKMEM_TINY_ULTRA_HEAP_DUMP") # Debug dump
|
||||
|
||||
File: core/ultra/tiny_ultra_page_arena.c
|
||||
- getenv("HAKMEM_TINY_ULTRA_PAGE_DUMP") # Debug dump
|
||||
|
||||
File: core/box/ultra_slim_alloc_box.h
|
||||
- getenv("HAKMEM_TINY_ULTRA_SLIM") # UltraSlim mode
|
||||
- getenv("HAKMEM_ULTRA_SLIM_STATS") # Stats
|
||||
|
||||
File: core/box/hak_core_init.inc.h
|
||||
- getenv("HAKMEM_TINY_ULTRA_DEBUG") # Debug
|
||||
```
|
||||
|
||||
**Action**: VERIFY - if Ultra features are experimental/unused, mark as deprecated
|
||||
|
||||
---
|
||||
|
||||
### 2E. Frontend V2/Heap V2 - ⚠️ **POSSIBLY OBSOLETE**
|
||||
|
||||
**Status**: ENV vars exist but feature may be replaced
|
||||
**Compiled**: Part of frontend code
|
||||
|
||||
**ENV Variables** (7 vars):
|
||||
```
|
||||
File: core/front/tiny_heap_v2.h
|
||||
- getenv("HAKMEM_TINY_HEAP_V2_CLASS_MASK") # Class mask
|
||||
- getenv("HAKMEM_TINY_HEAP_V2_LEFTOVER_MODE") # Leftover mode
|
||||
- getenv("HAKMEM_TINY_HEAP_V2_DEBUG") # Debug
|
||||
|
||||
File: core/tiny_alloc_fast.inc.h
|
||||
- getenv("HAKMEM_TINY_HEAP_V2_STATS") # Stats
|
||||
|
||||
File: core/box/front_metrics_box.h
|
||||
- getenv("HAKMEM_TINY_FRONT_DISABLE_HEAPV2") # Disable toggle
|
||||
|
||||
File: core/tiny_alloc_fast.inc.h
|
||||
- getenv("HAKMEM_TINY_FRONT_V2") # Front V2 enable
|
||||
- getenv("HAKMEM_TINY_FRONT_SLIM") # Slim variant
|
||||
- getenv("HAKMEM_TINY_FRONT_DIRECT") # Direct mode
|
||||
- getenv("HAKMEM_TINY_FRONT_METRICS") # Metrics
|
||||
- getenv("HAKMEM_TINY_FRONT_DUMP") # Dump
|
||||
- getenv("HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT") # UltraHot (obsolete?)
|
||||
```
|
||||
|
||||
**Action**: VERIFY - Heap V2 status with user
|
||||
|
||||
---
|
||||
|
||||
### 2F. Ring/SLL Features - ⚠️ **MIXED STATUS**
|
||||
|
||||
**Status**: Some ring vars still in use (L25 TLS ring), others removed
|
||||
**Compiled**: Mixed
|
||||
|
||||
**ENV Variables** (6 vars):
|
||||
```
|
||||
File: core/hakmem_l25_pool.c (ACTIVE - L25 TLS ring)
|
||||
- Line 718: getenv("HAKMEM_POOL_TLS_RING") # ✅ ACTIVE
|
||||
- Line 724: getenv("HAKMEM_RING_RETURN_DIV") # ✅ ACTIVE
|
||||
- Line 745: getenv("HAKMEM_L25_RING_TRIGGER") # ✅ ACTIVE
|
||||
|
||||
File: core/box/pool_init_api.inc.h (ACTIVE)
|
||||
- getenv("HAKMEM_POOL_TLS_RING") # ✅ ACTIVE (duplicate)
|
||||
- getenv("HAKMEM_RING_RETURN_DIV") # ✅ ACTIVE (duplicate)
|
||||
|
||||
File: core/box/tls_sll_box.h (SLL ring - may be different)
|
||||
- Line 115: getenv("HAKMEM_TINY_SLL_RING") # SLL variant ring
|
||||
|
||||
File: core/tiny_debug_ring.c (Debug ring)
|
||||
- getenv("HAKMEM_TINY_TRACE_RING") # Debug trace
|
||||
- getenv("HAKMEM_TINY_DUMP_RING_ATEXIT") # Dump at exit
|
||||
```
|
||||
|
||||
**Action**:
|
||||
- KEEP: HAKMEM_POOL_TLS_RING, HAKMEM_RING_RETURN_DIV, HAKMEM_L25_RING_TRIGGER (L25 active)
|
||||
- VERIFY: HAKMEM_TINY_SLL_RING, HAKMEM_TINY_TRACE_RING, HAKMEM_TINY_DUMP_RING_ATEXIT
|
||||
|
||||
---
|
||||
|
||||
### 2G. HotMag / SmallMag - ⚠️ **FILE EXISTS, STATUS UNCLEAR**
|
||||
|
||||
**Status**: File exists (core/hakmem_tiny_hotmag.inc.h) but no active ENV refs
|
||||
**Compiled**: Likely included but no dedicated .o file
|
||||
|
||||
**ENV Variables** (1 var):
|
||||
```
|
||||
File: core/hakmem_tiny_smallmag.inc.h
|
||||
- getenv("HAKMEM_TINY_SMALL_MAG") # Enable SmallMag
|
||||
```
|
||||
|
||||
**Action**: VERIFY - check if HotMag/SmallMag are used or obsolete
|
||||
|
||||
---
|
||||
|
||||
### 2H. BigCache - ✅ **ACTIVE**
|
||||
|
||||
**Status**: ACTIVE and compiled (hakmem_bigcache.o)
|
||||
**Compiled**: YES (hakmem_bigcache.o in OBJS_BASE)
|
||||
|
||||
**ENV Variables** (1 var):
|
||||
```
|
||||
File: core/box/hak_free_api.inc.h
|
||||
- getenv("HAKMEM_BIGCACHE_L25") # Enable BigCache for L25
|
||||
```
|
||||
|
||||
**Action**: KEEP - BigCache is active
|
||||
|
||||
---
|
||||
|
||||
## Priority 3: Verification Needed
|
||||
|
||||
These ENV variables need user/maintainer input:
|
||||
|
||||
### 3A. Experimental Features (Gated by ENV, Default OFF)
|
||||
|
||||
**Need decision**: Keep for experiments or remove?
|
||||
|
||||
```
|
||||
HAKMEM_TINY_ULTRA_FRONT # UltraFront experiment
|
||||
HAKMEM_TINY_ULTRA_L0 # Ultra L0 layer
|
||||
HAKMEM_TINY_ULTRA_SLIM # UltraSlim mode
|
||||
HAKMEM_TINY_HEAP_V2_* # Heap V2 features (4 vars)
|
||||
HAKMEM_TINY_FRONT_V2 # Frontend V2
|
||||
HAKMEM_TINY_FRONT_SLIM # Frontend Slim
|
||||
HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT # UltraHot toggle (feature removed!)
|
||||
```
|
||||
|
||||
### 3B. Debug/Stats Variables
|
||||
|
||||
**Keep for debugging or remove?**
|
||||
|
||||
```
|
||||
HAKMEM_SFC_DEBUG # SFC debug (4 duplicate locations!)
|
||||
HAKMEM_TINY_ULTRA_DEBUG # Ultra debug
|
||||
HAKMEM_TINY_ULTRA_HEAP_DUMP # Ultra heap dump
|
||||
HAKMEM_TINY_ULTRA_PAGE_DUMP # Ultra page dump
|
||||
HAKMEM_ULTRA_SLIM_STATS # UltraSlim stats
|
||||
HAKMEM_TINY_HEAP_V2_DEBUG # Heap V2 debug
|
||||
HAKMEM_TINY_FRONT_METRICS # Front metrics
|
||||
HAKMEM_TINY_FRONT_DUMP # Front dump
|
||||
HAKMEM_TINY_TRACE_RING # Debug ring trace
|
||||
HAKMEM_TINY_DUMP_RING_ATEXIT # Dump ring at exit
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Execution Plan
|
||||
|
||||
### Phase 1: Remove Duplicate/Dead Code (Immediate)
|
||||
|
||||
**NO ACTION NEEDED** - Already cleaned in bcfb4f6b5 and 225b6fcc7 ✅
|
||||
|
||||
### Phase 2: Consolidate Duplicate Debug Checks (Low Risk)
|
||||
|
||||
**File**: core/tiny_alloc_fast_sfc.inc.h, core/tiny_free_fast.inc.h, core/box/hak_wrappers.inc.h
|
||||
|
||||
**Problem**: `getenv("HAKMEM_SFC_DEBUG")` called 4 times in different files
|
||||
|
||||
**Fix**: Create single global `g_sfc_debug` variable, set once in `sfc_init()`
|
||||
|
||||
**Lines to modify**:
|
||||
- core/hakmem_tiny_sfc.c:123 - Keep this one (in init)
|
||||
- core/tiny_alloc_fast_sfc.inc.h:114 - Change to `extern int g_sfc_debug`
|
||||
- core/tiny_free_fast.inc.h:104 - Change to `extern int g_sfc_debug`
|
||||
- core/box/hak_wrappers.inc.h:89 - Change to `extern int g_sfc_debug`
|
||||
|
||||
**Impact**: Reduces 3 getenv() calls per debug check to 1 at init
|
||||
|
||||
### Phase 3: Verify Experimental Features (Needs Input)
|
||||
|
||||
**Questions for user/maintainer**:
|
||||
|
||||
1. **Ultra features** - Are these experiments still active?
|
||||
- HAKMEM_TINY_ULTRA_FRONT
|
||||
- HAKMEM_TINY_ULTRA_L0
|
||||
- HAKMEM_TINY_ULTRA_SLIM
|
||||
- HAKMEM_ULTRA_SLIM_STATS
|
||||
|
||||
2. **Heap V2** - Is this still used or replaced?
|
||||
- HAKMEM_TINY_HEAP_V2_* (4 vars)
|
||||
|
||||
3. **Frontend variants** - Which are active?
|
||||
- HAKMEM_TINY_FRONT_V2
|
||||
- HAKMEM_TINY_FRONT_SLIM
|
||||
- HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT (should remove - UltraHot deleted!)
|
||||
|
||||
4. **BG system** - Still needed?
|
||||
- HAKMEM_BATCH_BG
|
||||
- HAKMEM_L25_BG_DRAIN
|
||||
- HAKMEM_L25_BG_MS
|
||||
|
||||
5. **HotMag/SmallMag** - Used or obsolete?
|
||||
- HAKMEM_TINY_SMALL_MAG
|
||||
|
||||
### Phase 4: Mark Deprecated (If Removing)
|
||||
|
||||
Add to documentation:
|
||||
```
|
||||
## Deprecated ENV Variables (Removed in vX.X)
|
||||
|
||||
The following ENV variables are deprecated and no longer have any effect:
|
||||
- HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT (feature removed in bcfb4f6b5)
|
||||
- [Add others after verification]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Summary Table
|
||||
|
||||
| Category | Total Vars | Status | Action |
|
||||
|----------|------------|--------|--------|
|
||||
| Already Removed | 11 | ✅ Clean | None |
|
||||
| SFC (Active) | 6 | ✅ Keep | Deduplicate debug |
|
||||
| BG System | 5 | ⚠️ Verify | Need input |
|
||||
| TC (Thread Cache) | 10 | ✅ Keep | None |
|
||||
| Ultra Features | 8 | ⚠️ Verify | Need input |
|
||||
| Heap V2 | 7 | ⚠️ Verify | Need input |
|
||||
| Ring/SLL | 6 | 🟡 Mixed | Keep L25, verify Tiny |
|
||||
| HotMag/SmallMag | 1 | ⚠️ Verify | Need input |
|
||||
| BigCache | 1 | ✅ Keep | None |
|
||||
| **TOTAL** | **55** | | |
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **User decision needed**: Verify experimental features (Phase 3 questions)
|
||||
2. **Quick win**: Deduplicate SFC_DEBUG checks (Phase 2)
|
||||
3. **Documentation**: Mark deprecated vars
|
||||
4. **Testing**: Ensure no ENV var removal breaks existing users
|
||||
5. **Gradual removal**: Deprecate → warn → remove (3-release cycle)
|
||||
|
||||
---
|
||||
|
||||
## Files Requiring Modification
|
||||
|
||||
### Immediate Changes (Phase 2 - SFC Debug Deduplication):
|
||||
- core/hakmem_tiny_sfc.c (add global)
|
||||
- core/tiny_alloc_fast_sfc.inc.h (change to extern)
|
||||
- core/tiny_free_fast.inc.h (change to extern)
|
||||
- core/box/hak_wrappers.inc.h (change to extern)
|
||||
|
||||
### Pending Verification (Phase 3):
|
||||
- core/front/tiny_ultrafront.h
|
||||
- core/front/tiny_heap_v2.h
|
||||
- core/ultra/tiny_ultra_heap.c
|
||||
- core/ultra/tiny_ultra_page_arena.c
|
||||
- core/box/ultra_slim_alloc_box.h
|
||||
- core/hakmem_batch.c
|
||||
- core/hakmem_l25_pool.c
|
||||
- core/hakmem_tiny_smallmag.inc.h
|
||||
- core/tiny_alloc_fast.inc.h
|
||||
- core/box/front_metrics_box.h
|
||||
|
||||
**Total files**: ~14 files need review/modification
|
||||
|
||||
---
|
||||
|
||||
## Risk Assessment
|
||||
|
||||
- **Phase 1**: ✅ Zero risk (already done)
|
||||
- **Phase 2**: 🟢 Low risk (internal optimization, no behavior change)
|
||||
- **Phase 3**: 🟡 Medium risk (need verification, user-facing)
|
||||
- **Phase 4**: 🔴 High risk (breaking change, needs deprecation cycle)
|
||||
|
||||
**Recommendation**: Start with Phase 2 (safe), then get user input for Phase 3.
|
||||
92
docs/analysis/ENV_CLEANUP_SUMMARY.md
Normal file
92
docs/analysis/ENV_CLEANUP_SUMMARY.md
Normal file
@ -0,0 +1,92 @@
|
||||
# ENV Variable Cleanup Analysis - Executive Summary
|
||||
|
||||
## Key Findings
|
||||
|
||||
### Good News: Most "Obsolete" Features Already Cleaned! ✅
|
||||
|
||||
The major obsolete features (UltraHot, RingCache, FrontC23, Class5) were **already removed** in commits:
|
||||
- bcfb4f6b5: "Remove dead code: UltraHot, RingCache, FrontC23, Class5 Hotpath"
|
||||
- 225b6fcc7: Duplicate cleanup commit
|
||||
- a9ddb52ad: "ENV cleanup: Remove BG/HotMag vars"
|
||||
|
||||
All 11 ENV variables for these features are **already gone from the codebase** ✅
|
||||
|
||||
### Surprise Finding: SFC is ACTIVE (Not Obsolete!)
|
||||
|
||||
**SFC (Shared Frontend Cache)** was listed as "obsolete" but analysis shows:
|
||||
- ✅ Compiled in all binaries (hakmem_tiny_sfc.o)
|
||||
- ✅ Default: `g_sfc_enabled = 1` (ON by default)
|
||||
- ✅ Active optimization with 6 ENV vars
|
||||
- **Action**: KEEP all SFC vars
|
||||
|
||||
### Actual Cleanup Opportunities
|
||||
|
||||
**54 potentially obsolete vars** break down as:
|
||||
- 11 vars: Already removed ✅
|
||||
- 16 vars: Active features (SFC, TC, BigCache) - KEEP ✅
|
||||
- 6 vars: Active L25 TLS ring - KEEP ✅
|
||||
- **21 vars: Need verification** ⚠️
|
||||
|
||||
## Priority 1: Quick Wins (No Risk)
|
||||
|
||||
### SFC Debug Deduplication
|
||||
**Problem**: `getenv("HAKMEM_SFC_DEBUG")` called 4x in different files
|
||||
**Fix**: Single global variable, set once at init
|
||||
**Savings**: -3 getenv() calls per debug check
|
||||
**Risk**: Zero
|
||||
**Files**: 4 files, ~8 lines total
|
||||
|
||||
## Priority 2: Verification Needed (21 vars)
|
||||
|
||||
| Feature | Vars | Status | Question |
|
||||
|---------|------|--------|----------|
|
||||
| Ultra features | 8 | Gated/experimental | Still needed? |
|
||||
| Heap V2 | 7 | Unknown | Active or replaced? |
|
||||
| BG System | 5 | Partially active | Keep or deprecate? |
|
||||
| HotMag/SmallMag | 1 | File exists | Used or obsolete? |
|
||||
|
||||
## Priority 3: Deprecation Candidates
|
||||
|
||||
**IF verification confirms obsolete** (needs user input):
|
||||
|
||||
```
|
||||
HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT # UltraHot removed in bcfb4f6b5!
|
||||
HAKMEM_TINY_ULTRA_* (if unused) # 8 vars
|
||||
HAKMEM_TINY_HEAP_V2_* (if replaced) # 7 vars
|
||||
HAKMEM_BATCH_BG (if deprecated) # 5 vars
|
||||
```
|
||||
|
||||
**Total potential**: Up to 21 vars (after verification)
|
||||
|
||||
## Recommended Action Plan
|
||||
|
||||
### Immediate (This Week)
|
||||
1. ✅ Deduplicate SFC_DEBUG (4 files, low risk)
|
||||
2. ✅ Remove HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT (UltraHot deleted!)
|
||||
|
||||
### Short Term (Next Sprint)
|
||||
3. ⚠️ Verify Ultra features with maintainers
|
||||
4. ⚠️ Verify Heap V2 status
|
||||
5. ⚠️ Verify BG system usage
|
||||
6. ⚠️ Verify HotMag/SmallMag
|
||||
|
||||
### Long Term (Next Release)
|
||||
7. 📝 Mark deprecated vars in documentation
|
||||
8. 🔔 Add runtime warnings for deprecated vars
|
||||
9. 🗑️ Remove after deprecation cycle (3 releases)
|
||||
|
||||
## Impact Assessment
|
||||
|
||||
**Current state**: 221 ENV vars
|
||||
**Safe to remove now**: 1 var (ULTRAHOT toggle)
|
||||
**After verification**: Up to 21 vars (if all experimental features unused)
|
||||
**Best case reduction**: ~10% (-22 vars)
|
||||
|
||||
## Detailed Plan
|
||||
|
||||
See `ENV_CLEANUP_PLAN.md` for:
|
||||
- File-by-file breakdown
|
||||
- Line numbers for all getenv() calls
|
||||
- Priority ordering
|
||||
- Risk assessment
|
||||
- Verification questions
|
||||
496
docs/analysis/ENV_CONSOLIDATION_PLAN.md
Normal file
496
docs/analysis/ENV_CONSOLIDATION_PLAN.md
Normal file
@ -0,0 +1,496 @@
|
||||
# HAKMEM ENV Variable Consolidation - Detailed Mapping
|
||||
|
||||
## OBSOLETE Variables - Complete List (54 vars)
|
||||
|
||||
### BG (Background) System - 11 vars
|
||||
```
|
||||
HAKMEM_BATCH_BG
|
||||
HAKMEM_L25_BG_DRAIN
|
||||
HAKMEM_L25_BG_MS
|
||||
```
|
||||
|
||||
### SFC (Shared Frontend Cache) - 7 vars
|
||||
```
|
||||
HAKMEM_SFC_CAPACITY
|
||||
HAKMEM_SFC_CASCADE_PCT
|
||||
HAKMEM_SFC_DEBUG
|
||||
HAKMEM_SFC_ENABLE
|
||||
HAKMEM_SFC_REFILL_COUNT
|
||||
HAKMEM_SFC_STATS_DUMP
|
||||
HAKMEM_TINY_SFC_CASCADE
|
||||
```
|
||||
|
||||
### HotMag/Ultra/Quick Caches - 12 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_SLIM
|
||||
HAKMEM_TINY_ULTRA_VALIDATE
|
||||
HAKMEM_ULTRA_SLIM_STATS
|
||||
```
|
||||
|
||||
### Ring System - 7 vars
|
||||
```
|
||||
HAKMEM_L25_RING_TRIGGER
|
||||
HAKMEM_POOL_TLS_RING
|
||||
HAKMEM_RING_RETURN_DIV
|
||||
HAKMEM_TINY_ALLOC_RING
|
||||
HAKMEM_TINY_DUMP_RING_ATEXIT
|
||||
HAKMEM_TINY_SLL_RING
|
||||
HAKMEM_TINY_TRACE_RING
|
||||
```
|
||||
|
||||
### Thread Cache (TC) - 4 vars
|
||||
```
|
||||
```
|
||||
|
||||
### BigCache/L25 Experiments - 7 vars
|
||||
```
|
||||
HAKMEM_BIGCACHE_L25
|
||||
HAKMEM_DISABLE_BIGCACHE
|
||||
HAKMEM_L25_BG_DRAIN
|
||||
HAKMEM_L25_BG_MS
|
||||
HAKMEM_L25_RING_TRIGGER
|
||||
HAKMEM_L25_TC_CAP
|
||||
HAKMEM_L25_TC_SPILL
|
||||
```
|
||||
|
||||
### Frontend Experiments - 13 vars
|
||||
```
|
||||
HAKMEM_TINY_FASTCACHE
|
||||
HAKMEM_TINY_FRONTEND
|
||||
HAKMEM_TINY_FRONT_DISABLE_HEAPV2
|
||||
HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT
|
||||
HAKMEM_TINY_FRONT_SLIM
|
||||
HAKMEM_TINY_FRONT_V2
|
||||
HAKMEM_TINY_HEAP_V2_CLASS_MASK
|
||||
HAKMEM_TINY_HEAP_V2_DEBUG
|
||||
HAKMEM_TINY_HEAP_V2_LEFTOVER_MODE
|
||||
HAKMEM_TINY_HEAP_V2_STATS
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## DEBUG Variables - Complete List (59 vars)
|
||||
|
||||
### Tracing - 16 vars
|
||||
```
|
||||
HAKMEM_FREE_ROUTE_TRACE
|
||||
HAKMEM_FREE_WRAP_TRACE
|
||||
HAKMEM_PTR_TRACE_DUMP
|
||||
HAKMEM_PTR_TRACE_VERBOSE
|
||||
HAKMEM_SUPER_REG_REQTRACE
|
||||
HAKMEM_TINY_MAILBOX_TRACE
|
||||
HAKMEM_TINY_MAILBOX_TRACE_LIMIT
|
||||
HAKMEM_TINY_RF_TRACE
|
||||
HAKMEM_TINY_SUPERSLAB_TRACE
|
||||
HAKMEM_TINY_TRACE_RING
|
||||
```
|
||||
|
||||
### Logging - 8 vars
|
||||
```
|
||||
HAKMEM_ADAPTIVE_LOG
|
||||
HAKMEM_EXTERNAL_GUARD_LOG
|
||||
HAKMEM_INVALID_FREE_LOG
|
||||
HAKMEM_LOG_FILE
|
||||
HAKMEM_PTR_TRACE_VERBOSE
|
||||
HAKMEM_VERBOSE
|
||||
```
|
||||
|
||||
### Stats/Profiling - 16 vars
|
||||
```
|
||||
HAKMEM_EXTERNAL_GUARD_STATS
|
||||
HAKMEM_POOL_COUNT_SAMPLE
|
||||
HAKMEM_PROF_SAMPLE
|
||||
HAKMEM_SFC_STATS_DUMP
|
||||
HAKMEM_SHARED_POOL_LOCK_STATS
|
||||
HAKMEM_SHARED_POOL_STAGE_STATS
|
||||
HAKMEM_TINY_ALLOC_1024_METRIC
|
||||
HAKMEM_TINY_COUNT_SAMPLE
|
||||
HAKMEM_TINY_FAST_STATS
|
||||
HAKMEM_TINY_FRONT_METRICS
|
||||
HAKMEM_TINY_HEAP_V2_STATS
|
||||
HAKMEM_ULTRA_SLIM_STATS
|
||||
```
|
||||
|
||||
### Debug/Observe - 19 vars
|
||||
```
|
||||
HAKMEM_ACE_DEBUG
|
||||
HAKMEM_ACE_OBSERVE
|
||||
HAKMEM_DEBUG_SEGV
|
||||
HAKMEM_PTR_TRACE_DUMP
|
||||
HAKMEM_SFC_DEBUG
|
||||
HAKMEM_SFC_STATS_DUMP
|
||||
HAKMEM_SS_ACQUIRE_DEBUG
|
||||
HAKMEM_SS_FREE_DEBUG
|
||||
HAKMEM_SS_LRU_DEBUG
|
||||
HAKMEM_SS_PREWARM_DEBUG
|
||||
HAKMEM_SUPER_LOOKUP_DEBUG
|
||||
HAKMEM_SUPER_REG_DEBUG
|
||||
HAKMEM_TINY_ALLOC_DEBUG
|
||||
HAKMEM_TINY_COUNTERS_DUMP
|
||||
HAKMEM_TINY_DEBUG_FAST0
|
||||
HAKMEM_TINY_DEBUG_REMOTE_GUARD
|
||||
HAKMEM_TINY_DUMP_ATEXIT_ONLY
|
||||
HAKMEM_TINY_DUMP_RING_ATEXIT
|
||||
HAKMEM_TINY_FAST_DEBUG
|
||||
HAKMEM_TINY_FAST_DEBUG_MAX
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## POLICY Variables - Consolidation Proposals
|
||||
|
||||
### Proposal 1: Refill Parameters
|
||||
|
||||
**Remove (18 vars)**:
|
||||
```
|
||||
HAKMEM_INT_ADAPT_REFILL
|
||||
HAKMEM_SFC_REFILL_COUNT
|
||||
HAKMEM_TINY_MID_REFILL_SIMPLE
|
||||
HAKMEM_TINY_REFILL_COUNT
|
||||
HAKMEM_TINY_REFILL_COUNT_HOT
|
||||
HAKMEM_TINY_REFILL_COUNT_MID
|
||||
HAKMEM_TINY_REFILL_DUMP
|
||||
HAKMEM_TINY_REFILL_FAILFAST
|
||||
HAKMEM_TINY_REFILL_MAX
|
||||
HAKMEM_TINY_REFILL_MAX_HOT
|
||||
HAKMEM_TINY_REFILL_ONE_ON_MISS
|
||||
HAKMEM_TINY_REFILL_OPT_DEBUG
|
||||
HAKMEM_WRAP_TINY_REFILL
|
||||
```
|
||||
|
||||
**Replace with (3 vars)**:
|
||||
```
|
||||
HAKMEM_REFILL_BATCH=64 # Default refill batch size
|
||||
HAKMEM_REFILL_HOT_BATCH=192 # Hot class (C0-C3) batch size
|
||||
HAKMEM_REFILL_MAX=1024 # Maximum refill per operation
|
||||
```
|
||||
|
||||
### Proposal 2: Capacity Limits
|
||||
|
||||
**Remove (30+ vars including per-class)**:
|
||||
```
|
||||
HAKMEM_CAP_LARGE
|
||||
HAKMEM_CAP_MID
|
||||
HAKMEM_CAP_MID_DYN1
|
||||
HAKMEM_CAP_MID_DYN2
|
||||
HAKMEM_L25_MIN_BUNDLE
|
||||
HAKMEM_MF2_MAX_QUEUES
|
||||
HAKMEM_POOL_MIN_BUNDLE
|
||||
HAKMEM_SUPERSLAB_MAX_CACHED
|
||||
HAKMEM_SUPERSLAB_MAX_MEMORY_MB
|
||||
HAKMEM_TINY_MAG_CAP
|
||||
HAKMEM_TINY_MAX_CLASS
|
||||
HAKMEM_TINY_REFILL_MAX_HOT
|
||||
HAKMEM_TINY_SS_MAX_MB
|
||||
HAKMEM_TINY_SS_MIN_MB
|
||||
...(30+ total)
|
||||
```
|
||||
|
||||
**Replace with (6 vars)**:
|
||||
```
|
||||
HAKMEM_CACHE_PRESET=small|medium|large|custom # Global preset
|
||||
HAKMEM_TINY_CACHE_SLOTS=512 # TLS cache capacity (if custom)
|
||||
HAKMEM_MID_CACHE_SLOTS=128 # Mid-tier cache (if custom)
|
||||
HAKMEM_LARGE_CACHE_SLOTS=32 # Large-tier cache (if custom)
|
||||
HAKMEM_SS_MEMORY_LIMIT_MB=512 # SuperSlab memory cap
|
||||
HAKMEM_POOL_MEMORY_LIMIT_MB=256 # Pool memory cap
|
||||
```
|
||||
|
||||
**Presets**:
|
||||
```
|
||||
small: Tiny=256, Mid=64, Large=16, SS=256MB, Pool=128MB
|
||||
medium: Tiny=512, Mid=128, Large=32, SS=512MB, Pool=256MB (default)
|
||||
large: Tiny=1024, Mid=256, Large=64, SS=1024MB, Pool=512MB
|
||||
custom: Use individual *_SLOTS/*_LIMIT_MB vars
|
||||
```
|
||||
|
||||
### Proposal 3: Learning/Adaptation Systems
|
||||
|
||||
**Remove (35 vars)**:
|
||||
```
|
||||
HAKMEM_ACE_DEBUG
|
||||
HAKMEM_ACE_ENABLED
|
||||
HAKMEM_ACE_OBSERVE
|
||||
HAKMEM_ACE_PROFILE
|
||||
HAKMEM_ACE_SAMPLE
|
||||
HAKMEM_ADAPTIVE_LOG
|
||||
HAKMEM_ADAPTIVE_SIZING
|
||||
HAKMEM_CAP_MID_DYN1
|
||||
HAKMEM_CAP_MID_DYN2
|
||||
HAKMEM_DISABLE_ELO
|
||||
HAKMEM_DYN1_AUTO
|
||||
HAKMEM_DYN2_AUTO
|
||||
HAKMEM_HOT_SLOT
|
||||
HAKMEM_INT_ADAPT_CAPS
|
||||
HAKMEM_INT_ADAPT_REFILL
|
||||
HAKMEM_INT_ENGINE
|
||||
HAKMEM_INT_EVENT_TS
|
||||
HAKMEM_INT_SAMPLE
|
||||
HAKMEM_LEARN
|
||||
HAKMEM_LEARN_SAMPLE
|
||||
HAKMEM_MID_DYN1
|
||||
HAKMEM_MID_DYN2
|
||||
HAKMEM_PTR_TRACE_DUMP
|
||||
HAKMEM_PTR_TRACE_VERBOSE
|
||||
HAKMEM_THP_LEARN
|
||||
...(35 total)
|
||||
```
|
||||
|
||||
**Replace with (8 vars)**:
|
||||
```
|
||||
HAKMEM_ADAPTIVE_MODE=off|observe|active # Master switch
|
||||
HAKMEM_ADAPTIVE_TARGETS=caps,refill,wmax,thp # Comma-separated targets
|
||||
HAKMEM_ADAPTIVE_INTERVAL_MS=1000 # Update interval
|
||||
HAKMEM_ADAPTIVE_AGGRESSIVENESS=0.1 # Learning rate (0.0-1.0)
|
||||
HAKMEM_ADAPTIVE_MIN_CHANGE_PCT=5 # Minimum % change to apply
|
||||
HAKMEM_THP_POLICY=off|auto|on # THP policy
|
||||
HAKMEM_WMAX_MID_KB=256 # Mid-tier working set
|
||||
HAKMEM_WMAX_LARGE_KB=2048 # Large-tier working set
|
||||
```
|
||||
|
||||
### Proposal 4: Drain/Threshold Parameters
|
||||
|
||||
**Remove (20 vars)**:
|
||||
```
|
||||
HAKMEM_L25_BG_DRAIN
|
||||
HAKMEM_L25_RING_TRIGGER
|
||||
HAKMEM_MF2_IDLE_THRESHOLD_US
|
||||
HAKMEM_TC_DRAIN_MAX
|
||||
HAKMEM_TC_DRAIN_TRIGGER
|
||||
HAKMEM_TINY_DRAIN_TO_SLL
|
||||
HAKMEM_TINY_REMOTE_DRAIN_THRESHOLD
|
||||
HAKMEM_TINY_REMOTE_DRAIN_TRYRATE
|
||||
HAKMEM_TINY_SLL_DRAIN_DEBUG
|
||||
HAKMEM_TINY_SLL_DRAIN_ENABLE
|
||||
HAKMEM_TINY_SLL_DRAIN_INTERVAL
|
||||
HAKMEM_TINY_TENSION_DRAIN_ENABLE
|
||||
HAKMEM_TINY_TENSION_DRAIN_THRESHOLD
|
||||
```
|
||||
|
||||
**Replace with (5 vars)**:
|
||||
```
|
||||
HAKMEM_REMOTE_DRAIN_THRESHOLD=32 # Queue size to trigger drain
|
||||
HAKMEM_REMOTE_DRAIN_BATCH=16 # Items per drain operation
|
||||
HAKMEM_CACHE_SPILL_PCT=90 # % full to trigger spill
|
||||
HAKMEM_MEMORY_TRIM_INTERVAL_MS=1000 # Trim check interval
|
||||
HAKMEM_IDLE_TIMEOUT_MS=5000 # Idle detection timeout
|
||||
```
|
||||
|
||||
### Proposal 5: L25/Pool Configuration
|
||||
|
||||
**Remove (15 vars)**:
|
||||
```
|
||||
HAKMEM_L25_DZ
|
||||
HAKMEM_L25_INBOUND_SLOTS
|
||||
HAKMEM_L25_MIN_BUNDLE
|
||||
HAKMEM_L25_OWNER_INBOUND
|
||||
HAKMEM_L25_PREF
|
||||
HAKMEM_L25_REMOTE_SAFE
|
||||
HAKMEM_L25_RUN_BLOCKS
|
||||
HAKMEM_L25_RUN_FACTOR
|
||||
HAKMEM_MID_TC
|
||||
HAKMEM_POOL_MIN_BUNDLE
|
||||
HAKMEM_SHARED_POOL_LOCK_STATS
|
||||
HAKMEM_SHARED_POOL_STAGE_STATS
|
||||
```
|
||||
|
||||
**Replace with (5 vars)**:
|
||||
```
|
||||
HAKMEM_L25_SIZE_ZONES="64,256,1024" # Comma-separated size zones
|
||||
HAKMEM_L25_BUNDLE_SIZE=4 # Refill bundle size
|
||||
HAKMEM_MID_BUNDLE_SIZE=4 # Mid-tier bundle size
|
||||
HAKMEM_L25_RUN_BLOCKS=16 # Blocks per run
|
||||
HAKMEM_L25_RUN_FACTOR=2 # Run factor multiplier
|
||||
```
|
||||
|
||||
### Proposal 6: Misc Policy Variables
|
||||
|
||||
**Remove (36 vars)**:
|
||||
```
|
||||
HAKMEM_ACE_ENABLED
|
||||
HAKMEM_ALLOW_MALLOC_FALLBACK
|
||||
HAKMEM_BENCH_FAST_FRONT
|
||||
HAKMEM_BENCH_FAST_MODE
|
||||
HAKMEM_BENCH_TINY_ONLY
|
||||
HAKMEM_BIGCACHE_L25
|
||||
HAKMEM_DISABLE_BATCH
|
||||
HAKMEM_DISABLE_BIGCACHE
|
||||
HAKMEM_DISABLE_ELO
|
||||
HAKMEM_EXTERNAL_GUARD_LOG
|
||||
HAKMEM_EXTERNAL_GUARD_MINCORE
|
||||
HAKMEM_EXTERNAL_GUARD_STATS
|
||||
HAKMEM_FREE_POLICY
|
||||
HAKMEM_FREE_ROUTE_TRACE
|
||||
HAKMEM_HDR_LIGHT
|
||||
HAKMEM_INVALID_FREE
|
||||
HAKMEM_INVALID_FREE_LOG
|
||||
HAKMEM_L25_REMOTE_SAFE
|
||||
HAKMEM_L25_TC_SPILL
|
||||
HAKMEM_LD_BLOCK_JEMALLOC
|
||||
HAKMEM_LD_SAFE
|
||||
HAKMEM_MF2_ENABLE
|
||||
HAKMEM_MF2_IDLE_THRESHOLD_US
|
||||
HAKMEM_MF2_LEASE_MS
|
||||
HAKMEM_MF2_MAX_QUEUES
|
||||
HAKMEM_MODE
|
||||
HAKMEM_PAGE_ARENA_ENABLE
|
||||
HAKMEM_PRESET
|
||||
HAKMEM_ROUTE
|
||||
HAKMEM_ROUTE_SAMPLE_LG
|
||||
...(36 total)
|
||||
```
|
||||
|
||||
**Replace with (4 vars)**:
|
||||
```
|
||||
HAKMEM_MODE=fast|balanced|learning|minimal # High-level preset
|
||||
HAKMEM_FORCE_LIBC=0|1 # Force libc malloc fallback
|
||||
HAKMEM_THP_POLICY=off|auto|on # THP policy (from Proposal 3)
|
||||
HAKMEM_RSS_BUDGET_KB=unlimited # Total RSS budget
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Final 50 Variables (20 Essential + 30 Policy)
|
||||
|
||||
### Essential (20 vars)
|
||||
```
|
||||
# Core Features (8)
|
||||
HAKMEM_WRAP_TINY=1
|
||||
HAKMEM_TINY_USE_SUPERSLAB=1
|
||||
HAKMEM_TINY_TLS_SLL=1
|
||||
HAKMEM_TINY_FREE_FAST=1
|
||||
HAKMEM_TINY_UNIFIED_CACHE=1
|
||||
HAKMEM_SS_EMPTY_REUSE=1
|
||||
HAKMEM_FRONT_GATE_UNIFIED=1
|
||||
HAKMEM_POOL_TLS_FREE=1
|
||||
|
||||
# Pool TLS Arena (3)
|
||||
HAKMEM_POOL_TLS_ARENA_MB_INIT=1
|
||||
HAKMEM_POOL_TLS_ARENA_MB_MAX=8
|
||||
HAKMEM_POOL_TLS_ARENA_GROWTH_LEVELS=3
|
||||
|
||||
# Page Arena (5)
|
||||
HAKMEM_PAGE_ARENA_ENABLE=1
|
||||
HAKMEM_PAGE_ARENA_HOT_SIZE=...
|
||||
HAKMEM_PAGE_ARENA_WARM_64K=...
|
||||
HAKMEM_PAGE_ARENA_WARM_128K=...
|
||||
HAKMEM_PAGE_ARENA_WARM_2M=...
|
||||
|
||||
# Misc (4)
|
||||
HAKMEM_PREWARM_SUPERSLABS=1
|
||||
HAKMEM_TINY_PREWARM_ALL=1
|
||||
HAKMEM_WRAP_TINY_REFILL=1
|
||||
HAKMEM_SMALLMID_ENABLE=1
|
||||
```
|
||||
|
||||
### Policy (30 vars)
|
||||
```
|
||||
# Refill (3)
|
||||
HAKMEM_REFILL_BATCH=64
|
||||
HAKMEM_REFILL_HOT_BATCH=192
|
||||
HAKMEM_REFILL_MAX=1024
|
||||
|
||||
# Capacity (6)
|
||||
HAKMEM_CACHE_PRESET=medium
|
||||
HAKMEM_TINY_CACHE_SLOTS=512
|
||||
HAKMEM_MID_CACHE_SLOTS=128
|
||||
HAKMEM_LARGE_CACHE_SLOTS=32
|
||||
HAKMEM_SS_MEMORY_LIMIT_MB=512
|
||||
HAKMEM_POOL_MEMORY_LIMIT_MB=256
|
||||
|
||||
# Adaptive (8)
|
||||
HAKMEM_ADAPTIVE_MODE=off
|
||||
HAKMEM_ADAPTIVE_TARGETS=caps,refill,wmax
|
||||
HAKMEM_ADAPTIVE_INTERVAL_MS=1000
|
||||
HAKMEM_ADAPTIVE_AGGRESSIVENESS=0.1
|
||||
HAKMEM_ADAPTIVE_MIN_CHANGE_PCT=5
|
||||
HAKMEM_THP_POLICY=auto
|
||||
HAKMEM_WMAX_MID_KB=256
|
||||
HAKMEM_WMAX_LARGE_KB=2048
|
||||
|
||||
# Drain/Threshold (5)
|
||||
HAKMEM_REMOTE_DRAIN_THRESHOLD=32
|
||||
HAKMEM_REMOTE_DRAIN_BATCH=16
|
||||
HAKMEM_CACHE_SPILL_PCT=90
|
||||
HAKMEM_MEMORY_TRIM_INTERVAL_MS=1000
|
||||
HAKMEM_IDLE_TIMEOUT_MS=5000
|
||||
|
||||
# L25/Pool (5)
|
||||
HAKMEM_L25_SIZE_ZONES=64,256,1024
|
||||
HAKMEM_L25_BUNDLE_SIZE=4
|
||||
HAKMEM_MID_BUNDLE_SIZE=4
|
||||
HAKMEM_L25_RUN_BLOCKS=16
|
||||
HAKMEM_L25_RUN_FACTOR=2
|
||||
|
||||
# Global (3)
|
||||
HAKMEM_MODE=balanced
|
||||
HAKMEM_FORCE_LIBC=0
|
||||
HAKMEM_RSS_BUDGET_KB=unlimited
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Migration Guide Examples
|
||||
|
||||
### Example 1: Refill Migration
|
||||
```bash
|
||||
# OLD (18 vars)
|
||||
export HAKMEM_TINY_REFILL_MAX=64
|
||||
export HAKMEM_TINY_REFILL_MAX_HOT=192
|
||||
export HAKMEM_TINY_REFILL_COUNT=32
|
||||
export HAKMEM_TINY_REFILL_COUNT_HOT=96
|
||||
export HAKMEM_TINY_REFILL_COUNT_MID=48
|
||||
# ... 13 more ...
|
||||
|
||||
# NEW (3 vars)
|
||||
export HAKMEM_REFILL_BATCH=64 # Replaces *_COUNT
|
||||
export HAKMEM_REFILL_HOT_BATCH=192 # Replaces *_HOT
|
||||
export HAKMEM_REFILL_MAX=1024 # Replaces *_MAX
|
||||
```
|
||||
|
||||
### Example 2: Capacity Migration
|
||||
```bash
|
||||
# OLD (30+ vars)
|
||||
export HAKMEM_TINY_MAG_CAP=512
|
||||
export HAKMEM_TINY_MAG_CAP_C0=256
|
||||
export HAKMEM_TINY_MAG_CAP_C1=256
|
||||
# ... 27 more ...
|
||||
|
||||
# NEW (1 var for most cases)
|
||||
export HAKMEM_CACHE_PRESET=medium # Tiny=512, Mid=128, Large=32
|
||||
|
||||
# OR (6 vars for custom)
|
||||
export HAKMEM_CACHE_PRESET=custom
|
||||
export HAKMEM_TINY_CACHE_SLOTS=512
|
||||
export HAKMEM_MID_CACHE_SLOTS=128
|
||||
export HAKMEM_LARGE_CACHE_SLOTS=32
|
||||
export HAKMEM_SS_MEMORY_LIMIT_MB=512
|
||||
export HAKMEM_POOL_MEMORY_LIMIT_MB=256
|
||||
```
|
||||
|
||||
### Example 3: Learning Migration
|
||||
```bash
|
||||
# OLD (35 vars)
|
||||
export HAKMEM_ACE_ENABLED=1
|
||||
export HAKMEM_INT_ENGINE=1
|
||||
export HAKMEM_INT_ADAPT_REFILL=1
|
||||
export HAKMEM_INT_ADAPT_CAPS=1
|
||||
export HAKMEM_WMAX_LEARN=1
|
||||
# ... 30 more ...
|
||||
|
||||
# NEW (4 vars for most cases)
|
||||
export HAKMEM_ADAPTIVE_MODE=active
|
||||
export HAKMEM_ADAPTIVE_TARGETS=caps,refill,wmax
|
||||
export HAKMEM_ADAPTIVE_INTERVAL_MS=1000
|
||||
export HAKMEM_ADAPTIVE_AGGRESSIVENESS=0.1
|
||||
```
|
||||
|
||||
202
docs/analysis/ENV_QUICK_REFERENCE.md
Normal file
202
docs/analysis/ENV_QUICK_REFERENCE.md
Normal file
@ -0,0 +1,202 @@
|
||||
# ENV Cleanup Quick Reference Card
|
||||
|
||||
## ✅ SAFE TO REMOVE NOW (1 var)
|
||||
|
||||
### HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT
|
||||
**Status**: UltraHot feature completely removed in commit bcfb4f6b5
|
||||
**File**: core/box/front_metrics_box.h:149
|
||||
**Action**: Delete lines 148-152 (getenv check + usage)
|
||||
**Risk**: ZERO - Feature doesn't exist anymore
|
||||
|
||||
```diff
|
||||
File: core/box/front_metrics_box.h
|
||||
- const char* env = getenv("HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT");
|
||||
- if (env && atoi(env) != 0) {
|
||||
- g_tiny_front_enable_ultrahot = 1;
|
||||
- }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 LOW HANGING FRUIT (Deduplication)
|
||||
|
||||
### SFC_DEBUG - Called 4x, Should Be 1x
|
||||
|
||||
**Problem**: Same ENV var checked in 4 different files
|
||||
**Solution**: Single global variable
|
||||
|
||||
**Step 1**: Add to core/hakmem_tiny_sfc.c (line ~36)
|
||||
```c
|
||||
int g_sfc_enabled = 1;
|
||||
int g_sfc_debug = 0; // ADD THIS
|
||||
```
|
||||
|
||||
**Step 2**: Update init in core/hakmem_tiny_sfc.c (keep line 123):
|
||||
```c
|
||||
if (env_debug && *env_debug && *env_debug != '0') {
|
||||
g_sfc_debug = 1; // Set global once
|
||||
fprintf(stderr, "...
|
||||
```
|
||||
|
||||
**Step 3**: Replace in 3 files:
|
||||
|
||||
```diff
|
||||
File: core/tiny_alloc_fast_sfc.inc.h:114
|
||||
- free_debug_enabled = getenv("HAKMEM_SFC_DEBUG") ? 1 : 0;
|
||||
+ extern int g_sfc_debug;
|
||||
+ free_debug_enabled = g_sfc_debug;
|
||||
|
||||
File: core/tiny_free_fast.inc.h:104
|
||||
- free_ss_debug_enabled = getenv("HAKMEM_SFC_DEBUG") ? 1 : 0;
|
||||
+ extern int g_sfc_debug;
|
||||
+ free_ss_debug_enabled = g_sfc_debug;
|
||||
|
||||
File: core/box/hak_wrappers.inc.h:89
|
||||
- debug_enabled = (getenv("HAKMEM_SFC_DEBUG") != NULL) ? 1 : 0;
|
||||
+ extern int g_sfc_debug;
|
||||
+ debug_enabled = g_sfc_debug;
|
||||
```
|
||||
|
||||
**Savings**: -3 getenv() calls on hot paths
|
||||
**Risk**: ZERO
|
||||
**Impact**: 4 files, ~10 lines total
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ NEED VERIFICATION (21 vars)
|
||||
|
||||
### Ask Maintainer/User:
|
||||
|
||||
#### 1. Ultra Features (8 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?
|
||||
|
||||
#### 2. Heap V2 (7 vars) - Active or Replaced?
|
||||
```
|
||||
HAKMEM_TINY_HEAP_V2_CLASS_MASK core/front/tiny_heap_v2.h
|
||||
HAKMEM_TINY_HEAP_V2_LEFTOVER_MODE core/front/tiny_heap_v2.h
|
||||
HAKMEM_TINY_HEAP_V2_DEBUG core/front/tiny_heap_v2.h
|
||||
HAKMEM_TINY_HEAP_V2_STATS core/tiny_alloc_fast.inc.h
|
||||
HAKMEM_TINY_FRONT_V2 core/tiny_alloc_fast.inc.h
|
||||
HAKMEM_TINY_FRONT_SLIM core/tiny_alloc_fast.inc.h
|
||||
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?
|
||||
```
|
||||
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?
|
||||
|
||||
#### 4. HotMag/SmallMag (1 var) - Used?
|
||||
```
|
||||
HAKMEM_TINY_SMALL_MAG core/hakmem_tiny_smallmag.inc.h
|
||||
```
|
||||
**Question**: Is SmallMag still in use? (File exists, no getenv found for HotMag)
|
||||
|
||||
#### 5. Ring/Debug (3 vars) - Needed?
|
||||
```
|
||||
HAKMEM_TINY_SLL_RING core/box/tls_sll_box.h
|
||||
HAKMEM_TINY_TRACE_RING core/tiny_debug_ring.c
|
||||
HAKMEM_TINY_DUMP_RING_ATEXIT core/tiny_debug_ring.c
|
||||
```
|
||||
**Question**: Are Tiny SLL ring and debug ring different from L25 TLS ring?
|
||||
|
||||
---
|
||||
|
||||
## ✅ DEFINITELY KEEP (Active Features)
|
||||
|
||||
### SFC - Shared Frontend Cache (6 vars) ✅
|
||||
- Default: ON (`g_sfc_enabled = 1`)
|
||||
- Compiled: hakmem_tiny_sfc.o in all binaries
|
||||
- Vars: HAKMEM_SFC_ENABLE, CAPACITY, REFILL_COUNT, DEBUG, STATS_DUMP, CASCADE_PCT
|
||||
|
||||
### TC - Thread Cache for Pool/L25 (10 vars) ✅
|
||||
- Active for L25 and Pool allocations
|
||||
- Vars: HAKMEM_L25_TC_*, HAKMEM_MID_TC_*, HAKMEM_TC_*
|
||||
|
||||
### L25 TLS Ring (3 vars) ✅
|
||||
- Active in L25 pool
|
||||
- Vars: HAKMEM_POOL_TLS_RING, HAKMEM_RING_RETURN_DIV, HAKMEM_L25_RING_TRIGGER
|
||||
|
||||
### BigCache (1 var) ✅
|
||||
- Compiled: hakmem_bigcache.o
|
||||
- Var: HAKMEM_BIGCACHE_L25
|
||||
|
||||
**Total KEEP**: 20 vars
|
||||
|
||||
---
|
||||
|
||||
## 📊 Summary Stats
|
||||
|
||||
| Category | Count | Action |
|
||||
|----------|-------|--------|
|
||||
| Safe to remove | 1 | Delete ULTRAHOT toggle |
|
||||
| Deduplication | 4 | SFC_DEBUG consolidation |
|
||||
| Need verification | 21 | Ask maintainer |
|
||||
| Definitely keep | 20 | No action |
|
||||
| Already removed | 11 | ✅ Done |
|
||||
| **TOTAL** | **57** | |
|
||||
|
||||
**Current ENV vars**: 221
|
||||
**Potential reduction**: 1-22 vars (0.5%-10%)
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Execution Order
|
||||
|
||||
1. **Today**: Remove HAKMEM_TINY_FRONT_ENABLE_ULTRAHOT (1 line, zero risk)
|
||||
2. **This week**: Deduplicate SFC_DEBUG (4 files, low risk)
|
||||
3. **Next sprint**: Verify 21 experimental vars with maintainer
|
||||
4. **Next release**: Deprecate confirmed obsolete vars (doc + warnings)
|
||||
5. **Future release**: Remove deprecated vars after 3-release cycle
|
||||
|
||||
---
|
||||
|
||||
## 📂 Files to Modify (Immediate Actions)
|
||||
|
||||
### Priority 1: ULTRAHOT Removal
|
||||
- core/box/front_metrics_box.h (lines 148-152)
|
||||
|
||||
### Priority 2: SFC_DEBUG Dedup
|
||||
- core/hakmem_tiny_sfc.c (add global, ~2 lines)
|
||||
- core/tiny_alloc_fast_sfc.inc.h (change to extern, ~2 lines)
|
||||
- core/tiny_free_fast.inc.h (change to extern, ~2 lines)
|
||||
- core/box/hak_wrappers.inc.h (change to extern, ~2 lines)
|
||||
|
||||
**Total: 5 files, ~10 lines of changes**
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Verification Template
|
||||
|
||||
For each experimental feature, check:
|
||||
|
||||
```bash
|
||||
# 1. Is it compiled?
|
||||
ls -la out/release/*.o | grep <feature>
|
||||
|
||||
# 2. Is it used in benchmarks?
|
||||
grep -r "HAKMEM_<FEATURE>" scripts/ apps/ bench/
|
||||
|
||||
# 3. Default value?
|
||||
grep -r "g_<feature>_enabled.*=" core/ --include="*.c"
|
||||
|
||||
# 4. Last commit?
|
||||
git log --all --oneline --grep="<feature>" | head -5
|
||||
```
|
||||
|
||||
If all NO → mark as OBSOLETE candidate
|
||||
11
hakmem.d
11
hakmem.d
@ -22,11 +22,11 @@ hakmem.o: core/hakmem.c core/hakmem.h core/hakmem_build_flags.h \
|
||||
core/box/hak_kpi_util.inc.h core/box/hak_core_init.inc.h \
|
||||
core/hakmem_phase7_config.h core/box/ss_hot_prewarm_box.h \
|
||||
core/box/hak_alloc_api.inc.h core/box/../hakmem_tiny.h \
|
||||
core/box/../hakmem_smallmid.h core/box/../pool_tls.h \
|
||||
core/box/hak_free_api.inc.h core/hakmem_tiny_superslab.h \
|
||||
core/box/../tiny_free_fast_v2.inc.h core/box/../tiny_region_id.h \
|
||||
core/box/../hakmem_build_flags.h core/box/../hakmem_tiny_config.h \
|
||||
core/box/../box/tls_sll_box.h core/box/../box/../hakmem_tiny_config.h \
|
||||
core/box/../hakmem_smallmid.h core/box/hak_free_api.inc.h \
|
||||
core/hakmem_tiny_superslab.h core/box/../tiny_free_fast_v2.inc.h \
|
||||
core/box/../tiny_region_id.h core/box/../hakmem_build_flags.h \
|
||||
core/box/../hakmem_tiny_config.h core/box/../box/tls_sll_box.h \
|
||||
core/box/../box/../hakmem_tiny_config.h \
|
||||
core/box/../box/../hakmem_build_flags.h core/box/../box/../tiny_remote.h \
|
||||
core/box/../box/../tiny_region_id.h \
|
||||
core/box/../box/../hakmem_tiny_integrity.h \
|
||||
@ -104,7 +104,6 @@ core/box/ss_hot_prewarm_box.h:
|
||||
core/box/hak_alloc_api.inc.h:
|
||||
core/box/../hakmem_tiny.h:
|
||||
core/box/../hakmem_smallmid.h:
|
||||
core/box/../pool_tls.h:
|
||||
core/box/hak_free_api.inc.h:
|
||||
core/hakmem_tiny_superslab.h:
|
||||
core/box/../tiny_free_fast_v2.inc.h:
|
||||
|
||||
Reference in New Issue
Block a user