利用configure脚本将定制的模块加入到Nginx中

╰半夏微凉° 2022-05-24 06:09 135阅读 0赞

在1.6节提到的configure执行流程中，其中有两行脚本负责将第三方模块加入到Nginx中，如下所示。

. auto/modules

. auto/make

下面完整地解释一下configure脚本是如何与3.3.1节中提到的config文件配合起来把定制的第三方模块加入到Nginx中的。

在执行configure --add-module=PATH命令时，PATH就是第三方模块所在的路径。在configure中，通过auto/options脚本设置了NGX\_ADDONS变量：  
\--add-module=\*) NGX\_ADDONS="$NGX\_ADDONS $value" ;;

在configure命令执行到auto/modules脚本时，将在生成的ngx\_modules.c文件中加入定制的第三方模块。  
if test -n "$NGX\_ADDONS"; then

echo configuring additional modules

for ngx\_addon\_dir in $NGX\_ADDONS  
do  
echo "adding module in $ngx\_addon\_dir"

if test -f $ngx\_addon\_dir/config; then  
\#在这里执行自定义的config脚本  
. $ngx\_addon\_dir/config

echo " + $ngx\_addon\_name was configured"

else  
echo "$0: error: no $ngx\_addon\_dir/config was found"  
exit 1  
fi  
done  
fi

可以看到，$NGX\_ADDONS可以包含多个目录，对于每个目录，如果其中存在config文件就会执行，也就是说，在config中重新定义的变量都会生效。之后，auto/modules脚本开始创建ngx\_modules.c文件，这个文件的关键点就是定义了ngx\_module\_t \*ngx\_modules\[\]数组，这个数组存储了Nginx中的所有模块。Nginx在初始化、处理请求时，都会循环访问ngx\_modules数组，确定该用哪一个模块来处理。下面来看一下auto/modules是如何生成数组的，代码如下所示：  
modules="$CORE\_MODULES $EVENT\_MODULES"

if \[ $USE\_OPENSSL = YES \]; then  
modules="$modules $OPENSSL\_MODULE"  
CORE\_DEPS="$CORE\_DEPS $OPENSSL\_DEPS"  
CORE\_SRCS="$CORE\_SRCS $OPENSSL\_SRCS"  
fi

if \[ $HTTP = YES \]; then  
modules="$modules $HTTP\_MODULES $HTTP\_FILTER\_MODULES \\  
$HTTP\_HEADERS\_FILTER\_MODULE \\  
$HTTP\_AUX\_FILTER\_MODULES \\  
$HTTP\_COPY\_FILTER\_MODULE \\  
$HTTP\_RANGE\_BODY\_FILTER\_MODULE \\  
$HTTP\_NOT\_MODIFIED\_FILTER\_MODULE"

NGX\_ADDON\_DEPS="$NGX\_ADDON\_DEPS \\$(HTTP\_DEPS)"  
fi

首先，auto/modules会按顺序生成modules变量。注意，这里的$HTTP\_MODULES等已经在config文件中重定义了。这时，modules变量是包含所有模块的。然后，开始生成ngx\_modules.c文件：  
cat << END > $NGX\_MODULES\_C

\#include <ngx\_config.h>  
\#include <ngx\_core.h>

$NGX\_PRAGMA

END

for mod in $modules  
do  
echo "extern ngx\_module\_t $mod;" >> $NGX\_MODULES\_C  
done

echo >> $NGX\_MODULES\_C  
echo 'ngx\_module\_t \*ngx\_modules\[\] = \{' >> $NGX\_MODULES\_C

for mod in $modules  
do  
\#向ngx\_modules数组里添加Nginx模块  
echo " &$mod," >> $NGX\_MODULES\_C  
done

cat << END >> $NGX\_MODULES\_C  
NULL  
\};

END

这样就已经确定了Nginx在运行时会调用自定义的模块，而auto/make脚本负责把相关模块编译进Nginx。

在Makefile中生成编译第三方模块的源代码如下：  
if test -n "$NGX\_ADDON\_SRCS"; then

ngx\_cc="\\$(CC) $ngx\_compile\_opt \\$(CFLAGS) $ngx\_use\_pch \\$(ALL\_INCS)"

for ngx\_src in $NGX\_ADDON\_SRCS  
do  
ngx\_obj="addon/\`basename \\\`dirname $ngx\_src\\\`\`"

ngx\_obj=\`echo $ngx\_obj/\\\`basename $ngx\_src\\\` \\  
| sed -e "s/\\//$ngx\_regex\_dirsep/g"\`

ngx\_obj=\`echo $ngx\_obj \\  
| sed -e  
"s\#^\$.\*\\.\$cpp\\\\$\#$ngx\_objs\_dir\\1$ngx\_objext\#g" \\  
\-e  
"s\#^\$.\*\\.\$cc\\\\$\#$ngx\_objs\_dir\\1$ngx\_objext\#g" \\  
\-e  
"s\#^\$.\*\\.\$c\\\\$\#$ngx\_objs\_dir\\1$ngx\_objext\#g" \\  
\-e  
"s\#^\$.\*\\.\$S\\\\$\#$ngx\_objs\_dir\\1$ngx\_objext\#g"\`

ngx\_src=\`echo $ngx\_src | sed -e "s/\\//$ngx\_regex\_dirsep/g"\`

cat << END >> $NGX\_MAKEFILE

$ngx\_obj: \\$(ADDON\_DEPS)$ngx\_cont$ngx\_src  
$ngx\_cc$ngx\_tab$ngx\_objout$ngx\_obj$ngx\_tab$ngx\_src$NGX\_AUX

END  
done

下面这段代码用于将各个模块的目标文件设置到ngx\_obj变量中，紧接着会生成Makefile里的链接代码，并将所有的目标文件、库文件链接成二进制程序。  
for ngx\_src in $NGX\_ADDON\_SRCS  
do  
ngx\_obj="addon/\`basename \\\`dirname $ngx\_src\\\`\`"

test -d $NGX\_OBJS/$ngx\_obj || mkdir -p $NGX\_OBJS/$ngx\_obj

ngx\_obj=\`echo $ngx\_obj/\\\`basename $ngx\_src\\\` \\  
| sed -e "s/\\//$ngx\_regex\_dirsep/g"\`

ngx\_all\_srcs="$ngx\_all\_srcs $ngx\_obj"  
done

…

cat << END >> $NGX\_MAKEFILE

$NGX\_OBJS$\{ngx\_dirsep\}nginx$\{ngx\_binext\}:  
$ngx\_deps$ngx\_spacer \\$(LINK)  
$\{ngx\_long\_start\}$\{ngx\_binout\}$NGX\_OBJS$\{ngx\_dirsep\}nginx$ngx\_long\_cont$ngx\_objs$ngx\_libs$ngx\_link  
$ngx\_rcc  
$\{ngx\_long\_end\}  
END

综上可知，第三方模块就是这样嵌入到Nginx程序中的。