# 通知設計書 3-ファイルシステム変更通知

## 概要

本ドキュメントは、libuvにおけるファイルシステム変更通知（uv_fs_event_cb）の設計を記述する。OS固有のファイル監視機能を抽象化し、ファイルやディレクトリの変更（名前変更・内容変更）を検出してコールバックで通知するメカニズムについて定義する。

### 本通知の処理概要

uv_fs_event_cbは、ファイルやディレクトリに対する変更をOSカーネルの機能で検出し、イベントループを通じてコールバックで通知する仕組みである。プラットフォームごとに異なるOS機能（macOS: FSEvents/kqueue、Linux: inotify、BSD: kqueue）を抽象化し、統一的なAPIを提供する。

**業務上の目的・背景**：ファイルの変更をリアルタイムに検出する必要があるアプリケーション（設定ファイルの自動リロード、ファイル同期ツール、ビルドツールのウォッチモード等）にとって、ポーリングではなくOS通知ベースの効率的なファイル監視が不可欠である。本通知は、OS固有の監視APIの差異を吸収し、クロスプラットフォームで統一的なファイル変更検出を実現する。

**通知の送信タイミング**：監視対象のファイルまたはディレクトリに対して変更（内容変更、名前変更、作成、削除等）が発生した時点で、OSカーネルからイベントが通知され、イベントループのI/Oポーリングフェーズでコールバックが実行される。

**通知の受信者**：uv_fs_event_start()でファイル監視を開始したuv_fs_event_tハンドルに設定されたコールバック関数（uv_fs_event_cb）が受信者となる。

**通知内容の概要**：コールバックにはuv_fs_event_tハンドル、変更されたファイル名（const char* filename）、イベント種別（UV_RENAME=1またはUV_CHANGE=2）、ステータス（エラー時は負のエラーコード）が渡される。

**期待されるアクション**：受信者は変更の種類に応じた処理を行う。例えば設定ファイルの再読み込み、変更されたファイルの再ビルド、ファイルの同期等。

## 通知種別

コールバック通知（Cコールバック関数呼び出し）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（OS固有のファイル監視API経由でイベントループに通知） |
| 優先度 | 中（I/Oポーリングで処理される） |
| リトライ | なし |

### 送信先決定ロジック

uv_fs_event_start()で監視を開始したuv_fs_event_tハンドルに紐づくI/Oウォッチャーまたはプラットフォーム固有のイベントストリームを通じて、対応するコールバックが呼び出される。macOSではディレクトリに対してはFSEventsAPI、ファイルに対してはkqueue EVFILT_VNODEが使用される。

## 通知テンプレート

### コールバック関数シグネチャ

| 項目 | 内容 |
|-----|------|
| 関数型 | `typedef void (*uv_fs_event_cb)(uv_fs_event_t* handle, const char* filename, int events, int status)` |
| 定義場所 | `include/uv.h` 404-407行目 |

### コールバックパラメータ

```
handle: uv_fs_event_t* - ファイル監視ハンドル
filename: const char* - 変更されたファイル名（相対パスまたはNULL）
events: int - イベント種別（UV_RENAME=1, UV_CHANGE=2）
status: int - ステータス（0=成功、負の値=エラーコード）
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| handle | ファイル監視ハンドル | I/Oウォッチャー経由 | Yes |
| filename | 変更ファイル名 | OS固有API（inotify_event.name, FSEventのpath等） | No（NULLの場合あり） |
| events | イベント種別ビットマスク | OS固有イベントからの変換 | Yes |
| status | エラーステータス | OS固有エラーコード | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ファイル変更 | 監視対象の内容変更 | uv_fs_event_start()で監視中 | UV_CHANGEイベント |
| ファイル名変更 | 監視対象の名前変更/作成/削除 | uv_fs_event_start()で監視中 | UV_RENAMEイベント |
| エラー発生 | OS監視機能のエラー | 監視中にOSエラーが発生 | statusに負のエラーコード |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ハンドル非アクティブ | uv__is_active(handle)がfalseの場合（kqueue.c 553行目） |
| ハンドルクローズ中 | uv__is_closing(handle)がtrueの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ファイル変更発生] --> B[OSカーネル通知]
    B --> C{プラットフォーム}
    C -->|macOS ディレクトリ| D[FSEventsコールバック]
    C -->|macOS ファイル/BSD| E[kqueue EVFILT_VNODE]
    C -->|Linux| F[inotifyイベント]
    D --> G[イベント変換]
    E --> G
    F --> G
    G --> H[uv_fs_event_cb呼び出し]
    H --> I[終了]
```

## データベース参照・更新仕様

### 内部データ構造

| データ構造 | 用途 | 備考 |
|-----------|------|------|
| uv_fs_event_t.path | 監視対象パス | uv__strdup()で複製保持 |
| uv_fs_event_t.cb | ユーザーコールバック | uv_fs_event_cb型 |
| uv_fs_event_t.event_watcher | I/Oウォッチャー（kqueue用） | fdはopen()で取得したファイルディスクリプタ |
| uv__fsevents_event_t | FSEventsイベントデータ（macOS） | キューで管理、eventsとpathを含む |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| UV_EINVAL | ハンドルが既にアクティブ | エラーコードを返却（kqueue.c 553-554行目） |
| UV_ENOMEM | パス文字列の複製失敗 | エラーコードを返却（kqueue.c 558-559行目） |
| ファイルopen失敗 | 監視対象ファイルが存在しない等 | UV__ERR(errno)を返却（kqueue.c 563-567行目） |
| OSイベントエラー | kqueue/inotify/FSEventsのエラー | statusパラメータで通知 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | なし |
| リトライ対象エラー | なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし（OSのイベント配送頻度に依存） |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし。

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

- 監視対象ファイルへのread権限が必要（open(O_RDONLY)を使用: kqueue.c 562行目）
- macOSのFSEventsではfork後の動作に制限あり（atomic uv__has_forked_with_cfrunloopフラグで制御）

## 備考

- macOSではディレクトリに対してFSEventsAPIを優先使用し、ファイルに対してはkqueue EVFILT_VNODEにフォールバック
- UV_FS_EVENT_RECURSIVEフラグによる再帰的監視はプラットフォームにより対応が異なる
- フラグ: UV_FS_EVENT_WATCH_ENTRY, UV_FS_EVENT_STAT, UV_FS_EVENT_RECURSIVE

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | uv.h | `include/uv.h` | 404-407行目: uv_fs_event_cb型定義、233行目: uv_fs_event_t前方宣言、1770-1776行目: 公開API宣言 |
| 1-2 | fsevents.c | `src/unix/fsevents.c` | 51-70行目: FSEvents定数定義（kFSEventsModified, kFSEventsRenamed, kFSEventsSystem） |
| 1-3 | fsevents.c | `src/unix/fsevents.c` | 88-100行目: uv__fsevents_event_t, uv__cf_loop_state_t構造体 |

**読解のコツ**: macOSではFSEventsとkqueueの二つのパスがあり、ディレクトリかファイルかで使い分けられる。kqueue.c内のuv_fs_event_start()のfallbackラベルに注目。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | kqueue.c | `src/unix/kqueue.c` | 537-540行目: uv_fs_event_init() - ハンドル初期化 |
| 2-2 | kqueue.c | `src/unix/kqueue.c` | 543-609行目: uv_fs_event_start() - 監視開始（macOS: FSEvents/kqueue分岐、BSD: kqueue） |

**主要処理フロー**:
1. **557行目**: パスの複製
2. **562行目**: open(O_RDONLY)でファイルディスクリプタ取得
3. **579行目**: ディレクトリ判定（S_IFDIR）
4. **587行目**: FSEvents初期化（ディレクトリの場合）
5. **599-603行目**: kqueue EVFILT_VNODEによるI/Oウォッチャー初期化（ファイルの場合）

#### Step 3: プラットフォーム固有実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | fsevents.c | `src/unix/fsevents.c` | macOS FSEventsAPIを使用したディレクトリ監視の実装 |
| 3-2 | kqueue.c | `src/unix/kqueue.c` | kqueue EVFILT_VNODEを使用したファイル監視（EV_ADD | EV_ONESHOTで再登録パターン） |

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

```
uv_fs_event_init()
    +-- uv__handle_init()

uv_fs_event_start()
    +-- uv__strdup(path)
    +-- open(path, O_RDONLY)
    +-- [macOS ディレクトリ]
    |       +-- uv__fsevents_init()
    |           +-- FSEventStreamCreate()
    |           +-- CFRunLoop統合
    |
    +-- [kqueue フォールバック]
            +-- uv__io_init_start() [UV__FS_EVENT]
            +-- kevent(EVFILT_VNODE, EV_ADD | EV_ONESHOT)

[イベント発生時]
uv__fs_event()                ← I/Oウォッチャーから呼び出し
    +-- kevent結果からイベント変換
    +-- handle->cb(handle, filename, events, 0)
    +-- kevent再登録（EV_ONESHOT）
```

### データフロー図

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

ファイル変更        OSカーネル通知
(write/rename等)  ──▶  kqueue/inotify/FSEvents
                         │
                         ▼
                  [イベントループ I/Oポーリング]
                  uv__fs_event() / FSEventsコールバック
                         │
                         ▼
                  イベント種別変換
                  (UV_RENAME / UV_CHANGE)
                         │
                         ▼
                  handle->cb(handle, filename, events, status) ──▶ ユーザーコールバック
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| uv.h | `include/uv.h` | ヘッダ | uv_fs_event_cb型定義、uv_fs_event_t構造体定義、公開API宣言 |
| kqueue.c | `src/unix/kqueue.c` | ソース | macOS/BSD向けkqueue実装（uv_fs_event_init, uv_fs_event_start, uv_fs_event_stop） |
| fsevents.c | `src/unix/fsevents.c` | ソース | macOS FSEventsAPI実装（ディレクトリ監視） |
| linux.c | `src/unix/linux.c` | ソース | Linux inotify実装 |
| no-fsevents.c | `src/unix/no-fsevents.c` | ソース | FSEvents非サポートプラットフォーム向けスタブ |
| darwin-stub.h | `src/unix/darwin-stub.h` | ヘッダ | macOS CoreFoundation/FSEvents型定義 |
