出處：Blog of Felix021
時(shí)間：Sat, 25 Feb 2012 00:43:26 +0000
作者：felix021
地址：http://www.felix021.com/blog/read.php?2068
內(nèi)容：
花了兩天的時(shí)間在libevent上，想總結(jié)下，就以寫簡(jiǎn)單tutorial的方式吧，貌似沒(méi)有一篇簡(jiǎn)單的說(shuō)明，讓人馬上就能上手用的。
首先給出官方文檔吧： http://libevent.org ，首頁(yè)有個(gè)Programming with Libevent，里面是一節(jié)一節(jié)的介紹libevent，但是感覺信息量太大了，而且還是英文的-。-（當(dāng)然，如果想好好用libevent，看看還是很有必要的），還有個(gè)Reference，大致就是對(duì)各個(gè)版本的libevent使用doxgen生成的文檔，用來(lái)查函數(shù)原型和基本用法什么的。
下面假定已經(jīng)學(xué)習(xí)過(guò)基本的socket編程（socket,bind,listen,accept,connect,recv,send,close），并且對(duì)異步/callback有基本認(rèn)識(shí)。
基本的socket編程是阻塞/同步的，每個(gè)操作除非已經(jīng)完成或者出錯(cuò)才會(huì)返回，這樣對(duì)于每一個(gè)請(qǐng)求，要使用一個(gè)線程或者單獨(dú)的進(jìn)程去處理，系統(tǒng)資源沒(méi)法支撐大量的請(qǐng)求（所謂c10k problem?），例如內(nèi)存：默認(rèn)情況下每個(gè)線程需要占用2～8M的棧空間。posix定義了可以使用異步的select系統(tǒng)調(diào)用，但是因?yàn)槠洳捎昧溯喸兊姆绞絹?lái)判斷某個(gè)fd是否變成active，效率不高[O(n)]，連接數(shù)一多，也還是撐不住。于是各系統(tǒng)分別提出了基于異步/callback的系統(tǒng)調(diào)用，例如Linux的epoll，BSD的kqueue，Windows的IOCP。由于在內(nèi)核層面做了支持，所以可以用O(1)的效率查找到active的fd。基本上，libevent就是對(duì)這些高效IO的封裝，提供統(tǒng)一的API，簡(jiǎn)化開發(fā)。
libevent大概是這樣的：
默認(rèn)情況下是單線程的（可以配置成多線程，如果有需要的話），每個(gè)線程有且只有一個(gè)event_base，對(duì)應(yīng)一個(gè)struct event_base結(jié)構(gòu)體（以及附于其上的事件管理器），用來(lái)schedule托管給它的一系列event，可以和操作系統(tǒng)的進(jìn)程管理類比，當(dāng)然，要更簡(jiǎn)單一點(diǎn)。當(dāng)一個(gè)事件發(fā)生后，event_base會(huì)在合適的時(shí)間（不一定是立即）去調(diào)用綁定在這個(gè)事件上的函數(shù)（傳入一些預(yù)定義的參數(shù)，以及在綁定時(shí)指定的一個(gè)參數(shù)），直到這個(gè)函數(shù)執(zhí)行完，再返回schedule其他事件。//創(chuàng)建一個(gè)event_base
struct event_base *base = event_base_new();
assert(base != NULL);
event_base內(nèi)部有一個(gè)循環(huán)，循環(huán)阻塞在epoll/kqueue等系統(tǒng)調(diào)用上，直到有一個(gè)/一些事件發(fā)生，然后去處理這些事件。當(dāng)然，這些事件要被綁定在這個(gè)event_base上。每個(gè)事件對(duì)應(yīng)一個(gè)struct event，可以是監(jiān)聽一個(gè)fd或者POSIX信號(hào)量之類（這里只講fd了，其他的看manual吧）。struct event使用event_new來(lái)創(chuàng)建和綁定，使用event_add來(lái)啟用：//創(chuàng)建并綁定一個(gè)event
struct event *listen_event;
//參數(shù)：event_base, 監(jiān)聽的fd，事件類型及屬性，綁定的回調(diào)函數(shù)，給回調(diào)函數(shù)的參數(shù)
listen_event = event_new(base, listener, EV_READ|EV_PERSIST, callback_func, (void*)base);
//參數(shù)：event，超時(shí)時(shí)間(struct timeval *類型的，NULL表示無(wú)超時(shí)設(shè)置)
event_add(listen_event, NULL);
注：libevent支持的事件及屬性包括(使用bitfield實(shí)現(xiàn)，所以要用 | 來(lái)讓它們合體)
(a) EV_TIMEOUT: 超時(shí)
(b) EV_READ: 只要網(wǎng)絡(luò)緩沖中還有數(shù)據(jù)，回調(diào)函數(shù)就會(huì)被觸發(fā)
(c) EV_WRITE: 只要塞給網(wǎng)絡(luò)緩沖的數(shù)據(jù)被寫完，回調(diào)函數(shù)就會(huì)被觸發(fā)
(d) EV_SIGNAL: POSIX信號(hào)量，參考manual吧
(e) EV_PERSIST: 不指定這個(gè)屬性的話，回調(diào)函數(shù)被觸發(fā)后事件會(huì)被刪除
(f) EV_ET: Edge-Trigger邊緣觸發(fā)，參考EPOLL_ET
然后需要啟動(dòng)event_base的循環(huán)，這樣才能開始處理發(fā)生的事件。循環(huán)的啟動(dòng)使用event_base_dispatch，循環(huán)將一直持續(xù)，直到不再有需要關(guān)注的事件，或者是遇到event_loopbreak()/event_loopexit()函數(shù)。//啟動(dòng)事件循環(huán)
event_base_dispatch(base);
接下來(lái)關(guān)注下綁定到event的回調(diào)函數(shù)callback_func：傳遞給它的是一個(gè)socket fd、一個(gè)event類型及屬性bit_field、以及傳遞給event_new的最后一個(gè)參數(shù)（去上面幾行回顧一下，把event_base給傳進(jìn)來(lái)了，實(shí)際上更多地是分配一個(gè)結(jié)構(gòu)體，把相關(guān)的數(shù)據(jù)都撂進(jìn)去，然后丟給event_new，在這里就能取得到了）。其原型是：typedef void(* event_callback_fn)(evutil_socket_t sockfd, short event_type, void *arg)
對(duì)于一個(gè)服務(wù)器而言，上面的流程大概是這樣組合的：
1. listener = socket()，bind()，listen()，設(shè)置nonblocking(POSIX系統(tǒng)中可使用fcntl設(shè)置，windows不需要設(shè)置，實(shí)際上libevent提供了統(tǒng)一的包裝evutil_make_socket_nonblocking)
2. 創(chuàng)建一個(gè)event_base
3. 創(chuàng)建一個(gè)event，將該socket托管給event_base，指定要監(jiān)聽的事件類型，并綁定上相應(yīng)的回調(diào)函數(shù)(及需要給它的參數(shù))。對(duì)于listener socket來(lái)說(shuō)，只需要監(jiān)聽EV_READ|EV_PERSIST
4. 啟用該事件
5. 進(jìn)入事件循環(huán)
---------------
6. (異步) 當(dāng)有client發(fā)起請(qǐng)求的時(shí)候，調(diào)用該回調(diào)函數(shù)，進(jìn)行處理。
問(wèn)題：為什么不在listen完馬上調(diào)用accept，獲得客戶端連接以后再丟給event_base呢？這個(gè)問(wèn)題先想想噢。
回調(diào)函數(shù)要做什么事情呢？當(dāng)然是處理client的請(qǐng)求了。首先要accept，獲得一個(gè)可以與client通信的sockfd，然后……調(diào)用recv/send嗎？錯(cuò)！大錯(cuò)特錯(cuò)！如果直接調(diào)用recv/send的話，這個(gè)線程就阻塞在這個(gè)地方了，如果這個(gè)客戶端非常的陰險(xiǎn)（比如一直不發(fā)消息，或者網(wǎng)絡(luò)不好，老是丟包），libevent就只能等它，沒(méi)法處理其他的請(qǐng)求了——所以應(yīng)該創(chuàng)建一個(gè)新的event來(lái)托管這個(gè)sockfd。
在老版本libevent上的實(shí)現(xiàn)，比較羅嗦[如果不想詳細(xì)了解的話，看下一部分]。
對(duì)于服務(wù)器希望先從client獲取數(shù)據(jù)的情況，大致流程是這樣的：
1. 將這個(gè)sockfd設(shè)置為nonblocking
2. 創(chuàng)建2個(gè)event:
event_read，綁上sockfd的EV_READ|EV_PERSIST，設(shè)置回調(diào)函數(shù)和參數(shù)（后面提到的struct）
event_write，綁上sockfd的EV_WRITE|EV_PERSIST，設(shè)置回調(diào)函數(shù)和參數(shù)（后面提到的struct）
3. 啟用event_read事件
------
4. (異步) 等待event_read事件的發(fā)生, 調(diào)用相應(yīng)的回調(diào)函數(shù)。這里麻煩來(lái)了：回調(diào)函數(shù)用recv讀入的數(shù)據(jù)，不能直接用send丟給sockfd了事——因?yàn)閟ockfd是nonblocking的，丟給它的話，不能保證正確（為什么呢？）。所以需要一個(gè)自己管理的緩存用來(lái)保存讀入的數(shù)據(jù)中（在accept以后就創(chuàng)建一個(gè)struct，作為第2步回調(diào)函數(shù)的arg傳進(jìn)來(lái)），在合適的時(shí)間（比如遇到換行符）啟用event_write事件【event_add(event_write, NULL)】，等待EV_WRITE事件的觸發(fā)
------
5. (異步) 當(dāng)event_write事件的回調(diào)函數(shù)被調(diào)用的時(shí)候，往sockfd寫入數(shù)據(jù)，然后刪除event_write事件【event_del(event_write)】，等待event_read事件的下一次執(zhí)行。
以上步驟比較晦澀，具體代碼可參考官方文檔里面的【Example: A low-level ROT13 server with Libevent】
由于需要自己管理緩沖區(qū)，且過(guò)程晦澀難懂，并且不兼容于Windows的IOCP，所以libevent2開始，提供了bufferevent這個(gè)神器，用來(lái)提供更加優(yōu)雅、易用的API。struct bufferevent內(nèi)建了兩個(gè)event(read/write)和對(duì)應(yīng)的緩沖區(qū)【struct evbuffer *input, *output】，并提供相應(yīng)的函數(shù)用來(lái)操作緩沖區(qū)（或者直接操作bufferevent）。每當(dāng)有數(shù)據(jù)被讀入input的時(shí)候，read_cb函數(shù)被調(diào)用；每當(dāng)output被輸出完的時(shí)候，write_cb被調(diào)用；在網(wǎng)絡(luò)IO操作出現(xiàn)錯(cuò)誤的情況（連接中斷、超時(shí)、其他錯(cuò)誤），error_cb被調(diào)用。于是上一部分的步驟被簡(jiǎn)化為：
1. 設(shè)置sockfd為nonblocking
2. 使用bufferevent_socket_new創(chuàng)建一個(gè)struct bufferevent *bev，關(guān)聯(lián)該sockfd，托管給event_base
3. 使用bufferevent_setcb(bev, read_cb, write_cb, error_cb, (void *)arg)將EV_READ/EV_WRITE對(duì)應(yīng)的函數(shù)
4. 使用bufferevent_enable(bev, EV_READ|EV_WRITE|EV_PERSIST)來(lái)啟用read/write事件
------
5. (異步)
在read_cb里面從input讀取數(shù)據(jù)，處理完畢后塞到output里(會(huì)被自動(dòng)寫入到sockfd)
在write_cb里面（需要做什么嗎？對(duì)于一個(gè)echo server來(lái)說(shuō)，read_cb就足夠了）
在error_cb里面處理遇到的錯(cuò)誤
*. 可以使用bufferevent_set_timeouts(bev, struct timeval *READ, struct timeval *WRITE)來(lái)設(shè)置讀寫超時(shí), 在error_cb里面處理超時(shí)。
*. read_cb和write_cb的原型是
void read_or_write_callback(struct bufferevent *bev, void *arg)
error_cb的原型是
void error_cb(struct bufferevent *bev, short error, void *arg) //這個(gè)是event的標(biāo)準(zhǔn)回調(diào)函數(shù)原型
可以從bev中用libevent的API提取出event_base、sockfd、input/output等相關(guān)數(shù)據(jù)，詳情RTFM~
于是代碼簡(jiǎn)化到只需要幾行的read_cb和error_cb函數(shù)即可：
void read_cb(struct bufferevent *bev, void *arg) {
char line[256];
int n;
evutil_socket_t fd = bufferevent_getfd(bev);
while (n = bufferevent_read(bev, line, 256), n > 0)
bufferevent_write(bev, line, n);
}
void error_cb(struct bufferevent *bev, short event, void *arg) {
bufferevent_free(bev);
}
于是一個(gè)支持大并發(fā)量的echo server就成型了！下面附上無(wú)注釋的echo server源碼，110行，多抄幾遍，就能完全弄懂啦！更復(fù)雜的例子參見官方文檔里面的【Example: A simpler ROT13 server with Libevent】
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <assert.h>
#include <event2/event.h>
#include <event2/bufferevent.h>
#define LISTEN_PORT 9999
#define LISTEN_BACKLOG 32
void do_accept(evutil_socket_t listener, short event, void *arg);
void read_cb(struct bufferevent *bev, void *arg);
void error_cb(struct bufferevent *bev, short event, void *arg);
void write_cb(struct bufferevent *bev, void *arg);
int main(int argc, char *argv[])
{
int ret;
evutil_socket_t listener;
listener = socket(AF_INET, SOCK_STREAM, 0);
assert(listener > 0);
evutil_make_listen_socket_reuseable(listener);
struct sockaddr_in sin;
sin.sin_family = AF_INET;
sin.sin_addr.s_addr = 0;
sin.sin_port = htons(LISTEN_PORT);
if (bind(listener, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
perror("bind");
return 1;
}
if (listen(listener, LISTEN_BACKLOG) < 0) {
perror("listen");
return 1;
}
printf ("Listening...\n");
evutil_make_socket_nonblocking(listener);
struct event_base *base = event_base_new();
assert(base != NULL);
struct event *listen_event;
listen_event = event_new(base, listener, EV_READ|EV_PERSIST, do_accept, (void*)base);
event_add(listen_event, NULL);
event_base_dispatch(base);
printf("The End.");
return 0;
}
void do_accept(evutil_socket_t listener, short event, void *arg)
{
struct event_base *base = (struct event_base *)arg;
evutil_socket_t fd;
struct sockaddr_in sin;
socklen_t slen = sizeof(sin);
fd = accept(listener, (struct sockaddr *)&sin, &slen);
if (fd < 0) {
perror("accept");
return;
}
if (fd > FD_SETSIZE) { //這個(gè)if是參考了那個(gè)ROT13的例子，貌似是官方的疏漏，從select-based例子里抄過(guò)來(lái)忘了改
perror("fd > FD_SETSIZE\n");
return;
}
printf("ACCEPT: fd = %u\n", fd);
struct bufferevent *bev = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE);
bufferevent_setcb(bev, read_cb, NULL, error_cb, arg);
bufferevent_enable(bev, EV_READ|EV_WRITE|EV_PERSIST);
}
void read_cb(struct bufferevent *bev, void *arg)
{
#define MAX_LINE 256
char line[MAX_LINE+1];
int n;
evutil_socket_t fd = bufferevent_getfd(bev);
while (n = bufferevent_read(bev, line, MAX_LINE), n > 0) {
line[n] = '\0';
printf("fd=%u, read line: %s\n", fd, line);
bufferevent_write(bev, line, n);
}
}
void write_cb(struct bufferevent *bev, void *arg) {}
void error_cb(struct bufferevent *bev, short event, void *arg)
{
evutil_socket_t fd = bufferevent_getfd(bev);
printf("fd = %u, ", fd);
if (event & BEV_EVENT_TIMEOUT) {
printf("Timed out\n"); //if bufferevent_set_timeouts() called
}
else if (event & BEV_EVENT_EOF) {
printf("connection closed\n");
}
else if (event & BEV_EVENT_ERROR) {
printf("some other error\n");
}
bufferevent_free(bev);
}