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源码-扩展中抛出和处理错误

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容