Libevent框架库简介

一、Libevent简介

Libevent是开源社区一款高性能的I/O框架库，其具有如下特点：

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

2、统一事件源。libevent对i/o事件、信号和定时事件提供统一的处理。

3、线程安全。libevent使用libevent_pthreads库来提供线程安全支持。

4、基于reactor模式的实现。

5、轻量级，专注于网络，没有ACE那么臃肿庞大

6、可以注册事件优先级

二、Reactor 模式

2.1 Reactor简介

首先来回想一下普通函数调用的机制：程序调用某函数->函数执行，程序等待->函数将结果和控制权返回给程->程序继续处理。

Reactor 释义“反应堆”，是一种事件驱动机制。和普通函数调用的不同之处在于：应用程序不是主动的调用某个 API 完成处理，而是恰恰相反，Reactor 逆置了事件处理流程，应用程序需要提供相应的接口并注册到 Reactor 上，如果相应的事件发生，Reactor 将主动调用应用程序注册的接口，这些接口又称为“回调函数”。使用 Libevent 也是向 Libevent 框架注册相应的事件和回调函数；当这些事件发生时，Libevent 会调用这些回调函数处理相应的事件（I/O 读写、定时和信号）。

2.2 Reactor 模式的优点

Reactor 模式是编写高性能网络服务器的必备威廉希尔官方网站 之一，它具有如下的优点：

1）响应快，不必为单个同步时间所阻塞，虽然 Reactor 本身依然是同步的；

2）编程相对简单，可以最大程度的避免复杂的多线程及同步问题，并且避免了多线程/ 进程的切换开销；

3）可扩展性，可以方便的通过增加 Reactor 实例个数来充分利用 CPU 资源；

4）可复用性，reactor 框架本身与具体事件处理逻辑无关，具有很高的复用性；

2.3 Reactor 模式框架

使用 Reactor 模型，必备的几个组件：事件源（描述符）、Reactor 框架、多路复用机制和事件处理程序，先来看看 Reactor 模型的整体框架，接下来再对每个组件做逐一说明。

1）事件源（handle）

由操作系统提供，用于识别每一个事件，如Socket描述符、文件描述符等。在Linux中，它用一个整数来表示。事件可以来自外部，如来自客户端的连接请求、数据等。事件也可以来自内部，如定时器事件。

2）event demultiplexer——事件多路分发机制（同步事件分离器）

由操作系统提供的 I/O 多路复用机制，比如 select 和 epoll。 程序首先将其关心的句柄（事件源）及其事件注册到 event demultiplexer 上； 当有事件到达时，event demultiplexer 会发出通知“在已经注册的句柄集中，一个或多 个句柄的事件已经就绪”； 程序收到通知后，就可以在非阻塞的情况下对事件进行处理了。 对应到 libevent 中，依然是 select、poll、epoll 等，但是 libevent 使用结构体 eventop 进行了 封装，以统一的接口来支持这些 I/O 多路复用机制，达到了对外隐藏底层系统机制的目的。

3）Reactor——反应器（管理器）

定义了一些接口，用于应用程序控制事件调度，以及应用程序注册、删除事件处理器和相关的描述符。它是事件处理器的调度核心。 Reactor管理器使用同步事件分离器来等待事件的发生。一旦事件发生，Reactor管理器先是分离每个事件，然后调度事件处理器，最后调用相关的模板函数来处理这个事件。

4） Event Handler——事件处理程序（事件处理器接口）

事件处理程序提供了一组接口，每个接口对应了一种类型的事件，供 Reactor 在相应的事件发生时调用，执行相应的事件处理。通常它会绑定一个有效的句柄。 对应到 libevent 中，就是 event 结构体。

5）具体的事件处理器

是事件处理器接口的实现。它实现了应用程序提供的某个服务。每个具体的事件处理器总和一个描述符相关。它使用描述符来识别事件、识别应用程序提供的服务。

2.4 Reactor 事件处理流程

三、libevent库的使用

3.1 使用步骤

1、调用event_init函数创建event_base对象。一个event_base相当于一个reactor实例。

2、创建具体的事件处理器，并设置它们所从属的reactor实例。evsignal_new和evtimer_new分别用于创建信号事件处理器和定时事件处理器，它们的统一入口是event_new函数，event_new函数成功时返回一个event类型的对象，也就是libevent的事件处理器

3、调用event_add函数，将事件处理器添加到注册事件队列中，并将该事件处理器对应的事件添加到事件多路分发器中。

4、调用event_base_dispatch函数来执行事件循环。

5、事件循环结束后，使用*_free系列函数来释放系统资源。

3.2 事件处理流程

当应用程序向 libevent 注册一个事件后，libevent 内部是怎么样进行处理的呢？

下面的图就给出了这一基本流程。

1）首先应用程序准备并初始化 event，设置好事件类型和回调函数；这对应于前面第步骤 2 和 3；

2）向 libevent 添加该事件 event。对于定时事件，libevent 使用一个小根堆管理，key 为超 时时间；对于 Signal 和 I/O 事件，libevent 将其放入到等待链表（wait list）中，这是一 个双向链表结构；

3）程序调用 event_base_dispatch()系列函数进入无限循环，等待事件，以 select()函数为例； 每次循环前 libevent 会检查定时事件的最小超时时间 tv，根据 tv 设置 select()的最大等待时间，以便于后面及时处理超时事件； 当 select()返回后，首先检查超时事件，然后检查 I/O 事件；

四、libevent 源代码文件组织

4.1 源代码组织结构

1）头文件

主要就是 event.h：事件宏定义、接口函数声明，主要结构体 event 的声明；

2）内部头文件

xxx-internal.h：内部数据结构和函数，对外不可见，以达到信息隐藏的目的；

3） libevent 框架

event.c： event 整体框架的代码实现；

4）对系统 I/O 多路复用机制的封装

epoll.c：对 epoll 的封装；

select.c：对 select 的封装；

devpoll.c：对 dev/poll 的封装;

kqueue.c：对 kqueue 的封装；

5）定时事件管理

min-heap.h：其实就是一个以时间作为 key 的小根堆结构；

6）信号管理

signal.c：对信号事件的处理；

7）辅助功能函数

evutil.h 和 evutil.c：一些辅助功能函数，包括创建 socket pair 和一些时间操作函数：加、减和比较等。

8）日志

log.h 和 log.c： log 日志函数

9）缓冲区管理

evbuffer.c 和 buffer.c： libevent 对缓冲区的封装；

10）基本数据结构

compatsys 下的两个源文件： queue.h 是 libevent 基本数据结构的实现，包括链表，双向链表，队列等； _libevent_time.h：一些用于时间操作的结构体定义、函数和宏定义；

11）实用网络库

http 和 evdns：是基于 libevent 实现的 http 服务器和异步 dns 查询库

五、libevent 的核心

5.1 ibevent 的核心---event

Libevent 是基于事件驱动（event-driven）的，从名字也可以看到 event 是整个库的核心。 event 就是 Reactor 框架中的事件处理程序组件；它提供了函数接口，供 Reactor 在事件发生时调用，以执行相应的事件处理，通常它会绑定一个有效的句柄。 首先给出 event 结构体的声明，它位于libevent-masterincludeevent2event_struct.h文件中：

下面详细解释一下结构体中各字段的含义，注意部分变量有可能位于event_callback结构体中。

1）ev_events：event关注的事件类型，它可以是以下3种类型：

• I/O事件：EV_WRITE和EV_READ
• 定时事件：EV_TIMEOUT
• 信号事件： EV_SIGNAL
• 辅助选项：EV_PERSIST，表明是一个永久事件

Libevent中的定义为：

可以看出事件类型可以使用“|”运算符进行组合，需要说明的是，信号和I/O事件不能同时设置； 还可以看出libevent使用event结构体将这3种事件的处理统一起来；

2）ev_next，ev_active_next 和 ev_signal_next 都是双向链表节点指针；它们是 libevent 对不同事件类型和在不同的时期，对事件的管理时使用到的字段。 libevent 使用双向链表保存所有注册的 I/O 和 Signal 事件，ev_next 就是该 I/O 事件在链表中的位置；称此链表为“已注册事件链表”； 同样 ev_signal_next 就是 signal 事件在 signal 事件链表中的位置； ev_active_next：libevent 将所有的激活事件放入到链表 active list 中，然后遍历 active list 执行调度，ev_active_next 就指明了 event 在 active list 中的位置；

3）min_heap_idx 和 ev_timeout，如果是 timeout 事件，它们是 event 在小根堆中的索引和超时值，libevent 使用小根堆来管理定时事件。

4）ev_base 该事件所属的反应堆实例，这是一个 event_base 结构体。

5）ev_fd，对于 I/O 事件，是绑定的文件描述符；对于 signal 事件，是绑定的信号；

6）ev_callback，是一个结构体，里面包含有事件的回调函数（54-57行），这个回调函数被 ev_base 调用，执行事件处理程序，原型为：

7）ev_arg：void*，表明可以是任意类型的数据，在设置 event 时指定；

8）eb_flags：libevent 用于标记 event 信息的字段，表明其当前的状态，可能的值有：

9）ev_ncalls：事件就绪执行时，调用 ev_callback 的次数，通常为 1；

10）ev_pncalls：指针，通常指向 ev_ncalls 或者为 NULL；

11）ev_res：记录了当前激活事件的类型

5.2 libevent 对 event 的管理

从event 结构体中的 3 个链表节点指针和一个堆索引出发，大体上也能窥出 libevent 对 event 的管理方法了，可以参见下面的示意图。 每次当有事件 event 转变为就绪状态时，libevent 就会把它移入到 active event list[priority] 中，其中 priority 是 event 的优先级； 接着 libevent 会根据自己的调度策略选择就绪事件，调用其 cb_callback()函数执行事件处理；并根据就绪的句柄和事件类型填充 cb_callback 函数的参数。

5.3 事件设置的接口函数

要向 libevent 添加一个事件，需要首先设置 event 对象，这通过调用 libevent 提供的函数有：event_set(), event_base_set(), event_priority_set()来完成；下面分别进行讲解。

void event_set(struct event *ev, int fd, short events, void (*callback)(int, short, void *), void *arg)

1.设置事件 ev 绑定的文件描述符或者信号，对于定时事件，设为-1 即可；

2.设置事件类型，比如 EV_READ|EV_PERSIST, EV_WRITE, EV_SIGNAL 等；

3.设置事件的回调函数以及参数 arg；

4.初始化其它字段，比如缺省的 event_base 和优先级；

int event_base_set(struct event_base *base, struct event *ev)

设置 event ev 将要注册到的 event_base；

libevent 有一个全局 event_base 指针 current_base，默认情况下事件 ev 将被注册到 current_base 上，使用该函数可以指定不同的 event_base；

如果一个进程中存在多个 libevent 实例，则必须要调用该函数为 event 设置不同的 event_base；

int event_priority_set(struct event *ev, int pri)

设置event ev的优先级，没什么可说的，注意的一点就是：当ev正处于就绪状态时，不能设置，返回-1。

六、初见事件处理框架

前面已经对 libevent 的事件处理框架和 event 结构体做了描述，现在是时候剖析 libevent 对事件的详细处理流程了，本节将分析 libevent 的事件处理框架 event_base 和 libevent 注册、 删除事件的具体流程，可结合前一节 libevent 对 event 的管理。

6.1 事件处理框架-event_base

回想 Reactor 模式的几个基本组件，本节讲解的部分对应于 Reactor 框架组件。在 libevent 中，这就表现为 event_base 结构体，结构体声明如下，它位于libevent-masterevent-internal.h 文件中：

下面详细解释一下结构体中部分字段的含义。

1）evsel 和 evbase 这两个字段的设置可能会让人有些迷惑，这里你可以把 evsel 和 evbase 看作是类和静态函数的关系，比如添加事件时的调用行为：evsel->add(evbase, ev)，实际执 行操作的是 evbase；这相当于 class::add(instance, ev)，instance 就是 class 的一个对象实例。 evsel指向了全局变量static const struct eventop *eventops[]中的一个；libevent将系统提供的I/O demultiplex机制统一封装成了eventop结构；因此 eventops[]包含了select、poll、kequeue和epoll等等其中的若干个全局实例对象。 evbase实际上是一个eventop实例对象； 先来看看eventop结构体，它的成员是一系列的函数指针, 在event-internal.h文件中：

也就是说，在 libevent 中，每种 I/O demultiplex 机制的实现都必须提供这五个函数接口， 来完成自身的初始化、销毁释放；对事件的注册、注销和分发。 比如对于 epoll，libevent 实现了 5 个对应的接口函数，并在初始化时并将 eventop 的 5 个函数指针指向这 5 个函数，那么程序就可以使用 epoll 作为 I/O demultiplex 机制了，这个在后面会再次提到。

2）activequeues 是一个一级指针，前面讲过 libevent 支持事件优先级，因此你可以把它看作是一维数组，其中的元素 activequeues[priority]是一个链表，链表的每个节点指向一个优先级为 priority 的就绪事件 event，实际上链表当中存放的是事件的回调函数。

3）io，管理IO事件的结构体变量。

4）sigmap 是由来管理信号的结构体，将在后面信号处理时专门讲解；

5）timeheap 是管理定时事件的小根堆，将在后面定时事件处理时专门讲解；

6）tv_cache 是 libevent 用于时间管理的变量，存储时间：用来避免频繁调用gettimeofday/clock_gettime；

6.2 创建和初始化 event_base

创建一个 event_base 对象也既是创建了一个新的 libevent 实例，程序需要通过调用 event_init()（内部调用 event_base_new 函数执行具体操作）函数来创建，该函数同时还对新生成的 libevent 实例进行了初始化。 该函数首先为 event_base 实例申请空间，然后初始化定时事件使用的mini-heap，选择并初始化合适的系统 I/O 的 demultiplexer 机制，初始化各事件链表； 函数还检测了系统的时间设置，为后面的时间管理打下基础。

6.3 接口函数

前面提到 Reactor 框架的作用就是提供事件的注册、注销接口；根据系统提供的事件多路分发机制执行事件循环，当有事件进入“就绪”状态时，调用注册事件的回调函数来处理事件。 Libevent 中对应的接口函数主要就是：

int event_add(struct event *ev, const struct timeval *timeout);

int event_del(struct event *ev);

int event_base_loop(struct event_base *base, int loops);

void event_active(struct event *event, int res, short events);

void event_process_active(struct event_base *base);

6.3.1 注册事件

函数原型：

参数：ev：指向要注册的事件；

tv：超时时间；

函数将 ev 注册到 ev->ev_base 上，事件类型由 ev->ev_events 指明，如果注册成功，ev 将被插入到已注册链表中；如果 tv 不是 NULL，则会同时注册定时事件，将 ev 添加到 timer 堆上； 如果其中有一步操作失败，那么函数保证没有事件会被注册，可以讲这相当于一个原子操作。

event_add_nolock（）函数

6.3.2 删除事件

函数原型为：

该函数将删除事件 ev，对于 I/O 事件，从 I/O 的 demultiplexer 上将事件注销；对于 Signal 事件，将从 Signal 事件链表中删除；对于定时事件，将从堆上删除； 同样删除事件的操作则不一定是原子的，比如删除时间事件之后，有可能从系统 I/O 机 制中注销会失败。