[apache] 挂钩说明(1)
从大的方面来看,Apache对HTTP的请求可以分为连接、处理和断开连接三个阶段;从小的方面而言,每个阶段又可以分为更多的子阶段。比如对HTTP的请求,我们可以进一步划分为客户身份验证、客户权限认证、请求校验等阶段,每一个阶段调用相应的函数进行处理。在Apache中,这些子阶段可以用术语“挂钩(HOOK)”来描述。其中的每一个挂钩可以看做是抽象的,他们本身并不会完成什么功能,但在每一个挂钩中我们都维护一个类似于List的数据结构,在这个List中则存放着处理函数的指针,这些函数是挂钩的实现(我们这里称它为挂钩函数)。
简言之,挂钩=挂载点;挂钩函数=具体实现功能的函数。
1. hook类型
1.1 VOID 类型的挂钩
这个类型的挂钩使用宏AP_IMPLEMENT_HOOK_VOID或者APR_IMPLEMENT_EXTERNAL_HOOK_VOID来声明。
挂钩数组中的所有的挂钩函数将逐个被调用,直到调用结束或者发生错误为止。因此返回值类型是void,不会返回状态值。
1.2 RUN_ALL类型的挂钩
这个类型的挂钩使用宏AP_IMPLEMENT_HOOK_RUN_ALL或者APR_IMPLEMENT_EXTERNAL_HOOK_RUN_ALL来声明
挂钩数组中的所有的挂钩函数将逐个被调用,直到发生错误为止。如果返回值OK 或者 DECLINED的话仍然调用下一个挂钩函数。因此只有调用请求发生错误才返回该错误值,同时退出遍历。
例如 ap_hook_pre_config,设定各个模块的配置时发生错误的话,想阻止apache继续启动,就可以使用这个挂钩。
1.3 RUN_FIRST类型的挂钩
这个类型的挂钩使用宏AP_IMPLEMENT_HOOK_RUN_FIRST或者APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST来声明。
对于该类型Apache内核依次执行挂钩数组中所注册的挂钩函数,直到遇到一个能够完成所提交任务的函数或者发生错误为止(返回值不是DECLINE ,即等于OK or 异常)。调用成功的话以后的挂钩函数不会执行。
也就是说,apache内核可以把任务交给“谁知道 或者 谁想做这个事情”的时候就很有用。
例如大家都熟悉的ap_hook_handler 挂钩,这个挂钩用来处理“是哪个函数能处理这个请求,并返回合适的内容”。反过来说如果所有的模块如果都能返回就很可笑了。
实际上在某个函数不能处理时,在其他地方能处理时,就有必要指定这个挂钩函数置于数组的最前面,为 APR_HOOK_FIRST(或者APR_HOOK_REALLY_FIRST)。一般情况下,必须指定返回值为 DECLINED。
1.4 hook确认
1.4.1 环境变量SHOW_HOOKS
apache提供了一个环境变量SHOW_HOOKS,可以用来显示运行状态下什么地方注册了挂钩函数,以及挂钩函数的顺序。
[root@centos httpd-2.2.23-worker]# export SHOW_HOOKS=1
[root@centos httpd-2.2.23-worker]# ./bin/httpd -k start
Registering hooks for core.c
Hooked create_connection
Hooked pre_connection
Hooked post_config
Hooked translate_name
Hooked map_to_storage
Hooked open_logs
Hooked child_init
Hooked handler
Hooked type_checker
Hooked fixups
Hooked access_checker
Hooked create_request
Hooked create_req
Hooked pre_mpm
Hooked insert_filter
(略)
Sorting create_connection: core.c
Sorting pre_connection: mod_dumpio.c mod_logio.c core.c
Sorting post_config: core.c mod_cache.c mod_include.c mod_mime_magic.c mod_auth_digest.c mod_mem_cache.c mod_dbd.c mod_ext_filter.c mod_headers.c mod_unique_id.c mod_proxy.c mod_proxy_balancer.c mod_mime.c mod_dav.c mod_status.c mod_cgid.c mod_rewrite.c
(略)
上面的输出内容可以看到:
1) core.c里注册了接下来的15个挂钩;
2) 挂钩create_connection一共有1个挂钩函数所在的模块是core.c;
挂钩pre_connection 一共有3个挂钩函数,挂钩函数经过排序之后,他们所在的模块是分别是mod_dumpio.c、mod_logio.c、core.c。
挂钩post_config 一共有17个挂钩函数,挂钩函数经过排序之后,他们所在的模块是分别是core.c、mod_cache.c、mod_include.c、mod_mime_magic.c、mod_auth_digest.c、mod_mem_cache.c、mod_dbd.c、mod_ext_filter.c、mod_headers.c、mod_unique_id.c、mod_proxy.c、mod_proxy_balancer.c、mod_mime.c、mod_dav.c、mod_status.c、mod_cgid.c、mod_rewrite.c。
另外,因为apr_hook_sort_all()会被执行多次,console里会重复输出多次。
1.4.2 mod_info
也可以通过mod_info模块查看hook的信息,具体参考
http://httpd.apache.org/docs/2.2/mod/mod_info.html
修改httpd.conf,配置如下:
LoadModule info_module modules/mod_info.so
<Location /server-info>
SetHandler server-info
Deny from all
Allow from all
</Location>
然后在浏览器查看 http://<host>/server-info