# 機能設計書 14-pipe

## 概要

本ドキュメントは、Hack Standard Library（HSL）のIO名前空間における`pipe`関数の機能設計を記述する。この関数は、読み書きハンドルのペアを作成し、プロセス間通信などに使用できるパイプ機能を提供する。

### 本機能の処理概要

`pipe`関数は、Unixパイプを作成し、読み取り用と書き込み用のハンドルペアをタプルで返す。書き込みハンドルに書き込まれたデータは、読み取りハンドルから読み取ることができる。

**業務上の目的・背景**：プロセス間通信（IPC）において、データを一方から他方へ効率的に受け渡すための仕組みが必要である。パイプは、親子プロセス間の通信、非同期処理でのデータ受け渡し、ストリーム処理のチェーン構築など、様々な場面で使用される基本的なIPC機構を提供する。

**機能の利用シーン**：子プロセスとの通信、非同期タスク間のデータ受け渡し、ストリーム処理のテスト、複数の処理ステージ間のデータフロー構築など、データを一方向に流す必要がある場面で使用される。

**主要な処理内容**：
1. OS\pipe()を呼び出してファイルディスクリプタのペアを取得する
2. 読み取り用ファイルディスクリプタからPipeReadHandleを生成する
3. 書き込み用ファイルディスクリプタからPipeWriteHandleを生成する
4. タプル形式で両ハンドルを返す

**関連システム・外部連携**：OSレベルのパイプシステムコールに依存する。作成されたパイプは、Unixのpipe(2)システムコールの上位ラッパーとして機能する。

**権限による制御**：特段の権限制御はないが、ファイルディスクリプタの作成上限はOSレベルで管理される。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | 画面なし | - | 本プロジェクトはUIを持たないライブラリのため画面機能マッピングは該当しない |

## 機能種別

ハンドル生成 / プロセス間通信

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| なし | - | - | この関数は引数を取らない | - |

### 入力データソース

OSのパイプシステムコール

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値[0] | CloseableReadFDHandle | 読み取り用ハンドル。パイプからデータを読み取る |
| 戻り値[1] | CloseableWriteFDHandle | 書き込み用ハンドル。パイプにデータを書き込む |

### 出力先

呼び出し元にタプル `(CloseableReadFDHandle, CloseableWriteFDHandle)` を返す

## 処理フロー

### 処理シーケンス

```
1. OS\pipe()を呼び出し
   └─ ファイルディスクリプタのペアを取得
2. PipeReadHandleを生成
   └─ 読み取り用FDをラップ
3. PipeWriteHandleを生成
   └─ 書き込み用FDをラップ
4. タプルで返却
   └─ (ReadHandle, WriteHandle)
```

### フローチャート

```mermaid
flowchart TD
    A[pipe呼び出し] --> B[OS\pipe実行]
    B --> C[ファイルディスクリプタペア取得]
    C --> D[PipeReadHandle生成]
    D --> E[PipeWriteHandle生成]
    E --> F[タプル返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 一方向通信 | パイプは一方向のデータフローのみ対応 | 常時適用 |
| BR-02 | 自動クローズ | 両ハンドルはCloseableインターフェースを実装し、明示的なクローズが可能 | 常時適用 |
| BR-03 | ノンブロッキングモード | 作成されたハンドルはO_NONBLOCKモードで動作 | 常時適用 |

### 計算ロジック

特になし

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

該当なし（本機能はI/O操作のみでデータベースを使用しない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| EMFILE | OS\ErrnoException | プロセスのファイルディスクリプタ上限到達 | ファイルディスクリプタを解放してリトライ |
| ENFILE | OS\ErrnoException | システムのファイルディスクリプタ上限到達 | システム全体のリソース解放を待つ |

### リトライ仕様

リトライは実装されていない。エラー時は例外がスローされる。

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

該当なし

## パフォーマンス要件

パイプの作成はOSのシステムコールに依存する。通常、非常に高速（マイクロ秒オーダー）で完了する。

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

- パイプを通じて受け渡されるデータは暗号化されない
- 機密データの受け渡しには追加のセキュリティ層を検討する
- パイプのファイルディスクリプタは適切にクローズすること

## 備考

- 非推奨の`pipe_nd()`関数が存在するが、`pipe()`を使用することを推奨
- ネットワークソケットが必要な場合は`Network\Socket`を参照

---

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

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

### 推奨読解順序

#### Step 1: インターフェース定義を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Handle.php | `src/io/Handle.php` | IOハンドルの基本インターフェース |
| 1-2 | ReadHandle.php | `src/io/ReadHandle.php` | 読み取りハンドルのインターフェース |
| 1-3 | WriteHandle.php | `src/io/WriteHandle.php` | 書き込みハンドルのインターフェース |
| 1-4 | intersection_interfaces.php | `src/io/intersection_interfaces.php` | CloseableReadFDHandle、CloseableWriteFDHandleの定義 |

**読解のコツ**: パイプは読み取りと書き込みの両方のハンドルを返すため、両方のインターフェースを理解することが重要。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | pipe.php | `src/io/pipe.php` | pipe関数の本体 |

**主要処理フロー**:
1. **20行目**: pipe関数のシグネチャ。タプル型の戻り値に注目
2. **21行目**: OS\pipe()でファイルディスクリプタペアを取得
3. **22-25行目**: PipeReadHandleとPipeWriteHandleを生成してタプルで返却

#### Step 3: 内部実装クラスを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | PipeReadHandle.php | `src/io/_Private/PipeReadHandle.php` | 読み取り用パイプハンドル実装 |
| 3-2 | PipeWriteHandle.php | `src/io/_Private/PipeWriteHandle.php` | 書き込み用パイプハンドル実装 |
| 3-3 | FileDescriptorHandle.php | `src/io/_Private/FileDescriptorHandle.php` | ファイルディスクリプタハンドルの基底クラス |

**主要処理フロー**:
- **PipeReadHandle**: FileDescriptorHandleを継承し、FileDescriptorReadHandleTraitを使用（15-18行目）
- **PipeWriteHandle**: FileDescriptorHandleを継承し、FileDescriptorWriteHandleTraitを使用（15-18行目）

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

```
IO\pipe()
    │
    ├─ OS\pipe()
    │      └─ ファイルディスクリプタペア取得
    │
    ├─ _IO\PipeReadHandle
    │      └─ FileDescriptorHandle
    │             └─ FileDescriptorReadHandleTrait
    │
    └─ _IO\PipeWriteHandle
           └─ FileDescriptorHandle
                  └─ FileDescriptorWriteHandleTrait
```

### データフロー図

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

なし ─────────────▶ IO\pipe() ───────────────▶ タプル
                          │                        │
                    OS\pipe()                 ┌────┴────┐
                          │                   ▼         ▼
                    ┌─────┴─────┐      ReadHandle  WriteHandle
                    ▼           ▼
                read_fd     write_fd

使用例：
WriteHandle ──書込み──▶ パイプバッファ ──読取り──▶ ReadHandle
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| pipe.php | `src/io/pipe.php` | ソース | pipe関数のエントリーポイント |
| Handle.php | `src/io/Handle.php` | ソース | 基底インターフェース定義 |
| ReadHandle.php | `src/io/ReadHandle.php` | ソース | 読み取りハンドルインターフェース |
| WriteHandle.php | `src/io/WriteHandle.php` | ソース | 書き込みハンドルインターフェース |
| PipeReadHandle.php | `src/io/_Private/PipeReadHandle.php` | ソース | パイプ読み取りハンドル実装 |
| PipeWriteHandle.php | `src/io/_Private/PipeWriteHandle.php` | ソース | パイプ書き込みハンドル実装 |
| FileDescriptorHandle.php | `src/io/_Private/FileDescriptorHandle.php` | ソース | FDハンドル基底クラス |
| intersection_interfaces.php | `src/io/intersection_interfaces.php` | ソース | 複合インターフェース定義 |
