# 通知設計書 55-warnGcUnsafe2

## 概要

本ドキュメントは、Nimコンパイラの警告通知「warnGcUnsafe2」（GC安全でない - 詳細）の設計仕様を記載する。この警告は、`warnGcUnsafe`の拡張版であり、GC安全でないコードの詳細な理由を連鎖的に説明するために使用される。

### 本通知の処理概要

**業務上の目的・背景**：この警告は、GC安全性違反の根本原因を特定することを目的としている。`warnGcUnsafe`が単純に「GC安全でない」と報告するのに対し、`warnGcUnsafe2`はなぜGC安全でないのか、どのシンボルが原因なのかを詳細に説明する。これにより、開発者は複雑な呼び出しチェーンの中でもGC安全性違反の原因を追跡できる。

**通知の送信タイミング**：コンパイル時のエフェクト解析フェーズ（sempass2.nim）において、`listGcUnsafety`関数が呼び出された際に発生する。この関数は、GC安全でないプロシージャの理由を再帰的に辿り、各段階で詳細なメッセージを出力する。

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

**通知内容の概要**：警告メッセージは動的に生成され、以下のような形式で表示される：
- 「'{プロシージャ名}' is not GC-safe as it calls '{呼び出し先}'」
- 「'{プロシージャ名}' is not GC-safe as it accesses '{変数名}' which is a global using GC'ed memory」
- 「'{プロシージャ名}' is not GC-safe as it performs an indirect call via '{パラメータ名}'」
- 「Base method '{メソッド名}' requires explicit '{.gcsafe.}' to be GC-safe」

**期待されるアクション**：開発者は詳細なメッセージを参照して、GC安全性違反の根本原因を特定し、適切な修正を行う。例えば、GC安全でないプロシージャを呼び出している場合はその呼び出しを避けるか、呼び出し先を修正する。グローバル変数が原因の場合はスレッドローカル変数に変更するなどの対策を講じる。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Warning: {詳細メッセージ} [GcUnsafe2]
```

詳細メッセージの種類：
- `'{proc}' is not GC-safe as it calls '{callee}'` - GC安全でないプロシージャの呼び出し
- `'{proc}' is not GC-safe as it accesses '{var}' which is a global using GC'ed memory` - GC管理メモリを持つグローバル変数へのアクセス
- `'{proc}' is not GC-safe as it performs an indirect call via '{param}'` - パラメータ経由の間接呼び出し
- `Base method '{method}' requires explicit '{.gcsafe.}' to be GC-safe` - 基底メソッドの{.gcsafe.}不足

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ファイルパス | ソースファイルの絶対または相対パス | TLineInfo.fileIndex | Yes |
| 行番号 | 警告箇所の行番号 | TLineInfo.line | Yes |
| 列番号 | 警告箇所の列番号 | TLineInfo.col | Yes |
| 詳細メッセージ | 動的に生成された詳細メッセージ | listGcUnsafety関数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | GC安全でない理由の列挙 | listGcUnsafety()がonlyWarning=trueで呼ばれた場合 | 警告モードでの詳細出力 |
| コンパイル処理 | プロシージャ呼び出しチェーン | gcUnsafetyReasonが設定されている場合 | 再帰的に理由を辿る |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `{.warning[GcUnsafe2]:off.}` | プラグマによる警告抑制 |
| `--warning:GcUnsafe2:off` | コマンドラインオプションによる抑制 |
| cycleCheck.containsOrIncl(u.id) | 循環参照防止（同じシンボルを2度処理しない） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[GC安全性エラー/警告検出] --> B[listGcUnsafety呼び出し]
    B --> C{gcUnsafetyReason存在?}
    C -->|No| D[終了]
    C -->|Yes| E{cycleCheck済み?}
    E -->|Yes| D
    E -->|No| F[理由の種別判定]
    F --> G{skLet/skVar?}
    G -->|Yes| H[グローバル変数メッセージ]
    F --> I{routineKinds?}
    I -->|Yes| J{sfBase+非sfThread?}
    J -->|Yes| K[基底メソッドメッセージ]
    J -->|No| L[再帰的listGcUnsafety]
    L --> M[呼び出しチェーンメッセージ]
    F --> N{skParam/skForVar?}
    N -->|Yes| O[間接呼び出しメッセージ]
    H --> P[message warnGcUnsafe2発行]
    K --> P
    M --> P
    O --> P
    P --> D
```

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

### 参照テーブル一覧

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

| データ構造 | 用途 | 備考 |
|-----------|------|------|
| PSym | シンボル情報 | gcUnsafetyReasonを参照 |
| PSym.kind | シンボル種別 | 理由の分類に使用 |
| PSym.flags | シンボルフラグ | sfBase, sfThreadをチェック |
| IntSet (cycleCheck) | 循環防止セット | 既処理シンボルを追跡 |

### 更新テーブル一覧

| データ構造 | 操作 | 概要 |
|-----------|------|------|
| IntSet (cycleCheck) | UPDATE | 処理済みシンボルIDを追加 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | この警告自体はエラーではない（onlyWarning=falseの場合はerrGeneratedとして出力） | - |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | cycleCheckにより同一シンボルは1回のみ |

### 配信時間帯

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

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

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

## 備考

- この警告は`warnGcUnsafe`と組み合わせて使用される
- `onlyWarning`パラメータがfalseの場合、警告ではなくエラー（errGenerated）として出力される
- 再帰呼び出しにより、GC安全性違反の呼び出しチェーン全体を表示できる
- 基底メソッド（sfBase）の場合は特別なメッセージが使用される

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: メッセージテンプレートが`$1`となっており、動的にメッセージが生成されることを示している。

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

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

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

**主要処理フロー (sempass2.nim)**:
1. **330行目**: listGcUnsafety関数の定義開始
2. **331行目**: gcUnsafetyReasonを取得
3. **332行目**: cycleCheckで循環参照を防止
4. **333行目**: onlyWarningに応じてwarnGcUnsafe2またはerrGeneratedを選択
5. **334-343行目**: skLet/skVarの場合のメッセージ生成（グローバル変数アクセス）
6. **344-355行目**: routineKindsの場合のメッセージ生成（プロシージャ呼び出し）
7. **347-350行目**: sfBase + 非sfThreadの場合の基底メソッドメッセージ
8. **351-355行目**: 再帰的呼び出しと呼び出しチェーンメッセージ
9. **356-359行目**: skParam/skForVarの場合のメッセージ生成（間接呼び出し）

#### Step 3: 呼び出し元を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sempass2.nim | `compiler/sempass2.nim` | listGcUnsafetyの呼び出し箇所 |

**主要処理フロー**:
- **1821行目**: エラーモードでの呼び出し `listGcUnsafety(s, onlyWarning=false, g.config)`
- **1823行目**: 警告モードでの呼び出し `listGcUnsafety(s, onlyWarning=true, g.config)`

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

```
sempass2.nim::trackProc (プロシージャ解析完了時)
    │
    └─ GC安全性違反検出
           │
           ├─ sfThread設定時: listGcUnsafety(s, onlyWarning=false, config)
           │      └─ errGenerated として出力
           │
           └─ sfThread未設定時: listGcUnsafety(s, onlyWarning=true, config)
                  └─ warnGcUnsafe2 として出力

listGcUnsafety (再帰的処理)
    │
    ├─ gcUnsafetyReason取得
    ├─ cycleCheckで重複防止
    │
    ├─ skLet/skVar: グローバル変数メッセージ
    │
    ├─ routineKinds:
    │      ├─ sfBase: 基底メソッドメッセージ
    │      └─ その他: 再帰呼び出し + 呼び出しチェーンメッセージ
    │
    └─ skParam/skForVar: 間接呼び出しメッセージ
```

### データフロー図

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

PSym.gcUnsafetyReason ───▶ listGcUnsafety           ───▶ 警告メッセージ
                            │                              (stderr)
                            ├─ シンボル種別判定
                            ├─ メッセージ生成
                            └─ 再帰呼び出し（必要時）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別・メッセージ定義 |
| sempass2.nim | `compiler/sempass2.nim` | ソース | listGcUnsafety関数実装 |
| ast.nim | `compiler/ast.nim` | ソース | PSym型定義（gcUnsafetyReasonフィールド） |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
