Bash Basics - スクリプトのサンプル

#!/usr/bin/bash

# Trace Log
XTRACEFILE=~/logs/`basename $0`.log
exec {fd}> $XTRACEFILE
if [ $? == 0 ]; then
    BASH_XTRACEFD=$fd               # set -xのトレース情報をファイルに出力
    echo "Opened $fd"
    set -ex                         # set -eはエラー発生時にexit
else
    set -e                          # set -eはエラー発生時にexit
fi

set -o errtrace                     # ERRトラップを継承
trap catch ERR                      # ERRトラップの関数
trap finally EXIT                   # EXITトラップの関数

# Sub Function A
function func_A () {
    # func_A:21 is called from main:76
    echo ${FUNCNAME[0]}:${LINENO} is called from ${FUNCNAME[1]}:${BASH_LINENO[0]}
    func_B B1 B2
    return 0
}

# Sub Function B
function func_B () {
    # func_B:29 is called from func_A:22
    echo ${FUNCNAME[0]}:${LINENO} is called from ${FUNCNAME[1]}:${BASH_LINENO[0]}
    func_C C1 C2 C3 C4
    return 0
}

# Sub Function C
function func_C () {
    # func_C:37 is called from func_B:30
    echo ${FUNCNAME[0]}:${LINENO} is called from ${FUNCNAME[1]}:${BASH_LINENO[0]}

    # エラーを発生させる（実行するコマンドが存在しない）
    cmdcmd
    return 0
}

# トレースの表示
function catch () {
    echo "##### Call Trace #####" 1>&2
    for ((i=0, k=0; i<${#BASH_LINENO[*]}; i++))
    do
        if [ $i == 0 ]; then
            echo $((${#BASH_LINENO[*]}-$i)): ${BASH_SOURCE[$i]}: \
                 ${FUNCNAME[$i]}: "Current" 1>&2
        else
            echo $((${#BASH_LINENO[*]}-$i)): ${BASH_SOURCE[$i]}: \
                 ${FUNCNAME[$i]}: ${BASH_LINENO[$(($i-1))]} 1>&2
        fi
        # 引き数の表示
        for ((l=0, j=${BASH_ARGC[$i]}-1; j>=0; l++, j--))
        do
            echo "ARGV["$l"]: " ${BASH_ARGV[$((k+j))]}
        done
        x=$((k+=${BASH_ARGC[$i]-0}))
    done
    return 0
}

# 終了処理を記述
function finally () {
    echo "Exiting at ${FUNCNAME[1]}"        # exitする関数名を出力
    echo "Closing $fd"
    exec {fd}>&-                            # トレースファイルのクローズ
}

# メインの処理
shopt -s extdebug

func_A A1 A2 A3
echo "#### `basename $0` end ####"

• スクリプトの最初にトレース情報を出力するファイル名をXTRACEFILEに設定しています。
• execコマンドによるリダイレクションでトレース情報を出力するファイルをオープンしています。
• set -xでスクリプトの実行をトレースするように設定しています。
• set -eでスクリプトの実行でエラーが発生した場合にexitするように設定しています。
• set -o errtraceでERRを継承できるように設定しています。
• trapコマンドでERR、およびEXITをトラップする関数を設定しています。
• func_A、func_B、func_C関数をネストして呼び出ししています。
• func_C関数内で存在しないコマンド"cmdcmd"を実行しようとしてエラーを発生させています。
• ERRが発生することで、catch関数を呼び出し、関数の呼び出し履歴と引き数を出力しています。
• エラーによりスクリプトの実行を強制終了させています。
• EXITシグナルが発生することで、finally関数を呼び出し、終了処理としてトレースファイルをクローズしています。

$ ./funcname.sh
Opened 10
func_A:21 is called from main:76
func_B:29 is called from func_A:22
func_C:37 is called from func_B:30
./funcname.sh: 行 40: cmdcmd: コマンドが見つかりません
##### Call Trace #####
5: ./funcname.sh: catch: Current
4: ./funcname.sh: func_C: 40
ARGV[0]:  C1
ARGV[1]:  C2
ARGV[2]:  C3
ARGV[3]:  C4
3: ./funcname.sh: func_B: 30
ARGV[0]:  B1
ARGV[1]:  B2
2: ./funcname.sh: func_A: 22
ARGV[0]:  A1
ARGV[1]:  A2
ARGV[2]:  A3
1: ./funcname.sh: main: 67
Exiting at func_C
Closing 10
$ cat ~/logs/funcname.sh.log
+ set -o errtrace
+ trap catch ERR
+ trap finally EXIT
+ shopt -s extdebug
+ func_A A1 A2 A3
+ echo func_A:21 is called from main:76
+ func_B B1 B2
+ echo func_B:29 is called from func_A:22
+ func_C C1 C2 C3 C4
+ echo func_C:37 is called from func_B:30
+ cmdcmd
++ catch
++ echo '##### Call Trace #####'
++ (( i=0, k=0 ))
++ (( i<5 ))
++ '[' 0 == 0 ']'
++ echo 5: ./funcname.sh: catch: Current
++ (( l=0, j=0-1 ))
++ (( j>=0 ))
++ x=0
++ (( i++ ))
++ (( i<5 ))
++ '[' 1 == 0 ']'
++ echo 4: ./funcname.sh: func_C: 40
++ (( l=0, j=4-1 ))
++ (( j>=0 ))
++ echo 'ARGV[0]: ' C1
++ (( l++, j-- ))
++ (( j>=0 ))
++ echo 'ARGV[1]: ' C2
++ (( l++, j-- ))
++ (( j>=0 ))
++ echo 'ARGV[2]: ' C3
++ (( l++, j-- ))
++ (( j>=0 ))
++ echo 'ARGV[3]: ' C4
++ (( l++, j-- ))
++ (( j>=0 ))
++ x=4
++ (( i++ ))
++ (( i<5 ))
++ '[' 2 == 0 ']'
++ echo 3: ./funcname.sh: func_B: 30
++ (( l=0, j=2-1 ))
++ (( j>=0 ))
++ echo 'ARGV[0]: ' B1
++ (( l++, j-- ))
++ (( j>=0 ))
++ echo 'ARGV[1]: ' B2
++ (( l++, j-- ))
++ (( j>=0 ))
++ x=6
++ (( i++ ))
++ (( i<5 ))
++ '[' 3 == 0 ']'
++ echo 2: ./funcname.sh: func_A: 22
++ (( l=0, j=3-1 ))
++ (( j>=0 ))
++ echo 'ARGV[0]: ' A1
++ (( l++, j-- ))
++ (( j>=0 ))
++ echo 'ARGV[1]: ' A2
++ (( l++, j-- ))
++ (( j>=0 ))
++ echo 'ARGV[2]: ' A3
++ (( l++, j-- ))
++ (( j>=0 ))
++ x=9
++ (( i++ ))
++ (( i<5 ))
++ '[' 4 == 0 ']'
++ echo 1: ./funcname.sh: main: 76
++ (( l=0, j=-1 ))
++ (( j>=0 ))
++ x=9
++ (( i++ ))
++ (( i<5 ))
++ return 0
+ finally
+ echo 'Exiting at func_C'
+ echo 'Closing 10'
+ exec

• func_A、func_B、func_Cを呼び出した時に、呼び出し元の関数名と行数が出力されています。
• func_C内でエラーが発生したことで関数の呼び出し履歴と引き数が出力されています。
• 終了処理が呼び出されてトレースファイルがクローズされています。
• トレースファイルにはスクリプトが実行したコマンドとその引き数が記録されています。
• set -eでスクリプトの実行でエラーが発生した場合にexitするように設定されているため、最後のechoコマンドは実行されていないことにご注意ください。

#!/usr/bin/bash

set -o functrace                    # DEBUGトラップを継承
trap 'debug ${LINENO}' DEBUG        # DEBUGトラップの関数

# Sub Function A
function func_A () {
    # func_A:21 is called from main:67
    echo ${FUNCNAME[0]}:${LINENO} is called from ${FUNCNAME[1]}:${BASH_LINENO[0]}
    func_B
    return 0
}

# Sub Function B
function func_B () {
    # func_B:29 is called from func_A:22
    echo ${FUNCNAME[0]}:${LINENO} is called from ${FUNCNAME[1]}:${BASH_LINENO[0]}
    func_C
    return 0
}

# Sub Function C
function func_C () {
    # func_C:37 is called from func_B:30
    echo ${FUNCNAME[0]}:${LINENO} is called from ${FUNCNAME[1]}:${BASH_LINENO[0]}

    # エラーを発生させる（実行するコマンドが存在しない）
    cmdcmd
    return 0
}

function debug () {
    echo line $1: ${BASH_COMMAND}
}

# メインの処理
func_A
echo "#### `basename $0` end ####"

• set -o functraceでDEBUGを継承できるように設定しています。
• trapコマンドでDEBUGをコマンドを実行する前にトラップする関数を設定しています。
• func_A、func_B、func_C関数をネストして呼び出ししています。
• func_C関数内で存在しないコマンド"cmdcmd"を実行しようとしてエラーを発生させています。
• 単純なコマンド、forコマンド、caseコマンド、selectコマンド、算術forコマンドの前、および関数内の最初のコマンドの実行前にdebug関数を呼び出し、実行しようとしている行番号とコマンド文字列を標準出力に出力します。

$ ./debug.sh 
line 37: func_A
line 7: func_A
line 9: echo ${FUNCNAME[0]}:${LINENO} is called from ${FUNCNAME[1]}:${BASH_LINENO[0]}
func_A:9 is called from main:37
line 10: func_B
line 15: func_B
line 17: echo ${FUNCNAME[0]}:${LINENO} is called from ${FUNCNAME[1]}:${BASH_LINENO[0]}
func_B:17 is called from func_A:10
line 18: func_C
line 23: func_C
line 25: echo ${FUNCNAME[0]}:${LINENO} is called from ${FUNCNAME[1]}:${BASH_LINENO[0]}
func_C:25 is called from func_B:18
line 28: cmdcmd
./debug.sh: 行 28: cmdcmd: コマンドが見つかりません
line 29: return 0
line 19: return 0
line 11: return 0
line 38: echo "#### `basename $0` end ####"
#### line 38: basename $0
debug.sh end ####

• メインの処理からfunc_A、func_B、func_C関数をネストして呼び出ししています。
• 関数の呼び出し時（関数内の最初のコマンドの実行前）、コマンドの実行前にdebug関数が呼び出されて実行しようとしている行番号とコマンド文字列を標準出力に出力しています。

#!/usr/bin/bash

while getopts ":ab:c:h" OPT
do
    case "$OPT" in
    "a" ) OPT_A="TRUE";;
    "b" ) OPT_B="TRUE"; VAL_B="$OPTARG";;
    "c" ) OPT_C="TRUE"; VAL_C="$OPTARG";;
    "?" ) echo "無効なオプション $OPTARG が指定されました";
          echo "Usage: `basename $0` [-a] [-b VAL] [-c VAL] [-h]" 1>&2;
          exit 1;;
    "h" ) echo "Usage: `basename $0` [-a] [-b VAL] [-c VAL] [-h]" 1>&2;
          exit 1;;
esac
done

if [ "$OPT_A" = "TRUE" ]; then
    echo '"-a"オプションが指定されました。'
fi
if [ "$OPT_B" = "TRUE" ]; then
    echo '"-b"オプションが指定されました。'
    echo "値は $VAL_B です。"
fi
if [ "$OPT_C" = "TRUE" ]; then
    echo '"-c"オプションが指定されました。'
    echo "値は $VAL_C です。"
fi

# getoptsで処理したオプションと引き数の数だけ位置パラメータをシフト
shift  $(($OPTIND - 1))

• オプションabchがあり、そのうちbcには引き数があることを指定して1つずつ変数OPTに設定します。
  先頭に:を記述しているため、無効な引き数の処理はスクリプト内で記述します。
• それぞれのオプションの処理を実施します。
  オプションaは、変数OPT_Aの値を"TRUE"に設定します。
  オプションbは、変数OPT_Bの値を"TRUE"に設定し、変数VAL_Bにその引き数を設定します。
  オプションcは、変数OPT_Cの値を"TRUE"に設定し、変数VAL_Cにその引き数を設定します。
  オプション?は、無効なオプションの指定を意味し、シェル変数OPTARGに指定されたオプションが設定されます。エラーメッセージとUsageを出力します。
  オプションhは、Usageを出力します。
• 指定されたオプションとその引き数があれば出力します。
• getoptsで処理したオプションと引き数の数だけ位置パラメータをシフトします。

$ ./opt.sh -abこんにちは
"-a"オプションが指定されました。
"-b"オプションが指定されました。
値は こんにちは です。
$ ./opt.sh -a -b こんにちは -c おはようございます
"-a"オプションが指定されました。
"-b"オプションが指定されました。
値は こんにちは です。
"-c"オプションが指定されました。
値は おはようございます です。
$ ./opt.sh -a -h
Usage: opt.sh [-a] [-b VAL] [-c VAL] [-h]
$ ./opt.sh -a -x
Usage: opt.sh [-a] [-b VAL] [-c VAL] [-h]

• getoptsは複数のオプションを空白文字で区切って指定することも続けて指定することもできます。
• この例のスクリプトではオプションhまたは、未知のオプションが指定された場合、Usageを出力するようにしています。

#!/usr/bin/bash

lockfile=~/`basename $0`.lock

echo "Locking $lockfile"
exec {fd}> $lockfile            # ロック制御ファイルをオープン
flock -x ${fd}                  # 排他的ロック
echo "Locked $lockfile"
sleep 15
flock -u ${fd}                  # ロック解除
echo "Unlocked $lockfile"
exec {fd}>&-                    # ロック制御ファイルをクローズ

• execコマンドによるリダイレクションでロック制御ファイルをオープンしています。
• 外部コマンドのflockコマンドでロック制御ファイルを排他的にロックしています。
  これにより他のプロセスが同じファイルを排他ロックしようとするとロックが解除されるまで待たされます。
• 外部コマンドのsleepコマンドで15秒間スリープしています。
• flockコマンドでロック制御ファイルのロックを解除しています。
• execコマンドによるリダイレクションでロック制御ファイルをクローズしています。

$ ./lock.sh
Locking /home/user1/lock.sh.lock
Locked /home/user1/lock.sh.lock
Unlocked /home/user1/lock.sh.lock

• 複数の端末を開いてこのスクリプトを実行してみてください。
  あとから実行したスクリプトがflockコマンドの排他的ロックで待たされることを確認できます。

#!/usr/bin/bash

echo "### start ###"
while read line
do
    if [ "$line" == "end" ]; then
        exit
    else
        eval $line
fi
done

• 実行開始のメッセージ"### start ###"を標準出力に書き込みます。
• 標準入力から文字列を1行読み込みます。
• 読み込んだ文字列が"end"の場合、実行を終了します。
  それ以外の文字列の場合、読み込んだ文字列をevalコマンドによって評価（実行）します。
• 上記2から3を繰り返します。

$ coproc ./sub.sh
[1] 21059
$ read -u ${COPROC[0]} msg; echo $msg
### start ###
$ echo "date" >&${COPROC[1]}
$ read -u ${COPROC[0]} msg; echo $msg
2022年 2月 11日 金曜日 18:26:10 JST
$ echo "pwd" >&${COPROC[1]}
$ read -u ${COPROC[0]} msg; echo $msg
/home/user1
$ echo "end" >&${COPROC[1]}
[1]+  終了                  coproc COPROC ./sub.sh

• sub.shをコプロセスとして実行します。
  例ではコプロセスはプロセスID=21059として起動されました。
• コプロセスの標準出力に接続されたファイルディスクリプタから文字列を 読み込み、変数msgに設定し、標準出力に出力します。
  コプロセスが標準出力に書き込んだ"### start ###"が変数msgに読み込まれ、それが標準出力に表示されています。
• "date"という文字列をコプロセスの標準入力に接続されたファイルディスクリプタに書き込みます。
  コプロセスで"date"がコマンドとして評価され、実行されます。
• コプロセスの標準出力に接続されたファイルディスクリプタから文字列を読み込み、変数msgに設定し、標準出力に出力します。
  コプロセスが標準出力に書き込んだ"date"コマンドの実行結果が変数msgに読み込まれ、それが標準出力に表示されています。
• "pwd"という文字列をコプロセスの標準入力に接続されたファイルディスクリプタに書き込みます。
  コプロセスで"pwd"がコマンドとして評価され、実行されます。
• コプロセスの標準出力に接続されたファイルディスクリプタから文字列を読み込み、変数msgに設定し、標準出力に出力します。
  コプロセスが標準出力に書き込んだ"pwd"コマンドの実行結果が変数msgに読み込まれ、それが標準出力に表示されています。
• "end"という文字列をコプロセスの標準入力に接続されたファイルディスクリプタに書き込みます。
  コプロセスで"end"を読み込んだため、コプロセスは実行を終了します。

#!/usr/bin/bash

for ((i=0; i<11; i++)) {
    for ((j=0; j<10; j++)) {
        v=$(($i * 10 + $j));
        printf "\e[%dm%03d\e[0m " $v $v;
    }
    printf "\n";
}