Skip to content

Latest commit

 

History

History
385 lines (308 loc) · 19.1 KB

execute_timeout.md

File metadata and controls

385 lines (308 loc) · 19.1 KB

一起线上事故引发的对PHP超时控制的思考

几周以前我们的一个线上服务nginx请求日志里突然出现大量499、500、502的错误,于此同时发现php-fpm的worker进程不断的退出,新启动的worker几乎过几十秒就死掉了,在php-fpm.log里发现如下错误:

[28-Dec-2016 23:21:02] WARNING: [pool www] child 6528, script '/home/qinpeng/sofa/site/sofa/htdocs/test.php' (request: "GET /test.php") execution timed out (15.028107 sec), terminating
[28-Dec-2016 23:21:02] WARNING: [pool www] child 6528 exited on signal 15 (SIGTERM) after 53.265943 seconds from start
[28-Dec-2016 23:21:02] NOTICE: [pool www] child 26594 started

从日志里也可以看出fpm worker进程因为执行超时(超过15s)而被kill掉了。

最终经过排查确定是因为访问redis没有设置读写超时,后端redis实例挂了导致请求阻塞而引发的故障,事故造成的影响非常严重,在故障期间整个服务完全不可用。

事后一直不解为什么超时会导致fpm的退出?php-fpm.conf配置里有个:request_terminate_timeout,正是它导致fpm的退出,此配置项的注释中写的很清楚:如果一个request的执行时间超过request_terminate_timeout,worker进程将被killed。

此次事故引发我对PHP超时机制的进一步探究,fpm的处理方式太过暴力,那么除了request_terminate_timeout还有没有别的超时控制项可以避免这类问题?下面将根据PHP中几个涉及超时的配置分析内核是如何处理的。(版本:php-7.0.12)

1、PHP的超时配置

1.1 max_input_time

这个配置在php.ini中,含义是PHP解析请求数据的最大耗时,如解析GET、POST参数等,这个参数控制的PHP从解析请求到执行PHP脚本的超时,也就是从php_request_startup()到php_execute_script()之间的耗时。

此配置默认值为60s,cli模式下被强制设为-1,关于这个参数没有什么可说的,不再展开分析,下面重点分析max_execution_time

1.2 max_execution_time

此配置也在php.ini中,也就是说它是php的配置而不是fpm的,从源码注释上看这个配置的含义是:每个PHP脚本的最长执行时间。

默认值为30s,cli模式下为0(即cli下此配置不生效)。

从字面意义上猜测这个配置控制的是整个PHP脚本的最大执行耗时,也就是超过这个值PHP就不再执行了。我们用下面的例子测试下(max_execution_time = 10s):

//test.php
<?php
sleep(20);

echo "hello~";
?>

max_execution_time配置的是10s,按照上面的猜测,浏览器请求test.php将因为超时不会有任何输出,并可能返回某个500以上的错误,我们来实际操作下(不要用cli执行):

curl http://127.0.0.1:8000/test.php

结果输出:

hello~

很遗憾,结果不是预期的那样,脚本执行的很顺利,并没有中断,难道max_execution_time配置对fpm无效?网上有些文章认为"如果php-fpm中设置了 request_terminate_timeout 的话,那么 max_execution_time 就不生效",事实上这是错误的,这俩值是没有任何关联的,下面我们就从内核看下max_execution_time具体的实现。

max_execution_timephp_execute_script()函数中使用的:

//main/main.c #line:2400
PHPAPI int php_execute_script(zend_file_handle *primary_file)
{
    ...

    //注意zend_try,后面会用到
    zend_try {
        ...
        if (PG(max_input_time) != -1) { //非cli模式
            ...
            zend_set_timeout(INI_INT("max_execution_time"), 0);
        }

        ...
        zend_execute_scripts(...);
    }zend_end_try();
}

之前的一篇文章《一张图看PHP框架的整体执行流程》画的一幅图已经介绍过php_execute_script()函数的先后调用顺序:php_module_startup -> php_request_startup -> php_execute_script -> php_request_shutdown -> php_module_shutdown,它是PHP脚本的具体解析、执行的入口,max_execution_time在这个位置设置的可以进一步确定它控制的是PHP的执行时长,我们再到zend_set_timeout()中看下(去除了一些windows的无关代码):

//Zend/zend_execute_API.c #line:1222
void zend_set_timeout(zend_long seconds, int reset_signals)
{
    EG(timeout_seconds) = seconds;
    ...
    {
        struct itimerval t_r;       /* timeout requested */
        int signo;

        if(seconds) {
            t_r.it_value.tv_sec = seconds;
            t_r.it_value.tv_usec = t_r.it_interval.tv_sec = t_r.it_interval.tv_usec = 0;
            setitimer(ITIMER_PROF, &t_r, NULL); //设定一个定时器,seconds秒后触发,到达时间后将发出ITIMER_PROF信号
        }
        signo = SIGPROF;

        if (reset_signals) {
#   ifdef ZEND_SIGNALS
            zend_signal(signo, zend_timeout);
#   else
            sigset_t sigset;

            signal(signo, zend_timeout); //设置信号处理函数,这个例子中就是设置ITIMER_PROF信号由zend_timeout()处理
            sigemptyset(&sigset);
            sigaddset(&sigset, signo);
            sigprocmask(SIG_UNBLOCK, &sigset, NULL);
#   endif
        }
    }
}

如果你用过C语言里面的定时器看到这里应该明白max_execution_time的含义了吧?zend_set_timeout设定了一个间隔定时器(itimer),类型为ITIMER_PROF,问题就出在这,这个类型计算的程序在用户态、内核态下的执行时长,下面简单介绍下linux几种不同类型的定时器。

a. 间隔定时器itimer

间隔定时器设定的接口setitimer定义如下,setitimer()为Linux的API,并非C语言的Standard Library,setitimer()有两个功能,一是指定一段时间后,才执行某个function,二是每间格一段时间就执行某个function。

int setitimer(int which, const struct itimerval *value, struct itimerval *ovalue));

struct itimerval {
    struct timeval it_interval; //it_value时间后每隔it_interval执行
  struct timeval it_value; //it_value时间后将开始执行
};

struct timeval {
    long tv_sec;
  long tv_usec;
};

which为定时器类型:

  • ITIMER_REAL : 以__系统真实时间__来计算,它送出SIGALRM信号

  • ITIMER_VIRTUAL : 以该进程在__用户态__下花费的时间来计算,它送出SIGVTALRM信号

  • ITIMER_PROF : 以该进程在__用户态__下和__内核态__下所费的时间来计算,它送出SIGPROF信号

it_interval指定间隔时间,it_value指定初始定时时间。如果只指定it_value,就是实现一次定时;如果同时指定 it_interval,则超时后,系统会重新初始化it_value为it_interval,实现重复定时;两者都清零,则会清除定时器。

b. 内核态、用户态

操作系统的很多操作会消耗系统的物理资源,例如创建一个新进程时,要做很多底层的细致工作,如分配物理内存,从父进程拷贝相关信息,拷贝设置页目录、页表等,这些操作显然不能随便让任何程序都可以做,于是就产生了特权级别的概念,与系统相关的一些特别关键性的操作必须由高级别的程序来完成,这样可以做到集中管理,减少有限资源的访问和使用冲突。Intel的X86架构的CPU提供了0到3四个特权级,而在我们Linux操作系统中则主要采用了0和3两个特权级,也就是我们通常所说的内核态和用户态。

每个进程都有一个4G大小的虚拟地址空间,其中03G为用户空间,34G为内核空间,每个进程都有一各用户栈、内核栈,程序从用户空间开始执行,当发生系统调用发生异常外设产生中断时就从用户空间切换到内核空间,系统调用都有哪些呢?可以从kernal源码中查到:linux-4.9/arch/x86/entry/syscalls/syscall_xx.tbl,比如读写文件read/write、socket等。

PHP本质就是普通的C程序,所以我们直接按照C语言程序分析就行了,内核态、用户态的区分简单讲就是如果cpu当前执行在用户栈还是内核栈上,比如程序里写的if、for、+/-等都在用户态下执行,而读写文件、请求数据库则将切换到内核态。

c. linux IO模式

PHP中操作最多的就是IO,比如访问数据、rpc调用等等,因此这里单独分析下IO操作引起的进程挂起。

对于一次IO访问(以read举例),数据会先被拷贝到操作系统内核的缓冲区中,然后才会从操作系统内核的缓冲区拷贝到应用程序的地址空间,linux系统产生了下面五种网络模式:

  • 阻塞 I/O(blocking IO)
  • 非阻塞 I/O(nonblocking IO)
  • I/O 多路复用( IO multiplexing)
  • 信号驱动 I/O( signal driven IO)
  • 异步 I/O(asynchronous IO): linux下很少用

阻塞IO下当用户进程调用了recvfrom这个系统调用,kernel就开始了IO的第一个阶段:准备数据(对于网络IO来说,很多时候数据在一开始还没有到达。比如,还没有收到一个完整的UDP包。这个时候kernel就要等待足够的数据到来)。这个过程需要等待,也就是说数据被拷贝到操作系统内核的缓冲区中是需要一个过程的。而在用户进程这边,整个进程会被阻塞、休眠。当kernel一直等到数据准备好了,它就会将数据从kernel中拷贝到用户内存,然后kernel返回结果,用户进程才解除block的状态,重新运行起来。通过ps命令我们也可出fpm等待io响应时的状态:

[qinpeng@kvm980199 ~]$ ps aux|grep fpm
xiaoju   26700  0.0  0.2 207812  5340 ?        S    Dec28   0:16 php-fpm: pool www

ps命令进程的状态:R 正在运行或可运行 S 可中断睡眠 (休眠中, 受阻, 在等待某个条件的形成或接受到信号)。

最后我们回到PHP,总结一下:

ITIMER_VIRTUAL定时器只会在用户态下倒计时,在内核态下将停止倒计时,ITIMER_PROF在两种状态下都倒计时,ITIMER_REAL则以系统实际时间倒计时,因为除了这两种状态,程序还有一种状态:挂起,也就是说ITIMER_REAL之外的两种定时器记录的都是进程的活跃状态,也就是cpu忙碌的状态,而读写文件、sleep、socket等操作因为等待时间发生而挂起的时间则不包括。这就是为什么上面测试脚本执行的时间比max_execution_time长的原因。这个时间限制的是__执行__时间,不含io阻塞、sleep等等进程挂起的时长,所以PHP脚本的实际执行时间远远大于max_execution_time的设定。

所以如果PHP里的定时器setitimer用的是ITIMER_REAL或者用下面的代码测试,上面的例子结果就是我们预期了。

<?php
while(1){
}
?>

将返回: 500 Internal Server Error。

现在可以清楚上面测试例子为什么不是预期结果的原因了,文章开始提到的故障也是因为等待redis响应而导致fpm的worker进程挂起,等待redis响应的时间并不在ITIMER_PROF计时内,所以即使我们配的max_execution_time < request_terminate_timeout,也无法因为IO阻塞的原因而命中max_execution_time的限制,除非类似死循环这类导致长时间占用cpu的情况。

我们接着从源码看下max_execution_time超时时PHP是如何中断执行、返回错误的。

zend_set_timeout()函数中设定的ITIMER_PROF定时器超时信号处理函数为zend_timeout()

//Zend/zend_execute_API.c #line:1181
ZEND_API void zend_timeout(int dummy)
{

    if (zend_on_timeout) {
        ...
        zend_on_timeout(EG(timeout_seconds));
    }

    zend_error_noreturn(E_ERROR, "Maximum execution time of %pd second%s exceeded", EG(timeout_seconds), EG(timeout_seconds) == 1 ? "" : "s");
}

不要着急去zend_on_timeout里看,注意这个函数__zend_error_noreturn()__,从函数名称可以猜测它抛出了一个error错误,实际这就是将PHP中断执行的操作:

//Zend/zend.c
ZEND_COLD void zend_error_noreturn(int type, const char *format, ...) __attribute__ ((alias("zend_error"),noreturn));

ZEND_API ZEND_COLD void zend_error(int type, const char *format, ...)
{
    ...

    /* if we don't have a user defined error handler */
    if (Z_TYPE(EG(user_error_handler)) == IS_UNDEF
            || !(EG(user_error_handler_error_reporting) & type)
            || EG(error_handling) != EH_NORMAL) {
        zend_error_cb(type, error_filename, error_lineno, format, args);
    } else switch (type) {
        ...
    }

    ...
}

zend_error_cb是一个函数指针,它在php_module_startup()中定义:

//main/main.c #line:2011
int php_module_startup(sapi_module_struct *sf, zend_module_entry *additional_modules, uint num_additional_modules)
{
    ...

    zuf.error_function = php_error_cb;
    ...

    zend_startup(&zuf, NULL);
    ...
}

//Zend/zend.c #line:632
int zend_startup(zend_utility_functions *utility_functions, char **extensions)
{
    ...

    zend_error_cb = utility_functions->error_function; //即:zend_error_cb = php_error_cb
    ...
}

最终调用的是php_error_cb()

//main/main.c #line:973
static ZEND_COLD void php_error_cb(int type, const char *error_filename, const uint error_lineno, const char *format, va_list args)
{
    ...

    switch (type) {
        ...
        case E_ERROR:
        case E_RECOVERABLE_ERROR:
        case E_PARSE:
        case E_COMPILE_ERROR:
        case E_USER_ERROR:
            ...
            /* the parser would return 1 (failure), we can bail out nicely */
            if (type == E_PARSE) {
                CG(parse_error) = 0;
            } else {
                /* restore memory limit */
                zend_set_memory_limit(PG(memory_limit));
                efree(buffer);
                zend_objects_store_mark_destructed(&EG(objects_store));
                zend_bailout(); //终止执行,try-catch
                return;
            }
        ...
    }
    ...
}

再展开__zend_bailout()__:

//zend.h
#define zend_bailout()      _zend_bailout(__FILE__, __LINE__)

//zend.c #line:893
ZEND_API ZEND_COLD void _zend_bailout(char *filename, uint lineno)
{

    if (!EG(bailout)) {
        zend_output_debug_string(1, "%s(%d) : Bailed out without a bailout address!", filename, lineno);
        exit(-1);
    }
    CG(unclean_shutdown) = 1;
    CG(active_class_entry) = NULL;
    CG(in_compilation) = 0;
    EG(current_execute_data) = NULL;
    LONGJMP( *EG(bailout), FAILURE);
}

//zend_portability.h
# define SETJMP(a) sigsetjmp(a, 0)
# define LONGJMP(a,b) siglongjmp(a, b)
# define JMP_BUF sigjmp_buf

还记得上面php_execute_script()中在PHP脚本执行函数外的zend_try{...}吗?

实际这是PHP里面实现的C语言层面的try-catch机制,try时利用__sigsetjmp()将当前执行位置保存到__EG(bailout),中间执行抛出异常时利用__siglongjmp()跳回到try保存的位置__EG(bailout),展开来看php_execute_script

PHPAPI int php_execute_script(zend_file_handle *primary_file)
{
    ...

    JMP_BUF *__orig_bailout = EG(bailout);
    JMP_BUF __bailout; 

    EG(bailout) = &__bailout;
    if (SETJMP(__bailout)==0) { //初次设置时值为0,当执行LONGJMP时将跳回到这个位置,且值不为0,即从if之外的操作执行
        ...

        if (PG(max_input_time) != -1) {
            ...
            zend_set_timeout(INI_INT("max_execution_time"), 0);
        }
        ...

        zend_execute_scripts(...); //parse -> execute
    }
    //zend_bailout()将接着从这里执行
    EG(bailout) = __orig_bailout;
    ...
}

更多siglongjmp、sigsetjmp的说明可以自行查下,https://github.com/pangudashu/anywork/tree/master/try_catch

现在你应该清楚max_execution_time的实现机制及用法了吧?

最后总结一下__max_execution_time__的内核处理:PHP从执行php_execute_script开始活跃时间累计达到max_execution_time时,系统送出SIGPROF信号,此信号由__zend_timeout()处理,最终内核调用__zend_bailout(),回到开始执行的位置,结束php_execute_script执行,进入php_request_shutdown阶段。


1.3 request_terminate_timeout

上一节我们详细分析了PHP自身max_execution_time的实现原理,这一节我们再简单看下fpm退出主因:request_terminate_timeout

这个配置属于php-fpm,注释写的是:一个request执行的最长时间,超过这个时间worker进程将被killed。

php-fpm是多进程模型,与nginx类似,master负责管理worker进程,worker为进程阻塞模型,每个worker同一时刻只能处理一个请求。master与worker之间可以进行通信,master可以启动、杀掉worker。

这里不再对fpm详细说明,只简单看下request_terminate_timeout的处理:

//fpm_process_ctl.c
void fpm_pctl_heartbeat(struct fpm_event_s *ev, short which, void *arg) 
{
    ...

    if (which == FPM_EV_TIMEOUT) {
        fpm_clock_get(&now);
        fpm_pctl_check_request_timeout(&now);
        return;
    }
    
    ...
    
    fpm_event_set_timer(&heartbeat, FPM_EV_PERSIST, &fpm_pctl_heartbeat, NULL);
    fpm_event_add(&heartbeat, fpm_globals.heartbeat);
}

static void fpm_pctl_check_request_timeout(struct timeval *now)
{
    ...
    int terminate_timeout = wp->config->request_terminate_timeout; //php-fpm.conf中的request_terminate_timeout配置
    int slowlog_timeout = wp->config->request_slowlog_timeout;

    ...

    fpm_request_check_timed_out(child, now, terminate_timeout, slowlog_timeout);
    ...
}

再看下fpm_request_check_timed_out:

//fpm_request.c
void fpm_request_check_timed_out(struct fpm_child_s *child, struct timeval *now, int terminate_timeout, int slowlog_timeout)
{
    ...

    if (terminate_timeout && tv.tv_sec >= terminate_timeout) {
        ...

        fpm_pctl_kill(child->pid, FPM_PCTL_TERM); //kill worker

        zlog(...);
    }
}

可以看到,master如果发现worker处理一个request时间超过了request_terminate_timeout将发送TERM信号给worker,直接导致worker退出,而这个时间是从worker接到请求开始计时的,是系统时间。


2、优化思路

上面分析了request_terminate_timeoutmax_execution_time,两者在PHP脚本执行超时的控制上都有一些欠缺,首先fpm的处理,虽然直接kill调进程是最简单的方式,但对于业务而言成本太高,个别接口超时严重这种处理方式将直接导致所有的worker进程处于不断的重启状态,每一个进程只处理一个请求就被干掉了;另外max_execution_time的限制实际没有太大意义。

当然业务层面的优化才是根本解决之道,这里说的只是最后的一层防护,避免因为代码的疏漏导致业务雪崩,出现问题的时候尽量减小影响、尽快定位出现问题的地方。

最容易想到的优化就是将上面提到的超时定时器类型改为:ITIMER_REAL,关于这个方案我用PHP扩展实现了一个,通过callback回调机制控制一个函数的执行时间,有兴趣的具体可以翻下代码:https://github.com/pangudashu/timeout,因为同一种定时器,linux下每个进程同一时刻只支持一个,所以目前不支持嵌套调用,可以适当修改支持多定时器。