skynet源码分析之定时器skynet_timer.c

skynet自带定时器功能skynet-src/skynet_timer.c，在skynet启动时会创建一个线程专门跑定时器。每帧(0.0025秒/帧)调用skynet_updatetime()

// skynet-src/skynet_start.c

create_thread(&pid[1], thread_timer, m);

static void *
thread_timer(void *p) {
    struct monitor * m = p;
    skynet_initthread(THREAD_TIMER);
    for (;;) {
        skynet_updatetime();
        CHECK_ABORT
        wakeup(m,m->count-1);
        usleep(2500);  //2500微妙=0.0025秒
        if (SIG) {
            signal_hup();
            SIG = 0;
        }
    }
    ...
}

1. 设计思想

skynet的设计思想参考Linux内核动态定时器的机制，参考Linux动态内核定时器介绍http://www.cnblogs.com/leaven/archive/2010/08/19/1803382.html，

在skynet里，时间精度是0.01秒，这对于游戏服务器来说已经足够了，定义1滴答=0.01秒，1秒=100滴答。其核心思想是：每个定时器设置一个到期的滴答数，与当前系统的滴答数(启动时是0，然后1滴答1滴答往后跳)比较差值，如果差值interval比较小（0<=interval<=2^8-1），表示定时器即将到来，需要严格关注，把它们保存在2^8个定时器链表里；如果interval越大，表示定时器越远，可以不用太关注，划分成4个等级，2^8<=interval<=2^(8+6)-1，2^(8+6)<=interval<=2^(8+6+6)，...，每个等级只需要2^6个定时器链表保存，比如对于2^8<=interval<=2^(8+6)-1的定时器，将interval>>8相同的值idx保存在第一个等级位置为idx的链表里。

这样做的优势是：不用为每一个interval创建一个链表，而只需要2^8+4*(2^6)个链表，大大节省了内存。

之后，在不同情况下，分配不同等级的定时器，等级越高，表示越遥远，需要重新分配的次数越少。

2. 源码分析

数据结构：timer->near，保存2^8个即将到来的定时器链表；timer->t，保存4个分级数组，数组的每一项是一个链表；timer->time保存从skynet启动到现在走过的滴答数

// skynet-src/skynet_timer.c
struct timer_event {
    uint32_t handle;
    int session;
};

struct timer_node { //单个定时器节点
    struct timer_node *next;
    uint32_t expire; //到期滴答数
};

struct link_list { //定时器链表
    struct timer_node head;
    struct timer_node *tail;
};

struct timer {
    struct link_list near[TIME_NEAR];
    struct link_list t[4][TIME_LEVEL]; 
    struct spinlock lock;
    uint32_t time; //启动到现在走过的滴答数，等同于current
    ...
};

调用skynet_timeout创建一个定时器

然后调用timer_add（第8行），给timer_node指针分配空间，timer_node结构里并没有timer_event字段，除了分配node自身大小外，额外再分配timer_event大小的空间用来存放event，之后通过node+1的位置可以获取到timer_event数据

然后调用add_node（第21行），添加到定时器链表里，如果定时器的到期滴答数跟当前比较近(<2^8)，表示即将触发定时器添加到T->near数组里，否则根据差值大小添加到对应的T->T[i]中

// skynet-src/skynet_timer.c
int
skynet_timeout(uint32_t handle, int time, int session) {
    ...
    struct timer_event event;
    event.handle = handle;
    event.session = session;
    timer_add(TI, &event, sizeof(event), time);

    return session;
}

static void
timer_add(struct timer *T,void *arg,size_t sz,int time) {
    struct timer_node *node = (struct timer_node *)skynet_malloc(sizeof(*node)+sz);
    memcpy(node+1,arg,sz);

    SPIN_LOCK(T);

    node->expire=time+T->time;
    add_node(T,node);

    SPIN_UNLOCK(T);
}

static void
add_node(struct timer *T,struct timer_node *node) {
    uint32_t time=node->expire;
    uint32_t current_time=T->time;
        
    if ((time|TIME_NEAR_MASK)==(current_time|TIME_NEAR_MASK)) {
        link(&T->near[time&TIME_NEAR_MASK],node);
    } else {
        int i;
        uint32_t mask=TIME_NEAR << TIME_LEVEL_SHIFT;
        for (i=0;i<3;i++) {
            if ((time|(mask-1))==(current_time|(mask-1))) {
                 break;
            }
            mask <<= TIME_LEVEL_SHIFT;
        }

        link(&T->t[i][((time>>(TIME_NEAR_SHIFT + i*TIME_LEVEL_SHIFT)) & TIME_LEVEL_MASK)],node);        
    }
}

每帧从T->near中触发到期的定时器链表，near数组里每一项的链表中的所有节点的到期滴答数是相同的。

调用dispatch_list进行分发，通过current+1获取timer_event数据（第18行），然后给event->handle push一条消息表示触发定时器（第25行）

// skynet-src/skynet_timer.c
static inline void
timer_execute(struct timer *T) {
    int idx = T->time & TIME_NEAR_MASK;
        
    while (T->near[idx].head.next) {
        struct timer_node *current = link_clear(&T->near[idx]);
        SPIN_UNLOCK(T);
        // dispatch_list don't need lock T
        dispatch_list(current);
        SPIN_LOCK(T);
    }
}

static inline void
dispatch_list(struct timer_node *current) {
    do {
        struct timer_event * event = (struct timer_event *)(current+1);
        struct skynet_message message;
        message.source = 0;
        message.session = event->session;
        message.data = NULL;
        message.sz = (size_t)PTYPE_RESPONSE << MESSAGE_TYPE_SHIFT;

       skynet_context_push(event->handle, &message);
               
       struct timer_node * temp = current;
       current=current->next;
       skynet_free(temp);      
    } while (current);
}

每帧除了触发定时器外，还需重新分配定时器所在区间(timer_shift)，因为T->near里保存即将触发的定时器，所以每TIME_NEAR-1（2^8-1）个滴答数才有可能需要分配（第22行）。否则，分配T->t中某个等级即可。

当T->time的低8位不全为0时，不需要分配，所以每2^8个滴答数才有需要分配一次；

当T->time的第9-14位不全为0时，重新分配T[0]等级，每2^8个滴答数分配一次，idx从1开始，每次分配+1；

当T->time的第15-20位不全为0时，重新分配T[1]等级，每2^(8+6)个滴答数分配一次，idx从1开始，每次分配+1；

当T->time的第21-26位不全为0时，重新分配T[2]等级，每2^(8+6+6)个滴答数分配一次，idx从1开始，每次分配+1；

当T->time的第27-32位不全为0时，重新分配T[3]等级，每2^(8+6+6+6)个滴答数分配一次，idx从1开始，每次分配+1；

即等级越大的定时器越遥远，越不关注，需要重新分配的次数也就越少。

// skynet-src/skynet_timer.c
static void
move_list(struct timer *T, int level, int idx) {
    struct timer_node *current = link_clear(&T->t[level][idx]);
    while (current) {
        struct timer_node *temp=current->next;
        add_node(T,current);
        current=temp;
    }
}

static void
timer_shift(struct timer *T) {
    int mask = TIME_NEAR;
    uint32_t ct = ++T->time;
    if (ct == 0) {
        move_list(T, 3, 0);
    } else {
        uint32_t time = ct >> TIME_NEAR_SHIFT;
        int i=0;

        while ((ct & (mask-1))==0) {
            int idx=time & TIME_LEVEL_MASK;
            if (idx!=0) {
                move_list(T, i, idx);
                break;                          
            }
            mask <<= TIME_LEVEL_SHIFT;
            time >>= TIME_LEVEL_SHIFT;
            ++i;
        }
    }
}

3. 如何使用

在C层通过skynet_timeout创建一个定时器

在Lua层通过skynet.timeout创建一个定时器，比如，skynet.timeout(200, f)，即经过200个滴答数(2秒钟)后触发回调函数f。