# 機能設計書 5-メモリアロケータ

## 概要

本ドキュメントは、mrubyのメモリアロケータ機能の設計を記述する。デフォルトのメモリ割り当て関数（malloc/realloc/free）を提供し、カスタムアロケータへの差し替えも可能とする。

### 本機能の処理概要

メモリアロケータはmruby内部の全メモリ割り当てに使用される基盤関数`mrb_basic_alloc_func`を提供する。この関数はrealloc/freeのセマンティクスを持つ統一インターフェースであり、ユーザーが独自のメモリアロケータに差し替えることが可能である。

**業務上の目的・背景**：組み込みシステムでは標準のmalloc/freeが利用できない、またはカスタムメモリ管理が必要な場合がある。mrubyはメモリ割り当て関数を一箇所に集約することで、メモリ管理戦略の切り替えを容易にしている。

**機能の利用シーン**：mruby内部のあらゆるメモリ割り当て・解放時に使用される。mrb_malloc, mrb_realloc, mrb_free等の高レベルAPIから間接的に呼び出される。

**主要な処理内容**：
1. `mrb_basic_alloc_func` - 基本メモリ割り当て/解放関数
2. size==0の場合はfree(p)を実行しNULL返却
3. size>0の場合はrealloc(p, size)を実行（p==NULLならmallocと等価）

**関連システム・外部連携**：OS標準ライブラリのmalloc/realloc/free。GCのmrb_realloc/mrb_malloc/mrb_free。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 画面機能マッピングにデータなし |

## 機能種別

メモリ管理処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| p | void* | No | 既存メモリブロックポインタ（NULLで新規割り当て） | - |
| size | size_t | Yes | 要求サイズ（0で解放） | - |

### 入力データソース

mruby内部の全メモリ割り当てリクエスト。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ポインタ | void* | 割り当てられたメモリブロック（解放時はNULL） |

### 出力先

呼び出し元への戻り値。

## 処理フロー

### 処理シーケンス

```
1. mrb_basic_alloc_func(p, size)
   ├─ size == 0 の場合
   │   └─ free(p); return NULL;
   └─ size > 0 の場合
       └─ return realloc(p, size);
```

### フローチャート

```mermaid
flowchart TD
    A[mrb_basic_alloc_func] --> B{size == 0?}
    B -->|Yes| C[free p]
    C --> D[return NULL]
    B -->|No| E[realloc p, size]
    E --> F[return pointer]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | free(NULL)安全 | p=NULLでsize=0の場合、free(NULL)はno-op | 常時 |
| BR-02 | realloc(NULL)=malloc | p=NULLでsize>0の場合、mallocと等価 | 新規割り当て時 |

### 計算ロジック

特になし。

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| NULL返却 | メモリ不足 | realloc失敗 | GC実行後リトライ（gc.c側で処理） |

### リトライ仕様

mrb_basic_alloc_func自体にはリトライ機構なし。呼び出し元のmrb_realloc_simple（gc.c）でGC実行後にリトライする。

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

該当なし

## パフォーマンス要件

- OS標準のmalloc/realloc/freeに依存

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

- カスタムアロケータ使用時はメモリリーク・ダブルフリーに注意

## 備考

- allocf.cは38行の最小ファイル
- カスタムアロケータは2つの方法で提供可能：(1)独自のmalloc/realloc/freeを提供、(2)mrb_basic_alloc_funcを再定義
- 詳細はdoc/guides/memory.mdを参照

---

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

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

### 推奨読解順序

#### Step 1: 基本割り当て関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | allocf.c | `src/allocf.c` | mrb_basic_alloc_func()（25-37行目）: 全体がたった13行の極めてシンプルな関数 |

**読解のコツ**: この関数はweak symbol的な役割を果たす。ユーザーが同じシグネチャの関数を提供すれば差し替わる。

#### Step 2: 高レベルメモリAPI（GC側）を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | gc.c | `src/gc.c` | mrb_realloc_simple()（192-209行目）: GCストレス、GC後リトライ |
| 2-2 | gc.c | `src/gc.c` | mrb_realloc()（211-227行目）: NULLチェック、NoMemoryError |
| 2-3 | gc.c | `src/gc.c` | mrb_malloc()（229-233行目）: mrb_reallocのラッパー |
| 2-4 | gc.c | `src/gc.c` | mrb_calloc()（241-260行目）: ゼロ初期化割り当て、オーバーフローチェック |
| 2-5 | gc.c | `src/gc.c` | mrb_free()（262-266行目）: mrb_basic_alloc_funcの直接呼び出し |

**主要処理フロー**:
- **203-206行目**: mrb_realloc_simple内でメモリ不足時にmrb_full_gc→再試行
- **218-221行目**: mrb_reallocでNULL返却時にout_of_memoryフラグ設定→NoMemoryError

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

```
mrb_malloc() / mrb_calloc()
    │
    └─ mrb_realloc()
           │
           └─ mrb_realloc_simple()
                  │
                  ├─ mrb_basic_alloc_func() ─── 実際のメモリ操作
                  │
                  └─ [失敗時] mrb_full_gc() → mrb_basic_alloc_func() (リトライ)

mrb_free()
    │
    └─ mrb_basic_alloc_func(p, 0) ─── free操作
```

### データフロー図

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

(p=NULL, size) ──────────▶ mrb_basic_alloc_func()       ──▶ void* (新規メモリ)
(p, size)      ──────────▶ mrb_basic_alloc_func()       ──▶ void* (再割り当て)
(p, size=0)    ──────────▶ mrb_basic_alloc_func()       ──▶ NULL (解放)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| allocf.c | `src/allocf.c` | ソース | デフォルトメモリ割り当て関数 |
| gc.c | `src/gc.c` | ソース | 高レベルメモリAPI（mrb_malloc/realloc/free） |
