# 通知設計書 115-hintGCStats

## 概要

本ドキュメントは、Nimコンパイラにおける`hintGCStats`（GC統計ヒント）通知の設計について記述する。

### 本通知の処理概要

`hintGCStats`は、コンパイル完了時にガベージコレクタ（GC）の統計情報を出力するためのヒント通知である。メモリ使用状況やGCの動作状況を把握するための診断情報として機能する。

**業務上の目的・背景**：Nimコンパイラ自体のメモリ使用効率を監視し、コンパイラ開発者がメモリ関連の問題を特定・改善するための情報を提供する。大規模プロジェクトのコンパイル時のメモリ使用量の把握や、GCの動作確認にも活用できる。

**通知の送信タイミング**：コンパイル処理の完了後（mainCommand実行後）に、`hintGCStats`が有効な場合にGC_getStatistics()の結果を出力する。

**通知の受信者**：コンパイルを実行している開発者またはコンパイラ開発者。コンソール出力経由でGC統計情報を受け取る。

**通知内容の概要**：GCの統計情報（メモリ割り当て量、GC実行回数など）が出力される。

**期待されるアクション**：開発者はGC統計情報を分析し、メモリ使用量の異常やGCの過剰動作などを検出して、必要に応じてコンパイラオプションの調整やコードの改善を行う。

## 通知種別

コンパイラ出力（コンソール）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 低（Hint） |
| リトライ | なし |

### 送信先決定ロジック

コンパイラの標準出力へ`echo`で送信。verbosity レベル1以下ではデフォルトで無効化されている。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ |
| 形式 | テキスト |

### 本文テンプレート

```
{GC統計情報}
```

GC_getStatistics()の戻り値がそのまま出力される。

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | GC統計情報 | GC_getStatistics() | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル完了 | mainCommand終了 | conf.hasHint(hintGCStats) | GCStatsヒントが有効な場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| verbosity <= 1 | デフォルトのverbosityレベルでは抑止 |
| hintGCStats not in conf.notes | ヒントが無効化されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[mainCommand完了] --> B{hasHint hintGCStats?}
    B -->|Yes| C[GC_getStatistics呼び出し]
    B -->|No| E[終了]
    C --> D[echo出力]
    D --> E
```

## データベース参照・更新仕様

### 参照テーブル一覧

該当なし（コンパイラ内部処理のみ）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | このヒント自体はエラーを発生させない | - |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし（コンパイル完了時に1回のみ） |

### 配信時間帯

制限なし

## セキュリティ考慮事項

GC統計情報には機密情報は含まれないが、システムのメモリ使用状況が推測可能になる場合がある。

## 備考

- verbosity レベル2以上で有効になる
- `--hint:GCStats:on/off`オプションで個別に制御可能
- GC_getStatistics()はNimランタイムの関数

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

まず、通知の定義と設定について理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型のhintGCStats定義（113行目）、MsgKindToStr配列でのメッセージテンプレート（238行目） |

**読解のコツ**: hintGCStatsは"$1"テンプレートを持つが、実際の出力はGC_getStatistics()の結果をechoで直接出力している。

#### Step 2: エントリーポイントを理解する

処理の起点となるメイン処理を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | nim.nim | `compiler/nim.nim` | mainCommand完了後のGC統計出力（125行目） |

**主要処理フロー**:
1. **124行目**: mainCommand(graph)の実行
2. **125行目**: `if conf.hasHint(hintGCStats): echo(GC_getStatistics())`でGC統計出力

#### Step 3: verbosity設定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lineinfos.nim | `compiler/lineinfos.nim` | computeNotesVerbosity関数（263-271行目）、レベル1からhintGCStatsを除外（269行目） |

**主要処理フロー**:
- **269行目**: result[1]からhintGCStatsを除外（つまりレベル2以上で有効）

### プログラム呼び出し階層図

```
nim.nim main処理
    │
    ├─ mainCommand (graph)
    │
    └─ hasHint(hintGCStats)確認
           │
           └─ echo(GC_getStatistics())
```

### データフロー図

```
[入力]                    [処理]                      [出力]

コンパイル完了 ────────▶ hasHint確認 ──────────▶ GC統計情報
                             │                    (echo出力)
                             │
                    GC_getStatistics() ──────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義、メッセージテンプレート、verbosity設定 |
| nim.nim | `compiler/nim.nim` | ソース | コンパイラメイン処理、GC統計出力 |
| options.nim | `compiler/options.nim` | ソース | hasHint関数 |
