# 機能設計書 113-typedthreads

## 概要

本ドキュメントは、Nim標準ライブラリの`typedthreads`モジュールの機能設計について記載する。このモジュールはNimにおける型安全なスレッド管理機能を提供する。

### 本機能の処理概要

typedthreadsモジュールは、複数の関数を並行実行するためのスレッドサポートを提供する。スレッドの作成、実行、終了待機などの基本的な操作をプラットフォーム非依存な形で利用できる。

**業務上の目的・背景**：マルチコアプロセッサを活用した並列処理を実現するために、低レベルなスレッド操作が必要となる。ただし、Nimでは`malebolgia`、`taskpools`、`weave`などの高レベルライブラリの使用が推奨されている。このモジュールはそれらの基盤となる低レベルAPIを提供する。

**機能の利用シーン**：
- CPUバウンドな処理の並列化
- バックグラウンド処理の実行
- ワーカースレッドパターンの実装
- 並列ライブラリの基盤として使用

**主要な処理内容**：
1. `createThread` - 新しいスレッドの作成と開始
2. `joinThread` / `joinThreads` - スレッドの終了待機
3. `running` - スレッドの実行状態確認
4. `handle` - システムスレッドハンドルの取得
5. `pinToCpu` - CPU親和性の設定

**関連システム・外部連携**：
- OS固有のスレッドAPI（pthread、Windows Thread API）
- locksモジュール（排他制御）
- channelsモジュール（スレッド間通信）

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

## 関連画面

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

## 機能種別

並列処理 / システムプログラミング

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| t | var Thread[TArg] | Yes | スレッドオブジェクト | - |
| tp | proc(arg: TArg) {.thread, nimcall.} | Yes | スレッドで実行する関数 | thread, nimcallプラグマ必須 |
| param | TArg | No | スレッドに渡す引数 | void可 |
| cpu | Natural | No | 親和性を設定するCPU番号 | - |

### 入力データソース

プログラムコード内で定義されたスレッド関数と引数

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| Thread[TArg] | object | スレッドを表すオブジェクト |
| SysThread | システム依存 | OSネイティブのスレッドハンドル |
| bool | bool | running()の結果 |

### 出力先

OSのスレッドサブシステム

## 処理フロー

### 処理シーケンス

```
1. Thread[TArg]変数を宣言
   └─ デフォルト初期化

2. createThread()でスレッドを開始
   └─ GcThreadのためのメモリ割り当て
   └─ 引数のコピー
   └─ OSのスレッドAPIを呼び出し
   └─ スレッド関数をラップして実行開始

3. スレッドは独立して実行
   └─ スレッド関数が完了するまで実行

4. joinThread()で終了を待機
   └─ OSのスレッド待機APIを呼び出し

5. スレッドリソースの解放
   └─ GcThreadメモリの解放
```

### フローチャート

```mermaid
flowchart TD
    A[Thread変数宣言] --> B[createThread]
    B --> C[メモリ割り当て]
    C --> D[引数コピー]
    D --> E[OSスレッド作成]
    E --> F{スレッド開始成功?}
    F -->|Yes| G[並行実行]
    F -->|No| H[ResourceExhaustedError]
    G --> I[joinThread]
    I --> J[終了待機]
    J --> K[リソース解放]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-113-01 | thread pragma | スレッド関数には{.thread.}プラグマが必要 | 常時 |
| BR-113-02 | GC制約 | refや他のGC管理変数は直接共有不可 | refcメモリ管理時 |
| BR-113-03 | sharedAlloc使用 | スレッド間でデータ共有にはsharedAllocを使用 | データ共有時 |
| BR-113-04 | ポインタ渡し | arc/orcではポインタ経由で共有可能 | arc/orcメモリ管理時 |
| BR-113-05 | チャネル推奨 | スレッド間通信にはchannelsの使用を推奨 | 通信時 |

### 計算ロジック

スタックサイズの計算：
- デフォルト: `ThreadStackMask + 1 - StackGuardSize`
- 一部プラットフォーム: `nimThreadStackSize - nimThreadStackGuard`

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

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ResourceExhaustedError | スレッド作成失敗 | システムリソースを確認 |
| - | コンパイルエラー | os:anyでの使用 | --threads:offを指定 |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- スレッドスタックサイズはプラットフォームに応じて最適化
- スレッドプールパターンでオーバーヘッドを軽減推奨

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

- スレッド間のデータ競合に注意
- ロックを適切に使用して排他制御

## 備考

- `--threads:on`コンパイルオプションが必要
- 高レベルライブラリ（malebolgia等）の使用を推奨

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | typedthreads.nim | `lib/std/typedthreads.nim` | Thread型のエクスポート（80行目） |
| 1-2 | threadtypes.nim | `lib/std/private/threadtypes.nim` | Thread型の定義（参照） |

**読解のコツ**: Thread[TArg]はジェネリック型で、TArgはスレッド関数に渡す引数の型を表す。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | typedthreads.nim | `lib/std/typedthreads.nim` | createThread - Windows版（212-229行目） |
| 2-2 | typedthreads.nim | `lib/std/typedthreads.nim` | createThread - POSIX版（261-290行目） |

**主要処理フロー**:
1. **220行目（Windows）**: GcThreadのメモリ割り当て
2. **222-223行目**: 引数のコピー
3. **226-227行目**: Windows CreateThread呼び出し
4. **269行目（POSIX）**: GcThreadのメモリ割り当て
5. **288行目**: pthread_create呼び出し

#### Step 3: 待機・補助関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | typedthreads.nim | `lib/std/typedthreads.nim` | joinThread（163-165行目/187-189行目） |
| 3-2 | typedthreads.nim | `lib/std/typedthreads.nim` | joinThreads（167-176行目/191-193行目） |
| 3-3 | typedthreads.nim | `lib/std/typedthreads.nim` | running（152-154行目） |
| 3-4 | typedthreads.nim | `lib/std/typedthreads.nim` | handle（156-158行目） |
| 3-5 | typedthreads.nim | `lib/std/typedthreads.nim` | pinToCpu（231-236行目/292-301行目） |

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

```
アプリケーション
    │
    ├─ createThread(t, threadFunc, param)
    │      ├─ allocThreadStorage()
    │      ├─ パラメータコピー
    │      └─ Windows: CreateThread() / POSIX: pthread_create()
    │
    ├─ スレッド実行
    │      └─ threadProcWrapper[TArg]()
    │             └─ nimThreadProcWrapperBody()
    │                    └─ threadFunc(param)
    │
    ├─ joinThread(t)
    │      └─ Windows: waitForSingleObject() / POSIX: pthread_join()
    │
    └─ joinThreads(threads)
           └─ Windows: waitForMultipleObjects() / POSIX: pthread_join() * N
```

### データフロー図

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

threadFunc ─────▶ createThread ─────▶ Thread[TArg]
param ──────────▶      │
                       │
                       ▼
                 OS Thread API
                       │
                       ▼
                 スレッド並行実行
                       │
                       ▼
                 joinThread ─────────▶ 終了
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| typedthreads.nim | `lib/std/typedthreads.nim` | ソース | スレッド管理API |
| threadtypes.nim | `lib/std/private/threadtypes.nim` | ソース | Thread型定義 |
| locks.nim | `lib/pure/locks.nim` | ソース | ロック機構 |
| channels.nim | `lib/system/channels_builtin.nim` | ソース | チャネル通信 |
| ansi_c.nim | `lib/system/ansi_c.nim` | ソース | C関数ラッパー |
