深入理解Zend SAPIs(Zend SAPI Internals)

• 
  
• 作者: Laruence(   )
• 本文地址: http://www.laruence.com/2008/08/12/180.html
• 转载请注明出处

SAPI: Server abstraction API，研究过PHP架构的同学应该知道这个东东的重要性，它提供了一个接口，使得PHP可以和其他应用进行交互数据。 本文不会详细介绍每个PHP的SAPI，只是针对最简单的CGI SAPI，来说明SAPI的机制。

首先，我们来看看PHP的架构图：

PHP架构图

图1 PHP Architecture
SAPI提供了一个和外部通信的接口， 对于PHP5.2，默认提供了很多种SAPI， 常见的给apache的mod_php5，CGI，给IIS的ISAPI，还有Shell的CLI，本文就从CGI SAPI入手 ，介绍SAPI的机制。 虽然CGI简单，但是不用担心，它包含了绝大部分内容，足以让你深刻理解SAPI的工作原理。

要定义个SAPI，首先要定义个sapi_module_struct, 查看 PHP-SRC/sapi/cgi/cgi_main.c:

  
  
  
  

   
   
   
   
 */
   
   
   
   
static sapi_module_struct cgi_sapi_module = {
   
   
   
   
#if PHP_FASTCGI
   
   
   
   
    "cgi-fcgi", /* name */
   
   
   
   
    "CGI/FastCGI", /* pretty name */
   
   
   
   
#else
   
   
   
   
    "cgi", /* name */
   
   
   
   
    "CGI", /* pretty name */
   
   
   
   
#endif
   
   
   
   
 
   
   
   
   
    php_cgi_startup, /* startup */
   
   
   
   
    php_module_shutdown_wrapper, /* shutdown */
   
   
   
   
 
   
   
   
   
    NULL, /* activate */
   
   
   
   
    sapi_cgi_deactivate, /* deactivate */
   
   
   
   
 
   
   
   
   
    sapi_cgibin_ub_write, /* unbuffered write */
   
   
   
   
    sapi_cgibin_flush, /* flush */
   
   
   
   
    NULL, /* get uid */
   
   
   
   
    sapi_cgibin_getenv, /* getenv */
   
   
   
   
 
   
   
   
   
    php_error, /* error handler */
   
   
   
   
 
   
   
   
   
    NULL, /* header handler */
   
   
   
   
    sapi_cgi_send_headers, /* send headers handler */
   
   
   
   
    NULL, /* send header handler */
   
   
   
   
 
   
   
   
   
    sapi_cgi_read_post, /* read POST data */
   
   
   
   
    sapi_cgi_read_cookies, /* read Cookies */
   
   
   
   
 
   
   
   
   
    sapi_cgi_register_variables, /* register server variables */
   
   
   
   
    sapi_cgi_log_message, /* Log message */
   
   
   
   
    NULL, /* Get request time */
   
   
   
   
 
   
   
   
   
    STANDARD_SAPI_MODULE_PROPERTIES
   
   
   
   
};
  
  
  
  

这个结构，包含了一些常量，比如name, 这个会在我们调用php_info()的时候被使用。一些初始化，收尾函数，以及一些函数指针，用来告诉Zend，如何获取，和输出数据。

1. php_cgi_startup， 当一个应用要调用PHP的时候，这个函数会被调用，对于CGI来说，它只是简单的调用了PHP的初始化函数：

   
   
   
   

    
    
    
    
   static int php_cgi_startup(sapi_module_struct *sapi_module)
    
    
    
    
{
    
    
    
    
    if (php_module_startup(sapi_module, NULL, 0) == FAILURE) {
    
    
    
    
        return FAILURE;
    
    
    
    
    }
    
    
    
    
    return SUCCESS;
    
    
    
    
}
    
    
    
    
  
   
   
   
   

2. php_module_shutdown_wrapper ， 一个对PHP关闭函数的简单包装。只是简单的调用php_module_shutdown;

3. PHP会在每个request的时候，处理一些初始化，资源分配的事务。这部分就是activate字段要定义的，从上面的结构我们可以看出，对于CGI来说，它并没有提供初始化处理句柄。对于mod_php来说，那就不同了，他要在apache的pool中注册资源析构函数， 申请空间， 初始化环境变量，等等等等。

4. sapi_cgi_deactivate, 这个是对应与activate的函数，顾名思义，它会提供一个handler, 用来处理收尾工作，对于CGI来说，他只是简单的刷新缓冲区，用以保证用户在Zend关闭前得到所有的输出数据：

   
   
   
   

    
    
    
    
  static int sapi_cgi_deactivate(TSRMLS_D)
    
    
    
    
{
    
    
    
    
    /* flush only when SAPI was started. The reasons are:
    
    
    
    
 1. SAPI Deactivate is called from two places: module init and request shutdown
    
    
    
    
 2. When the first call occurs and the request is not set up, flush fails on
    
    
    
    
 FastCGI.
    
    
    
    
 */
    
    
    
    
    if (SG(sapi_started)) {
    
    
    
    
        sapi_cgibin_flush(SG(server_context));
    
    
    
    
    }
    
    
    
    
    return SUCCESS;
    
    
    
    
}
   
   
   
   

5. sapi_cgibin_ub_write, 这个hanlder告诉了Zend，如何输出数据，对于mod_php来说，这个函数提供了一个向response数据写的接口，而对于CGI来说，只是简单的写到stdout：

   
   
   
   

    
    
    
    
 
    
    
    
    
static inline size_t sapi_cgibin_single_write(const char *str, uint str_length TSRMLS_DC)
    
    
    
    
{
    
    
    
    
#ifdef PHP_WRITE_STDOUT
    
    
    
    
    long ret;
    
    
    
    
#else
    
    
    
    
    size_t ret;
    
    
    
    
#endif
    
    
    
    
 
    
    
    
    
#if PHP_FASTCGI
    
    
    
    
    if (fcgi_is_fastcgi()) {
    
    
    
    
        fcgi_request *request = (fcgi_request*) SG(server_context);
    
    
    
    
        long ret = fcgi_write(request, FCGI_STDOUT, str, str_length);
    
    
    
    
        if (ret <= 0) {
    
    
    
    
            return 0;
    
    
    
    
        }
    
    
    
    
        return ret;
    
    
    
    
    }
    
    
    
    
#endif
    
    
    
    
#ifdef PHP_WRITE_STDOUT
    
    
    
    
    ret = write(STDOUT_FILENO, str, str_length);
    
    
    
    
    if (ret <= 0) return 0;
    
    
    
    
    return ret;
    
    
    
    
#else
    
    
    
    
    ret = fwrite(str, 1, MIN(str_length, 16384), stdout);
    
    
    
    
    return ret;
    
    
    
    
#endif
    
    
    
    
}
    
    
    
    
 
    
    
    
    
static int sapi_cgibin_ub_write(const char *str, uint str_length TSRMLS_DC)
    
    
    
    
{
    
    
    
    
    const char *ptr = str;
    
    
    
    
    uint remaining = str_length;
    
    
    
    
    size_t ret;
    
    
    
    
 
    
    
    
    
    while (remaining > 0) {
    
    
    
    
        ret = sapi_cgibin_single_write(ptr, remaining TSRMLS_CC);
    
    
    
    
        if (!ret) {
    
    
    
    
            php_handle_aborted_connection();
    
    
    
    
            return str_length - remaining;
    
    
    
    
        }
    
    
    
    
        ptr += ret;
    
    
    
    
        remaining -= ret;
    
    
    
    
    }
    
    
    
    
 
    
    
    
    
    return str_length;
    
    
    
    
}
   
   
   
   

把真正的写的逻辑剥离出来，就是为了简单实现兼容fastcgi的写方式。

6. sapi_cgibin_flush, 这个是提供给zend的刷新缓存的函数句柄，对于CGI来说，只是简单的调用系统提供的fflush;

7.NULL， 这部分用来让Zend可以验证一个要执行脚本文件的state，从而判断文件是否据有执行权限等等，CGI没有提供。

8. sapi_cgibin_getenv, 为Zend提供了一个根据name来查找环境变量的接口，对于mod_php5来说，当我们在脚本中调用getenv的时候，就会间接的调用这个句柄。而对于CGI来说，因为他的运行机制和CLI很类似，直接调用父级是Shell， 所以，只是简单的调用了系统提供的genenv:

   
   
   
   

    
    
    
    
static char *sapi_cgibin_getenv(char *name, size_t name_len TSRMLS_DC)
    
    
    
    
{
    
    
    
    
#if PHP_FASTCGI
    
    
    
    
    /* when php is started by mod_fastcgi, no regular environment
    
    
    
    
 is provided to PHP. It is always sent to PHP at the start
    
    
    
    
 of a request. So we have to do our own lookup to get env
    
    
    
    
 vars. This could probably be faster somehow. */
    
    
    
    
    if (fcgi_is_fastcgi()) {
    
    
    
    
        fcgi_request *request = (fcgi_request*) SG(server_context);
    
    
    
    
        return fcgi_getenv(request, name, name_len);
    
    
    
    
    }
    
    
    
    
#endif
    
    
    
    
    /* if cgi, or fastcgi and not found in fcgi env
    
    
    
    
 check the regular environment */
    
    
    
    
    return getenv(name);
    
    
    
    
}
   
   
   
   

9. php_error, 错误处理函数, 到这里，说几句题外话，上次看到php maillist 提到的使得PHP的错误处理机制完全OO化， 也就是，改写这个函数句柄，使得每当有错误发生的时候，都throw一个异常。而CGI只是简单的调用了PHP提供的错误处理函数。

10. 这个函数会在我们调用PHP的header()函数的时候被调用，对于CGI来说，不提供。

11. sapi_cgi_send_headers, 这个函数会在要真正发送header的时候被调用，一般来说，就是当有任何的输出要发送之前：

   
   
   
   

    
    
    
    
static int sapi_cgi_send_headers(sapi_headers_struct *sapi_headers TSRMLS_DC)
    
    
    
    
{
    
    
    
    
    char buf[SAPI_CGI_MAX_HEADER_LENGTH];
    
    
    
    
    sapi_header_struct *h;
    
    
    
    
    zend_llist_position pos;
    
    
    
    
 
    
    
    
    
    if (SG(request_info).no_headers == 1) {
    
    
    
    
        return SAPI_HEADER_SENT_SUCCESSFULLY;
    
    
    
    
    }
    
    
    
    
 
    
    
    
    
    if (cgi_nph || SG(sapi_headers).http_response_code != 200)
    
    
    
    
    {
    
    
    
    
        int len;
    
    
    
    
 
    
    
    
    
        if (rfc2616_headers && SG(sapi_headers).http_status_line) {
    
    
    
    
            len = snprintf(buf, SAPI_CGI_MAX_HEADER_LENGTH,
    
    
    
    
                           "%s\r\n", SG(sapi_headers).http_status_line);
    
    
    
    
 
    
    
    
    
            if (len > SAPI_CGI_MAX_HEADER_LENGTH) {
    
    
    
    
                len = SAPI_CGI_MAX_HEADER_LENGTH;
    
    
    
    
            }
    
    
    
    
 
    
    
    
    
        } else {
    
    
    
    
            len = sprintf(buf, "Status: %d\r\n", SG(sapi_headers).http_response_code);
    
    
    
    
        }
    
    
    
    
 
    
    
    
    
        PHPWRITE_H(buf, len);
    
    
    
    
    }
    
    
    
    
 
    
    
    
    
    h = (sapi_header_struct*)zend_llist_get_first_ex(&sapi_headers->headers, &pos);
    
    
    
    
    while (h) {
    
    
    
    
        /* prevent CRLFCRLF */
    
    
    
    
        if (h->header_len) {
    
    
    
    
            PHPWRITE_H(h->header, h->header_len);
    
    
    
    
            PHPWRITE_H("\r\n", 2);
    
    
    
    
        }
    
    
    
    
        h = (sapi_header_struct*)zend_llist_get_next_ex(&sapi_headers->headers, &pos);
    
    
    
    
    }
    
    
    
    
    PHPWRITE_H("\r\n", 2);
    
    
    
    
 
    
    
    
    
    return SAPI_HEADER_SENT_SUCCESSFULLY;
    
    
    
    
   }
    
    
    
    
 
   
   
   
   

12. NULL, 这个用来单独发送每一个header, CGI没有提供

13. sapi_cgi_read_post, 这个句柄指明了如何获取POST的数据，如果做过CGI编程的话，我们就知道CGI是从stdin中读取POST DATA的，

   
   
   
   

    
    
    
    
static int sapi_cgi_read_post(char *buffer, uint count_bytes TSRMLS_DC)
    
    
    
    
{
    
    
    
    
    uint read_bytes=0, tmp_read_bytes;
    
    
    
    
#if PHP_FASTCGI
    
    
    
    
    char *pos = buffer;
    
    
    
    
#endif
    
    
    
    
 
    
    
    
    
    count_bytes = MIN(count_bytes, (uint) SG(request_info).content_length - SG(read_post_bytes));
    
    
    
    
    while (read_bytes < count_bytes) {
    
    
    
    
#if PHP_FASTCGI
    
    
    
    
        if (fcgi_is_fastcgi()) {
    
    
    
    
            fcgi_request *request = (fcgi_request*) SG(server_context);
    
    
    
    
            tmp_read_bytes = fcgi_read(request, pos, count_bytes - read_bytes);
    
    
    
    
            pos += tmp_read_bytes;
    
    
    
    
        } else {
    
    
    
    
            tmp_read_bytes = read(0, buffer + read_bytes, count_bytes - read_bytes);
    
    
    
    
        }
    
    
    
    
#else
    
    
    
    
        tmp_read_bytes = read(0, buffer + read_bytes, count_bytes - read_bytes);
    
    
    
    
#endif
    
    
    
    
 
    
    
    
    
        if (tmp_read_bytes <= 0) {
    
    
    
    
            break;
    
    
    
    
        }
    
    
    
    
        read_bytes += tmp_read_bytes;
    
    
    
    
    }
    
    
    
    
    return read_bytes;
    
    
    
    
}
   
   
   
   

14. sapi_cgi_read_cookies, 这个和上面的函数一样，只不过是去获取cookie值：

   
   
   
   

    
    
    
    
static char *sapi_cgi_read_cookies(TSRMLS_D)
    
    
    
    
{
    
    
    
    
    return sapi_cgibin_getenv((char *) "HTTP_COOKIE", sizeof("HTTP_COOKIE")-1 TSRMLS_CC);
    
    
    
    
}
   
   
   
   

15. sapi_cgi_register_variables, 这个函数给了一个接口，用以给$_SERVER变量中添加变量，对于CGI来说，注册了一个PHP_SELF,这样我们就可以在脚本中访问$_SERVER['PHP_SELF']来获取本次的request_uri：

   
   
   
   

    
    
    
    
static void sapi_cgi_register_variables(zval *track_vars_array TSRMLS_DC)
    
    
    
    
{
    
    
    
    
    /* In CGI mode, we consider the environment to be a part of the server
    
    
    
    
 * variables
    
    
    
    
 */
    
    
    
    
    php_import_environment_variables(track_vars_array TSRMLS_CC);
    
    
    
    
    /* Build the special-case PHP_SELF variable for the CGI version */
    
    
    
    
    php_register_variable("PHP_SELF", (SG(request_info).request_uri ? SG(request_info).request_uri : ""), track_vars_array TSRMLS_CC);
    
    
    
    
}
   
   
   
   

16. sapi_cgi_log_message ，用来输出错误信息，对于CGI来说，只是简单的输出到stderr:

   
   
   
   

    
    
    
    
static void sapi_cgi_log_message(char *message)
    
    
    
    
{
    
    
    
    
#if PHP_FASTCGI
    
    
    
    
    if (fcgi_is_fastcgi() && fcgi_logging) {
    
    
    
    
        fcgi_request *request;
    
    
    
    
        TSRMLS_FETCH();
    
    
    
    
 
    
    
    
    
        request = (fcgi_request*) SG(server_context);
    
    
    
    
        if (request) {
    
    
    
    
            int len = strlen(message);
    
    
    
    
            char *buf = malloc(len+2);
    
    
    
    
 
    
    
    
    
            memcpy(buf, message, len);
    
    
    
    
            memcpy(buf + len, "\n", sizeof("\n"));
    
    
    
    
            fcgi_write(request, FCGI_STDERR, buf, len+1);
    
    
    
    
            free(buf);
    
    
    
    
        } else {
    
    
    
    
            fprintf(stderr, "%s\n", message);
    
    
    
    
        }
    
    
    
    
        /* ignore return code */
    
    
    
    
    } else
    
    
    
    
#endif /* PHP_FASTCGI */
    
    
    
    
    fprintf(stderr, "%s\n", message);
    
    
    
    
}
   
   
   
   

经过分析，我们已经了解了一个SAPI是如何实现的了， 分析过CGI以后，我们也就可以想象mod_php, embed等SAPI的实现机制。 ：）

延伸阅读

此文章所在专题列表如下：

1. PHP内核探索：从SAPI接口开始
2. PHP内核探索：一次请求的开始与结束
3. PHP内核探索：一次请求生命周期
4. PHP内核探索：单进程SAPI生命周期
5. PHP内核探索：多进程/线程的SAPI生命周期
6. PHP内核探索：Zend引擎
7. PHP内核探索：再次探讨SAPI
8. PHP内核探索：Apache模块介绍
9. PHP内核探索：通过mod_php5支持PHP
10. PHP内核探索：Apache运行与钩子函数
11. PHP内核探索：嵌入式PHP
12. PHP内核探索：PHP的FastCGI
13. PHP内核探索：如何执行PHP脚本
14. PHP内核探索：PHP脚本的执行细节
15. PHP内核探索：操作码OpCode
16. PHP内核探索：PHP里的opcode
17. PHP内核探索：解释器的执行过程
18. PHP内核探索：变量概述
19. PHP内核探索：变量存储与类型
20. PHP内核探索：PHP中的哈希表
21. PHP内核探索：理解Zend里的哈希表
22. PHP内核探索：PHP哈希算法设计
23. PHP内核探索：翻译一篇HashTables文章
24. PHP内核探索：哈希碰撞攻击是什么？
25. PHP内核探索：常量的实现
26. PHP内核探索：变量的存储
27. PHP内核探索：变量的类型
28. PHP内核探索：变量的值操作
29. PHP内核探索：变量的创建
30. PHP内核探索：预定义变量
31. PHP内核探索：变量的检索
32. PHP内核探索：变量的类型转换
33. PHP内核探索：弱类型变量的实现
34. PHP内核探索：静态变量的实现
35. PHP内核探索：变量类型提示
36. PHP内核探索：变量的生命周期
37. PHP内核探索：变量赋值与销毁
38. PHP内核探索：变量作用域
39. PHP内核探索：诡异的变量名
40. PHP内核探索：变量的value和type存储
41. PHP内核探索：全局变量Global
42. PHP内核探索：变量类型的转换
43. PHP内核探索：内存管理开篇
44. PHP内核探索：Zend内存管理器
45. PHP内核探索：PHP的内存管理
46. PHP内核探索：内存的申请与销毁
47. PHP内核探索：引用计数与写时复制
48. PHP内核探索：PHP5.3的垃圾回收机制
49. PHP内核探索：内存管理中的cache
50. PHP内核探索：写时复制COW机制
51. PHP内核探索：数组与链表
52. PHP内核探索：使用哈希表API
53. PHP内核探索：数组操作
54. PHP内核探索：数组源码分析
55. PHP内核探索：函数的分类
56. PHP内核探索：函数的内部结构
57. PHP内核探索：函数结构转换
58. PHP内核探索：定义函数的过程
59. PHP内核探索：函数的参数
60. PHP内核探索：zend_parse_parameters函数
61. PHP内核探索：函数返回值
62. PHP内核探索：形参return value
63. PHP内核探索：函数调用与执行
64. PHP内核探索：引用与函数执行
65. PHP内核探索：匿名函数及闭包
66. PHP内核探索：面向对象开篇
67. PHP内核探索：类的结构和实现
68. PHP内核探索：类的成员变量
69. PHP内核探索：类的成员方法
70. PHP内核探索：类的原型zend_class_entry
71. PHP内核探索：类的定义
72. PHP内核探索：访问控制
73. PHP内核探索：继承，多态与抽象类
74. PHP内核探索：魔术函数与延迟绑定
75. PHP内核探索：保留类与特殊类
76. PHP内核探索：对象
77. PHP内核探索：创建对象实例
78. PHP内核探索：对象属性读写
79. PHP内核探索：命名空间
80. PHP内核探索：定义接口
81. PHP内核探索：继承与实现接口
82. PHP内核探索：资源resource类型
83. PHP内核探索：Zend虚拟机
84. PHP内核探索：虚拟机的词法解析
85. PHP内核探索：虚拟机的语法分析
86. PHP内核探索：中间代码opcode的执行
87. PHP内核探索：代码的加密与解密
88. PHP内核探索：zend_execute的具体执行过程
89. PHP内核探索：变量的引用与计数规则
90. PHP内核探索：新垃圾回收机制说明