# 通知設計書 41-warnWriteToForeignHeap

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ `warnWriteToForeignHeap`（外部ヒープへの書き込み警告）に関する設計書です。

### 本通知の処理概要

この警告は、Nimプログラムが外部（foreign）ヒープ領域への書き込みを検出した際に発生する警告メッセージです。現在、この警告は定義のみ存在し、実際のコード内では使用されていません（予約済み警告）。

**業務上の目的・背景**：マルチスレッド環境やFFI（Foreign Function Interface）を使用する場合、異なるメモリ管理領域（ヒープ）間でのデータ操作は、メモリ破損やデータ競合の原因となる可能性があります。この警告は、そのような潜在的な問題を開発者に通知するために設計されました。Nimのガベージコレクタはスレッドローカルであるため、他スレッドのヒープへの直接書き込みは安全でない操作となります。

**通知の送信タイミング**：コンパイル時のセマンティック解析フェーズにおいて、外部ヒープへの書き込み操作が検出された際に警告が発生します。ただし、現時点では実際の検出ロジックは実装されていません。

**通知の受信者**：Nimプログラムをコンパイルする開発者がこの警告を受け取ります。コンパイラの標準出力または標準エラー出力に警告メッセージが表示されます。

**通知内容の概要**：「write to foreign heap」というメッセージが表示され、外部ヒープ領域への書き込み操作が検出されたことを通知します。

**期待されるアクション**：開発者は該当コードを見直し、スレッドセーフな方法でデータを共有するか、チャネルや他の同期プリミティブを使用してスレッド間通信を行うことが期待されます。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

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

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

コンパイラを実行している開発者のコンソールに直接出力されます。警告の有効/無効は `--warning[WriteToForeignHeap]:on/off` オプションで制御可能です。

## 通知テンプレート

### コンパイラ警告の場合

| 項目 | 内容 |
|-----|------|
| メッセージID | WriteToForeignHeap |
| 警告レベル | Warning |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイル名}({行番号}, {列番号}) Warning: write to foreign heap [WriteToForeignHeap]
```

### 添付ファイル

該当なし（コンパイラ警告のため添付ファイルは存在しない）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ファイル名 | ソースファイルのパス | TLineInfo.fileIndex | Yes |
| 行番号 | 警告発生行 | TLineInfo.line | Yes |
| 列番号 | 警告発生列 | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル時 | 外部ヒープへの書き込み検出 | 警告が有効 | セマンティック解析フェーズで検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--warning[WriteToForeignHeap]:off` | コマンドラインオプションで警告を無効化 |
| `{.warning[WriteToForeignHeap]:off.}` | プラグマで警告を無効化 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コンパイル開始] --> B[ソースコード解析]
    B --> C[セマンティック解析]
    C --> D{外部ヒープ書き込み検出?}
    D -->|Yes| E{警告有効?}
    D -->|No| F[通常処理継続]
    E -->|Yes| G[警告メッセージ生成]
    E -->|No| F
    G --> H[コンソール出力]
    H --> F
    F --> I[コンパイル継続]
```

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

### 参照テーブル一覧

該当なし（コンパイラ内部処理のため外部データベース参照なし）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | - | - |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

コンパイル実行時に即座に出力される（時間帯制限なし）

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

- 警告メッセージにはソースコードのファイルパスと行番号が含まれるため、ビルドログを外部共有する際は注意が必要
- 本警告自体はセキュリティ向上を目的としており、メモリ安全性の問題を早期発見するのに役立つ

## 備考

- この警告は現在予約済みで、実際の検出ロジックは実装されていない
- 将来的にスレッドセーフティ解析機能の拡張時に使用される可能性がある
- Nimの古いGC（Refc）では、各スレッドが独自のヒープを持つため、この警告は特に重要であった

---

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

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

### 推奨読解順序

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

まず、警告メッセージの種類を定義するデータ構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnWriteToForeignHeapの定義を確認（66行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | MsgKindToStr配列で警告メッセージテンプレートを確認（161行目） |

**読解のコツ**: TMsgKind列挙型は、Nimコンパイラのすべてのエラー・警告・ヒントメッセージを定義しています。警告は`warnXxx`という命名規則に従います。

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

警告メッセージを出力する関数を特定します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | msgs.nim | `compiler/msgs.nim` | message関数が警告出力の中心的な役割を担う |

**主要処理フロー**:
1. **message関数**: 警告種別と情報を受け取りメッセージを構築
2. **出力先決定**: 設定に基づいて標準出力または標準エラーに出力

#### Step 3: 関連するメモリ管理コードを理解する

外部ヒープの概念を理解するためのファイルを参照します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | gc.nim | `lib/system/gc.nim` | 616行目、623行目でforeign heap rootの検出アサーションを確認 |

**主要処理フロー**:
- **616行目**: `isAllocatedPtr`でヒープ領域の検証
- **623行目**: マーキング処理中の外部ヒープ検出

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

```
lineinfos.nim (警告種別定義)
    │
    ├─ TMsgKind.warnWriteToForeignHeap (列挙値)
    │
    └─ MsgKindToStr[warnWriteToForeignHeap] (メッセージテンプレート)
           │
           └─ msgs.nim::message() (警告出力関数)
                  │
                  └─ コンソール出力
```

### データフロー図

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

ソースコード ───▶ セマンティック解析 ───▶ 外部ヒープ検出
                         │
                         ▼
               警告種別・位置情報 ───▶ message関数 ───▶ コンソール警告
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別の定義とメッセージテンプレート |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力機能 |
| gc.nim | `lib/system/gc.nim` | ソース | ガベージコレクタとヒープ管理 |
