Bash | デバッグライフ

この記事は【2016年6月26日】と作成から2年以上経っているため、記事の内容が古い可能性があります。最新の情報を合わせてご確認されることを推奨いたします。

変数展開

記述

説明

例

${parameter}

parameter値に置換される。

ex1) a=10; echo $a     # => 10

1	ex1) a=10; echo $a # => 10

${parameter:-word}

parameterがunsetまたはnullの時、wordに置換される。

ex1) echo ${a:-"def"}  # => def

1	ex1) echo ${a:-"def"} # => def

${parameter:+word}

parameterがunsetまたはnullの時、置換されず、そうでなければparameterの値に置換される。

ex1) a=10; echo ${a:+20}  # => 20
ex2) echo ${a:+20}        # =>

1 2	ex1) a=10; echo ${a:+20} # => 20 ex2) echo ${a:+20} # =>

${parameter:=word}

parameterがunsetまたはnullの時、wordの値がparameterに代入される。

ex1) b=${a:="c"}; test "$a" = "$b" && \
echo "a = b" # => a = b

1 2	ex1) b=${a:="c"}; test "$a" = "$b" && \ echo "a = b" # => a = b

${parameter:?word}

parameterがnullまたはunsetの時、wordの値が標準エラー出力とshellに出力される。インタラクティブでないshellは終了する。そうでければ、parameterの値に置換される。

ex1) echo ${a:?"error"} ; echo "not exec" # => -bash: a: error 
ex2) a=10; echo ${a:?"error"}; echo "ok"
# => 10 ok

ex1) echo ${a:?"error"} ; echo "not exec" # => -bash: a: error

ex2) a=10; echo ${a:?"error"}; echo "ok"

# => 10 ok

${parameter:offset}
${parameter:offset:length}

parameter文字列をoffsetからlength数までの部分文字列を返す。

ex1) a="abcde"; echo ${a:0:2}    # => ab
ex2) a="abcde"; echo ${a: -1:1}  # => e

1 2	ex1) a="abcde"; echo ${a:0:2} # => ab ex2) a="abcde"; echo ${a: -1:1} # => e

${!prefix*}
${!prefix@}

名前がprefixで始まる変数名を展開する。区切り文字はIFSの値が使われる。

ex1) a1="a1";a2="a2"; echo ${!a@}
# => a1 a2

1 2	ex1) a1="a1";a2="a2"; echo ${!a@} # => a1 a2

${!name[@]}
${!name[*]}

nameが配列の場合、keyのリストに展開される。 nameが配列でない場合、nameがsetされていれば 0、でなければnullに展開される。

ex1) a=(9 10); echo ${!a[@]}  # => 0 1
ex2) a=1; echo ${!a[@]}       # => 0
ex3) echo ${!a[@]}            # =>

ex1) a=(9 10); echo ${!a[@]} # => 0 1

ex2) a=1; echo ${!a[@]} # => 0

ex3) echo ${!a[@]} # =>

${#parameter}

parameterの文字列長。

ex1) a="hoge"; echo ${#a}    # => 4

1	ex1) a="hoge"; echo ${#a} # => 4

${parameter#word}
${parameter##word}

パス名の前方一致によるパターン展開。#は、 shortest maching、##は、longest maching。

ex1) a="/c/b.txt.swp"; echo ${a#*.}
# => txt.swp
ex2) a="/c/b.txt.swp"; echo ${a##*.}
# => .swp

ex1) a="/c/b.txt.swp"; echo ${a#*.}

# => txt.swp

ex2) a="/c/b.txt.swp"; echo ${a##*.}

# => .swp

${parameter%word}
${parameter%%word}

パス名の後方一致によるパターン展開。%は、 shortest maching、%%は、longest maching。

ex1) a="/c/b.txt.swp"; echo ${a%.*}
# => /c/b.txt
ex1) a="/c/b.txt.swp"; echo ${a%%.*}
# => /c/b

ex1) a="/c/b.txt.swp"; echo ${a%.*}

# => /c/b.txt

ex1) a="/c/b.txt.swp"; echo ${a%%.*}

# => /c/b

${parameter/pattern/string}

パラメータ置換。

ex1) a="abbb"; echo ${a/b*/d}    # => ad
ex2) a=b.txt; echo ${a/#*./a.}   # => a.txt
ex3) a=b.txt; echo ${a/%.*/.log} # => b.log

ex1) a="abbb"; echo ${a/b*/d} # => ad

ex2) a=b.txt; echo ${a/#*./a.} # => a.txt

ex3) a=b.txt; echo ${a/%.*/.log} # => b.log

フロー制御

ループ構造

until

条件が真になるまで繰り返し実行される。

n=5
t=1
until [ $n -eq 0 ]; do
let t=$n*$t
let n=$n-1
done
echo "5! = $t"
### output ###
5! = 120

n=5

t=1

until [ $n -eq 0 ]; do

let t=$n*$t

let n=$n-1

done

echo "5! = $t"

### output ###

5! = 120

while

条件が真の間繰り返し実行される。

$ cat server.txt
web1
web2
web3
db1

$ cat server.txt

web1

web2

web3

db1

以下では、server.txtから1行ずつ読み込み、文字列に”web”が含まれている場合に出力する。

while read line && [[ "$line" =~ "web" ]]; do
echo $line
done < sample.txt
### output ###
web1
web2
web3

while read line && [[ "$line" =~ "web" ]]; do

echo $line

done < sample.txt

### output ###

web1

web2

web3

for

馴染みのあるfor文。他の高級言語の構文と同様に書ける。

# for ((expr1; expr2; expr3)); do commands; done
for ((i=0; i < 10; i++)); do
echo $i
done
((i++)) # increment
echo $i
### output ###
0
1
2
3
4
5
6
7
8
9
11

# for ((expr1; expr2; expr3)); do commands; done

for ((i=0; i < 10; i++)); do

echo $i

done

((i++)) # increment

echo $i

### output ###

拡張for文、foreach文のようにも書ける。

for word in $(cat server.txt); do
echo $word
done
### output ###
web1
web2
web3
db1

for word in $(cat server.txt); do

echo $word

done

### output ###

web1

web2

web3

db1

条件構造

if

基本的な条件分岐。elsifでもなく、else ifでもなく、elifに注意。

if [ $# -eq 0 ]; then
echo "Usage: if.sh <arg>"
exit
elif [ $# -eq 1 ]; then
echo "args[0] = $1"
else
echo "args = $@"
fi
### output ###
$ bash if.sh
Usage: script.sh <arg>
$ bash if.sh 1
args[0] = 1
$ bash if.sh 1 2 3
args = 1 2 3

if [ $# -eq 0 ]; then

echo "Usage: if.sh <arg>"

exit

elif [ $# -eq 1 ]; then

echo "args[0] = $1"

else

echo "args = $@"

### output ###

$ bash if.sh

Usage: script.sh <arg>

$ bash if.sh 1

args[0] = 1

$ bash if.sh 1 2 3

args = 1 2 3

case

他の高級言語でいうとswitch文に当たる。比較部分は、(.+)と(で囲っても良い。以下は、起動時に渡された引数をParseするシンプルな例。

#!/usr/bin/env bash
#
# case word in [ [(] pattern [| pattern]…) command-list ;;]… esac
#
while [ $# -gt 0 ]; do
case "$1" in
--help)
echo "Usage: case.sh [OPTIONS]"
exit
;;
(-v)
# () でも良い
echo "Version 1.0"
;;
--verbose)
VERBOSE=1
echo "VERBOSE -> on"
;;
-o|--output)
shift
OUTPUT="$1"
echo "outpuf -> $OUTPUT"
;;
-*)
echo "invalid option" 2>&1
exit 1
;;
esac
shift
done
### output ###
$ bash case.sh -v --verbose --output /tmp
Version 1.0
VERBOSE -> on
outpuf -> /tmp

#!/usr/bin/env bash

# case word in [ [(] pattern [| pattern]…) command-list ;;]… esac

while [ $# -gt 0 ]; do

case "$1" in

--help)

echo "Usage: case.sh [OPTIONS]"

exit

;;

(-v)

# () でも良い

echo "Version 1.0"

;;

--verbose)

VERBOSE=1

echo "VERBOSE -> on"

;;

-o|--output)

shift

OUTPUT="$1"

echo "outpuf -> $OUTPUT"

;;

-*)

echo "invalid option" 2>&1

exit 1

;;

esac

shift

done

### output ###

$ bash case.sh -v --verbose --output /tmp

Version 1.0

VERBOSE -> on

outpuf -> /tmp

最新のbashではコマンドの区切り文字に、;;、;&、;;&が用意されておりそれぞれ解釈が異なるので注意。;;は、command-listの実行を終え次の句の評価へ移る。;&は、fall throughの動きになる。;;&は、引き続き後続するwordのマッチを試みる。実際の動きは以下のようになる。

#!/usr/bin/env bash
#
# case word in [ [(] pattern [| pattern]…) command-list ;;]… esac
#
while [ $# -gt 0 ]; do
case "$1" in
--help)
echo "Usage: case.sh [OPTIONS]"
exit
;;
(-v)
echo "Version 1.0"
;&
--verbose)
VERBOSE=1
echo "VERBOSE -> on"
shift
;;&
-o|--output)
shift
OUTPUT="$1"
echo "outpuf -> $OUTPUT"
;;
--ver*)
echo "ver"
;;
-*)
echo "invalid option" 2>&1
exit 1
;;
esac
shift
done
### output ###
$ bash case.sh -v
Version 1.0
VERBOSE -> on
$ bash case.sh --verbose
VERBOSE -> on
ver

#!/usr/bin/env bash

# case word in [ [(] pattern [| pattern]…) command-list ;;]… esac

while [ $# -gt 0 ]; do

case "$1" in

--help)

echo "Usage: case.sh [OPTIONS]"

exit

;;

(-v)

echo "Version 1.0"

--verbose)

VERBOSE=1

echo "VERBOSE -> on"

shift

;;&

-o|--output)

shift

OUTPUT="$1"

echo "outpuf -> $OUTPUT"

;;

--ver*)

echo "ver"

;;

-*)

echo "invalid option" 2>&1

exit 1

;;

esac

shift

done

### output ###

$ bash case.sh -v

Version 1.0

VERBOSE -> on

$ bash case.sh --verbose

VERBOSE -> on

ver

select

シンプルな選択リストを表示して標準入力から値を受け取ることができる。

#!/usr/bin/env bash
#
# select name [in words …]; do commands; done
#
ANSWER=
select ans in yes no; do
ANSWER=$ans
break;
done
echo "Your Answer is '$ANSWER'"
### output ###
bash select.sh 
1) yes
2) no
#? 1
Your Answer is 'yes'

#!/usr/bin/env bash

# select name [in words …]; do commands; done

ANSWER=

select ans in yes no; do

ANSWER=$ans

break;

done

echo "Your Answer is '$ANSWER'"

### output ###

bash select.sh

1) yes

2) no

#? 1

Your Answer is 'yes'

in wordsが省略されている場合は、$@が指定されたかのように振る舞う。

echo "Which do you like ?"
select ans; do
ANSWER=$ans
break;
done
echo "Your Answer is '$ANSWER'"
### output ###
Which do you like ?
1) apple
2) orange
#? 1
Your Answer is 'apple'

echo "Which do you like ?"

select ans; do

ANSWER=$ans

break;

done

echo "Your Answer is '$ANSWER'"

### output ###

Which do you like ?

1) apple

2) orange

#? 1

Your Answer is 'apple'

((..))、$((..))

算術式。letと等しい。statusは、式の評価の結果が0の場合は1を、そうでない場合は0を返す。

i=0
while [ $i -lt 5 ]; do
echo $i
((i++))
done
echo "# status test"
((0)) ; echo "((0)) returns $?"
((1)) ; echo "((1)) returns $?"
### output ###
0
1
2
3
4
# status test
((0)) returns 1
((1)) returns 0

i=0

while [ $i -lt 5 ]; do

echo $i

((i++))

done

echo "# status test"

((0)) ; echo "((0)) returns $?"

((1)) ; echo "((1)) returns $?"

### output ###

# status test

((0)) returns 1

((1)) returns 0

[[..]]

拡張正規表現やPattern Matchingによる条件評価が可能。

#!/usr/bin/env bash
STRING="This is a pen. This is a dog. This is a cat."
# Matching with regexp
[[ $STRING =~ [[:space:]]*a[[:space:]](pen) ]] && {
# マッチした文字列はBASH_REMATCH変数で参照可能
echo ${BASH_REMATCH[0]}
echo ${BASH_REMATCH[1]}
}
# Pattern Matching as if the extglob shell option were enabled
STRING="pendogcat"
echo '[[ $STRING = ?(pen*) ]] ; echo $?'
[[ $STRING = ?(pen*) ]] ; echo $?
### output ###
a pen
pen
[[ $STRING = ?(pen*) ]] ; echo $?
0

#!/usr/bin/env bash

STRING="This is a pen. This is a dog. This is a cat."

# Matching with regexp

[[ $STRING =~ [[:space:]]*a[[:space:]](pen) ]] && {

# マッチした文字列はBASH_REMATCH変数で参照可能

echo ${BASH_REMATCH[0]}

echo ${BASH_REMATCH[1]}

}

# Pattern Matching as if the extglob shell option were enabled

STRING="pendogcat"

echo '[[ $STRING = ?(pen*) ]] ; echo $?'

[[ $STRING = ?(pen*) ]] ; echo $?

### output ###

a pen

pen

[[ $STRING = ?(pen*) ]] ; echo $?

[..], test

条件の評価を行なう。

if [ -f ~/.bashrc ] ; then
. ~/.bashrc
fi

if [ -f ~/.bashrc ] ; then

. ~/.bashrc

グルーピングコマンド

コマンドをグループ化して実行できる。

( list )

サブシェルで実行される。以下の例では、サブシェルでカレントディレクトリを一時的に変更し、また元のカレントディレクトリで後続の処理を実行している。サブシェルで定義した変数は、元のコンテキストでは無効となっている。

echo $PWD
(
cd ..
echo $PWD
VARS="subshell"
)
echo $VARS
echo $PWD
### output ###
$ pwd
/Users/guest/workspace/bash
$ bash group.sh 
/Users/guest/workspace/bash
/Users/guest/workspace
/Users/guest/workspace/bash

echo $PWD

(

cd ..

echo $PWD

VARS="subshell"

)

echo $VARS

echo $PWD

### output ###

$ pwd

/Users/guest/workspace/bash

$ bash group.sh

/Users/guest/workspace/bash

/Users/guest/workspace

/Users/guest/workspace/bash

{ list; }

現在のシェルのコンテキストで評価される。リストのコマンド実行前後でカレントディレクトリは変更されている。

echo $PWD
{
cd ..
echo $PWD
VARS="same context"
}
echo $VARS
echo $PWD
### output ###
$ bash group2.sh 
/Users/guest/workspace/bash
/Users/guest/workspace
same context
/Users/guest/workspace

echo $PWD

{

cd ..

echo $PWD

VARS="same context"

}

echo $VARS

echo $PWD

### output ###

$ bash group2.sh

/Users/guest/workspace/bash

/Users/guest/workspace

same context

/Users/guest/workspace

また、以下のようにリダイレクトと組み合わせるとログファイルへの出力などを一箇所にまとめることができる。

{
echo "==> `date`"
if [[ "hoge" =~ "foo" ]]; then
echo "INFO - match"
else
echo "ERROR - not match"
fi
} >> out.log
### output ###
$ bash group3.sh
$ cat out.log 
==> 2016年 7月 8日 金曜日 20時56分54秒 JST
ERROR - not match

{

echo "==> `date`"

if [[ "hoge" =~ "foo" ]]; then

echo "INFO - match"

else

echo "ERROR - not match"

} >> out.log

### output ###

$ bash group3.sh

$ cat out.log

==> 2016年 7月 8日金曜日 20時56分54秒 JST

ERROR - not match

Coprocesses

サブシェルで非同期に実行する仕組み。サブシェルとはcoproc実行時に生成されるファイルディスクリプタを経由してやりとりすることができる。

NAMEは、commandのPIDやファイルディスクリプタを参照するための変数に使われる識別名。指定しない場合は、デフォルトでCOPROCという名前が使われる。サブシェルのPIDは、NAME_PIDで参照できる。

#
# coproc [NAME] command [redirections]
#
do_loop() {
i=0
while test $i -lt 10; do
echo "loop $i"
read line <&0
echo "reply from parent -> $line"
((i++))
sleep 0.5
done
}
coproc do_loop
echo "waiting until coprocess is done."
while read line; do
echo $line
echo "ok" >&${COPROC[1]}
done <&${COPROC[0]}
wait $COPROC_PID
echo "done"
### output ###
$ bash coproc.sh 
waiting until coprocess is done.
loop 0
reply from parent -> ok
loop 1
reply from parent -> ok
loop 2
reply from parent -> ok
loop 3
reply from parent -> ok
loop 4
reply from parent -> ok
loop 5
reply from parent -> ok
loop 6
reply from parent -> ok
loop 7
reply from parent -> ok
loop 8
reply from parent -> ok
loop 9
reply from parent -> ok
done

# coproc [NAME] command [redirections]

do_loop() {

i=0

while test $i -lt 10; do

echo "loop $i"

read line <&0

echo "reply from parent -> $line"

((i++))

sleep 0.5

done

}

coproc do_loop

echo "waiting until coprocess is done."

while read line; do

echo $line

echo "ok" >&${COPROC[1]}

done <&${COPROC[0]}

wait $COPROC_PID

echo "done"

### output ###

$ bash coproc.sh

waiting until coprocess is done.

loop 0

reply from parent -> ok

loop 1

reply from parent -> ok

loop 2

reply from parent -> ok

loop 3

reply from parent -> ok

loop 4

reply from parent -> ok

loop 5

reply from parent -> ok

loop 6

reply from parent -> ok

loop 7

reply from parent -> ok

loop 8

reply from parent -> ok

loop 9

reply from parent -> ok

done

関数

name () compound-command [ redirections ]
or
function name [()] compound-command [ redirections ]

name () compound-command [ redirections ]

function name [()] compound-command [ redirections ]

コマンドをグループ化して名前で一連のコマンド群を呼び出すことができる。以下ような特徴がある。

unset -f nameで関数定義を削除することができる。
関数のbodyを囲む{ }では、前後にブランクや改行での区切りが必要。
関数への引数は$NUMBERで参照できる（引数は1から）
DEBUGやRETURNトラップは関数に継承されないため、もし設定を引き継ぎたい場合は、set -o functrace、関数内でDEBUGやRETURNのトラップを指定する、declare -tで宣言するのいずれかの方法を用いる必要がある。
FUNCNEST変数でネスト数を指定することができる。ネスト回数を超えて関数を呼び出しした場合、関数の実行は中断される。
return 数値で関数の終了ステータスを指定できる。指定がない場合は、関数の最終コマンドの実行結果が関数の終了ステータスとなる。
local varnameでvarnameは関数ローカルの変数となる。

#!/usr/bin/env bash
function hello() {
# 関数ローカル変数
local la="$1"
# ネスト数をカウント
((NEST_COUNT++))
echo "FUNCNAME: $FUNCNAME"
echo "FUNCNEST: $FUNCNEST"
echo "  NEST_COUNT: $NEST_COUNT"
echo "\$0: $0"
echo "Hello, \$la: Hello, $la"
# 再帰
hello
# 終了ステータスは1
return 1
}
FUNCNEST=2
NEST_COUNT=0
# This function definition overwrides existed one.
# hello() {
#   echo "hello function was overwride"
# }
hello "haikikyou"
# 修了ステータス
echo "\$?: $?"
### output ###
$ bash func.sh 
FUNCNAME: hello
FUNCNEST: 2
NEST_COUNT: 1
$0: func.sh
Hello, $la: Hello, haikikyou
FUNCNAME: hello
FUNCNEST: 2
NEST_COUNT: 2
$0: func.sh
Hello, $la: Hello, 
func.sh: 行 12: hello: maximum function nesting level exceeded (2)
$?: 1

#!/usr/bin/env bash

function hello() {

# 関数ローカル変数

local la="$1"

# ネスト数をカウント

((NEST_COUNT++))

echo "FUNCNAME: $FUNCNAME"

echo "FUNCNEST: $FUNCNEST"

echo " NEST_COUNT: $NEST_COUNT"

echo "\$0: $0"

echo "Hello, \$la: Hello, $la"

# 再帰

hello

# 終了ステータスは1

return 1

}

FUNCNEST=2

NEST_COUNT=0

# This function definition overwrides existed one.

# hello() {

# echo "hello function was overwride"

# }

hello "haikikyou"

# 修了ステータス

echo "\$?: $?"

### output ###

$ bash func.sh

FUNCNAME: hello

FUNCNEST: 2

NEST_COUNT: 1

$0: func.sh

Hello, $la: Hello, haikikyou

FUNCNAME: hello

FUNCNEST: 2

NEST_COUNT: 2

$0: func.sh

Hello, $la: Hello,

func.sh: 行 12: hello: maximum function nesting level exceeded (2)

$?: 1

trap DEBUGと-o functraceを使って以下のようなデバッグもできる（以下のサンプルは簡単かつ稚拙な例、bashdbの方が高度で実用的である）。

#!/usr/bin/env bash
#
_lines=()
_i=0
_file=$1
_steps=0
# ステップごとに呼ばれる
debugger() {
local lineno
let lineno=$1+1
(( $_steps > 0 )) && echo "line $lineno: ${_lines[$1]}"
(( _steps++ ))
}
# デバッグ対象ソースを配列に保存
while read; do
_lines[$_i]=$REPLY
((_i++))
done < $_file
set -o functrace
trap 'debugger $(( $LINENO-1 ))' DEBUG
source $_file # 実行

#!/usr/bin/env bash

_lines=()

_i=0

_file=$1

_steps=0

# ステップごとに呼ばれる

debugger() {

local lineno

let lineno=$1+1

(( $_steps > 0 )) && echo "line $lineno: ${_lines[$1]}"

(( _steps++ ))

}

# デバッグ対象ソースを配列に保存

while read; do

_lines[$_i]=$REPLY

((_i++))

done < $_file

set -o functrace

trap 'debugger $(( $LINENO-1 ))' DEBUG

source $_file # 実行

sample() {
local i=0
while test $i -lt 5; do
echo "i = $i"
let i=i+1
done
}
sample

sample() {

local i=0

while test $i -lt 5; do

echo "i = $i"

let i=i+1

done

}

sample

これを実行すると以下のようになる。

bash  trap.sh sample.sh 
line 8: sample
line 1: sample() {
line 2:   local i=0
line 3:   while test $i -lt 5; do
line 4:     echo "i = $i"
i = 0
line 5:     let i=i+1
line 3:   while test $i -lt 5; do
line 4:     echo "i = $i"
i = 1
line 5:     let i=i+1
line 3:   while test $i -lt 5; do
line 4:     echo "i = $i"
i = 2
line 5:     let i=i+1
line 3:   while test $i -lt 5; do
line 4:     echo "i = $i"
i = 3
line 5:     let i=i+1
line 3:   while test $i -lt 5; do
line 4:     echo "i = $i"
i = 4
line 5:     let i=i+1
line 3:   while test $i -lt 5; do

bash trap.sh sample.sh

line 8: sample

line 1: sample() {

line 2: local i=0