Fix PIC errors when building libphp.so | extensive extension building rework

.gitignore

@@ -10,6 +10,9 @@ docker/source/
 # default source extract directory
 /source/
 
+# built by shared embed tests
+/locale/
+
 # default source download directory
 /downloads/
 

config/ext.json

@@ -124,10 +124,6 @@
             "Linux": "partial",
             "BSD": "wip"
         },
-        "target": [
-            "static",
-            "shared"
-        ],
         "notes": true,
         "arg-type": "custom",
         "type": "builtin",
@@ -414,13 +410,19 @@
     },
     "mysqli": {
         "type": "builtin",
+        "target": [
+            "static"
+        ],
         "arg-type": "with",
         "ext-depends": [
             "mysqlnd"
         ]
     },
     "mysqlnd": {
         "type": "builtin",
+        "target": [
+            "static"
+        ],
         "arg-type-windows": "with",
         "lib-depends": [
             "zlib"
@@ -454,6 +456,9 @@
     "openssl": {
         "notes": true,
         "type": "builtin",
+        "target": [
+            "static"
+        ],
         "arg-type": "custom",
         "arg-type-windows": "with",
         "lib-depends": [
@@ -781,9 +786,6 @@
             "Windows": "no",
             "BSD": "wip"
         },
-        "target": [
-            "static"
-        ],
         "notes": true,
         "type": "external",
         "source": "swoole",
@@ -1055,9 +1057,6 @@
         "support": {
             "BSD": "wip"
         },
-        "target": [
-            "static"
-        ],
         "type": "builtin",
         "arg-type": "with-prefix",
         "arg-type-windows": "enable",

src/SPC/builder/BuilderBase.php

@@ -233,15 +233,25 @@ public function proveExts(array $static_extensions, array $shared_extensions = [
      */
     abstract public function buildPHP(int $build_target = BUILD_TARGET_NONE);
 
+    /**
+     * @throws WrongUsageException
+     * @throws RuntimeException
+     * @throws FileSystemException
+     */
     public function buildSharedExts(): void
     {
+        FileSystem::replaceFileLineContainsString(BUILD_BIN_PATH . '/php-config', 'extension_dir="', 'extension_dir="' . BUILD_MODULES_PATH . '"');
+        FileSystem::createDir(BUILD_MODULES_PATH);
         foreach ($this->getExts() as $ext) {
             if (!$ext->isBuildShared()) {
                 continue;
             }
             logger()->info('Building extension [' . $ext->getName() . '] as shared extension (' . $ext->getName() . '.so)');
             $ext->buildShared();
         }
+        if (getenv('EXTENSION_DIR')) {
+            FileSystem::replaceFileLineContainsString(BUILD_BIN_PATH . '/php-config', 'extension_dir="', 'extension_dir="' . getenv('EXTENSION_DIR') . '"');
+        }
     }
 
     /**

src/SPC/builder/Extension.php

@@ -188,13 +188,23 @@ public function patchBeforeMake(): bool
         return false;
     }
 
+    /**
+     * Patch code before shared extension ./configure
+     * If you need to patch some code, overwrite this
+     * return true if you patched something, false if not
+     */
+    public function patchBeforeSharedBuild(): bool
+    {
+        return false;
+    }
+
     /**
      * Run shared extension check when cli is enabled
      * @throws RuntimeException
      */
     public function runSharedExtensionCheckUnix(): void
     {
-        [$ret] = shell()->execWithResult(BUILD_BIN_PATH . '/php -n -d "extension=' . BUILD_LIB_PATH . '/' . $this->getName() . '.so" --ri ' . $this->getName());
+        [$ret] = shell()->execWithResult(BUILD_BIN_PATH . '/php -n -d "extension=' . BUILD_MODULES_PATH . '/' . $this->getName() . '.so" --ri ' . $this->getName());
         if ($ret !== 0) {
             throw new RuntimeException($this->getName() . '.so failed to load');
         }
@@ -275,6 +285,10 @@ public function validate(): void
      */
     public function buildShared(): void
     {
+        if (file_exists(BUILD_MODULES_PATH . '/' . $this->getName() . '.so')) {
+            logger()->info('extension ' . $this->getName() . ' already built, skipping');
+            return;
+        }
         match (PHP_OS_FAMILY) {
             'Darwin', 'Linux' => $this->buildUnixShared(),
             default => throw new WrongUsageException(PHP_OS_FAMILY . ' build shared extensions is not supported yet'),
@@ -297,17 +311,27 @@ public function buildUnixShared(): void
             'CFLAGS' => $config['cflags'],
             'LDFLAGS' => $config['ldflags'],
             'LIBS' => $config['libs'],
+            'LD_LIBRARY_PATH' => BUILD_LIB_PATH,
         ];
         // prepare configure args
         shell()->cd($this->source_dir)
             ->setEnv($env)
             ->execWithEnv(BUILD_BIN_PATH . '/phpize')
             ->execWithEnv('./configure ' . $this->getUnixConfigureArg(true) . ' --with-php-config=' . BUILD_BIN_PATH . '/php-config --enable-shared --disable-static')
             ->execWithEnv('make clean')
-            ->execWithEnv('make -j' . $this->builder->concurrency);
+            ->execWithEnv('make -j' . $this->builder->concurrency)
+            ->execWithEnv('make install');
 
         // copy shared library
-        copy($this->source_dir . '/modules/' . $this->getDistName() . '.so', BUILD_LIB_PATH . '/' . $this->getDistName() . '.so');
+        $extensionDirFile = (getenv('EXTENSION_DIR') ?: $this->source_dir . '/modules') . '/' . $this->getName() . '.so';
+        $sourceDirFile = $this->source_dir . '/modules/' . $this->getName() . '.so';
+        if (file_exists($extensionDirFile)) {
+            copy($extensionDirFile, BUILD_MODULES_PATH . '/' . $this->getName() . '.so');
+        } elseif (file_exists($sourceDirFile)) {
+            copy($sourceDirFile, BUILD_MODULES_PATH . '/' . $this->getName() . '.so');
+        } else {
+            throw new RuntimeException('extension ' . $this->getName() . ' built successfully, but into an unexpected location.');
+        }
         // check shared extension with php-cli
         if (file_exists(BUILD_BIN_PATH . '/php')) {
             $this->runSharedExtensionCheckUnix();

src/SPC/builder/extension/bz2.php

@@ -24,4 +24,9 @@ public function patchBeforeConfigure(): bool
         FileSystem::replaceFileRegex(SOURCE_PATH . '/php-src/configure', '/-lbz2/', $this->getLibFilesString() . $frameworks);
         return true;
     }
+
+    public function getUnixConfigureArg(bool $shared = false): string
+    {
+        return $shared ? '--with-bz2=' . BUILD_ROOT_PATH : '';
+    }
 }

src/SPC/builder/extension/dom.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SPC\builder\extension;
+
+use SPC\builder\Extension;
+use SPC\exception\RuntimeException;
+use SPC\store\FileSystem;
+use SPC\util\CustomExt;
+use SPC\util\SPCConfigUtil;
+
+#[CustomExt('dom')]
+class dom extends Extension
+{
+    /**
+     * @throws RuntimeException
+     */
+    public function getUnixConfigureArg(bool $shared = false): string
+    {
+        $arg = '--enable-dom';
+        if (!$shared) {
+            $arg .= ' --with-libxml="' . BUILD_ROOT_PATH . '"';
+        }
+        return $arg;
+    }
+
+    public function patchBeforeBuildconf(): bool
+    {
+        FileSystem::replaceFileStr(SOURCE_PATH . '/php-src/win32/build/config.w32', 'dllmain.c ', '');
+        return true;
+    }
+
+    public function getWindowsConfigureArg(): string
+    {
+        return '--with-dom --with-libxml';
+    }
+
+    public function buildUnixShared(): void
+    {
+        $config = (new SPCConfigUtil($this->builder))->config([$this->getName()]);
+        $env = [
+            'CFLAGS' => $config['cflags'] . ' -I' . SOURCE_PATH . '/php-src',
+            'LDFLAGS' => $config['ldflags'],
+            'LIBS' => $config['libs'],
+            'LD_LIBRARY_PATH' => BUILD_LIB_PATH,
+        ];
+        // prepare configure args
+        shell()->cd($this->source_dir)
+            ->setEnv($env)
+            ->execWithEnv(BUILD_BIN_PATH . '/phpize')
+            ->execWithEnv('./configure ' . $this->getUnixConfigureArg(true) . ' --with-php-config=' . BUILD_BIN_PATH . '/php-config --enable-shared --disable-static')
+            ->execWithEnv('make clean')
+            ->execWithEnv('make -j' . $this->builder->concurrency);
+
+        // copy shared library
+        FileSystem::createDir(BUILD_MODULES_PATH);
+        $extensionDirFile = (getenv('EXTENSION_DIR') ?: $this->source_dir . '/modules') . '/' . $this->getName() . '.so';
+        $sourceDirFile = $this->source_dir . '/modules/' . $this->getName() . '.so';
+        if (file_exists($extensionDirFile)) {
+            copy($extensionDirFile, BUILD_MODULES_PATH . '/' . $this->getName() . '.so');
+        } elseif (file_exists($sourceDirFile)) {
+            copy($sourceDirFile, BUILD_MODULES_PATH . '/' . $this->getName() . '.so');
+        } else {
+            throw new RuntimeException('extension ' . $this->getName() . ' built successfully, but into an unexpected location.');
+        }
+        // check shared extension with php-cli
+        if (file_exists(BUILD_BIN_PATH . '/php')) {
+            $this->runSharedExtensionCheckUnix();
+        }
+    }
+}

src/SPC/builder/extension/opcache.php

@@ -24,6 +24,17 @@ public function validate(): void
         }
     }
 
+    public function runSharedExtensionCheckUnix(): void
+    {
+        [$ret, $out] = shell()->execWithResult(BUILD_BIN_PATH . '/php -n -d "zend_extension=' . BUILD_MODULES_PATH . '/opcache.so" -v');
+        if ($ret !== 0) {
+            throw new RuntimeException('opcache.so failed to load.');
+        }
+        if (!str_contains(join($out), 'with Zend OPcache')) {
+            throw new RuntimeException('opcache.so failed to load.');
+        }
+    }
+
     public function patchBeforeBuildconf(): bool
     {
         if (file_exists(SOURCE_PATH . '/php-src/.opcache_patched')) {

src/SPC/builder/extension/sockets.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SPC\builder\extension;
+
+use SPC\builder\Extension;
+use SPC\util\CustomExt;
+
+#[CustomExt('sockets')]
+class sockets extends Extension
+{
+    public function patchBeforeConfigure(): bool
+    {
+        if (file_exists(BUILD_INCLUDE_PATH . 'php/ext/sockets/php_sockets.h')) {
+            return false;
+        }
+        copy(SOURCE_PATH . '/php-src/ext/sockets/php_sockets.h', BUILD_INCLUDE_PATH . 'php/ext/sockets/php_sockets.h');
+        return true;
+    }
+}

src/SPC/builder/extension/xdebug.php

@@ -13,9 +13,12 @@ class xdebug extends Extension
 {
     public function runSharedExtensionCheckUnix(): void
     {
-        [$ret] = shell()->execWithResult(BUILD_BIN_PATH . '/php -n -d "zend_extension=' . BUILD_LIB_PATH . '/xdebug.so" --ri xdebug');
+        [$ret, $out] = shell()->execWithResult(BUILD_BIN_PATH . '/php -n -d "zend_extension=' . BUILD_MODULES_PATH . '/xdebug.so" -v');
         if ($ret !== 0) {
             throw new RuntimeException('xdebug.so failed to load.');
         }
+        if (!str_contains(join($out), 'with Xdebug')) {
+            throw new RuntimeException('xdebug.so failed to load.');
+        }
     }
 }

src/SPC/builder/extension/xml.php

@@ -13,7 +13,6 @@
 #[CustomExt('soap')]
 #[CustomExt('xmlreader')]
 #[CustomExt('xmlwriter')]
-#[CustomExt('dom')]
 #[CustomExt('simplexml')]
 class xml extends Extension
 {

src/SPC/builder/linux/library/icu.php

@@ -14,11 +14,16 @@ class icu extends LinuxLibraryBase
 
     protected function build(): void
     {
-        $cppflags = 'CPPFLAGS="-DU_CHARSET_IS_UTF8=1  -DU_USING_ICU_NAMESPACE=1 -DU_STATIC_IMPLEMENTATION=1 -fPIC -fPIE -fno-ident"';
-        $cxxflags = 'CXXFLAGS="-std=c++17"';
+        $cppflags = 'CPPFLAGS="-DU_CHARSET_IS_UTF8=1  -DU_USING_ICU_NAMESPACE=1 -DU_STATIC_IMPLEMENTATION=1 -DPIC -fPIC"';
+        $cxxflags = 'CXXFLAGS="-std=c++17 -fPIC -fno-ident"';
         $ldflags = getenv('SPC_LIBC') !== 'glibc' ? 'LDFLAGS="-static"' : '';
         shell()->cd($this->source_dir . '/source')
-            ->exec(
+            ->setEnv([
+                'CFLAGS' => $this->getLibExtraCFlags(),
+                'LDFLAGS' => $this->getLibExtraLdFlags(),
+                'LIBS' => $this->getLibExtraLibs(),
+            ])
+            ->execWithEnv(
                 "{$cppflags} {$cxxflags} {$ldflags} " .
                 './runConfigureICU Linux ' .
                 '--enable-static ' .
@@ -33,9 +38,9 @@ protected function build(): void
                 '--enable-samples=no ' .
                 '--prefix=' . BUILD_ROOT_PATH
             )
-            ->exec('make clean')
-            ->exec("make -j{$this->builder->concurrency}")
-            ->exec('make install');
+            ->execWithEnv('make clean')
+            ->execWithEnv("make -j{$this->builder->concurrency}")
+            ->execWithEnv('make install');
 
         $this->patchPkgconfPrefix(['icu-i18n.pc', 'icu-io.pc', 'icu-uc.pc'], PKGCONF_PATCH_PREFIX);
         FileSystem::removeDir(BUILD_LIB_PATH . '/icu');

src/SPC/builder/linux/library/libffi.php

@@ -21,7 +21,11 @@ public function build(): void
         $arch = getenv('SPC_ARCH');
 
         shell()->cd($this->source_dir)
-            ->setEnv(['CFLAGS' => $this->getLibExtraCFlags(), 'LDFLAGS' => $this->getLibExtraLdFlags(), 'LIBS' => $this->getLibExtraLibs()])
+            ->setEnv([
+                'CFLAGS' => $this->getLibExtraCFlags(),
+                'LDFLAGS' => $this->getLibExtraLdFlags(),
+                'LIBS' => $this->getLibExtraLibs(),
+            ])
             ->execWithEnv(
                 './configure ' .
                 '--enable-static ' .

src/SPC/builder/linux/library/openssl.php

@@ -65,7 +65,11 @@ public function build(): void
         $clang_postfix = SystemUtil::getCCType(getenv('CC')) === 'clang' ? '-clang' : '';
 
         shell()->cd($this->source_dir)
-            ->setEnv(['CFLAGS' => $this->getLibExtraCFlags() ?: $this->builder->arch_c_flags, 'LDFLAGS' => $this->getLibExtraLdFlags(), 'LIBS' => $this->getLibExtraLibs()])
+            ->setEnv([
+                'CFLAGS' => $this->getLibExtraCFlags(),
+                'LDFLAGS' => $this->getLibExtraLdFlags(),
+                'LIBS' => $this->getLibExtraLibs(),
+            ])
             ->execWithEnv(
                 "{$env} ./Configure no-shared {$extra} " .
                 '--prefix=/ ' .

src/SPC/builder/macos/library/openssl.php

@@ -50,7 +50,11 @@ protected function build(): void
         $arch = getenv('SPC_ARCH');
 
         shell()->cd($this->source_dir)
-            ->setEnv(['CFLAGS' => $this->getLibExtraCFlags(), 'LDFLAGS' => $this->getLibExtraLdFlags(), 'LIBS' => $this->getLibExtraLibs()])
+            ->setEnv([
+                'CFLAGS' => $this->getLibExtraCFlags(),
+                'LDFLAGS' => $this->getLibExtraLdFlags(),
+                'LIBS' => $this->getLibExtraLibs(),
+            ])
             ->exec(
                 "./Configure no-shared {$extra} " .
                 '--prefix=/ ' . // use prefix=/

src/SPC/builder/unix/UnixBuilderBase.php

@@ -223,8 +223,8 @@ protected function deployBinary(int $type): bool
             default => throw new RuntimeException('Deployment does not accept type ' . $type),
         };
         logger()->info('Deploying ' . $this->getBuildTypeName($type) . ' file');
-        FileSystem::createDir(BUILD_ROOT_PATH . '/bin');
-        shell()->exec('cp ' . escapeshellarg($src) . ' ' . escapeshellarg(BUILD_ROOT_PATH . '/bin/'));
+        FileSystem::createDir(BUILD_BIN_PATH);
+        shell()->exec('cp ' . escapeshellarg($src) . ' ' . escapeshellarg(BUILD_BIN_PATH));
         return true;
     }