php源码-sapi基础数据结构解析

sapi是什么相信大家都不陌生，sapi: Server Application Programming Interface 服务器端应用编程端口 , 网上有这么一张图来对php做了一个分层

sapi.jpg

中间的SAPI， 其实是php提供的一套用来和php交互的数据结构和函数，这些东西的定义和实现都在main\SAPI.h、main\SAPI.c 中。这其中有几个关键的数据结构

关键数据结构

1. SG , sapi_globals_struct ， 这个是sapi 运行期间的全局变量， 比如 header() 函数设置的header就存在 SG(sapi_headers)
2. _sapi_module_struct, sapi_module_struct ， 这个就是实现一个sapi必须要定义的一个结构体，其中包含了sapi生命周期中各种处理函数的定义

下面对sapi_module_struct 中几个关键的字段做说明

struct _sapi_module_struct {
       // 名字而已， 不解释了， 比如 cli 、fpm等 
    char *name;
    char *pretty_name;

        // sapi启动的执行函数
    int (*startup)(struct _sapi_module_struct *sapi_module);
    int (*shutdown)(struct _sapi_module_struct *sapi_module);

    int (*activate)(void);
    int (*deactivate)(void);

    size_t (*ub_write)(const char *str, size_t str_length);
    void (*flush)(void *server_context);

    void (*sapi_error)(int type, const char *error_msg, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3);

    int (*header_handler)(sapi_header_struct *sapi_header, sapi_header_op_enum op, sapi_headers_struct *sapi_headers);
    int (*send_headers)(sapi_headers_struct *sapi_headers);

        void (*log_message)(char *message, int syslog_type_int);

};

startup

sapi启动的执行函数，这个函数不会自动执行，这个要和 SAPI.c中定义的 sapi_startup(sapi_module_struct *sf)) 区分开来，后面我们讲sapi的执行过程的时候会说这个
我看fpm的源码fpm_main.c中会有 cgi_sapi_module.startup(&cgi_sapi_module) 调用, 说明这个是sapi实现者完全把控的：定义和调用都由自己控制 （目前看fpm是这样，还有待确认）

shutdown

sapi关闭时的执行函数，比如fpm程序退出 ， 什么时候调用暂不明，

activate

每次请求开始的时候会执行 php_request_startup() main/main.c 函数， 其中会调用 sapi_activate()

SAPI_API void sapi_activate(void)
{
    if (sapi_module.activate) {
        sapi_module.activate();   //执行sapi定义中的activate函数
    }
}

deactivate

每次请求结束的时候会执行 php_request_shutdown() main/main.c 函数， 其中会调用sapi_deactivate()

SAPI_API void sapi_deactivate(void)
{
    if (sapi_module.deactivate) {
        sapi_module.deactivate();  //执行sapi定义中的deactivate函数
    }
}

ub_write，flush

sapi中的 ub_write 、flush 控制着php的输出，比如我们在php代码中的 echo 、print_r、var_dump这样的输出都会通过这两个函数来最终执行。后面会详细分析执行过程

header_handler，send_headers

header_handler ： 如果定义了，每次调用header() 函数时都会执行该handler函数
send_headers： 通过header()函数设置的header实际上是存储在SG(sapi_headers) 全局变量中，当php有输出或者request结束时，会调用sapi的send_headers来执行 header输出

sapi_error

sapi实现逻辑中的错误处理函数，通过 grep sapi_error -rn main/* 命令可以发现主要在 main/rfc1867.c、main/SAPI.c、main/SAPI.h有调用， 说明是SAPI层面的错误处理handler， fpm中这个函数赋值为 php_error, 看过这篇文章php源码-扩展中抛出和处理错误的会知道 php_error 最终会调用 _sapi_module_struct.log_message()来输出错误信息

log_message

这个是每个sapi实现的对于php的错误输出的处理函数，参考
php源码-扩展中抛出和处理错误