feat(hako_check): Phase 154 MIR CFG integration & HC020 dead block detection
Implements block-level unreachable code detection using MIR CFG information. Complements Phase 153's method-level HC019 with fine-grained analysis. Core Infrastructure (Complete): - CFG Extractor: Extract block reachability from MirModule - DeadBlockAnalyzerBox: HC020 rule for unreachable blocks - CLI Integration: --dead-blocks flag and rule execution - Test Cases: 4 comprehensive patterns (early return, constant false, infinite loop, break) - Smoke Test: Validation script for all test cases Implementation Details: - src/mir/cfg_extractor.rs: New module for CFG→JSON extraction - tools/hako_check/rules/rule_dead_blocks.hako: HC020 analyzer box - tools/hako_check/cli.hako: Added --dead-blocks flag and HC020 integration - apps/tests/hako_check/test_dead_blocks_*.hako: 4 test cases Architecture: - Follows Phase 153 boxed modular pattern (DeadCodeAnalyzerBox) - Optional CFG field in Analysis IR (backward compatible) - Uses MIR's built-in reachability computation - Gracefully skips if CFG unavailable Known Limitation: - CFG data bridge pending (Phase 155): analysis_consumer.hako needs MIR access - Current: DeadBlockAnalyzerBox implemented, but CFG not yet in Analysis IR - Estimated 2-3 hours to complete bridge in Phase 155 Test Coverage: - Unit tests: cfg_extractor (simple CFG, unreachable blocks) - Integration tests: 4 test cases ready (will activate with bridge) - Smoke test: tools/hako_check_deadblocks_smoke.sh Documentation: - phase154_mir_cfg_inventory.md: CFG structure investigation - phase154_implementation_summary.md: Complete implementation guide - hako_check_design.md: HC020 rule documentation Next Phase 155: - Implement CFG data bridge (extract_mir_cfg builtin) - Update analysis_consumer.hako to call bridge - Activate HC020 end-to-end testing 🤖 Generated with Claude Code (https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
nyash-codex
@ -329,3 +329,55 @@ $ ./target/release/hakorune --backend vm test.hako
|
||||
|
||||
**Note**: JoinIR 経路はプレースホルダー実装のため、実際にはレガシー経路で処理。
|
||||
環境変数読み取りとフラグ分岐は完全に動作しており、Phase 124 で JoinIR 実装を追加すれば即座に動作可能。
|
||||
|
||||
|
||||
## HC020: Unreachable Basic Block (Phase 154)
|
||||
|
||||
**Rule ID:** HC020
|
||||
**Severity:** Warning
|
||||
**Category:** Dead Code (Block-level)
|
||||
|
||||
### Description
|
||||
|
||||
Detects unreachable basic blocks using MIR CFG information. Complements HC019 by providing fine-grained analysis at the block level rather than method level.
|
||||
|
||||
### Patterns Detected
|
||||
|
||||
1. **Early return**: Code after unconditional return
|
||||
2. **Constant conditions**: Branches that can never be taken (`if 0`, `if false`)
|
||||
3. **Infinite loops**: Code after `loop(1)`
|
||||
4. **Unconditional break**: Code after break statement
|
||||
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
# Enable HC020 alone
|
||||
./tools/hako_check.sh --dead-blocks program.hako
|
||||
|
||||
# Combined with HC019
|
||||
./tools/hako_check.sh --dead-code --dead-blocks program.hako
|
||||
|
||||
# Via rules filter
|
||||
./tools/hako_check.sh --rules dead_blocks program.hako
|
||||
```
|
||||
|
||||
### Example Output
|
||||
|
||||
```
|
||||
[HC020] Unreachable basic block: fn=Main.test bb=5 (after early return) :: test.hako:10
|
||||
[HC020] Unreachable basic block: fn=Foo.bar bb=12 (dead conditional) :: test.hako:25
|
||||
```
|
||||
|
||||
### Requirements
|
||||
|
||||
- Requires MIR CFG information (Phase 154+)
|
||||
- Gracefully skips if CFG unavailable
|
||||
- Works with NYASH_JOINIR_STRICT=1 mode
|
||||
|
||||
### Implementation
|
||||
|
||||
- **Analyzer:** `tools/hako_check/rules/rule_dead_blocks.hako`
|
||||
- **CFG Extractor:** `src/mir/cfg_extractor.rs`
|
||||
- **Tests:** `apps/tests/hako_check/test_dead_blocks_*.hako`
|
||||
|
||||
|
||||
|
||||
368
docs/development/current/main/phase154_implementation_summary.md
Normal file
368
docs/development/current/main/phase154_implementation_summary.md
Normal file
@ -0,0 +1,368 @@
|
||||
# Phase 154: Implementation Summary - MIR CFG Integration & Dead Block Detection
|
||||
|
||||
## Overview
|
||||
|
||||
Successfully implemented **HC020 Unreachable Basic Block Detection** rule using MIR CFG information. This provides block-level dead code analysis complementing the existing method-level HC019 rule from Phase 153.
|
||||
|
||||
**Status:** Core infrastructure complete, CFG data bridge pending (see Known Limitations)
|
||||
|
||||
---
|
||||
|
||||
## Completed Deliverables
|
||||
|
||||
### 1. CFG Extractor (`src/mir/cfg_extractor.rs`)
|
||||
|
||||
**Purpose:** Extract CFG information from MIR modules for analysis tools.
|
||||
|
||||
**Features:**
|
||||
- Extracts block-level reachability information
|
||||
- Exports successor relationships
|
||||
- Identifies terminator types (Branch/Jump/Return)
|
||||
- Deterministic output (sorted by block ID)
|
||||
|
||||
**API:**
|
||||
```rust
|
||||
pub fn extract_cfg_info(module: &MirModule) -> serde_json::Value
|
||||
```
|
||||
|
||||
**Output Format:**
|
||||
```json
|
||||
{
|
||||
"functions": [
|
||||
{
|
||||
"name": "Main.main/0",
|
||||
"entry_block": 0,
|
||||
"blocks": [
|
||||
{
|
||||
"id": 0,
|
||||
"reachable": true,
|
||||
"successors": [1, 2],
|
||||
"terminator": "Branch"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**Testing:** Includes unit tests for simple CFG and unreachable blocks.
|
||||
|
||||
### 2. DeadBlockAnalyzerBox (`tools/hako_check/rules/rule_dead_blocks.hako`)
|
||||
|
||||
**Purpose:** HC020 rule implementation for unreachable basic block detection.
|
||||
|
||||
**Features:**
|
||||
- Scans CFG information from Analysis IR
|
||||
- Reports unreachable blocks with function and block ID
|
||||
- Infers reasons for unreachability (early return, dead branch, etc.)
|
||||
- Gracefully skips if CFG info unavailable
|
||||
|
||||
**API:**
|
||||
```hako
|
||||
static box DeadBlockAnalyzerBox {
|
||||
method apply_ir(ir, path, out) {
|
||||
// Analyze CFG and report HC020 diagnostics
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Output Format:**
|
||||
```
|
||||
[HC020] Unreachable basic block: fn=Main.test bb=5 (after early return) :: test.hako
|
||||
```
|
||||
|
||||
### 3. CLI Integration (`tools/hako_check/cli.hako`)
|
||||
|
||||
**New Flag:** `--dead-blocks`
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
# Run HC020 dead block detection
|
||||
./tools/hako_check.sh --dead-blocks program.hako
|
||||
|
||||
# Combined with other modes
|
||||
./tools/hako_check.sh --dead-code --dead-blocks program.hako
|
||||
|
||||
# Or use rules filter
|
||||
./tools/hako_check.sh --rules dead_blocks program.hako
|
||||
```
|
||||
|
||||
**Integration Points:**
|
||||
- Added `DeadBlockAnalyzerBox` import
|
||||
- Added `--dead-blocks` flag parsing
|
||||
- Added HC020 rule execution after HC019
|
||||
- Added debug logging for HC020
|
||||
|
||||
### 4. Test Cases
|
||||
|
||||
Created 4 comprehensive test cases:
|
||||
|
||||
1. **`test_dead_blocks_early_return.hako`**
|
||||
- Pattern: Early return creates unreachable code
|
||||
- Expected: HC020 for block after return
|
||||
|
||||
2. **`test_dead_blocks_always_false.hako`**
|
||||
- Pattern: Constant false condition (`if 0`)
|
||||
- Expected: HC020 for dead then-branch
|
||||
|
||||
3. **`test_dead_blocks_infinite_loop.hako`**
|
||||
- Pattern: `loop(1)` never exits
|
||||
- Expected: HC020 for code after loop
|
||||
|
||||
4. **`test_dead_blocks_after_break.hako`**
|
||||
- Pattern: Unconditional break in loop
|
||||
- Expected: HC020 for code after break
|
||||
|
||||
### 5. Smoke Test Script
|
||||
|
||||
**File:** `tools/hako_check_deadblocks_smoke.sh`
|
||||
|
||||
**Features:**
|
||||
- Tests all 4 test cases
|
||||
- Checks for HC020 output
|
||||
- Gracefully handles CFG info unavailability (MVP limitation)
|
||||
- Non-failing for incomplete CFG integration
|
||||
|
||||
---
|
||||
|
||||
## Known Limitations & Next Steps
|
||||
|
||||
### Current State: Core Infrastructure Complete ✅
|
||||
|
||||
**What Works:**
|
||||
- ✅ CFG extractor implemented and tested
|
||||
- ✅ DeadBlockAnalyzerBox implemented
|
||||
- ✅ CLI integration complete
|
||||
- ✅ Test cases created
|
||||
- ✅ Smoke test script ready
|
||||
|
||||
### Outstanding: CFG Data Bridge 🔄
|
||||
|
||||
**The Gap:**
|
||||
Currently, `analysis_consumer.hako` builds Analysis IR by text scanning, not from MIR. The CFG information exists in Rust's `MirModule` but isn't exposed to the .hako side yet.
|
||||
|
||||
**Solution Path (Phase 155+):**
|
||||
|
||||
#### Option A: Extend analysis_consumer with MIR access (Recommended)
|
||||
```hako
|
||||
// In analysis_consumer.hako
|
||||
static box HakoAnalysisBuilderBox {
|
||||
build_from_source_flags(text, path, no_ast) {
|
||||
local ir = new MapBox()
|
||||
// ... existing text scanning ...
|
||||
|
||||
// NEW: Request CFG from MIR if available
|
||||
local cfg = me._extract_cfg_from_mir(text, path)
|
||||
if cfg != null {
|
||||
ir.set("cfg", cfg)
|
||||
}
|
||||
|
||||
return ir
|
||||
}
|
||||
|
||||
_extract_cfg_from_mir(text, path) {
|
||||
// Call Rust function that:
|
||||
// 1. Compiles text to MIR
|
||||
// 2. Calls extract_cfg_info()
|
||||
// 3. Returns JSON value
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Option B: Add MIR compilation step to hako_check pipeline
|
||||
```bash
|
||||
# In tools/hako_check.sh
|
||||
# 1. Compile to MIR JSON
|
||||
hakorune --emit-mir-json /tmp/mir.json program.hako
|
||||
|
||||
# 2. Extract CFG
|
||||
hakorune --extract-cfg /tmp/mir.json > /tmp/cfg.json
|
||||
|
||||
# 3. Pass to analyzer
|
||||
hakorune --backend vm tools/hako_check/cli.hako \
|
||||
--source-file program.hako "$(cat program.hako)" \
|
||||
--cfg-file /tmp/cfg.json
|
||||
```
|
||||
|
||||
**Recommended:** Option A (cleaner integration, single pass)
|
||||
|
||||
### Implementation Roadmap (Phase 155)
|
||||
|
||||
1. **Add Rust-side function** to compile .hako to MIR and extract CFG
|
||||
2. **Expose to VM** as builtin function (e.g., `extract_mir_cfg(text, path)`)
|
||||
3. **Update analysis_consumer.hako** to call this function
|
||||
4. **Test end-to-end** with all 4 test cases
|
||||
5. **Update smoke script** to expect HC020 output
|
||||
|
||||
**Estimated Effort:** 2-3 hours (mostly Rust-side plumbing)
|
||||
|
||||
---
|
||||
|
||||
## Architecture Decisions
|
||||
|
||||
### Why Not Merge HC019 and HC020?
|
||||
|
||||
**Decision:** Keep HC019 (method-level) and HC020 (block-level) separate
|
||||
|
||||
**Rationale:**
|
||||
1. **Different granularity**: Methods vs. blocks are different analysis levels
|
||||
2. **Different use cases**: HC019 finds unused code, HC020 finds unreachable paths
|
||||
3. **Optional CFG**: HC019 works without MIR, HC020 requires CFG
|
||||
4. **User control**: `--dead-code` vs `--dead-blocks` allows selective analysis
|
||||
|
||||
### CFG Info Location in Analysis IR
|
||||
|
||||
**Decision:** Add `cfg` as top-level field in Analysis IR
|
||||
|
||||
**Alternatives considered:**
|
||||
- Embed in `methods` array → Breaks existing format
|
||||
- Separate IR structure → More complex
|
||||
|
||||
**Chosen:**
|
||||
```javascript
|
||||
{
|
||||
"methods": [...], // Existing
|
||||
"calls": [...], // Existing
|
||||
"cfg": { // NEW
|
||||
"functions": [...]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Benefits:**
|
||||
- Backward compatible (optional field)
|
||||
- Extensible (can add more CFG data later)
|
||||
- Clean separation of concerns
|
||||
|
||||
### Reachability: MIR vs. Custom Analysis
|
||||
|
||||
**Decision:** Use MIR's built-in `block.reachable` flag
|
||||
|
||||
**Rationale:**
|
||||
- Already computed during MIR construction
|
||||
- Proven correct (used by optimizer)
|
||||
- No duplication of logic
|
||||
- Consistent with Rust compiler design
|
||||
|
||||
**Alternative (rejected):** Re-compute reachability in DeadBlockAnalyzerBox
|
||||
- Pro: Self-contained
|
||||
- Con: Duplication, potential bugs, slower
|
||||
|
||||
---
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
### Unit Tests
|
||||
- ✅ `cfg_extractor::tests::test_extract_simple_cfg`
|
||||
- ✅ `cfg_extractor::tests::test_unreachable_block`
|
||||
|
||||
### Integration Tests
|
||||
- 🔄 Pending CFG bridge (Phase 155)
|
||||
- Test cases ready in `apps/tests/hako_check/`
|
||||
|
||||
### Smoke Tests
|
||||
- ✅ `tools/hako_check_deadblocks_smoke.sh`
|
||||
- Currently validates infrastructure, will validate HC020 output once bridge is complete
|
||||
|
||||
---
|
||||
|
||||
## Performance Considerations
|
||||
|
||||
### CFG Extraction Cost
|
||||
- **Negligible**: Already computed during MIR construction
|
||||
- **One-time**: Extracted once per function
|
||||
- **Small output**: ~100 bytes per function typically
|
||||
|
||||
### DeadBlockAnalyzerBox Cost
|
||||
- **O(blocks)**: Linear scan of blocks array
|
||||
- **Typical**: <100 blocks per function
|
||||
- **Fast**: Simple boolean check and string formatting
|
||||
|
||||
**Conclusion:** No performance concerns, suitable for CI/CD pipelines.
|
||||
|
||||
---
|
||||
|
||||
## Future Enhancements (Phase 160+)
|
||||
|
||||
### Enhanced Diagnostics
|
||||
- Show source code location of unreachable blocks
|
||||
- Suggest how to fix (remove code, change condition, etc.)
|
||||
- Group related unreachable blocks
|
||||
|
||||
### Deeper Analysis
|
||||
- Constant propagation to find more dead branches
|
||||
- Path sensitivity (combine conditions across blocks)
|
||||
- Integration with type inference
|
||||
|
||||
### Visualization
|
||||
- DOT graph output showing dead blocks in red
|
||||
- Interactive HTML report with clickable blocks
|
||||
- Side-by-side source and CFG view
|
||||
|
||||
---
|
||||
|
||||
## Files Modified/Created
|
||||
|
||||
### New Files
|
||||
- ✅ `src/mir/cfg_extractor.rs` (184 lines)
|
||||
- ✅ `tools/hako_check/rules/rule_dead_blocks.hako` (100 lines)
|
||||
- ✅ `apps/tests/hako_check/test_dead_blocks_*.hako` (4 files, ~20 lines each)
|
||||
- ✅ `tools/hako_check_deadblocks_smoke.sh` (65 lines)
|
||||
- ✅ `docs/development/current/main/phase154_mir_cfg_inventory.md`
|
||||
- ✅ `docs/development/current/main/phase154_implementation_summary.md`
|
||||
|
||||
### Modified Files
|
||||
- ✅ `src/mir/mod.rs` (added cfg_extractor module and re-export)
|
||||
- ✅ `tools/hako_check/cli.hako` (added --dead-blocks flag and HC020 rule execution)
|
||||
|
||||
**Total Lines:** ~450 lines (code + docs + tests)
|
||||
|
||||
---
|
||||
|
||||
## Recommendations for Next Phase
|
||||
|
||||
### Immediate (Phase 155)
|
||||
1. **Implement CFG data bridge** (highest priority)
|
||||
- Add `extract_mir_cfg()` builtin function
|
||||
- Update `analysis_consumer.hako` to use it
|
||||
- Test end-to-end with all 4 test cases
|
||||
|
||||
2. **Update documentation**
|
||||
- Mark CFG bridge as complete
|
||||
- Add usage examples to hako_check README
|
||||
- Update CURRENT_TASK.md
|
||||
|
||||
### Short-term (Phase 156-160)
|
||||
3. **Add source location mapping**
|
||||
- Track span information for unreachable blocks
|
||||
- Show line numbers in HC020 output
|
||||
|
||||
4. **Enhance test coverage**
|
||||
- Add tests for complex control flow (nested loops, try-catch, etc.)
|
||||
- Add negative tests (no false positives)
|
||||
|
||||
### Long-term (Phase 160+)
|
||||
5. **Constant folding integration**
|
||||
- Detect more dead branches via constant propagation
|
||||
- Integrate with MIR optimizer
|
||||
|
||||
6. **Visualization tools**
|
||||
- DOT/GraphViz output for CFG
|
||||
- HTML reports with interactive CFG
|
||||
|
||||
---
|
||||
|
||||
## Conclusion
|
||||
|
||||
Phase 154 successfully establishes the **infrastructure for block-level dead code detection**. The core components (CFG extractor, analyzer box, CLI integration, tests) are complete and tested.
|
||||
|
||||
The remaining work is a **straightforward data bridge** to connect the Rust-side MIR CFG to the .hako-side Analysis IR. This is a mechanical task estimated at 2-3 hours for Phase 155.
|
||||
|
||||
**Key Achievement:** Demonstrates the power of the **boxed modular architecture** - DeadBlockAnalyzerBox is completely independent and swappable, just like DeadCodeAnalyzerBox from Phase 153.
|
||||
|
||||
---
|
||||
|
||||
**Author:** Claude (Anthropic)
|
||||
**Date:** 2025-12-04
|
||||
**Phase:** 154 (MIR CFG Integration & Dead Block Detection)
|
||||
**Status:** Core infrastructure complete, CFG bridge pending (Phase 155)
|
||||
388
docs/development/current/main/phase154_mir_cfg_deadblocks.md
Normal file
388
docs/development/current/main/phase154_mir_cfg_deadblocks.md
Normal file
@ -0,0 +1,388 @@
|
||||
# Phase 154: MIR CFG 統合 & ブロックレベル unreachable 検出
|
||||
|
||||
## 0. ゴール
|
||||
|
||||
**hako_check に MIR CFG 情報を取り込み、「到達不能な basic block」を検出する HC020 ルールを追加する。**
|
||||
|
||||
目的：
|
||||
- Phase 153 で復活した dead code 検出（メソッド・Box 単位）を、ブロック単位まで細粒度化
|
||||
- JoinIR/MIR の CFG 情報を hako_check の Analysis IR に統合
|
||||
- 「unreachable basic block」を検出し、コード品質向上に寄与
|
||||
|
||||
---
|
||||
|
||||
## 1. Scope / Non-scope
|
||||
|
||||
### ✅ やること
|
||||
|
||||
1. **MIR/CFG 情報のインベントリ**
|
||||
- 現在の MIR JSON v0 に含まれる CFG 情報（blocks, terminators）を確認
|
||||
- hako_check の Analysis IR に追加すべきフィールドを特定
|
||||
|
||||
2. **DeadBlockAnalyzerBox の設計（箱化モジュール化）**
|
||||
- Phase 153 の DeadCodeAnalyzerBox パターンを踏襲
|
||||
- 入力: Analysis IR（CFG 情報付き）
|
||||
- 出力: 未到達ブロックのリスト
|
||||
|
||||
3. **hako_check パイプラインへの統合設計**
|
||||
- Analysis IR 生成時に CFG 情報を含める方法を決定
|
||||
- HC020 ルールの位置付け（HC019 の後に実行）
|
||||
|
||||
4. **テストケース設計（ブロックレベル）**
|
||||
- 到達不能な if/else 分岐
|
||||
- 早期 return 後のコード
|
||||
- 常に false のループ条件
|
||||
|
||||
5. **実装 & テスト**
|
||||
- DeadBlockAnalyzerBox 実装
|
||||
- HC020 ルール実装
|
||||
- スモークテスト作成
|
||||
|
||||
6. **ドキュメント & CURRENT_TASK 更新**
|
||||
|
||||
### ❌ やらないこと
|
||||
|
||||
- JoinIR/MIR の意味論を変えない（解析は「読むだけ」）
|
||||
- 新しい Stage-3 構文を追加しない
|
||||
- 環境変数を増やさない（CLI フラグ `--dead-blocks` のみ）
|
||||
|
||||
---
|
||||
|
||||
## 2. Task 1: MIR/CFG 情報のインベントリ
|
||||
|
||||
### 対象ファイル
|
||||
|
||||
- `src/mir/join_ir/json.rs` - JoinIR JSON シリアライズ
|
||||
- `src/mir/join_ir_runner.rs` - JoinIR 実行
|
||||
- `src/mir/` - MIR 構造定義
|
||||
- `tools/hako_check/analysis_ir.hako` - 現在の Analysis IR 定義
|
||||
|
||||
### やること
|
||||
|
||||
1. **MIR JSON v0 の CFG 情報を確認**
|
||||
- blocks 配列の構造
|
||||
- terminator の種類（Jump, Branch, Return）
|
||||
- predecessors / successors の有無
|
||||
|
||||
2. **Analysis IR に追加すべきフィールドを特定**
|
||||
- `blocks: Array<BlockInfo>` ?
|
||||
- `cfg_edges: Array<Edge>` ?
|
||||
- `entry_block: BlockId` ?
|
||||
|
||||
3. **JoinIR Strict モードでの動作確認**
|
||||
- `NYASH_JOINIR_STRICT=1` で MIR が正しく生成されているか
|
||||
- Phase 150 の代表ケースで CFG 情報が取れるか
|
||||
|
||||
### 成果物
|
||||
|
||||
- CFG 情報インベントリ結果の記録
|
||||
|
||||
---
|
||||
|
||||
## 3. Task 2: DeadBlockAnalyzerBox の設計（箱化モジュール化）
|
||||
|
||||
### 目的
|
||||
|
||||
Phase 153 の DeadCodeAnalyzerBox パターンを踏襲し、ブロックレベル解析を箱化
|
||||
|
||||
### 方針
|
||||
|
||||
- エントリブロックからの到達可能性を DFS/BFS で計算
|
||||
- 到達しなかったブロックを列挙
|
||||
- 各ブロックがどの関数に属するかも記録
|
||||
|
||||
### 箱単位の設計
|
||||
|
||||
**DeadBlockAnalyzerBox** として：
|
||||
- 入力: Analysis IR（CFG 情報付き）
|
||||
- 出力: 「未到達ブロック」のリスト
|
||||
|
||||
### API シグネチャ案
|
||||
|
||||
```hako
|
||||
static box DeadBlockAnalyzerBox {
|
||||
method apply_ir(ir, path, out) {
|
||||
// CFG 情報を取得
|
||||
local blocks = ir.get("blocks")
|
||||
local edges = ir.get("cfg_edges")
|
||||
local entry = ir.get("entry_block")
|
||||
|
||||
// 到達可能性解析
|
||||
local reachable = me._compute_reachability(entry, edges)
|
||||
|
||||
// 未到達ブロックを検出
|
||||
me._report_unreachable_blocks(blocks, reachable, path, out)
|
||||
}
|
||||
|
||||
method _compute_reachability(entry, edges) {
|
||||
// DFS/BFS で到達可能なブロックを収集
|
||||
// return: Set<BlockId>
|
||||
}
|
||||
|
||||
method _report_unreachable_blocks(blocks, reachable, path, out) {
|
||||
// 到達不能なブロックを HC020 として報告
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 出力フォーマット
|
||||
|
||||
```
|
||||
[HC020] Unreachable basic block: fn=Main.main bb=10 (after early return)
|
||||
[HC020] Unreachable basic block: fn=Foo.bar bb=15 (if false branch never taken)
|
||||
```
|
||||
|
||||
### 成果物
|
||||
|
||||
- DeadBlockAnalyzerBox の設計（API シグネチャ）
|
||||
- Analysis IR 拡張フィールド決定
|
||||
|
||||
---
|
||||
|
||||
## 4. Task 3: hako_check パイプラインへの統合設計
|
||||
|
||||
### 目的
|
||||
|
||||
HC020 ルールを既存の hako_check パイプラインに統合
|
||||
|
||||
### やること
|
||||
|
||||
1. **Analysis IR 生成の拡張**
|
||||
- `tools/hako_check/analysis_ir.hako` を拡張
|
||||
- CFG 情報（blocks, edges, entry_block）を含める
|
||||
|
||||
2. **CLI フラグ追加**
|
||||
- `--dead-blocks` フラグで HC020 を有効化
|
||||
- または `--dead-code` に統合（ブロックレベルも含む）
|
||||
|
||||
3. **ルール実行順序**
|
||||
- HC019（dead code）の後に HC020（dead blocks）を実行
|
||||
- または `--rules dead_blocks` で個別指定可能に
|
||||
|
||||
### 設計方針
|
||||
|
||||
**Option A**: `--dead-code` に統合
|
||||
```bash
|
||||
# HC019 + HC020 を両方実行
|
||||
./tools/hako_check.sh --dead-code target.hako
|
||||
```
|
||||
|
||||
**Option B**: 別フラグ
|
||||
```bash
|
||||
# HC019 のみ
|
||||
./tools/hako_check.sh --dead-code target.hako
|
||||
|
||||
# HC020 のみ
|
||||
./tools/hako_check.sh --dead-blocks target.hako
|
||||
|
||||
# 両方
|
||||
./tools/hako_check.sh --dead-code --dead-blocks target.hako
|
||||
```
|
||||
|
||||
**推奨**: Option A（ユーザーは「dead code」を広義に捉えるため）
|
||||
|
||||
### 成果物
|
||||
|
||||
- パイプライン統合設計
|
||||
- CLI フラグ仕様確定
|
||||
|
||||
---
|
||||
|
||||
## 5. Task 4: テストケース設計（ブロックレベル）
|
||||
|
||||
### テストケース一覧
|
||||
|
||||
#### Case 1: 早期 return 後のコード
|
||||
```hako
|
||||
static box TestEarlyReturn {
|
||||
test(x) {
|
||||
if x > 0 {
|
||||
return 1
|
||||
}
|
||||
// ここに到達不能コード
|
||||
local unreachable = 42 // HC020 検出対象
|
||||
return unreachable
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Case 2: 常に false の条件
|
||||
```hako
|
||||
static box TestAlwaysFalse {
|
||||
test() {
|
||||
if false {
|
||||
// このブロック全体が到達不能
|
||||
return 999 // HC020 検出対象
|
||||
}
|
||||
return 0
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Case 3: 無限ループ後のコード
|
||||
```hako
|
||||
static box TestInfiniteLoop {
|
||||
test() {
|
||||
loop(true) {
|
||||
// 無限ループ
|
||||
}
|
||||
// ここに到達不能
|
||||
return 0 // HC020 検出対象
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Case 4: break 後のコード（ループ内）
|
||||
```hako
|
||||
static box TestAfterBreak {
|
||||
test() {
|
||||
loop(true) {
|
||||
break
|
||||
// break 後のコード
|
||||
local x = 1 // HC020 検出対象
|
||||
}
|
||||
return 0
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 成果物
|
||||
|
||||
- テスト .hako ファイル 4 本
|
||||
- 期待される HC020 出力の定義
|
||||
|
||||
---
|
||||
|
||||
## 6. Task 5: 実装 & テスト
|
||||
|
||||
### 実装ファイル
|
||||
|
||||
1. **`tools/hako_check/rules/rule_dead_blocks.hako`** - 新規作成
|
||||
- DeadBlockAnalyzerBox 実装
|
||||
- HC020 ルール実装
|
||||
|
||||
2. **`tools/hako_check/analysis_ir.hako`** - 拡張
|
||||
- CFG 情報フィールド追加
|
||||
|
||||
3. **`tools/hako_check/cli.hako`** - 修正
|
||||
- `--dead-blocks` または `--dead-code` 拡張
|
||||
- HC020 実行統合
|
||||
|
||||
### テストファイル
|
||||
|
||||
1. **`apps/tests/hako_check/test_dead_blocks_early_return.hako`**
|
||||
2. **`apps/tests/hako_check/test_dead_blocks_always_false.hako`**
|
||||
3. **`apps/tests/hako_check/test_dead_blocks_infinite_loop.hako`**
|
||||
4. **`apps/tests/hako_check/test_dead_blocks_after_break.hako`**
|
||||
|
||||
### スモークスクリプト
|
||||
|
||||
- `tools/hako_check_deadblocks_smoke.sh` - HC020 スモークテスト
|
||||
|
||||
### 成果物
|
||||
|
||||
- DeadBlockAnalyzerBox 実装
|
||||
- HC020 ルール実装
|
||||
- テストケース 4 本
|
||||
- スモークスクリプト
|
||||
|
||||
---
|
||||
|
||||
## 7. Task 6: ドキュメント & CURRENT_TASK 更新
|
||||
|
||||
### ドキュメント更新
|
||||
|
||||
1. **phase154_mir_cfg_deadblocks.md** に：
|
||||
- 実装結果を記録
|
||||
- CFG 統合の最終設計
|
||||
|
||||
2. **hako_check_design.md** を更新：
|
||||
- HC020 ルールの説明
|
||||
- CFG 解析機能の説明
|
||||
|
||||
3. **CURRENT_TASK.md**：
|
||||
- Phase 154 セクションを追加
|
||||
|
||||
4. **CLAUDE.md**：
|
||||
- hako_check ワークフローに `--dead-blocks` 追記（必要なら）
|
||||
|
||||
### 成果物
|
||||
|
||||
- 各種ドキュメント更新
|
||||
- git commit
|
||||
|
||||
---
|
||||
|
||||
## ✅ 完成チェックリスト（Phase 154）
|
||||
|
||||
- [ ] Task 1: MIR/CFG 情報インベントリ完了
|
||||
- [ ] CFG 構造確認
|
||||
- [ ] Analysis IR 拡張フィールド決定
|
||||
- [ ] Task 2: DeadBlockAnalyzerBox 設計
|
||||
- [ ] API シグネチャ決定
|
||||
- [ ] 到達可能性アルゴリズム決定
|
||||
- [ ] Task 3: パイプライン統合設計
|
||||
- [ ] CLI フラグ仕様確定
|
||||
- [ ] ルール実行順序確定
|
||||
- [ ] Task 4: テストケース設計
|
||||
- [ ] テスト .hako 4 本設計
|
||||
- [ ] Task 5: 実装 & テスト
|
||||
- [ ] DeadBlockAnalyzerBox 実装
|
||||
- [ ] HC020 ルール実装
|
||||
- [ ] テストケース実装
|
||||
- [ ] スモークスクリプト作成
|
||||
- [ ] Task 6: ドキュメント更新
|
||||
- [ ] phase154_mir_cfg_deadblocks.md 確定版
|
||||
- [ ] hako_check_design.md 更新
|
||||
- [ ] CURRENT_TASK.md 更新
|
||||
- [ ] git commit
|
||||
|
||||
---
|
||||
|
||||
## 技術的考慮事項
|
||||
|
||||
### JoinIR Strict モードとの整合性
|
||||
|
||||
Phase 150 で確認済みの代表ケースで CFG 情報が取れることを確認：
|
||||
- `peek_expr_block.hako` - match 式、ブロック式
|
||||
- `loop_min_while.hako` - ループ変数、Entry/Exit PHI
|
||||
- `joinir_min_loop.hako` - break 制御
|
||||
- `joinir_if_select_simple.hako` - 早期 return
|
||||
|
||||
### Analysis IR の CFG 拡張案
|
||||
|
||||
```json
|
||||
{
|
||||
"methods": [...],
|
||||
"calls": [...],
|
||||
"boxes": [...],
|
||||
"entrypoints": [...],
|
||||
"cfg": {
|
||||
"functions": [
|
||||
{
|
||||
"name": "Main.main",
|
||||
"entry_block": 0,
|
||||
"blocks": [
|
||||
{"id": 0, "successors": [1, 2], "terminator": "Branch"},
|
||||
{"id": 1, "successors": [3], "terminator": "Jump"},
|
||||
{"id": 2, "successors": [3], "terminator": "Jump"},
|
||||
{"id": 3, "successors": [], "terminator": "Return"}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 次のステップ
|
||||
|
||||
Phase 154 完了後：
|
||||
- **Phase 155+**: より高度な解析（定数畳み込み、型推論など）
|
||||
- **Phase 160+**: .hako JoinIR/MIR 移植章
|
||||
|
||||
---
|
||||
|
||||
**作成日**: 2025-12-04
|
||||
**Phase**: 154（MIR CFG 統合 & ブロックレベル unreachable 検出）
|
||||
269
docs/development/current/main/phase154_mir_cfg_inventory.md
Normal file
269
docs/development/current/main/phase154_mir_cfg_inventory.md
Normal file
@ -0,0 +1,269 @@
|
||||
# Phase 154: MIR/CFG Information Inventory
|
||||
|
||||
## Task 1 Results: MIR/CFG Information Investigation
|
||||
|
||||
### MIR BasicBlock Structure (from `src/mir/basic_block.rs`)
|
||||
|
||||
The MIR already contains rich CFG information:
|
||||
|
||||
```rust
|
||||
pub struct BasicBlock {
|
||||
pub id: BasicBlockId,
|
||||
pub instructions: Vec<MirInstruction>,
|
||||
pub terminator: Option<MirInstruction>,
|
||||
pub predecessors: BTreeSet<BasicBlockId>,
|
||||
pub successors: BTreeSet<BasicBlockId>,
|
||||
pub effects: EffectMask,
|
||||
pub reachable: bool, // Already computed!
|
||||
pub sealed: bool,
|
||||
}
|
||||
```
|
||||
|
||||
**Key findings:**
|
||||
- CFG edges already tracked via `predecessors` and `successors`
|
||||
- Block reachability already computed during MIR construction
|
||||
- Terminators (Branch/Jump/Return) determine control flow
|
||||
|
||||
### Terminator Types (from `src/mir/instruction.rs`)
|
||||
|
||||
```rust
|
||||
// Control flow terminators
|
||||
Branch { condition, then_bb, else_bb } // Conditional
|
||||
Jump { target } // Unconditional
|
||||
Return { value } // Function exit
|
||||
```
|
||||
|
||||
### Current Analysis IR Structure (from `tools/hako_check/analysis_consumer.hako`)
|
||||
|
||||
```javascript
|
||||
{
|
||||
"path": String,
|
||||
"uses": Array<String>,
|
||||
"boxes": Array<BoxInfo>,
|
||||
"methods": Array<String>,
|
||||
"calls": Array<CallEdge>,
|
||||
"entrypoints": Array<String>,
|
||||
"source": String
|
||||
}
|
||||
```
|
||||
|
||||
**Missing:** CFG/block-level information
|
||||
|
||||
## Proposed Analysis IR Extension
|
||||
|
||||
### Option A: Add CFG field (Recommended)
|
||||
|
||||
```javascript
|
||||
{
|
||||
// ... existing fields ...
|
||||
"cfg": {
|
||||
"functions": [
|
||||
{
|
||||
"name": "Main.main/0",
|
||||
"entry_block": 0,
|
||||
"blocks": [
|
||||
{
|
||||
"id": 0,
|
||||
"reachable": true,
|
||||
"successors": [1, 2],
|
||||
"terminator": "Branch"
|
||||
},
|
||||
{
|
||||
"id": 1,
|
||||
"reachable": true,
|
||||
"successors": [3],
|
||||
"terminator": "Jump"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"reachable": false, // <-- Dead block!
|
||||
"successors": [3],
|
||||
"terminator": "Jump"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Advantages:**
|
||||
- Minimal: Only essential CFG data
|
||||
- Extensible: Can add more fields later
|
||||
- Backward compatible: Optional field
|
||||
|
||||
### Option B: Embed in methods array
|
||||
|
||||
```javascript
|
||||
{
|
||||
"methods": [
|
||||
{
|
||||
"name": "Main.main/0",
|
||||
"arity": 0,
|
||||
"cfg": { /* ... */ }
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**Disadvantages:**
|
||||
- Breaks existing method array format (Array<String>)
|
||||
- More complex migration
|
||||
|
||||
**Decision: Choose Option A**
|
||||
|
||||
## CFG Information Sources
|
||||
|
||||
### Source 1: MIR Module (Preferred)
|
||||
|
||||
**File:** `src/mir/mod.rs`
|
||||
|
||||
```rust
|
||||
pub struct MirModule {
|
||||
pub functions: BTreeMap<String, MirFunction>,
|
||||
// ...
|
||||
}
|
||||
|
||||
pub struct MirFunction {
|
||||
pub blocks: BTreeMap<BasicBlockId, BasicBlock>,
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
**Access Pattern:**
|
||||
```rust
|
||||
for (func_name, function) in &module.functions {
|
||||
for (block_id, block) in &function.blocks {
|
||||
println!("Block {}: reachable={}", block_id, block.reachable);
|
||||
println!(" Successors: {:?}", block.successors);
|
||||
println!(" Terminator: {:?}", block.terminator);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Source 2: MIR Printer
|
||||
|
||||
**File:** `src/mir/printer.rs`
|
||||
|
||||
Already has logic to traverse and format CFG:
|
||||
```rust
|
||||
pub fn print_function(&self, function: &MirFunction) -> String {
|
||||
// Iterates over blocks and prints successors/predecessors
|
||||
}
|
||||
```
|
||||
|
||||
## Implementation Strategy
|
||||
|
||||
### Step 1: Extract CFG during MIR compilation
|
||||
|
||||
**Where:** `src/mir/mod.rs` or new `src/mir/cfg_extractor.rs`
|
||||
|
||||
```rust
|
||||
pub fn extract_cfg_info(module: &MirModule) -> serde_json::Value {
|
||||
let mut functions = Vec::new();
|
||||
|
||||
for (func_name, function) in &module.functions {
|
||||
let mut blocks = Vec::new();
|
||||
|
||||
for (block_id, block) in &function.blocks {
|
||||
blocks.push(json!({
|
||||
"id": block_id.0,
|
||||
"reachable": block.reachable,
|
||||
"successors": block.successors.iter()
|
||||
.map(|id| id.0).collect::<Vec<_>>(),
|
||||
"terminator": terminator_name(&block.terminator)
|
||||
}));
|
||||
}
|
||||
|
||||
functions.push(json!({
|
||||
"name": func_name,
|
||||
"entry_block": function.entry_block.0,
|
||||
"blocks": blocks
|
||||
}));
|
||||
}
|
||||
|
||||
json!({ "functions": functions })
|
||||
}
|
||||
```
|
||||
|
||||
### Step 2: Integrate into Analysis IR
|
||||
|
||||
**File:** `tools/hako_check/analysis_consumer.hako`
|
||||
|
||||
Add CFG extraction call:
|
||||
```hako
|
||||
// After existing IR building...
|
||||
if needs_cfg {
|
||||
local cfg_info = extract_cfg_from_mir(module)
|
||||
ir.set("cfg", cfg_info)
|
||||
}
|
||||
```
|
||||
|
||||
### Step 3: DeadBlockAnalyzerBox consumes CFG
|
||||
|
||||
**File:** `tools/hako_check/rules/rule_dead_blocks.hako`
|
||||
|
||||
```hako
|
||||
static box DeadBlockAnalyzerBox {
|
||||
method apply_ir(ir, path, out) {
|
||||
local cfg = ir.get("cfg")
|
||||
if cfg == null { return }
|
||||
|
||||
local functions = cfg.get("functions")
|
||||
local i = 0
|
||||
while i < functions.size() {
|
||||
local func = functions.get(i)
|
||||
me._analyze_function_blocks(func, path, out)
|
||||
i = i + 1
|
||||
}
|
||||
}
|
||||
|
||||
_analyze_function_blocks(func, path, out) {
|
||||
local blocks = func.get("blocks")
|
||||
local func_name = func.get("name")
|
||||
|
||||
local bi = 0
|
||||
while bi < blocks.size() {
|
||||
local block = blocks.get(bi)
|
||||
local reachable = block.get("reachable")
|
||||
|
||||
if reachable == 0 {
|
||||
local msg = "[HC020] Unreachable block: fn=" + func_name
|
||||
+ " bb=" + me._itoa(block.get("id"))
|
||||
out.push(msg + " :: " + path)
|
||||
}
|
||||
|
||||
bi = bi + 1
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## JoinIR Strict Mode Compatibility
|
||||
|
||||
**Question:** Does `NYASH_JOINIR_STRICT=1` affect CFG structure?
|
||||
|
||||
**Answer:** No. CFG is computed **after** JoinIR lowering in `MirBuilder`:
|
||||
1. JoinIR → MIR lowering (produces blocks with terminators)
|
||||
2. CFG computation (fills predecessors/successors from terminators)
|
||||
3. Reachability analysis (marks unreachable blocks)
|
||||
|
||||
**Verification needed:** Test with Phase 150 representative cases:
|
||||
- `peek_expr_block.hako` - Match expressions
|
||||
- `loop_min_while.hako` - Loop with PHI
|
||||
- `joinir_min_loop.hako` - Break control
|
||||
- `joinir_if_select_simple.hako` - Early return
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. ✅ Create `src/mir/cfg_extractor.rs` - Extract CFG to JSON
|
||||
2. ⏳ Modify `analysis_consumer.hako` - Add CFG field
|
||||
3. ⏳ Implement `rule_dead_blocks.hako` - DeadBlockAnalyzerBox
|
||||
4. ⏳ Create test cases - 4 dead block patterns
|
||||
5. ⏳ Update CLI - Add `--dead-blocks` flag
|
||||
|
||||
---
|
||||
|
||||
**Created:** 2025-12-04
|
||||
**Phase:** 154 (MIR CFG Integration & Dead Block Detection)
|
||||
**Status:** Task 1 Complete
|
||||
Reference in New Issue
Block a user