Libevent库源码的剖析

        Libevent是一个轻量级的开源高性能网络库，使用者众多，研究者更甚，它有几个显著的优点 ：                          

（1）事件驱动（event-driven），高性能;（2）轻量级，专注于网络，不如ACE那么臃肿庞大；（3）源代码相当精炼、易读；（4）跨平台，支持Windows、Linux、*BSD和Mac Os；（5）支持多种I/O多路复用技术， epoll、poll、dev/poll、select和kqueue等；（6）支持I/O，定时器和信号等事件；（7）注册事件优先级；

       Libevent已经被广泛的应用，作为底层的网络库；比如memcached、Vomit、Nylon、Netchat等等。

一、I/O框架库概述

      I/O框架库以库函数的形式，封装了较为底层的系统调用，给应用程序提供了一组便于使用的接口，它们更合理、高效和健壮，经受住了真是网络环境下的高压测试，以及事件的考验。各种I/O库实现原理基本相似，Reactor、Proactor或同时以两种模式实现。举例，基于Reactor模式的I/O框架库包括如下组件，组件关系如图1，图2总结了I/O框架库的工作时序。

1.句柄（Handle）

      I/O事件要处理的对象：I/O事件、信号和定时事件，统一称为事件源。一个事件源通常和一个句柄绑定在一起。句柄作用：当内核假案测到就绪事件时，将通过句柄通知应用程序。在Linux环境下，I/O事件对应的句柄是文件描述符，信号事件对应的句柄就是信号值。

2.事件多路分发器（EventDemultiplexer）

      循环事件：由于事件的到来的随机性、异步性，所以程序需要循环等待并处理事件。在事件循环中，等待事件一般使用I/O复用技术复用技术来实现。事件多路分发器：I/O框架库一般将系统支持的各种I/O复用调用封装成的统一的接口。事件多路分发器的demultiplex方法是等待事件的核心函数，其内部调用的是select、poll、epoll_wait等函数。事件多路分发器还需要实现register_event和remove_event方法，供调用者往事件多路分发器中添加和删除事件。

3.事件处理器和具体事件处理器（EventHandler & ConcreteEventHandler）

       事件处理器执行事件对应的业务逻辑。它通常包含一个或多个handle_event回调函数，回调函数在事件循环中被执行。I/O框架库提供的事件处理器通常是一个接口，用户需要继承它来实现自己的事件处理器，即具体事件处理器。因此事件处理器中的回调函数一般被声明为虚函数，以支持用户的扩展。

       事件处理器一般还提供一个get_handle方法，返回与该事件处理器关联的句柄。我们必须将事件处理器与句柄绑定，因为当事件多路分发器检测到有事件发生时，将通过句柄来通知应用程序，只有事件处理器与句柄绑定，才能在事件发生时获得正确的事件处理器。

4.Reactor

 Reactor是I/O框架库的核心。它提供的几个主要方法是：

（1）handle_events。该方法执行事件循环。重复过程：等待事件，再依次处理所有就绪事件对应的事件处理器。

（2）register_handler。该方法调用事件多路分发器的register_event方法来往事件多路分发器中注册一个事件。

（3）remove_handler。该方法调用事件多路分发器的remove_event方法来删除事件多路分发器中的一个事件。

二、Libevent源码分析

      Libevent是开源社区的一款高性能的I/O框架库，学习者和使用者众多。著名使用案例有：高性能的分布式内存对象缓存软件memcached，Google浏览器Chromium的Linux版本。作为一个I/O框架库，Libevent具有如下特点：

     （1）跨平台支持。Libevent支持Linux、UNIX和Windows。

     （2）统一事件源。Libevent对I/O事件、信号和定时事件提供统一的处理。

     （3）线程安全。Libevent使用libevent_pthreads库来提供线程安全支持。

     （4）基于Reactor模式的实现。

 1.一个实例

 用Libevent库实现一个“Hello World”程序，从整体上把握该软件的逻辑结构。(为了更好的注释，直接在博文里面编辑代码)

#include

#include

void signal_cb(int fd, short event, void *argc){

      struct event_base *base = (event_base*)argc;

      struct timeval delay = {2, 0};

      printf("Catch an interrupt signal; exiting cleanly in two seconds...\n");

      event_base_loopexit(base, &delay);        }

void timeout_cb(int fd, short event, void *argc)

{   printf("timeout\n");  }

int mian(){

     struct event_base *base = event_init();  //1个event_base相当于1个Reactor实例。event_init函数创建event_base对象。

     struct event *signal_event = evsignal_new(base, SIGINT, signal_cb, base);

     event_add(signal_event, NULL);  /*将事件处理器添加到注册事件队列中，并将该事件处理器对应的事件添加到事件多路分发器中。event_add函数相当于Reactor中的register_handler方法。*/

/*  evsignal_new和evtimer_new  分别用于创建信号事件处理器和定时事件处理器，定义在include/event2/event.h的宏， 它们的统一入口是event_new函数，用于创建通用事件处理器（图1中的EventHandler函数） 。 struct event* event_new(base, fd, events, cb, arg);base指定事件处理器从属的Reactor，创建I/O、信号、定时事件处理器,分别给fd参数传递文件描述符、信号值、-1。events参数指定时间类型。cb指定木变时间对应的回调函数，相当于图1的handle_event方法。arg参数是Reactor传递给回调函数的参数。 */

   timeval tv = {1, 0};

   struct event *timeout_event = evtimer_new(base, timeout_cb, NULL);

   event_add(timeout_event, &tv);

   event_base_dispatch(base);//执行 事件循环

   event_free(timeout_event);

   event_freee(signal_event);  //使用*_free系列函数来释放系统资源

   event_base_free(base);}

2.event结构体

      Libevent使用I/O事件队列将具有相同文件描述符的事件处理器组织在一起。所以当一个文件描述符上有事件发生时，事件多路分发器很快就能把所有相关的事件处理器添加到活动事件队列中。信号事件队列一样。

3.往注册事件队列中添加事件处理器

      创建一个event对象的函数是event_new，实现简单，主要是给event对象分配内存并初始化它的部分成员。event创建好后，应用程序需要调用event_add函数将其添加到注册事件队列中，并将对应的事件注册到事件多路分发器上。event_add函数在event.c中实现，主要是调用两外一个内部函数event_add_internal。其内部调用了几个重要函数：

（1）evmap_io_add。该函数将信号事件添加到事件多路分发器中，并将对应的事件处理器添加到I/O事件队列中，同时建立I/O事件和I/O事件处理器之间的映射关系。

（2）evmap_signal_add。该函数将I/O事件添加到事件多路分发器中，并将对应的事件处理器添加到信号事件队列中，同时建立信号事件和信号事件处理器之间的映射关系。

（3）event_queue_insert。该函数将事件处理器添加到各种事件队列中，将I/O事件处理器和信号事件处理器插入注册时间队列；将定时器插入通用定时器队列或时间堆；将被激活的事件处理器添加到活动事件队列中。

4.往事件多路分发器中注册事件

      event_queue_insert函数仅仅是将一个事件处理器加入event_base的某个事件队列中。对于新添加的I/O事件处理器和信号事件处理器，我们还需让事件多路分发器来监听其对应的事件，同时建立文件描述符、信号值与事件处理器之间的映射关系。这需要调用evmap_io_add和evmap_signal_add两个函数来完成。这两个函数相当于事件多路分发器中的register_event方法，由evmap.c文件来实现。

5.eventop结构体

      eventop结构体封装了I/O复用机制必要的一些操作，比如注册事件、等待事件等。它为event_base支持的所有后端I/O复用机制提供了一个统一的接口。定义在event_internal.h文件中，如下代码：

       Libevent支持的后端I/O复用技术及他们的优先级在event.c文件中定义。Libevent通过遍历eventop数组来选择其后端I/O复用技术。遍历的顺序是从数组第一个元素开始，到最后一个元素结束。在Linux下，Libevent默认选择后端的I/O复用技术是epoll。

6.event_base结构体

event_base是Libevent的Reactor。定义在event_internal.h文件中，代码清单如下：

7.事件循环

      最后，我们讨论一下Libevent的“动力”，即事件循环。Libevent中实现时间循环的函数是event_base_loop。该函数首先调用I/O事件多路分发器的事件监听函数，以等待事件。当有事件发生时，就依次处理。

      

      至此，介绍了Libevent库的核心代码。学习Libevent有助于提升程序设计功力，除了网络程序设计方面外，Libevent的代码里有很多有用的设计技巧和基础数据结构，比如信息隐藏、函数指针、c语言的多态支持、链表和堆等等，都有助于提升自身的程序功力。

参考资料：Libevent: http://monkey.org/~provos/libevent/