# 機能設計書 109-ファイル同期

## 概要

本ドキュメントは、libuvが提供するファイル同期機能（uv_fs_fsync / uv_fs_fdatasync）の設計を記述する。

### 本機能の処理概要

ファイルのデータおよびメタデータをディスクに同期（フラッシュ）する機能である。fsyncは全てのデータとメタデータを同期し、fdatasyncはデータのみを同期する。macOSではF_FULLFSYNCを使用してドライブの書き込みキャッシュまでフラッシュする。

**業務上の目的・背景**：データベースやジャーナルファイルなど、データの永続性が重要なアプリケーションでは、write()の後にデータが確実にディスクに書き込まれることを保証する必要がある。fsync/fdatasyncはこの保証を提供する。特にmacOSでは標準のfsync()がドライブキャッシュをフラッシュしないため、libuvはF_FULLFSYNCを使用してSQLiteと同様のアプローチを取る。

**機能の利用シーン**：データベースエンジンのトランザクションコミット、ログファイルの確実な書き込み保証、設定ファイルのアトミックな更新（書き込み→fsync→リネーム）、ジャーナルファイルシステムのメタデータ同期などに利用される。

**主要な処理内容**：
1. uv_fs_fsync(): ファイルの全データとメタデータをディスクに同期
2. uv_fs_fdatasync(): ファイルのデータのみをディスクに同期（メタデータは同期しない場合あり）
3. macOSではF_FULLFSYNC→F_BARRIERFSYNC→fsync()の順でフォールバック
4. Linuxではio_uring対応あり

**関連システム・外部連携**：OSのファイルシステム（POSIX fsync/fdatasync、macOS fcntl F_FULLFSYNC/F_BARRIERFSYNC）

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 24 | ファイルシステム操作 | 主機能 | uv_fs_fsync()/fdatasync()によるディスク同期のAPI定義 |

## 機能種別

データ同期（ファイルバッファのディスクへのフラッシュ）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| loop | uv_loop_t* | Yes | イベントループへのポインタ | NULLの場合は未定義動作 |
| req | uv_fs_t* | Yes | ファイルシステムリクエスト | NULLの場合はUV_EINVALを返す |
| file | uv_file | Yes | 同期対象のファイルディスクリプタ | 無効なFDの場合はEBADFエラー |
| cb | uv_fs_cb | No | 完了時コールバック（NULLで同期実行） | - |

### 入力データソース

- ユーザーが指定するファイルディスクリプタ

## 出力仕様

### 出力データ

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

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. API関数呼び出し（uv_fs_fsync / uv_fs_fdatasync）
   └─ INITマクロでリクエスト初期化
2. req->fileにFDを設定
3. io_uring最適化チェック（Linux非同期のみ）
   └─ uv__iou_fs_fsync_or_fdatasync()
4. POST処理（非同期/同期の分岐）
5. ワーカー関数での実処理
   └─ fsync:
      ├─ [macOS] fcntl(fd, F_FULLFSYNC) → 失敗時 fcntl(fd, F_BARRIERFSYNC) → 失敗時 fsync()
      └─ [その他] fsync(fd)
   └─ fdatasync:
      ├─ [Linux/Sun/NetBSD] fdatasync(fd)
      ├─ [macOS] uv__fs_fsync(req)にフォールバック
      └─ [その他] fsync(fd)
6. 結果格納・完了通知
```

### フローチャート

```mermaid
flowchart TD
    A[uv_fs_fsync/fdatasync] --> B[INIT + file設定]
    B --> C{io_uring対応?}
    C -->|Yes| D[uv__iou_fs_fsync_or_fdatasync]
    C -->|No| E[POST]
    D --> F[完了通知]
    E --> G[uv__fs_work]
    G -->|fsync| H{macOS?}
    H -->|Yes| I[fcntl F_FULLFSYNC]
    I -->|失敗| J[fcntl F_BARRIERFSYNC]
    J -->|失敗| K[fsync fallback]
    H -->|No| K
    G -->|fdatasync| L{OS種別}
    L -->|Linux/Sun/NetBSD| M[fdatasync syscall]
    L -->|macOS| N[uv__fs_fsync にフォールバック]
    L -->|その他| O[fsync syscall]
    K --> P[結果返却]
    I -->|成功| P
    J -->|成功| P
    M --> P
    N --> P
    O --> P
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-109a | macOS F_FULLFSYNC | macOSではfsync()がドライブの書き込みキャッシュをフラッシュしないため、fcntl(F_FULLFSYNC)を優先使用する | macOS環境でのfsync |
| BR-109b | macOS フォールバック | F_FULLFSYNCがファイルシステムに非対応の場合、F_BARRIERFSYNC→fsync()の順でフォールバック | macOS環境でF_FULLFSYNC失敗時 |
| BR-109c | macOS fdatasync等価 | macOSではfdatasyncもF_FULLFSYNC→F_BARRIERFSYNC→fsync()の順で実行（fdatasyncとfsyncに実質的な差異なし） | macOS環境 |
| BR-109d | io_uring最適化 | LinuxではIORING_FSYNC_DATASYNCフラグの有無でfsync/fdatasyncを切り替え | Linux非同期モード |
| BR-109e | fdatasync対応OS | Linux/Sun/NetBSDのみfdatasync()が利用可能。その他はfsync()にフォールバック | fdatasync呼び出し時 |

### 計算ロジック

特になし。OSのシステムコールに委譲する。

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| UV_EINVAL | 入力不正 | reqがNULL | 入力を確認する |
| UV_EBADF | 不正FD | 無効なFDが渡された | 有効なFDを指定する |
| UV_EIO | I/Oエラー | ディスクへの書き込みに失敗 | ディスクの状態を確認する |
| UV_ECANCELED | キャンセル | リクエストがキャンセルされた | 必要に応じて再実行する |

### リトライ仕様

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

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

fsync/fdatasyncはOSレベルでのデータ永続化保証を提供する。アプリケーションレベルのトランザクションでは、write→fsync→renameの順で使用することでアトミックな更新が実現可能。

## パフォーマンス要件

- fsync/fdatasyncはディスクI/Oを伴うため、他のFS操作と比較して遅い
- fdatasyncはメタデータを同期しないため、fsyncよりも高速な場合がある
- 非同期モードではスレッドプールで実行し、メインループをブロックしない
- Linuxではio_uring対応により効率的な非同期同期が可能

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

- データの永続性保証はセキュリティ監査ログの整合性確保に重要

## 備考

- macOSのF_FULLFSYNC使用はSQLiteと同様のアプローチである（コメントに記載あり）
- F_BARRIERFSYNCは定数85としてハードコードされている（include未定義の場合に対応）
- uv_fs_req_cleanup()でリソース解放が必要

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | uv.h | `include/uv.h` | uv_fs_fsync/fdatasync API宣言（1571-1578行目） |

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | fs.c | `src/unix/fs.c` | uv_fs_fsync()（1886-1893行目）：fsync公開API |
| 2-2 | fs.c | `src/unix/fs.c` | uv_fs_fdatasync()（1866-1873行目）：fdatasync公開API |

**主要処理フロー**:
1. **1887行目**: INIT(FSYNC) + file設定
2. **1889-1891行目**: io_uring最適化チェック（フラグ0=fsync）
3. **1867行目**: INIT(FDATASYNC) + file設定
4. **1870行目**: io_uring最適化チェック（フラグ1=IORING_FSYNC_DATASYNC）

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | fs.c | `src/unix/fs.c` | uv__fs_fsync()（170-191行目）：macOS F_FULLFSYNC対応のfsync実装 |
| 3-2 | fs.c | `src/unix/fs.c` | uv__fs_fdatasync()（194-203行目）：OS別fdatasync実装 |

**主要処理フロー**:
- **182行目**: fcntl(req->file, F_FULLFSYNC)でmacOS固有の完全同期を試行
- **184行目**: F_FULLFSYNC失敗時にF_BARRIERFSYNC（定数85）を試行
- **186行目**: F_BARRIERFSYNC失敗時にfsync()にフォールバック
- **196行目**: Linux/Sun/NetBSDではfdatasync()を直接呼び出し
- **199行目**: macOSではuv__fs_fsync()にフォールバック（コメント参照）
- **201行目**: その他のOSではfsync()を使用

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

```
uv_fs_fsync() / uv_fs_fdatasync()
    │
    ├─ INIT(FSYNC/FDATASYNC)
    ├─ req->file設定
    ├─ uv__iou_fs_fsync_or_fdatasync()  [io_uring、Linux非同期のみ]
    │
    └─ POST
        └─ uv__fs_work()
               ├─ uv__fs_fsync(req)
               │      ├─ [macOS] fcntl(F_FULLFSYNC)
               │      │         └─ fcntl(F_BARRIERFSYNC)
               │      │               └─ fsync()
               │      └─ [その他] fsync()
               └─ uv__fs_fdatasync(req)
                      ├─ [Linux/Sun/NetBSD] fdatasync()
                      ├─ [macOS] uv__fs_fsync()
                      └─ [その他] fsync()
```

### データフロー図

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

ファイルFD           ──── fsync/fdatasync           uv_fs_t.result
  (file)                  システムコール                (0 or エラー)
                          [macOS: F_FULLFSYNC優先]

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

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| uv.h | `include/uv.h` | ヘッダー | uv_fs_fsync/fdatasync API宣言 |
| fs.c | `src/unix/fs.c` | ソース | Unix/macOS向けfsync実装（F_FULLFSYNC対応） |
| fs.c | `src/win/fs.c` | ソース | Windows向けfsync実装 |
