# バッチ設計書 5-mrblib.rake

## 概要

本ドキュメントは、`mrblib/*.rb` ファイルをCソースに変換しコンパイルするRakeタスク定義ファイル `tasks/mrblib.rake` の設計仕様を記述する。

### 本バッチの処理概要

`mrblib.rake` は、mrubyの標準ライブラリとして提供されるRubyソースファイル（`mrblib/*.rb`）をmrbcコンパイラでCダンプ形式に変換し、生成されたCソースファイルをオブジェクトファイルにコンパイルするタスクを定義する。

**業務上の目的・背景**：mrubyの標準ライブラリ（Array、Hash、String等のRubyレベルのメソッド実装）はRubyで記述されている。これらを組み込みバイナリに含めるため、Rubyソースコードをmrbcコンパイラでバイトコードに変換し、さらにCソースコードのダンプ形式（cdump）に変換する。これにより、mrubyランタイムの起動時にRuby標準ライブラリが自動的にロードされる。

**バッチの実行タイミング**：`rake build` の依存関係解決時に、libmrubyの構成要素として自動的に実行される。`libmruby_enabled?` が true のターゲットでのみ実行される。

**主要な処理内容**：
1. `mrblib/*.rb` のRubyソースファイルをソートして収集する
2. mrbcコンパイラを使用してRubyソースファイルをCダンプ形式に変換し、`mrblib.c` を生成する
3. 生成されたCソースには `mrb_init_mrblib` 関数が含まれ、mrubyの初期化時にプロシージャをロードする
4. `mrblib.c` をオブジェクトファイルにコンパイルし、`libmruby_objs` に追加する

**前後の処理との関連**：mrbcfile（mrbcバイナリ）が前提条件として必要。生成されたオブジェクトファイルは libmruby.rake（No.8）で `libmruby.a` に結合される。

**影響範囲**：`build/{target}/mrblib/` ディレクトリに `mrblib.c` と対応するオブジェクトファイルが生成される。

## バッチ種別

コード生成処理（Ruby-to-C変換 + コンパイル）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（ビルド時に自動実行） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | Rakeの依存関係解決により自動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| libmruby_enabled? | ターゲットでlibmrubyが有効であること |
| mrbcfile | mrbcコンパイラバイナリがビルド済みであること |
| mrblib/*.rb | mruby標準ライブラリのRubyソースファイルが存在すること |
| Cコンパイラ | 生成されたCソースをコンパイルするためのCコンパイラが必要 |

### 実行可否判定

`libmruby_enabled?` が false のターゲットでは `next` によりスキップされる。mrbcfile が存在しない場合は依存関係解決により先にmrbcがビルドされる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| mrblib/*.rb | Rubyソースファイル | mruby標準ライブラリのRubyソースコード |
| mrbcfile | 実行バイナリ | mrbcコンパイラバイナリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| build/{target}/mrblib/mrblib.c | Cソースファイル | Rubyソースから変換されたCダンプ |
| build/{target}/mrblib/mrblib.o | オブジェクトファイル | mrblib.cをコンパイルしたオブジェクト |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | mrblib.c / mrblib.o |
| 出力先 | `build/{target}/mrblib/` |
| 文字コード | ASCII（自動生成Cソース）/ バイナリ（オブジェクト） |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. libmruby有効チェック
   └─ libmruby_enabled? が false の場合はスキップ
2. 入力ファイル収集
   └─ Dir["#{MRUBY_ROOT}/mrblib/*.rb"].sort! で全Rubyソースをソート取得
3. Cソース生成（mrblib.c）
   └─ mrbc.run で全.rbファイルをCダンプ形式に変換
   └─ "mrblib_proc" という名前のプロシージャとして生成
   └─ mrb_init_mrblib 関数を末尾に追加
4. ヘッダーコメント出力
   └─ "This file is loading the mrblib" の自動生成コメント
5. オブジェクトファイル生成
   └─ mrblib.c をCコンパイルしてオブジェクトファイルを生成
6. libmruby_objs への登録
   └─ self.libmruby_objs << objfile(src.ext)
```

### フローチャート

```mermaid
flowchart TD
    A[mrblib.rake 処理開始] --> B{libmruby_enabled?}
    B -->|いいえ| C[スキップ]
    B -->|はい| D[mrblib/*.rb ファイル収集・ソート]
    D --> E[mrbcでCダンプ形式に変換]
    E --> F[mrblib.c を生成]
    F --> G[mrb_init_mrblib 関数を追加]
    G --> H[mrblib.c をCコンパイル]
    H --> I[libmruby_objs に追加]
    I --> J[mrblib.rake 処理終了]
    C --> J
```

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

### 操作別データベース影響一覧

本バッチではデータベース操作は発生しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | mrbc変換エラー | Rubyソースの構文エラー | 対象の.rbファイルの構文を確認 |
| - | コンパイルエラー | 生成されたmrblib.cのコンパイル失敗 | mrbcの出力を確認 |
| - | mrbcfile不在エラー | mrbcバイナリが見つからない | mrbcのビルドを先に実行 |

### リトライ仕様

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

### 障害時対応

Rubyソースの構文エラーの場合は対象ファイルを修正する。mrbcの問題の場合は `rake clean` 後に再ビルドする。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | mrblib/ 配下のRubyソースファイル数 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | mrbc + Cコンパイラ依存 |

## 排他制御

同一ビルドターゲットに対する同時実行は想定されていない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | Cソース生成時 | `_pp "GEN", "mrblib/*.rb", "#{t.name.relative_path}"` |
| エラーログ | エラー発生時 | mrbcまたはコンパイラのエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | CI/CDパイプラインの通知設定に依存 |

## 備考

- 生成される `mrblib.c` には自動生成の警告コメントが含まれ、手動変更は失われる旨が記載される。
- `mrbc.run` は `cdump: true, static: true` オプションで実行され、Cダンプ形式で静的データとして生成される。
- `mrblib_proc` という名前でプロシージャが生成され、`mrb_init_mrblib` 関数内で `mrb_load_proc` によりロードされる。
- `mrblib_proc_init_syms` が `mrb_load_proc` の前に呼び出され、シンボルの初期化が行われる。
