Sapi/frankenphp

config/env.ini

@@ -42,6 +42,9 @@ SPC_CONCURRENCY=${CPU_COUNT}
 SPC_SKIP_PHP_VERSION_CHECK="no"
 ; Ignore some check item for bin/spc doctor command, comma separated (e.g. SPC_SKIP_DOCTOR_CHECK_ITEMS="if homebrew has installed")
 SPC_SKIP_DOCTOR_CHECK_ITEMS=""
+; extra modules that xcaddy will include in the FrankenPHP build
+SPC_CMD_VAR_FRANKENPHP_XCADDY_MODULES="--with github.com/dunglas/mercure/caddy --with github.com/dunglas/vulcain/caddy --with github.com/dunglas/caddy-cbrotli"
+
 ; EXTENSION_DIR where the built php will look for extension when a .ini instructs to load them
 ; only useful for builds targeting not pure-static linking
 ; default paths

src/SPC/builder/freebsd/BSDBuilder.php

@@ -96,6 +96,7 @@ public function buildPHP(int $build_target = BUILD_TARGET_NONE): void
         $enableFpm = ($build_target & BUILD_TARGET_FPM) === BUILD_TARGET_FPM;
         $enableMicro = ($build_target & BUILD_TARGET_MICRO) === BUILD_TARGET_MICRO;
         $enableEmbed = ($build_target & BUILD_TARGET_EMBED) === BUILD_TARGET_EMBED;
+        $enableFrankenphp = ($build_target & BUILD_TARGET_FRANKENPHP) === BUILD_TARGET_FRANKENPHP;
 
         shell()->cd(SOURCE_PATH . '/php-src')
             ->exec(
@@ -143,6 +144,10 @@ public function buildPHP(int $build_target = BUILD_TARGET_NONE): void
             }
             $this->buildEmbed();
         }
+        if ($enableFrankenphp) {
+            logger()->info('building frankenphp');
+            $this->buildFrankenphp();
+        }
     }
 
     public function testPHP(int $build_target = BUILD_TARGET_NONE)

src/SPC/builder/linux/LinuxBuilder.php

@@ -110,10 +110,11 @@ public function buildPHP(int $build_target = BUILD_TARGET_NONE): void
         $config_file_scan_dir = $this->getOption('with-config-file-scan-dir', false) ?
             ('--with-config-file-scan-dir=' . $this->getOption('with-config-file-scan-dir') . ' ') : '';
 
-        $enable_cli = ($build_target & BUILD_TARGET_CLI) === BUILD_TARGET_CLI;
-        $enable_fpm = ($build_target & BUILD_TARGET_FPM) === BUILD_TARGET_FPM;
-        $enable_micro = ($build_target & BUILD_TARGET_MICRO) === BUILD_TARGET_MICRO;
-        $enable_embed = ($build_target & BUILD_TARGET_EMBED) === BUILD_TARGET_EMBED;
+        $enableCli = ($build_target & BUILD_TARGET_CLI) === BUILD_TARGET_CLI;
+        $enableFpm = ($build_target & BUILD_TARGET_FPM) === BUILD_TARGET_FPM;
+        $enableMicro = ($build_target & BUILD_TARGET_MICRO) === BUILD_TARGET_MICRO;
+        $enableEmbed = ($build_target & BUILD_TARGET_EMBED) === BUILD_TARGET_EMBED;
+        $enableFrankenphp = ($build_target & BUILD_TARGET_FRANKENPHP) === BUILD_TARGET_FRANKENPHP;
 
         $mimallocLibs = $this->getLib('mimalloc') !== null ? BUILD_LIB_PATH . '/mimalloc.o ' : '';
         // prepare build php envs
@@ -125,7 +126,7 @@ public function buildPHP(int $build_target = BUILD_TARGET_NONE): void
         ]);
 
         // process micro upx patch if micro sapi enabled
-        if ($enable_micro) {
+        if ($enableMicro) {
             if (version_compare($this->getMicroVersion(), '0.2.0') < 0) {
                 // for phpmicro 0.1.x
                 $this->processMicroUPXLegacy();
@@ -137,10 +138,10 @@ public function buildPHP(int $build_target = BUILD_TARGET_NONE): void
         shell()->cd(SOURCE_PATH . '/php-src')
             ->exec(
                 getenv('SPC_CMD_PREFIX_PHP_CONFIGURE') . ' ' .
-                ($enable_cli ? '--enable-cli ' : '--disable-cli ') .
-                ($enable_fpm ? '--enable-fpm ' . ($this->getLib('libacl') !== null ? '--with-fpm-acl ' : '') : '--disable-fpm ') .
-                ($enable_embed ? "--enable-embed={$embed_type} " : '--disable-embed ') .
-                ($enable_micro ? '--enable-micro=all-static ' : '--disable-micro ') .
+                ($enableCli ? '--enable-cli ' : '--disable-cli ') .
+                ($enableFpm ? '--enable-fpm ' . ($this->getLib('libacl') !== null ? '--with-fpm-acl ' : '') : '--disable-fpm ') .
+                ($enableEmbed ? "--enable-embed={$embed_type} " : '--disable-embed ') .
+                ($enableMicro ? '--enable-micro=all-static ' : '--disable-micro ') .
                 $config_file_path .
                 $config_file_scan_dir .
                 $disable_jit .
@@ -156,25 +157,29 @@ public function buildPHP(int $build_target = BUILD_TARGET_NONE): void
 
         $this->cleanMake();
 
-        if ($enable_cli) {
+        if ($enableCli) {
             logger()->info('building cli');
             $this->buildCli();
         }
-        if ($enable_fpm) {
+        if ($enableFpm) {
             logger()->info('building fpm');
             $this->buildFpm();
         }
-        if ($enable_micro) {
+        if ($enableMicro) {
             logger()->info('building micro');
             $this->buildMicro();
         }
-        if ($enable_embed) {
+        if ($enableEmbed) {
             logger()->info('building embed');
-            if ($enable_micro) {
+            if ($enableMicro) {
                 FileSystem::replaceFileStr(SOURCE_PATH . '/php-src/Makefile', 'OVERALL_TARGET =', 'OVERALL_TARGET = libphp.la');
             }
             $this->buildEmbed();
         }
+        if ($enableFrankenphp) {
+            logger()->info('building frankenphp');
+            $this->buildFrankenphp();
+        }
     }
 
     public function testPHP(int $build_target = BUILD_TARGET_NONE)

src/SPC/builder/macos/MacOSBuilder.php

@@ -122,6 +122,7 @@ public function buildPHP(int $build_target = BUILD_TARGET_NONE): void
         $enableFpm = ($build_target & BUILD_TARGET_FPM) === BUILD_TARGET_FPM;
         $enableMicro = ($build_target & BUILD_TARGET_MICRO) === BUILD_TARGET_MICRO;
         $enableEmbed = ($build_target & BUILD_TARGET_EMBED) === BUILD_TARGET_EMBED;
+        $enableFrankenphp = ($build_target & BUILD_TARGET_FRANKENPHP) === BUILD_TARGET_FRANKENPHP;
 
         // prepare build php envs
         $mimallocLibs = $this->getLib('mimalloc') !== null ? BUILD_LIB_PATH . '/mimalloc.o ' : '';
@@ -180,6 +181,10 @@ public function buildPHP(int $build_target = BUILD_TARGET_NONE): void
             }
             $this->buildEmbed();
         }
+        if ($enableFrankenphp) {
+            logger()->info('building frankenphp');
+            $this->buildFrankenphp();
+        }
     }
 
     public function testPHP(int $build_target = BUILD_TARGET_NONE)

src/SPC/builder/traits/UnixGoCheckTrait.php

@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SPC\builder\traits;
+
+use SPC\doctor\CheckResult;
+use SPC\exception\RuntimeException;
+use SPC\store\Downloader;
+use SPC\store\FileSystem;
+
+trait UnixGoCheckTrait
+{
+    private function checkGoAndXcaddy(): ?CheckResult
+    {
+        $paths = explode(PATH_SEPARATOR, getenv('PATH'));
+        $goroot = getenv('GOROOT') ?: '/usr/local/go';
+        $goBin = "{$goroot}/bin";
+        $paths[] = $goBin;
+        if ($this->findCommand('go', $paths) === null) {
+            $this->installGo();
+        }
+
+        $gobin = getenv('GOBIN') ?: (getenv('HOME') . '/go/bin');
+        putenv("GOBIN={$gobin}");
+
+        $paths[] = $gobin;
+
+        if ($this->findCommand('xcaddy', $paths) === null) {
+            shell(true)->exec('go install github.com/caddyserver/xcaddy/cmd/xcaddy@latest');
+        }
+
+        return CheckResult::ok();
+    }
+
+    private function installGo(): bool
+    {
+        $prefix = '';
+        if (get_current_user() !== 'root') {
+            $prefix = 'sudo ';
+            logger()->warning('Current user is not root, using sudo for running command');
+        }
+
+        $arch = php_uname('m');
+        $go_arch = match ($arch) {
+            'x86_64' => 'amd64',
+            'aarch64' => 'arm64',
+            default => $arch
+        };
+        $os = strtolower(PHP_OS_FAMILY);
+
+        $go_version = '1.24.4';
+        $go_filename = "go{$go_version}.{$os}-{$go_arch}.tar.gz";
+        $go_url = "https://go.dev/dl/{$go_filename}";
+
+        logger()->info("Downloading Go {$go_version} for {$go_arch}");
+
+        try {
+            // Download Go binary
+            Downloader::downloadFile('go', $go_url, $go_filename);
+
+            // Extract the tarball
+            FileSystem::extractSource('go', SPC_SOURCE_ARCHIVE, DOWNLOAD_PATH . "/{$go_filename}");
+
+            // Move to /usr/local/go
+            logger()->info('Installing Go to /usr/local/go');
+            shell()->exec("{$prefix}rm -rf /usr/local/go");
+            shell()->exec("{$prefix}mv " . SOURCE_PATH . '/go /usr/local/');
+
+            if (!str_contains(getenv('PATH'), '/usr/local/go/bin')) {
+                logger()->info('Adding Go to PATH');
+                shell()->exec("{$prefix}echo 'export PATH=\$PATH:/usr/local/go/bin' >> /etc/profile");
+                putenv('PATH=' . getenv('PATH') . ':/usr/local/go/bin');
+            }
+
+            logger()->info('Go has been installed successfully');
+            return true;
+        } catch (RuntimeException $e) {
+            logger()->error('Failed to install Go: ' . $e->getMessage());
+            return false;
+        }
+    }
+}

src/SPC/builder/unix/UnixBuilderBase.php

@@ -277,4 +277,36 @@ protected function patchPhpScripts(): void
             FileSystem::writeFile(BUILD_BIN_PATH . '/php-config', $php_config_str);
         }
     }
+
+    protected function buildFrankenphp(): void
+    {
+        $path = getenv('PATH');
+        $xcaddyPath = getenv('GOBIN') ?: (getenv('HOME') . '/go/bin');
+        if (!str_contains($path, $xcaddyPath)) {
+            $path = $path . ':' . $xcaddyPath;
+        }
+        $path = BUILD_BIN_PATH . ':' . $path;
+        f_putenv("PATH={$path}");
+
+        $brotliLibs = $this->getLib('brotli') !== null ? '-lbrotlienc -lbrotlidec -lbrotlicommon' : '';
+        $watcherLibs = $this->getLib('brotli') !== null ? '-lwatcher-c' : '';
+        $nobrotli = $this->getLib('brotli') === null ? ',nobrotli' : '';
+        $nowatcher = $this->getLib('watcher') === null ? ',nowatcher' : '';
+
+        $env = [
+            'CGO_ENABLED' => '1',
+            'CGO_CFLAGS' => '$(php-config --includes) -I$(php-config --include-dir)/..',
+            'CGO_LDFLAGS' => "$(php-config --ldflags) $(php-config --libs) {$brotliLibs} {$watcherLibs} -lphp",
+            'XCADDY_GO_BUILD_FLAGS' => "-ldflags='-w -s' -tags=nobadger,nomysql,nopgx" . $nobrotli . $nowatcher,
+            'LD_LIBRARY_PATH' => BUILD_LIB_PATH,
+        ];
+        shell()->cd(BUILD_BIN_PATH)
+            ->setEnv($env)
+            ->exec(
+                'xcaddy build ' .
+                '--output frankenphp ' .
+                '--with github.com/dunglas/frankenphp/caddy ' .
+                getenv('SPC_CMD_VAR_FRANKENPHP_XCADDY_MODULES')
+            );
+    }
 }

src/SPC/command/BuildPHPCommand.php

@@ -33,6 +33,7 @@ public function configure(): void
         $this->addOption('build-cli', null, null, 'Build cli SAPI');
         $this->addOption('build-fpm', null, null, 'Build fpm SAPI (not available on Windows)');
         $this->addOption('build-embed', null, null, 'Build embed SAPI (not available on Windows)');
+        $this->addOption('build-frankenphp', null, null, 'Build FrankenPHP SAPI (not available on Windows)');
         $this->addOption('build-all', null, null, 'Build all SAPI');
         $this->addOption('no-strip', null, null, 'build without strip, in order to debug and load external extensions');
         $this->addOption('disable-opcache-jit', null, null, 'disable opcache jit');
@@ -83,7 +84,8 @@ public function handle(): int
             $this->output->writeln("<comment>\t--build-micro\tBuild phpmicro SAPI</comment>");
             $this->output->writeln("<comment>\t--build-fpm\tBuild php-fpm SAPI</comment>");
             $this->output->writeln("<comment>\t--build-embed\tBuild embed SAPI/libphp</comment>");
-            $this->output->writeln("<comment>\t--build-all\tBuild all SAPI: cli, micro, fpm, embed</comment>");
+            $this->output->writeln("<comment>\t--build-frankenphp\tBuild FrankenPHP SAPI/libphp</comment>");
+            $this->output->writeln("<comment>\t--build-all\tBuild all SAPI: cli, micro, fpm, embed, frankenphp</comment>");
             return static::FAILURE;
         }
         if ($rule === BUILD_TARGET_ALL) {
@@ -304,6 +306,7 @@ private function parseRules(array $shared_extensions = []): int
         $rule |= ($this->getOption('build-micro') ? BUILD_TARGET_MICRO : BUILD_TARGET_NONE);
         $rule |= ($this->getOption('build-fpm') ? BUILD_TARGET_FPM : BUILD_TARGET_NONE);
         $rule |= ($this->getOption('build-embed') || !empty($shared_extensions) ? BUILD_TARGET_EMBED : BUILD_TARGET_NONE);
+        $rule |= ($this->getOption('build-frankenphp') ? BUILD_TARGET_FRANKENPHP : BUILD_TARGET_NONE);
         $rule |= ($this->getOption('build-all') ? BUILD_TARGET_ALL : BUILD_TARGET_NONE);
         return $rule;
     }

src/SPC/doctor/item/BSDToolCheckList.php

@@ -47,6 +47,12 @@ public function checkCliTools(): ?CheckResult
         return CheckResult::ok();
     }
 
+    #[AsCheckItem('if xcaddy is installed', limit_os: 'BSD')]
+    public function checkXcaddy(): ?CheckResult
+    {
+        return $this->checkGoAndXcaddy();
+    }
+
     #[AsFixItem('build-tools-bsd')]
     public function fixBuildTools(array $missing): bool
     {

src/SPC/doctor/item/LinuxToolCheckList.php

@@ -5,6 +5,7 @@
 namespace SPC\doctor\item;
 
 use SPC\builder\linux\SystemUtil;
+use SPC\builder\traits\UnixGoCheckTrait;
 use SPC\builder\traits\UnixSystemUtilTrait;
 use SPC\doctor\AsCheckItem;
 use SPC\doctor\AsFixItem;
@@ -14,6 +15,7 @@
 class LinuxToolCheckList
 {
     use UnixSystemUtilTrait;
+    use UnixGoCheckTrait;
 
     public const TOOLS_ALPINE = [
         'make', 'bison', 'flex',
@@ -87,6 +89,12 @@ public function checkCliTools(): ?CheckResult
         return CheckResult::ok();
     }
 
+    #[AsCheckItem('if xcaddy is installed', limit_os: 'Linux')]
+    public function checkXcaddy(): ?CheckResult
+    {
+        return $this->checkGoAndXcaddy();
+    }
+
     #[AsCheckItem('if cmake version >= 3.18', limit_os: 'Linux')]
     public function checkCMakeVersion(): ?CheckResult
     {

src/SPC/doctor/item/MacOSToolCheckList.php

@@ -4,6 +4,7 @@
 
 namespace SPC\doctor\item;
 
+use SPC\builder\traits\UnixGoCheckTrait;
 use SPC\builder\traits\UnixSystemUtilTrait;
 use SPC\doctor\AsCheckItem;
 use SPC\doctor\AsFixItem;
@@ -13,6 +14,7 @@
 class MacOSToolCheckList
 {
     use UnixSystemUtilTrait;
+    use UnixGoCheckTrait;
 
     /** @var string[] MacOS 环境下编译依赖的命令 */
     public const REQUIRED_COMMANDS = [
@@ -34,6 +36,12 @@ class MacOSToolCheckList
         'glibtoolize',
     ];
 
+    #[AsCheckItem('if xcaddy is installed', limit_os: 'Darwin')]
+    public function checkXcaddy(): ?CheckResult
+    {
+        return $this->checkGoAndXcaddy();
+    }
+
     #[AsCheckItem('if homebrew has installed', limit_os: 'Darwin', level: 998)]
     public function checkBrew(): ?CheckResult
     {

src/globals/defines.php

@@ -62,7 +62,8 @@
 const BUILD_TARGET_MICRO = 2;   // build micro
 const BUILD_TARGET_FPM = 4;     // build fpm
 const BUILD_TARGET_EMBED = 8;   // build embed
-const BUILD_TARGET_ALL = 15;    // build all
+const BUILD_TARGET_FRANKENPHP = BUILD_TARGET_EMBED | 16;   // build frankenphp
+const BUILD_TARGET_ALL = BUILD_TARGET_CLI | BUILD_TARGET_MICRO | BUILD_TARGET_FPM | BUILD_TARGET_EMBED | BUILD_TARGET_FRANKENPHP;    // build all
 
 // doctor error fix policy
 const FIX_POLICY_DIE = 1;       // die directly