# 通知設計書 54-warnGcUnsafe

## 概要

本ドキュメントは、Nimコンパイラの警告通知「warnGcUnsafe」（GC安全でない）の設計仕様を記載する。この警告は、`{.gcsafe.}`プラグマが付与されたプロシージャ内で、ガベージコレクタ（GC）の安全性を損なう操作が検出された場合に発生する。

### 本通知の処理概要

**業務上の目的・背景**：この警告は、マルチスレッド環境でのメモリ安全性を確保することを目的としている。Nimのガベージコレクタはスレッドローカルであり、異なるスレッド間でGC管理メモリを共有すると、データ競合やメモリ破壊が発生する可能性がある。`{.gcsafe.}`プラグマは、プロシージャがGC安全であること（GC管理メモリへのグローバルアクセスがないこと）を宣言するが、この警告はその違反を検出する。

**通知の送信タイミング**：コンパイル時のエフェクト解析フェーズ（sempass2.nim）において、`{.gcsafe.}`が期待されるコンテキストでGC安全でない操作が検出された場合に発生する。具体的には、グローバル変数へのアクセス、GC安全でないプロシージャの呼び出し、間接的な呼び出しなどがチェックされる。

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

**通知内容の概要**：警告メッセージ「not GC-safe: '{識別子名}'」が、問題のあるコードのソースコード位置と共に表示される。識別子名は、GC安全でないプロシージャ名やグローバル変数名が入る。

**期待されるアクション**：開発者はGC安全でないコードを修正するか、`{.gcsafe.}`プラグマを削除するか、またはスレッドセーフな代替手段を使用する必要がある。例えば、グローバル変数の代わりにスレッドローカル変数（`{.threadvar.}`）を使用するなどの対策が考えられる。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Warning: not GC-safe: '{識別子名}' [GcUnsafe]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ファイルパス | ソースファイルの絶対または相対パス | TLineInfo.fileIndex | Yes |
| 行番号 | 警告箇所の行番号 | TLineInfo.line | Yes |
| 列番号 | 警告箇所の列番号 | TLineInfo.col | Yes |
| 識別子名 | GC安全でないシンボル名 | renderTree(n) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | GC安全でないproc呼び出し | notGcSafe(s.typ)かつhasWarn(warnGcUnsafe) | GC安全でないプロシージャの呼び出し |
| コンパイル処理 | グローバル変数アクセス | tfHasGCedMem in s.typ.flagsまたはisGCedMem | GC管理メモリを持つグローバル変数へのアクセス |
| コンパイル処理 | 間接呼び出し | notGcSafe(op)かつ非自己再帰呼び出し | procvar経由のGC安全でない呼び出し |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `{.warning[GcUnsafe]:off.}` | プラグマによる警告抑制 |
| `--warning:GcUnsafe:off` | コマンドラインオプションによる抑制 |
| verbosityレベル0または1 | NotesVerbosityの設定により抑制 |
| sfImportc in s.flags | Cからインポートされた関数 |
| inEnforcedGcSafe == false | gcsafeが強制されていないコンテキスト |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[プロシージャ呼び出し/変数アクセス解析] --> B{gcsafeコンテキスト?}
    B -->|No| C[チェックスキップ]
    B -->|Yes| D{notGcSafe?}
    D -->|No| C
    D -->|Yes| E{hasWarn warnGcUnsafe?}
    E -->|No| F[markGcUnsafeのみ]
    E -->|Yes| G[warnAboutGcUnsafe呼び出し]
    G --> H[message warnGcUnsafe発行]
    H --> F
    F --> I[gcUnsafe=true設定]
    I --> J[終了]
    C --> J
```

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

### 参照テーブル一覧

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

| データ構造 | 用途 | 備考 |
|-----------|------|------|
| PEffects | エフェクト追跡情報 | gcUnsafeフラグを保持 |
| PSym | シンボル情報 | gcUnsafetyReasonを保持 |
| PType | 型情報 | tfHasGCedMemフラグをチェック |

### 更新テーブル一覧

| データ構造 | 操作 | 概要 |
|-----------|------|------|
| PEffects.gcUnsafe | UPDATE | GC安全でない場合trueに設定 |
| PSym.gcUnsafetyReason | UPDATE | GC安全でない理由となったシンボルを記録 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | この警告自体はエラーではない（ただしsfThreadフラグがある場合はエラーになる） | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- この警告は`NotesVerbosity`レベル1では無効化されている（レベル2以上で有効）
- `--threads:on`オプションが有効な場合、GC安全性のチェックがより重要になる
- スレッドプロシージャ（`{.thread.}`）では、この警告がエラーに昇格する
- `warnGcUnsafe2`と組み合わせて使用され、より詳細な理由を提供する

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: メッセージテンプレート「not GC-safe: '$1'」の$1には、GC安全でないシンボル名が入る。

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

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

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

**主要処理フロー (sempass2.nim)**:
1. **295-297行目**: warnAboutGcUnsafe関数でmessage()を呼び出し
2. **299-302行目**: markGcUnsafe(reason: PSym)で安全でない理由を記録
3. **304-312行目**: markGcUnsafe(reason: PNode)でノードから理由を抽出
4. **700行目**: プロシージャ呼び出し時のチェック `if tracked.config.hasWarn(warnGcUnsafe): warnAboutGcUnsafe(n, tracked.config)`
5. **786行目**: 間接呼び出し時のチェック
6. **794行目**: エフェクトリスト経由の呼び出しチェック
7. **1066行目**: 直接呼び出し時のチェック

#### Step 3: GC安全性判定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | types.nim | `compiler/types.nim` | notGcSafe関数とisGCedMem関数 |

**主要処理フロー**:
- tfNoSideEffect, tfGcSafeなどのフラグをチェック
- 型がGC管理メモリを含むかどうかを判定

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

```
sempass2.nim::trackCall (呼び出し解析)
    │
    ├─ notGcSafe(s.typ) チェック
    │      └─ types.nim::notGcSafe
    │
    ├─ hasWarn(warnGcUnsafe) チェック
    │
    ├─ warnAboutGcUnsafe(n, config)
    │      └─ message(conf, n.info, warnGcUnsafe, renderTree(n))
    │
    └─ markGcUnsafe(tracked, s)
           ├─ gcUnsafe = true
           └─ gcUnsafetyReason = s
```

### データフロー図

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

プロシージャ呼び出し   ───▶ trackCall                   ───▶ 警告メッセージ
グローバル変数参照          │                              (stderr)
                            ├─ notGcSafe()判定
                            ├─ hasWarn()確認
                            ├─ warnAboutGcUnsafe()
                            └─ markGcUnsafe()

                    ───▶ PEffects.gcUnsafe = true
                    ───▶ PSym.gcUnsafetyReason設定
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別・メッセージ定義 |
| sempass2.nim | `compiler/sempass2.nim` | ソース | エフェクト解析・GC安全性チェック |
| types.nim | `compiler/types.nim` | ソース | 型のGC安全性判定 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
| options.nim | `compiler/options.nim` | ソース | コンパイラオプション管理 |
