swoole_process源码分析之alarm操作

swoole_process提供的alarm是个高精度定时器，是操作系统setitimer系统调用的封装，可以设置微秒级别的定时器。定时器会触发信号，需要与swoole_process::signal或pcntl_signal配合使用。

function swoole_process::alarm(int $interval_usec, int $type = ITIMER_REAL) : bool

• $interval_usec 定时器间隔时间，单位为微秒。如果为负数表示清除定时器
• $type 定时器类型，0 表示为真实时间,触发SIGALAM信号，1 表示用户态CPU时间，触发SIGVTALAM信号，2 表示用户态+内核态时间，触发SIGPROF信号
• 设置成功返回true，失败返回false，可以使用swoole_errno得到错误码

下面我们分析下其流程。

static PHP_METHOD(swoole_process, alarm)
{
    long usec = 0;
    long type = ITIMER_REAL;
    
    //解析输入参数，其中usec表示定时器时间，单位为微秒；type表示定时器类型，具体参考上述php接口
    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l|l", &usec, &type) == FAILURE)
    {
        return;
    }

    if (!SWOOLE_G(cli))
    {
        swoole_php_fatal_error(E_ERROR, "cannot use swoole_process::alarm here.");
        RETURN_FALSE;
    }

    if (SwooleG.timer.fd != 0)//如果已经设置了其他定时事件，则不允许重复设置，这是linux系统的限制，即一个进程只允许设置一个定时器 
    {
        swoole_php_fatal_error(E_WARNING, "cannot use both 'timer' and 'alarm' at the same time.");
        RETURN_FALSE;
    }

    struct timeval now;
    if (gettimeofday(&now, NULL) < 0)//获取当前时间
    {
        swoole_php_error(E_WARNING, "gettimeofday() failed. Error: %s[%d]", strerror(errno), errno);
        RETURN_FALSE;
    }

    struct itimerval timer_set;//定义时间变量，这个主要用于后续的其他系统调用
    bzero(&timer_set, sizeof(timer_set));//初始化

    if (usec > 0)
    {
        long _sec = usec / 1000000;//获取秒数信息
        long _usec = usec - (_sec * 1000000);//获取微秒数信息

        timer_set.it_interval.tv_sec = _sec;//定时器间隔时间秒数信息
        timer_set.it_interval.tv_usec = _usec;//定时器间隔时间微秒数信息

        timer_set.it_value.tv_sec = _sec;//定时器起始时间秒数信息
        timer_set.it_value.tv_usec = _usec;//定时器起始时间微秒数信息

        if (timer_set.it_value.tv_usec > 1e6)//起始时间秒微秒数信息大于1000000，则调整秒数和微秒数信息
        {
            timer_set.it_value.tv_usec = timer_set.it_value.tv_usec - 1e6;
            timer_set.it_value.tv_sec += 1;
        }
    }

    if (setitimer(type, &timer_set, NULL) < 0)//调用linux函数setitimer，关于setitimer请参考linux系统函数手册
    {
        swoole_php_error(E_WARNING, "setitimer() failed. Error: %s[%d]", strerror(errno), errno);
        RETURN_FALSE;
    }

    RETURN_TRUE;
}