Xdebug Update: July 2023 – Derick Rethans

Xdebug Update: July 2023

In this monthly update I explain what happened with Xdebug development in this past two months. These are normally published on the first Tuesday on or after the 5th of each month.

Patreon and GitHub supporters will get it earlier, around the first of each month.

You can become a patron or support me through GitHub Sponsors. I am currently 37% towards my $2,500 per month goal, which is set to allow continued maintenance of Xdebug.

If you are leading a team or company, then it is also possible to support Xdebug through a subscription.

In the last month, I spend around 15 hours on Xdebug, with 25 hours funded. This is much less than I wanted, but instead I have been busy implementing features for PHP.

Business Supporter Scheme and Funding

In the last few months, no new business supporters signed up.

Some of the supporters that I reached out to, have supplied their logos, making the front page less bland.

If you, or your company, would also like to support Xdebug, head over to the support page!

Besides business support, I also maintain a Patreon page, a profile on GitHub sponsors, as well as an OpenCollective organisation.

Concealed Code – Derick Rethans

Concealed Code

Last week, the author of the PHP Debug Adapter for Visual Studio Code asked me to look at an issue. A user noticed that configured breakpoints in the editor would be greyed out for any request besides the first one for each process when using PHP’s built-in web server.

Xdebug “resolves” breakpoints when it sees code compiled by PHP and then notifies IDEs that the configured breakpoints are valid. Sometimes it also means it moves them to a line with executable code on it, as in some cases, PHP is “confused” about where lines of code live.

I spent some time delving into this, and initially I could not reproduce this. On my side (Linux, PHP 8.1/8.2) with php -S the behaviour was always correct, with the breakpoints resolved for each request through the dev server.

When I had another good look at the phpinfo() output from the user, I noticed:

Zend Engine v4.2.8, Copyright (c) Zend Technologies with Xdebug v3.2.2, Copyright (c) 2002-2023, by Derick Rethans with Zend OPcache v8.2.8, Copyright (c), by Zend Technologies 

The above shows that Xdebug is loaded first and OPcache second, which the documentation says you shouldn’t do:

Zend Opcache

Can be loaded together with Xdebug, but it is not 100% compatible.

Load Xdebug after Opcache in php.ini for better compatibility. When running php -v or when looking at phpinfo() output, Xdebug should be listed below Opcache.

After I switched the loading order of the two Zend extensions, loaded on the command line after ignoring (through -n) the normal php.ini file from:

XDEBUG_MODE=debug XDEBUG_TRIGGER=yes \ php -n -d zend_extension=opcache -d zend_extension=xdebug \ -S localhost:9112 -t /tmp 

To:

XDEBUG_MODE=debug XDEBUG_TRIGGER=yes \ php -n -d zend_extension=xdebug -d zend_extension=opcache \ -S localhost:9112 -t /tmp 

I could reproduce this issue.

The explanation for this is that both Xdebug and OPcache override PHP’s compile file handler.

Xdebug uses this to analyse newly loaded files for lines of code that can have breakpoints to resolve them. Before doing its magic, it calls the already present handler, nominally, the built-in PHP one that converts a PHP script into byte code that the PHP engine can run.

OPcache uses the handler to see whether it sees a file being converted (parsed) for a second time. If it is in its cache, it doesn’t call PHP’s original compile handler again but instead returns the byte code from its cache.

If OPcache is loaded first and then Xdebug, the following sequence occurs:

  • OPcache replaces the compile file handler with opcache_compile_file, and remembers the previous one, php_compile_file.

  • Xdebug replaces the compile file handler with xdebug_compile_file, and remembers the previous one, now opcache_compile_file.

In this situation, when PHP runs the compile file handler, it first calls xdebug_compile_file, which then calls opcache_compile_file and all is well.

The process reverses if OPcache is loaded last:

  • Xdebug replaces the compile file handler with xdebug_compile_file, and remembers the previous one, php_compile_file.

  • OPcache replaces the compile file handler with opcache_compile_file, and remembers the previous one, now xdebug_compile_file.

When PHP runs the compile file handler, it calls opcache_compile first. OPcache checks whether it has seen the file already and, if not, calls the previous handler (xdebug_compile_file), but if it has seen the file already (the second request through a php -S server), it does not call the previous compile file handler.

Typically, that is what you want, as compiling files is expensive. However, because it does not call th

Truncated by Planet PHP, read more at the original (another 2152 bytes)

PHP 8.3.0 Beta 2 available for testing – PHP: Hypertext Preprocessor

The PHP team is pleased to announce the second beta release of PHP 8.3.0, Beta 2. This continues the PHP 8.3 release cycle, the rough outline of which is specified in the PHP Wiki. For source downloads of PHP 8.3.0 Beta 2 please visit the download page.Please carefully test this version and report any issues found in the bug reporting system.Please DO NOT use this version in production, it is an early test version. For more information on the new features and other changes, you can read the NEWS file, or the UPGRADING file for a complete list of upgrading notes. These files can also be found in the release archive. The next release will be Beta 3, planned for Aug 17 2023.The signatures for the release can be found in the manifest or on the QA site.Thank you for helping us make PHP better.

PHP 8.3.0 Beta 1 available for testing – PHP: Hypertext Preprocessor

The PHP team is pleased to announce the first beta release of PHP 8.3.0, Beta 1. This continues the PHP 8.3 release cycle, the rough outline of which is specified in the PHP Wiki. For source downloads of PHP 8.1.0 Beta 1 please visit the download page.Please carefully test this version and report any issues found in the bug reporting system.Please DO NOT use this version in production, it is an early test version. For more information on the new features and other changes, you can read the NEWS file, or the UPGRADING file for a complete list of upgrading notes. These files can also be found in the release archive. The next release will be Beta 2, planned for Aug 3 2023.The signatures for the release can be found in the manifest or on the QA site.Thank you for helping us make PHP better.

PHP 8.3.0 Alpha 3 available for testing – PHP: Hypertext Preprocessor

The PHP team is pleased to announce the third testing release of PHP 8.3.0, Alpha 3. This continues the PHP 8.3 release cycle, the rough outline of which is specified in the PHP Wiki.For source downloads of PHP 8.3.0 Alpha 3 please visit the download page.Please carefully test this version and report any issues found in the bug reporting system.Please DO NOT use this version in production, it is an early test version.For more information on the new features and other changes, you can read the NEWS file, or the UPGRADING file for a complete list of upgrading notes. These files can also be found in the release archive.The next release will be Beta 1, planned for 20 Jul 2023.The signatures for the release can be found in the manifest or on the QA site.Thank you for helping us make PHP better.

Xdebug Update: June 2023 – Derick Rethans

Xdebug Update: June 2023

In this monthly update I explain what happened with Xdebug development in this past two months. These are normally published on the first Tuesday on or after the 5th of each month.

Patreon and GitHub supporters will get it earlier, around the first of each month.

You can become a patron or support me through GitHub Sponsors. I am currently 38% towards my $2,500 per month goal, which is set to allow continued maintenance of Xdebug.

If you are leading a team or company, then it is also possible to support Xdebug through a subscription.

In the last month, I spend around 10 hours on Xdebug, with 24 hours funded. This is much less than I wanted, but instead I have been busy implementing features for PHP, and been on holiday. I expect to spend a significantly more amount of time on Xdebug in July.

Towards Xdebug 3.3

Now PHP 8.3 has its first alpha releases made, it is time to have a look at what needs to be added to Xdebug to support these new features. At the moment, it looks like there are no actual breaking changes in PHP, and Xdebug’s master branch on GIT compiles and runs fine with PHP 8.3.

I will have to investigate the following features to see if I can add things to Xdebug to make these more useful:

  • Typed Class Constants — I could perhaps show these as part of the representation of classes during debugging.

  • Readonly Amendments — PHP’s classes can now also be marked as readonly, and having this reflected in xdebug_var_dump() and the debugging protocol would likely be useful too.

In addition to PHP 8.3 specific features, I have also done some research into Xdebug-side path mappings. As part of this, I have drafted a document “Native Xdebug Path Mappings” to collect ideas and a draft specification. This would allow for applications written in PHP to define their own path, file, and line mappings, instead of relying solely on IDEs to implement this. This is a large amount of work, and hence I am intending to “Crowd Fund” this in a specific way. I have already received pledges for about half of the time.

If you have comments, suggestions, or if your company wants to help fund this feature, please reach out, or leave comments on the document.

Business Supporter Scheme and Funding

In the last few months, three new business supporters signed up:

I have also reached out to all other existing supporters to ask for a logo, to replace their text only mentions on the Xdebug home page.

If you, or your company, would also like to support Xdebug, head over to the support page!

Besides business support, I also maintain a the original (another 1233 bytes)