# 機能設計書 110-ファイルサイズ変更

## 概要

本ドキュメントは、libuvが提供するファイルサイズ変更機能（uv_fs_ftruncate）の設計を記述する。

### 本機能の処理概要

ファイルのサイズを指定したオフセット値に変更（切り詰めまたは拡張）する機能である。POSIXのftruncateシステムコールに対応するクロスプラットフォームラッパーを提供する。

**業務上の目的・背景**：ファイルのサイズ制御は、ログファイルのローテーション（切り詰め）、固定長ファイルの作成、メモリマップドファイルのサイズ調整、データベースファイルの事前割り当てなどに必要な操作である。libuvはこれを非同期APIとして提供し、イベントループのブロッキングを防止する。

**機能の利用シーン**：ログファイルの切り詰め（size=0でファイルをクリア）、固定長レコードファイルの作成、mmapに必要なファイルサイズの事前確保、一時ファイルの初期化、データベースファイルの拡張・縮小などに利用される。

**主要な処理内容**：
1. uv_fs_ftruncate(): ファイルディスクリプタを指定してファイルサイズを変更
2. 指定したオフセットより大きい部分は切り詰められ、小さい場合はNULバイトで拡張される
3. Linuxではio_uring対応あり
4. OSのftruncate()に直接委譲するシンプルなラッパー

**関連システム・外部連携**：OSのファイルシステム（POSIX ftruncate）

**権限による制御**：対象ファイルへの書き込み権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 24 | ファイルシステム操作 | 主機能 | uv_fs_ftruncate()によるファイルサイズ変更のAPI定義 |

## 機能種別

データ更新（ファイルサイズの変更）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| loop | uv_loop_t* | Yes | イベントループへのポインタ | NULLの場合は未定義動作 |
| req | uv_fs_t* | Yes | ファイルシステムリクエスト | NULLの場合はUV_EINVALを返す |
| file | uv_file | Yes | 対象ファイルのディスクリプタ | 無効なFDの場合はEBADFエラー。書き込み用にオープンされている必要あり |
| offset | int64_t | Yes | 新しいファイルサイズ（バイト） | 負の値はOS依存（一般的にEINVAL） |
| cb | uv_fs_cb | No | 完了時コールバック（NULLで同期実行） | - |

### 入力データソース

- ユーザーが指定するファイルディスクリプタとオフセット値

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| result | ssize_t | 成功時0、失敗時は負のエラーコード |

### 出力先

- uv_fs_tリクエスト構造体のresultフィールド

## 処理フロー

### 処理シーケンス

```
1. uv_fs_ftruncate() API呼び出し
   └─ INITマクロでリクエスト初期化（fs_type = UV_FS_FTRUNCATE）
2. パラメータ設定
   └─ req->file = file
   └─ req->off = off（int64_t）
3. io_uring最適化チェック（Linux非同期のみ）
   └─ uv__iou_fs_ftruncate()
4. POST処理
   └─ 非同期: スレッドプールに投入
   └─ 同期: uv__fs_work()を直接実行
5. ワーカー関数での実処理
   └─ ftruncate(req->file, req->off)
6. 結果格納・完了通知
```

### フローチャート

```mermaid
flowchart TD
    A[uv_fs_ftruncate呼び出し] --> B[INIT: リクエスト初期化]
    B --> C[file + offset設定]
    C --> D{cbがNULL?}
    D -->|No 非同期| E{io_uring対応?}
    E -->|Yes| F[uv__iou_fs_ftruncate]
    E -->|No| G[スレッドプールに投入]
    D -->|Yes 同期| H[uv__fs_work直接実行]
    F --> I[完了コールバック]
    G --> H
    H --> J[ftruncate syscall]
    J --> K{非同期?}
    K -->|Yes| I
    K -->|No| L[結果を直接返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-110a | 直接システムコール | OSのftruncate(req->file, req->off)に直接委譲する | 全ftruncate操作 |
| BR-110b | サイズ拡張 | offsetが現在のファイルサイズより大きい場合、NULバイトで拡張される（POSIX仕様） | offset > 現在サイズ |
| BR-110c | サイズ切り詰め | offsetが現在のファイルサイズより小さい場合、超過部分が切り詰められる | offset < 現在サイズ |
| BR-110d | io_uring最適化 | Linuxの非同期モードではio_uringが利用可能 | Linux非同期モード |

### 計算ロジック

特になし。offset値をそのままOSのftruncateに渡す。

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| UV_EINVAL | 入力不正 | reqがNULL、またはoffsetが不正 | 入力を確認する |
| UV_EBADF | 不正FD | 無効なFD、または書き込み用にオープンされていない | 有効なFDを書き込み可能な状態で指定する |
| UV_EFBIG | ファイル過大 | offsetがシステムの最大ファイルサイズを超過 | offset値を確認する |
| UV_EIO | I/Oエラー | ディスクエラー | ディスクの状態を確認する |
| UV_ECANCELED | キャンセル | リクエストがキャンセルされた | 必要に応じて再実行する |

### リトライ仕様

EINTRの場合はuv__fs_work内で自動リトライされる。

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

該当なし。ftruncate単体ではデータの永続性は保証されない。永続化にはfsyncとの併用が必要。

## パフォーマンス要件

- 非同期モードではスレッドプールで実行
- Linuxではio_uring対応によりスレッドプールを経由せずに実行可能
- ftruncate自体は高速だが、ファイルサイズ拡張時にはディスクI/Oが発生する可能性がある

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

- ファイルサイズの拡張時に追加される領域はNULバイトで埋められ、他のプロセスのデータが露出することはない
- 書き込み権限のチェックはOSカーネルが行う

## 備考

- uv_fs_req_cleanup()でリソース解放が必要
- offset=0でファイルの内容を完全にクリアできる
- ファイルのオフセットポインタ（seek位置）は変更されない

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | uv.h | `include/uv.h` | uv_fs_ftruncate API宣言（1579-1583行目）：file、offset引数 |
| 1-2 | uv.h | `include/uv.h` | uv_fs_t構造体（1450-1460行目）：offフィールドの使用 |

**読解のコツ**: offsetはint64_tで受け取り、req->offに格納される。ftruncate()のoff_t型への変換はOS側で行われる。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | fs.c | `src/unix/fs.c` | uv_fs_ftruncate()（1896-1908行目）：公開API関数 |

**主要処理フロー**:
1. **1901行目**: INIT(FTRUNCATE)でリクエスト初期化
2. **1902行目**: req->file = fileでFDを設定
3. **1903行目**: req->off = offでオフセットを設定
4. **1904-1906行目**: io_uring最適化チェック
5. **1907行目**: POST実行

#### Step 3: ディスパッチを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | fs.c | `src/unix/fs.c` | uv__fs_work()（1710行目）：ftruncate(req->file, req->off)の直接呼び出し |

**主要処理フロー**:
- **1710行目**: X(FTRUNCATE, ftruncate(req->file, req->off))でOSのftruncateを直接呼び出し

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

```
uv_fs_ftruncate()
    │
    ├─ INIT(FTRUNCATE)
    ├─ req->file = file
    ├─ req->off = off
    ├─ uv__iou_fs_ftruncate()  [io_uring、Linux非同期のみ]
    │
    └─ POST
        ├─ [非同期] uv__work_submit()
        │       └─ uv__fs_work()
        │              └─ ftruncate(req->file, req->off)
        │
        └─ [同期] uv__fs_work()
               └─ ftruncate(req->file, req->off)
```

### データフロー図

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

ファイルFD           ──── ftruncate syscall         uv_fs_t.result
  (file)                                               (0 or エラー)

オフセット            ──── req->offとして渡す
  (offset: int64_t)

uv_loop_t            ──── スレッドプール / io_uring
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| uv.h | `include/uv.h` | ヘッダー | uv_fs_ftruncate API宣言 |
| fs.c | `src/unix/fs.c` | ソース | Unix/macOS向けftruncate実装 |
| fs.c | `src/win/fs.c` | ソース | Windows向けftruncate実装 |
