Libevent源码分析-----多线程、锁、条件变量(一)
转载请注明出处: http://blog.csdn.net/luotuo44/article/details/38350633
Libevent提供给用户的可见多线程API都在thread.h文件中。在这个文件提供的API并不多。基本上都是一些定制函数，像前面几篇博文说到的，可以为Libevent定制用户自己的多线程函数。
开启多线程：
Libevent默认是不开启多线程的，也没有锁、条件变量这些东西。这点和前面博客说到的"没有定制就用Libevent默认提供"，有所不同。只有当你调用了evthread_use_windows_threads()或者evthread_use_pthreads()或者调用evthread_set_lock_callbacks函数定制自己的多线程、锁、条件变量才会开启多线程功能。其实，前面的那两个函数其内部实现也是定制，在函数的内部，Libevent封装的一套Win32线程、pthreads线程。然后调用evthread_set_lock_callbacks函数，进行定制。
thread.h文件只提供了定制线程的接口，并没有提供使用线程接口。这点很像前面说到的Libevent日志和内存分配。其实这也很好理解。因为都是你提供定制的线程函数。你都能提供了，你肯定有办法使用，没必要要Libevent提供一些API给你使用。
如果用户为libevent开启了多线程，那么libevent里面的函数就会变成线程安全的。此时主线程在使用event_base_dispatch，别的线程是可以线程安全地使用event_add把一个event添加到主线程的event_base中。具体的工作原理可以参考《evthread_notify_base通知主线程》。
锁和条件变量结构体：
Libevent允许用户定制自己的锁和条件变量。其实现原理和前面说到的日志和内存分配一样，都是内部有一个全局变量。定制自己的锁和条件变量，就是对这个全局变量进行赋值。
锁结构：
//thread.h文件
struct evthread_lock_callbacks {
//版本号，设置为宏EVTHREAD_LOCK_API_VERSION
int lock_api_version;
//支持的锁类型，有普通锁，递归锁，读写锁三种
unsigned supported_locktypes;
//分配一个锁变量(指针类型)，因为不同的平台锁变量是不同的类型
//所以用这个通用的void*类型
void *(*alloc)(unsigned locktype);
void (*free)(void *lock, unsigned locktype);
int (*lock)(unsigned mode, void *lock);
int (*unlock)(unsigned mode, void *lock);
};
目前Libevent支持的locktype
(
锁类型)有三种：
- 普通锁， 值为0
- 递归锁， 值为EVTHREAD_LOCKTYPE_RECURSIVE
- 读写锁， 值为EVTHREAD_LOCKTYPE_READWRITE
参数mode(锁模式)则取下面的值：
- EVTHREAD_READ：仅用于读写锁：为读操作请求或者释放锁
-
EVTHREAD_WRITE：仅用于读写锁：为写操作请求或者释放锁
-
EVTHREAD_TRY：仅用于锁定：仅在可以立刻锁定的时候才请求锁定
虽然Libevent提供了这些锁类型和mode类型，但实际上是否支持这些类型完全是由所定制的线程锁决定的。Libevent提供的pthreads线程锁和WIN32线程锁就只支持其中的一部分。具体是哪些下面会说到。
条件变量结构：
//thread.h文件
struct evthread_condition_callbacks {
//版本号，设置为EVTHREAD_CONDITION_API_VERSION宏
int condition_api_version;
void *(*alloc_condition)(unsigned condtype);
void (*free_condition)(void *cond);
int (*signal_condition)(void *cond, int broadcast);
int (*wait_condition)(void *cond, void *lock,
const struct timeval *timeout);
};
条件变量的版本为EVTHREAD_CONDITION_API_VERSION时，alloc_condition的参数取0。奇怪的是，Libevent并没有提供其他的版本号。前面的线程锁也是只提供给了一个版本号。
signal_condition的第一个参数为alloc_condition的返回值，第二个参数指明唤醒多少个等待的线程。当broadcast取1时，唤醒所有的线程。取其他值时，只唤醒其中一个线程。
wait_condition的第二个参数为前面线程锁evthread_lock_callbacks结构中的alloc指针函数的返回值。熟悉条件变量的读者，这点还是比较容易懂的。对于第三个参数，和pthread_cond_timedwait有所不同。pthread_cond_timedwait的时间是绝对时间，这里的timeout则是等待的时间，所以千万不要用一个绝对时间作为参数值，不然等到老都等不到超时。如果该参数为NULL，那么就没有超时，将死等下去，直到另外的线程调用了signal_condition。
Libevent封装的多线程：
说了这么多，其实对于用户来说，如果想让Libevent支持多线程。Windows用户直接调用evthread_use_windows_threads()，遵循pthreads线程的系统直接调用evthread_use_pthreads()就可以了。其他什么东西都不需要做了。还有一点要注意的是，这两个函数要在代码的一开始就调用， 必须在event_base_new函数之前调用。好了，现在还是研究代码吧。 下面看一下evthread_use_pthreads()函数。
//evthread_pthreads.c文件
int
evthread_use_pthreads(void)
{
//结构体中做一些函数指针作为参数。这些函数都是定义在evthread_pthread.c文件中
struct evthread_lock_callbacks cbs = {
EVTHREAD_LOCK_API_VERSION,
EVTHREAD_LOCKTYPE_RECURSIVE,
evthread_posix_lock_alloc,//函数指针
evthread_posix_lock_free,//函数指针
evthread_posix_lock,//函数指针
evthread_posix_unlock//函数指针
};
struct evthread_condition_callbacks cond_cbs = {
EVTHREAD_CONDITION_API_VERSION,
evthread_posix_cond_alloc,
evthread_posix_cond_free,
evthread_posix_cond_signal,
evthread_posix_cond_wait
};
/* Set ourselves up to get recursive locks. */
if (pthread_mutexattr_init(&attr_recursive))
return -1;
if (pthread_mutexattr_settype(&attr_recursive, PTHREAD_MUTEX_RECURSIVE))
return -1;
evthread_set_lock_callbacks(&cbs); //定制锁操作
evthread_set_condition_callbacks(&cond_cbs); //定制条件变量操作
evthread_set_id_callback(evthread_posix_get_id); //设置可以获取线程ID的回调函数
return 0;
}
函数一开始就定义并初始化了一个evthread_lock_callbacks结构和一个evthread_condition_callbacks结构。然后用之去进行定制。
代码中的attr_recursive是一个锁属性pthread_mutexattr_t类型的全局变量。在这个函数中，它被设置成具有递归属性。在申请锁时，可以看到其作用。
static void *
evthread_posix_lock_alloc(unsigned locktype)
{
pthread_mutexattr_t *attr = NULL;
pthread_mutex_t *lock = mm_malloc(sizeof(pthread_mutex_t));
if (!lock)
return NULL;
if (locktype & EVTHREAD_LOCKTYPE_RECURSIVE)
attr = &attr_recursive;
if (pthread_mutex_init(lock, attr)) {
mm_free(lock);
return NULL;
}
return lock;
}
可以看到这个全局变量是用于设置递归锁的。从这个函数可以看到，Libevent提供的pthreads版本锁只支持递归锁和普通非递归锁，并不支持读写锁。当然你可以提供一套支持读写锁的锁操作。阅读Libevent提供的WIN32版本锁代码，也可以看到并不支持读写锁。值得注意的是，WIN32的锁默认是具有递归功能的，无需用EVTHREAD_LOCKTYPE_RECURSIVE作参数值。
前面还说到Libevent提供了EVTHREAD_READ、EVTHREAD_READ、EVTHREAD_TRY三种锁模式(mode)。但在Libevent提供的pthreads版本锁中，只在evthread_posix_lock函数中使用到这些宏。
static int
evthread_posix_lock(unsigned mode, void *_lock)
{
pthread_mutex_t *lock = _lock;
if (mode & EVTHREAD_TRY)
return pthread_mutex_trylock(lock);
else
return pthread_mutex_lock(lock);
}
可以看到，它仅仅支持EVTHREAD_TRY这个锁模式。WIN32版本也是如此。
条件变量也简单地对系统native的条件进行一些简单的封装。这里就不多说了。在Windows中，因为在Windows Vista之前的Windows 操作系统并不支持提供条件变量，此时Libevent就使用Windows提供的EVENT进行一些封装来实现条件变量的功能。如果所在的Windows系统支持条件变量，Libevent将优先使用Windows本身提供的条件变量。这点可以在evthread_use_windows_threads函数看到。
//evthread_win32.c文件
int
evthread_use_windows_threads(void)
{
struct evthread_lock_callbacks cbs = {
EVTHREAD_LOCK_API_VERSION,
EVTHREAD_LOCKTYPE_RECURSIVE,
evthread_win32_lock_create,
evthread_win32_lock_free,
evthread_win32_lock,
evthread_win32_unlock
};
struct evthread_condition_callbacks cond_cbs = {
EVTHREAD_CONDITION_API_VERSION,
evthread_win32_cond_alloc,
evthread_win32_cond_free,
evthread_win32_cond_signal,
evthread_win32_cond_wait
};
#ifdef WIN32_HAVE_CONDITION_VARIABLES //有内置的条件变量功能
struct evthread_condition_callbacks condvar_cbs = {
EVTHREAD_CONDITION_API_VERSION,
evthread_win32_condvar_alloc,
evthread_win32_condvar_free,
evthread_win32_condvar_signal,
evthread_win32_condvar_wait
};
#endif
evthread_set_lock_callbacks(&cbs);
evthread_set_id_callback(evthread_win32_get_id);
//优先使用Windows自身提供的条件变量
#ifdef WIN32_HAVE_CONDITION_VARIABLES
if (evthread_win32_condvar_init()) {
evthread_set_condition_callbacks(&condvar_cbs);
return 0;
}
#endif
evthread_set_condition_callbacks(&cond_cbs);
return 0;
}
一旦用户调用evthread_use_windows_threads()或者evthread_use_pthreads()函数，那么用户就为Libevent定制了自己的线程锁操作。Libevent的其他代码中，如果需要用到锁，就会去调用这些线程锁操作。在实现上，当调用evthread_use_windows_threads()或者evthread_use_pthreads()函数时，两个函数的内部都会调用evthread_set_lock_callbacks函数。而这个设置函数会把前面两个evthread_use_xxx函数中定义的cbs变量值复制到一个evthread_lock_callbacks类型的_evthread_lock_fns全局变量保存起来。以后，Libevent需要用到多线程锁操作，直接访问这个_evthread_lock_fn变量即可。对于条件变量，也是用这样方式实现的。
定制的顺序：
前面的一些博文和这篇都说到了用户可以定制自己的操作，比如内存分配、日志记录、线程锁。这些定制都应该放在代码的最前面，即不能在使用 Libevent 的 event 、 event_base 这些结构体之后。因为这些结构体会使用到内存分配、日志记录、线程锁的。而这三者的定制顺序应该是：内存分配 -> 日志记录 -> 线程锁。
参考：
http://www.wangafu.net/~nickm/libevent-book/Ref1_libsetup.html