使用apxs重新编译apache模块
2010-08-21 13:16:54 阿炯

编译apache-httpd

官方上指定的依赖环境有：apr、apr-util、pcre、pcre-devle，此外还需要expat-devel包。其中pcre、pcre-devel和expat.devel可以直接使用软件源安装，apr和apr-util需要编译安装。

模块动静态编译

httpd是高度模块化的程序，各个功能通过加载各个模块来实现。但前提是将功能对应的模块先编译好，以供httpd加载。httpd对模块有两种编译方式：静态编译和动态编译：
静态编译：将模块直接编译进httpd的核心中。静态编译的所有模块都会随着httpd的启动和启动。
动态编译：将模块编译好，但不编译到httpd的核心中。要启动动态编译的模块，需要在httpd的配置文件中使用LoadModule指令加载。

httpd的一个优点是可以实现动态模块的热插拔。因为httpd是独立于终端的守护进程，可以通过发送HUP信号给httpd让其重读配置文件。而是否加载动态编译模块正是由httpd配置文件中的LoadModule指令决定的。当想要加载某个模块A时(即模块热插)，使用LoadModule指定A模块的链接地址，再发送HUP信号重读配置文件即可。而想要停止某个模块A时(即模块热拔)，只需将对应模块的LoadModule指令行给注释，再重读配置文件即可。

甚至，可以随时动态编译某个外部模块到httpd中，然后再热插。因为何时编译需要动态加载的模块对httpd来说是无关紧要的，它只需LoadModule和重读配置文件两个过程对模块进行控制。在编译选项中，有几种类型的选项：
--disable-FEATURE:禁用某特性，等价于--enable-FEATURE=no
--enable-FEATURE[=ARG]:启用某特性，默认参数值为YES
--enable-Module_Name=shared:指定的模块Module_Name以动态编译方式安装
--enable-Module_Name=static:指定的模块Module_Name以静态编译方式安装

对于./configure --help中给定的选项，如果该选项是--disable的，那么表示该选项默认是启用的，需要显式使用--disable选项禁用；如果该选项是--enable的，那么表示该选项默认是禁用的，需要使用--enable选项来启用。例如：
--disable-authz-user:表示authz-user特性默认启用，编译时无需指定该项。如果要禁用，编译时需显式指定--disable-authz-user
--enable-echo:表示echo特性默认是禁用的，如果要启用，则编译时需显式指定--enable-echo

模块名的书写是有规则的，一般模块的全称类似于"mod_BASENAME.so"格式，例如"mod_charset_lite.so"，但在编译选项中指定模块时，只需指定BASENAME，且如果basename中包含下划线时，需要转换为短横线。例如"--enable-echo"表示编译的模块是"mod_echo.so"。

此外，还支持3种列表方式的动静态编译选项：列表项之间使用空格分隔，但要使用单引号包围。
--enable-modules='Module_Name1 Moduel_Name2'
--enable-mods-shared='Module_Name1 Module_Name2'
--enable-mods-statics='Module_Name1 Module_Name2'

列表部分还可以使用关键字"all/few/most/reallyall"。分别表示编译所有、少量、大多数、真正的所有模块。

"--enable-modules"基本等价于"--enable-mods-shared"，都是动态编译给定列表中的模块，但"--enable-modules"可以额外使用一个关键字"none"，表示不编译所有模块。


动静态编译的优先级规则

httpd动静态模块编译有一套规则，各种动静态便宜选项之间有优先级的存在。例如，某个非核心模块既指定了动态编译，同时又指定了静态编译，那到底是静态还是动态编译？

以下是我总结的一些优先级规则。

不指定任何模块编译选项时，默认的选项为"--enable-mods-shared"，而该选项的默认值又是most，所以等价于"--enable-mods-shared=most"。显式指定要动态或静态编译的优先级最高。有以下几种方式显式指定：
--enable-Module_Name=shared
--enable-Module_Name=static
--enable-mods-shared='Module_Name1 Module_Name2'
--enable-mods-statics='Module_Name1 Module_Name2'
--enable-modules='Module_Name1 Moduel_Name2'

如果某个模块既显式指定了动态，又显式指定了静态编译，则静态编译优先级更高。例如：
--enable-echo=shared
--enable-echo=static

那么，mod_echo模块将被静态编译。指定了关键字(all/most/few/reallyall)的"--enable-mods-static"选项，优先级高于指定或未指定关键字的"--enable-mods-shared"和"--enable-modules"选项，即静态关键字规则强于动态关键字规则。例如，下面两个编译配置中，都是"--enable-mods-static=few"生效。第二个编译配置语句中将忽略"--enable-mods-shared=all"。
./configure --prefix=/tmp/apache --enable-mods-static=few
./configure --prefix=/tmp/apache --enable-mods-static=few --enable-mods-shared=all

对于下面的例子，authn-file和echo这两个模块既指定了动态编译又指定了静态编译，静态优先级高于动态，所以这两个模块静态被静态编译。由于没有使用关键字，所以会使用默认的"--enable-mods-shared=most"配置。即动态编译大部分，但指定的这两个模块被静态编译。

./configure --prefix=/tmp/apache --enable-mods-static='authn-file echo' --enable-mods-shared='authn-file echo'

    而下面这个例子由于额外指定了使用"--enable-mods-static=few"选项，其优先级高于默认的"--enable-mods-shared=most"，所以结果是静态编译few，且显式指定的两个模块也被静态编译。
./configure --prefix=/tmp/apache --enable-mods-static='authn-file echo' \
--enable-mods-shared='authn-file echo' --enable-mods-static=few

使用了关键字的"--enable-mods-static"、"--enable-mods-shared "和"--enable-modules"的选项，隐含了"没有指定何种编译方式的模块"的默认编译方式。例如下面的编译配置，"--enable-mods-static"指定了关键字few，它将优先于默认的配置规则"--enable-mods-shared=most"，所以没有指定编译方式的模块"data"将以静态的方式编译。
./configure --prefix=/tmp/apache --enable-mods-static=few --enable-data

下面的配置如何编译的？由于默认的是"--enable-mods-shared=most"编译方式，所以模块"data"将以动态的方式编译。
./configure --prefix=/tmp/apache --enable-data

再看下面的例子，配置中出现了"--enable-mods-static=few"和"--enable-mods-shared"(未给定值时也是默认为most)，static的优先级高于shared，所以没有指定编译方式的模块"data"使用静态编译方式编译，而显式指定了编译方式的模块"echo"其优先级最强，所以动态编译"echo"。
./configure --prefix=/tmp/apache --enable-mods-static=few --enable-mods-shared --enable-data --enable-echo=shared


MPM的安装

编译mpm模块(prefork/worker/event)和其他模块差不多，唯一的区别是必须至少编译一个mpm模块，且必须有且仅有一个加载被httpd加载。编译安装时默认的mpm是event模式(和发行版有关)。但可以通过"--with-mpm=MPM_NAME"来指定被加载的mpm模块。以下是几个相关编译选项：
--with-mpm=MPM_Name：用于指定默认的mpm模块，它所指定的模块会被静态编译，并在httpd启动时加载。
--enable-mpms-shared=MPM-LIST：指定动态编译安装的MPM列表，动态编译的MPM必须使用LoadModule指令加载才能使用。

如果定"--with-mpm"选项指定了某个mpm，则默认该模块被静态编译，但如果同时使用"--enable-mpms-shared"指定了该mpm，则该mpm模块被动态编译。如果某个mpm模块被静态编译，在httpd启动时会加载它，如果想要切换到其他mpm模块，只有一种方法：重新编译httpd。

而动态编译mpm模块时，则可以通过LoadModule来切换到其他mpm模块。由于编译时自带默认mpm模块，还可以使用"--with-mpm"指定默认mpm模块，所以动态编译mpm模块无疑比静态编译要好。

"--enable-mpms-shared"可以指定动态编译的mpm列表，使用空格分隔，但需要使用单引号包围。还可以使用关键字"all"表示动态编译所有mpm模块。 例如：
--enable-mpms-shared='prefork worker'
--enable-mpms-shared=all


关于"--enable-so"

一个模块被动态编译，在需要加载的时候使用LoadModule指令指定该模块，并重读配置文件即可。但httpd为什么能加载该动态模块？这就是mod_so的能力。实际上，LoadModule和LoadFile指令就是该模块提供的。

该选项使得httpd有加载某动态模块的能力(DSO,Dynamic Shared Object)，也因此它只能使用静态编译方式随httpd启动被加载。只要不显式指定"--enable-so=shared"或者将其加入显式编译列表，它都会默认以静态方式编译。实际上，只要显式指定了动态方式编译该选项，编译时会报错。

编译安装httpd

./configure --prefix=/usr/local/apache --sysconfdir=/etc/apache --with-z --with-pcre --with-apr=/usr/local/apr --with-apr-util=/usr/local/apr-util --with-mpm=event --enable-mpms-shared=all

其中安装路径为/usr/local/apache，配置文件路径为/etc/apache。

# ls /usr/local/apache/
bin  build  cgi-bin  error  htdocs  icons  include  logs  man  manual  modules

bin目录为二进制程序存放位置，如启动脚本apachectl、httpd、htpasswd、ab（压力测试工具）等；
htdocs目录存放网页文件，默认里面有index.html；
logs目录存放了日志文件，除了日志文件，默认还有httpd运行的pid文件httpd.pid，这个建议修改到/var/run目录下(方便判断)；
modules存放了编译后的模块；
man目录为帮助文档路径。

使用httpd的启动脚本bin/apahcectl启动httpd，然后测试其是否正常。

编译后的规范化操作

设置man路径
echo "MANPATH /usr/local/apache/man" >>/etc/man.config

设置PATH环境变量(非标准路径)
echo 'PATH=/usr/local/apache/bin:$PATH' >/etc/profile.d/apache.sh
source /etc/profile.d/apache.sh

链接开发头文件
ln -s /usr/include /usr/local/apache/include

提供服务启动脚本。
提供不提供没多大所谓，因为apachectl或httpd命令自身可以管理进程的启停，但自身管理启停时不提供lock文件。


apache的apxs2来自动向http.conf配置文件中加入LoadModule语句并将mod_rewrite.so文件拷贝到apache/libexec目录：
/apache2/bin/apxs2 -i -A -n rewrite /root/apache2/src/modules/mod_rewrite.so

备注：命令中的rewrite参数是告诉apxs命令mod_rewrite.so文件中的模块名。在命令执行后，apxs会在LoadModule中为 rewrite加上"_module"以标名模块名称。如果在启动apache时发现总是给出“不能定位API”之类的错误，那就是说明 LoadModule后面的模块名的语法要根据apache的版本加以改变。

另外一种编译方法
apxs2 -c -i -a mod *.c

如编译proxy模块，应该进入proxy目录  apxs2 -c -i -a  *.c

Usage: apxs -g [-S =] -n
apxs -q [-S =] ...
apxs -c [-S =] [-o ] [-D [=]]
[-I ] [-L ] [-l ] [-Wc,]
[-Wl,] [-p] ...
apxs -i [-S =] [-a] [-A] [-n ] ...
apxs -e [-S =] [-a] [-A] [-n ] ...
部分参数说明：

-n modname
它明确设置了-i(install)和-g (template generation)选项的模块名称。 对-g选项，它是必须的； 对-i选项，apxs工具会按文件名判断至少是推测出这个模块名称。

-q
查询某种apxs设置的信息。 query参数可以是下列一个或多个字串：CC, CFLAGS, CFLAGS_SHLIB, INCLUDEDIR, LD_SHLIB, LDFLAGS_SHLIB, LIBEXECDIR, LIBS_SHLIB, SBINDIR, SYSCONFDIR, TARGET.这个参数用于手动查询某些设置。比如，要手动处理Apache的C头文件，可以在Makefile中使用

-g
此选项生成一个名为name的子目录(见选项-n)和其中的两个文件： 一个是名为mod_name.c的样板模块源程序， 可以用作建立你自己的模块的模板，或是学习使用apxs机制的良好开端； 另一个则是对应的Makefile，用于编译和安装此模块。

-c
此选项表示需要执行编译操作。 它首先会编译C源程序(.c)files为对应的目标代码文件(.o)， 然后，连接这些目标代码和files中其余的目标代码文件(.o and .a)， 以生成动态共享对象dsofile。如果没有指定-o选项， 则此输出文件名由files中的第一个文件名推测得到， 所以，缺省时，它一般会是mod_name.so

-i
此选项表示需要执行安装操作， 以安装一个或多个动态共享对象到服务器的modules目录中。

-a
此选项自动在httpd.conf文件中增加一个LoadModule行，以激活此模块，或者，如果此行已经存在，则启用之。

-A
与-a选项类似，但是它增加的LoadModule指令由一个井号前缀(#)， 即，此模块已经准备就绪，但尚处于禁用状态。

-e
此选项表示需要执行编辑操作，它可以与-a和-A选项配合使用， 与-i操作类似，修改Apache的httpd.conf配置文件，但是并不安装此模块。

示例如下：
# cd PATH/to/mod_rewrite.c //进入包含mod_rewrite.c文件的目录
# apxs2 -c mod_rewrite.c //apxs请指定绝对路径，在你当前正在使用apache的bin目录里
# apxs2 -i -a -n mod_rewrite mod_rewrite.la

如果没有什么错误的话，应该在你的apache的modules目录中编译出一个mod_rewrite.so文件。编辑httpd.conf文件，确认httpd.conf中已经包含mod_rewrite.so的加载语句，如下：
LoadModule rewrite_module modules/mod_rewrite.so

这时，你的apache应该已经支持rewrite了。