解剖Nginx·自动脚本篇（4）工具型脚本系列

Dear 丶 2022-05-27 04:53 188阅读 0赞

# 解剖 Nginx·自动脚本篇（4）工具型脚本系列 #

*  Author: Poechant
 *  Blog: blog.CSDN.net/Poechant
 *  Email: zhongchao.ustc\#gmail.com (\#->@)
 *  Date: March 12th, 2012
 *  Copyright © 柳大·Poechant

# 目录 #

1、auto/have 向自动配置头文件追加可用宏定义（`objs/ngx_auto_config.h`）  
2、auto/nohave 向自动配置头文件追加不可用宏定义（`objs/ngx_auto_config.h`）  
3、auto/define 向自动配置脚本追加 K-V 宏定义（`objs/ngx_auto_config.h`），表示“设置了 K，其值为 V”  
4、auto/have\_headers 向自动头头文件（`objs/ngx_auto_header.h`）  
5、auto/feature  
6、auto/types/sizeof 生成测试程序并检测指定类型的大小  
7、auto/types/typedef  
8、auto/types/value

## 1、auto/have ##

*  主要功能：向自动配置头文件中标示有指定的参数的宏定义。
 *  处理变量：`$have`
 *  作用对象：  
    
    
    >  *  作用对象：`$NGX_AUTO_CONFIG_H`变量所表示的自动生成头文件。
    >  *  默认对象：`objs/ngx_auto_config.h`
    > 
    >   
    >

cat << END >> $NGX_AUTO_CONFIG_H
      #ifndef $have
      #define $have  1
      #endif
      END

*  示例：

如果`have`值为`SOME_FLAG`，则引用该脚本而运行后，`objs/ngx_auto_config.h`中将追加如下内容：

#ifndef SOME_FLAG
    #define SOME_FLAG 1
    #endif

## 2、auto/nohave ##

与`auto/have`脚本类似。

*  主要功能：向自动配置头文件中标示没有指定的参数的宏定义。
 *  处理变量：`$have`
 *  作用对象：  
    
    
    >  *  作用对象：`$NGX_AUTO_CONFIG_H`变量所表示的自动生成头文件。
    >  *  默认对象：`objs/ngx_auto_config.h`
    > 
    >   
    >

cat << END >> $NGX_AUTO_CONFIG_H
      #ifndef $have
      #define $have  0
      #endif
      END

*  示例：

如果`have`值为`SOME_FLAG`，则引用该脚本而运行后，`objs/ngx_auto_config.h`中将追加如下内容：

#ifndef SOME_FLAG
    #define SOME_FLAG 0
    #endif

## 3、auto/define ##

*  主要功能：向自动配置头文件中标示指定参数的值
 *  处理变量：`$have`和`value`
 *  作用对象：  
    
    
    >  *  作用对象：`$NGX_AUTO_CONFIG_H`变量所表示的自动生成头文件。
    >  *  默认对象：`objs/ngx_auto_config.h`
    > 
    >   
    >

cat << END >> $NGX_AUTO_CONFIG_H
      #ifndef $have
      #define $have  1
      #endif
      END

*  示例：

如果`have`值为`SOME_FLAG`，`value`值为`1234`，则引用该脚本而运行后，`objs/ngx_auto_config.h`中将追加如下内容：

#ifndef SOME_FLAG
    #define SOME_FLAG 1234
    #endif

## 4、auto/have\_headers ##

*  主要功能：向自动头头文件中标示指定参数存在。
 *  处理变量：`$have`和`value`
 *  作用对象：  
    
    
    >  *  作用对象：`$NGX_AUTO_CONFIG_H`变量所表示的自动生成头文件。
    >  *  默认对象：`objs/ngx_auto_headers.h`
    > 
    >   
    >

cat << END >> $NGX_AUTO_CONFIG_H
      #ifndef $have
      #define $have  1
      #endif
      END

*  注意：`auto/have_headers`与`auto/have`的不同，前者是向`objs/ngx_auto_config.h`写，后者是向`objs/ngx_auto_headers.h`写。

## 5、auto/feature ##

*    
    
 *  主要功能：向自动头头文件中标示指定参数存在。
 *  处理变量：

> `$ngx_n $ngx_feature $ngx_c ngx_feature_name $ngx_feature_path $ngx_feature_inc_path $ngx_temp $ngx_feature_incs $ngx_feature_test $ngx_feature_libs $ngx_have_feature`

## feature详细解释： ##

# Copyright (C) Igor Sysoev
    # Copyright (C) Nginx, Inc.
    
    #检测平台是否支持某些特性，包括函数，编译器啥的，并将信息输出到autoconf.err里面。
    
    #在init脚本里面已经测试了echo是否支持ngx_n和ngx_c也就是\n和\c，这里只是为了打印出来的效果好点
    
    echo $ngx_n "checking for $ngx_feature ...$ngx_c"
    
    cat << END >> $NGX_AUTOCONF_ERR  #向objs/autoconf.err追加信息，注意是重定向，然后追加
    
    ----------------------------------------
    checking for $ngx_feature
    
    END
    
    #初始化输出结果为no
    ngx_found=no
    
    #将特性名称非空利用tr将小写转换成大写
    if test -n "$ngx_feature_name"; then
        #小写转大写
        ngx_have_feature=`echo $ngx_feature_name \
                       | tr abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ`
    fi
    
    
    #将所有include目录转换成编译选项，这是为了让gcc使用
    #如果ngx_feature_path为/path/to/one /path/to/two /path/to/three，
    #则ngx_feature_inc_path将被置为-I /path/to/one -I /path/to/two -I /path/to/three。
    
    if test -n "$ngx_feature_path"; then
        for ngx_temp in $ngx_feature_path; do
            ngx_feature_inc_path="$ngx_feature_inc_path -I $ngx_temp"
        done
    fi
    
    
    
    
    
    # 生成临时的小段c程序代码。
    # $ngx_feature_incs变量是程序需要include的头文件
    # $ngx_feature_test是测试代码
    
    cat << END > $NGX_AUTOTEST.c  #注意这里是重定向而不是重定向追加形式，写入objs/autotest.c。
    
    #include <sys/types.h>
    $NGX_INCLUDE_UNISTD_H
    $ngx_feature_incs
    
    int main() {
        $ngx_feature_test;
        return 0;
    }
    
    END
    
    # 编译命令
    # 编译之后的目标文件是 $NGX_AUTOTEST，后面会判断这个文件是否存在来判断是否编译成功
    # CC是在脚本auto/options中初始化的， 为CC=${CC:-gcc}。该段代码的功能是生成编译命令。
    ngx_test="$CC $CC_TEST_FLAGS $CC_AUX_FLAGS $ngx_feature_inc_path \ -o $NGX_AUTOTEST $NGX_AUTOTEST.c $NGX_TEST_LD_OPT $ngx_feature_libs"
    
    ngx_feature_inc_path=
    
    # 执行编译过程
    # 编译成功后，会生成$NGX_AUTOTEST命名的文件
    eval "/bin/sh -c \"$ngx_test\" >> $NGX_AUTOCONF_ERR 2>&1"
    
    
    # 如果文件存在，则编译成功
    if [ -x $NGX_AUTOTEST ]; then
    
        case "$ngx_feature_run" in
            # 需要运行来判断是否支持特性
            # 测试程序能否正常执行（即程序退出后的状态码是否是0），如果正常退出，则特性测试成功，设置ngx_found为yes，
            #并添加名为ngx_feature_name的宏定义，宏的值为1
            # 如果程序正常退出，退出码为0，则程序执行成功，我们可以在测试代码里面手动返回非0来表示程序出错
            yes)
                # /bin/sh is used to intercept "Killed" or "Abort trap" messages
                if /bin/sh -c $NGX_AUTOTEST >> $NGX_AUTOCONF_ERR 2>&1; then
                    echo " found"
                    ngx_found=yes
    
                     #添加宏定义，宏的值为1
                    if test -n "$ngx_feature_name"; then
                        have=$ngx_have_feature . auto/have #如果特性名字非空则向objs/ngx_auto_config.h写入宏定义
                    fi
    
                #如果NGX_AUTOTEST表示的值为空或者表示的命令执行错误
                else
                    echo " found but is not working"
                fi
            ;;
    
            #如果ngx_feature_run的值为value，则执行NGX_AUTOTEST所表示的命令
            value)
                # /bin/sh is used to intercept "Killed" or "Abort trap" messages
                if /bin/sh -c $NGX_AUTOTEST >> $NGX_AUTOCONF_ERR 2>&1; then
                    echo " found"
                    ngx_found=yes
                # 与yes不一样的是，value会将程序从标准输出里面打印出来的值，设置为ngx_feature_name宏变量的值
                # 在此种情况下，程序需要设置ngx_feature_name变量名
                    cat << END >> $NGX_AUTO_CONFIG_H
    
    #ifndef $ngx_feature_name
    #define $ngx_feature_name `$NGX_AUTOTEST`
    #endif
    
    END
                else
                    echo " found but is not working"
                fi
            ;;
        #如果ngx_feature_run是bug
            bug)
                # /bin/sh is used to intercept "Killed" or "Abort trap" messages
                if /bin/sh -c $NGX_AUTOTEST >> $NGX_AUTOCONF_ERR 2>&1; then
                    echo " not found"
    
                else
                    echo " found"
                    ngx_found=yes
    
                    if test -n "$ngx_feature_name"; then
                        have=$ngx_have_feature . auto/have
                    fi
                fi
            ;;
            #如果是其他情况
            *)
                echo " found"
                ngx_found=yes
    
                if test -n "$ngx_feature_name"; then
                    have=$ngx_have_feature . auto/have
                fi
            ;;
    
        esac
    
    #如果NGX_AUTOTEST表示的文件不存在、编译失败或不可执行
    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 -rf $NGX_AUTOTEST*

## 使用feature检测系统是否支持某种特性的例子 ##

nginx的configure会自动检测不同平台的特性，神奇之处就是auto/feature的实现，在继续向下分析之前，我们先来看看这个工具的实现原理。此工具的核心思想是，输出一小段代表性c程序，然后设置好编译选项，再进行编译连接运行，再对结果进行分析。例如，如果想检测某个库是否存在，就在小段c程序里面调用库里面的某个函数，再进行编译链接，如果出错，则表示库的环境不正常，如果编译成功，且运行正常，则库的环境检测正常。我们在写nginx第三方模块时，也常使用此工具来进行环境的检测，所以，此工具的作用贯穿整个configure过程。

# epoll, EPOLLET version
    
    ngx_feature="epoll"
    ngx_feature_name="NGX_HAVE_EPOLL"
    ngx_feature_run=yes
    ngx_feature_incs="#include <sys/epoll.h>"
    ngx_feature_path=
    ngx_feature_libs=
    
    #测试返回值即可
    ngx_feature_test="int efd = 0; struct epoll_event ee; ee.events = EPOLLIN|EPOLLOUT|EPOLLET; ee.data.ptr = NULL; efd = epoll_create(100); if (efd == -1) return 1;"
    . auto/feature #编译，运行，测试
    
    if [ $ngx_found = yes ]; then
        have=NGX_HAVE_CLEAR_EVENT . auto/have
        CORE_SRCS="$CORE_SRCS $EPOLL_SRCS"
        EVENT_MODULES="$EVENT_MODULES $EPOLL_MODULE"
        EVENT_FOUND=YES
    
    
        # EPOLLRDHUP appeared in Linux 2.6.17, glibc 2.8
    
        ngx_feature="EPOLLRDHUP"
        ngx_feature_name="NGX_HAVE_EPOLLRDHUP"
        ngx_feature_run=no
        ngx_feature_incs="#include <sys/epoll.h>"
        ngx_feature_path=
        ngx_feature_libs=
        ngx_feature_test="int efd = 0, fd = 0; struct epoll_event ee; ee.events = EPOLLIN|EPOLLRDHUP|EPOLLET; ee.data.ptr = NULL; epoll_ctl(efd, EPOLL_CTL_ADD, fd, &ee)"
        . auto/feature
    fi

段代码在auto/Linux里面实现，用来检测当前操作系统是否支持poll函数调用。在调用auto/feature之前，需要先设置几个输入参数变量的值，然后结果会存在$ngx\_found变量里面, 并输出宏定义以表示支持此特性。

$ngx_feature      特性名称
    $ngx_feature_name 特性的宏定义名称，如果特性测试成功，则会定义该宏定义
    $ngx_feature_path 编译时要查找头文件目录
    $ngx_feature_test 要执行的测试代码
    $ngx_feature_incs 在代码中要include的头文件
    $ngx_feature_libs 编译时需要link的库文件选项
    $ngx_feature_run  编译成功后，对二进制文件需要做的动作，可以是yes value bug 其它
    
    #ngx_found 如果找到，并测试成功，其值为yes，否则其值为no