php可以做嵌入式吗,PHP内核探索：嵌入式PHP

从PHP源码目录结构的介绍以及PHP生命周期可知，嵌入式PHP类似CLI，也是SAPI接口的另一种实现。一般情况下，它的一个请求的生命周期也会和其它SAPI一样：模块初始化→请求初始化→处理请求→关闭请求→关闭模块。当然，这只是理想情况。因为特定应用有自己特殊的需求，只是在处理PHP脚本这个环节基本一致。

对于嵌入式PHP，很多人可能觉得比较陌生，甚至平时根本用不到。网上相关的资料也不多。打个比方，很多游戏中使用Lua语言作为粘合语言，或者作为扩展游戏的脚本语言；类似的，浏览器中的Ja vaScript语言就是嵌入在浏览器中的。只是目前很少有应用将PHP作为嵌入语言来使用，PHP的强项目前还是在Web开发方面。

那么，PHP为嵌入式提供了哪些接口或功能呢？先来看一下示例源码：

#include 
#ifdef ZTS
void ***tsrm_ls;
#endif

/* Extension bits */
zend_module_entry php_mymod_module_entry = {
    STANDARD_MODULE_HEADER,
    "mymod", /* extension name */
    NULL, /* function entries */
    NULL, /* MINIT */
    NULL, /* MSHUTDOWN */
    NULL, /* RINIT */
    NULL, /* RSHUTDOWN */
    NULL, /* MINFO */
    "1.0", /* version */
    STANDARD_MODULE_PROPERTIES
};

/* Embedded bits */
static void startup_php(void)
{
    int argc = 1;
    char *argv[2] = { "embed5", NULL };
    php_embed_init(argc, argv PTSRMLS_CC);
    zend_startup_module(&php_mymod_module_entry);
}

static void execute_php(char *filename)
{
    zend_first_try {
        char *include_script;
        spprintf(&include_script, 0, "include '%s'", filename);
        zend_eval_string(include_script, NULL, filename TSRMLS_CC);
        efree(include_script);
    } zend_end_try();
}

int main(int argc, char *argv[])
{
    if (argc <= 1) {
        printf("Usage: embed4 scriptfile");
        return -1;
    }
    startup_php();
    execute_php(argv[1]);
    php_embed_shutdown(TSRMLS_CC);
    return 0;
}

以上代码可以在《Extending and Embedding PHP》第20章找到（原始代码有一个符号错误，感兴趣的同学可以去围观一下）。这段代码相当于一个嵌入式PHP运行器，在这个运行器上我们可以运行PHP代码。它包含了对于PHP嵌入式支持的声明、启动嵌入式PHP运行环境、运行PHP代码、关闭嵌入式PHP运行环境。下面我们就这段代码分析PHP对于嵌入式的支持做了哪些工作。

先看第一行：

#include 

在sapi目录下的embed目录是PHP对于嵌入式的抽象层所在。这里包含了我们所需要的函数或宏定义，如示例中使用的php_embed_init、php_embed_shutdown等函数。

第2到4行：

#ifdef ZTS
void ***tsrm_ls;
#endif

ZTS是Zend Thread Safety的简写，与之相关的有一个TSRM（线程安全资源管理）的机制，这个后面的章节会有详细介绍，这里就不再展开。

第6到17行：

zend_module_entry php_mymod_module_entry = {
    STANDARD_MODULE_HEADER,
    "mymod", /* extension name */
    NULL, /* function entries */
    NULL, /* MINIT */
    NULL, /* MSHUTDOWN */
    NULL, /* RINIT */
    NULL, /* RSHUTDOWN */
    NULL, /* MINFO */
    "1.0", /* version */
    STANDARD_MODULE_PROPERTIES
};

上面这段代码是PHP内部的模块结构声明。此处模块初始化、请求初始化等函数指针均为NULL，也就是说模块在初始化及请求开始结束等事件发生时，不执行任何操作。不过这些操作在sapi/embed/php_embed.c文件中的php_embed_shutdown等函数中有体现。关于模块结构的定义，参考zend/zend_modules.h。

来看startup_php函数：

static void startup_php(void)
{
    int argc = 1;
    char *argv[2] = { "embed5", NULL };
    php_embed_init(argc, argv PTSRMLS_CC);
    zend_startup_module(&php_mymod_module_entry);
}

这个函数调用了两个函数：php_embed_init和zend_startup_module完成初始化工作。php_embed_init函数定义在sapi/embed/php_embed.c文件中，它完成了PHP对于嵌入式的初始化支持。zend_startup_module是PHP的内部API函数，作用是注册定义的模块，这里就是注册mymod模块。注册过程仅仅是将所定义的zend_module_entry结构添加到注册模块列表中。

再看execute_php函数：

static void execute_php(char *filename)
{
    zend_first_try {
        char *include_script;
        spprintf(&include_script, 0, "include '%s'", filename);
        zend_eval_string(include_script, NULL, filename TSRMLS_CC);
        efree(include_script);
    } zend_end_try();
}

从函数名称来看，它的功能是执行PHP代码。它通过调用spprintf函数构造一个include语句，然后再调用zend_eval_string函数执行这个include语句。zend_eval_string最终调用的是zend_eval_stringl函数，这个函数的流程是：编译PHP代码，生成zend_op_array类型数据，并执行opcode。这段程序相当于下面的PHP代码，这段代码可以用php命令来执行，虽然下面这段PHP本身没有实际意义，但通过嵌入式PHP，你可以在一个用C实现的系统中嵌入PHP，然后用PHP来实现功能。

if($argc < 2) die("Usage: embed4 scriptfile");
include $argv[1];

最后是main函数：

int main(int argc, char *argv[])
{
    if (argc <= 1) {
        printf("Usage: embed4 scriptfile");
        return -1;
    }
    startup_php();
    execute_php(argv[1]);
    php_embed_shutdown(TSRMLS_CC);
    return 0;
}

这个函数是主函数，执行初始化操作，根据输入的参数执行PHP的include语句，最后执行关闭操作，返回。其中php_embed_shutdown函数定义在sapi/embed/php_embed.c文件中，它完成了PHP对于嵌入式的关闭操作支持，包括请求关闭操作、模块关闭操作等。

以上是使用PHP嵌入式方式开发的一个简单的PHP代码运行器。这些调用的方式都基于PHP本身的一些实现，而针对嵌入式的SAPI定义相对简单，没有Apache和CGI模式那么复杂，或者说相当简陋，这也是由其所在环境决定的。在嵌入式环境下，很多网络协议所需要的方法都不再需要。如下所示，为嵌入式的模块定义。

sapi_module_struct php_embed_module = {
    "embed", /* name */
    "PHP Embedded Library",/* pretty name */
    php_embed_startup,/* startup */
    php_module_shutdown_wrapper, /* shutdown */
    NULL,/* activate */
    php_embed_deactivate, /* deactivate */
    php_embed_ub_write, /* unbuffered write */
    php_embed_flush,/* flush */
    NULL,/* get uid */
    NULL,/* getenv */
    php_error, /* error handler */
    NULL,/* header handler */
    NULL,/* send headers handler */
    php_embed_send_header,/* send header handler */
    NULL,/* read POST data */
    php_embed_read_cookies, /* read Cookies */
    php_embed_register_variables, /* register server variables */
    php_embed_log_message,/* Log message */
    NULL, /* Get request time */
    NULL, /* Child terminate */
    STANDARD_SAPI_MODULE_PROPERTIES
};
/* }}} */

在这个定义中我们看到若干NULL定义。在前面一小节中说到SAPI时，我们以cookie的读取为例，这里也有读取cookie的实现——php_embed_read_cookies函数，但它的实现是一个空指针NULL。