wifidog认证源码分析Lighttpd1.4.20源码分析之插件系统（2）---插件的加载和初始化（2）
前面提到了main函数调用plugins_call_init函数对所有插件进行初始化，下面接着介绍
plugins_call_init函数在plugin.c文件中：
Code highlighting produced by Actipro CodeHighlighter (freeware)http://www.CodeHighlighter.com/--> 1 handler_t plugins_call_init(server * srv)
{
size_t i;
plugin **ps;
ps = srv->plugins.ptr;
/*
* fill slots
*/
srv->plugin_slots = calloc(PLUGIN_FUNC_SIZEOF, sizeof(ps));
for (i = 0; i < srv->plugins.used; i++)
{
size_t j;
/*
* check which calls are supported
*/
plugin *p = ps[i];
/**
* 对所有的plugin进行登记造册。这个宏在后文中着重讲解。
*/
#define PLUGIN_TO_SLOT(x, y) \
if (p->y) { \
plugin **slot = ((plugin ***)(srv->plugin_slots))[x]; \
if (!slot) { \
slot = calloc(srv->plugins.used, sizeof(*slot));\
((plugin ***)(srv->plugin_slots))[x] = slot; \
} \
for (j = 0; j < srv->plugins.used; j++) { \
if (slot[j]) continue;\
slot[j] = p;\
break;\
}\
}
PLUGIN_TO_SLOT(PLUGIN_FUNC_HANDLE_URI_CLEAN, handle_uri_clean);
PLUGIN_TO_SLOT(PLUGIN_FUNC_HANDLE_URI_RAW, handle_uri_raw);
PLUGIN_TO_SLOT(PLUGIN_FUNC_HANDLE_REQUEST_DONE, handle_request_done);
PLUGIN_TO_SLOT(PLUGIN_FUNC_HANDLE_CONNECTION_CLOSE, handle_connection_close);
PLUGIN_TO_SLOT(PLUGIN_FUNC_HANDLE_TRIGGER, handle_trigger);
PLUGIN_TO_SLOT(PLUGIN_FUNC_HANDLE_SIGHUP, handle_sighup);
PLUGIN_TO_SLOT(PLUGIN_FUNC_HANDLE_SUBREQUEST, handle_subrequest);
PLUGIN_TO_SLOT(PLUGIN_FUNC_HANDLE_SUBREQUEST_START, handle_subrequest_start);
PLUGIN_TO_SLOT(PLUGIN_FUNC_HANDLE_JOBLIST, handle_joblist);
PLUGIN_TO_SLOT(PLUGIN_FUNC_HANDLE_DOCROOT, handle_docroot);
PLUGIN_TO_SLOT(PLUGIN_FUNC_HANDLE_PHYSICAL, handle_physical);
PLUGIN_TO_SLOT(PLUGIN_FUNC_CONNECTION_RESET, connection_reset);
PLUGIN_TO_SLOT(PLUGIN_FUNC_CLEANUP, cleanup);
PLUGIN_TO_SLOT(PLUGIN_FUNC_SET_DEFAULTS, set_defaults);
#undef PLUGIN_TO_SLOT
//对插件进行初始化，调用其初始化函数
if (p->init)
{
if (NULL == (p->data = p->init()))
{
log_error_write(srv, __FILE__, __LINE__, "sb", "plugin-init failed for module", p->name);
return HANDLER_ERROR;
}
/*
* used for con->mode,DIRECT==0,plugins above that
*/
((plugin_data *) (p->data))->id = i + 1;
//这里检测插件的版本是否和当前服务器的版本相同。
//这里保证如果以后插件的接口发生了改变，不会造成服务器崩溃。
if (p->version != LIGHTTPD_VERSION_ID)
{
log_error_write(srv, __FILE__, __LINE__, "sb","plugin-version doesn't match lighttpd-version for", p->name);
return HANDLER_ERROR;
}
}
else
{
p->data = NULL;
}
}
return HANDLER_GO_ON;
}
整个函数中，这个宏是重点：
Code highlighting produced by Actipro CodeHighlighter (freeware)http://www.CodeHighlighter.com/--> 1 #define PLUGIN_TO_SLOT(x, y) \
if (p->y) { \
plugin **slot = ((plugin ***)(srv->plugin_slots))[x]; \
if (!slot) { \
slot = calloc(srv->plugins.used, sizeof(*slot));\
((plugin ***)(srv->plugin_slots))[x] = slot; \
} \
for (j = 0; j < srv->plugins.used; j++) { \
if (slot[j]) continue;\
slot[j] = p;\
break;\
}\
}
在结构体server中，plugin_slots是一个void指针。在这个宏中可以看到，plugin_slots被转换成了plugin结构体的三级指针。朝前看：
srv->plugin_slots = calloc(PLUGIN_FUNC_SIZEOF, sizeof(ps));
plugin_slots是一个存放ps类型数据的数组，数组的长度为PLUGIN_FUNC_SIZEOF。PLUGIN_FUNC_SIZEOF在后面说明。ps的类型是plugin结构体的二级指针。在上面的宏中，我们看到，plugin_slots是一个数组，随后的if分支中可以看到，plugin_slots的元素也是数组。因此，plugin_slots是一个二维数组，数组中的元素是plugin结构体的指针，并且，plugin_slots是动态创建的。
下面在来看PLUGIN_FUNC_SIZEOF，它定义在下面的枚举结构中：
Code highlighting produced by Actipro CodeHighlighter (freeware)http://www.CodeHighlighter.com/--> 1 typedef enum
{
PLUGIN_FUNC_UNSET,
PLUGIN_FUNC_HANDLE_URI_CLEAN,
PLUGIN_FUNC_HANDLE_URI_RAW,
PLUGIN_FUNC_HANDLE_REQUEST_DONE,
PLUGIN_FUNC_HANDLE_CONNECTION_CLOSE,
PLUGIN_FUNC_HANDLE_TRIGGER,
PLUGIN_FUNC_HANDLE_SIGHUP,
PLUGIN_FUNC_HANDLE_SUBREQUEST,
PLUGIN_FUNC_HANDLE_SUBREQUEST_START,
PLUGIN_FUNC_HANDLE_JOBLIST,
PLUGIN_FUNC_HANDLE_DOCROOT,
PLUGIN_FUNC_HANDLE_PHYSICAL,
PLUGIN_FUNC_CONNECTION_RESET,
PLUGIN_FUNC_INIT,
PLUGIN_FUNC_CLEANUP,
PLUGIN_FUNC_SET_DEFAULTS,
PLUGIN_FUNC_SIZEOF
} plugin_t;
从枚举结构的名字可以看出，这个枚举类型定义了插件的功能的类型，对应着plugin结构体中那些函数指针。而最后一个量，PLUGIN_FUNC_SIZEOF，根据枚举类型的特点，正好是上面所定义的类型的数量。这是一个很常用的技巧，这样可以保证在增加类型的时候，保证程序中可以得到正确的类型数量，而不要去改动那些需要类型数量的代码。
接着回到上面的宏，这个宏有两个参数，有后面的使用可以看出，第一个参数x是枚举类型plugin_t，第二个参数x对应的在plugin结构体中函数指针的名称。因此，上面的宏的作用就是：根据参数x所指定的插件功能类型，判断插件p中是否含有功能x，也就是指针p->y是否非NULL。如果包含功能x，则将指针p添加到数组plugin_slots的第x行中。内层的if语句是为了判断plugin_slots的第x行是否存在，不存在则创建之。for循环是为了将p添加到plugin_slots的第x行的末尾。
例如，插件*p1, *p2, *p3,在执行完后面那些宏调用之后，会形成一个如下的表：
从表中可以看出，插件p1包含所有的功能，也就是实现了plugin结构体中函数指针对应的所有函数。插件p2不包含功能HANDLE_SUBREQUEST，HANDLE_SUBREQUEST_START和HANDLE_REQUEST_DONE功能，插件p3中不包含
HANDLE_TRIGGER，HANDLE_SIGHUP和CONNECTION_RESET功能。当然，这仅仅是举个例子。
上面的例子中的表就是plugins_slots。这个宏和后面的宏调用可以看成是给所有的插件“登记造册”。通过plugins_slots数组，可以快速的确定某个功能都有那些插件实现了，这方便后面的插件的调用。
完成这些宏调用后，初始化函数测试插件是否定义了init函数。如果定义了则调用之。这里的init函数和前面加载函数中的XXX_plugin_init函数不一样。XXX_plugin_init初始化函数是初始化plugin结构体，核心工作是对plugin结构体中的函数指针进行赋值。而init函数则是初始化这个插件对应的plugin_data结构体，分配数据空间，初始化成员变量并返回其指针。
如：mod_cgi.c的init函数定义为，
Code highlighting produced by Actipro CodeHighlighter (freeware)http://www.CodeHighlighter.com/-->1 INIT_FUNC(mod_cgi_init)
{
plugin_data *p;
p = calloc(1, sizeof(*p));
assert(p);
p->tmp_buf = buffer_init();
p->parse_response = buffer_init();
return p;
}
返回的指针存放在plugin结构体中的data成员中。然后对data中的id进行赋值。接着，检查插件的版本是否和当前服务器的版本相同。
如果插件没有定义init函数，则data赋值NULL。
至此，插件的加载和初始化工作全部完成了。下面总结一下整个加载和初始化的过程：
（1）根据配置文件从相应的目录中加载插件的动态连接库。
（2）获得插件动态库中XXX_plugin_init函数的入口地址并调用之。此函数对plugin结构体进行赋值。
（3）在server结构体中注册插件。
（4）调用plugins_call_init初始化插件。
（5）通过上面那个宏及后面一系列的宏调用，将插件登记造册，记录在server结构体的plugins_slots成员中。plugins_slot是一个二维数组，数组成员是plugin结构体指针。
（6）最后调用插件的init函数初始化各自的plugin_data结构体。
下一篇中，将介绍一下plugin.c中的宏PLUGIN_TO_SLOT。
本文章由 http://www.wifidog.pro/2015/04/17/wifidog%E8%AE%A4%E8%AF%81%E6%BA%90%E7%A0%81%E5%88%86%E6%9E%90lighttpd%E6%8F%92%E4%BB%B6%E5%8A%A0%E8%BD%BD%E5%88%9D%E5%A7%8B%E5%8C%96-2.html 整理编辑，转载请注明出处