Merge pull request #810 from crazywhalecc/refactor/spc-target

refactor: replace SPC_LIBC with SPC_TARGET and update related logic

Author: crazywhalecc

bin/spc-gnu-docker

@@ -64,7 +64,7 @@ fi
 # Detect docker env is setup
 if ! $DOCKER_EXECUTABLE images | grep -q cwcc-spc-gnu-$SPC_USE_ARCH-$SPC_DOCKER_VERSION; then
     echo "Docker container does not exist. Building docker image ..."
-    $DOCKER_EXECUTABLE buildx build $PLATFORM_ARG --no-cache -t cwcc-spc-gnu-$SPC_USE_ARCH-$SPC_DOCKER_VERSION -f- . <<EOF
+    $DOCKER_EXECUTABLE buildx build $PLATFORM_ARG -t cwcc-spc-gnu-$SPC_USE_ARCH-$SPC_DOCKER_VERSION -f- . <<EOF
 FROM centos:7
 RUN sed -i 's/mirror.centos.org/vault.centos.org/g' /etc/yum.repos.d/*.repo && \
     sed -i 's/^#.*baseurl=http/baseurl=http/g' /etc/yum.repos.d/*.repo && \
@@ -96,7 +96,7 @@ RUN curl -fsSL -o patchelf.tgz https://github.com/NixOS/patchelf/releases/downlo
     tar -xzf patchelf.tgz -C /patchelf --strip-components=1 && \
     cp /patchelf/bin/patchelf /usr/bin/
 
-RUN curl -o cmake.tgz -fsSL https://github.com/Kitware/CMake/releases/download/v3.31.4/cmake-3.31.4-linux-$SPC_USE_ARCH.tar.gz && \
+RUN curl -o cmake.tgz -#fSL https://github.com/Kitware/CMake/releases/download/v3.31.4/cmake-3.31.4-linux-$SPC_USE_ARCH.tar.gz && \
     mkdir /cmake && \
     tar -xzf cmake.tgz -C /cmake --strip-components 1
 
@@ -107,8 +107,8 @@ 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
-ENV PATH="/app/bin:/cmake/bin:$PATH"
 ENV SPC_LIBC=glibc
+ENV PATH="/app/bin:/cmake/bin:/opt/rh/devtoolset-10/root/usr/bin:\$PATH"
 
 ADD ./config/env.ini /app/config/env.ini
 RUN CC=gcc bin/spc doctor --auto-fix --debug
@@ -128,7 +128,6 @@ RUN curl -o automake.tgz -fsSL https://ftp.gnu.org/gnu/automake/automake-1.17.ta
     make && \
     make install && \
     ln -sf /usr/local/bin/automake /usr/bin/automake
-
 EOF
 fi
 
@@ -154,11 +153,7 @@ if [ -f "$(pwd)/craft.yml" ]; then
 fi
 
 # Apply env in temp env file
-echo 'CC=/opt/rh/devtoolset-10/root/usr/bin/gcc' > /tmp/spc-gnu-docker.env
-echo 'CXX=/opt/rh/devtoolset-10/root/usr/bin/g++' >> /tmp/spc-gnu-docker.env
-echo 'AR=/opt/rh/devtoolset-10/root/usr/bin/ar' >> /tmp/spc-gnu-docker.env
-echo 'LD=/opt/rh/devtoolset-10/root/usr/bin/ld' >> /tmp/spc-gnu-docker.env
-echo 'SPC_DEFAULT_C_FLAGS=-fPIC' >> /tmp/spc-gnu-docker.env
+echo 'SPC_DEFAULT_C_FLAGS=-fPIC' > /tmp/spc-gnu-docker.env
 echo 'SPC_LIBC=glibc' >> /tmp/spc-gnu-docker.env
 echo 'SPC_CMD_VAR_PHP_MAKE_EXTRA_LDFLAGS_PROGRAM="-Wl,-O1 -pie"' >> /tmp/spc-gnu-docker.env
 echo 'SPC_CMD_VAR_PHP_MAKE_EXTRA_LIBS="-ldl -lpthread -lm -lresolv -lutil -lrt"' >> /tmp/spc-gnu-docker.env

config/env.ini

@@ -55,6 +55,8 @@ SPC_CMD_VAR_FRANKENPHP_XCADDY_MODULES="--with github.com/dunglas/frankenphp/cadd
 ; EXTENSION_DIR=
 
 [windows]
+; build target: win7-static
+SPC_TARGET=native-windows
 ; php-sdk-binary-tools path
 PHP_SDK_PATH="${WORKING_DIR}\php-sdk-binary-tools"
 ; upx executable path
@@ -63,6 +65,17 @@ UPX_EXEC="${PKG_ROOT_PATH}\bin\upx.exe"
 SPC_MICRO_PATCHES=static_extensions_win32,cli_checks,disable_huge_page,vcruntime140,win32,zend_stream,cli_static
 
 [linux]
+; Linux can use different build toolchain, but the toolchain can not be changed in this file:
+; - musl (default): used for general linux distros, can build `musl-static` target only.
+; - zig (WIP): used for general linux distros, can build `musl` and `glibc` targets.
+; - musl-native: used for alpine linux, can build `musl-static` and `musl`(WIP) target.
+; - gnu-native (assume): used for general linux distros, can build `glibc` target only and have portability issues.
+
+; build target:
+; - musl-static (default): pure static linking, using musl-libc, can run on any linux distro.
+; - musl: static linking with dynamic linking to musl-libc, can run on musl-based linux distro.
+; - glibc: static linking with dynamic linking to glibc, can run on glibc-based linux distro.
+
 ; include PATH for musl libc.
 SPC_LIBC=musl
 ; compiler environments
@@ -109,6 +122,9 @@ SPC_CMD_VAR_PHP_MAKE_EXTRA_LDFLAGS=""
 SPC_CMD_VAR_PHP_MAKE_EXTRA_LDFLAGS_PROGRAM="-all-static -Wl,-O1 -pie"
 
 [macos]
+; build target: macho or macho (possibly we could support macho-universal in the future)
+; Currently we do not support universal and cross-compilation for macOS.
+SPC_TARGET=native-macos
 ; compiler environments
 CC=clang
 CXX=clang++

docs/en/guide/extension-notes.md

@@ -82,7 +82,7 @@ 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.
+1. Xdebug is only buildable as a shared extension. You need to use a build target other than `musl-static` for SPC_TARGET.
 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`.
 

docs/zh/guide/extension-notes.md

@@ -76,7 +76,7 @@ bin/spc build gd --with-libs=freetype,libjpeg,libavif,libwebp --build-cli
 
 ## xdebug
 
-1. Xdebug 只能作为共享扩展进行构建。在 Linux 上，您需要使用 static-php-cli 并设置 SPC_LIBC=glibc。
+1. Xdebug 只能作为共享扩展进行构建。您需要使用除了 `musl-static` 外的其他 `SPC_TARGET` 构建目标。
 2. 使用 Linux/glibc 或 macOS 时，您可以使用 `--build-shared=xdebug` 将 Xdebug 编译为共享扩展。
    编译后的 `./php` 二进制文件可以通过指定 INI 文件进行配置和运行，例如 `./php -d 'zend_extension=/path/to/xdebug.so' your-code.php`。
 

phpunit.xml.dist

@@ -4,5 +4,6 @@
 >
     <php>
         <env name="SPC_IGNORE_BAD_HASH" value="yes" force="true" />
+        <env name="SPC_SKIP_TOOLCHAIN_CHECK" value="yes" force="true" />
     </php>
 </phpunit>

src/SPC/ConsoleApplication.php

@@ -9,6 +9,7 @@
 use SPC\command\CraftCommand;
 use SPC\command\DeleteDownloadCommand;
 use SPC\command\dev\AllExtCommand;
+use SPC\command\dev\EnvCommand;
 use SPC\command\dev\ExtVerCommand;
 use SPC\command\dev\GenerateExtDepDocsCommand;
 use SPC\command\dev\GenerateExtDocCommand;
@@ -70,6 +71,7 @@ public function __construct()
                 new GenerateExtDepDocsCommand(),
                 new GenerateLibDepDocsCommand(),
                 new PackLibCommand(),
+                new EnvCommand(),
             ]
         );
     }

src/SPC/builder/Extension.php

@@ -10,6 +10,7 @@
 use SPC\store\Config;
 use SPC\store\FileSystem;
 use SPC\util\SPCConfigUtil;
+use SPC\util\SPCTarget;
 
 class Extension
 {
@@ -532,6 +533,11 @@ protected function getStaticAndSharedLibs(): array
                 $sharedLibString .= '-l' . $lib . ' ';
             }
         }
+        // move static libstdc++ to shared if we are on non-full-static build target
+        if (!SPCTarget::isStatic() && in_array(SPCTarget::getLibc(), SPCTarget::LIBC_LIST)) {
+            $staticLibString .= ' -lstdc++';
+            $sharedLibString = str_replace('-lstdc++', '', $sharedLibString);
+        }
         return [trim($staticLibString), trim($sharedLibString)];
     }
 

src/SPC/builder/extension/imagick.php

@@ -10,34 +10,9 @@
 #[CustomExt('imagick')]
 class imagick extends Extension
 {
-    public function patchBeforeMake(): bool
-    {
-        if (PHP_OS_FAMILY !== 'Linux') {
-            return false;
-        }
-        if (getenv('SPC_LIBC') === 'glibc' && str_contains(getenv('CC'), 'devtoolset-10')) {
-            return false;
-        }
-        // imagick with calls omp_pause_all, which requires openmp, on non-musl we build imagick without openmp
-        $extra_libs = trim(getenv('SPC_EXTRA_LIBS') . ' -lgomp');
-        f_putenv('SPC_EXTRA_LIBS=' . $extra_libs);
-        return true;
-    }
-
     public function getUnixConfigureArg(bool $shared = false): string
     {
-        $disable_omp = !(getenv('SPC_LIBC') === 'glibc' && str_contains(getenv('CC'), 'devtoolset-10')) ? '' : ' ac_cv_func_omp_pause_resource_all=no';
+        $disable_omp = ' ac_cv_func_omp_pause_resource_all=no';
         return '--with-imagick=' . ($shared ? 'shared,' : '') . BUILD_ROOT_PATH . $disable_omp;
     }
-
-    protected function getStaticAndSharedLibs(): array
-    {
-        // on centos 7, it will use the symbol _ZTINSt6thread6_StateE, which is not defined in system libstdc++.so.6
-        [$static, $shared] = parent::getStaticAndSharedLibs();
-        if (getenv('SPC_LIBC') === 'glibc' && str_contains(getenv('CC'), 'devtoolset-10')) {
-            $static .= ' -lstdc++';
-            $shared = str_replace('-lstdc++', '', $shared);
-        }
-        return [$static, $shared];
-    }
 }

src/SPC/builder/linux/LinuxBuilder.php

@@ -25,22 +25,8 @@ public function __construct(array $options = [])
     {
         $this->options = $options;
 
-        // check musl-cross make installed if we use musl-cross-make
-        $arch = arch2gnu(php_uname('m'));
-
         GlobalEnvManager::init();
-
-        if (getenv('SPC_LIBC') === 'musl' && !SystemUtil::isMuslDist()) {
-            $this->setOptionIfNotExist('library_path', "LIBRARY_PATH=\"/usr/local/musl/{$arch}-linux-musl/lib\"");
-            $this->setOptionIfNotExist('ld_library_path', "LD_LIBRARY_PATH=\"/usr/local/musl/{$arch}-linux-musl/lib\"");
-            $configure = getenv('SPC_CMD_PREFIX_PHP_CONFIGURE');
-            $configure = "LD_LIBRARY_PATH=\"/usr/local/musl/{$arch}-linux-musl/lib\" " . $configure;
-            GlobalEnvManager::putenv("SPC_CMD_PREFIX_PHP_CONFIGURE={$configure}");
-
-            if (!file_exists("/usr/local/musl/{$arch}-linux-musl/lib/libc.a")) {
-                throw new WrongUsageException('You are building with musl-libc target in glibc distro, but musl-toolchain is not installed, please install musl-toolchain first. (You can use `doctor` command to install it)');
-            }
-        }
+        GlobalEnvManager::afterInit();
 
         // concurrency
         $this->concurrency = intval(getenv('SPC_CONCURRENCY'));

src/SPC/builder/linux/SystemUtil.php

@@ -188,12 +188,12 @@ public static function getSupportedDistros(): array
     /**
      * Get libc version string from ldd
      */
-    public static function getLibcVersionIfExists(): ?string
+    public static function getLibcVersionIfExists(string $libc): ?string
     {
         if (self::$libc_version !== null) {
             return self::$libc_version;
         }
-        if (PHP_OS_FAMILY === 'Linux' && getenv('SPC_LIBC') === 'glibc') {
+        if ($libc === 'glibc') {
             $result = shell()->execWithResult('ldd --version', false);
             if ($result[0] !== 0) {
                 return null;
@@ -208,7 +208,7 @@ public static function getLibcVersionIfExists(): ?string
             }
             return null;
         }
-        if (PHP_OS_FAMILY === 'Linux' && getenv('SPC_LIBC') === 'musl') {
+        if ($libc === 'musl') {
             if (self::isMuslDist()) {
                 $result = shell()->execWithResult('ldd 2>&1', false);
             } else {