name, 'type'); $unix_only = Config::getExt($this->name, 'unix-only', false); $windows_only = Config::getExt($this->name, 'windows-only', false); if (PHP_OS_FAMILY !== 'Windows' && $windows_only) { throw new RuntimeException("{$ext_type} extension {$name} is not supported on Linux and macOS platform"); } if (PHP_OS_FAMILY === 'Windows' && $unix_only) { throw new RuntimeException("{$ext_type} extension {$name} is not supported on Windows platform"); } // set source_dir for builtin if ($ext_type === 'builtin') { $this->source_dir = SOURCE_PATH . '/php-src/ext/' . $this->name; } elseif ($ext_type === 'external') { $source = Config::getExt($this->name, 'source'); if ($source === null) { throw new RuntimeException("{$ext_type} extension {$name} source not found"); } $source_path = Config::getSource($source)['path'] ?? null; $source_path = $source_path === null ? SOURCE_PATH . '/' . $source : SOURCE_PATH . '/' . $source_path; $this->source_dir = $source_path; } else { $this->source_dir = SOURCE_PATH . '/php-src'; } } public function getFrameworks(): array { return Config::getExt($this->getName(), 'frameworks', []); } /** * 获取开启该扩展的 PHP 编译添加的参数 * * @throws FileSystemException * @throws WrongUsageException */ public function getConfigureArg(bool $shared = false): string { return match (PHP_OS_FAMILY) { 'Windows' => $this->getWindowsConfigureArg($shared), 'Darwin', 'Linux', 'BSD' => $this->getUnixConfigureArg($shared), default => throw new WrongUsageException(PHP_OS_FAMILY . ' build is not supported yet'), }; } /** * 根据 ext 的 arg-type 获取对应开启的参数,一般都是 --enable-xxx 和 --with-xxx * * @throws FileSystemException * @throws WrongUsageException */ public function getEnableArg(bool $shared = false): string { $_name = str_replace('_', '-', $this->name); return match ($arg_type = Config::getExt($this->name, 'arg-type', 'enable')) { 'enable' => '--enable-' . $_name . ($shared ? '=shared' : '') . ' ', 'with' => '--with-' . $_name . ($shared ? '=shared' : '') . ' ', 'with-prefix' => '--with-' . $_name . '=' . ($shared ? 'shared,' : '') . '"' . BUILD_ROOT_PATH . '" ', 'none', 'custom' => '', default => throw new WrongUsageException("argType does not accept {$arg_type}, use [enable/with/with-prefix] ."), }; } /** * 导出当前扩展依赖的所有 lib 库生成的 .a 静态编译库文件,以字符串形式导出,用空格分割 */ public function getLibFilesString(): string { $ret = array_map( fn ($x) => $x->getStaticLibFiles(), $this->getLibraryDependencies(recursive: true) ); return implode(' ', $ret); } /** * 检查下依赖就行了,作用是导入依赖给 Extension 对象,今后可以对库依赖进行选择性处理 * * @throws RuntimeException * @throws FileSystemException * @throws WrongUsageException */ public function checkDependency(): static { foreach (Config::getExt($this->name, 'lib-depends', []) as $name) { $this->addLibraryDependency($name); } foreach (Config::getExt($this->name, 'lib-suggests', []) as $name) { $this->addLibraryDependency($name, true); } foreach (Config::getExt($this->name, 'ext-depends', []) as $name) { $this->addExtensionDependency($name); } foreach (Config::getExt($this->name, 'ext-suggests', []) as $name) { $this->addExtensionDependency($name, true); } return $this; } public function getExtensionDependency(): array { return array_filter($this->dependencies, fn ($x) => $x instanceof Extension); } public function getName(): string { return $this->name; } /** * returns extension dist name */ public function getDistName(): string { return $this->name; } public function getWindowsConfigureArg(bool $shared = false): string { return $this->getEnableArg(); // Windows is not supported yet } public function getUnixConfigureArg(bool $shared = false): string { return $this->getEnableArg($shared); } /** * Patch code before ./buildconf * If you need to patch some code, overwrite this * return true if you patched something, false if not */ public function patchBeforeBuildconf(): bool { return false; } /** * Patch code before ./configure * If you need to patch some code, overwrite this * return true if you patched something, false if not */ public function patchBeforeConfigure(): bool { return false; } /** * Patch code before make * If you need to patch some code, overwrite this * return true if you patched something, false if not */ public function patchBeforeMake(): bool { return false; } /** * Patch code before shared extension phpize * If you need to patch some code, overwrite this * return true if you patched something, false if not */ public function patchBeforeSharedPhpize(): 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 patchBeforeSharedConfigure(): bool { return false; } /** * Patch code before shared extension make * If you need to patch some code, overwrite this * return true if you patched something, false if not */ public function patchBeforeSharedMake(): bool { $extra = SystemUtil::getExtraRuntimeObjects(); if (!$extra) { return false; } FileSystem::replaceFileRegex( $this->source_dir . '/Makefile', "/^(shared_objects_{$this->getName()}\\s*=.*)$/m", "$1 {$extra}", ); return true; } /** * @return string * returns a command line string with all required shared extensions to load * i.e.; pdo_pgsql would return: * * `-d "extension=pgsql" -d "extension=pdo_pgsql"` * @throws FileSystemException * @throws WrongUsageException */ public function getSharedExtensionLoadString(): string { $loaded = []; $order = []; $resolve = function ($extension) use (&$resolve, &$loaded, &$order) { if (isset($loaded[$extension->getName()])) { return; } $loaded[$extension->getName()] = true; foreach ($this->dependencies as $dependency) { $resolve($dependency); } $order[] = $extension; }; $resolve($this); $ret = ''; foreach ($order as $ext) { if ($ext instanceof Extension && $ext->isBuildShared()) { if (Config::getExt($ext->getName(), 'zend-extension', false) === true) { $ret .= " -d \"zend_extension={$ext->getName()}\""; } else { $ret .= " -d \"extension={$ext->getName()}\""; } } } if ($ret !== '') { $ret = ' -d "extension_dir=' . BUILD_MODULES_PATH . '"' . $ret; } return $ret; } /** * @throws RuntimeException */ public function runCliCheckUnix(): void { // Run compile check if build target is cli // If you need to run some check, overwrite this or add your assert in src/globals/ext-tests/{extension_name}.php // If check failed, throw RuntimeException $sharedExtensions = $this->getSharedExtensionLoadString(); [$ret, $out] = shell()->execWithResult(BUILD_BIN_PATH . '/php -n' . $sharedExtensions . ' --ri "' . $this->getDistName() . '"'); if ($ret !== 0) { throw new RuntimeException( 'extension ' . $this->getName() . ' failed runtime check: php-cli returned ' . $ret . "\n" . join("\n", $out) ); } if (file_exists(ROOT_DIR . '/src/globals/ext-tests/' . $this->getName() . '.php')) { // Trim additional content & escape special characters to allow inline usage $test = str_replace( ['getName() . '.php') ); [$ret, $out] = shell()->execWithResult(BUILD_BIN_PATH . '/php -n' . $sharedExtensions . ' -r "' . trim($test) . '"'); if ($ret !== 0) { if ($this->builder->getOption('debug')) { var_dump($out); } throw new RuntimeException('extension ' . $this->getName() . ' failed sanity check'); } } } /** * @throws RuntimeException */ public function runCliCheckWindows(): void { // Run compile check if build target is cli // If you need to run some check, overwrite this or add your assert in src/globals/ext-tests/{extension_name}.php // If check failed, throw RuntimeException [$ret] = cmd()->execWithResult(BUILD_ROOT_PATH . '/bin/php.exe -n --ri "' . $this->getDistName() . '"', false); if ($ret !== 0) { throw new RuntimeException('extension ' . $this->getName() . ' failed compile check: php-cli returned ' . $ret); } if (file_exists(FileSystem::convertPath(ROOT_DIR . '/src/globals/ext-tests/' . $this->getName() . '.php'))) { // Trim additional content & escape special characters to allow inline usage $test = str_replace( ['getName() . '.php')) ); [$ret] = cmd()->execWithResult(BUILD_ROOT_PATH . '/bin/php.exe -n -r "' . trim($test) . '"'); if ($ret !== 0) { throw new RuntimeException('extension ' . $this->getName() . ' failed sanity check'); } } } public function validate(): void { // do nothing, just throw wrong usage exception if not valid } /** * Build shared extension * * @throws WrongUsageException * @throws RuntimeException */ public function buildShared(): void { if (Config::getExt($this->getName(), 'type') === 'builtin' || Config::getExt($this->getName(), 'build-with-php') === true) { if (file_exists(BUILD_MODULES_PATH . '/' . $this->getName() . '.so')) { logger()->info('Shared extension [' . $this->getName() . '] was already built by php-src/configure (' . $this->getName() . '.so)'); return; } if (Config::getExt($this->getName(), 'build-with-php') === true) { logger()->warning('Shared extension [' . $this->getName() . '] did not build with php-src/configure (' . $this->getName() . '.so)'); logger()->warning('Try deleting your build and source folders and running `spc build`` again.'); return; } } if (file_exists(BUILD_MODULES_PATH . '/' . $this->getName() . '.so')) { logger()->info('Shared extension [' . $this->getName() . '] was already built, skipping (' . $this->getName() . '.so)'); } logger()->info('Building extension [' . $this->getName() . '] as shared extension (' . $this->getName() . '.so)'); foreach ($this->dependencies as $dependency) { if (!$dependency instanceof Extension) { continue; } if (!$dependency->isBuildStatic()) { logger()->info('extension ' . $this->getName() . ' requires extension ' . $dependency->getName()); $dependency->buildShared(); } } match (PHP_OS_FAMILY) { 'Darwin', 'Linux' => $this->buildUnixShared(), default => throw new WrongUsageException(PHP_OS_FAMILY . ' build shared extensions is not supported yet'), }; } /** * Build shared extension for Unix * * @throws FileSystemException * @throws RuntimeException * @throws WrongUsageException * @throws \ReflectionException * @throws \Throwable */ public function buildUnixShared(): void { $config = (new SPCConfigUtil($this->builder))->config([$this->getName()], with_dependencies: true); [$staticLibString, $sharedLibString] = $this->getStaticAndSharedLibs(); // macOS ld64 doesn't understand these, while Linux and BSD do // use them to make sure that all symbols are picked up, even if a library has already been visited before $preStatic = PHP_OS_FAMILY !== 'Darwin' ? '-Wl,--start-group ' : ''; $postStatic = PHP_OS_FAMILY !== 'Darwin' ? ' -Wl,--end-group ' : ' '; $env = [ 'CFLAGS' => $config['cflags'], 'CXXFLAGS' => $config['cflags'], 'LDFLAGS' => $config['ldflags'], 'LIBS' => $preStatic . $staticLibString . $postStatic . $sharedLibString, 'LD_LIBRARY_PATH' => BUILD_LIB_PATH, ]; if ($this->patchBeforeSharedPhpize()) { logger()->info("Extension [{$this->getName()}] patched before shared phpize"); } // prepare configure args shell()->cd($this->source_dir) ->setEnv($env) ->appendEnv($this->getExtraEnv()) ->exec(BUILD_BIN_PATH . '/phpize'); if ($this->patchBeforeSharedConfigure()) { logger()->info("Extension [{$this->getName()}] patched before shared configure"); } shell()->cd($this->source_dir) ->setEnv($env) ->appendEnv($this->getExtraEnv()) ->exec( './configure ' . $this->getUnixConfigureArg(true) . ' --with-php-config=' . BUILD_BIN_PATH . '/php-config ' . '--enable-shared --disable-static' ); // some extensions don't define their dependencies well, this patch is only needed for a few FileSystem::replaceFileRegex( $this->source_dir . '/Makefile', '/^(.*_SHARED_LIBADD\s*=.*)$/m', '$1 ' . $staticLibString ); if ($this->patchBeforeSharedMake()) { logger()->info("Extension [{$this->getName()}] patched before shared make"); } shell()->cd($this->source_dir) ->setEnv($env) ->appendEnv($this->getExtraEnv()) ->exec('make clean') ->exec('make -j' . $this->builder->concurrency) ->exec('make install'); } /** * Get current extension version * * @return null|string Version string or null */ public function getExtVersion(): ?string { return null; } public function setBuildStatic(): void { if (!in_array('static', Config::getExtTarget($this->name))) { throw new WrongUsageException("Extension [{$this->name}] does not support static build!"); } $this->build_static = true; } public function setBuildShared(): void { if (!in_array('shared', Config::getExtTarget($this->name))) { throw new WrongUsageException("Extension [{$this->name}] does not support shared build!"); } $this->build_shared = true; } public function isBuildShared(): bool { return $this->build_shared; } public function isBuildStatic(): bool { return $this->build_static; } /** * @throws RuntimeException */ protected function addLibraryDependency(string $name, bool $optional = false): void { $depLib = $this->builder->getLib($name); if (!$depLib) { if (!$optional) { throw new RuntimeException("extension {$this->name} requires library {$name}"); } logger()->info("enabling {$this->name} without library {$name}"); } else { $this->dependencies[] = $depLib; } } /** * @throws RuntimeException */ protected function addExtensionDependency(string $name, bool $optional = false): void { $depExt = $this->builder->getExt($name); if (!$depExt) { if (!$optional) { throw new RuntimeException("{$this->name} requires extension {$name}"); } logger()->info("enabling {$this->name} without extension {$name}"); } else { $this->dependencies[] = $depExt; } } /** * Get required static and shared libraries as a pair of strings in format -l{libname} -l{libname2} * * @return array [staticLibString, sharedLibString] */ protected function getStaticAndSharedLibs(): array { $config = (new SPCConfigUtil($this->builder))->config([$this->getName()], with_dependencies: true); $sharedLibString = ''; $staticLibString = ''; $staticLibs = $this->getLibFilesString(); $staticLibs = str_replace([BUILD_LIB_PATH . '/lib', '.a'], ['-l', ''], $staticLibs); $staticLibs = explode('-l', $staticLibs . ' ' . $config['libs']); foreach ($staticLibs as $lib) { $lib = trim($lib); if ($lib === '') { continue; } $static_lib = 'lib' . $lib . '.a'; if (file_exists(BUILD_LIB_PATH . '/' . $static_lib) && !str_contains($static_lib, 'libphp')) { if (!str_contains($staticLibString, '-l' . $lib . ' ')) { $staticLibString .= '-l' . $lib . ' '; } } elseif (!str_contains($sharedLibString, '-l' . $lib . ' ')) { $sharedLibString .= '-l' . $lib . ' '; } } return [trim($staticLibString), trim($sharedLibString)]; } protected function getExtraEnv(): array { return []; } private function getLibraryDependencies(bool $recursive = false): array { $ret = array_filter($this->dependencies, fn ($x) => $x instanceof LibraryBase); if (!$recursive) { return $ret; } $deps = []; $added = 1; while ($added !== 0) { $added = 0; foreach ($ret as $depName => $dep) { foreach ($dep->getDependencies(true) as $depdepName => $depdep) { if (!in_array($depdepName, array_keys($deps), true)) { $deps[$depdepName] = $depdep; ++$added; } } if (!in_array($depName, array_keys($deps), true)) { $deps[$depName] = $dep; } } } if (array_key_exists(0, $deps)) { $zero = [0 => $deps[0]]; unset($deps[0]); return $zero + $deps; } return $deps; } }