一、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 機 制中注銷會失敗。