前天剖析了libevent的事件链表tail queue,今天来剖析一下它的evbuffer。evbuffer是libevent中的缓冲区模块,支持读写数据,尤其是可以按行读取,特别是TCP这种基于字节流的数据,需要从字节流解析自己的通讯协议,借助缓冲区保存多余的数据,以便和下一次读到的数据合并分析。
evbuffer对外提供的一系列函数简介,可以参看这篇博客:http://blog.sina.com.cn/s/blog_4ab24dd501013d0h.html
我的这篇博客主要用来分析源码,并附上详细注释。
下面是evbuffer结构体:
//libevnet的缓冲模块
struct evbuffer {
u_char *buffer; //当前存放有效数据的缓冲区的内存起始地址
u_char *orig_buffer; //整个分配(realloc)用来缓冲的内存起始地址
size_t misalign; //origin_buffer和buffer之间的字节数
size_t totallen; //整个分配用来缓冲的内存字节数
size_t off; //当前存放有效数据的缓冲区的长度(字节数)
void (*cb)(struct evbuffer *, size_t, size_t, void *); //缓冲区有变化时调用的回调函数,可以不设置
void *cbarg; //回调函数的参数
};
那么怎么理解evbuffer呢?请看下图:
orig_buffer就是指向你申请的总大小,buffer是实际存放数据的大小。读数据从前往后读,写数据相当于追加数据。有以下几种情况:
1.刚开始orign_buffer=buffer,misalign=off=0,放入数据,off增加,即buffer指向的有效数据区增加。
2.读取了一部分数据,一部分数据变为used已经使用了,那么就干掉用过的那部分,buffer向后移,misalign增加,off减小。
3.如果要些数据,那么进行相应的判断,free space是否足够,这是有这几种情况:
(1)足够,那么直接追加在buffer后面即可。
(2)free space不够,used区域,也就是已经使用过的但目前没有利用的区域有空间,那么将buffer挪回orig_buffer,相当于扩大free space,再写数据。
(3)都不够,那么直接扩大内存,以realloc方式,最少一次扩大256字节,后面每次以2倍的方式扩大,和STL的vectot内存策略一样。
下面我将源码附带注释贴出来,这些都在buffer.c中:
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#ifdef WIN32
#include <winsock2.h>
#include <windows.h>
#endif
#ifdef HAVE_VASPRINTF
/* If we have vasprintf, we need to define this before we include stdio.h. */
#define _GNU_SOURCE
#endif
#include <sys/types.h>
#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#ifdef HAVE_SYS_IOCTL_H
#include <sys/ioctl.h>
#endif
#include <assert.h>
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#ifdef HAVE_STDARG_H
#include <stdarg.h>
#endif
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#include "event.h&#