TypePHP 编译器 https://swoole.com/aot/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

1397 lines
50 KiB

<?php
/**
* This file is part of Swoole-Compiler(AOT).
*
* @link https://www.swoole.com/
* @contact service@swoole.com
*/
namespace PhpAot\Php;
use MJS\TopSort\Implementations\StringSort;
use PhpAot\Php\Entity\ClassDef;
use PhpAot\Php\Entity\ClassLikeDef;
use PhpAot\Php\Entity\ConstantDef;
use PhpAot\Php\Entity\FunctionDef;
use PhpAot\Php\Entity\InterfaceDef;
use PhpAot\Php\Entity\MethodDef;
use PhpAot\Php\Entity\PropertyDef;
use PhpAot\Php\Exception\Redo;
use PhpAot\Php\Exception\Unsupported;
use PhpParser\Modifiers;
use PhpParser\Node;
use PhpParser\Node\Stmt\Foreach_;
use PhpParser\NodeTraverser;
use Symfony\Component\Yaml\Yaml;
class Translator extends Preprocessor
{
protected string $targetName = 'app';
protected array $sourceDirs = [];
protected bool $verbose = false;
protected array $phpSrcFiles = [];
protected array $argInfoHeaderFiles = [];
protected array $registerSymbols = [];
// 类静态属性初始值
protected array $defaultStaticPropertyList = [];
// 类属性初始值
protected array $defaultPropertyList = [];
protected bool $useRegisterSymbolsFn = false;
public function __construct(string $rootPath)
{
parent::__construct($rootPath);
$this->climate->arguments->add(require __DIR__ . '/../config/compiler_options.php');
$this->preprocessArgvAdvanced();
$this->climate->arguments->parse();
$this->optimizeLevel = $this->climate->arguments->get('optimize');
$this->buildMode = $this->climate->arguments->get('mode');
$this->debugLine = intval($this->climate->arguments->get('debug-line'));
$this->maxJob = intval($this->climate->arguments->get('job'));
$this->debugInfo = $this->climate->arguments->defined('debug-info');
$this->noLiteralStrings = $this->climate->arguments->get('noLiteralStrings');
$this->enableProfiler = $this->climate->arguments->defined('profile');
$this->internalFunctions = array_flip(get_defined_functions()['internal']);
if ($this->climate->arguments->defined('help')) {
$this->showUsage();
exit(0);
}
}
public function showUsage(): void
{
$climate = $this->climate;
$climate->bold()->green('PHP AOT Compiler v1.0.0');
$climate->br();
$climate->bold('USAGE:');
$climate->tab()->out('./bin/compiler.php <file/dir> [options]');
$climate->br();
$climate->bold('ARGUMENTS:');
$climate->tab()->out('<file> Input PHP file/directory to compile');
$climate->br();
$climate->bold('OPTIONS:');
$climate->tab()->out('-O <level> Optimization level (0-3, default: 0)');
$climate->tab()->out('-p, --profile Enable performance profiling');
$climate->tab()->out('-o, --output <file> Output binary name (default: input basename)');
$climate->tab()->out('-v, --verbose Verbose output');
$climate->tab()->out('-h, --help Show this help message');
$climate->tab()->out('-f, --force Force compile even if cache exists');
$climate->tab()->out('-m, --mode <mode> Compilation mode, -m bin(binary) or -m ext(extension), default: bin');
$climate->tab()->out('-j, --job <num> Number of parallel compilation jobs (default: 4)');
$climate->tab()->out('--no-literal-strings Disable literal strings optimization');
$climate->br();
$climate->bold('EXAMPLES:');
$climate->tab()->out('./bin/compiler.php examples/hello.php');
$climate->tab()->out('./bin/compiler.php examples/bench.php -O2');
$climate->tab()->out('./bin/compiler.php examples/bench.php -O2 ');
$climate->tab()->out('./bin/compiler.php examples/extension -O2 -o myapp -m ext');
$climate->tab()->out('./bin/compiler.php examples/app.php -O3 -o myapp -v');
$climate->br();
}
public function convert(string $file): string
{
$file = realpath($file);
if ($this->hasCppFileCache($file)) {
$this->climate->darkGray('skip: ' . $file . ', cache exists');
return $this->getCppFile($file);
}
$phpCode = $this->loadFile($file);
$this->genStubFile($this->file);
$this->localHeaders = [];
while (true) {
try {
$cppCode = $this->doConvert($phpCode);
$cppFile = $this->getCppFile($file);
$this->save($cppCode, $cppFile);
$this->phpSrcFiles[] = $file;
return $cppFile;
} catch (Redo $e) {
continue;
}
}
}
public function getRegisterClassFunctionArgs(ClassDef|InterfaceDef $classDef): string
{
return implode(', ', $this->getRegisterClassFunctionCeList($classDef));
}
public function setTargetName(string $name): void
{
if ($this->climate->arguments->defined('output')) {
$name = $this->climate->arguments->get('output');
}
$name = str_replace(['-', '*'], '_', $name);
if (!preg_match('/^[a-zA-Z0-9_]+$/', $name)) {
$this->climate->red('The target name `' . $name . '` must be a valid identifier');
exit(1);
}
if (in_array($name, Constants::CPP_RESERVED_NAMES)) {
$this->climate->red('The target name `' . $name . '` must not be a reserved keyword');
exit(1);
}
$realTargetPath = $this->rootPath . '/' . $name;
if (is_dir($realTargetPath)) {
$this->climate->red('The target name `' . $name . '` must not be a directory');
exit(1);
}
$this->targetName = $name;
}
public function addFiles(array $files): void
{
$this->sourceDirs = array_merge($this->sourceDirs, $files);
}
public function getFiles(string $path): array
{
$realpath = realpath($path);
if ($realpath === false) {
exit("path not exists: {$path}\n");
}
$path = $realpath;
if (is_dir($path)) {
$list = $this->getFilesFromDir($path);
$targetName = basename($path);
$this->setTargetName($targetName);
$this->sourceDirs[] = $path;
} else {
$ext = pathinfo($path, PATHINFO_EXTENSION);
if ($ext === 'yml') {
$list = $this->parseProjectYaml($path);
} elseif ($ext === 'php') {
$list = [$path];
$targetName = FileScanner::getFileName($path);
$this->setTargetName($targetName);
$this->sourceDirs[] = dirname($path);
} else {
$this->error('Unsupported file type: ' . $path);
}
}
return $list;
}
public function preprocessArgvAdvanced(): void
{
global $argv;
$processed = [$argv[0]];
for ($i = 1; $i < count($argv); $i++) {
$arg = $argv[$i];
if (preg_match('/^-([a-zA-Z])(.+)$/', $arg, $matches)) {
$option = $matches[1];
$value = $matches[2];
$processed[] = "-{$option}";
$processed[] = $value;
} elseif (preg_match('/^-([a-zA-Z]{2,})$/', $arg, $matches)) {
$options = str_split($matches[1]);
foreach ($options as $opt) {
$processed[] = "-{$opt}";
}
} else {
$processed[] = $arg;
}
}
$argv = $processed;
}
public function genExternGlobalVars(string $file): void
{
$lines[] = '#include <phpx.h>';
$lines[] = PHP_EOL;
foreach ($this->globalVars as $name => $type) {
$lines[] = 'extern ' . self::TYPE_VAR . ' ' . $name . ';';
}
$literalStringsCount = count($this->literalStrings);
$lines[] = 'extern ' . self::TYPE_STR . ' ' . self::LITERAL_STRINGS . '[' . $literalStringsCount . '];' . PHP_EOL;
$classCount = count($this->classMap);
$lines[] = 'extern zend_class_entry *' . self::PREFIX . self::CLASS_MAP . '[' . $classCount . '];' . PHP_EOL;
$funcCount = count($this->funcMap);
$lines[] = 'extern zend_function *' . self::PREFIX . self::FUNC_MAP . '[' . $funcCount . '];' . PHP_EOL;
$propCount = count($this->propMap);
$lines[] = 'extern uint32_t ' . self::PREFIX . self::PROP_MAP . '[' . $propCount . '];' . PHP_EOL;
foreach ($this->classes as $classDef) {
foreach ($classDef->constants as $constant) {
if ($constant->type === self::TYPE_ARRAY) {
$constName = self::PREFIX . $this->getNativeName($constant->name, $classDef->namespace, $classDef->name);
$lines[] = 'extern ' . self::TYPE_VAR . ' ' . $constName . ';' . PHP_EOL;
}
}
}
$code = implode(PHP_EOL, $lines) . PHP_EOL . PHP_EOL;
$this->writeFile($file, $code);
}
public function genExtension(string $file): void
{
if ($this->buildMode == 'bin') {
if (!$this->hasFunction('main')) {
$this->climate->red('When the build mode is a binary executable file, the `main()` function must be defined');
exit(1);
}
}
$this->localHeaders = $this->argInfoHeaderFiles;
$this->genClassCeList();
$code = $this->render('extension.cc.php');
$this->writeFile($file, $code);
$this->formatCppCode($file);
$this->localHeaders = [];
}
public function getModuleName(): string
{
if (ctype_digit($this->targetName[0])) {
return 'app_' . $this->targetName;
}
$extensions = get_loaded_extensions();
if (in_array($this->targetName, $extensions)) {
return $this->targetName . '_';
}
return $this->targetName;
}
public function hasObjectFileCache(string $cppFile): bool
{
if (!$this->enableCache or $this->climate->arguments->defined('force')) {
return false;
}
$objectFile = $this->getObjectFile($cppFile);
if (file_exists($objectFile) and filemtime($objectFile) > filemtime($cppFile)) {
return true;
}
return false;
}
public function compileFile(string $cppFile, string $objectFile, bool $parallel = false): void
{
if ($this->hasObjectFileCache($cppFile)) {
if (!$parallel) {
$this->climate->darkGray('skip: ' . $cppFile . ', cache exists');
}
return;
}
$cmd = $this->cppCompiler . ' -c ' . $cppFile . ' -o ' . $objectFile;
$this->addCompilationOption($cmd, false);
if (!$parallel) {
$this->climate->comment($cmd);
}
// 在并行模式下,抑制 passthru 的输出
if ($parallel) {
exec($cmd . ' 2>&1', $output, $ret);
} else {
passthru($cmd, $ret);
}
if ($ret !== 0) {
if ($parallel && !empty($output)) {
foreach ($output as $line) {
$this->climate->red($line);
}
}
$this->error('compile failed: ' . $cppFile);
}
}
public function compile(array $sourceFiles): array
{
$objectFiles = [];
$job = $this->maxJob;
// 如果只有一个文件或 job 为 1,则串行编译
if (count($sourceFiles) <= 1 || $job <= 1) {
foreach ($sourceFiles as $cppFile) {
$objectFile = $this->getObjectFile($cppFile);
$this->compileFile($cppFile, $objectFile);
if (!is_file($objectFile)) {
throw new \Exception('compile error');
}
$objectFiles[] = $objectFile;
}
return $objectFiles;
}
// 并行编译
$totalFiles = count($sourceFiles);
$runningProcesses = 0;
$processPipes = [];
$fileQueue = $sourceFiles;
$compiledCount = 0;
$failedFiles = [];
$this->climate->blue("Starting parallel compilation with {$job} jobs for {$totalFiles} files");
while ($compiledCount < $totalFiles) {
// 启动新进程,直到达到最大并发数
while ($runningProcesses < $job && !empty($fileQueue)) {
$cppFile = array_shift($fileQueue);
$objectFile = $this->getObjectFile($cppFile);
$pid = pcntl_fork();
if ($pid == -1) {
throw new \Exception('Failed to fork process');
}
if ($pid === 0) {
// 子进程:执行编译
try {
$this->compileFile($cppFile, $objectFile, true);
if (!is_file($objectFile)) {
exit(1);
}
exit(0);
} catch (\Throwable $e) {
// 在子进程中不抛出异常,直接退出
exit(1);
}
} else {
// 父进程:记录子进程
$processPipes[$pid] = ['file' => $cppFile, 'object' => $objectFile];
$runningProcesses++;
}
}
// 等待任意一个子进程完成
if ($runningProcesses > 0) {
$pid = pcntl_wait($status);
if ($pid > 0) {
$processInfo = $processPipes[$pid] ?? null;
unset($processPipes[$pid]);
$runningProcesses--;
$exitCode = pcntl_wexitstatus($status);
if ($exitCode !== 0) {
$failedFile = $processInfo['file'] ?? 'unknown';
$this->climate->red("Compilation failed: {$failedFile}");
$failedFiles[] = $failedFile;
} else {
if ($processInfo) {
$objectFiles[] = $processInfo['object'];
}
}
$compiledCount++;
}
}
}
// 确保所有子进程都已结束
while ($runningProcesses > 0) {
$pid = pcntl_wait($status);
if ($pid > 0) {
unset($processPipes[$pid]);
$runningProcesses--;
$compiledCount++;
}
}
if (!empty($failedFiles)) {
throw new \Exception('Compilation failed for: ' . implode(', ', $failedFiles));
}
$this->climate->green("Successfully compiled {$totalFiles} files");
return $objectFiles;
}
public function output(string $message, string $style = 'out'): void
{
$this->climate->{$style}($message);
}
public function build(array $objectFiles): void
{
$objectList = implode(' ', $objectFiles);
$targetFile = $this->targetName;
if ($this->buildMode == 'ext' and !str_ends_with($targetFile, '.so')) {
$targetFile .= '.so';
}
$linkCmd = $this->cppCompiler . ' ' . $objectList . ' -o ' . $targetFile;
$this->addCompilationOption($linkCmd, true);
$this->climate->comment($linkCmd);
shell_exec($linkCmd);
}
public function genFunctionDeclaration(string $file): void
{
$code = '#include <phpx.h>' . PHP_EOL;
// 函数的默认值可能会使用字符串字面量,需要提前声明
$literalStringsCount = count($this->literalStrings);
$code .= 'extern ' . self::TYPE_STR . ' ' . self::LITERAL_STRINGS . '[' . $literalStringsCount . '];' . PHP_EOL;
foreach ($this->functions as $name => $func) {
$code .= 'extern ' . $func->returnType . ' ' . self::PREFIX . $name . '(';
$list = [];
if ($func->method) {
$list[] = 'php::Object &this_';
}
$argInfoList = $func->argInfoList;
if ($argInfoList) {
foreach ($argInfoList as $argInfo) {
if ($argInfo->variadic) {
$arg = self::TYPE_ARRAY . ' ' . $argInfo->name . ' = {}';
} else {
$arg = $argInfo->type . ' ' . $argInfo->name;
if ($argInfo->default) {
$arg .= ' = ' . $argInfo->default;
}
}
$list[] = $arg;
}
}
$code .= implode(', ', $list);
$code .= ');' . PHP_EOL;
}
$code .= PHP_EOL;
foreach ($this->constants as $name => $constant) {
$code .= 'extern ' . $constant->type . ' ' . $name . ';' . PHP_EOL;
}
$this->writeFile($file, $code);
}
public function getBuildMode(): string
{
return $this->buildMode;
}
public function getArgInfoStubFilename(string $stubFile): string
{
$rs = str_replace(['.stub.php', '.php'], '', $stubFile);
return str_replace('-', '_', $rs);
}
public function getArgInfoHeaderFile(string $stubFilenameWithoutExtension, bool $relative = false): string
{
foreach ($this->sourceDirs as $srcDir) {
if (!is_dir($srcDir) or str_starts_with($stubFilenameWithoutExtension, $srcDir)) {
$filePath = ltrim($this->removeCommonPrefix($srcDir, $stubFilenameWithoutExtension), '/');
break;
}
}
$filename = self::PREFIX . str_replace('/', '_', $filePath);
$filename = $this->escapeFileName($filename);
$absPath = $this->getIncludeDir() . "/{$filename}_arginfo.h";
if ($relative) {
return ltrim($this->removeCommonPrefix($this->getIncludeDir(), $absPath), '/');
}
return $absPath;
}
public function genIncludeHeaderFiles(): string
{
$headers = array_merge($this->globalHeaders, $this->localHeaders);
$lines = [];
foreach ($headers as $header) {
$lines[] = '#include <' . $header . '>';
}
return implode(PHP_EOL, $lines) . PHP_EOL . PHP_EOL;
}
public function genClassPropertyInit(): string
{
$code = '';
foreach ($this->classCeList as $ce) {
$info = $this->classCeInfo[$ce] ?? $this->getInternalCeInfo($ce);
$code .= "{$ce} = {$info['func']}({$info['args']});\n";
$classDef = !empty($info['classDef']) ? $info['classDef'] : null;
/**
* @var ClassDef $classDef
*/
if ($classDef and $classDef->requireCtor) {
$className = $classDef->getNamespacedName();
$code .= "create_object_{$className} = php_get_create_object_fn({$ce});\n";
$code .= "{$ce}->create_object = [](zend_class_entry *class_type) -> zend_object* {\n";
$code .= "auto obj = create_object_{$className}(class_type);\n";
foreach ($classDef->properties as $property) {
$fullPropName = $classDef->getNamespacedName() . '::' . $property->name;
if (isset($this->defaultPropertyList[$fullPropName])) {
$code .= "auto value = {$this->defaultPropertyList[$fullPropName]};\n";
$code .= 'zend_update_property_ex(obj->ce, obj, ' . $this->getLiteralString($property->name) . ".str(), value.ptr());\n";
}
}
$code .= "return obj;\n};\n";
}
}
return $code;
}
protected function getRegisterClassFunction(string $name): string
{
return self::PREFIX . 'register_class_' . $name;
}
protected function getRegisterClassFunctionCeList(ClassDef|InterfaceDef $classDef): array
{
$list = [];
$parentCe = $this->getParentClassCe($classDef);
if ($parentCe !== '') {
$list = [$parentCe];
}
// interface 没有 implements
if ($classDef instanceof InterfaceDef) {
return $list;
}
$implements = $this->getImplementCe($classDef);
return array_merge($list, $implements);
}
protected function getClassCe(ClassLikeDef $classDef): string
{
return self::PREFIX . 'class_entry_' . $this->escapeCeName($classDef->getNamespacedName());
}
protected function getFilesFromDir(string $path): array
{
$scanner = new FileScanner($path);
return $scanner->scan();
}
protected function genClassArrayConstants(): string
{
$code = '';
foreach ($this->classes as $classDef) {
foreach ($classDef->constants as $constant) {
if ($constant->type === self::TYPE_ARRAY) {
$constName = self::PREFIX . $this->getNativeName($constant->name, $classDef->namespace, $classDef->name);
$code .= "do {\n";
$code .= $constant->arrayExpr;
$code .= $constName . ' = ' . $constant->value . ";\n";
$code .= "} while(0);\n";
}
}
}
return $code;
}
protected function parseProjectYaml(string $path): array
{
$cfg = Yaml::parseFile($path);
$projectDir = dirname($path);
if (!empty($cfg['sources'])) {
$sources = $cfg['sources'];
$list = [];
foreach ($sources as $src) {
$src = trim($src);
if ($src[0] != '/') {
$absPath = $projectDir . '/' . $src;
} else {
$absPath = $src;
}
$realPath = realpath($absPath);
if (!$realPath) {
$this->error('Source file not exists: `' . $src . '`');
}
if (is_file($realPath)) {
$list[] = $realPath;
$this->sourceDirs[] = basename($realPath);
} else {
$tmp = $this->getFilesFromDir($realPath);
$list = array_merge($list, $tmp);
$this->sourceDirs[] = $realPath;
}
}
} else {
$list = $this->getFilesFromDir($projectDir);
}
if (!empty($cfg['cxxflags'])) {
if (is_array($cfg['cxxflags'])) {
$this->cxxflags = implode(' ', $cfg['cxxflags']);
} else {
$this->cxxflags = str_replace("\n", ' ', $cfg['cxxflags']);
}
}
if (!empty($cfg['ldflags'])) {
if (is_array($cfg['ldflags'])) {
$this->ldflags = implode(' ', $cfg['ldflags']);
} else {
$this->ldflags = str_replace("\n", ' ', $cfg['ldflags']);
}
}
if (!empty($cfg['name'])) {
$this->setTargetName($cfg['name']);
}
return $list;
}
protected function getInternalCeInfo(string $ce): array
{
return [
'func' => 'php::getClassEntry',
'args' => '"' . substr($ce, strlen(self::PREFIX . 'class_entry_')) . '"',
];
}
protected function getParentClassCe(ClassLikeDef $classDef): string
{
if (!$classDef->extends) {
return '';
}
return self::PREFIX . 'class_entry_' . $this->escapeCeName($classDef->extends);
}
protected function doConvert(string $phpCode): string
{
$this->climate->info('convert: ' . $this->file);
$ast = $this->parser->parse($phpCode);
$traverser = new NodeTraverser();
$traverser->addVisitor(new Visitor());
$stmts = $traverser->traverse($ast);
$this->resetFile();
$this->resetFunction();
$this->resetClass();
$this->resetNamespace();
$cppCode = '';
foreach ($stmts as $v) {
$type = $v->getType();
switch ($type) {
case 'Stmt_Declare':
$this->parseDeclare($v);
break;
case 'Stmt_Namespace':
$cppCode .= $this->parseNamespace($v);
break;
case 'Stmt_Class':
case 'Stmt_Trait':
case 'Stmt_Enum':
$cppCode .= $this->parseClass($v);
break;
case 'Stmt_Use':
$cppCode .= $this->parseUse($v) . PHP_EOL;
break;
case 'Stmt_Function':
$cppCode .= $this->parseFunction($v) . PHP_EOL;
break;
case 'Stmt_Const':
$this->parseConstDef($v) . PHP_EOL;
break;
case 'Stmt_Interface':
$this->parseInterface($v) . PHP_EOL;
break;
case 'Stmt_Nop':
break;
default:
abort($v);
}
}
foreach ($this->classesDefineInFile as $classDef) {
$cppCode .= $this->genClassWrapper($classDef);
}
foreach ($this->interfacesDefineInFile as $interfaceDef) {
$cppCode .= $this->genClassWrapper($interfaceDef);
}
foreach ($this->functionDefineInFile as $functionDef) {
$cppCode .= $this->genFunctionWrapper($functionDef);
}
$constDataCode = '';
foreach ($this->constData as $name => $data) {
$constDataCode .= 'static const unsigned char ' . $name . '[] = {' . $data . '};' . PHP_EOL;
}
$constDataCode .= PHP_EOL;
return $this->genIncludeHeaderFiles() . $constDataCode . $cppCode;
}
protected function genClassCeList(): void
{
if (empty($this->interfaces) and empty($this->classes)) {
return;
}
$sorter = new StringSort();
foreach ($this->interfaces as $interfaceDef) {
$parent = $interfaceDef->extends;
$ce = $this->getClassCe($interfaceDef);
$deps = [];
if ($parent) {
// 不存在的接口,说明可能是内置接口
$tmpCe = $this->getParentClassCe($interfaceDef);
if (!isset($this->interfaces[$parent])) {
$sorter->add($tmpCe);
}
$deps[] = $tmpCe;
}
$this->classCeInfo[$ce] = [
'deps' => $deps,
'func' => $this->getRegisterClassFunction($interfaceDef->getNamespacedName()),
'args' => $this->getRegisterClassFunctionArgs($interfaceDef),
'argDef' => $this->getRegisterClassFunctionArgDef($interfaceDef),
];
$sorter->add($ce, $deps);
}
foreach ($this->classes as $classDef) {
$ce = $this->getClassCe($classDef);
$deps = [];
$parent = $classDef->extends;
if ($parent) {
// 不存在的父类,说明可能是内置类
$tmpCe = $this->getParentClassCe($classDef);
if (!isset($this->classes[$parent])) {
$sorter->add($tmpCe);
}
$deps[] = $tmpCe;
}
$implements = $classDef->implements;
if ($implements) {
foreach ($implements as $interface) {
$tmpCe = self::PREFIX . 'class_entry_' . $this->escapeCeName($interface);
if (!isset($this->interfaces[$interface])) {
$sorter->add($tmpCe);
}
$deps[] = $tmpCe;
}
}
$this->classCeInfo[$ce] = [
'classDef' => $classDef,
'deps' => $deps,
'func' => $this->getRegisterClassFunction($classDef->getNamespacedName()),
'args' => $this->getRegisterClassFunctionArgs($classDef),
'argDef' => $this->getRegisterClassFunctionArgDef($classDef),
];
$sorter->add($ce, $deps);
}
$this->classCeList = $sorter->sort();
}
protected function getMethodName(Node\Stmt\ClassMethod $v): string
{
return $this->parseIdentifier($v->name);
}
protected function getNativeMethodName(ClassDef $classDef, MethodDef $methodDef): string
{
return $this->getNativeName($methodDef->name, $classDef->namespace, $classDef->name);
}
protected function parseNamespace(Node\Stmt\Namespace_ $node): string
{
$ns = $node->name ? $this->parseIdentifier($node->name) : '';
$code = '';
$this->resetNamespace();
$this->namespace = $ns;
$ns_end = '';
foreach ($node->stmts as $v2) {
$type2 = $v2->getType();
switch ($type2) {
case 'Stmt_Class':
$code .= $this->parseClass($v2);
break;
case 'Stmt_Const':
$this->parseConstDef($v2) . PHP_EOL;
break;
case 'Stmt_Function':
$code .= $this->parseFunction($v2) . PHP_EOL;
break;
case 'Stmt_Use':
$code .= $this->parseUse($v2) . PHP_EOL;
break;
case 'Stmt_Interface':
$code .= $this->parseInterface($v2) . PHP_EOL;
break;
case 'Stmt_Trait':
$code .= $this->parseTrait($v2) . PHP_EOL;
break;
default:
abort($v2);
}
}
$code .= $ns_end;
$this->resetNamespace();
return $code;
}
protected function genStubFile(string $file): void
{
$stubFilenameWithoutExtension = str_replace(['.stub.php', '.php'], '', $file);
$headerFile = $this->getArgInfoHeaderFile($stubFilenameWithoutExtension, true);
$genStubCmd = PHP_BINARY . ' ' . $this->rootPath . '/bin/gen_stub.php -f -o ' . $this->getIncludeDir() . '/' . $headerFile . ' ' . $file;
$output = shell_exec($genStubCmd);
$this->climate->info('generate stub file: ' . $file);
$this->climate->comment($genStubCmd);
if (!str_contains($output, 'Saved')) {
$this->error("failed to generate arginfo header file: `{$headerFile}`, output: {$output}");
}
if ($this->useRegisterSymbolsFn) {
preg_match('/php_(.*)_arginfo.h/', $headerFile, $matches);
$registerSymbolFn = 'register_' . $matches[1] . '_symbols';
$registerSymbol = PHP_EOL . 'static void ' . $registerSymbolFn . '(int module_number)' . PHP_EOL;
if (str_contains(file_get_contents($this->getBuildDir() . '/include/' . $headerFile), $registerSymbol)) {
$this->registerSymbols[] = $registerSymbolFn;
}
}
$this->argInfoHeaderFiles[] = $headerFile;
}
protected function parseClass(Node\Stmt\Class_|Node\Stmt\Trait_|Node\Stmt\Enum_ $class): string
{
$this->class = $this->parseIdentifier($class->name);
if ($class instanceof Node\Stmt\Enum_) {
$flags = Modifiers::PUBLIC;
$extends = '';
} else {
$flags = $class->flags;
$extends = $class->extends;
}
$fullName = $this->getFullClassName();
if ($this->hasClass($fullName)) {
$this->classDef = $this->getClass($fullName);
} else {
$this->classDef = new ClassDef($this->class, $flags, $this->namespace);
$this->addClass($fullName, $this->classDef);
}
if ($class instanceof Node\Stmt\Enum_) {
$this->classDef->enum = true;
}
if ($extends) {
$parentClass = $this->getParentClass($class->extends);
if ($this->hasClass($parentClass)) {
$parent = $this->getClass($parentClass);
if ($parent->flags & Modifiers::FINAL) {
$this->fatalError($class, "Class `{$this->class}` cannot extend final class `{$parentClass}`");
}
$this->classDef->extends = $parentClass;
$this->classDef->inheritedFromInternalClass = false;
} else {
if (Reflection::isInternalClass($parentClass)) {
$this->classDef->extends = $parentClass;
$this->classDef->inheritedFromInternalClass = true;
} else {
$this->fatalError($class, "Class `{$this->class}` inherits from a non-existent class `{$parentClass}`");
}
}
}
$this->classDef->implements = $this->parseIdentifierList($class->implements);
$className = $this->classDef->getNamespacedName();
$this->classesDefineInFile[$className] = $this->classDef;
$methodCodes = [];
foreach ($class->stmts as $v) {
$type = $v->getType();
switch ($type) {
case 'Stmt_ClassConst':
$this->parseClassConstDef($v);
break;
case 'Stmt_Property':
$this->parsePropertyDef($v);
break;
case 'Stmt_ClassMethod':
$this->parseClassMethod($v, $methodCodes);
break;
case 'Stmt_EnumCase':
case 'Stmt_Nop':
break;
default:
abort($v);
}
}
$code = $this->genNativeMethod($methodCodes);
$this->resetClass();
return $code;
}
protected function genNativeMethod(array $methodCodes): string
{
$code = '';
$classDef = $this->classDef;
foreach ($classDef->methods as $method) {
$code .= $methodCodes[$method->name] . PHP_EOL;
}
$code .= PHP_EOL;
return $code;
}
protected function genWrapperFunctionArgs(string $fn, FunctionDef $functionDef): string
{
$cppCode = '';
$callParams = '';
foreach ($functionDef->argInfoList as $k => $argInfo) {
$var = 'arg_' . $argInfo->name;
if ($argInfo->variadic) {
$cppCode .= $this->getIndent() . self::TYPE_ARRAY . ' ' . $var . ';' . PHP_EOL;
$cppCode .= $this->getIndent() . 'for (uint32_t i = ' . $k . '; i < php::getCallArgNum(); i++) {' . PHP_EOL;
$this->indentLevel++;
$cppCode .= $this->getIndent() . $var . '.append(php::getCallArg(i));' . PHP_EOL;
$this->indentLevel--;
$cppCode .= '}' . PHP_EOL;
} else {
if ($argInfo->default) {
if ($argInfo->byRef) {
$argExpr = 'php::getCallArgByRef(' . $k . ', ' . $argInfo->default . ')';
} else {
$argExpr = 'php::getCallArg(' . $k . ', ' . $argInfo->default . ')';
}
} else {
if ($argInfo->byRef) {
$argExpr = 'php::getCallArgByRef(' . $k . ')';
} elseif ($argInfo->nullable) {
$argExpr = 'php::getCallArg(' . $k . ', php::null)';
} else {
$argExpr = 'php::getCallArg(' . $k . ')';
}
}
$expr = $this->convertExprFromType($argInfo->type, $argExpr);
$cppCode .= $this->getIndent() . $argInfo->type . ' ' . $var . ' = ' . $expr . ';' . PHP_EOL;
}
$callParams .= 'arg_' . $argInfo->name . ',';
}
if ($functionDef->method) {
$callParams = $functionDef->argInfoList ? 'this_, ' . rtrim($callParams, ',') : 'this_';
} else {
$callParams = $functionDef->argInfoList ? rtrim($callParams, ',') : '';
}
if ($functionDef->returnType !== self::TYPE_VOID) {
$cppCode .= $this->getIndent() . 'auto retval = ' . $fn . '(' . $callParams . ');' . PHP_EOL;
$cppCode .= $this->getIndent() . 'php::move(retval, return_value);' . PHP_EOL;
} else {
$cppCode .= $this->getIndent() . $fn . '(' . $callParams . ');' . PHP_EOL;
}
$cppCode .= '}' . PHP_EOL . PHP_EOL;
return $cppCode;
}
protected function genMethodWrapper(ClassDef $classDef, MethodDef $methodDef): string
{
$name = $classDef->getNamespacedName();
$cppCode = 'ZEND_METHOD(' . $name . ', ' . $methodDef->name . '){' . PHP_EOL;
$cppCode .= $this->getIndent() . self::TYPE_OBJECT . ' this_(&execute_data->This);' . PHP_EOL;
$fn = self::PREFIX . $this->getNativeMethodName($classDef, $methodDef);
$cppCode .= $this->genWrapperFunctionArgs($fn, $methodDef->functionDef);
return $cppCode;
}
protected function getClassRegisterCeFunc(ClassDef|InterfaceDef $classDef): string
{
$cppCode = '';
$name = $classDef->getNamespacedName();
$argsDef = $this->getRegisterClassFunctionArgDef($classDef);
$param = $this->getRegisterClassFunctionArgs($classDef);
$cppCode .= 'zend_class_entry *' . $this->getRegisterClassFunction($name) . '(' . $argsDef . ') {' . PHP_EOL;
$cppCode .= $this->getIndent() . 'return register_class_' . $name . '(' . $param . ');' . PHP_EOL;
$cppCode .= '}' . PHP_EOL . PHP_EOL;
return $cppCode;
}
protected function genClassWrapper(ClassDef|InterfaceDef $classDef): string
{
$cppCode = '';
// 接口没有方法实体
if ($classDef instanceof ClassDef) {
$arrayPropCount = 0;
foreach ($classDef->properties as $property) {
if ($property->type === self::TYPE_ARRAY and $property->default and $property->default !== self::TYPE_ARRAY . '{}') {
$fullClassName = $classDef->getNamespacedName(false);
$fullPropName = $fullClassName . '::' . $property->name;
if ($property->isStatic()) {
$prop = new \stdClass();
$prop->class = $fullClassName;
$prop->name = $property->name;
$prop->default = $property->default;
$this->defaultStaticPropertyList[$fullPropName] = $prop;
} else {
$this->defaultPropertyList[$fullPropName] = $property->default;
$arrayPropCount++;
}
}
}
if ($arrayPropCount > 0) {
$classDef->requireCtor = true;
}
$methods = $classDef->methods;
foreach ($methods as $methodDef) {
$cppCode .= $this->genMethodWrapper($classDef, $methodDef);
}
}
return $cppCode;
}
/**
* @param array<ConstantDef> $list
*/
protected function genClassConstantList(array $list): string
{
$code = '';
foreach ($list as $const) {
$code .= $this->getIndent() . $this->genClassConstant($const);
}
return $code;
}
protected function genClassConstant(ConstantDef $const): string
{
return 'static const ' . $const->type . ' ' . $const->name . ';' . PHP_EOL;
}
/**
* @param array<PropertyDef> $list
*/
protected function genClassPropertyList(array $list): string
{
$code = '';
foreach ($list as $prop) {
$code .= $this->getIndent() . $this->genClassProperty($prop);
}
return $code;
}
protected function genClassProperty(PropertyDef $prop): string
{
$code = $prop->type . ' ' . $prop->name;
if ($prop->default !== null) {
$code .= ' = ' . $prop->default;
}
return $code . ';' . PHP_EOL;
}
protected function genFunction(string $name, string $returnType, array $args = [], array $lines = []): string
{
$_args = [];
foreach ($args as $arg => $type) {
$_args[] = $type . ' ' . $arg;
}
$code = $returnType . ' ' . $name . '(' . implode(', ', $_args) . ') {' . PHP_EOL;
$code .= implode(PHP_EOL, $lines) . PHP_EOL;
$code .= '}' . PHP_EOL;
return $code;
}
protected function parseClassConstDef(Node\Stmt\ClassConst $v): void
{
$this->resetFunction();
$flags = $this->parseModifiers($v->flags);
if ($v->type) {
$type = $this->parseTypeDecl($v->type, self::DECL_TYPE_OF_CONST);
} else {
$type = null;
}
foreach ($v->consts as $const) {
if ($type === null) {
$type = match ($const->value->getType()) {
'Expr_Array' => self::TYPE_ARRAY,
'Scalar_String' => self::TYPE_STR,
default => self::TYPE_VAR,
};
}
$constName = $this->parseIdentifier($const->name);
$constValue = $this->parseIdentifier($const->value);
$arrayExpr = '';
if ($this->context->beforeStmtLines) {
if ($this->context->localVars) {
$arrayExpr .= $this->genLocalVarDecl();
}
$arrayExpr .= $this->parseBeforeStmtLines();
}
$constInfo = new ConstantDef($constName, $flags, $type, $constValue, $arrayExpr);
$this->classDef->constants[$constInfo->name] = $constInfo;
}
}
protected function parsePropertyDef(Node\Stmt\Property $v): void
{
$flags = $this->parseModifiers($v->flags);
$type = $this->parseTypeDecl($v->type, self::DECL_TYPE_OF_PROPERTY);
foreach ($v->props as $prop) {
$propDef = new PropertyDef($this->parseIdentifier($prop->name), $flags, $type);
if ($prop->default) {
if ($prop->default->getType() == 'Expr_Array' and count($prop->default->items) > 0) {
$propDef->type = self::TYPE_ARRAY;
}
$propDef->default = $this->parseIdentifier($prop->default);
}
$this->classDef->properties[$propDef->name] = $propDef;
}
}
protected function parseModifiers(int $flags): int
{
if (!($flags & Modifiers::PRIVATE) and !($flags & Modifiers::PROTECTED)) {
$flags |= Modifiers::PUBLIC;
}
return $flags;
}
protected function parseClassMethod(Node\Stmt\ClassMethod $v, array &$methodCodes): void
{
$name = $this->getMethodName($v);
$this->method = $name;
$flags = $this->parseModifiers($v->flags);
$classDef = $this->classDef;
while (true) {
$extends = $classDef->extends;
if (!$extends) {
break;
}
$classDef = $this->getClass($extends);
if ($classDef->hasMethod($this->method)) {
$methodDef = $classDef->getMethod($this->method);
if ($methodDef->flags & Modifiers::PRIVATE) {
$this->fatalError($v,
'Cannot override private method `' .
$classDef->getNamespacedName(false) . '::' . $this->method . '()`');
}
}
}
if (!($flags & Modifiers::ABSTRACT)) {
$this->methodDef = new MethodDef($flags, $name);
$methodCodes[$name] = $this->parseFunction($v);
$this->checkRequiredArgNum($name, $this->methodDef, $v);
$this->classDef->addMethod($this->methodDef);
}
$this->resetMethod();
}
protected function parseIdentifierList(array $implements): array
{
$list = [];
foreach ($implements as $implement) {
$list[] = $this->getNamespacedClassName($implement);
}
return $list;
}
protected function parseInterface(Node\Stmt\Interface_ $v): void
{
$name = $this->parseIdentifier($v->name);
$this->interface = $name;
$this->interfaceDef = new InterfaceDef($name, $this->namespace);
$interfaceName = $this->interfaceDef->getNamespacedName();
$this->interfaces[$interfaceName] = $this->interfaceDef;
$this->interfacesDefineInFile[$interfaceName] = $this->interfaceDef;
}
protected function parseForeachObject(Foreach_ $node): string
{
$obj = $this->parseIdentifier($node->expr);
$tmpVar = $this->genTmpVarName();
$this->addLocalVar($tmpVar, self::TYPE_OBJECT);
$tmpArrayVar = $this->genTmpVarName();
$this->addLocalVar($tmpArrayVar, self::TYPE_ARRAY);
$code = 'if (' . $obj . '.instanceOf("IteratorAggregate")) {' . PHP_EOL;
$code .= $this->getIndent() . $tmpVar . ' = ' . $obj . '.exec("getIterator");' . PHP_EOL . '}' . PHP_EOL;
$code .= 'else if (' . $obj . '.instanceOf("Iterator")) {' . PHP_EOL;
$code .= $this->getIndent() . $tmpVar . ' = ' . $obj . ';' . PHP_EOL . '}' . PHP_EOL;
$code .= 'if (' . $tmpVar . ') {' . PHP_EOL;
$this->indentLevel++;
$code .= $this->getIndent() . $tmpVar . '.exec("rewind");' . PHP_EOL;
$code .= $this->getIndent() . 'for (;' . $tmpVar . '.exec("valid"); ' . $tmpVar . '.exec("next")) {' . PHP_EOL;
$this->indentLevel++;
$valueVar = $this->parseIdentifier($node->valueVar);
$this->checkVar($node, $valueVar);
$code .= $this->getIndent() . ' ' . $valueVar . ' = ' . $tmpVar . '.exec("current");' . PHP_EOL;
if ($node->keyVar) {
$keyVar = $this->parseIdentifier($node->keyVar);
$this->checkVar($node, $keyVar);
$code .= $this->getIndent() . ' ' . $keyVar . ' = ' . $tmpVar . '.exec("key");' . PHP_EOL;
}
$code .= $this->parseStmts($node->stmts);
$code .= '}' . PHP_EOL;
$this->indentLevel--;
$code .= $this->getIndent() . '} else {' . PHP_EOL;
$code .= $this->getIndent() . $tmpArrayVar . ' = php::call("get_object_vars", {' . $obj . '});' . PHP_EOL;
$code .= $this->parseForeachArray($node, $tmpArrayVar);
$this->indentLevel--;
$code .= '}' . PHP_EOL;
return $code;
}
protected function parseTrait(Node\Stmt\Trait_ $trait)
{
throw new Unsupported('Unsupported Trait ');
}
private function getRegisterClassFunctionArgDef(ClassDef|InterfaceDef $classDef): string
{
$depsCeList = $this->getRegisterClassFunctionCeList($classDef);
if (empty($depsCeList)) {
return '';
}
return 'zend_class_entry *' . implode(', zend_class_entry *', $depsCeList);
}
private function getImplementCe(ClassDef $classDef): array
{
$list = [];
foreach ($classDef->implements as $interface) {
$list[] = self::PREFIX . 'class_entry_' . $this->escapeCeName($interface);
}
return $list;
}
private function render(string $template): string
{
ob_start();
include __DIR__ . '/../template/' . $template;
return ob_get_clean();
}
private function genFunctionWrapper(FunctionDef $functionDef): string
{
$name = $this->escapeZendFnName($functionDef->getNamespacedName());
$cppCode = 'ZEND_FUNCTION(' . $name . '){' . PHP_EOL;
$fn = self::PREFIX . $this->getNativeName($functionDef->name, $functionDef->namespace);
$cppCode .= $this->genWrapperFunctionArgs($fn, $functionDef);
return $cppCode;
}
private function genClassNative(): string
{
$code = 'class ' . $this->class . ' { ';
$publicMethods = [];
$protectedMethods = [];
$privateMethods = [];
$publicConstants = [];
$protectedConstants = [];
$privateConstants = [];
$publicProperties = [];
$protectedProperties = [];
$privateProperties = [];
foreach ($this->classDef->constants as $const) {
if ($const->flags & Modifiers::PUBLIC) {
$publicConstants[] = $const;
}
if ($const->flags & Modifiers::PROTECTED) {
$protectedConstants[] = $const;
}
if ($const->flags & Modifiers::PRIVATE) {
$privateConstants[] = $const;
}
}
foreach ($this->classDef->methods as $method) {
if ($method->flags & Modifiers::PUBLIC) {
$publicMethods[] = $method;
}
if ($method->flags & Modifiers::PROTECTED) {
$protectedMethods[] = $method;
}
if ($method->flags & Modifiers::PRIVATE) {
$privateMethods[] = $method;
}
}
foreach ($this->classDef->properties as $property) {
if ($property->flags & Modifiers::PUBLIC) {
$publicProperties[] = $property;
}
if ($property->flags & Modifiers::PROTECTED) {
$protectedProperties[] = $property;
}
if ($property->flags & Modifiers::PRIVATE) {
$privateProperties[] = $property;
}
}
if ($privateConstants) {
$code .= 'private:' . PHP_EOL;
$code .= $this->genClassConstantList($privateConstants);
}
if ($protectedConstants) {
$code .= 'protected:' . PHP_EOL;
$code .= $this->genClassConstantList($protectedConstants);
}
if ($publicConstants) {
$code .= 'public:' . PHP_EOL;
$code .= $this->genClassConstantList($publicConstants);
}
if ($privateProperties) {
$code .= 'private:' . PHP_EOL;
$code .= $this->genClassPropertyList($privateProperties);
}
if ($protectedProperties) {
$code .= 'protected:' . PHP_EOL;
$code .= $this->genClassPropertyList($protectedProperties);
}
if ($publicProperties) {
$code .= 'public:' . PHP_EOL;
$code .= $this->genClassPropertyList($publicProperties);
}
$code .= '};' . PHP_EOL . PHP_EOL;
return $code;
}
}