# 通知設計書 57-warnGcMem

## 概要

本ドキュメントは、Nimコンパイラの警告通知「warnGcMem」（GC管理メモリの使用）の設計仕様を記載する。この警告は、`--gc:none`オプションでガベージコレクタを無効化した状態で、GC管理メモリを必要とする操作が検出された場合に発生する。

### 本通知の処理概要

**業務上の目的・背景**：この警告は、GCなしのコンパイルモード（`--gc:none`）において、GC管理メモリを使用するコードを検出することを目的としている。組み込みシステムやリアルタイムシステムなど、GCを使用できない環境向けにコードを作成する際に、意図しないGCメモリ使用を警告する。これにより、メモリリークや予期しない動作を防ぐことができる。

**通知の送信タイミング**：コード生成フェーズ（ccgexprs.nim）において、GC管理メモリを使用する操作が検出された場合に発生する。具体的には、`gcUsage`関数内で`conf.selectedGC == gcNone`の条件がチェックされる。

**通知の受信者**：この警告はコンパイルを実行した開発者に対して、標準エラー出力またはコンパイラが設定した出力先に通知される。

**通知内容の概要**：警告メッセージ「'{式}' uses GC'ed memory」（'{式}'はGC管理メモリを使用しています）が、問題のあるコードのソースコード位置と共に表示される。

**期待されるアクション**：開発者はGC管理メモリを使用しない代替手段を検討するか、`--gc:none`の使用を再検討する必要がある。例えば、動的配列（seq）の代わりに固定長配列を使用する、文字列操作を避けるなどの対策が考えられる。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル時に即座に出力） |
| 優先度 | 中（警告レベル） |
| リトライ | なし |

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

標準エラー出力（stderr）に出力される。コンパイラの`--verbosity`オプションや`--warning[GcMem]:off`オプションにより出力を制御可能。

## 通知テンプレート

### コンパイラ出力の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ（nim c） |
| 重大度 | Warning |
| メッセージキー | GcMem |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Warning: '{式}' uses GC'ed memory [GcMem]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ファイルパス | ソースファイルの絶対または相対パス | TLineInfo.fileIndex | Yes |
| 行番号 | 警告箇所の行番号 | TLineInfo.line | Yes |
| 列番号 | 警告箇所の列番号 | TLineInfo.col | Yes |
| 式 | GC管理メモリを使用する式 | renderTree(n) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | GC管理メモリ操作 | conf.selectedGC == gcNone | GCなしモードでGCメモリ操作を検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `{.warning[GcMem]:off.}` | プラグマによる警告抑制 |
| `--warning:GcMem:off` | コマンドラインオプションによる抑制 |
| conf.selectedGC != gcNone | GCが有効な場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[GC関連操作の検出] --> B{selectedGC == gcNone?}
    B -->|No| C[警告なし]
    B -->|Yes| D[warnGcMem発行]
    D --> E[message関数呼び出し]
    E --> F[renderTreeで式を文字列化]
    F --> G[出力]
    C --> H[終了]
    G --> H
```

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

### 参照テーブル一覧

この警告はコンパイラ内部のデータ構造を参照するため、外部データベースは使用しない。

| データ構造 | 用途 | 備考 |
|-----------|------|------|
| ConfigRef | コンパイラ設定 | selectedGCをチェック |
| PNode | AST | 警告対象の式を保持 |

### 更新テーブル一覧

なし（読み取り専用のチェック処理）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | この警告自体はエラーではない | - |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし（発生箇所ごとに1回出力） |

### 配信時間帯

制限なし（コンパイル実行時に即座に出力）

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

- ソースコードのパスが出力に含まれるため、ビルドログを公開する際はパス情報に注意が必要
- 式の内容が出力に含まれるが、通常は機密情報ではない

## 備考

- この警告は`--gc:none`オプションが指定された場合にのみ有効
- 組み込みシステムやカーネル開発など、GCを使用できない環境で重要
- `seq`、`string`、`ref`型などがGC管理メモリを使用する
- `ptr`型や固定長配列はGC管理メモリを使用しない

---

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

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

### 推奨読解順序

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

警告メッセージの種類とメッセージテンプレートを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnGcMemの定義（73行目）とメッセージテンプレート（179行目）を確認 |

**読解のコツ**: メッセージテンプレート「'$1' uses GC'ed memory」の$1には、renderTree(n)の結果（式の文字列表現）が入る。

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

警告が発生する主要な場所を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | ccgexprs.nim | `compiler/ccgexprs.nim` | gcUsage関数 |

**主要処理フロー (ccgexprs.nim)**:
1. **1452-1453行目**: gcUsage関数の定義
2. **1453行目**: `if conf.selectedGC == gcNone`で条件チェック
3. **1453行目**: `message(conf, n.info, warnGcMem, n.renderTree)`で警告発行

#### Step 3: GCオプションを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | options.nim | `compiler/options.nim` | TGCMode列挙型とselectedGCフィールド |

**主要処理フロー**:
- `gcNone`はTGCMode列挙型のメンバー
- `--gc:none`コマンドラインオプションで設定される

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

```
ccgexprs.nim::各式のコード生成
    │
    └─ gcUsage(conf, n)
           │
           ├─ selectedGC == gcNone チェック
           │
           └─ message(conf, n.info, warnGcMem, n.renderTree)
                  └─ msgs.nim::rawMessage
                         └─ 出力処理
```

### データフロー図

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

GC関連操作のAST      ───▶ gcUsage                      ───▶ 警告メッセージ
                            │                              (stderr)
                            ├─ selectedGC確認
                            ├─ renderTree()で式を文字列化
                            └─ message()呼び出し
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別・メッセージ定義 |
| ccgexprs.nim | `compiler/ccgexprs.nim` | ソース | gcUsage関数実装 |
| options.nim | `compiler/options.nim` | ソース | TGCMode定義・selectedGC |
| renderer.nim | `compiler/renderer.nim` | ソース | renderTree関数 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
