# 機能設計書 115-isolation

## 概要

本ドキュメントは、Nim標準ライブラリの`isolation`モジュールの機能設計について記載する。このモジュールはスレッド間で安全にデータを転送するためのIsolated[T]型を提供する。

### 本機能の処理概要

isolationモジュールは、分離されたサブグラフを構築し、異なるチャネルやスレッドに効率的に渡すための`Isolated[T]`型を提供する。この型はコピー不可でムーブのみ可能であり、データ競合を防止する。

**業務上の目的・背景**：マルチスレッドプログラミングにおいて、オブジェクトグラフを安全にスレッド間で転送することは困難である。Isolated[T]型は、コンパイル時に「分離」が保証されたデータのみを転送可能とすることで、スレッド安全性を型システムレベルで保証する。

**機能の利用シーン**：
- tasksモジュールでのスレッド間引数渡し
- チャネルを介したスレッド間通信
- 並列処理での安全なデータ転送
- ムーブセマンティクスを活用したゼロコピー転送

**主要な処理内容**：
1. `isolate(value)` - 値からIsolated[T]を作成（分離性を静的チェック）
2. `unsafeIsolate(value)` - 分離性チェックなしで作成（危険）
3. `extract(src)` - Isolated[T]から値を取り出し（ムーブ）

**関連システム・外部連携**：
- tasksモジュール（toTaskマクロ内で使用）
- チャネルモジュール
- 並列処理ライブラリ

**権限による制御**：特になし

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | プログラム内部で使用するライブラリ機能 |

## 機能種別

並列処理 / 型システム

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| value | sink T | Yes | 分離する値 | isolateではコンパイル時に分離性チェック |

### 入力データソース

プログラムコード内の値

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| Isolated[T] | object {.sendable.} | 分離された値をラップするオブジェクト |
| T | T | extractで取り出された値 |

### 出力先

メモリ上のオブジェクト

## 処理フロー

### 処理シーケンス

```
1. isolate(value)を呼び出し
   └─ コンパイラがvalue式の分離性をチェック（magic: "Isolate"）
   └─ 分離可能な場合のみコンパイル成功

2. Isolated[T]オブジェクトを生成
   └─ valueをムーブして内部に格納
   └─ コピー禁止（`=copy`がエラー）

3. extract(src)で値を取り出し
   └─ src.valueをムーブして返却
   └─ srcは空になる
```

### フローチャート

```mermaid
flowchart TD
    A[値を準備] --> B{分離性チェック}
    B -->|isolate| C[コンパイル時チェック]
    B -->|unsafeIsolate| D[チェックなし]
    C -->|成功| E[Isolated[T]作成]
    C -->|失敗| F[コンパイルエラー]
    D --> E
    E --> G[スレッド間転送]
    G --> H[extract]
    H --> I[値を取り出し]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-115-01 | コピー禁止 | Isolated[T]はコピー不可、ムーブのみ | 常時 |
| BR-115-02 | sendable | Isolated[T]はsendableマーカー付き | 常時 |
| BR-115-03 | 分離性要件 | isolateに渡す値は他から参照されていないこと | isolate使用時 |
| BR-115-04 | sink引数 | 値はsinkとして受け取り所有権を移動 | 常時 |

### 計算ロジック

特になし

## データベース操作仕様

### 操作別データベース影響一覧

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | コンパイルエラー | isolateに分離不可能な式を渡した | 新規オブジェクトを構築して渡す |
| - | コンパイルエラー | Isolated[T]をコピーしようとした | moveを使用する |

### リトライ仕様

該当なし

## トランザクション仕様

該当なし

## パフォーマンス要件

- ムーブセマンティクスによりゼロコピー転送
- オーバーヘッドは最小限

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

- unsafeIsolateはスレッド安全性を破壊する可能性あり
- 安全なコードではisolateを使用すること

## 備考

- 実験的モジュール（インターフェースが変更される可能性あり）
- RFC #244に詳細な設計根拠が記載

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | isolation.nim | `lib/std/isolation.nim` | Isolated[T]型定義（18-19行目） |

**読解のコツ**: `{.sendable.}`マーカーはスレッド間転送可能であることを示す。内部に`value: T`フィールドを持つシンプルな構造。

#### Step 2: 演算子オーバーロードを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | isolation.nim | `lib/std/isolation.nim` | `=copy`（21行目） |
| 2-2 | isolation.nim | `lib/std/isolation.nim` | `=sink`（23-25行目） |
| 2-3 | isolation.nim | `lib/std/isolation.nim` | `=destroy`（27-29行目） |

**主要処理フロー**:
- **21行目**: `=copy`はerrorとして定義され、コピーを禁止
- **23-25行目**: `=sink`は内部valueのsinkに委譲
- **27-29行目**: `=destroy`は内部valueのdestroyに委譲

#### Step 3: 主要関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | isolation.nim | `lib/std/isolation.nim` | isolate関数（31-37行目） |
| 3-2 | isolation.nim | `lib/std/isolation.nim` | unsafeIsolate関数（39-44行目） |
| 3-3 | isolation.nim | `lib/std/isolation.nim` | extract関数（46-49行目） |

**主要処理フロー**:
- **31行目**: isolateは`{.magic: "Isolate".}`で分離性チェックをコンパイラに委任
- **39-44行目**: unsafeIsolateはチェックなしで単純にラップ
- **46-49行目**: extractは`move(src.value)`で値を取り出し

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

```
アプリケーション
    │
    ├─ isolate(value)
    │      └─ コンパイラによる分離性チェック（magic: "Isolate"）
    │      └─ Isolated[T](value: value)
    │
    ├─ スレッド間転送（チャネル、タスク等）
    │      └─ ムーブセマンティクス適用
    │
    └─ extract(src)
           └─ move(src.value)
           └─ T型の値を返却
```

### データフロー図

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

value: T ───▶ isolate() ─────▶ Isolated[T]
                   │
                   │ (コンパイル時分離性チェック)
                   │
Isolated[T] ───▶ extract() ────▶ T (所有権移動)
                   │
                   └─ src は空になる
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| isolation.nim | `lib/std/isolation.nim` | ソース | Isolated[T]型定義 |
| tasks.nim | `lib/std/tasks.nim` | ソース | isolationを使用してタスク引数を転送 |
| channels.nim | `lib/system/channels_builtin.nim` | ソース | スレッド間通信 |
