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.3.6
2. こんにちは〜〜〜〜〜〜！！ 2
3. このトークのプロポーザル 3
4. カバレッジってなんだ？ 4
5. カバレッジってなんだ？ 5
6. 明日から使える豆知識が増えましたね！ (おめでとうございます) 6
7. (話が逸れたぜ！) 閑話休題 7
8. ここまでのまとめ 1. タイトル 2. 挨拶 3. トークの紹介(forteeから) 4. 豆知識 8
9. ここまでのまとめ 1. タイトル 2. 挨拶 3. トークの紹介(forteeから) 4. 豆知識 9 実行されたプログラム
10. ここまでのまとめ 10 実行されたプログラム 1. タイトル 2. 挨拶 3. トークの紹介(forteeから) 4. 豆知識 プログラムと スライドを 対応付けてみると？
11. 1. タイトル 2. 挨拶 3. トークの紹介(forteeから) 4. 豆知識 実行されたプログラム ロジックと「実装」ソース 11 ＃1 ＃2 ＃3 ＃4 ＃5 ＃6
12. ロジックと「実装」ソース 12 カバーされたスライド 1. タイトル 2. 挨拶 3. トークの紹介(forteeから) 4. 豆知識 実行されたプログラム ＃1 ＃2 ＃3 ＃4 ＃5 ＃6
13. ロジックと「実装」ソース 13 「未実行」なスライドもある ＃1 ＃2 ＃3 ＃4 ＃5 ＃6 #?? #?? #?? #?? #??
14. 普段のプログラム実行においては (実行の結果として)何が出力されたかが大事 14
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); ?> 実行された if条件網羅
31. pcovによるカバレッジの測定 (起動・終了・収集)
32. 測定実行コード pcovの関数を利用して カバレッジを測定する コード 32 <?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
33. 測定実行コード 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 ["/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したもの
38. 測定結果 38 ["/opt/lib/functions.php"]=> array(4) { [13]=> int(-1) [7]=> int(1) [8]=> int(-1) [11]=> int(1) } 対象ファイル 対象行 測定結果
39. 測定結果 39 ["/opt/lib/functions.php"]=> array(4) { [13]=> int(-1) [7]=> int(1) [8]=> int(-1) [11]=> int(1) } 1回でもその行を通った 1回もその行を通らなかった
40. 測定結果 40 [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();
41. pcovが提供している(その他の)PHP関数
42. pcov拡張が提供している関数 \pcov\start, \pcov\stop, \pcov\collect Ҏ֎ʹ΋ɾɾ • \pcov\enabled : pcov͕༗ޮʹͳ͍ͬͯΔ͔Λฦ͢ • \pcov\clear : ֨ೲ͞Ε͍ͯΔ৘ใΛΫϦΞ • \pcov\waiting : collect͞Ε͍ͯͳ͍ϑΝΠϧϦετΛฦ͢ • \pcov\memory : ֬อࡁΈͰ࢖ΘΕ͍ͯͳ͍ϝϞϦ༰ྔΛฦ͢ 42
43. ① pcovの基本的な使い方や機能を見てみる ② 実行されたファイル・行を記録する仕組み ③ 実行済み・未実行のファイル・行を分別する仕組み ④ まとめ
44. pcovが「できること」は分かったので それを「どうやっているのか」、 「何を使っているのか」の話 44
45. 先にネタバレ 実行されたファイル・行を記録する仕組み • PHPでは、元のコードを低次元な形に変換した上で(opcode)、 • それを1ステップずつ実行される際に、 • pcov独自の処理を差し込んで • 「元のソースコードのどこの行か」を記録しておく 45
46. 先にネタバレ 実行されたファイル・行を記録する仕組み • PHPでは、元のコードを低次元な形に変換した上で(opcode)、 • それを1ステップずつ実行される際に、 • pcov独自の処理を差し込んで • 「元のソースコードのどこの行か」を記録しておく 46
47. 順番に見ていきましょう 1. 低次元な形に変換する 2. 1ステップずつ実行する(際に) 3. 処理を差し込んで 4. 元のソースコードのどこの行かを記録 47
48. 順番に見ていきましょう 1. 低次元な形に変換する 2. 1ステップずつ実行する(際に) 3. 処理を差し込んで 4. 元のソースコードのどこの行かを記録 48
49. PHPスクリプトが実行されるまで 49 PHPのコード (いつもの) 本当のCPU (何か良い感じにする)
50. PHPスクリプトが実行されるまで 50 PHPのコード (いつもの) 本当のCPU 仮想マシン ZendVM 機械語 (何か良い感じにする)
51. PHPスクリプトが実行されるまで 51 PHPのコード (いつもの) 本当のCPU 仮想マシン ZendVM OpCode 機械語 Zend Compiler
52. PHPスクリプトが実行されるまで 52 PHPのコード (いつもの) 本当のCPU 仮想マシン ZendVM OpCode 機械語 Zend Compiler 低次元に変換されたコード
53. りある・おぺこーど <?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) 53
54. PHPスクリプトが実行されるまで 54 本当の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
55. out-of-scope • これがなぜ「何か良い感じに」なのかは、 PHPerKaigi 2026の発表を参照してください • 何となく伝わる気がします 55 https://speakerdeck.com/o0h/phperkaigi-2026
56. 順番に見ていきましょう 1. 低次元な形に変換する 2. 1ステップずつ実行する(際に) 3. 処理を差し込んで 4. 元のソースコードのどこの行かを記録 56
57. PHPスクリプトが実行されるまで 57 PHPのコード (いつもの) 本当のCPU 仮想マシン ZendVM OpCode 機械語 Zend Compiler さっきの図
58. PHPスクリプトが実行されるまで 58 PHPのコード (いつもの) 本当のCPU 仮想マシン ZendVM OpCode 機械語 Zend Compiler さっきの図 ココで起きていること
59. ZendVMのメインループ • 起点となるフレームを受け取る • その中にオペコードのリストがある • リストの順に実行していく 59 仮想マシン ZendVM OpCode
60. ZendVMのメインループ 60 $_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
61. ZendVMのメインループ 61 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
62. ZendVMのメインループ 62 L10 00 INIT_FCALL 2 144 string("div") ɾ ɾ ɾ L10 03 V2 = DO_FCALL 仮想マシン ZendVM div: L02 00 CV0($a) = RECV 1 L02 01 CV1($b) = RECV 2 L04 02 T2 = IS_EQUAL CV1($b) int(0) ɾ ɾ ɾ 別のフレームの実行
63. zend_execute_ex 「いち関数実行(メイン関数を含む)」ごとに、 `zend_execute_ex` が実行される 63 $_main: 仮想マシン ZendVM div: zend_execute_ex zend_execute_ex ※ このあたり、拡張の利用有無で挙動が変わることがある
64. zend_execute_ex (っぽいもの) zend_execute_exは、1つのフレームに相当する単位で 実行するデータを受け取り、1ステップずつ処理していく 64 function zend_execute_ex($࣮ߦ͢Δσʔλ) { $op_array = $࣮ߦ͢Δσʔλ->ίϨΫγϣϯ; foreach ($op_array as $opline) { εςοϓ͝ͱͷॲཧ($opline); } } PHPer向けの ざっくりイメージ ※ このあたり、拡張の利用有無で挙動が変わることがある
65. ↑ここまでが「通常のPHP」の処理の話 ↓やっと「PHP拡張」の話が出てきます！！！ 65
66. 順番に見ていきましょう 1. 低次元な形に変換する 2. 1ステップずつ実行する(際に) 3. 処理を差し込んで 4. 元のソースコードのどこの行かを記録 66
67. PHP拡張とフック • zend_execute_exの処理を任意のものに差し替えられる • 拡張側で関数ポインタをオーバーライドする 67 標準的な機能をラップする形で、 「プラスα」なものに差し替えるなど
68. PHP拡張とフック • zend_execute_exの処理を任意のものに差し替えられる • 拡張側で関数ポインタをオーバーライドする • PHP実行ライフサイクル中にフックがある • これらのフックに引っ掛けて、ゴニョゴニョする 68 フック = PHPUnitでおなじみの setUpとかtearDownみたいなやつね！！
69. PHP拡張とフック • zend_execute_exの処理を任意のものに差し替えられる • 拡張側で関数ポインタをオーバーライドする • PHP実行ライフサイクル中にフックがある • これらのフックに引っ掛けて、ゴニョゴニョする • 提供されているのは、 モジュールの初期化時・リクエスト処理の初期化時…など 69
70. 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
71. pcovのオーバーライド PHP_MINIT_FUNCTION(pcov) { /** লུ */ /** লུ */ }  PHP_MINIT_FUNCTION(pcov) 「モジュールの初期化」時に 処理をぶら下げるフック のおまじない(マクロ) pcov.c
72. pcovのオーバーライド PHP_MINIT_FUNCTION(pcov) { /** লུ */ /** লུ */ }  if (php_pcov_api_enabled()) { モジュールを読み込んでいても、iniファ イル等でdisableされているからね pcov拡張が有効かをチェック pcov.c
73. pcovのオーバーライド PHP_MINIT_FUNCTION(pcov) { /** লུ */ /** লུ */ }  zend_execute_ex_function = zend_execute_ex; 終了時のフックで 復帰に使う 元の処理を退避させて pcov.c
74. pcovのオーバーライド PHP_MINIT_FUNCTION(pcov) { /** লུ */ /** লུ */ }  zend_execute_ex = php_pcov_execute_ex; pcovの独自処理に 差し替える pcov.c
75. 余談 PHP_MINIT_FUNCTION(pcov) { /** লུ */ /** লུ */ }  ZVAL_LONG(&php_pcov_uncovered, PHP_PCOV_UNCOVERED); 「実行されていない行」 を示す定数、「-1」 ZVAL_LONG(&php_pcov_covered, PHP_PCOV_COVERED); 「実行されている行」 を示す定数、「1」 pcov.c
76. 順番に見ていきましょう 1. 低次元な形に変換する 2. 1ステップずつ実行する(際に) 3. 処理を差し込んで 4. 元のソースコードのどこの行かを記録 76
77. zend_execute_ex / _zend_execute_data zend_execute_exは_zend_execute_dataを受け取る 77 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
78. zend_execute_ex / _zend_execute_data zend_execute_dataはzend_functionをもち、op_arrayを含む 1つのop_arrayが1つのフレームに相当(≒関数の中身のopcode) 78 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
79. • 先ほど見たように、pcovを使うと zend_execute_exとしてphp_pcov_execute_exが呼び出される • この中身を追っていくことで、 どうやって実行された行を記録しているのか分かる(遂に！) php_pcov_execute_ex 79 zend_execute_ex = php_pcov_execute_ex;
80. 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
81. php_pcov_execute_ex (っぽいもの) function pcovExecuteEx($࣮ߦ͢Δσʔλ) { while (true) { $returnCode = pcovTrace($࣮ߦ͢Δσʔλ); if ($returnCode === CODE_શ෦ऴྃ) { return; } elseif ($returnCode !== CODE_ͦͷ··࣍΁) { $࣮ߦ͢Δσʔλ = ݱࡏͷϑϨʔϜऔಘ(); } } } 
82. php_pcov_execute_ex (っぽいもの) function pcovExecuteEx($࣮ߦ͢Δσʔλ) { while (true) { $returnCode = pcovTrace($࣮ߦ͢Δσʔλ); if ($returnCode === CODE_શ෦ऴྃ) { return; } elseif ($returnCode !== CODE_ͦͷ··࣍΁) { $࣮ߦ͢Δσʔλ = ݱࡏͷϑϨʔϜऔಘ(); } } }  while (true) { 全部終わるまで反復
83. php_pcov_execute_ex (っぽいもの) function pcovExecuteEx($࣮ߦ͢Δσʔλ) { while (true) { $returnCode = pcovTrace($࣮ߦ͢Δσʔλ); if ($returnCode === CODE_શ෦ऴྃ) { return; } elseif ($returnCode !== CODE_ͦͷ··࣍΁) { $࣮ߦ͢Δσʔλ = ݱࡏͷϑϨʔϜऔಘ(); } } }  pcovTrace($࣮ߦ͢Δσʔλ); opcodeを1ステップずつ実行 対応するPHPスクリプトの行を記録 実行結果状態を返す
84. php_pcov_execute_ex (っぽいもの) function pcovExecuteEx($࣮ߦ͢Δσʔλ) { while (true) { $returnCode = pcovTrace($࣮ߦ͢Δσʔλ); if ($returnCode === CODE_શ෦ऴྃ) { return; } elseif ($returnCode !== CODE_ͦͷ··࣍΁) { $࣮ߦ͢Δσʔλ = ݱࡏͷϑϨʔϜऔಘ(); } } }  if ($returnCode === CODE_શ෦ऴྃ) { return; } elseif ($returnCode !== CODE_ͦͷ··࣍΁) { $࣮ߦ͢Δσʔλ = ݱࡏͷϑϨʔϜऔಘ(); } 状態に応じて 離脱したり次に行ったり
85. 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
86. php_pcov_trace (っぽいもの) function pcovTrace($࣮ߦ͢Δσʔλ) { if (pcovଌఆελʔτࡁΈ()) { if (/** ଌఆσʔλΛ࡞ͬͯ௥Ճ͢Δ͔ */) { $ଌఆσʔλ = pcovCreate($࣮ߦ͢Δσʔλ); ଌఆσʔλ௥Ճ($ଌఆσʔλ); } } return zendVMͷඪ४Φϖίʔυॲཧ($࣮ߦ͢Δσʔλ); } 
87. php_pcov_trace (っぽいもの) function pcovTrace($࣮ߦ͢Δσʔλ) { if (pcovଌఆελʔτࡁΈ()) { if (/** ଌఆσʔλΛ࡞ͬͯ௥Ճ͢Δ͔ */) { $ଌఆσʔλ = pcovCreate($࣮ߦ͢Δσʔλ); ଌఆσʔλ௥Ճ($ଌఆσʔλ); } } return zendVMͷඪ४Φϖίʔυॲཧ($࣮ߦ͢Δσʔλ); }  if (pcovଌఆελʔτࡁΈ()) { pcov\start()するとフラグが立つ / pcov\stop()するとフラグが折れる 「スタート済み」フラグが 立っていれば処理に入る
88. php_pcov_trace (っぽいもの) function pcovTrace($࣮ߦ͢Δσʔλ) { if (pcovଌఆελʔτࡁΈ()) { if (/** ଌఆσʔλΛ࡞ͬͯ௥Ճ͢Δ͔ */) { $ଌఆσʔλ = pcovCreate($࣮ߦ͢Δσʔλ); ଌఆσʔλ௥Ճ($ଌఆσʔλ); } } return zendVMͷඪ४Φϖίʔυॲཧ($࣮ߦ͢Δσʔλ); }  if (/** ଌఆσʔλΛ࡞ͬͯ௥Ճ͢Δ͔ */) {
89. php_pcov_trace (っぽいもの) - 測定データの追加 if (ଌఆର৅ϑΝΠϧ͔($࣮ߦ͢Δσʔλ->func->ϑΝΠϧ໊) && !ແࢹ͢ΔΦϖίʔυ͔($࣮ߦ͢Δσʔλ->ݱࡏͷopline) && !طʹଌఆࡁΈ͔( $࣮ߦ͢Δσʔλ->func->ϑΝΠϧ໊, $࣮ߦ͢Δσʔλ->ߦ൪߸ )) {  if (/** ଌఆσʔλΛ࡞ͬͯ௥Ճ͢Δ͔ */) {
90. php_pcov_trace (っぽいもの) function pcovTrace($࣮ߦ͢Δσʔλ) { if (pcovଌఆελʔτࡁΈ()) { if (/** ଌఆσʔλΛ࡞ͬͯ௥Ճ͢Δ͔ */) { $ଌఆσʔλ = pcovCreate($࣮ߦ͢Δσʔλ); ଌఆσʔλ௥Ճ($ଌఆσʔλ); } } return zendVMͷඪ४Φϖίʔυॲཧ($࣮ߦ͢Δσʔλ); }  pcovCreate($࣮ߦ͢Δσʔλ); 「実行済み」行のデータ作成
91. 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
92. 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; } 
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; }  ファイル名、行番号を持つ 構造体 create->file create->line
94. php_pcov_trace (っぽいもの) function pcovTrace($࣮ߦ͢Δσʔλ) { if (pcovଌఆελʔτࡁΈ()) { if (/** ଌఆσʔλΛ࡞ͬͯ௥Ճ͢Δ͔ */) { $ଌఆσʔλ = pcovCreate($࣮ߦ͢Δσʔλ); ଌఆσʔλ௥Ճ($ଌఆσʔλ); } } return zendVMͷඪ४Φϖίʔυॲཧ($࣮ߦ͢Δσʔλ); }  ଌఆσʔλ௥Ճ($ଌఆσʔλ); file, line情報を持つ 構造体を蓄積する
95. ① pcovの基本的な使い方や機能を見てみる ② 実行されたファイル・行を記録する仕組み ③ 実行済み・未実行のファイル・行を分別する仕組み ④ まとめ
96. まずはネタバレ 実行済み・未実行のファイル・行を分別する仕組み 1. 「測定対象ファイル」のリストを作っておいて 2. pcov\collect()実行時に、 「測定対象ファイル」の内、測定対象行を分析 3. 事前に記録しておいた実行済みのファイル・行のデータと 統合して、未実行・実行済みの行を整理 96
97. まずはネタバレ 実行済み・未実行のファイル・行を分別する仕組み 1. 「測定対象ファイル」のリストを作っておいて 2. pcov\collect()実行時に、 「測定対象ファイル」の内、測定対象行を分析 3. 事前に記録しておいた実行済みのファイル・行のデータと 統合して、未実行・実行済みの行を整理 97
98. 順番に見ていきましょう 1. 「測定対象ファイル」のリストを作る 2. pcov\collect()実行時: 測定対象行を分析 3. pcov\collect()実行時: 未実行・実行済みの行を整理 98
99. 順番に見ていきましょう 1. 「測定対象ファイル」のリストを作る 2. pcov\collect()実行時: 測定対象行を分析 3. pcov\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. pcov\collect()実行時: 測定対象行を分析 3. pcov\collect()実行時: 未実行・実行済みの行を整理 109
110. 測定対象行 #とは • 文や式が存在する、PHPが何かを実行する行 (雰囲気説明) • 「関数やクラスを宣言する行」は 含まれない • 空白行とか、`{}` があるだけの行も 含まれない • カバレッジの「分母」になる 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. 測定対象行の洗い出し: ここからやること 1. 分析対象ファイルを拾ってきて 2. op_arrayから制御フローグラフを構築して 3. 到達可能なブロックを拾ってきて 4. ブロックごとに、opcode種類(※命令)をみて拾う・捨てる 5. 残った全ての行を「未実行」としてマークする 112
113. そろそろコードばっか見せられて 疲れてきちゃったな、って思っていますか？ 図で説明して良いですかね 113
114. 測定対象行の分析の流れ 114 op_array 制御フローグラフ 結果データの初期化 コンパイル ZEND_APIの機能 測定対象行の抽出 カバレッジデータとの統合 PHPスクリプト
115. 測定対象行の〜 115 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
116. 測定対象行の〜 制御フローグラフ 結果データの初期化 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)
117. 実行に関わりが無い行が消える op_arrayの時点で、 「実行可能なコードがない」行は消えている 117 [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は処理を持たない
118. 測定対象行の〜 118 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
119. 制御フローグラフ？ • プログラムが通りうる経路を整理したやつ • 「ブロック」と、それらをつなぐ「ノード」で成り立つ • pcovでは、ブロックごとの「到達可能・不可能」を気にする 119
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 0 [REACHABLE] start=0 len=8 000 L6 ZEND_INIT_FCALL op1=JMP->002 001 L6 ZEND_DO_ICALL 002 L7 ZEND_INIT_FCALL op1=JMP->[00 // ... 006 L7 ZEND_ASSIGN op1=CV($x) o 007 L8 ZEND_JMPZ op1=CONST(fa
121. 到達不能な行(ブロック)が区別される • op_arrayを分岐地点でブロックに区切る • 条件分岐やreturnがあるところが境目 121 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)
122. 到達不能な行(ブロック)が区別される • op_arrayを分岐地点でブロックに区切る • 条件分岐やreturnがあるところが境目 122 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
123. 到達不能な行(ブロック)が区別される • pcovでは、「絶対に到達することのない」行は カバレッジの分母から消される • PHPスクリプトの10行目とはここでさようなら〜 123 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
124. 測定対象行の〜 124 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 = 未実行」で 埋めておく
125. 順番に見ていきましょう 1. 「測定対象ファイル」のリストを作る 2. pcov\collect()実行時: 測定対象行を分析 3. pcov\collect()実行時: 未実行・実行済みの行を整理 125
126. 測定対象行の〜 126 /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 最終的な測定結果 結果データの初期化 測定対象行の抽出 カバレッジデータとの統合 PHP側に結果を返す
127. 実行済みの行を、どうやってマークするの？ ここまで来たら あとはメッチャ単純です！(やったね) 127
128. カバレッジの測定データを組み立てる • 測定対象行(実行可能行)・実行された行のデータが揃った 128
129. カバレッジの測定データを組み立てる • 測定対象行(実行可能行)・実行された行のデータが揃った • これらを突き合わせるだけ！ • 実行された行のデータ(のコレクション)を使って • まだ実行済みとしてマークされていなかったら、-1 => 1に 129
130. 測定対象行の〜 130 /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 最終的な測定結果 結果データの初期化 測定対象行の抽出 カバレッジデータとの統合 PHP側に結果を返す
131. ① pcovの基本的な使い方や機能を見てみる ② 実行されたファイル・行を記録する仕組み ③ 実行済み・未実行のファイル・行を分別する仕組み ④ まとめ
132. リマインド: 今日のお話 カバレッジ測定を通じて、 「PHP拡張は、どんな機能を提供しているのか」 「何を可能にしているのか」 を知っていきましょう 132
133. PHP拡張は、どんな機能を提供しているのか • 拡張を開発するには、PHP実行の主要なライフサイクルに そのPHP拡張の独自処理を差し込めるフックを利用する • ex: PHP_MINIT_FUNCTION / PHP_RINIT_FUNCTION 133
134. 何を可能にしているのか • 通常の処理をラップして、独自の仕事を付加している • ex: zend_execute_ex のオーバーライド • oplineの処理時に、「これがどこの行だったか」を記録 134
135. 何を可能にしているのか • 通常の処理をラップして、独自の仕事を付加している • ex: zend_execute_ex のオーバーライド • oplineの処理時に、「これがどこの行だったか」を記録 • 独自関数内部で、ZendVMのAPIも利用してデータ作成 • ex: \pcov\collect() 内部での、zend_build_cfgの利用。 制御フローグラフの構築と、到達不可能ブロックの洗い出し 135
136. PHP拡張ってこんな感じ PHPの基本機能を乗っ取ったり 処理を追加するための 仕組みがあった！ 136
137. 終わっての感想
138. お疲れ様でした！ 「コードカバレッジ」が 「何をカバーしている」のか、「どうやっている」のか、 少しでも感じられましたか？ 138
139. お疲れ様でした！ ここまで知らなくても、 困ることは無いのですが 知ってみると気持ち良い(きっと) 139
140. お疲れ様でした！ 最高に気持ちよくなりたい？ JetBrainsの「CLion」、 めっちゃ便利なので使っていきましょう 140
141. お疲れ様でした！ 最高に気持ちよくなりたい？ JetBrainsの「CLion」、 めっちゃ便利なので使っていきましょう 141 今すぐブースへ走 れ
142. pcovは、コードサイズも小さいし エクステンション開発の最初の一歩に いかがでしょうか？ 142
143. pcovは コードサイズも 小さいし 最初の一歩に いかがでしょうか？ 143
144. おしまい！ お付き合いいただき ありがとうございました!!
145. Appendix Ⅰ カバレッジデータの利用に関する資料
146. PHPUnitと連携したコードカバレッジ取得 • PHPerKaigi 2024で発表したものがあります • Xdebug中心の紹介ですが、仕組みは同じ 146 https://speakerdeck.com/o0h/phperkaigi-2024
147. OpCodeとカバレッジ • 今回の発表で(ほとんど)省略している、 「OpCodeレベルで見て分かること」についての言及 147 https://speakerdeck.com/o0h/phperkaigi-2024-omake
148. Appendix Ⅱ PHP拡張の開発と内部処理に関する資料
149. 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 • 古いかつ英語ですが、基本的なコンセプトは通じるはず 149
150. 最近のコミュニティでの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 150
151. PHP(内部)入門的なもの • php-src 入門: ぼくらの画面に hello world が届くまで sji • @PHPカンファレンス福岡2024 • https://www.youtube.com/watch?v=fpRcZiTi5As 151
152. PHPの開発 • Using CLion with php-src - DEV Community • https://dev.to/ramsey/using-clion-with-php-src-4me0 • 少し前の記事だが、基本的にこの通りにやればphp-srcからPHPのデ バッグ実行まで行けるようになる(簡単！) • エラーになったら、ログやスクショを生成AIさんに渡して乗り切る 152
153. Appendix Ⅲ PHPの実行の様子 - oplineの逐次処理まで
154. php_execute_script〜php_pcov_trace までの流れを、ステップ実行したキャプチャ 154
155. PHPの実行の様子 - oplineの逐次処理まで 155
156. PHPの実行の様子 - oplineの逐次処理まで 156
157. PHPの実行の様子 - oplineの逐次処理まで 157
158. PHPの実行の様子 - oplineの逐次処理まで 158
159. PHPの実行の様子 - oplineの逐次処理まで 159
160. PHPの実行の様子 - oplineの逐次処理まで 160
161. PHPの実行の様子 - oplineの逐次処理まで 161