Merge pull request #673 from crazywhalecc/feat/xdebug-dynamic

add xdebug dynamic extension

Author: crazywhalecc

.github/workflows/tests.yml

@@ -197,5 +197,5 @@ jobs:
         run: php src/globals/test-extensions.php build_cmd ${{ matrix.os }} ${{ matrix.php }}
 
       - name: "Run Build Tests (build - embed for non-windows)"
-        if: matrix.os != 'windows-latest'
+        if: ${{ !startsWith(matrix.os, 'windows-') }}
         run: php src/globals/test-extensions.php build_embed_cmd ${{ matrix.os }} ${{ matrix.php }}

bin/spc-alpine-docker

@@ -122,6 +122,20 @@ MOUNT_LIST="$MOUNT_LIST -v ""$(pwd)""/pkgroot:/app/pkgroot"
 # shellcheck disable=SC2086
 # shellcheck disable=SC2090
 if [ "$SPC_DOCKER_DEBUG" = "yes" ]; then
+    echo "* Debug mode enabled, run docker in interactive mode."
+    echo "* You can use 'exit' to exit the docker container."
+    echo "* You can use 'bin/spc' like normal builds."
+    echo "*"
+    echo "*    Mounted directories:"
+    echo "*    ./config:    $(pwd)/config"
+    echo "*    ./src:       $(pwd)/src"
+    echo "*    ./buildroot: $(pwd)/buildroot"
+    echo "*    ./source:    $(pwd)/source"
+    echo "*    ./dist:      $(pwd)/dist"
+    echo "*    ./downloads: $(pwd)/downloads"
+    echo "*    ./pkgroot:   $(pwd)/pkgroot"
+    echo "*"
+
     $DOCKER_EXECUTABLE run --rm $INTERACT -e SPC_FIX_DEPLOY_ROOT="$(pwd)" $MOUNT_LIST cwcc-spc-$SPC_USE_ARCH-v2
 else
     $DOCKER_EXECUTABLE run --rm $INTERACT -e SPC_FIX_DEPLOY_ROOT="$(pwd)" $MOUNT_LIST cwcc-spc-$SPC_USE_ARCH-v2 bin/spc $@

bin/spc-gnu-docker

@@ -12,7 +12,7 @@ DOCKER_EXECUTABLE="docker"
 # shellcheck disable=SC2046
 if [ $(id -u) -ne 0 ]; then
     if ! docker info > /dev/null 2>&1; then
-        if [ "$SPC_USE_SUDO" != "yes" ]; then
+        if [ "$SPC_USE_SUDO" != "yes" ] && [ "$SPC_DOCKER_DEBUG" != "yes" ]; then
             echo "Docker command requires sudo"
             # shellcheck disable=SC2039
             echo -n 'To use sudo to run docker, run "export SPC_USE_SUDO=yes" and run command again'
@@ -86,7 +86,7 @@ COPY ./composer.* /app/
 ADD ./bin/setup-runtime /app/bin/setup-runtime
 ADD ./bin/spc /app/bin/spc
 RUN /app/bin/setup-runtime
-RUN /app/bin/php /app/bin/composer install --no-dev --classmap-authoritative
+RUN /app/bin/php /app/bin/composer install --no-dev
 ENV PATH="/app/bin:/cmake/bin:$PATH"
 ENV SPC_LIBC=glibc
 
@@ -146,6 +146,20 @@ echo 'SPC_CMD_VAR_PHP_MAKE_EXTRA_LIBS="-ldl -lpthread -lm -lresolv -lutil -lrt"'
 # shellcheck disable=SC2090
 
 if [ "$SPC_DOCKER_DEBUG" = "yes" ]; then
+    echo "* Debug mode enabled, run docker in interactive mode."
+    echo "* You can use 'exit' to exit the docker container."
+    echo "* You can use 'bin/spc' like normal builds."
+    echo "*"
+    echo "*    Mounted directories:"
+    echo "*    ./config:    $(pwd)/config"
+    echo "*    ./src:       $(pwd)/src"
+    echo "*    ./buildroot: $(pwd)/buildroot"
+    echo "*    ./source:    $(pwd)/source"
+    echo "*    ./dist:      $(pwd)/dist"
+    echo "*    ./downloads: $(pwd)/downloads"
+    echo "*    ./pkgroot:   $(pwd)/pkgroot"
+    echo "*"
+
     $DOCKER_EXECUTABLE run --rm -it --privileged $INTERACT -e SPC_FIX_DEPLOY_ROOT="$(pwd)" --env-file /tmp/spc-gnu-docker.env $MOUNT_LIST cwcc-spc-gnu-$SPC_USE_ARCH
 else
     $DOCKER_EXECUTABLE run --rm $INTERACT -e SPC_FIX_DEPLOY_ROOT="$(pwd)" --env-file /tmp/spc-gnu-docker.env $MOUNT_LIST cwcc-spc-gnu-$SPC_USE_ARCH bin/spc $@

config/env.ini

@@ -28,7 +28,6 @@
 ;   PATH:                               static-php-cli will add `$BUILD_BIN_PATH` to PATH.
 ;   PKG_CONFIG:                         static-php-cli will set `$BUILD_BIN_PATH/pkg-config` to PKG_CONFIG.
 ;   PKG_CONFIG_PATH:                    static-php-cli will set `$BUILD_LIB_PATH/pkgconfig` to PKG_CONFIG_PATH.
-;   SPC_PHP_DEFAULT_OPTIMIZE_CFLAGS:    the default optimization CFLAGS for compiling php. (if --no-strip option is set: `-g -O0`, else: `-g -Os`)
 ;
 ;   * These vars are only be defined in LinuxBuilder and cannot be changed anywhere:
 ;   SPC_LINUX_DEFAULT_CC:                   the default compiler for linux. (For alpine linux: `gcc`, default: `$GNU_ARCH-linux-musl-gcc`)
@@ -98,9 +97,9 @@ SPC_CMD_VAR_PHP_CONFIGURE_LDFLAGS="-L${BUILD_LIB_PATH}"
 ; LIBS for configuring php
 SPC_CMD_VAR_PHP_CONFIGURE_LIBS="-ldl -lpthread -lm"
 ; EXTRA_CFLAGS for `make` php
-SPC_CMD_VAR_PHP_MAKE_EXTRA_CFLAGS="${SPC_PHP_DEFAULT_OPTIMIZE_CFLAGS} -fno-ident -fPIE -fPIC"
+SPC_CMD_VAR_PHP_MAKE_EXTRA_CFLAGS="-g -fstack-protector-strong -fpic -fpie -Os -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -fno-ident -fPIE -fPIC"
 ; EXTRA_LIBS for `make` php
-SPC_CMD_VAR_PHP_MAKE_EXTRA_LIBS=""
+SPC_CMD_VAR_PHP_MAKE_EXTRA_LIBS="-ldl -lpthread -lm"
 ; EXTRA_LDFLAGS_PROGRAM for `make` php
 SPC_CMD_VAR_PHP_MAKE_EXTRA_LDFLAGS_PROGRAM="-all-static -Wl,-O1 -pie"
 
@@ -132,7 +131,7 @@ SPC_CMD_VAR_PHP_CONFIGURE_CPPFLAGS="-I${BUILD_INCLUDE_PATH}"
 ; LDFLAGS for configuring php
 SPC_CMD_VAR_PHP_CONFIGURE_LDFLAGS="-L${BUILD_LIB_PATH}"
 ; EXTRA_CFLAGS for `make` php
-SPC_CMD_VAR_PHP_MAKE_EXTRA_CFLAGS="${SPC_PHP_DEFAULT_OPTIMIZE_CFLAGS}"
+SPC_CMD_VAR_PHP_MAKE_EXTRA_CFLAGS="-g -fstack-protector-strong -fpic -fpie -Os -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64"
 ; EXTRA_LIBS for `make` php
 SPC_CMD_VAR_PHP_MAKE_EXTRA_LIBS="-lresolv"
 ; embed type for php, static (libphp.a) or shared (libphp.dylib)

config/ext.json

@@ -119,6 +119,10 @@
             "Linux": "partial",
             "BSD": "wip"
         },
+        "target": [
+            "static",
+            "shared"
+        ],
         "notes": true,
         "arg-type": "custom",
         "type": "builtin",
@@ -772,6 +776,9 @@
             "Windows": "no",
             "BSD": "wip"
         },
+        "target": [
+            "static"
+        ],
         "notes": true,
         "type": "external",
         "source": "swoole",
@@ -919,12 +926,16 @@
         ]
     },
     "xdebug": {
-        "type": "builtin",
+        "type": "external",
+        "source": "xdebug",
+        "target": [
+            "shared"
+        ],
         "support": {
             "Windows": "wip",
             "BSD": "no",
-            "Darwin": "no",
-            "Linux": "no"
+            "Darwin": "partial",
+            "Linux": "partial"
         },
         "notes": true
     },
@@ -1040,6 +1051,9 @@
         "support": {
             "BSD": "wip"
         },
+        "target": [
+            "static"
+        ],
         "type": "builtin",
         "arg-type": "with-prefix",
         "arg-type-windows": "enable",

config/lib.json

@@ -281,8 +281,7 @@
         "headers-unix": [
             "ares.h",
             "ares_dns.h",
-            "ares_nameser.h",
-            "ares_rules.h"
+            "ares_nameser.h"
         ]
     },
     "libde265": {

config/source.json

@@ -913,6 +913,15 @@
             "path": "COPYING"
         }
     },
+    "xdebug": {
+        "type": "url",
+        "url": "https://pecl.php.net/get/xdebug",
+        "filename": "xdebug.tgz",
+        "license": {
+            "type": "file",
+            "path": "LICENSE"
+        }
+    },
     "xhprof": {
         "type": "url",
         "url": "https://pecl.php.net/get/xhprof",

docs/en/guide/extension-notes.md

@@ -80,10 +80,9 @@ and this extension cannot be compiled into php by static linking, so it cannot b
 
 ## xdebug
 
-1. Xdebug is only buildable as a shared extension. On Linux, you need to use static-php-cli with SPC_LIBC=glibc and then compile php-xdebug from source with the option `--with-php-config=/path/to/buildroot/bin/php-config`.
-2. The macOS platform can compile an xdebug extension under PHP compiled on the same platform, 
-extract the `xdebug.so` file, and then use the `--no-strip` parameter in static-php-cli to retain the debug symbol table and add the `ffi` extension. 
-The compiled `./php` binary can be configured and run by specifying the INI, eg `./php -d 'zend_extension=/path/to/xdebug.so' your-code.php`.
+1. Xdebug is only buildable as a shared extension. On Linux, you need to use static-php-cli with SPC_LIBC=glibc.
+2. When using Linux/glibc or macOS, you can compile Xdebug as a shared extension using --build-shared="xdebug". 
+   The compiled `./php` binary can be configured and run by specifying the INI, eg `./php -d 'zend_extension=/path/to/xdebug.so' your-code.php`.
 
 ## xml
 
@@ -126,8 +125,8 @@ For details on the solution, see [FAQ - Unable to use ssl](../faq/#unable-to-use
 
 ## ffi
 
-1. Due to the limitation of Linux system, you cannot use it to load other `so` extensions in the purely static compiled state (spc defaults to pure static compilation). 
-   Linux supports loading so extensions only if they are non-statically compiled. If you need to use the ffi extension, see [Compile PHP with GNU libc](./build-with-glibc).
+1. Due to the limitation of musl libc's static linkage, you cannot use ffi because dynamic libraries cannot be loaded. 
+   If you need to use the ffi extension, see [Compile PHP with GNU libc](./build-with-glibc).
 2. macOS supports the ffi extension, but errors will occur when some kernels do not contain debugging symbols.
 3. Windows x64 supports the ffi extension.
 

docs/en/guide/manual-build.md

@@ -314,6 +314,7 @@ You can try to use the following commands:
 - `--with-suggested-exts`: Add `ext-suggests` as dependencies when compiling
 - `--with-suggested-libs`: Add `lib-suggests` as dependencies when compiling
 - `--with-upx-pack`: Use UPX to reduce the size of the binary file after compilation (you need to use `bin/spc install-pkg upx` to install upx first)
+- `--build-shared=XXX,YYY`: compile the specified extension into a shared library (the default is to compile into a static library)
 
 For hardcoding INI options, it works for cli, micro, embed sapi. Here is a simple example where we preset a larger `memory_limit` and disable the `system` function:
 

docs/zh/guide/extension-notes.md

@@ -74,9 +74,9 @@ bin/spc build gd --with-libs=freetype,libjpeg,libavif,libwebp --build-cli
 
 ## xdebug
 
-1. Xdebug 只能作为共享扩展构建。在 Linux 上，您需要使用带有 `SPC_LIBC=glibc` 的 static-php-cli，然后使用选项 `--with-php-config=/path/to/buildroot/bin/php-config` 从源代码编译 php-xdebug。
-2. macOS 平台可以通过在相同平台编译的 PHP 下编译一个 xdebug 扩展，并提取其中的 `xdebug.so` 文件，再在 static-php-cli 中使用 `--no-strip` 参数保留调试符号表，同时加入 `ffi` 扩展。
-   编译的 `./php` 二进制可以通过指定 INI 配置并运行，例如`./php -d 'zend_extension=xdebug.so' your-code.php`。
+1. Xdebug 只能作为共享扩展进行构建。在 Linux 上，您需要使用 static-php-cli 并设置 SPC_LIBC=glibc。
+2. 使用 Linux/glibc 或 macOS 时，您可以使用 `--build-shared=xdebug` 将 Xdebug 编译为共享扩展。
+   编译后的 `./php` 二进制文件可以通过指定 INI 文件进行配置和运行，例如 `./php -d 'zend_extension=/path/to/xdebug.so' your-code.php`。
 
 ## xml
 
@@ -117,9 +117,10 @@ pgsql 16.2 修复了这个 Bug，现在正常工作了。
 
 ## ffi
 
-1. 因为 Linux 系统的限制，纯静态编译的状态下（spc 默认编译结果为纯静态）无法使用它加载其他 `so` 扩展。Linux 支持加载 so 扩展的前提是非静态编译。如果你需要使用 ffi 扩展，请参见 [编译 GNU libc 的 PHP](./build-with-glibc)。
-2. macOS 支持 ffi 扩展，但是部分内核下不包含调试符号时会出现错误。
-3. Windows 支持 ffi 扩展。
+1. 由于 musl libc 静态链接的限制，无法加载动态库，因此无法使用 ffi。
+   如果您需要使用 ffi 扩展，请参阅 [使用 GNU libc 编译 PHP](./build-with-glibc)。
+2. macOS 支持 ffi 扩展，但某些内核不包含调试符号时会出现错误。
+3. Windows x64 支持 ffi 扩展。
 
 ## xhprof