Nginx源码分析之--auto/include脚本

微信公众号：Nginx源码分析
关注可了解更多的Nginx知识。任何问题或建议，请公众号留言;
关注公众号，有趣有内涵的文章第一时间送达！

回顾

上一篇文章咱们详细的分析了auto/feature脚本的做用，该脚本的主要做用是测试宿主系统是否支持某个特性。

辅助脚本

下面咱们分析上图中最后一个脚本文件 auto/include。

auto/include 脚本

测试当前的宿主操做系统中是否存在某个头文件。

输入参数

ngx_include: 待测试的头文件

输出参数

ngx_found: 表示是否存在该头文件，若是为yes表示存在该头文件。
若为no，表示不存在。

功能

测试当前的宿主操做系统中是否存在某个头文件。

示例

下面是一个示例。
这个例子用于测试当前的操做系统中是否包含 unistd.h头文件。

1ngx_include="unistd.h";      . auto/include
复制代码

脚本内容

 1echo $ngx_n "checking for $ngx_include ...$ngx_c"
 2
 3cat << END >> $NGX_AUTOCONF_ERR
 4
 5----------------------------------------
 6checking for $ngx_include
 7
 8END
 9
10
11ngx_found=no
12
13cat << END > $NGX_AUTOTEST.c
14
15$NGX_INCLUDE_SYS_PARAM_H
16#include <$ngx_include>
17
18int main() {
19    return 0;
20}
21
22END
23
24
25ngx_test="$CC -o $NGX_AUTOTEST $NGX_AUTOTEST.c"
26
27eval "$ngx_test >> $NGX_AUTOCONF_ERR 2>&1"
28
29if [ -x $NGX_AUTOTEST ]; then
30
31    ngx_found=yes
32
33    echo " found"
34
35    ngx_name=`echo $ngx_include \
36              | tr abcdefghijklmnopqrstuvwxyz/. ABCDEFGHIJKLMNOPQRSTUVWXYZ__`
37
38
39    have=NGX_HAVE_$ngx_name . auto/have_headers
40
41    eval "NGX_INCLUDE_$ngx_name='#include <$ngx_include>'"
42
43    #STUB
44    eval "NGX_$ngx_name='#include <$ngx_include>'"
45
46else
47    echo " not found"
48
49    echo "----------"    >> $NGX_AUTOCONF_ERR
50    cat $NGX_AUTOTEST.c  >> $NGX_AUTOCONF_ERR
51    echo "----------"    >> $NGX_AUTOCONF_ERR
52    echo $ngx_test       >> $NGX_AUTOCONF_ERR
53    echo "----------"    >> $NGX_AUTOCONF_ERR
54fi
55
56rm $NGX_AUTOTEST*
复制代码

脚本分析

咱们以示例中测试unistd.h的代码分析这个脚本。

1).向终端和NGX_AUTOCONF_ERR中输出测试信息

1echo $ngx_n "checking for $ngx_include ...$ngx_c"
2
3cat << END >> $NGX_AUTOCONF_ERR
4
5----------------------------------------
6checking for $ngx_include
7
8END
复制代码

咱们以前分析的几乎全部脚本文件的第一步都是这个功能。主要是方便查找错误使用。

2). 初始化一些变量

1ngx_found=no
复制代码

上面初始化一个ngx_found，这个变量表示的是当前测试的头文件是否存在。默认设置为no.

3).生成自动测试文件

 1cat << END > $NGX_AUTOTEST.c
 2
 3$NGX_INCLUDE_SYS_PARAM_H
 4#include <$ngx_include>
 5
 6int main() {
 7    return 0;
 8}
 9
10END
复制代码

根据传进来的入参ngx_include参数生成自动测试程序。
本例中生成的测试程序以下：

1#include <unistd.h>
2
3int main() {
4    return 0;
5}
复制代码

4).编译自动测试程序

1ngx_test="$CC -o $NGX_AUTOTEST $NGX_AUTOTEST.c"
2
3eval "$ngx_test >> $NGX_AUTOCONF_ERR 2>&1"
复制代码

上面的脚本把第3)步生成的自动测试程序进行编译。编译后的可执行文件为objs/autotest.

5). 执行自动测试程序并处理相应的逻辑

 1if [ -x $NGX_AUTOTEST ]; then
 2
 3    ngx_found=yes
 4
 5    echo " found"
 6
 7    ngx_name=`echo $ngx_include \
 8              | tr abcdefghijklmnopqrstuvwxyz/. ABCDEFGHIJKLMNOPQRSTUVWXYZ__`
 9
10
11    have=NGX_HAVE_$ngx_name . auto/have_headers
12
13    eval "NGX_INCLUDE_$ngx_name='#include <$ngx_include>'"
14
15    #STUB
16    eval "NGX_$ngx_name='#include <$ngx_include>'"
17
18else
19    echo " not found"
20
21    echo "----------"    >> $NGX_AUTOCONF_ERR
22    cat $NGX_AUTOTEST.c  >> $NGX_AUTOCONF_ERR
23    echo "----------"    >> $NGX_AUTOCONF_ERR
24    echo $ngx_test       >> $NGX_AUTOCONF_ERR
25    echo "----------"    >> $NGX_AUTOCONF_ERR
26fi
复制代码

咱们分析一下上面的脚本。
①. 若是自动测试程序不能执行，那么会执行下面的else逻辑。

1    echo " not found"
2
3    echo "----------"    >> $NGX_AUTOCONF_ERR
4    cat $NGX_AUTOTEST.c  >> $NGX_AUTOCONF_ERR
5    echo "----------"    >> $NGX_AUTOCONF_ERR
6    echo $ngx_test       >> $NGX_AUTOCONF_ERR
7    echo "----------"    >> $NGX_AUTOCONF_ERR
复制代码

这部分脚本和咱们以前分析的错误处理基本上都同样。都是保存错误现场，便于查找错误。

②.若是自动测试程序可执行
首先把ngx_found设置为yes,表示当前操做系统包含unistd.h头文件。
设置ngx_name变量。这个变量的生成规则也比较简单，管道符后面的tr命令是把ngx_include中的小写字母替换成对应的大写字母，把小数点.替换为下划线_。因此这里的ngx_name变量的值就会被设置为UNISTD_H.

③. 向NGX_AUTO_HEADERS_H添加宏定义
在上面的第②.步中，生成了一个ngx_name变量。紧接该脚本调用auto/have_headers（咱们以前分析过该脚本，不懂得朋友能够看看以前的文章）向NGX_AUTO_HEADERS_H中增长一个宏定义。

1#define NGX_HAVE_UNISTD_H 1;
复制代码

经过这个宏定义，说明了当前操做系统包含此头文件。

④. 紧接着的两个eval语句生成了另外两个输出变量。

1    eval "NGX_INCLUDE_$ngx_name='#include <$ngx_include>'"
2
3    #STUB
4    eval "NGX_$ngx_name='#include <$ngx_include>'"
复制代码

这两个变量分别是：

1NGX_INCLUDE_UNISTD_H="#include <unistd.h>"
2NGX_UNISTD_H="#include <unistd.h>"
复制代码

咱们在前面分析过的一些脚本中，在生成自动测试程序的时候就会使用到这两个变量。如今咱们知道这两个变量是怎么来的吧？

6). 删除临时文件

1rm $NGX_AUTOTEST*
复制代码

总结

咱们经过unistd.h的例子详细的分析了auto/include脚本的功能。这个脚本的做用就是测试在当前的宿主系统上面是否含有某个头文件。在测试成功以后，会输出若干变量，这样就能够在其余脚本中使用到这些变量。

到如今为止，咱们已经把开篇图中的全部脚本已经所有分析过了。后面的文章咱们会接着分析nginx的源码，敬请期待。顺便关注个人个公众号（Nginx源码分析），第一时间接收最新文章。

后面的文章咱们会接着分析nginx的源码，敬请期待。顺便关注个人个公众号（Nginx源码分析）。

---

喜欢本文的朋友们，欢迎长按下图关注订阅号Nginx源码分析，更多精彩内容第一时间送达

Nginx源码分析