Files
hakmem/docs/archive/DEBUG_LOGGING_POLICY.md
Moe Charm (CI) a9ddb52ad4 ENV cleanup: Remove BG/HotMag vars & guard fprintf (Larson 52.3M ops/s)
Phase 1 完了:環境変数整理 + fprintf デバッグガード

ENV変数削除(BG/HotMag系):
- core/hakmem_tiny_init.inc: HotMag ENV 削除 (~131 lines)
- core/hakmem_tiny_bg_spill.c: BG spill ENV 削除
- core/tiny_refill.h: BG remote 固定値化
- core/hakmem_tiny_slow.inc: BG refs 削除

fprintf Debug Guards (#if !HAKMEM_BUILD_RELEASE):
- core/hakmem_shared_pool.c: Lock stats (~18 fprintf)
- core/page_arena.c: Init/Shutdown/Stats (~27 fprintf)
- core/hakmem.c: SIGSEGV init message

ドキュメント整理:
- 328 markdown files 削除(旧レポート・重複docs)

性能確認:
- Larson: 52.35M ops/s (前回52.8M、安定動作)
- ENV整理による機能影響なし
- Debug出力は一部残存(次phase で対応)

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-26 14:45:26 +09:00

2.7 KiB
Raw Blame History

Debug Logging Policy

統一方針

すべての診断ログは HAKMEM_BUILD_RELEASE フラグで統一的に制御する。

Build Modes

  • Release Build (HAKMEM_BUILD_RELEASE=1): 診断ログ完全無効(性能最優先)

    • -DNDEBUG が定義されると自動的に有効
    • 本番環境・ベンチマーク用
  • Debug Build (HAKMEM_BUILD_RELEASE=0): 診断ログ有効(デバッグ用)

    • デフォルトNDEBUG未定義
    • 環境変数で細かく制御可能

Implementation Pattern

推奨パターンGuard関数

static inline int diagnostic_enabled(void) {
#if HAKMEM_BUILD_RELEASE
    return 0;  // Always disabled in release
#else
    // Check env var in debug builds
    static int enabled = -1;
    if (__builtin_expect(enabled == -1, 0)) {
        const char* env = getenv("HAKMEM_DEBUG_FEATURE");
        enabled = (env && *env != '0') ? 1 : 0;
    }
    return enabled;
#endif
}

// Usage
if (__builtin_expect(diagnostic_enabled(), 0)) {
    fprintf(stderr, "[DEBUG] ...\n");
}

避けるパターン

// 悪い例環境変数を毎回チェックgetenv() は遅い)
const char* env = getenv("HAKMEM_DEBUG");
if (env && *env != '0') {
    fprintf(stderr, "...\n");
}

// 悪い例無条件ログrelease でも出力される)
fprintf(stderr, "[DEBUG] ...\n");

Existing Guard Functions

関数 用途 ファイル
trc_refill_guard_enabled() Refill path 診断 core/tiny_refill_opt.h
g_debug_remote_guard Remote queue 診断 core/superslab/superslab_inline.h
tiny_refill_failfast_level() Fail-fast 検証 core/hakmem_tiny_free.inc

Priority for Conversion

  1. 🔥 Hot Path (最優先): Refill, Alloc, Free の fast path 完了
  2. ⚠️ Medium: Remote drain, Magazine 層
  3. Low: Initialization, Slow path

Status

  • trc_refill_guard_enabled() - Release build で完全無効化
  • 残り 92 箇所 - 必要に応じて対処

Makefile Integration

現状:NDEBUG が定義されていない → HAKMEM_BUILD_RELEASE=0

TODO: Release ビルドターゲットに -DNDEBUG を追加

release: CFLAGS += -DNDEBUG -O3

Environment Variables (Debug Build Only)

  • HAKMEM_TINY_REFILL_FAILFAST: Refill path 検証 (0=off, 1=on, 2=verbose)
  • HAKMEM_TINY_REFILL_OPT_DEBUG: Refill 最適化ログ
  • HAKMEM_DEBUG_REMOTE_GUARD: Remote queue 検証

Performance Impact

状態 Throughput 改善
Before (診断あり) 1,015,347 ops/s -
After (guard追加) 1,046,392 ops/s +3.1%
Target (完全無効化) TBD 推定 +5-10%