Libevent源码分析-----超时event的处理

最新推荐文章于 2023-06-25 12:15:45 发布

一介丶草民

最新推荐文章于 2023-06-25 12:15:45 发布

阅读量2.9k

点赞数

分类专栏：基本库相关

基本库相关专栏收录该内容

27 篇文章 0 订阅

订阅专栏

如何成为超时event：

Libevent允许创建一个超时event，使用evtimer_new宏。

[cpp]view plaincopy 
    
 //event.h文件  
 #define evtimer_new(b, cb, arg)        event_new((b), -1, 0, (cb), (arg))  

从宏的实现来看，它一样是用到了一般的event_new，并且不使用任何的文件描述符。从超时event宏的实现来看，无论是evtimer创建的event还是一般event_new创建的event，都能使得Libevent进行超时监听。其实，使得Libevent对一个event进行超时监听的原因是：在调用event_add的时候，第二参数不能为NULL，要设置一个超时值。如果为NULL，那么Libevent将不会为这个event监听超时。下文统一称设置了超时值的event为超时event。

超时event的原理：

Libevent对超时进行监听的原理不同于之前讲到的对信号的监听，Libevent对超时的监听的原理是，多路IO复用函数都是有一个超时值。如果用户需要Libevent同时监听多个超时event，那么Libevent就把超时值最小的那个作为多路IO复用函数的超时值。自然，当时间一到，就会从多路IO复用函数返回。此时对超时event进行处理即可。

Libevent运行用户同时监听多个超时event，那么就必须要对这个超时值进行管理。Libevent提供了小根堆和通用超时(common timeout)这两种管理方式。下文为了叙述方便，就假定使用的是小根堆。

工作流程：

下面来看一下超时event的工作流程。

设置超时值：

首先调用event_add时要设置一个超时值，这样才能成为一个超时event。

[cpp]view plaincopy 
    
 //event.c文件  
 //在event_add中，会把第三个参数设为0.使得使用的是相对时间  
 static inline int  
 event_add_internal(struct event *ev, const struct timeval *tv,  
     int tv_is_absolute)  
 {  
     struct event_base *base = ev->ev_base;  
     int res = 0;  
     int notify = 0;  
   
     //tv不为NULL,就说明是一个超时event,在小根堆中为其留一个位置  
     if (tv != NULL && !(ev->ev_flags & EVLIST_TIMEOUT)) {  
         if (min_heap_reserve(&base->timeheap,  
             1 + min_heap_size(&base->timeheap)) == -1)  
             return (-1);  /* ENOMEM == errno */  
     }  
   
     ...//将IO或者信号event插入到对应的队列中。  
   
   
     if (res != -1 && tv != NULL) {  
         struct timeval now;  
   
         //用户把这个event设置成EV_PERSIST。即永久event.  
         //如果没有这样设置的话，那么只会超时一次。设置了，那么就  
         //可以超时多次。那么就要记录用户设置的超时值。  
         if (ev->ev_closure == EV_CLOSURE_PERSIST && !tv_is_absolute)  
             ev->ev_io_timeout = *tv;  
   
         //该event之前被加入到超时队列。用户可以对同一个event调用多次event_add  
         //并且可以每次都用不同的超时值。  
         if (ev->ev_flags & EVLIST_TIMEOUT) {  
             /* XXX I believe this is needless. */  
             //之前为该event设置的超时值是所有超时中最小的。  
             //从下面的删除可知，会删除这个最小的超时值。此时多路IO复用函数  
             //的超时值参数就已经改变了。  
             if (min_heap_elt_is_top(ev))  
                 notify = 1; //要通知主线程。可能是次线程为这个event调用本函数  
   
             //从超时队列中删除这个event。因为下次会再次加入。  
             //多次对同一个超时event调用event_add,那么只能保留最后的那个。  
             event_queue_remove(base, ev, EVLIST_TIMEOUT);  
         }  
   
         //因为可以在次线程调用event_add。而主线程刚好在执行event_base_dispatch  
         if ((ev->ev_flags & EVLIST_ACTIVE) &&  
             (ev->ev_res & EV_TIMEOUT)) {//该event被激活的原因是超时  
               
             ...  
             event_queue_remove(base, ev, EVLIST_ACTIVE);  
         }  
   
         //获取现在的时间  
         gettime(base, &now);  
   
         //虽然用户在event_add时只需用一个相对时间，但实际上在Libevent内部  
         //还是要把这个时间转换成绝对时间。从存储的角度来说，存绝对时间只需  
         //一个变量。而相对时间则需两个，一个存相对值，另一个存参照物。  
         if (tv_is_absolute) { //该参数指明时间是否为一个绝对时间  
             ev->ev_timeout = *tv;  
         } else {  
             //参照时间 + 相对时间  ev_timeout存的是绝对时间  
             evutil_timeradd(&now, tv, &ev->ev_timeout);  
         }  
   
   
         //将该超时event插入到超时队列中  
         event_queue_insert(base, ev, EVLIST_TIMEOUT);  
   
         //本次插入的超时值，是所有超时中最小的。那么此时就需要通知主线程。  
         if (min_heap_elt_is_top(ev))  
             notify = 1;  
     }  
   
     //如果代码逻辑中是需要通知的。并且本线程不是主线程。那么就通知主线程  
     if (res != -1 && notify && EVBASE_NEED_NOTIFY(base))  
         evthread_notify_base(base);  
   
     return (res);  
 }  

对于同一个event，如果是IO event或者信号event，那么将无法多次添加。但如果是一个超时event，那么是可以多次添加的。并且对应超时值会使用最后添加时指明的那个，之前的统统不要，即替换掉之前的超时值。

代码中出现了多次使用了notify变量。这主要是用在：次线程在执行这个函数，而主线程在执行event_base_dispatch。前面说到Libevent能对超时event进行监听的原理是：多路IO复用函数有一个超时参数。在次线程添加的event的超时值更小，又或者替换了之前最小的超时值。在这种情况下，都是要通知主线程，告诉主线程，最小超时值已经变了。关于通知主线程evthread_notify_base，可以参考博文《evthread_notify_base通知主线程》。

代码中的第三个判断体中用到了ev->ev_io_timeout。但event结构体中并没有该变量。其实，ev_io_timeout是一个宏定义。

[cpp]view plaincopy 
    
 //event-internal.h文件  
 #define ev_io_timeout   _ev.ev_io.ev_timeout  

要注意的一点是，在调用event_add时设定的超时值是一个时间段(可以认为隔多长时间就触发一次)，相对于现在，即调用event_add的时间，而不是调用event_base_dispatch的时间。

调用多路IO复用函数等待超时：

现在来看一下event_base_loop函数，看其是怎么处理超时event的。

[cpp]view plaincopy 
    
 //event.c文件  
 int  
 event_base_loop(struct event_base *base, int flags)  
 {  
     const struct eventop *evsel = base->evsel;  
     struct timeval tv;  
     struct timeval *tv_p;  
     int res, done, retval = 0;  
   
     EVBASE_ACQUIRE_LOCK(base, th_base_lock);  
   
     base->running_loop = 1;  
   
     done = 0;  
     while (!done) {  
         tv_p = &tv;  
         if (!N_ACTIVE_CALLBACKS(base) && !(flags & EVLOOP_NONBLOCK)) {  
             // 根据Timer事件计算evsel->dispatch的最大等待时间(超时值最小)  
             timeout_next(base, &tv_p);  
         } else { //不进行等待  
             //把等待时间置为0，即可不进行等待，马上触发事件  
             evutil_timerclear(&tv);  
         }  
   
         res = evsel->dispatch(base, tv_p);  
   
         //处理超时事件，将超时事件插入到激活链表中  
         timeout_process(base);  
   
         if (N_ACTIVE_CALLBACKS(base)) {  
             int n = event_process_active(base);  
         }   
     }  
   
 done:  
     base->running_loop = 0;  
     EVBASE_RELEASE_LOCK(base, th_base_lock);  
   
     return (retval);  
 }  
   
   
 //选出超时值最小的那个  
 static int  
 timeout_next(struct event_base *base, struct timeval **tv_p)  
 {  
     /* Caller must hold th_base_lock */  
     struct timeval now;  
     struct event *ev;  
     struct timeval *tv = *tv_p;  
     int res = 0;  
   
     // 堆的首元素具有最小的超时值，这个是小根堆的性质。  
     ev = min_heap_top(&base->timeheap);  
   
     //堆中没有元素  
     if (ev == NULL) {  
         *tv_p = NULL;  
         goto out;  
     }  
   
     //获取当然时间  
     if (gettime(base, &now) == -1) {  
         res = -1;  
         goto out;  
     }  
   
     // 如果超时时间<=当前时间，不能等待，需要立即返回  
     // 因为ev_timeout这个时间是由event_add调用时的绝对时间 + 相对时间。所以ev_timeout是  
     // 绝对时间。可能在调用event_add之后，过了一段时间才调用event_base_diapatch,所以  
     // 现在可能都过了用户设置的超时时间。  
     if (evutil_timercmp(&ev->ev_timeout, &now, <=)) {  
         evutil_timerclear(tv); //清零，这样可以让dispatcht不会等待，马上返回  
         goto out;  
     }  
   
     // 计算等待的时间=当前时间-最小的超时时间  
     evutil_timersub(&ev->ev_timeout, &now, tv);  
   
 out:  
     return (res);  
 }  

上面代码的流程是：计算出本次调用多路IO复用函数的等待时间，然后调用多路IO复用函数中等待超时。

激活超了时的event：

上面代码中的timeout_process函数就是处理超了时的event。

[cpp]view plaincopy 
    
 //event.c文件  
 //把超时了的event，放到激活队列中。并且，其激活原因设置为EV_TIMEOUT  
 static void  
 timeout_process(struct event_base *base)  
 {  
     /* Caller must hold lock. */  
     struct timeval now;  
     struct event *ev;  
   
     if (min_heap_empty(&base->timeheap)) {  
         return;  
     }  
   
     gettime(base, &now);  
   
     //遍历小根堆的元素。之所以不是只取堆顶那一个元素，是因为当主线程调用多路IO复用函数  
     //进入等待时，次线程可能添加了多个超时值更小的event  
     while ((ev = min_heap_top(&base->timeheap))) {  
         //ev->ev_timeout存的是绝对时间  
         //超时时间比此刻时间大，说明该event还没超时。那么余下的小根堆元素更不用检查了。  
         if (evutil_timercmp(&ev->ev_timeout, &now, >))  
             break;  
   
   
         //下面说到的del是等同于调用event_del.把event从这个event_base中(所有的队列都)  
         //删除。event_base不再监听之。  
         //这里是timeout_process函数。所以对于有超时的event，才会被del掉。  
         //对于有EV_PERSIST选项的event，在处理激活event的时候，会再次添加进event_base的。  
         //这样做的一个好处就是，再次添加的时候，又可以重新计算该event的超时时间(绝对时间)。  
         event_del_internal(ev);  
   
         //把这个event加入到event_base的激活队列中。  
         //event_base的激活队列又有该event了。所以如果该event是EV_PERSIST的，是可以  
         //再次添加进该event_base的  
         event_active_nolock(ev, EV_TIMEOUT, 1);  
     }  
 }  

当从多路IO复用函数返回时，就检查时间小根堆，看有多少个event已经超时了。如果超时了，那就把这个event加入到event_base的激活队列中。并且把这个超时del(删除)掉，这主要是用于非PERSIST 超时event的。删除一个event的具体操作可以查看这里。

把一个event添加进激活队列后的工作流程可以参考《Libevent工作流程探究》一文。

处理永久超时event：

现在来看一下如果该超时event有EV_PERSIST选项，在后面是怎么再次添加进event_base，因为前面的代码注释中已经说了，在选出超时event时，会把超时的event从event_base中delete掉。

[cpp]view plaincopy 
    
 //event.c文件  
 int  
 event_assign(struct event *ev, struct event_base *base, evutil_socket_t fd,   
                   short events, void (*callback)(evutil_socket_t, short, void *), void *arg)  
 {  
     ...  
     if (events & EV_PERSIST) {  
         ev->ev_closure = EV_CLOSURE_PERSIST;  
     } else {  
         ev->ev_closure = EV_CLOSURE_NONE;  
     }  
       
     return 0;  
 }  
   
   
 static int  
 event_process_active_single_queue(struct event_base *base,  
     struct event_list *activeq)  
 {  
     struct event *ev;  
   
     //遍历同一优先级的所有event  
     for (ev = TAILQ_FIRST(activeq); ev; ev = TAILQ_FIRST(activeq)) {  
   
         //下面这个if else 是用于IO event的。这里贴出，是为了了解一些非超时event是  
         //怎么处理永久事件(EV_PERSIST)的。  
         //如果是永久事件，那么只需从active队列中删除。  
         if (ev->ev_events & EV_PERSIST)  
             event_queue_remove(base, ev, EVLIST_ACTIVE);  
         else //不是的话，那么就要把这个event删除掉。  
             event_del_internal(ev);  
           
   
         switch (ev->ev_closure) {  
         //这个case只对超时event的EV_PERSIST才有用。IO的没有用  
         case EV_CLOSURE_PERSIST:  
             event_persist_closure(base, ev);  
             break;  
               
         default: //默认是EV_CLOSURE_NONE  
         case EV_CLOSURE_NONE:  
             //没有设置EV_PERSIST的超时event，就只有一次的监听机会  
             (*ev->ev_callback)(  
                 ev->ev_fd, ev->ev_res, ev->ev_arg);  
             break;  
         }  
     }  
 }  
   
   
 static inline void  
 event_persist_closure(struct event_base *base, struct event *ev)  
 {  
     //在event_add_internal函数中，如果是超时event并且有EV_PERSIST，那么就会把ev_io_timeout设置成  
     //用户设置的超时时间(相对时间)。否则为0。即不进入判断体中。  
     //说明这个if只用于处理具有EV_PERSIST属性的超时event  
     if (ev->ev_io_timeout.tv_sec || ev->ev_io_timeout.tv_usec) {  
         struct timeval run_at, relative_to, delay, now;  
         ev_uint32_t usec_mask = 0;  
   
         gettime(base, &now);  
    
         //delay是用户设置的超时时间。event_add的第二个参数  
         delay = ev->ev_io_timeout;  
         //是因为超时才执行到这里，event可以同时监听多种事件。如果是由于可读而执行  
         //到这里，那么就说明还没超时。  
         if (ev->ev_res & EV_TIMEOUT) { //如果是因为超时而激活，那么下次超时就是本次超时的  
             relative_to = ev->ev_timeout; // 加上 delay 时间。  
         } else {  
             relative_to = now; //重新计算超时值  
         }  
           
         evutil_timeradd(&relative_to, &delay, &run_at);  
         //无论relative是哪个时间，run_at都不应该小于now。  
         //如果小于，则说明是用户手动修改了系统时间，使得gettime()函数获取了一个  
         //之前的时间。比如现在是9点，用户手动调回到7点。  
         if (evutil_timercmp(&run_at, &now, <)) {  
             //那么就以新的系统时间为准  
             evutil_timeradd(&now, &delay, &run_at);  
         }  
   
         //把这个event再次添加到event_base中。注意，此时第三个参数为1，说明是一个绝对时间  
         event_add_internal(ev, &run_at, 1);  
     }  
     EVBASE_RELEASE_LOCK(base, th_base_lock);  
     (*ev->ev_callback)(ev->ev_fd, ev->ev_res, ev->ev_arg);//执行回调函数  
 }  

这段代码的处理流程是：如果用户指定了EV_PERSIST，那么在event_assign中就记录下来。在event_process_active_single_queue函数中会针对永久event进行调用event_persist_closure函数对之进行处理。在event_persist_closure函数中，如果是一般的永久event，那么就直接调用该event的回调函数。如果是超时永久event，那么就需要再次计算新的超时时间，并将这个event再次插入到event_base中。

这段代码也指明了，如果一个event因可读而被激活，那么其超时时间就要重新计算。而不是之前的那个了。也就是说，如果一个event设置了3秒的超时，但1秒后就可读了，那么下一个超时值，就要重新计算设置，而不是2秒后。

从前面的源码分析也可以得到：如果一个event监听可读的同时也设置了超时值，并且一直没有数据可读，最后超时了，那么这个event将会被删除掉，不会再等。