evbuffer结构与基本操作

  转载出处：http://blog.csdn.net/luotuo44/article/details/39290721        

        

        对于非阻塞IO的网络库来说，buffer几乎是必须的。Libevent在1.0版本之前就提供了buffer功能。现在来看一下Libevent的buffer。

buffer相关结构体：

        Libevent为buffer定义了下面的结构体：

[cpp]  view plain copy

1. //evbuffer-internal.h文件  
2. struct evbuffer_chain;  
3. struct evbuffer {  
4.     struct evbuffer_chain *first;  
5.     struct evbuffer_chain *last;  
6.     //这是一个二级指针。使用*last_with_datap时，指向的是链表中最后一个有数据的evbuffer_chain。  
7.     //所以last_with_datap存储的是倒数第二个evbuffer_chain的next成员地址。  
8.     //一开始buffer->last_with_datap = &buffer->first;此时first为NULL。所以当链表没有节点时  
9.     //*last_with_datap为NULL。当只有一个节点时*last_with_datap就是first。      
10.     struct evbuffer_chain **last_with_datap;  
11.   
12.     size_t total_len;//链表中所有chain的总字节数  
13.   
14.     ...  
15. };  
16.   
17.   
18. struct evbuffer_chain {  
19.     struct evbuffer_chain *next;  
20.     size_t buffer_len;//buffer的大小  
21.   
22.     //错开不使用的空间。该成员的值一般等于0  
23.     ev_off_t misalign;  
24.   
25.     //evbuffer_chain已存数据的字节数  
26.     //所以要从buffer + misalign + off的位置开始写入数据  
27.     size_t off;  
28.   
29.     ...  
30.       
31.     unsigned char *buffer;  
32. };  

        这两个结构体配合工作得到下图所示的存储结构：

        

        因为last_with_datap成员比较特殊，上图只是展示了一种情况。后面还有一张图，展示另外一种情况。

        Libevent将缓冲数据都存放到buffer中。通过一个个的evbuffer_chain连成的链表可以存放很多的缓冲数据。

        这是一个很常见的链表形式。但Libevent有一个很独特的地方，就是那个evbuffer_chain结构体。

        首先，该结构体有misalign成员。该成员表示错开不用的buffer空间。也就是说buffer中真正的数据是从buffer + misalign开始。

        第二，evbuffer_chain结构体buffer是一个指针，按道理来说，应该单独调用malloc分配一个堆内存并让buffer指向之。但实际上buffer指向的内存和evbuffer_chain结构体本身的存储内存是一起分配的。下面代码展示了这一点：

[cpp]  view plain copy

1. //evbuffer-internal.h文件  
2. #define EVBUFFER_CHAIN_SIZE sizeof(struct evbuffer_chain)  
3.   
4. #if _EVENT_SIZEOF_VOID_P < 8  
5. #define MIN_BUFFER_SIZE 512  
6. #else  
7. #define MIN_BUFFER_SIZE 1024  
8. #endif  
9.   
10. //宏的作用就是返回，chain + sizeof(evbuffer_chain) 的内存地址。  
11. #define EVBUFFER_CHAIN_EXTRA(t, c) (t *)((struct evbuffer_chain *)(c) + 1)  
12.   
13.   
14. //buffer.c文件  
15. static struct evbuffer_chain *  
16. evbuffer_chain_new(size_t size)//size是buffer所需的大小  
17. {  
18.     struct evbuffer_chain *chain;  
19.     size_t to_alloc;  
20.   
21.     //所需的大小size 再 加上evbuffer_chain结构体本身所需  
22.     //的内存大小。这样做的原因是，evbuffer_chain本身是管理  
23.     //buffer的结构体。但buffer内存就分配在evbuffer_chain结构体存储  
24.     //内存的后面。所以要申请多一些内存。  
25.     size += EVBUFFER_CHAIN_SIZE;//evbuffer_chain结构体本身的大小  
26.   
27.       
28.     to_alloc = MIN_BUFFER_SIZE; //内存块的最小值  
29.     while (to_alloc < size)  
30.         to_alloc <<= 1;  
31.    //从分配的内存大小可以知道，evbuffer_chain结构体和buffer是一起分配的  
32.     //也就是说他们是存放在同一块内存中  
33.     if ((chain = mm_malloc(to_alloc)) == NULL)  
34.         return (NULL);  
35.   
36.     //只需初始化最前面的结构体部分即可  
37.     memset(chain, 0, EVBUFFER_CHAIN_SIZE);  
38.   
39.     //buffer_len存储的是buffer的大小  
40.     chain->buffer_len = to_alloc - EVBUFFER_CHAIN_SIZE;  
41.   
42.      //宏的作用就是返回，chain + sizeof(evbuffer_chain) 的内存地址。  
43.      //其效果就是buffer指向的内存刚好是在evbuffer_chain的后面。  
44.     chain->buffer = EVBUFFER_CHAIN_EXTRA(u_char, chain);  
45.   
46.     return (chain);  
47. }  

        前面的图中，buffer内存区域(蓝色区域)连在next的后面也是基于这一点的。在代码的while循环中也可以看到申请的空间大小是512的倍数，也就是说evbuffer_chain申请的空间大小是512、1024、2048、4096……

 

        上面贴出了函数evbuffer_chain_new，该函数是用来创建一个evbuffer_chain。现在贴出另外一个函数evbuffer_new，它是用来创建一个evbuffer的。

[cpp]  view plain copy

1. //buffer.c  
2. struct evbuffer *  
3. evbuffer_new(void)  
4. {  
5.     struct evbuffer *buffer;  
6.   
7.     buffer = mm_calloc(1, sizeof(struct evbuffer));  
8.     if (buffer == NULL)  
9.         return (NULL);  
10.   
11.     buffer->refcnt = 1;  
12.     buffer->last_with_datap = &buffer->first;  
13.   
14.     return (buffer);  
15. }  

Buffer的数据操作：

在链表尾添加数据：

        

        Libevent提供给用户的添加数据接口是evbuffer_add，现在就通过这个函数看一下是怎么将数据插入到buffer中的。该函数是在链表的尾部添加数据，如果想在链表的前面添加数据可以使用evbuffer_prepend。在链表尾部插入数据，分下面几种情况：

1. 该链表为空，即这是第一次插入数据。这是最简单的，直接把新建的evbuffer_chain插入到链表中，通过调用evbuffer_chain_insert。
2. 链表的最后一个节点(即evbuffer_chain)还有一些空余的空间，放得下本次要插入的数据。此时直接把数据追加到最后一个节点即可。
3. 链表的最后一个节点并不能放得下本次要插入的数据，那么就需要把本次要插入的数据分开由两个evbuffer_chain存放。

        具体的实现如下面所示：

[cpp]  view plain copy

1. //buffer.c文件  
2. int  
3. evbuffer_add(struct evbuffer *buf, const void *data_in, size_t datlen)  
4. {  
5.     struct evbuffer_chain *chain, *tmp;  
6.     const unsigned char *data = data_in;  
7.     size_t remain, to_alloc;  
8.     int result = -1;  
9.   
10.     EVBUFFER_LOCK(buf);//加锁,线程安全  
11.   
12.     //冻结缓冲区尾部，禁止追加数据  
13.     if (buf->freeze_end) {  
14.         goto done;  
15.     }  
16.   
17.     //找到最后一个evbuffer_chain。  
18.     chain = buf->last;  
19.   
20.     //第一次插入数据时，buf->last为NULL  
21.     if (chain == NULL) {  
22.         chain = evbuffer_chain_new(datlen);  
23.         if (!chain)  
24.             goto done;  
25.         evbuffer_chain_insert(buf, chain);  
26.     }  
27.   
28.     //EVBUFFER_IMMUTABLE 是 read-only chain  
29.     if ((chain->flags & EVBUFFER_IMMUTABLE) == 0) {//等于0说明是可以写的  
30.         //最后那个chain可以放的字节数        
31.         remain = (size_t)(chain->buffer_len - chain->misalign - chain->off);  
32.         if (remain >= datlen) {//最后那个chain可以放下本次要插入的数据  
33.   
34.             memcpy(chain->buffer + chain->misalign + chain->off,  
35.                 data, datlen);  
36.             chain->off += datlen;//偏移量，方便下次插入数据  
37.             buf->total_len += datlen;//buffer的总字节数  
38.             goto out;  
39.         } else if (!CHAIN_PINNED(chain) &&//该evbuffer_chain可以修改  
40.             evbuffer_chain_should_realign(chain, datlen)) {  
41.             //通过调整后，也可以放得下本次要插入的数据  
42.               
43.             //通过使用chain->misalign这个错位空间而插入数据  
44.             evbuffer_chain_align(chain);  
45.   
46.             memcpy(chain->buffer + chain->off, data, datlen);  
47.             chain->off += datlen;  
48.             buf->total_len += datlen;  
49.             goto out;  
50.         }  
51.     } else {  
52.         remain = 0; //最后一个节点是只写evbuffer_chain  
53.     }  
54.   
55.     //当这个evbuffer_chain是一个read-only buffer或者最后那个chain  
56.     //放不下本次要插入的数据时才会执行下面代码  
57.     //此时需要新建一个evbuffer_chain  
58.     to_alloc = chain->buffer_len;  
59.     //当最后evbuffer_chain的缓冲区小于等于2048时，那么新建的evbuffer_chain的  
60.     //大小将是最后一个节点缓冲区的2倍。  
61.     if (to_alloc <= EVBUFFER_CHAIN_MAX_AUTO_SIZE/2)//4096/2  
62.         to_alloc <<= 1;  
63.   
64.     //最后的大小还是有要插入的数据决定。要注意的是虽然to_alloc最后的值可能为  
65.     //datlen。但在evbuffer_chain_new中，实际分配的内存大小必然是512的倍数。  
66.     if (datlen > to_alloc)  
67.         to_alloc = datlen;  
68.   
69.     //此时需要new一个chain才能保存本次要插入的数据  
70.     tmp = evbuffer_chain_new(to_alloc);  
71.     if (tmp == NULL)  
72.         goto done;  
73.   
74.     //链表最后那个节点还是可以放下一些数据的。那么就先填满链表最后那个节点  
75.     if (remain) {  
76.         memcpy(chain->buffer + chain->misalign + chain->off,  
77.             data, remain);  
78.         chain->off += remain;  
79.         buf->total_len += remain;  
80.         buf->n_add_for_cb += remain;  
81.     }  
82.   
83.     data += remain;//要插入的数据指针  
84.     datlen -= remain;  
85.   
86.     //把要插入的数据复制到新建一个chain中。  
87.     memcpy(tmp->buffer, data, datlen);  
88.     tmp->off = datlen;  
89.     //将这个chain插入到evbuffer中  
90.     evbuffer_chain_insert(buf, tmp);  
91.     buf->n_add_for_cb += datlen;  
92.   
93. out:  
94.     evbuffer_invoke_callbacks(buf);//调用回调函数  
95.     result = 0;  
96. done:  
97.     EVBUFFER_UNLOCK(buf);//解锁  
98.     return result;  
99. }  

        可以看到，evbuffer_add函数是复制一份数据，保存在链表中。这样做的好处是，用户调用该函数后，就可以丢弃该数据。读者比较熟知的函数bufferevent_write就是直接调用这个函数。当用户调用bufferevent_write后，就可以马上把数据丢弃，无需等到Libevent把这份数据写到socket的缓存区中。

        前面的代码是把数据存放到evbuffer_chain中，至于怎么把evbuffer_chain插入到链表中，则是由函数evbuffer_chain_insert完成。

[cpp]  view plain copy

1. //buffer.c文件  
2. static void  
3. evbuffer_chain_insert(struct evbuffer *buf,  
4.     struct evbuffer_chain *chain)  
5. {  
6.     //新建evbuffer时是把整个evbuffer结构体都赋值0，  
7.     //并有buffer->last_with_datap = &buffer->first;  
8.     //所以*buf->last_with_datap就是first的值，所以一开始为NULL  
9.     if (*buf->last_with_datap == NULL) {  
10.         buf->first = buf->last = chain;  
11.     } else {  
12.         struct evbuffer_chain **ch = buf->last_with_datap;  
13.         /* Find the first victim chain.  It might be *last_with_datap */  
14.         //(*ch)->off != 0表示该evbuffer_chain有数据了  
15.         //CHAIN_PINNED(*ch)则表示该evbuffer_chain不能被修改  
16.         //在链表中寻找到一个可以使用的evbuffer_chain.  
17.         //可以使用是指该chain没有数据并且可以修改。  
18.         while ((*ch) && ((*ch)->off != 0 || CHAIN_PINNED(*ch)))  
19.             ch = &(*ch)->next;//取的还是next地址。 这样看&((*ch)->next)更清晰  
20.           
21.         //在已有的链表中找不到一个满足条件的evbuffer_chain。一般都是这种情况  
22.         if (*ch == NULL) {  
23.             /* There is no victim; just append this new chain. */  
24.             //此时buf->last指向的chain不再是最后了。因为last->next被赋值了  
25.             buf->last->next = chain;  
26.               
27.             if (chain->off)//要插入的这个chain是有数据的  
28.                 buf->last_with_datap = &buf->last->next;//last_with_datap指向的是倒数第二个有数据的chain的next  
29.         } else {//这种情况得到的链表可以参考下图  
30.             /* Replace all victim chains with this chain. */  
31.             //断言，从这个节点开始，后面的说有节点都是没有数据的  
32.             EVUTIL_ASSERT(evbuffer_chains_all_empty(*ch));  
33.             //释放从这个节点开始的余下链表节点  
34.             evbuffer_free_all_chains(*ch);  
35.   
36.             //把这个chain插入到最后  
37.             *ch = chain;  
38.         }  
39.         buf->last = chain;//重新设置last指针，让它指向最后一个chain  
40.     }  
41.     buf->total_len += chain->off;  
42. }  
43.   
44. static void  
45. evbuffer_free_all_chains(struct evbuffer_chain *chain)  
46. {  
47.     struct evbuffer_chain *next;  
48.     for (; chain; chain = next) {//遍历余下的链表，删除之  
49.         next = chain->next;  
50.         evbuffer_chain_free(chain);  
51.     }  
52. }  
53.   
54.   
55. static inline void  
56. evbuffer_chain_free(struct evbuffer_chain *chain)  
57. {  
58.     ...//特殊buffer缓冲数据。一般的不用这些操作。直接释放内存即可  
59.     mm_free(chain);  
60. }  

        可以看到，evbuffer_chain_insert的插入并不是已经一个简单的链表插入，还要检测链表里面是否有没有数据(off为0)的节点。但这个buffer链表里面会有这样的节点吗？其实是有这样节点，这种节点一般是用于预留空间的。预留空间这个概念在STL中是很常见的，它的主要作用是使得当下次添加数据时，无需额外申请空间就能保存数据。

预留buffer空间：

        其中一个扩大预留空间的函数是evbuffer_expand。在讲evbuffer_expand前，看一下如果存在没有数据(off为0)的节点，链表又会是怎么样的。这涉及到last_with_data指针的指向，如下图所示：

        

        好了，现在来说一下evbuffer_expand。

[cpp]  view plain copy

1. //buffer.c文件  
2. int  
3. evbuffer_expand(struct evbuffer *buf, size_t datlen)  
4. {  
5.     struct evbuffer_chain *chain;  
6.   
7.     EVBUFFER_LOCK(buf);//加锁  
8.     chain = evbuffer_expand_singlechain(buf, datlen);  
9.     EVBUFFER_UNLOCK(buf);//解释  
10.     return chain ? 0 : -1;  
11. }  

        该函数的作用是扩大链表的buffer空间，使得下次add一个长度为datlen的数据时，无需动态申请内存。

        由于确保的是无需动态申请内存，所以假如这个链表本身还有大于datlen的空闲空间，那么这个evbuffer_expand函数将不做任何操作。

        如果这个链表的所有buffer空间都被用完了，那么解决需要创建一个buffer为datlen的evbuffer_chain，然后把这个evbuffer_chain插入到链表最后面即可。此时这个evbuffer_chain的off就等于0了，也就出现了前面说的的那个问题。

        如果链表的最后一个有数据chain还有一些空闲空间，但小于datlen。那么就有点麻烦。evbuffer_expand 是调用evbuffer_expand_singlechain实现扩大空间的。而evbuffer_expand_singlechain函数有一个特点，预留空间datlen必须是在一个evbuffer_chain中，不能跨chain。该函数的返回值就指明了哪个chain预留了datlen空间。不能跨chain也就导致了一些麻烦事。

        由于不能跨chain，但最后一个chain确实又还有一些空闲空间。前面的evbuffer_add函数会把链表的所有节点的buffer都填得满满的。这说明所有节点的buffer还是用完的好，比较统一。要明确的是，此种情况下，肯定是要新建一个evbuffer_chain插入到后面。

        Libevent还是想把所有节点的buffer都填满。如果最后一个chain的数据比较少，那么就直接不要那个chain。当然chain上的数据还是要的。Libevent新建一个比datlen更大的chain，把最后一个chain上的数据迁移到这个新建的chain上。这样就既能保证该chain节点也能填满，也保证了预留空间datlen必须在是一个chain的。如果最后一个chain的数据比较多，Libevent就认为迁移不划算，那么Libevent就让这个chain最后留有一些空间不使用。

        下面是该函数的代码展示了上面所说的：

[cpp]  view plain copy

1. //buffer.c文件  
2.   
3. #define MAX_TO_COPY_IN_EXPAND 4096  
4. //计算evbuffer_chain的可用空间是多少  
5. #define CHAIN_SPACE_LEN(ch) ((ch)->flags & EVBUFFER_IMMUTABLE ? \  
6.         0 : (ch)->buffer_len - ((ch)->misalign + (ch)->off))  
7.   
8. static struct evbuffer_chain *  
9. evbuffer_expand_singlechain(struct evbuffer *buf, size_t datlen)  
10. {  
11.     struct evbuffer_chain *chain, **chainp;  
12.     struct evbuffer_chain *result = NULL;  
13.     ASSERT_EVBUFFER_LOCKED(buf);  
14.   
15.     chainp = buf->last_with_datap;  
16.   
17.     //*chainp指向最后一个有数据的evbuffer_chain或者为NULL  
18.     if (*chainp && CHAIN_SPACE_LEN(*chainp) == 0)//CHAIN_SPACE_LEN该chain可用空间的大小  
19.         chainp = &(*chainp)->next;  
20.   
21.     //经过上面的那个if后，当最后一个有数据的evbuffer_chain还有空闲空间时  
22.     //*chainp就指向之。否则*chainp指向最后一个有数据的evbuffer_chain的next。     
23.   
24.     chain = *chainp;  
25.   
26.     if (chain == NULL ||//这个chain是不可修改的，那么就只能插入一个新的chain了  
27.         (chain->flags & (EVBUFFER_IMMUTABLE|EVBUFFER_MEM_PINNED_ANY))) {  
28.         goto insert_new;  
29.     }  
30.   
31.     if (CHAIN_SPACE_LEN(chain) >= datlen) {//这个chain的可用空间大于扩展空间  
32.         result = chain;  
33.         //这种情况，Libevent并不会扩大buffer空间.因为Libevent认为现在的可用空间可以用作用户提出的预留空间  
34.         goto ok;   
35.     }  
36.   
37.     if (chain->off == 0) {//当前一个chain存满了时，就会出现这种情况  
38.         goto insert_new;//插入一个新的chain  
39.     }  
40.   
41.      //通过使用misalign错位空间，也能使得可用空间大于等于预留空间，那么也不用  
42.      //扩大buffer空间  
43.     if (evbuffer_chain_should_realign(chain, datlen)) {  
44.         evbuffer_chain_align(chain);  
45.         result = chain;  
46.         goto ok;  
47.     }  
48.   
49.       
50.     //空闲空间小于总空间的1/8 或者 已有的数据量大于MAX_TO_COPY_IN_EXPAND(4096)  
51.     if (CHAIN_SPACE_LEN(chain) < chain->buffer_len / 8 ||  
52.         chain->off > MAX_TO_COPY_IN_EXPAND) {//4096  
53.   
54.         //本chain有比较多的数据，将这些数据迁移到另外一个chain是不划算的  
55.         //此时，将不会改变这个chain。  
56.   
57.         //下一个chain是否可以有足够的空闲空间.有则直接用之  
58.         if (chain->next && CHAIN_SPACE_LEN(chain->next) >= datlen) {  
59.             result = chain->next;  
60.             goto ok;  
61.         } else {  
62.             goto insert_new;  
63.         }  
64.     } else {  
65.         //由于本chain的数据量比较小，所以把这个chain的数据迁移到另外一个  
66.         //chain上是值得的。  
67.         size_t length = chain->off + datlen;  
68.         struct evbuffer_chain *tmp = evbuffer_chain_new(length);  
69.         if (tmp == NULL)  
70.             goto err;  
71.   
72.         tmp->off = chain->off;  
73.         //进行数据迁移  
74.         memcpy(tmp->buffer, chain->buffer + chain->misalign,  
75.             chain->off);  
76.         EVUTIL_ASSERT(*chainp == chain);  
77.         result = *chainp = tmp;  
78.   
79.         if (buf->last == chain)  
80.             buf->last = tmp;  
81.   
82.         tmp->next = chain->next;  
83.         evbuffer_chain_free(chain);  
84.         goto ok;  
85.     }  
86.   
87. insert_new:  
88.     result = evbuffer_chain_insert_new(buf, datlen);  
89.     if (!result)  
90.         goto err;  
91. ok:  
92.     EVUTIL_ASSERT(result);  
93.     EVUTIL_ASSERT(CHAIN_SPACE_LEN(result) >= datlen);  
94. err:  
95.     return result;  
96. }  
97.   
98.   
99. static inline struct evbuffer_chain *  
100. evbuffer_chain_insert_new(struct evbuffer *buf, size_t datlen)  
101. {  
102.     struct evbuffer_chain *chain;  
103.     if ((chain = evbuffer_chain_new(datlen)) == NULL)  
104.         return NULL;  
105.     evbuffer_chain_insert(buf, chain);  
106.     return chain;  
107. }  

        上面代码中evbuffer_expand_singlechain函数的第一个if语句，可以联合前面的两张图一起看，更容易看懂。

        evbuffer_expand_singlechain函数是要求一个节点就能提供大小为datlen的可用空间。其实Libevent还提供了_evbuffer_expand_fast函数，该函数还有一个整型的参数n，用来表示使用不超过n个节点的前提下，提供datlen的可用空间。不过这个函数只留给Libevent内部使用，用户不能使用之。

[cpp]  view plain copy

1. //buffer.c文件  
2. int//用最多不超过n个节点就提供datlen大小的空闲空间。链表过长是不好的  
3. _evbuffer_expand_fast(struct evbuffer *buf, size_t datlen, int n)  
4. {  
5.     struct evbuffer_chain *chain = buf->last, *tmp, *next;  
6.     size_t avail;  
7.     int used;  
8.   
9.     EVUTIL_ASSERT(n >= 2); //n必须大于等于2  
10.   
11.     //最后一个节点是不可用的  
12.     if (chain == NULL || (chain->flags & EVBUFFER_IMMUTABLE)) {  
13.         //这种情况下，直接新建一个足够大的evbuffer_chain即可  
14.         chain = evbuffer_chain_new(datlen);  
15.         if (chain == NULL)  
16.             return (-1);  
17.   
18.         evbuffer_chain_insert(buf, chain);  
19.         return (0);  
20.     }  
21.   
22.     used = 0; /* number of chains we're using space in. */  
23.     avail = 0; /* how much space they have. */  
24.     for (chain = *buf->last_with_datap; chain; chain = chain->next) {  
25.         if (chain->off) {//最后一个有数据的节点的可用空间也是要被使用  
26.             size_t space = (size_t) CHAIN_SPACE_LEN(chain);  
27.             EVUTIL_ASSERT(chain == *buf->last_with_datap);  
28.             if (space) {  
29.                 avail += space;  
30.                 ++used;  
31.             }  
32.         } else {//链表中off为0的空buffer统统使用  
33.             /* No data in chain; realign it. */  
34.             chain->misalign = 0;  
35.             avail += chain->buffer_len;  
36.             ++used;  
37.         }  
38.         if (avail >= datlen) {//链表中的节点的可用空间已经足够了  
39.             return (0);  
40.         }  
41.         if (used == n)//到达了最大可以忍受的链表长度  
42.             break;  
43.     }  
44.   
45.     //前面的for循环，如果找够了空闲空间，那么是直接return。所以  
46.     //运行到这里时，就说明还没找到空闲空间。一般是因为链表后面的off等于0  
47.     //的节点已经被用完了都还不能满足datlen  
48.     if (used < n) {  
49.         EVUTIL_ASSERT(chain == NULL);  
50.   
51.         //申请一个足够大的evbuffer_chain，把空间补足  
52.         tmp = evbuffer_chain_new(datlen - avail);  
53.         if (tmp == NULL)  
54.             return (-1);  
55.   
56.         buf->last->next = tmp;  
57.         buf->last = tmp;  
58.         return (0);  
59.     } else { //used == n。把后面的n个节点都用了还是不够datlen空间  
60.         //链表后面的n个节点都用上了，这个n个节点中，至少有n-1个节点的off等于  
61.         //0。n个节点都不够，Libevent就认为这些节点都是饭桶，Libevent会统统删除  
62.         //然后新建一个足够大的evbuffer_chain。  
63.       
64.         //用来标志该链表的所有节点都是off为0的。在这种情况下，将删除所有的节点  
65.         int rmv_all = 0; /* True iff we removed last_with_data. */  
66.         chain = *buf->last_with_datap;  
67.         if (!chain->off) {  
68.             //这说明链表中的节点都是没有数据的evbuffer_chain  
69.             EVUTIL_ASSERT(chain == buf->first);  
70.             rmv_all = 1;//标志之  
71.             avail = 0;  
72.         } else {  
73.             //最后一个有数据的chain的可用空间的大小。这个空间是可以用上的  
74.             avail = (size_t) CHAIN_SPACE_LEN(chain);  
75.             chain = chain->next;  
76.         }  
77.           
78.   
79.         //chain指向第一个off等于0的evbuffer_chain 或者等于NULL  
80.   
81.         //将这些off等于0的evbuffer_chain统统free掉，不要了。  
82.         //然后new一个足够大的evbuffer_chain即可。这能降低链表的长度  
83.         for (; chain; chain = next) {  
84.             next = chain->next;  
85.             EVUTIL_ASSERT(chain->off == 0);  
86.             evbuffer_chain_free(chain);  
87.         }  
88.   
89.         //new一个足够大的evbuffer_chain  
90.         tmp = evbuffer_chain_new(datlen - avail);  
91.         if (tmp == NULL) {//new失败  
92.             if (rmv_all) {//这种情况下，该链表就根本没有节点了  
93.                 ZERO_CHAIN(buf);//相当于初始化evbuffer的链表  
94.             } else {  
95.                 buf->last = *buf->last_with_datap;  
96.                 (*buf->last_with_datap)->next = NULL;  
97.             }  
98.             return (-1);  
99.         }  
100.   
101.         if (rmv_all) {//这种情况下，该链表就只有一个节点了  
102.             buf->first = buf->last = tmp;  
103.             buf->last_with_datap = &buf->first;  
104.         } else {  
105.             (*buf->last_with_datap)->next = tmp;  
106.             buf->last = tmp;  
107.         }  
108.         return (0);  
109.     }  
110. }  

在链表头添加数据：

        前面的evbuffer_add是在链表尾部追加数据，Libevent提供了另外一个函数evbuffer_prepend可以在链表头部添加数据。在这个函数里面可以看到evbuffer_chain结构体成员misalign的一些使用，也能知道为什么会有这个成员。

        evbuffer_prepend函数并不复杂，只需弄懂misalign的作用就很容易明白该函数的实现。考虑这种情况：要在链表头插入数据，那么应该new一个新的evbuffer_chain，然后把要插入的数据放到这个新建个的evbuffer_chain中。但evbuffer_chain_new申请到的buffer空间可能会大于要插入的数据长度。插入数据后，buffer就必然会剩下一些空闲空间。那么这个空闲空间放在buffer的前面好还是后面好呢？Libevent认为放在前面会好些，此时misalign就有用了。它表示错开不用的空间，也就是空闲空间。如果再次在链表头插入数据，就可以使用到这些空闲空间了。所以，misalign也可以认为是空闲空间，可以随时使用。

[cpp]  view plain copy

1. //buffer.c文件  
2. int  
3. evbuffer_prepend(struct evbuffer *buf, const void *data, size_t datlen)  
4. {  
5.     struct evbuffer_chain *chain, *tmp;  
6.     int result = -1;  
7.   
8.     EVBUFFER_LOCK(buf);  
9.   
10.     //冻结缓冲区头部，禁止在头部添加数据  
11.     if (buf->freeze_start) {  
12.         goto done;  
13.     }  
14.   
15.     chain = buf->first;  
16.   
17.     //该链表暂时还没有节点  
18.     if (chain == NULL) {  
19.         chain = evbuffer_chain_new(datlen);  
20.         if (!chain)  
21.             goto done;  
22.         evbuffer_chain_insert(buf, chain);  
23.     }  
24.   
25.     if ((chain->flags & EVBUFFER_IMMUTABLE) == 0) {//该chain可以修改  
26.         /* If this chain is empty, we can treat it as 
27.          * 'empty at the beginning' rather than 'empty at the end' */  
28.         if (chain->off == 0)  
29.             chain->misalign = chain->buffer_len;  
30.   
31.         //考虑这种情况:一开始chain->off等于0，之后调用evbuffer_prepend插入  
32.         //一些数据(还没填满这个chain),之后再次调用evbuffer_prepend插入一些  
33.         //数据。这样就能分别进入下面的if else了  
34.   
35.         if ((size_t)chain->misalign >= datlen) {//空闲空间足够大  
36.             memcpy(chain->buffer + chain->misalign - datlen,  
37.                 data, datlen);  
38.             chain->off += datlen;  
39.             chain->misalign -= datlen;  
40.             buf->total_len += datlen;  
41.             buf->n_add_for_cb += datlen;  
42.             goto out;  
43.         } else if (chain->misalign) {//不够大，但也要用  
44.             memcpy(chain->buffer,//用完这个chain,所以从头开始  
45.                 (char*)data + datlen - chain->misalign,  
46.                 (size_t)chain->misalign);  
47.             chain->off += (size_t)chain->misalign;  
48.             buf->total_len += (size_t)chain->misalign;  
49.             buf->n_add_for_cb += (size_t)chain->misalign;  
50.             datlen -= (size_t)chain->misalign;  
51.             chain->misalign = 0;  
52.         }  
53.     }  
54.   
55.   
56.     //为datlen申请一个evbuffer_chain。把datlen长的数据放到这个新建的chain  
57.     if ((tmp = evbuffer_chain_new(datlen)) == NULL)  
58.         goto done;  
59.     buf->first = tmp;  
60.     if (buf->last_with_datap == &buf->first)  
61.         buf->last_with_datap = &tmp->next;  
62.   
63.     tmp->next = chain;  
64.   
65.     tmp->off = datlen;  
66.     tmp->misalign = tmp->buffer_len - datlen;  
67.   
68.     memcpy(tmp->buffer + tmp->misalign, data, datlen);  
69.     buf->total_len += datlen;  
70.     buf->n_add_for_cb += (size_t)chain->misalign;  
71.   
72. out:  
73.     evbuffer_invoke_callbacks(buf);//调用回调函数  
74.     result = 0;  
75. done:  
76.     EVBUFFER_UNLOCK(buf);  
77.     return result;  
78. }  

读取数据：

        现在来看一下怎么从evbuffer中复制一些数据。Libevent提供了函数evbuffer_copyout用来复制evbuffer的数据。当然是从链表的前面开始复制。

[cpp]  view plain copy

1. //buffer.c文件  
2. ev_ssize_t  
3. evbuffer_copyout(struct evbuffer *buf, void *data_out, size_t datlen)  
4. {  
5.     struct evbuffer_chain *chain;  
6.     char *data = data_out;  
7.     size_t nread;  
8.     ev_ssize_t result = 0;  
9.   
10.     EVBUFFER_LOCK(buf);  
11.   
12.     chain = buf->first;  
13.   
14.     if (datlen >= buf->total_len)  
15.         datlen = buf->total_len;//最大能提供的数据  
16.   
17.     if (datlen == 0)  
18.         goto done;  
19.   
20.     //冻结缓冲区头部，禁止读取缓冲区的数据  
21.     if (buf->freeze_start) {  
22.         result = -1;  
23.         goto done;  
24.     }  
25.   
26.     nread = datlen;  
27.     while (datlen && datlen >= chain->off) {  
28.         memcpy(data, chain->buffer + chain->misalign, chain->off);  
29.         data += chain->off;  
30.         datlen -= chain->off;  
31.   
32.         chain = chain->next;  
33.     }  
34.   
35.     if (datlen) {  
36.         memcpy(data, chain->buffer + chain->misalign, datlen);  
37.     }  
38.   
39.     result = nread;  
40. done:  
41.     EVBUFFER_UNLOCK(buf);  
42.     return result;  
43. }  

        这个函数逻辑比较简单，这里就不多讲了。

        有时我们不仅仅想复制数据，还想删除数据，或者是复制后就删除数据。这些操作在socket编程中还是很常见的。

[cpp]  view plain copy

1. //buffer.c文件  
2. int  
3. evbuffer_drain(struct evbuffer *buf, size_t len)  
4. {  
5.     struct evbuffer_chain *chain, *next;  
6.     size_t remaining, old_len;  
7.     int result = 0;  
8.   
9.     EVBUFFER_LOCK(buf);  
10.     old_len = buf->total_len;  
11.   
12.     if (old_len == 0)  
13.         goto done;  
14.   
15.     //冻结缓冲区头部，禁止删除头部数据  
16.     if (buf->freeze_start) {  
17.         result = -1;  
18.         goto done;  
19.     }  
20.   
21.     //要删除的数据量大于等于已有的数据量。并且这个evbuffer是可以删除的  
22.     if (len >= old_len && !HAS_PINNED_R(buf)) {  
23.         len = old_len;  
24.         for (chain = buf->first; chain != NULL; chain = next) {  
25.             next = chain->next;  
26.             evbuffer_chain_free(chain);  
27.         }  
28.   
29.         ZERO_CHAIN(buf);//相当于初试化evbuffer的链表  
30.     } else {  
31.         if (len >= old_len)  
32.             len = old_len;  
33.   
34.         buf->total_len -= len;  
35.         remaining = len;  
36.         for (chain = buf->first;  
37.              remaining >= chain->off;  
38.              chain = next) {  
39.             next = chain->next;  
40.             remaining -= chain->off;  
41.   
42.             //已经删除到最后一个有数据的evbuffer_chain了  
43.             if (chain == *buf->last_with_datap) {  
44.                 buf->last_with_datap = &buf->first;  
45.             }  
46.   
47.             //删除到倒数第二个有数据的evbuffer_chain  
48.             if (&chain->next == buf->last_with_datap)  
49.                 buf->last_with_datap = &buf->first;  
50.   
51.             //这个chain被固定了，不能删除  
52.             if (CHAIN_PINNED_R(chain)) {  
53.                 EVUTIL_ASSERT(remaining == 0);  
54.                 chain->misalign += chain->off;  
55.                 chain->off = 0;  
56.                 break;//后面的evbuffer_chain也是固定的  
57.             } else  
58.                 evbuffer_chain_free(chain);  
59.         }  
60.   
61.         buf->first = chain;  
62.         if (chain) {  
63.             chain->misalign += remaining;  
64.             chain->off -= remaining;  
65.         }  
66.     }  
67.   
68.     evbuffer_invoke_callbacks(buf);//因为删除数据，所以也要调用回调函数  
69. done:  
70.     EVBUFFER_UNLOCK(buf);  
71.     return result;  
72. }  
73.   
74.   
75. int  
76. evbuffer_remove(struct evbuffer *buf, void *data_out, size_t datlen)  
77. {  
78.     ev_ssize_t n;  
79.     EVBUFFER_LOCK(buf);  
80.     n = evbuffer_copyout(buf, data_out, datlen);  
81.     if (n > 0) {  
82.         if (evbuffer_drain(buf, n)<0)  
83.             n = -1;  
84.     }  
85.     EVBUFFER_UNLOCK(buf);  
86.     return (int)n;  
87. }  

        可以看到evbuffer_remove是先复制数据，然后才删除evbuffer的数据。而evbuffer_drain则直接删除evbuffer的数据，而不会复制。