# 機能設計書 107-segfaults

## 概要

本ドキュメントは、Nim標準ライブラリの`segfaults`モジュールの機能設計を記述する。このモジュールは、セグメンテーションフォルト（アクセス違反）をNilAccessDefect例外に変換する機能を提供する。

### 本機能の処理概要

`segfaults`モジュールは、オペレーティングシステムからのセグメンテーションフォルトシグナル（SIGSEGV）またはアクセス違反例外を捕捉し、Nimの例外（NilAccessDefect）として再発生させる。これにより、通常はプログラムを即時終了させるメモリアクセス違反を、try-exceptで捕捉可能な例外として処理できるようになる。

**業務上の目的・背景**：Nimプログラムでnilポインタにアクセスした場合、通常はセグメンテーションフォルトが発生しプログラムが強制終了する。このモジュールをimportすることで、nilアクセスを例外として捕捉し、適切なエラーハンドリングやリカバリを行えるようになる。デバッグ時のエラー特定や、堅牢なアプリケーション開発に有用。

**機能の利用シーン**：デバッグ時のnilアクセス検出、堅牢なサーバーアプリケーション開発、FFI（Foreign Function Interface）使用時の安全性向上、テストフレームワークでのエラー検出など。

**主要な処理内容**：
1. シグナルハンドラ/例外ハンドラの登録
2. SIGSEGV/アクセス違反の捕捉
3. NilAccessDefect例外の発生

**関連システム・外部連携**：OS固有のシグナルAPI（Unix: sigaction、Windows: Vectored Exception Handling）。

**権限による制御**：権限による制御は存在しない。

## 関連画面

本モジュールは標準ライブラリであり、特定の画面との関連はない。

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | - |

## 機能種別

エラーハンドリング / システムユーティリティ

## 入力仕様

### 入力パラメータ

本モジュールはimportするだけで機能が有効になり、明示的な入力パラメータはない。

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| - | - | - | - | - |

### 入力データソース

OSからのシグナル/例外。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| NilAccessDefect | ref Exception | nilアクセス時に発生する例外 |

### 出力先

Nim例外システム（raise）。

## 処理フロー

### 処理シーケンス

```
1. モジュールロード時の初期化
   └─ NilAccessDefect例外オブジェクトを事前確保
   └─ シグナル/例外ハンドラを登録

2. セグメンテーションフォルト発生時
   └─ OSがシグナル/例外を発生
   └─ 登録済みハンドラが呼び出される
   └─ SEGV_MAPERRの場合（nilアクセス）
       └─ 事前確保したNilAccessDefectをraise
   └─ それ以外の場合
       └─ プログラムを終了（Unix）または検索継続（Windows）
```

### フローチャート

```mermaid
flowchart TD
    A[モジュールimport] --> B[NilAccessDefect事前確保]
    B --> C{プラットフォーム?}
    C -->|Windows| D[AddVectoredExceptionHandler]
    C -->|Unix| E[sigaction SIGSEGV]
    D --> F[待機]
    E --> F

    G[セグメンテーションフォルト発生] --> H{プラットフォーム?}
    H -->|Windows| I{EXCEPTION_ACCESS_VIOLATION?}
    H -->|Unix| J{SEGV_MAPERR?}
    I -->|Yes| K[raise NilAccessDefect]
    I -->|No| L[EXCEPTION_CONTINUE_SEARCH]
    J -->|Yes| K
    J -->|No| M[quit(1)]
    K --> N[例外として伝播]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 自動登録 | importするだけでハンドラが登録される | モジュールロード時 |
| BR-02 | 事前確保 | 例外オブジェクトは事前に確保（シグナルハンドラ内でのメモリ確保を回避） | 初期化時 |
| BR-03 | SEGV_MAPERR判定 | nilアクセス（SEGV_MAPERR）のみをNilAccessDefectに変換 | シグナル受信時 |
| BR-04 | スタックトレースなし | シグナルハンドラ内ではスタックトレース出力しない | `{.push stackTrace: off.}` |

### 計算ロジック

**例外の事前確保**:
```nim
var se: ref NilAccessDefect
new(se)
se.name = "NilAccessDefect"
se.msg = "Could not access value because it is nil."
```

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

本モジュールはデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| NilAccessDefect | 実行時例外 | nilポインタへのアクセス | try-exceptで捕捉 |
| quit(1) | プログラム終了 | SEGV_MAPERR以外のセグフォルト | プログラム修正 |

### リトライ仕様

リトライは不要。例外を捕捉した場合は適切な処理を行う。

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

トランザクション管理は不要。

## パフォーマンス要件

- シグナルハンドラは最小限の処理のみ
- 例外オブジェクトの事前確保により、ハンドラ内でのメモリ確保を回避

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

- arm64での動作に問題がある可能性あり（bug #17178）
- シグナルハンドラは特殊なコンテキストで実行されるため、デバッグ困難

## 備考

- `{.used.}`プラグマによりimportするだけで機能が有効化
- Linux、Windows、macOSでテスト済み

---

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

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

### 推奨読解順序

#### Step 1: 初期化処理を理解する

例外オブジェクトの事前確保を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | segfaults.nim | `lib/pure/segfaults.nim` | 18行目: `{.used.}`プラグマ |
| 1-2 | segfaults.nim | `lib/pure/segfaults.nim` | 20-24行目: NilAccessDefect事前確保 |

**読解のコツ**: `{.used.}`プラグマにより、モジュールをimportするだけで副作用（ハンドラ登録）が実行される。例外オブジェクトは事前確保されており、シグナルハンドラ内ではメモリ確保が行われない。

#### Step 2: Windows実装を理解する

Vectored Exception Handlingを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | segfaults.nim | `lib/pure/segfaults.nim` | 26-46行目: Windows用の型定義 |
| 2-2 | segfaults.nim | `lib/pure/segfaults.nim` | 48-55行目: segfaultHandler（Windows版） |
| 2-3 | segfaults.nim | `lib/pure/segfaults.nim` | 57行目: ハンドラ登録 |

**主要処理フロー**:
- **32-33行目**: EXCEPTION_ACCESS_VIOLATIONの定数定義
- **50行目**: 例外コードがACCESS_VIOLATIONか確認
- **51-52行目**: NilAccessDefectをraise
- **54行目**: それ以外はEXCEPTION_CONTINUE_SEARCHを返却

#### Step 3: Unix実装を理解する

sigactionによるSIGSEGVハンドリングを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | segfaults.nim | `lib/pure/segfaults.nim` | 67-68行目: posixモジュールのimport |
| 3-2 | segfaults.nim | `lib/pure/segfaults.nim` | 70-71行目: Sigaction変数とSEGV_MAPERR |
| 3-3 | segfaults.nim | `lib/pure/segfaults.nim` | 73-81行目: segfaultHandler（Unix版） |
| 3-4 | segfaults.nim | `lib/pure/segfaults.nim` | 83-88行目: sigaction登録 |

**主要処理フロー**:
- **72行目**: SEGV_MAPERRをheaderからimport
- **76行目**: si_codeがSEGV_MAPERRか確認
- **77-78行目**: NilAccessDefectをraise
- **80行目**: それ以外はquit(1)でプログラム終了
- **85-86行目**: SA_SIGINFO | SA_NODEFERフラグでハンドラ設定

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

```
segfaults.nim
    │
    ├─ 初期化（モジュールロード時）
    │      ├─ NilAccessDefect事前確保
    │      │      └─ new(se)
    │      │      └─ se.name = "NilAccessDefect"
    │      │      └─ se.msg = "..."
    │      │
    │      └─ ハンドラ登録
    │             │
    │             ├─ [Windows]
    │             │      └─ AddVectoredExceptionHandler
    │             │
    │             └─ [Unix]
    │                    └─ sigaction(SIGSEGV, sa)
    │
    └─ ハンドラ実行（セグフォルト発生時）
           │
           ├─ [Windows] segfaultHandler
           │      ├─ EXCEPTION_ACCESS_VIOLATION → raise se
           │      └─ その他 → EXCEPTION_CONTINUE_SEARCH
           │
           └─ [Unix] segfaultHandler
                  ├─ SEGV_MAPERR → raise se
                  └─ その他 → quit(1)
```

### データフロー図

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

モジュールimport ───────▶ 初期化処理 ────────────────▶ ハンドラ登録済み
                              │
                              └─▶ NilAccessDefect事前確保

(nilアクセス発生) ──────▶ OS検出 ─────────────────────▶ シグナル/例外

シグナル/例外 ──────────▶ segfaultHandler ────────────▶ raise NilAccessDefect
                              │                            │
                              │                            ▼
                              │                     try-exceptで捕捉可能
                              │
                              └─▶ (SEGV_MAPERR以外) ──▶ quit(1) / 検索継続
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| segfaults.nim | `lib/pure/segfaults.nim` | ソース | メインモジュール、全機能の実装 |
| ansi_c.nim | `lib/system/ansi_c.nim` | 依存 | ANSI C関数インターフェース（Windows用） |
| winlean.nim | `lib/pure/winlean.nim` | 依存 | Windows API（Windows用） |
| posix.nim | `lib/posix/posix.nim` | 依存 | POSIX API（Unix用） |
