php-src debug マニュアル

https://github.com/onopon/php_build_environment

https://fortee.jp/phperkaigi-2024/proposal/26fcb764-0a5a-4759-9cb7-d8f14814e97a

php-src。それはPHP言語のソースコードのことです。
そのため全て読むのは大変です。
php-srcを読む際、適当なtest.phpを作り、ast\parse_codeを利用しながら気になる挙動の構造を確認したり、気になるfunctionにブレークポイントを仕込んでdebugしていくこととなるでしょう。

しかし、debug環境を整えようとすると、一筋縄ではいかないことが多々あります。少なくとも経験の浅い僕にとっては簡単ではありませんでした。
MacやWindowsなど、デバッグを試す環境の違いにより色々な知見を得ながら環境整備しなければなりません。
それだけの労力を割きながら、いざphp-srcのmake testをしてFailだらけになると気が滅入ってしまうものです。

そこで、Dockerを利用してphp-srcのためのsandbox環境を整えました（発表当日にはgithub上でpublicリポジトリとして公開します）。
本セッションでは、そんなsandbox環境とVSCodeを連携方法や、それらを用いたfunctionへのアプローチ（debug）方法をお伝えいたします。

もうphp-srcの環境構築に迷うことはありません。
素敵なphp-srcリーディングライフを送りましょう！

対象者： php-srcを読んでみたい方/読もうとしたけど環境構築で挫折した方

Transcript

1. php-src debug マニュア PHPerKaigi 2024 おのぽん @onopon_engineer
2. X（旧Twitter）への投稿は、 #phperkaigi #a とつけていただけると嬉しいです！ 2 はじめに
3. 自己紹介 株式会社ウエディングパーク Photorait 本部 おのぽん（@onopon_engineer） ・2022年6月にウエディングパークに入社 ・前職では 　　- 大規模ソーシャ ゲームのサーバエンジニア 　　- 人工知能コミュニケーション ボットのサーバ全般 　　- Androidアプ 開発 　を行い、業務でのPHP開発は未経験 ・エンジニア以外の時は大体卓球をしています🏓 ・パ 卓球選手のコーチもしており、 　今年のパ パ ンピックでの活躍を目指し日々奮闘中 ・今月末もポー ンドに行ってきます😇󰐤 3
4. Photorait 全国のフォトウエディング・前撮りの撮影スタジオ・サ ン情報と共にクチコミを掲載している 日本最大級のフォトウエディング専門クチコミ情報サイト 4
5. 5 本セッションを楽しんでいただくにあたり
6. 6 右下にやる気ゲージが出てくることがあります。 本セッションを楽しんでいただくにあたり
7. 7 ゲージがMaxに近づくほど、 僕のphp-srcを読みたい欲も上昇し 本セッションを楽しんでいただくにあたり
8. 8 ゲージが0に近づくほど、僕の心は折れかけています。 本セッションを楽しんでいただくにあたり
9. 9 どうぞ最後までお付き合い願います！！
10. 10 php-srcのデバッグ環境を整え、適切にブ ークポイントを仕込めるようになろう！ 本セッションのゴー
11. 11 ここ半年間での僕の周りの出来事
12. 12 phpで気になる挙動を発見しました。
13. 13 突然ですが、問題です。 explode(',', '1,2'); を実行すると [1,2] が返ってきます。 では、 explode(',', ''); の返り値は次の3つのうちどれでしょうか？ A: [] B: [''] C: [null]
14. 14 突然ですが、問題です。 A: [] B: [''] C: [null] explode(',', '1,2'); を実行すると [1,2] が返ってきます。 では、 explode(',', ''); の返り値は次の3つのうちどれでしょうか？
15. 15 ちゃまほりさんがwphpconの場で「php-src読もうよ！」と言っていたり
16. 16 てきめんさんの作った関数がAcceptされたり
17. 17 周りの尊敬するエンジニアさんはみんなphp-srcを読める！ 僕も読めるようになりたい！
18. 18 そもそもphp-srcって何だ？
19. 19 phpファイ が動く簡単な流れ PHPのサイトにアクセス。
20. 20 phpファイ が動く簡単な流れ PHPのサイトにアクセス。 アクセスされたPHPテキス トファイ 。 PHPerが好んで書くもの。
21. 21 phpファイ が動く簡単な流れ Hello, world! PHPのサイトにアクセス。 アクセスされたPHPテキス トファイ 。 PHPerが好んで書くもの。 PHPテキストを解読し、適 切な振る舞いを行う。 アウトプット
22. 22 このソースコードの ポジト 名こそがphp-src
23. 23 php-srcはC言語から構成されている Hello, world! https://github.com/php/php-src テストするためにはbuildする必要がある
24. 24 さっそくphp-srcを入れてbuildしてみよう！ macでもできるかな😇
25. 25 とりあえず調べながらやってみよう！
26. 26 「php-src ビ ド mac」で検索 brew install hoge × n あれ、installうまくいかないぞ・・・ エ ー解消方法検索しないと😇 ./configure コマンドが通らない・・・ path指定やオプションが必要なのか。。 make -j4 成功してくれ・・・
27. 27 build成功・・・！make test実行だ！！
33. 33 ビ ドで詰んだ
34. 34 あれ、ひょっとして僕以外にもphp-srcのビ ドに挑戦して諦めた方いるのでは？
35. 35 初心者でもphp-buildでつまづかない未来を作ろう
36. 36 Hello, php_build_environment
37. 37 https://github.com/onopon/php_build_environment onopon php_build_environment
38. 38 php_build_environment でphp-srcをデバッグする環境を整える手順 • Docker をインストー する • Visual Studio Codeをインストー する • php_build_environment をcloneする • php_build_environment 内にある initial_run.sh を実行する ◦ sh ./initial_run.sh 以上。
39. 39 initial_run.sh により行われること • php-src のclone（ブ ンチはmaster） • デバッグ用のdockerコンテナ「sandbox」の構築 • sandbox上でphp-srcのbuild • php-srcに ◦ テスト用のファイ test.phpとast_parse_test.phpを設置 ▪ 後ほど解説 ◦ .vscode ディ クト を設置
40. 40 sandbox コンテナについて • コンテナのベースは ubuntu: 23.10 • 必要なミド ウェアをインストー ◦ デバッグに必要なgdbを利用可能な状態に ◦ php-astもこのタイミングでインストー • volume: php_build_environment 配下 ◦ なので、php-srcのファイ をコンテナ外から書き換えても大丈夫
41. 41 実際にデバッグ環境を整えてみよう
42. 42 sh ./initial_run.sh を実行 • 10分以上かかるので気長に待つ
43. 43 Visual Studio Codeで開いてみよう モート エクスプ ー ーを選択
44. 44 Visual Studio Codeで開いてみよう 開発コンテナーの中にいるphp_build_environment sandboxをアタッチ
45. 45 test.php を実行してみよう デバッグ コンソー にHOGEと出力される
46. 46 ast_parse_test.php を実行してみよう ast\Nodeがdumpされる
47. 47 よし！いざデバッグするぞ！
48. 48 ・・・と思ったけどphpの内部のある程度の流れを知らないとまた詰みそう
49. 49 phpの大まかな流れ
50. 50 phpファイ が動く簡単な流れ Hello, world! PHPのサイトにアクセス。 アクセスされたPHPテキス トファイ 。 PHPerが好んで書くもの。 PHPテキストを解読し、適 切な振る舞いを行う。 アウトプット
51. 51 この時にPHPが行っていること SAPI = Zend Engineを呼び出すためのインターフェース （mod_php, php-fpm, cli etc…） Zend Engine：PHP スク プトを実行するエンジン ・スク プトを解析してAST化 ・ASTからOpcodeを生成 ・Opcodeより適切なHandlerを呼び出す アウトプット
52. 52 この時にPHPが行っていること SAPI = Zend Engineを呼び出すためのインターフェース （mod_php, php-fpm, cli etc…） Zend Engine：PHP スク プトを実行するエンジン ・スク プトを解析してAST化 ・ASTからOpcodeを生成 ・Opcodeより適切なHandlerを呼び出す アウトプット この辺りをおさえれば デバッグできそう
53. SAPI = Zend Engineを呼び出すためのインターフェース （mod_php, php-fpm, cli etc…） Zend Engine：PHP スク プトを実行するエンジン ・スク プトを解析してAST化 ・ASTからOpcodeを生成 ・Opcodeより適切なHandlerを呼び出す アウトプット この辺りをおさえれば デバッグできそう AST この時にPHPが行っていること 53
54. 54 ASTとは Abstract Syntax Tree（抽象構文木）の略。 Syntax Tree（構文木）から言語の意味に関係ある情報のみを取り出した木構造の木のこと。 https://ja.wikipedia.org/wiki/%E6%8A%BD%E8%B1%A1%E6%A7%8B%E6%96%87%E6%9C%A8
55. 55 Syntax Tree → Abstract Syntax Tree echo("HOGE"); echo ( "HOGE" ) ; Source Code Syntax Tree Abstract Syntax Tree echo "HOGE"
56. 56 ZendEngineでのAST typedef uint16_t zend_ast_kind; typedef uint16_t zend_ast_attr; struct _zend_ast { zend_ast_kind kind; /* Type of the node (ZEND_AST_* enum constant) */ zend_ast_attr attr; /* Additional attribute, use depending on node type */ uint32_t lineno; /* Line number */ zend_ast *child[1]; /* Array of children (using struct hack) */ }; Zend/zend_ast.h
57. 57 ZendEngineでのAST typedef uint16_t zend_ast_kind; typedef uint16_t zend_ast_attr; struct _zend_ast { zend_ast_kind kind; /* Type of the node (ZEND_AST_* enum constant) */ zend_ast_attr attr; /* Additional attribute, use depending on node type */ uint32_t lineno; /* Line number */ zend_ast *child[1]; /* Array of children (using struct hack) */ }; Zend/zend_ast.h kind: astの種類 attr: 付属情報 lineno: 行番号 child: 子ノード kindとchildだけ抑えれば一旦大丈夫
58. 58 echo("HOGE"); をast解析すると、 ast\Nodeがdumpされる
59. 59 echo("HOGE"); をast解析すると、 kind:132(？？？） kind:283(？？？) "HOGE" children[0] children[0]
60. 60 kind（=astの種類）はenumで宣言されている Zend/zend_ast.h の _zend_ast_kind にてenumで宣言されているが、ぱっと見わかりづらい Visual Studioの場合、カーソ を当ててみるとintで値が表示される
61. 61 echo("HOGE"); をast解析すると、 kind:132(ZEND_AST_STMT_LIST) kind:283(ZEND_AST_ECHO) "HOGE" children[0] children[0]
62. 62 Zend/zend_compile.c の zend_compile_stmt メソッド内にある switch (ast->kind) { ast→opcodeのbreak point Step in
63. SAPI = Zend Engineを呼び出すためのインターフェース （mod_php, php-fpm, cli etc…） Zend Engine：PHP スク プトを実行するエンジン ・スク プトを解析してAST化 ・ASTからOpcodeを生成 ・Opcodeより適切なHandlerを呼び出す アウトプット この辺りをおさえれば デバッグできそう Opcode この時にPHPが行っていること 63 Handler
64. 64 Opcodeとは プ セッサが実行する操作に関する命令コードのこと https://ja.wikipedia.org/wiki/%E3%82%AA%E3%83%9A%E3%82%B3%E3%83%BC%E3%83%89
65. 65 PHPのOpcodeはopcacheモジュー のデバッグの設定をすると確認できる $ sapi/cli/php\ -d opcache.opt_debug_level=0x10000\ -d opcache.enable_cli\ -d zend_extension=$(pwd)/modules/opcache.so\ test.php Visual Codeでデバッグすると下記が実行される
66. 66 PHPのOpcodeはopcacheモジュー のデバッグ実行時 $_main: ; (lines=2, args=0, vars=0, tmps=0) ; (before optimizer) ; /src/php-src/test.php:1-2 ; return [] RANGE[0..0] 0000 ECHO string("HOGE") 0001 RETURN int(1)
67. 67 PHPのOpcodeはopcacheモジュー のデバッグ実行時 $_main: ; (lines=2, args=0, vars=0, tmps=0) ; (before optimizer) ; /src/php-src/test.php:1-2 ; return [] RANGE[0..0] 0000 ECHO string("HOGE") 0001 RETURN int(1)
68. 68 0000 ECHO string("HOGE") Opcode OPType
69. 69 Opcodeの名前がHandlerとして利用される zend/zend_vm_execute.h で zend_execute メソッドが実行され、 opcodeに対応するhandlerメソッドが呼ばれる handlerは、 ZEND_{OPCODE_NAME}_SPEC_{OP_TYPE}_HANDLER ZEND_{OPCODE_NAME}_SPEC_{OP1_TYPE}_{OP2_TYPE}_HANDLER のようなメソッド名で用意されている
70. 70 echoメソッドのhandlerは3つ用意されている（挙動はほとんど変わらない） echo("HOGE"); echo("HO"."GE"); ZEND_ECHO_SPEC_CONST_HANDLER デバッグ出力 0000 ECHO string("HOGE") 0001 RETURN int(1) $var = "HOGE"; echo($var); ZEND_ECHO_SPEC_CV_HANDLER デバッグ出力 0000 ASSIGN CV0($var) string("HOGE") 0001 ECHO CV0($var) 0002 RETURN int(1) $ho = "HO"; echo($ho."GE"); ZEND_ECHO_SPEC_TMPVAR_HANDLER デバッグ出力 0000 ASSIGN CV0($ho) string("HO") 0001 T2 = CONCAT CV0($ho) string("GE") 0002 ECHO T2 0003 RETURN int(1)
71. 71 今回の例では ZEND_ECHO_SPEC_CONST_HANDLER にbreak point OP Typeがわからなくても、ZEND_ECHO_ で検索すればとりあえず見つかる
72. 72 これでデバッグできるぞ！！
73. 73 php-srcのデバッグ環境を整え、適切にブ ークポイントを仕込めるようになろう！ 本セッションのゴー
74. 74 まとめ • php_src_environment を用意し、デバッグ環境を整備 ◦ https://github.com/onopon/php_build_environment • PHPはスク プトをAST化→OPCodeを生成→Handlerの呼び出しにより実行される ◦ ast_parse_test.php によりast構造を確認できる ◦ Zend/zend_compile.c の zend_compile_stmt メソッドにブ ークポイントを貼れ ばAST化後の流れを追える ◦ Zend/zend_vm_execute.h 内で ZEND_{Opcode} と検索するとHandlerを見つ けることができる ▪ そこにブ ークポイントを貼れば振る舞いの流れを追える onopon php_build_environment
75. 75 ご清聴ありがとうございました！
76. 76 Appendix
77. 77 本資料作成にあたり参考にさせていただいた記事 php-srcを読んでみよう by 田実 誠 https://fortee.jp/phpcon-2022/proposal/1addf51d-6f72-4c96-9337-034ec6cc0643 PHPのOpcodeを 読んでみよう https://speakerdeck.com/yasuaki640/phpnoopcodewo-du-ndemiyou PHP AST 徹底解説 https://www.slideshare.net/do_aki/php-ast php-src の歩き方 https://www.slideshare.net/do_aki/phpsrc php and sapi and zendengine2 and... https://www.slideshare.net/do_aki/php-and-sapi-and-zendengine2-and PHP と SAPI と ZendEngine3 と https://www.slideshare.net/do_aki/php-sapi-zendengine3 [php-src読書録]その１: CLI実行からスク プト実行まで https://blog.freedom-man.com/php_src_1 深入理解Zend执行引擎（PHP5） https://gywbd.github.io/posts/2016/2/zend-execution-engine.html How PHP engine builds AST https://dev.to/mrsuh/how-php-engine-builds-ast-1nc4 How to dump and inspect PHP OPCodes https://php.watch/articles/php-dump-opcodes
78. 78 ZEND_ECHO_SPEC_CONST_HANDLER
79. 79 ZEND_ECHO_SPEC_CV_HANDLER
80. 80 ZEND_ECHO_SPEC_TMPVAR_HANDLER