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

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

回顾

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

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

auto/include 脚本

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

输入参数

ngx_include: 待测试的头文件

输出参数

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

功能

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

示例

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

ngx_include="unistd.h";      . auto/include

脚本内容

echo $ngx_n "checking for $ngx_include ...$ngx_c"

cat << END >> $NGX_AUTOCONF_ERR

----------------------------------------
checking for $ngx_include

END


ngx_found=no

cat << END > $NGX_AUTOTEST.c

$NGX_INCLUDE_SYS_PARAM_H
#include <$ngx_include>

int main() {
    return 0;
}

END


ngx_test="$CC -o $NGX_AUTOTEST $NGX_AUTOTEST.c"

eval "$ngx_test >> $NGX_AUTOCONF_ERR 2>&1"

if [ -x $NGX_AUTOTEST ]; then

    ngx_found=yes

    echo " found"

    ngx_name=`echo $ngx_include \
              | tr abcdefghijklmnopqrstuvwxyz/. ABCDEFGHIJKLMNOPQRSTUVWXYZ__`


    have=NGX_HAVE_$ngx_name . auto/have_headers

    eval "NGX_INCLUDE_$ngx_name='#include <$ngx_include>'"

    #STUB
    eval "NGX_$ngx_name='#include <$ngx_include>'"

else
    echo " not found"

    echo "----------"    >> $NGX_AUTOCONF_ERR
    cat $NGX_AUTOTEST.c  >> $NGX_AUTOCONF_ERR
    echo "----------"    >> $NGX_AUTOCONF_ERR
    echo $ngx_test       >> $NGX_AUTOCONF_ERR
    echo "----------"    >> $NGX_AUTOCONF_ERR
fi

rm $NGX_AUTOTEST*

脚本分析

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

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

echo $ngx_n "checking for $ngx_include ...$ngx_c"

cat << END >> $NGX_AUTOCONF_ERR

----------------------------------------
checking for $ngx_include

END

我们之前分析的几乎所有脚本文件的第一步都是这个功能。主要是方便查找错误使用。

2). 初始化一些变量

ngx_found=no

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

3).生成自动测试文件

cat << END > $NGX_AUTOTEST.c

$NGX_INCLUDE_SYS_PARAM_H
#include <$ngx_include>

int main() {
    return 0;
}

END

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

#include <unistd.h>

int main() {
    return 0;
}

4).编译自动测试程序

ngx_test="$CC -o $NGX_AUTOTEST $NGX_AUTOTEST.c"

eval "$ngx_test >> $NGX_AUTOCONF_ERR 2>&1"

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

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

if [ -x $NGX_AUTOTEST ]; then

    ngx_found=yes

    echo " found"

    ngx_name=`echo $ngx_include \
              | tr abcdefghijklmnopqrstuvwxyz/. ABCDEFGHIJKLMNOPQRSTUVWXYZ__`


    have=NGX_HAVE_$ngx_name . auto/have_headers

    eval "NGX_INCLUDE_$ngx_name='#include <$ngx_include>'"

    #STUB
    eval "NGX_$ngx_name='#include <$ngx_include>'"

else
    echo " not found"

    echo "----------"    >> $NGX_AUTOCONF_ERR
    cat $NGX_AUTOTEST.c  >> $NGX_AUTOCONF_ERR
    echo "----------"    >> $NGX_AUTOCONF_ERR
    echo $ngx_test       >> $NGX_AUTOCONF_ERR
    echo "----------"    >> $NGX_AUTOCONF_ERR
fi

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

    echo " not found"

    echo "----------"    >> $NGX_AUTOCONF_ERR
    cat $NGX_AUTOTEST.c  >> $NGX_AUTOCONF_ERR
    echo "----------"    >> $NGX_AUTOCONF_ERR
    echo $ngx_test       >> $NGX_AUTOCONF_ERR
    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中增加一个宏定义。

#define NGX_HAVE_UNISTD_H 1;

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

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

    eval "NGX_INCLUDE_$ngx_name='#include <$ngx_include>'"

    #STUB
    eval "NGX_$ngx_name='#include <$ngx_include>'"

这两个变量分别是：

NGX_INCLUDE_UNISTD_H="#include <unistd.h>"
NGX_UNISTD_H="#include <unistd.h>"

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

6). 删除临时文件

rm $NGX_AUTOTEST*

总结

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

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

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