深入理解PHP内核(三)概览-SAPI概述，深入理解-sapi

深入理解PHP内核(三)概览-SAPI概述，深入理解-sapi

 本文链接：http://www.orlion.ml/234/

1、在PHP生命周期的各个阶段，一些与服务相关的操作都是通过SAPI接口实现。这些内置实现的物理位置在PHP源码的SAPI目录。这个目录存放了PHP对各个服务器抽象层的代码，例如命令行程序的实现，Apache的mod_php模块实现以及fastcgi的实现等等

在各个服务器抽象层之间遵守着相同的约定，这里我们称之为SAPI接口。每个SAPI实现都是一个_sapi_module_struct结构体变量。(SAPI接口)。在PHP的源码中，当需要调用服务器相关信息时，全部通过SAPI接口中对应的方法调用实现，而这些方法在各个服务器抽象层实现时都会有各自的实现。由于很多操作的通用性，有很大一部分接口方法使用的是默认方法。下图为SPAI的简单示意图

以cgi模式和apache2服务器为例，它们的启动方法如下:

cgi_sapi_module.startup(&cgi_sapi_module) // cgi模式 cgi/cgi_main.c文件
<span>
apache_sapi_module.startup(&apache_sapi_module); // apache服务器  apache2handler/sapi_apache2.c文件</span>

这里的cgi_sapi_module是sapi_module_struct结构体的静态变量。它的startup方法指向php_cgi_startup函数指针。在这个结构体中除了startup函数指针，还有许多其他方法或字段，这些结构在服务器的接口实现中都有定义

整个SAPI类似于一个面向对象中的模板方法模式的应用。SAPI.c和SAPI.h文件所包含的一些函数就是模板方法模式中的抽象模板，各个服务器对于sapi_module的定义及相关实现则是一个个具体的模板

2、Apache模块

(1)当PHP需要在Apache服务器下运行时，一般来说，它可以mod_php5模块的形式集成，此时mod_php5模块的作用是接收Aapche传递过来的PHP文件请求，并处理这些请求，然后将处理后的结果返回给Apache。如果我们在Apache启动前在其配置文件中配置了PHP模块，PHP模块通过注册apache2的ap_hook_post_config挂钩，在Apache启动的时候启动此模块以接收PHP文件的请求。

除了这种启动时的加载方式，Apache的模块可以在运行的时候动态装载，这意味着对服务器可以进行功能扩展而不需要重新对源代码进行编译，甚至不需要重启服务器。我们所需要做的仅仅是给服务器发送信号HUP或者AP_SIG_GEACEFUL通知服务器重新载入模块。但是在动态装载之前我们需要将模块编译成为动态链接库。此时的动态加载就是加载动态链接库。Apache中对动态链接库的处理是通过模块mod_so来完成的，因此mod_so模块不能被动态加载，它只能本静态编译进Apache的核心。这意味着它和Apache一起启动的。

Apache是如何加载模块的呢？以mod_php5为例，首先在httpd.conf中添加一行:

LoadModule php5_module modules/mod_php5.so

在配置文件中添加了所示的指令后，Apache在加载模块时会根据模块名查找模块并加载。Apache的每一个模块都是以module结构体的形式存在，module结构的name属性在最后是通过宏STANDARD20_MODULE_STUFF以__FILE__体现。通过之前的指令中指定的路径找到相关的动态链接库文件后，Apache通过内部的函数获取动态链接库中的内容，并将模块的内容加载到内存中指定变量中。

在真正激活模块之前，Apache会检查所有加载的模块是否为真正的Apache模块。最后Apache会调用相关的函数(ap_add_loaded_module)将模块激活，此处的激活就是将模块放入相应的链表中(ap_top_modules链表)

Apache加载的是PHP模块，那么这个模块时怎么实现的呢？Apache2的mod_php5模块包括sapi/apache2handler和sapi/apache2filter两个目录，在apache2_handle/mod_php5.c文件中，模块定义的相关代码如下:

AP_MODULE_DECLARE_DATA module php5_module =<span> {
    STANDARD20_MODULE_STUFF,
        /* 宏，包括版本，小版本，模块索引，模块名，下一个模块指针等信息，其中模块名以__FILE__体现*/<span>
    create_php_config,      /* create per-directory config structure */<span>
    merge_php_config,       /* merge per-directory config structures */<span>
    NULL,                   /* create per-server config structure */<span>
    NULL,                   /* merge per-server config structures */<span>
    php_dir_cmds,           /*模块定义的所有命令*/<span>
    php_ap2_register_hook  /*注册钩子，此函数通过ap_hoo_开头的函数在一次处理过程中对于指定的步骤注册钩子*/<span>
};</span></span></span></span></span></span></span></span>

它所对应的是Apache的module结构，module的结构定义如下：

typedef struct<span> module_struct module;
struct<span> module_struct {
    int<span> version;
    int<span> minor_version;
    int<span> module_index;
    const char *<span>name;
    void *<span>dynamic_load_handle;
    struct module_struct *<span>next;
    unsigned long<span> magic;
    void (*rewrite_args) (process_rec *<span>process);
    void *(*create_dir_config) (apr_pool_t *p, char *<span>dir);
    void *(*merge_dir_config) (apr_pool_t *p, void *base_conf, void *<span>new_conf);
    void *(*create_server_config) (apr_pool_t *p, server_rec *<span>s);
    void *(*merge_server_config) (apr_pool_t *p, void *base_conf, void 
*<span>new_conf);
    const command_rec *<span>cmds;
    void (*register_hooks) (apr_pool_t *<span>p);
}</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>

上面的模块结构与我们在mod_php5.c中所看到的结构有一点不同，这是由于STANDARD20_MODULE_STUFF的原因，这个宏它包含了前面8个字段的定义。STANDARD20_MODULE_STUFF宏的定义如下:

/** Use this in all standard modules */
#define STANDARD20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \<span>
                MODULE_MAGIC_NUMBER_MINOR, \
                -1<span>, \
                __FILE__, \
                NULL, \
                NULL, \
                MODULE_MAGIC_COOKIE, \
                                NULL      /* rewrite args spot */</span></span>

在php5_module定义的结构中，php_dir_cmds是模块定义的所有的指令集合，定义的内容如下:

const command_rec php_dir_cmds[] =<span>
{
    AP_INIT_TAKE2("php_value"<span>, php_apache_value_handler, NULL,
        OR_OPTIONS, "PHP Value Modifier"<span>),
    AP_INIT_TAKE2("php_flag"<span>, php_apache_flag_handler, NULL,
        OR_OPTIONS, "PHP Flag Modifier"<span>),
    AP_INIT_TAKE2("php_admin_value"<span>, php_apache_admin_value_handler,
        NULL, ACCESS_CONF|RSRC_CONF, "PHP Value Modifier (Admin)"<span>),
    AP_INIT_TAKE2("php_admin_flag"<span>, php_apache_admin_flag_handler,
        NULL, ACCESS_CONF|RSRC_CONF, "PHP Flag Modifier (Admin)"<span>),
    AP_INIT_TAKE1("PHPINIDir"<span>, php_apache_phpini_set, NULL,
        RSRC_CONF, "Directory containing the php.ini file"<span>),
    {NULL}
};</span></span></span></span></span></span></span></span></span></span></span>

这是mod_php5模块定义的指令表。它实际上是一个commond_rec结构的数组。当Apache遇到指令的时候将逐一遍历各个模块中的指令表，查找是否有那个模块能够处理该指令，如果找到，则调用响应的处理函数，如果所有指令表中的模块都不能处理该指令，那么将报错，如上所见，mod_php5模块仅提供php_value等5个指令。

php_ap2_register_hook函数的定义如下:

void php_ap2_register_hook(apr_pool_t *<span>p)
{
    ap_hook_pre_config(php_pre_config, NULL, NULL, APR_HOOK_MIDDLE);
    ap_hook_post_config(php_apache_server_startup, NULL, NULL, 
APR_HOOK_MIDDLE);
    ap_hook_handler(php_handler, NULL, NULL, APR_HOOK_MIDDLE);
    ap_hook_child_init(php_apache_child_init, NULL, NULL, APR_HOOK_MIDDLE);
}</span>

以上代码声明了pre_config,post_config,handler和child_init4个挂钩以及对应的处理函数。其中pre_config，post_config,child_init是启动挂钩，它们在服务器启动时调用。handler挂钩是请求挂钩，它在服务器处理请求时调用。其中在post_config挂钩中启动php。它通过php_apache_server_startup函数实现，php_apache_server_startup函数通过调用sapi_startup启动sapi,并通过调用php_apache2_startup来注册sapi module struct,最后调用php_module_startup初始化php，其中又会初始化Zend引擎，以及填充zend_module_struct中的treat_data成员(通过php_startup_sapi_content_types)等。

　　到这里，我们知道了Apache加载mod_php5模块的整个过程，可是这个过程与我们的饿SAPI有什么关系呢?mod_php5也定义了属于Apache的sapi_module_struct结构：

static sapi_module_struct apache2_sapi_module =<span> {
"apache2handler"<span>,
"Apache 2.0 Handler"<span>,
 
php_apache2_startup,                /* startup */<span>
php_module_shutdown_wrapper,            /* shutdown */<span>
 
NULL,                       /* activate */<span>
NULL,                       /* deactivate */<span>
 
php_apache_sapi_ub_write,           /* unbuffered write */<span>
php_apache_sapi_flush,              /* flush */<span>
php_apache_sapi_get_stat,           /* get uid */<span>
php_apache_sapi_getenv,             /* getenv */<span>
php_error,                  /* error handler */<span>
 
php_apache_sapi_header_handler,         /* header handler */<span>
php_apache_sapi_send_headers,           /* send headers handler */<span>
NULL,                       /* send header handler */<span>
 
php_apache_sapi_read_post,          /* read POST data */<span>
php_apache_sapi_read_cookies,           /* read Cookies */<span>
 
php_apache_sapi_register_variables,
php_apache_sapi_log_message,            /* Log message */<span>
php_apache_sapi_get_request_time,       /* Request Time */<span>
NULL,                       /* Child Terminate */<span>
 
STANDARD_SAPI_MODULE_PROPERTIES
};</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>

这些方法都属于Apache服务器，以读取cookie为例，当我们在Apache服务器环境下，在PHP中调用读取Cookie时，最终获取的数据的位置是在激活SAPI时，它所调用的方法是read_cookie。

SG(request_info).cookie_data = sapi_module.read_cookies(TSRMLS_C);

对于每一个服务器在加载时，我们都指定了sapi_module，而Apache的sapi_module是apache2_sapi_module。其中对应read_cookie的方法是php_apache_sapi_read_cookie函数。这也是定义SAPI结构的理由:统一接口，面向接口编程，具有更好的扩展性和适应性。

(2)Apache的运行过程

Apache的运行包括启动阶段和运行阶段，启动阶段Apache以root完成启动，整个过程处于单进程单线程的环境中，这个阶段包括配置文件解析、模块加载、系统资源初始化(例如日志文件、共享内存段、数据库连接等)等工作。

在运行阶段，Apache主要工作是处理用户的服务请求，在这个阶段Apache以普通用户运行。主要是安全性考虑，Apache对HTTP的请求可以分为连接、处理和断开连接三个大的阶段。

2、FastCGI

(1)cgi是通用网关接口(Common Gateway Intedface)，它可以让一个客户端从网页浏览器向执行在Web服务器上的程序请求数据。CGI描述了客户端和这个程序之间传输数据的标准。CGI的一个目的是独立于任何语言，所以CGI可以用任何语言编写，只要这种语言具有标准输入、输出和环境变量。如PHP、perl、tcl等。

FastCGI是Web服务器和处理程序之间通信的一种协议，是CGI的一种改进方案，FastCGI像是一个常驻型的CGI，它可以一直执行，在请求到达时不会花费时间去fork一个进程来处理(这是CGI对位人诟病的fork-and-execute模式)。正是因为它只是一个通信协议，它还支持分布式的运算，即FastCGI程序可以在网站服务器以外的主机上执行并且接受来自其他网站服务器的请求

FastCGI的整个流程是这样的:

　　Step1:Web Server启动时载入FastCGI进程管理器(IIS ISAPI或Apache Module)

　　Step2:FastCGI进程管理器自身初始化，启动多个CGI解释器进程(可见多个php-cgi)并等待来自web server的连接

　　Step3:当客户端请求到达Web Server时，FastCGI进程管理器选择并连接到一个CGI解释器。Web Server将CGI环境变量和标准输入发送到FastCGI子进程php-cgi

　　Step4:FastCGI子进程完成处理后将标准输出和错误新词从同一连接返回Web Server 当FastCGI子进程关闭连接时，请求便结束。FastCGI子进程接着等待并处理来自FastCGI进程管理器(运行在Web Server中)的下一个连接。在CGI模式中，php-cgi在此便退出了。

(2)php中CGI实现

PHP的CGI实现了Fastcgi协议。是一个TCP或UDP协议的服务器接受来自Web服务器的请求，当启动时创建TCP/UDP协议的服务器的socket监听，并接受相关请求并进行处理。随后就进入了PHP的生命周期:模块初始化，sapi初始化，处理PHP请求，模块关闭，sapi关闭等 就构成了整个CGI的生命周期。

以TCP为例在，在TCP的服务端，一般会执行这样几个步骤：

1、调用socket函数创建一个TCP用的流式套接字；

2、调用bind函数将服务器的本地地址与前面创建的套接字绑定；

3、调用listen函数将新创建的套接字作为监听，等待客户端发起的连接，当客户端有多个连接连接到这个套接字时，可能需要排队处理；

4、服务器进程调用accept函数进入阻塞状态，直到有客户进程调用connect函数而建立起一个连接；

5、当与客户端创建连接后，服务器调用read_stream函数读取客户端的请求；

6、处理完数据后，服务器调用write函数向客户端发送应答

TCP上客户-服务器事务的时序如图所示：

php的CGI实现从cgi_main.c文件的main函数开始，在main函数中调用了定义在fastcgi.c文件中的初始化，监听等函数。对比TCP的流程，我们查看php对TCP协议的实现，虽然php本身也实现了这些流程，但是在main函数中一些过程被封装成一个函数实现。对应TCP的操作流程，PHP首先会执行创建socket，绑定套接字，创建监听:

if<span> (bindpath) {
    fcgi_fd = fcgi_listen(bindpath, 128);   //  socket˥˦2sfcgi_initɩ    
<span>Ȑ
    ...
}</span></span>

在fastcgi.c文件中，fcig_listen函数主要用于创建、绑定socket并开始监听，它走完了前面所列TCP流程的前三个阶段，

 if ((listen_socket = socket(sa.sa.sa_family, SOCK_STREAM, 0)) < 0 ||<span>
        ...
        bind(listen_socket, (struct sockaddr *) &sa, sock_len) < 0 ||<span>
        listen(listen_socket, backlog) < 0<span>) {
        ...
    }</span></span></span>

当服务端初始化完成后，进程调用accept函数进入阻塞状态，在main函数中我们看到如下代码：

  while<span> (parent) {
        do<span> {
            pid = fork();   //  o&Ograve;Ÿ
<span>ȨėJ
            switch<span> (pid) {
            case 0: //  ȨėJ
                parent = 0<span>;
 
                /* don't catch our signals */<span>
                sigaction(SIGTERM, &old_term, 0);   //  ľ&acirc;&macr;ķ
                sigaction(SIGQUIT, &old_quit, 0);   //  ľĿɰ&pound;ƺ
                sigaction(SIGINT,  &old_int,  0);   //  ľĿKȠƺ
                break<span>;
                ...
                default<span>:
                /* Fine */<span>
                running++<span>;
                break<span>;
        } while (parent && (running <<span> children));
 
    ...
        while (!fastcgi || fcgi_accept_request(&request) >= 0<span>) {
        SG(server_context) = (void *) &<span>request;
        init_request_info(TSRMLS_C);
        CG(interactive) = 0<span>;
                    ...
            }</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>

如上的代码是一个生成子进程，并等待用户请求。在fcgi_accept_request函数中，程序会调用accept函数阻塞新创建的线程。当用户的请求到达时，fcgi_accept_request函数会判断是否处理用户的请求，其中会过滤某些连接请求，忽略受限制客户的请求，如果程序受理用户的请求，他将分析请求的信息，将相关的变量写到对应的变量中。其中在读取请求内容时调用了safe_read方法。如下所示：main()->fcgi_accept_request()->fcgi_read_request()->safe_read()

static inline ssize_t safe_read(fcgi_request *req, const void *<span>buf, size_t 
count)
{
    size_t n = 0<span>;
    do<span> {
    ... //  省略 对win32的处理<span>
        ret = read(req->fd, ((char*)buf)+n, count-n);   //  非win版本的读操作
<span>D‰
    ... // 省略
    } while (n !=<span> count);
 
}</span></span></span></span></span></span>

如上对应服务器端读取用户的请求数据。

在请求初始化完成，读取请求完毕后，就该处理请求的PHP文件了。假设此次请求为PHP_MODE_STANDARD则会调用php_execute_script执行PHP文件。在此函数中它先初始化此文件相关的一些内容，然后再调用zend_execute_scripts函数，对PHP文件进行词法分析和语法分析，生成中间代码，并执行zend_execute函数，从而执行这些中间代码。

　　在处理完用户的请求后，服务端将返回信息给客户端，此时在main函数中调用的是fcgi_finish_request(&request , 1);fcgi_finish_request函数定义在fasftcgi.c文件中。

　　在发送了请求的应答后，服务器端将会执行关闭操作，仅限于CGI本身的关闭，程序执行的是fcgi_close函数。