PCOVから学ぶコードカバレッジ #phpcon_odawara

PHPカンファレンス小田原2026 での登壇資料です
https://fortee.jp/phpconodawara-2026/proposal/aae4efc9-59c8-4edc-a57e-571886c24fd6

Transcript

1. PCOVから学ぶコードカバレッジ PHPカンファレンス小田原2026 Hideki Kinjyo GitHub: o0h / X: @o0h_ [発表用] v1.0.0
2. こんにちは〜〜〜〜〜〜！！ 2
3. このトークのプロポーザル 3
4. 今、ここにいるのは 隣の人も、前後にいる人も カンファレンスで朝10時から 「コードカバレッジでも学ぶか〜〜」 っていう皆さん 4
5. 繋がってください。仲間と。 #phpcon_odawara #boko インターネットで。 5
6. カバレッジってなんだ？ 6
7. カバレッジってなんだ？ 7
8. 明日から使える豆知識が増えましたね！ (おめでとうございます) 8
9. ここまでのまとめ 1. タイトル 2. 挨拶 3. トークの紹介(forteeから) 4. ネットワーキング 5. 豆知識 9
10. ここまでのまとめ 1. タイトル 2. 挨拶 3. トークの紹介(forteeから) 4. ネットワーキング 5. 豆知識 10 実行されたプログラム
11. ここまでのまとめ 11 実行されたプログラム 1. タイトル 2. 挨拶 3. トークの紹介(forteeから) 4. ネットワーキング 5. 豆知識 ロジックとスライドを 対応付けてみると？
12. ロジックと「実装」ソース 12 実行されたプログラム 1. タイトル 2. 挨拶 3. トークの紹介(forteeから) 4. ネットワーキング 5. 豆知識 ＃1 ＃2 ＃3 ＃4 ＃5 ＃6 ＃7 ＃8
13. ロジックと「実装」ソース 13 実行されたプログラム 1. タイトル 2. 挨拶 3. トークの紹介(forteeから) 4. ネットワーキング 5. 豆知識 ＃1 ＃2 ＃3 ＃4 ＃5 ＃6 ＃7 ＃8 カバーされたスライド
14. ロジックと「実装」ソース 14 「未実行」なスライドもある ＃1 ＃2 ＃3 ＃4 ＃5 ＃6 ＃7 ＃8 #?? #??
15. 普段のプログラム実行においては (実行の結果として)何が出力されたかが大事 15
16. 普段のプログラム実行においては (実行の結果として)何が出力されたかが大事 どこが実行された/されなかったかって 意識もされない(できない)ですよね・・・？ 16
17. このトークのプロポーザル 17
18. このトークのプロポーザル 18
19. このトークのプロポーザル 19
20. カバレッジ測定には、 通常の実行では使われない？捨てられる？データを 収集する必要がある 20
21. カバレッジ測定には、 通常の実行では使われない？捨てられる？データを 収集する必要がある なんかPHP拡張ってのを使っているらしいな！ 21
22. 今日のお話 カバレッジ測定を通じて、 「PHP拡張は、どんな機能を提供しているのか」 「何を可能にしているのか」 を知っていきましょう (※ なるべくCのコードは触れません) 22
23. 自己紹介 • 金城秀樹 / きんじょうひでき • GitHub: @o0h / 𝕏 : @o0h_ • 好きなFWはCakePHP • アイコンは美味しい鮭親子丼の写真です • 楽しみすぎて有給取って昨日から小田原に居ます • 最近はPodcastをやっています • ハッシュタグ: #readlinefm 
24. おしながき 1. pcovの基本的な使い方や機能を見てみる 2. 実行されたファイル・行を記録する仕組み 3. 実行済み・未実行のファイル・行を分別する仕組み 4. まとめ 24
25. ① pcovの基本的な使い方や機能を見てみる ② 実行されたファイル・行を記録する仕組み ③ 実行済み・未実行のファイル・行を分別する仕組み ④ まとめ
26. カバレッジを測定しよう！！ #とは
27. 27 こういうやつの話
28. <?php ?> 実行されていない 実行されていない
29. <?php div(2.5, 3.2); ?> 実行された 実行された
30. <?php div(2.5, 3.2); div(2.5, 0.0); ?> 実行された
31. pcovによるカバレッジの測定 (起動・終了・収集)
32. 測定対象コード 関数の定義ファイル。 このうち、 「どこが実行されたか」 を測定していくには？ 32 <?php function div( float $left, float $right ): ?float { if ($right == 0) { return null; } return $left / $right; } 001 002 003 004 005 006 007 008 009 010 011 012 013
33. 測定実行コード pcovの関数を利用して カバレッジを測定する コード 33 <?php require 'functions.php'; \pcov\start(); $a = div(2.5, 3.2); \pcov\stop(); $coverage = \pcov\collect(); var_dump($coverage); 001 002 003 004 005 006 007 008 009 010 011 012
34. 測定実行コード 34 <?php require 'functions.php'; \pcov\start(); $a = div(2.5, 3.2); \pcov\stop(); $coverage = \pcov\collect(); var_dump($coverage); 001 002 003 004 005 006 007 008 009 010 011 012 ここから測定開始
35. 測定実行コード 35 <?php require 'functions.php'; \pcov\start(); $a = div(2.5, 3.2); \pcov\stop(); $coverage = \pcov\collect(); var_dump($coverage); 001 002 003 004 005 006 007 008 009 010 011 012 ここで測定終了
36. 測定実行コード 36 <?php require 'functions.php'; \pcov\start(); $a = div(2.5, 3.2); \pcov\stop(); $coverage = \pcov\collect(); var_dump($coverage); 001 002 003 004 005 006 007 008 009 010 011 012 ここが測定対象
37. 測定実行コード 37 <?php require 'functions.php'; \pcov\start(); $a = div(2.5, 3.2); \pcov\stop(); $coverage = \pcov\collect(); var_dump($coverage); 001 002 003 004 005 006 007 008 009 010 011 012 測定結果の生成・取得
38. 測定結果 38 ["/opt/lib/functions.php"]=> array(4) { [13]=> int(-1) [7]=> int(1) [8]=> int(-1) [11]=> int(1) } $coverage = \pcov\collect(); var_dump($coverage); \pcov\collect()の 実行結果をdumpしたもの
39. 測定結果 39 ["/opt/lib/functions.php"]=> array(4) { [13]=> int(-1) [7]=> int(1) [8]=> int(-1) [11]=> int(1) } 対象ファイル 対象行 測定結果
40. 測定結果 40 ["/opt/lib/functions.php"]=> array(4) { [13]=> int(-1) [7]=> int(1) [8]=> int(-1) [11]=> int(1) } 1回でもその行を通った 1回もその行を通らなかった
41. 測定結果 41 [13]=> int(-1) [7]=> int(1) [8]=> int(-1) [11]=> int(1) <?php function div( float $left, float $right ): ?float { if ($right == 0) { return null; } return $left / $right; } 001 002 003 004 005 006 007 008 009 010 011 012 013 require 'functions.php'; \pcov\start(); $a = div(2.5, 3.2); \pcov\stop();
42. 測定結果(余談) 13行目を「未実行」って どういうことでしょうね 42 [13]=> int(-1) [7]=> int(1) [8]=> int(-1) [11]=> int(1) <?php function div( float $left, float $right ): ?float { if ($right == 0) { return null; } return $left / $right; } 001 002 003 004 005 006 007 008 009 010 011 012 013
43. 測定結果(余談) requireの実行を start/stopに 含めればOK 43 [13]=> int(-1) [7]=> int(1) [8]=> int(-1) [11]=> int(1) require 'functions.php'; \pcov\start(); div(2.5, 3.2); \pcov\stop(); [13]=> int(1) [7]=> int(1) [8]=> int(-1) [11]=> int(1) \pcov\start(); require 'functions.php'; div(2.5, 3.2); \pcov\stop();
44. pcovが提供している(その他の)PHP関数
45. pcov拡張が提供している関数 \pcov\start, \pcov\stop, \pcov\collect Ҏ֎ʹ΋ɾɾ • \pcov\enabled : pcov͕༗ޮʹͳ͍ͬͯΔ͔Λฦ͢ • \pcov\clear : ֨ೲ͞Ε͍ͯΔ৘ใΛΫϦΞ • \pcov\waiting : collect͞Ε͍ͯͳ͍ϑΝΠϧϦετΛฦ͢ • \pcov\memory : ֬อࡁΈͰ࢖ΘΕ͍ͯͳ͍ϝϞϦ༰ྔΛฦ͢ 45
46. ① pcovの基本的な使い方や機能を見てみる ② 実行されたファイル・行を記録する仕組み ③ 実行済み・未実行のファイル・行を分別する仕組み ④ まとめ
47. pcovが「できること」は分かったので それを「どうやっているのか」、 「何を使っているのか」の話 47
48. 先にネタバレ 実行されたファイル・行を記録する仕組み • PHPのコードから低次元に変換されたコードが 1ステップずつ実行される際に、 • pcov独自の処理を差し込んで • 「元のソースコードのどこの行か」を記録しておく 48
49. 先にネタバレ 実行されたファイル・行を記録する仕組み • PHPのコードから低次元に変換されたコードが 1ステップずつ実行される際に、 • pcov独自の処理を差し込んで • 「元のソースコードのどこの行か」を記録しておく 49
50. 順番に見ていきましょう 1. 低次元に変換されたコード 2. 1ステップずつ実行される 3. 処理を差し込んで 4. 元のソースコードのどこの行か 50
51. 順番に見ていきましょう 1. 低次元に変換されたコード 2. 1ステップずつ実行される 3. 処理を差し込んで 4. 元のソースコードのどこの行か 51
52. PHPスクリプトが実行されるまで 52 PHPのコード (いつもの) 本当のCPU (何か良い感じにする)
53. PHPスクリプトが実行されるまで 53 PHPのコード (いつもの) 本当のCPU 仮想マシン ZendVM 機械語 (何か良い感じにする)
54. PHPスクリプトが実行されるまで 54 PHPのコード (いつもの) 本当のCPU 仮想マシン ZendVM OpCode 機械語 Zend Compiler
55. PHPスクリプトが実行されるまで 55 PHPのコード (いつもの) 本当のCPU 仮想マシン ZendVM OpCode 機械語 Zend Compiler 低次元に変換されたコード
56. りある・おぺこーど <?php function f($a, $b) { if ($b == 0) { return null; } return $a / $b; } $a = f(2, 3); $b = f(2, 0); $_main: L10 00 INIT_FCALL 2 144 string("f") L10 01 SEND_VAL int(2) 1 L10 02 SEND_VAL int(3) 2 L10 03 V2 = DO_FCALL L10 04 ASSIGN CV0($a) V2 L11 05 INIT_FCALL 2 144 string("f") L11 06 SEND_VAL int(2) 1 L11 07 SEND_VAL int(0) 2 L11 08 V4 = DO_FCALL L11 09 ASSIGN CV1($b) V4 L12 10 RETURN int(1) f: L02 00 CV0($a) = RECV 1 L02 01 CV1($b) = RECV 2 L04 02 T2 = IS_EQUAL CV1($b) int(0) 56
57. PHPスクリプトが実行されるまで 57 本当のCPU 仮想マシン ZendVM 機械語 $_main: L10 00 INIT_FCALL 2 144 string("f") L10 01 SEND_VAL int(2) 1 L10 02 SEND_VAL int(3) 2 L10 03 V2 = DO_FCALL L10 04 ASSIGN CV0($a) V2 L11 05 INIT_FCALL 2 144 string("f") L11 06 SEND_VAL int(2) 1 L11 07 SEND_VAL int(0) 2 L11 08 V4 = DO_FCALL L11 09 ASSIGN CV1($b) V4 L12 10 RETURN int(1) f: L02 00 CV0($a) = RECV 1 L02 01 CV1($b) = RECV 2 L04 02 T2 = IS_EQUAL CV1($b) int(0) L04 03 JMPZ T2 05 L05 04 RETURN null L08 05 T3 = DIV CV0($a) CV1($b) L08 06 RETURN T3 L09 07 RETURN null
58. out-of-scope • これがなぜ「何か良い感じに」なのかは、 PHPerKaigi 2026の発表を参照してください • 何となく伝わる気がします 58 https://speakerdeck.com/o0h/phperkaigi-2026
59. 順番に見ていきましょう 1. 低次元に変換されたコード 2. 1ステップずつ実行される 3. 処理を差し込んで 4. 元のソースコードのどこの行か 59
60. PHPスクリプトが実行されるまで 60 PHPのコード (いつもの) 本当のCPU 仮想マシン ZendVM OpCode 機械語 Zend Compiler さっきの図
61. PHPスクリプトが実行されるまで 61 PHPのコード (いつもの) 本当のCPU 仮想マシン ZendVM OpCode 機械語 Zend Compiler さっきの図 ココで起きていること
62. ZendVMのメインループ • 起点となるフレームを受け取る • その中にオペコードのリストがある • リストの順に実行していく 62 仮想マシン ZendVM OpCode
63. ZendVMのメインループ 63 $_main: L10 00 INIT_FCALL 2 144 string("f") L10 01 SEND_VAL int(2) 1 L10 02 SEND_VAL int(3) 2 L10 03 V2 = DO_FCALL L10 04 ASSIGN CV0($a) V2 L11 05 INIT_FCALL 2 144 string("f") ɾ ɾ ɾ 仮想マシン ZendVM 丸っと受け取る op_array
64. ZendVMのメインループ 64 L10 00 INIT_FCALL 2 144 string("f") 仮想マシン ZendVM 1ステップずつ実行 L10 01 SEND_VAL int(2) 1 L10 02 SEND_VAL int(3) 2 L10 03 V2 = DO_FCALL ɾ ɾ ɾ opline
65. ZendVMのメインループ 65 L10 00 INIT_FCALL 2 144 string("f") ɾ ɾ ɾ L10 03 V2 = DO_FCALL 仮想マシン ZendVM f: L02 00 CV0($a) = RECV 1 L02 01 CV1($b) = RECV 2 L04 02 T2 = IS_EQUAL CV1($b) int(0) ɾ ɾ ɾ 別のフレームの実行
66. zend_execute_ex 「いち関数実行(メイン関数を含む)」ごとに、 `zend_execute_ex` が実行される 66 $_main: 仮想マシン ZendVM f: zend_execute_ex zend_execute_ex ※ このあたり、拡張の利用有無で挙動が変わることがある
67. zend_execute_ex (っぽいもの) zend_execute_exは、1つのフレームに相当する単位で 実行するデータを受け取り、1ステップずつ処理していく 67 function zend_execute_ex($࣮ߦ͢Δσʔλ) { $op_array = $࣮ߦ͢Δσʔλ->ίϨΫγϣϯ; foreach ($op_array as $opline) { εςοϓ͝ͱͷॲཧ($opline); } } PHPer向けの ざっくりイメージ ※ このあたり、拡張の利用有無で挙動が変わることがある
68. ↑ここまでが「通常のPHP」の処理の話 ↓やっと「PHP拡張」の話が出てきます！！！ 68
69. 順番に見ていきましょう 1. 低次元に変換されたコード 2. 1ステップずつ実行される 3. 処理を差し込んで 4. 元のソースコードのどこの行か 69
70. PHP拡張とフック • デフォルトのzend_execute_exを任意に差し替えられる • 拡張側で関数ポインタをオーバーライドする • PHP拡張を作成する際には、いくつかのフックを利用可能 • モジュールの初期化時、リクエスト処理の開始(初期化)時・・ など、いくつかのフックが用意されている • これらのフックに引っ掛けて、「元の処理をオーバーライド」する 70
71. pcovのオーバーライド PHP_MINIT_FUNCTION(pcov) { /** লུ */ if (php_pcov_api_enabled()) { zend_execute_ex_function = zend_execute_ex; zend_execute_ex = php_pcov_execute_ex; } ZVAL_LONG(&php_pcov_uncovered, PHP_PCOV_UNCOVERED); ZVAL_LONG(&php_pcov_covered, PHP_PCOV_COVERED); /** লུ */ return SUCCESS; }  pcov.c
72. pcovのオーバーライド PHP_MINIT_FUNCTION(pcov) { /** লུ */ /** লུ */ }  PHP_MINIT_FUNCTION(pcov) 「モジュールの初期化」時に 処理をぶら下げるフック のおまじない(マクロ) pcov.c
73. pcovのオーバーライド PHP_MINIT_FUNCTION(pcov) { /** লུ */ /** লུ */ }  if (php_pcov_api_enabled()) { モジュールを読み込んでいても、 iniファイル等でdisableされている pcov拡張が有効かをチェックして pcov.c
74. pcovのオーバーライド PHP_MINIT_FUNCTION(pcov) { /** লུ */ /** লུ */ }  zend_execute_ex_function = zend_execute_ex; 終了時のフックで 復帰に使う 元の処理を退避させて pcov.c
75. pcovのオーバーライド PHP_MINIT_FUNCTION(pcov) { /** লུ */ /** লུ */ }  zend_execute_ex = php_pcov_execute_ex; pcovの独自処理に 差し替える pcov.c
76. 余談 PHP_MINIT_FUNCTION(pcov) { /** লུ */ /** লུ */ }  ZVAL_LONG(&php_pcov_uncovered, PHP_PCOV_UNCOVERED); 「実行されていない行」 を示す定数、「-1」 ZVAL_LONG(&php_pcov_covered, PHP_PCOV_COVERED); 「実行されている行」 を示す定数、「1」 pcov.c
77. 順番に見ていきましょう 1. 低次元に変換されたコード 2. 1ステップずつ実行される 3. 処理を差し込んで 4. 元のソースコードのどこの行か 77
78. zend_execute_ex / _zend_execute_data zend_execute_exは_zend_execute_dataを受け取る 78 ZEND_API extern void (*zend_execute_ex) (zend_execute_data *execute_data); struct _zend_execute_data { const zend_op *opline; ɾɾɾ zval *return_value; zend_function *func; }; zend_execute.h zend_execute.h
79. zend_execute_ex / _zend_execute_data zend_execute_dataはzend_functionをもち、op_arrayを含む 1つのop_arrayが1つのフレームに相当(≒関数の中身のopcode) 79 struct _zend_execute_data { const zend_op *opline; ɾɾɾ zend_function *func; }; union _zend_function { uint8_t type; uint32_t quick_arg_flags; struct {...} common; zend_op_array op_array; ɾɾɾ }; zend_types.h zend_types.h
80. • 先ほど見たように、pcovを使うと zend_execute_exとしてphp_pcov_execute_exが呼び出される • この中身を追っていくことで、 どうやって実行された行を記録しているのか分かる(遂に！) php_pcov_execute_ex 80 zend_execute_ex = php_pcov_execute_ex;
81. php_pcov_execute_ex void php_pcov_execute_ex(zend_execute_data *execute_data) { int zrc = 0; while (1) { zrc = php_pcov_trace(execute_data); if (zrc != SUCCESS) { if (zrc < SUCCESS) { return; } execute_data = EG(current_execute_data); } } }  pcov.c
82. php_pcov_execute_ex (っぽいもの) function pcovExecuteEx($࣮ߦ͢Δσʔλ) { while (true) { $returnCode = pcovTrace($࣮ߦ͢Δσʔλ); if ($returnCode === CODE_શ෦ऴྃ) { return; } elseif ($returnCode !== CODE_ͦͷ··࣍΁) { $࣮ߦ͢Δσʔλ = ݱࡏͷϑϨʔϜऔಘ(); } } } 
83. php_pcov_execute_ex (っぽいもの) function pcovExecuteEx($࣮ߦ͢Δσʔλ) { while (true) { $returnCode = pcovTrace($࣮ߦ͢Δσʔλ); if ($returnCode === CODE_શ෦ऴྃ) { return; } elseif ($returnCode !== CODE_ͦͷ··࣍΁) { $࣮ߦ͢Δσʔλ = ݱࡏͷϑϨʔϜऔಘ(); } } }  while (true) { 全部終わるまで反復
84. php_pcov_execute_ex (っぽいもの) function pcovExecuteEx($࣮ߦ͢Δσʔλ) { while (true) { $returnCode = pcovTrace($࣮ߦ͢Δσʔλ); if ($returnCode === CODE_શ෦ऴྃ) { return; } elseif ($returnCode !== CODE_ͦͷ··࣍΁) { $࣮ߦ͢Δσʔλ = ݱࡏͷϑϨʔϜऔಘ(); } } }  pcovTrace($࣮ߦ͢Δσʔλ); opcodeを1ステップずつ実行 対応するPHPスクリプトの行を記録 実行結果状態を返す
85. php_pcov_execute_ex (っぽいもの) function pcovExecuteEx($࣮ߦ͢Δσʔλ) { while (true) { $returnCode = pcovTrace($࣮ߦ͢Δσʔλ); if ($returnCode === CODE_શ෦ऴྃ) { return; } elseif ($returnCode !== CODE_ͦͷ··࣍΁) { $࣮ߦ͢Δσʔλ = ݱࡏͷϑϨʔϜऔಘ(); } } }  if ($returnCode === CODE_શ෦ऴྃ) { return; } elseif ($returnCode !== CODE_ͦͷ··࣍΁) { $࣮ߦ͢Δσʔλ = ݱࡏͷϑϨʔϜऔಘ(); } 状態に応じて 離脱したり次に行ったり
86. php_pcov_trace static zend_always_inline int php_pcov_trace(zend_execute_data *execute_data) { if (PCG(enabled)) { if (php_pcov_wants(EX(func)->op_array.filename) && !php_pcov_ignored_opcode(EX(opline)->opcode) && !php_pcov_has(EX(func)->op_array.filename, EX(opline)->lineno)) { php_coverage_t *coverage = php_pcov_create(execute_data); if (!PCG(start)) { PCG(start) = coverage; } else { *(PCG(next)) = coverage; } PCG(next) = &coverage->next; } } return zend_vm_call_opcode_handler(execute_data); }  pcov.c
87. php_pcov_trace (っぽいもの) function pcovTrace($࣮ߦ͢Δσʔλ) { if (pcovଌఆελʔτࡁΈ()) { if (/** ଌఆσʔλΛ࡞ͬͯ௥Ճ͢Δ͔ */) { $ଌఆσʔλ = pcovCreate($࣮ߦ͢Δσʔλ); ଌఆσʔλ௥Ճ($ଌఆσʔλ); } } return zendVMͷඪ४Φϖίʔυॲཧ($࣮ߦ͢Δσʔλ); } 
88. php_pcov_trace (っぽいもの) function pcovTrace($࣮ߦ͢Δσʔλ) { if (pcovଌఆελʔτࡁΈ()) { if (/** ଌఆσʔλΛ࡞ͬͯ௥Ճ͢Δ͔ */) { $ଌఆσʔλ = pcovCreate($࣮ߦ͢Δσʔλ); ଌఆσʔλ௥Ճ($ଌఆσʔλ); } } return zendVMͷඪ४Φϖίʔυॲཧ($࣮ߦ͢Δσʔλ); }  if (pcovଌఆελʔτࡁΈ()) { pcov\start()するとフラグが立つ / pcov\stop()するとフラグが折れる 「スタート済み」フラグが 立っていれば処理に入る
89. php_pcov_trace (っぽいもの) function pcovTrace($࣮ߦ͢Δσʔλ) { if (pcovଌఆελʔτࡁΈ()) { if (/** ଌఆσʔλΛ࡞ͬͯ௥Ճ͢Δ͔ */) { $ଌఆσʔλ = pcovCreate($࣮ߦ͢Δσʔλ); ଌఆσʔλ௥Ճ($ଌఆσʔλ); } } return zendVMͷඪ४Φϖίʔυॲཧ($࣮ߦ͢Δσʔλ); }  if (/** ଌఆσʔλΛ࡞ͬͯ௥Ճ͢Δ͔ */) { (この後に詳しく)
90. php_pcov_trace (っぽいもの) function pcovTrace($࣮ߦ͢Δσʔλ) { if (pcovଌఆελʔτࡁΈ()) { if (/** ଌఆσʔλΛ࡞ͬͯ௥Ճ͢Δ͔ */) { $ଌఆσʔλ = pcovCreate($࣮ߦ͢Δσʔλ); ଌఆσʔλ௥Ճ($ଌఆσʔλ); } } return zendVMͷඪ४Φϖίʔυॲཧ($࣮ߦ͢Δσʔλ); }  pcovCreate($࣮ߦ͢Δσʔλ); 「実行済み」行のデータ作成 ଌఆσʔλ௥Ճ($ଌఆσʔλ); 「実行済み」行のデータのリスト更新
91. php_pcov_trace (っぽいもの) - 測定データの追加 if (ଌఆର৅ϑΝΠϧ͔($࣮ߦ͢Δσʔλ->func->ϑΝΠϧ໊) && !ແࢹ͢ΔΦϖίʔυ͔($࣮ߦ͢Δσʔλ->ݱࡏͷopline) && !طʹଌఆࡁΈ͔( $࣮ߦ͢Δσʔλ->func->ϑΝΠϧ໊, $࣮ߦ͢Δσʔλ->ߦ൪߸ )) { $ଌఆσʔλ = pcovCreate($࣮ߦ͢Δσʔλ); ଌఆσʔλ௥Ճ($ଌఆσʔλ); } 
92. php_pcov_create static zend_always_inline php_coverage_t* php_pcov_create(zend_execute_data *execute_data) { /* {{{ */ php_coverage_t *create = (php_coverage_t*) zend_arena_alloc(&PCG(mem), sizeof(php_coverage_t)); create->file = php_pcov_interned_string(EX(func)- >op_array.filename); create->line = EX(opline)->lineno; create->next = NULL; zend_hash_add_empty_element(&PCG(waiting), create->file); return create; } /* }}} */  pcov.c
93. php_pcov_create - 要点 // php_pcov_create(zend_execute_data *execute_data) { php_coverage_t *create = /** ...* / create->file = php_pcov_interned_string( EX(func)->op_array.filename ); create->line = EX(opline)->lineno; create->next = NULL; return create; }  ファイル名、 行番号を持つ 構造体
94. 「元のソースコードのどこの行か」をまとめると • opcodeを1行ずつ(opline)処理する際に • pcov独自の処理を挟んで→通常の処理に渡す • 独自の処理 = • op_array/oplineからファイル名・行番号を取り出して • 「処理が通った行」データを集めたコレクション(リスト)を作る 94
95. ① pcovの基本的な使い方や機能を見てみる ② 実行されたファイル・行を記録する仕組み ③ 実行済み・未実行のファイル・行を分別する仕組み ④ まとめ
96. まずはネタバレ 実行済み・未実行のファイル・行を分別する仕組み 1. 「測定対象ファイル」のリストを作っておいて 2. collect()実行時に、 「測定対象ファイル」の内、測定対象行を分析 3. 事前に記録しておいた実行済みのファイル・行のデータと 統合して、未実行・実行済みの行を整理 96
97. まずはネタバレ 実行済み・未実行のファイル・行を分別する仕組み 1. 「測定対象ファイル」のリストを作っておいて 2. collect()実行時に、 「測定対象ファイル」の内、測定対象行を分析 3. 事前に記録しておいた実行済みのファイル・行のデータと 統合して、未実行・実行済みの行を整理 97
98. 順番に見ていきましょう 1. 「測定対象ファイル」のリストを作る 2. collect()実行時: 測定対象行を分析 3. collect()実行時: 未実行・実行済みの行を整理 98
99. 順番に見ていきましょう 1. 「測定対象ファイル」のリストを作る 2. collect()実行時: 測定対象行を分析 3. collect()実行時: 未実行・実行済みの行を整理 99
100. PHPスクリプトが実行されるまで 100 PHPのコード (いつもの) 本当のCPU 仮想マシン ZendVM OpCode 機械語 Zend Compiler さっきの図
101. PHPスクリプトが実行されるまで 101 PHPのコード (いつもの) 本当のCPU 仮想マシン ZendVM OpCode 機械語 Zend Compiler さっきの図 ここでの仕事が大事
102. pcovのオーバーライド PHP_RINIT_FUNCTION(pcov) { /** লུ */ if (!zend_compile_file_function) { zend_compile_file_function = zend_compile_file; zend_compile_file = php_pcov_compile_file; } /** লུ */ return SUCCESS; }  pcov.c
103. pcovのオーバーライド PHP_RINIT_FUNCTION(pcov) { /** লུ */ /** লུ */ }  pcov.c zend_compile_file = php_pcov_compile_file; phpスクリプト→opcode変換処理の オーバーライド
104. php_pcov_compile_file (っぽいもの) function pcovCompileFile(FileHandler $file, int $type) { $op_array = zendCompilerඪ४ͷॲཧ($file, $type); if (!$op_array || !$op_array->filename || !ଌఆର৅ʹؚΊ͍͍͔ͯ($op_array->finename) || طʹ௥ՃࡁΈ͔($op_array->finename) ) { return $op_array; } ଌఆର৅ϑΝΠϧʹ௥Ճ($op_array->filename); /** GCपΓͷॲཧ͕ίίʹೖ͍ͬͯΔ */ return $op_array; } 
105. php_pcov_compile_file (っぽいもの) function pcovCompileFile(FileHandler $file, int $type) { $op_array = zendCompilerඪ४ͷॲཧ($file, $type); if (!$op_array || !$op_array->filename || !ଌఆର৅ʹؚΊ͍͍͔ͯ($op_array->filename) || طʹ௥ՃࡁΈ͔($op_array->finename) ) { return $op_array; } ଌఆର৅ϑΝΠϧʹ௥Ճ($op_array->filename); /** GCपΓͷॲཧ͕ίίʹೖ͍ͬͯΔ */ return $op_array; }  $op_array = zendCompilerඪ४ͷॲཧ($file, $type); 元の処理を実行して、 この関数の戻り値を取得する このデータ(op_array)が そのまま関数全体の戻り値になる
106. php_pcov_compile_file (っぽいもの) function pcovCompileFile(FileHandler $file, int $type) { $op_array = zendCompilerඪ४ͷॲཧ($file, $type); if (!$op_array || !$op_array->filename || !ଌఆର৅ʹؚΊ͍͍͔ͯ($op_array->finename) || طʹ௥ՃࡁΈ͔($op_array->finename) ) { return $op_array; } ଌఆର৅ϑΝΠϧʹ௥Ճ($op_array->filename); /** GCपΓͷॲཧ͕ίίʹೖ͍ͬͯΔ */ return $op_array; }  !ଌఆର৅ʹؚΊ͍͍͔ͯ($op_array->finename) 測定/除外対象の 設定内容との照合
107. php_pcov_compile_file (っぽいもの) function pcovCompileFile(FileHandler $file, int $type) { $op_array = zendCompilerඪ४ͷॲཧ($file, $type); if (!$op_array || !$op_array->filename || !ଌఆର৅ʹؚΊ͍͍͔ͯ($op_array->finename) || طʹ௥ՃࡁΈ͔($op_array->finename) ) { return $op_array; } ଌఆର৅ϑΝΠϧʹ௥Ճ($op_array->filename); /** GCपΓͷॲཧ͕ίίʹೖ͍ͬͯΔ */ return $op_array; }  طʹ௥ՃࡁΈ͔($op_array->finename) もうメモしてあるファイルだったらスキップ
108. php_pcov_compile_file (っぽいもの) function pcovCompileFile(FileHandler $file, int $type) { $op_array = zendCompilerඪ४ͷॲཧ($file, $type); if (!$op_array || !$op_array->filename || !ଌఆର৅ʹؚΊ͍͍͔ͯ($op_array->finename) || طʹ௥ՃࡁΈ͔($op_array->finename) ) { return $op_array; } ଌఆର৅ϑΝΠϧʹ௥Ճ($op_array->filename); /** GCपΓͷॲཧ͕ίίʹೖ͍ͬͯΔ */ return $op_array; }  ଌఆର৅ϑΝΠϧʹ௥Ճ($op_array->filename); ココが肝！！
109. 順番に見ていきましょう 1. 「測定対象ファイル」のリストを作る 2. collect()実行時: 測定対象行を分析 3. collect()実行時: 未実行・実行済みの行を整理 109
110. そろそろコードばっか見せられて 疲れてきちゃったな、って思っていますか？ 図で説明して良いですかね 110
111. \pcov\collect() のおさらい • 「実行された行」「されなかった行」のデータを返す関数 • この関数が呼ばれると、集めたデータの統合と整理を行う • コンパイル時に集めた 「対象ファイル」の一覧 • コード実行時に記録された 「実行された行」の一覧 111 // var_dump(\pcov\collect()); ["/opt/hoge.php"]=> array(4) { [13]=> int(-1) [7]=> int(1) [8]=> int(-1) [11]=> int(1) }
112. 測定対象行の分析の流れ 112 op_array 制御フローグラフ 結果データの初期化 コンパイル ZEND_APIの機能 測定対象行の抽出 カバレッジデータとの統合 PHPスクリプト
113. 測定対象行の〜 113 op_array 制御フローグラフ 結果データの初期化 コンパイル ZEND_APIの機能 測定対象行の抽出 カバレッジデータとの統合 PHPスクリプト <?php function add(int $a, int $b): int { return $a + $b; } \pcov\start(); $x = add(1, 2); if (false) { return; var_dump('ίίʹ͸དྷͳ͍Α'); } else { var_dump('ίίʹ͸དྷΔͬͯ͞'); } echo $x; \pcov\stop(); // ݁ՌΛऔಘ $coverage = \pcov\collect(); 001 002 003 004 005 006 007 008 009 010 011 012 013 014 015 016 017 018
114. 測定対象行の〜 制御フローグラフ 結果データの初期化 ZEND_APIの機能 測定対象行の抽出 カバレッジデータとの統合 PHPスクリプト op_array コンパイル [000] L6 ZEND_INIT_FCALL op1=JMP->[002] op2 [001] L6 ZEND_DO_ICALL [002] L7 ZEND_INIT_FCALL op1=JMP->[006] op2 [003] L7 ZEND_SEND_VAL op1=CONST(1) op2=J [004] L7 ZEND_SEND_VAL op1=CONST(2) op2=J [005] L7 ZEND_DO_FCALL [006] L7 ZEND_ASSIGN op1=CV($x) op2=VAR [007] L8 ZEND_JMPZ op1=CONST(false) o [008] L9 ZEND_RETURN op1=CONST(null) [009] L10 ZEND_INIT_FCALL op1=JMP->[012] op2 [010] L10 ZEND_SEND_VAL op1=CONST("ίίʹ͸དྷ [011] L10 ZEND_DO_ICALL [012] L8 ZEND_JMP op1=JMP->[016] [013] L12 ZEND_INIT_FCALL op1=JMP->[016] op2 [014] L12 ZEND_SEND_VAL op1=CONST("ίίʹ͸དྷ [015] L12 ZEND_DO_ICALL [016] L14 ZEND_ECHO op1=CV($x) [017] L15 ZEND_INIT_FCALL op1=JMP->[019] op2 [018] L15 ZEND_DO_ICALL [019] L18 ZEND_INIT_FCALL op1=JMP->[021] op2 [020] L18 ZEND_DO_ICALL [021] L18 ZEND_ASSIGN op1=CV($coverage)
115. 実行に関わりが無い行が消える op_arrayの時点で、 「実行可能なコードがない」行は消えている 115 [013] L12 ZEND_INIT_FCALL [014] L12 ZEND_SEND_VAL [015] L12 ZEND_DO_ICALL [016] L14 ZEND_ECHO [017] L15 ZEND_INIT_FCALL 011 012 013 014 015 } else { var_dump(' } echo $x; \pcov\stop(); L13は処理を持たない
116. 測定対象行の〜 116 op_array 結果データの初期化 コンパイル 測定対象行の抽出 カバレッジデータとの統合 PHPスクリプト 制御フローグラフ ZEND_APIの機能 Block 0 (start=0 len=8) => REACHABLE Block 1 (start=8 len=1) => REACHABLE Block 2 (start=9 len=4) => UNREACHABLE Block 3 (start=13 len=3) => REACHABLE Block 4 (start=16 len=8) => REACHABLE
117. 制御フローグラフ？ • プログラムが通りうる経路を整理したやつ • 「ブロック」と、それらをつなぐ「ノード」で成り立つ • pcovでは、ブロックごとの「到達可能・不可能」を気にする 117
118. 到達不能な行(ブロック)が区別される • op_arrayを分岐地点でブロックに区切る • 条件分岐やreturnがあるところが境目 118 006 007 008 009 010 011 012 013 014 \pcov\start(); $x = add(1, 2); if (false) { return; var_dump(' } else { var_dump(' } echo $x; Block 0 [REACHABLE] start=0 len=8 000 L6 ZEND_INIT_FCALL op1=JMP->002 op2=CONST( 001 L6 ZEND_DO_ICALL 002 L7 ZEND_INIT_FCALL op1=JMP->[006] op2=CONS 003 L7 ZEND_SEND_VAL op1=CONST(1) op2=JMP->[ 004 L7 ZEND_SEND_VAL op1=CONST(2) op2=JMP->[ 005 L7 ZEND_DO_FCALL 006 L7 ZEND_ASSIGN op1=CV($x) op2=VAR(208) 007 L8 ZEND_JMPZ op1=CONST(false) op2=J
119. 到達不能な行(ブロック)が区別される • op_arrayを分岐地点でブロックに区切る • 条件分岐やreturnがあるところが境目 119 006 007 008 009 010 011 012 013 014 \pcov\start(); $x = add(1, 2); if (false) { return; var_dump(' } else { var_dump(' } echo $x; Block 1 [REACHABLE] start=8 len=1 008 L9 ZEND_RETURN op1=CONST(null)
120. 到達不能な行(ブロック)が区別される • op_arrayを分岐地点でブロックに区切る • 条件分岐やreturnがあるところが境目 120 006 007 008 009 010 011 012 013 014 \pcov\start(); $x = add(1, 2); if (false) { return; var_dump(' } else { var_dump(' } echo $x; Block 2 [UNREACHABLE] start=9 len=4 009 L10 ZEND_INIT_FCALL op1=JMP->[012] 010 L10 ZEND_SEND_VAL op1=CONST(" 011 L10 ZEND_DO_ICALL 012 L8 ZEND_JMP op1=JMP->[016
121. 到達不能な行(ブロック)が区別される • pcovでは、「絶対に到達することのない」行は カバレッジの分母から消される • PHPスクリプトの10行目とはここでさようなら〜 121 008 009 010 if (false) { return; var_dump(' Block 2 [UNREACHABLE] start=9 len=4 009 L10 ZEND_INIT_FCALL op1=JMP->[012] 010 L10 ZEND_SEND_VAL op1=CONST(" 011 L10 ZEND_DO_ICALL 012 L8 ZEND_JMP op1=JMP->[016
122. 測定対象行の〜 122 op_array 制御フローグラフ コンパイル ZEND_APIの機能 測定対象行の抽出 PHPスクリプト 結果データの初期化 カバレッジデータとの統合 /opt/pcov-demo.php: line 6:-1 line 7:-1 line 8:-1 line 9:-1 line 12: -1 line 14: -1 line 15: -1 line 18: -1 line 20: -1 line 23: -1 line 24: -1 line 25: -1 line 27: -1 全ての対象行に対する、 「行番号」と「結果」を 持つデータを構築 この時点では、 「-1 = 未実行」で 埋めておく
123. 順番に見ていきましょう 1. 「測定対象ファイル」のリストを作る 2. collect()実行時: 測定対象行を分析 3. collect()実行時: 未実行・実行済みの行を整理 123
124. 実行済みの行をマークする 124 最終的な測定結果 結果データの初期化 測定対象行の抽出 カバレッジデータとの統合 PHP側に結果を返す
125. さっき見たやつ if (ଌఆର৅ϑΝΠϧ͔($࣮ߦ͢Δσʔλ->func->ϑΝΠϧ໊) && !ແࢹ͢ΔΦϖίʔυ͔($࣮ߦ͢Δσʔλ->ݱࡏͷopline) && !طʹଌఆࡁΈ͔( $࣮ߦ͢Δσʔλ->func->ϑΝΠϧ໊, $࣮ߦ͢Δσʔλ->ߦ൪߸ )) { $ଌఆσʔλ = pcovCreate($࣮ߦ͢Δσʔλ); ଌఆσʔλ௥Ճ($ଌఆσʔλ); } 
126. さっき見たやつ if (ଌఆର৅ϑΝΠϧ͔($࣮ߦ͢Δσʔλ->func->ϑΝΠϧ໊) && !ແࢹ͢ΔΦϖίʔυ͔($࣮ߦ͢Δσʔλ->ݱࡏͷopline) && !طʹଌఆࡁΈ͔( $࣮ߦ͢Δσʔλ->func->ϑΝΠϧ໊, $࣮ߦ͢Δσʔλ->ߦ൪߸ )) { $ଌఆσʔλ = pcovCreate($࣮ߦ͢Δσʔλ); ଌఆσʔλ௥Ճ($ଌఆσʔλ); }  これです！！
127. カバレッジの測定データを組み立てる • ここまでで、 測定対象行(実行可能行)・実行された行のデータが揃った • あとは結構単純！ • 実行された行のデータ(のコレクション)を使って • まだ実行済みとしてマークされていなかったら、-1 => 1に 127
128. 測定対象行の〜 128 pcov-demo.php line 6: not covered line 7: covered line 8: covered line 9: not covered line 12: covered line 14: covered line 15: covered line 18: not covered line 20: not covered line 23: not covered line 24: not covered line 25: not covered line 27: not covered 最終的な測定結果 結果データの初期化 測定対象行の抽出 カバレッジデータとの統合 PHP側に結果を返す
129. ① pcovの基本的な使い方や機能を見てみる ② 実行されたファイル・行を記録する仕組み ③ 実行済み・未実行のファイル・行を分別する仕組み ④ まとめ
130. リマインド: 今日のお話 カバレッジ測定を通じて、 「PHP拡張は、どんな機能を提供しているのか」 「何を可能にしているのか」 を知っていきましょう 130
131. PHP拡張は、どんな機能を提供しているのか • PHP実行の主要なライフサイクルに、 独自の処理を差し込めるフックを提供している • コンパイル時(php -> opcode) • 実行時(opcode -> 機械語) 131
132. 何を可能にしているのか • 実行時には元のPHPコードを分解・変形したopcodeが渡される • それを以て「実行した」が分かる • もとのPHPファイル・行番号と照合すると、何とカバレッジ！ 132
133. 何を可能にしているのか • 実行時には元のPHPコードを分解・変形したopcodeが渡される • それを以て「実行した」が分かる • もとのPHPファイル・行番号と照合すると、何とカバレッジ！ • 「実行した行の記録」と「実行可能な行の算出」は 全く別のフェーズで実行されている • 後者は、集計時になって初めて行われる 133
134. 終わっての感想
135. お疲れ様でした！ 「コードカバレッジ」が 「何をカバーしている」のか、 少しでも感じられましたか？ 135
136. お疲れ様でした！ ここまで知らなくても、 困ることは無いのですが 知ってみると気持ち良い(きっと) 136
137. お疲れ様でした！ 最高に気持ちよくなりたい？ JetBrainsの「CLion」、 めっちゃ便利なので使っていきましょう 137
138. お疲れ様でした！ 最高に気持ちよくなりたい？ JetBrainsの「CLion」、 めっちゃ便利なので使っていきましょう 138 今すぐブースへ走 れ
139. おしまい！ お付き合いいただき ありがとうございました!!
140. Appendix Ⅰ カバレッジデータの利用に関する資料
141. PHPUnitと連携したコードカバレッジ取得 • PHPerKaigi 2024で発表したものがあります • Xdebug中心の紹介ですが、仕組みは同じ 141 https://speakerdeck.com/o0h/phperkaigi-2024
142. Appendix Ⅱ PHP拡張の開発と内部処理に関する資料
143. PHP拡張の中身・開発 • Writing PHP Extensions - YouTube • https://www.youtube.com/playlist?list=PLg9Kjjye- m1hW4z0J-546qaFpysjlo27x • Xdebug作者のDerickさんのYoutube • Writing PHP Extensions | Zend • https://www.zend.com/resources/writing-php-extensions • 古いかつ英語ですが、基本的なコンセプトは通じるはず 143
144. 最近のコミュニティでのPHP拡張関連の情報 • Deep Dive into Xdebug by nsfisis • @PHPカンファレンス小田原2026 • https://fortee.jp/phpconodawara-2026/proposal/ 2ff16827-3893-480e-b73b-0ff88e65e555 • PHP7.4でもOpenTelemetryゼロコード計装がしたい！ by Arthur • @PHPerKaigi 2026 • https://fortee.jp/phperkaigi-2026/proposal/8310bab7- a3d3-4b7a-8c98-8d6a97c4fc00 144
145. PHPの開発 • Using CLion with php-src - DEV Community • https://dev.to/ramsey/using-clion-with-php-src-4me0 • 少し前の記事だが、基本的にこの通りにやればphp-srcからPHPのデ バッグ実行まで行けるようになる(簡単！) • エラーになったら、ログやスクショを生成AIさんに渡して乗り切る 145
146. Appendix Ⅲ PHPの実行の様子 - oplineの逐次処理まで
147. PHPの実行の様子 - oplineの逐次処理まで 147
148. PHPの実行の様子 - oplineの逐次処理まで 148
149. PHPの実行の様子 - oplineの逐次処理まで 149
150. PHPの実行の様子 - oplineの逐次処理まで 150
151. PHPの実行の様子 - oplineの逐次処理まで 151
152. PHPの実行の様子 - oplineの逐次処理まで 152
153. PHPの実行の様子 - oplineの逐次処理まで 153