# 通知設計書 42-warnUnsafeCode

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ `warnUnsafeCode`（安全でないコード警告）に関する設計書です。

### 本通知の処理概要

この警告は、Nimプログラムにおいて安全でない（unsafe）コード操作が検出された際に発生する警告メッセージです。特に、文字列からcstringへの暗黙的な変換など、メモリ安全性を損なう可能性のある操作を検出します。

**業務上の目的・背景**：Nimは安全性を重視したプログラミング言語ですが、C言語との相互運用性のために低レベルな操作も可能です。この警告は、開発者が意図せず安全でない操作を行った場合に早期に検出し、潜在的なメモリ破損やセキュリティ脆弱性を防止することを目的としています。特にcstring（Cスタイルの文字列）への変換は、ガベージコレクタによる参照追跡が困難になるため危険です。

**通知の送信タイミング**：コンパイル時のセマンティック解析フェーズ（sempass2）において、unsafe操作が検出された際に警告が発生します。具体的には、Nim文字列からcstringへの代入操作で、リテラル以外の文字列が使用された場合に発生します。

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

**通知内容の概要**：「unsafe code: '式'」というメッセージが表示され、どの式が安全でないかを具体的に示します。

**期待されるアクション**：開発者は該当コードを見直し、より安全な代替手段を使用するか、意図的にunsafe操作を行う場合は明示的なキャスト操作に変更し、コードレビューで注意深く確認することが期待されます。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイル名}({行番号}, {列番号}) Warning: unsafe code: '{式}' [UnsafeCode]
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ファイル名 | ソースファイルのパス | TLineInfo.fileIndex | Yes |
| 行番号 | 警告発生行 | TLineInfo.line | Yes |
| 列番号 | 警告発生列 | TLineInfo.col | Yes |
| 式 | 安全でない式の内容 | renderTree(n) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル時 | cstring代入検出 | 文字列からcstringへの暗黙変換 | sempass2.nim:966行目で検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--warning[UnsafeCode]:off` | コマンドラインオプションで警告を無効化 |
| `{.warning[UnsafeCode]:off.}` | プラグマで警告を無効化 |
| 文字列リテラルの場合 | `nkStrLit..nkTripleStrLit`の場合は警告なし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[代入式検出] --> B{左辺がcstring?}
    B -->|No| C[通常処理]
    B -->|Yes| D{右辺の型チェック}
    D --> E{tyString?}
    E -->|No| C
    E -->|Yes| F{リテラル?}
    F -->|Yes| C
    F -->|No| G[warnUnsafeCode発行]
    G --> H[警告メッセージ出力]
    H --> C
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- この警告自体がセキュリティ向上を目的としている
- cstringへの変換は、GC管理外のポインタを作成するため、use-after-freeの脆弱性につながる可能性がある
- 警告を無視してコードを書く場合は、メモリ安全性を十分に検証する必要がある

## 備考

- 現在、cstringCheck関数内で条件付きコンパイル（`when false`）により無効化されている可能性がある
- 文字列リテラルは静的にメモリ確保されるため安全とみなされる
- FFI（Foreign Function Interface）使用時に頻繁に発生する可能性がある

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: 警告メッセージテンプレートの`$1`はrenderTree(n)の結果で置換されます。

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

警告を発生させるcstringCheck関数を確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sempass2.nim | `compiler/sempass2.nim` | cstringCheck関数（963-966行目）で警告発生ロジックを確認 |

**主要処理フロー**:
1. **963行目**: cstringCheck関数の定義
2. **964行目**: 左辺がtyCstringかチェック
3. **965行目**: 右辺がtyStringでリテラル以外かチェック
4. **966行目**: 条件を満たす場合にwarnUnsafeCode警告を発行

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

cstringCheckがどこから呼ばれるかを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sempass2.nim | `compiler/sempass2.nim` | 1345行目で`when false: cstringCheck`として条件付き無効化 |

**主要処理フロー**:
- **1345行目**: 代入文の処理後にcstringCheckが呼ばれる予定だが、現在は無効

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

```
sempass2.nim::track()
    │
    ├─ nkAsgn, nkFastAsgn, nkSinkAsgn の処理（1336-1355行目）
    │      │
    │      └─ cstringCheck() [現在無効: when false]
    │             │
    │             └─ message(warnUnsafeCode)
    │                    │
    │                    └─ コンソール出力
    │
    └─ その他の式処理
```

### データフロー図

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

代入式 (n) ───▶ cstringCheck(tracked, n)
                    │
                    ├─ n[0].typ.kind == tyCstring?
                    │       │
                    │       └─ skipConv(n[1]).typ.kind == tyString?
                    │               │
                    │               └─ kind notin {nkStrLit..nkTripleStrLit}?
                    │                       │
                    ▼                       ▼
              message() ───▶ renderTree(n) ───▶ 警告メッセージ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別の定義とメッセージテンプレート |
| sempass2.nim | `compiler/sempass2.nim` | ソース | cstringCheck関数の実装（警告発生ロジック） |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力機能 |
| renderer.nim | `compiler/renderer.nim` | ソース | renderTree関数（式の文字列表現生成） |
