# 機能設計書 26-コードダンプ

## 概要

本ドキュメントは、mrubyにおけるコードダンプ機能の設計を記述する。irepのオペコードを人間が読める形式でダンプする。デバッグ用途で使用される。

### 本機能の処理概要

コードダンプ機能は、コンパイルされたmrubyバイトコード（irep）を人間が読めるアセンブリ風テキスト形式で標準出力またはファイルに出力する。各オペコードの名前、オペランド、対応するソース行番号、ローカル変数名を表示する。

**業務上の目的・背景**：mrubyのバイトコードをデバッグ・最適化する際に、コンパイラが生成したオペコード列を視覚的に確認する必要がある。コードダンプはirepの内部構造を可読形式で表示し、コンパイラの動作検証やパフォーマンスチューニングを支援する。

**機能の利用シーン**：mrubyコマンドの`-v`（verbose）オプション使用時、コンパイラコンテキストのdump_result設定時、デバッガでのコード確認時。

**主要な処理内容**：
1. irepヘッダ情報の出力（nregs, nlocals, pools, syms, reps, ilen）
2. ローカル変数名の一覧出力
3. catch handler テーブルの出力
4. 各オペコードのデコードと表示（約80種類以上のオペコード対応）
5. 行番号・ファイル名の付与
6. 子irepの再帰的ダンプ

**関連システム・外部連携**：デバッグ情報（debug.c）から行番号・ファイル名を取得。irep構造体のシンボル・プール・ローカル変数を参照。

**権限による制御**：特になし。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 標準出力またはファイルへのテキスト出力 |

## 機能種別

帳票出力（バイトコードの可読テキスト出力）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| mrb | mrb_state* | Yes | mrubyインタプリタ状態 | - |
| proc | struct RProc* | Yes | ダンプ対象のProc | - |
| out | FILE* | No | 出力先（デフォルトstdout） | - |

### 入力データソース

- コンパイラまたはバイナリローダから生成されたProcオブジェクト

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| テキスト出力 | 文字列 | オペコードの可読形式表現 |

### 出力先

標準出力またはFILE*指定のファイル

## 処理フロー

### 処理シーケンス

```
1. irep情報ヘッダ出力
   └─ nregs, nlocals, pools, syms, reps, ilen
2. ローカル変数名出力（lv配列が存在する場合）
3. catch handlerテーブル出力（clen > 0の場合）
4. 命令列ループ
   ├─ ファイル名変更検出・出力
   ├─ 行番号表示（mrb_debug_get_line）
   ├─ オペコードデコード・表示
   └─ ローカル変数注釈表示
5. 子irep再帰ダンプ（codedump_recur）
```

### フローチャート

```mermaid
flowchart TD
    A[mrb_codedump_all] --> B[codedump_recur]
    B --> C[codedump: irep情報出力]
    C --> D[ローカル変数名出力]
    D --> E[catch handler出力]
    E --> F[命令列ループ]
    F --> G{次の命令?}
    G -->|あり| H[ファイル名・行番号取得]
    H --> I[オペコードデコード・表示]
    I --> G
    G -->|なし| J[子irep再帰処理]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | ファイル変更検出 | ファイル名が変わった場合にfile: ヘッダを表示 | 命令列ループ |
| BR-02 | 行番号表示 | 行番号取得不可時は空白6文字で表示 | print_header |
| BR-03 | EXT命令対応 | OP_EXT1/EXT2/EXT3の後に拡張オペコードを読み出す | 命令列ループ |

### 計算ロジック

- ENTER命令の引数解析: MRB_ASPEC_REQ/OPT/REST/POST/KEY/KDICT/BLOCK/NOBLOCKのビットフィールド分解

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

本機能はデータベースを使用しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | irepがNULL | codedump関数が即座にreturn |

### リトライ仕様

リトライは不要。

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

GCアリーナの保存・復帰を各オペコード処理ごとに行う。

## パフォーマンス要件

デバッグ用途であり、特別なパフォーマンス要件はない。

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

- バイトコードの内容が標準出力に表示されるため、本番環境では無効化推奨

## 備考

- MRB_NO_STDIO定義時は主要機能が無効化される（mrb_codedump_allは空関数になる）
- 約80種類以上のオペコードに対応した大規模switchステートメント

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | opcode.h | `include/mruby/opcode.h` | オペコード定義とFETCHマクロ |

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | codedump.c | `src/codedump.c` | mrb_codedump_all（687-692行目）: stdout出力のエントリーポイント |
| 2-2 | codedump.c | `src/codedump.c` | mrb_codedump_all_file（677-682行目）: FILE*指定版 |
| 2-3 | codedump.c | `src/codedump.c` | codedump_recur（666-675行目）: 再帰ダンプ |

#### Step 3: コアダンプ処理

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | codedump.c | `src/codedump.c` | codedump（96-663行目）: 主要なオペコードダンプ処理 |
| 3-2 | codedump.c | `src/codedump.c` | print_header（52-66行目）: 行番号・PC表示 |
| 3-3 | codedump.c | `src/codedump.c` | print_lv_a/print_lv_ab（31-49行目）: ローカル変数注釈 |

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

```
mrb_codedump_all (公開API)
    │
    └─ mrb_codedump_all_file
           └─ codedump_recur
                  └─ codedump
                         ├─ print_header (行番号表示)
                         │     └─ mrb_debug_get_line
                         ├─ mrb_debug_get_filename (ファイル名表示)
                         ├─ print_lv_a / print_lv_ab (ローカル変数注釈)
                         └─ print_args (引数情報表示)
```

### データフロー図

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

struct RProc*       ───▶ codedump_recur        ───▶ テキスト出力（FILE*）
  └─ mrb_irep*            │
     ├─ iseq[]     ───▶ オペコードデコード     ───▶ "OP_MOVE R1 R2"
     ├─ syms[]     ───▶ シンボル名解決        ───▶ ":method_name"
     ├─ pool[]     ───▶ リテラル値表示        ───▶ "L[0]; 42"
     └─ debug_info ───▶ 行番号取得            ───▶ "  10 "
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| codedump.c | `src/codedump.c` | ソース | コードダンプの実装本体 |
| opcode.h | `include/mruby/opcode.h` | ヘッダ | オペコード定義 |
| ops.h | `include/mruby/ops.h` | ヘッダ | EXT命令用のオペコードテーブル |
| debug.c | `src/debug.c` | ソース | 行番号・ファイル名取得 |
| debug.h | `include/mruby/debug.h` | ヘッダ | デバッグ情報API |
| irep.h | `include/mruby/irep.h` | ヘッダ | irep構造体定義 |
