精讀 Nginx·自動指令碼篇（4）工具型指令碼系列

• Author: Poechant
• Blog: blog.CSDN.net/Poechant
• Email: zhongchao.ustc#gmail.com (#->@)
• Date: March 12^th, 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  $value
    #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_HEADERS_H變數所表示的自動生成標頭檔案。
  • 預設物件：objs/ngx_auto_headers.h

    cat << END >> $NGX_AUTO_HEADERS_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

• 作用物件：

  • 作用物件：
  • 預設物件：

5.1 輸出檢查提示

還記得在《精讀Nginx原始碼·自動指令碼篇（2）設定初始變數指令碼 auto/init》一文中關於ngx_n和ngx_c兩個變數嗎？在auto/feature中的第一句是：

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

就是echo一句checking for $ngx_feature，然後換行。當然存在ngx_n和ngx_c都為空的情況，這時真就沒有主動換行了。

然後向NGX_AUTOCONF_ERR表示的檔案新增自動配置錯誤資訊。該檔案是在auto/init檔案中初始化的（參見《精讀Nginx原始碼·自動指令碼篇（2）設定初始變數指令碼 auto/init》），其值為NGX_AUTOCONF_ERR=$NGX_OBJS/autoconf.err，預設情況下為objs/autoconf.err。

5.2 初始化ngx_found

ngx_found=no

5.3 初始化ngx_have_feature

if test -n "$ngx_feature_name"; then
    ngx_have_feature=`echo $ngx_feature_name \
                   | tr abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ`
fi

test -n是測試引數的長度是否為 0。那麼如果ngx_feature_name為空，則不會執行if內的語句，否則將把ngx_have_feature命名為ngx_feature_name的大寫版（tr命令將小寫全部改為大寫）。

5.4 初始化ngx_feature_inc_path

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

test -n是測試引數的長度是否為 0。如果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。

5.5 生成自動測試程式

自動測試原始碼檔案是在auto/init指令碼中初始化為$NGX_OBJS/autotest的，預設為objs/autotest。加上字尾名則為objs/autotest.c

cat << END > $NGX_AUTOTEST.c
#include <sys/types.h>
$NGX_INCLUDE_UNISTD_H
$ngx_feature_incs
int main() {
    $ngx_feature_test;
    return 0;
}
END

其中ngx_feature_incs和ngx_feature_test算是auto/feature指令碼的引數。

5.6 編譯自動測試程式

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=

執行測試程式。

eval "/bin/sh -c \"$ngx_test\" >> $NGX_AUTOCONF_ERR 2>&1"

5.7 根據ngx_feature_run處理

這一段稍長，下面逐步解釋：

Bash 程式設計中所有布林表示式都是用中括號括起來的。-x參數列示Test if file exists and is executable。所以如果NGX_AUTOTEST表示的檔案存在則執行then。

if [ -x $NGX_AUTOTEST ]; then
    case "$ngx_feature_run" in

如果ngx_feature_run的值為yes，由於-c，則將NGX_AUTOTEST檔案的內容當做命令執行，其輸出到標準輸出及錯誤輸出的結果都被重定向到NGX_AUTOCONF_ERR中。

        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

如果ngx_feature_name長度不為零，則have設定為$ngx_have_feature的值，並引用auto/have指令碼向objs/ngx_auto_config.h寫入巨集定義。

                if test -n "$ngx_feature_name"; then
                    have=$ngx_have_feature . auto/have
                fi

如果NGX_AUTOTEST表示的值為空或者表示的命令執行錯誤，則執行else：

            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

想objs/ngx_auto_config.h檔案寫入：

                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
        ;;

如果是其他情況，則若ngx_feature_name不為空則將ngx_have_feature相關的巨集寫入objs/ngx_auto_config.h職工。

        *)
            echo " found"
            ngx_found=yes

            if test -n "$ngx_feature_name"; then
                have=$ngx_have_feature . auto/have
            fi
        ;;

    esac

如果NGX_AUTOTEST表示的檔案不存在或不可執行，則執行下面的else中的幾句echo。

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

5.8 刪除NGX_AUTOSET測試程式可執行檔案

rm $NGX_AUTOTEST*

-

轉載請註明來自“鍾超的CSDN部落格”：Blog.CSDN.net/Poechant

-