How to time a program in POSIX shell script

Introduction

シェルスクリプトは複数のコマンドや構文の組み合わせにより構成される。そのため，ある処理を行う場合に複数の実現方法が存在することがよくある。例えば，変数VARと文字列TARGETが一致するかの判定には，以下の3通りの方法がある。

[ "$VAR" = "TARGET" ]                   && echo MATCH
printf '%s' "$VAR" | grep -q '^TARGET$' && echo MATCH
case "$VAR" in 'TARGET')                   echo MATCH;; esac

複数の実現方法が存在する場合は，以下の要素を考慮してどれが最善の方法かを検討して選ぶだろう。

これらの内，［可読性］と［記述量］はコードとして書かれた時点で人が判断できる。しかし，実行速度はコードを実行して実際に時間を計測しなければわからない。場合によっては，実行速度が圧倒的に速いために可読性や記述量が多少悪くても最善の方法になることも考えられる。

POSIX原理主義を実践していくうえで，シェルスクリプトは実行速度が遅いという風評被害を受けることがある。これは，複数の実現方法の中から実行速度が遅いものを選択した場合や，実行速度の遅い方法しか知らない場合になされる批判だ。

そこで，POSIXに準拠したプログラムの実行速度の計測方法を検討し，実行速度が遅いという批判を避けられるようにする。

時間の計測方法

まず，実行速度の計測にあたって，計測する時間の種類を把握しておく。例えば，プログラムの開始時から終了時までなのか，プログラムの実際の処理時間だけをみるのかといったように，用途によって注目すべき項目が異なってくる。

POSIXにおける実行時間はtimeコマンドの節で説明されている3種類となる。

Real timeはコマンド呼び出しから終了までの合計時間である。単に実行速度について議論するときはReal timeを指すことが多い。User CPU timeとSystem CPU timeに加え，これら2種類以外の全ての要素（I/Oやネットワークの待ち時間など）の+αの要素を含む。式で記述すると以下となる。

Real time = User CPU time + System CPU time + α

User CPU timeはコマンド自体の処理時間である。プログラム自体のパフォーマンスに注目する場合はこの時間を参照する。

System CPU timeはプログラムを実行するために必要なリソースの割当などのOS自体が処理する時間である。System CPU timeを参照することはあまりない印象だ。

計測時間の保証精度

計測方法の説明の前にもう一つ知っておく必要がある。それは，POSIXでの計測時間の保証精度だ。計測した時間の秒の内，小数点以下何桁までPOSIXで使えるとみていいかだ。

POSIXでのプロセスの時間計測にはsys/times.hで定義されるtimes関数を使われている。times関数のページで以下の記述がある。

つまり，時間の計測にはclock tick（クロック単位）を使っていることになる。そして，clock tickはシステムで異なるのでsysconf(_SC_CLK_TCK)で取得すべきだとのこと。clock tickは以下で定義される。

1秒間に発生する実装で定義される回数での時間の間隔。この回数で時間の間隔が処理されている模様。clock_tの値でclock tickの値を確認できるらしい。

実際にclock tickの値を確認してみる。以下のコードをgccでコンパイルして実行してみたところ，以下の結果になった。

• MSYS2だと1000
• Ubuntu 16.04だと100

////////////////////////////////////////////////////////////////////////////////
/// \file      clock_tick.c
/// \author    SENOO, Ken
/// \copyright CC0
////////////////////////////////////////////////////////////////////////////////

#include <stdio.h>
#include <unistd.h>

int main(void){
  printf("%ld\n", sysconf(_SC_CLK_TCK));
  return 0;
}

clock tickが確認できたところで，このclock tickの値と計測時間の精度をどう見るかを考える。timeコマンドに以下の説明があった。

timeコマンドやtimesコマンドなど計測時間を表示するコマンドの表示結果の書式は%fという表記を使っており，ここの精度は基本的に処理系依存となる。しかし，上記説明で書かれている通り，この精度はclock tickのサイズに対応できなければならない。例にあるとおり60 clock ticksであれば，1/60≒0.0167であり0.01 sの単位までは保証されなければならないとある。

実際にclock tickを確認したところUbuntu 16.04で100だった。0.1 sの単位までの精度の保証で済むのはclock tick=10（1/10=0.1 s）までで，clock tick>11となれば1/11≒0.091 sとなり，0.01 sの精度の保証が必要となる。現実的にclock tick<=10は小さすぎるので0.1 sの単位の保証で済むとは考えにくい。

したがって，時間の計測時には小数点以下第2位である0.01 s（10 ms）の単位までは保証されると考えてよいだろう。

計測方法

ここからは，実際にPOSIXに準拠した実行時間の計測方法について説明する。以下の3通りの方法が存在する。

1. date
2. times
3. time

#!/bin/sh -u
## \file time-date.sh
start=$(date +%s)
sleep 1
stop=$(date +%s)
echo "$((stop - start))"

1

times

0m0.088s 0m0.052s
0m17.144s 0m1.552s

#!/bin/sh -u
## \file time-times.sh
yes | head -n 100000
times

0m0.000000s 0m0.000000s
0m0.000000s 0m0.020000s

sh -c 'for i in $(yes | head -n 10000); do echo $i; done; times'

0.00user 0.00system 0:01.00elapsed 0%CPU (0avgtext+0avgdata 2116maxresident)k
0inputs+0outputs (0major+81minor)pagefaults 0swaps

real    0m1.001s
user    0m0.000s
sys     0m0.000s

sleep 1  0.00s user 0.00s system 0% cpu 1.003 total

0.0u 0.0s 0:01.00 0.0% 0+0k 0+0io 0pf+0w

0.000u 0.000s 0:01.00 0.0%      0+0k 0+0io 0pf+0w

real 0m1.00s
user 0m0.00s
sys 0m0.00s

\time sleep 1

real 1.00
user 0.00
sys 0.00

#!/bin/sh
time -p sleep 1

-p: Command not found.

bash
type time
type command

time is a shell keyword
command is a shell builtin

\time
t\ime
t"im"e
ti'me'

command time -p sleep 1

\time -p sleep 1

\time -p sh -c 'for i in $(yes | head -n 10000); do echo "A" | grep -q "A"; done'

その他の計測方法

POSIX非準拠だったり，時間計測としてはあまり適さないと判断した方法を参考までに掲載する。

ps -o stime,time $$

STIME     TIME
20:03 00:00:00

Discussion

ここまでで，実行時間の計測方法を紹介した。これらの中でどれがベストであるかを検討する。検討にあたって，時間計測結果に必要と考える以下2項目の対応状況を確認する。

• ミリ秒の精度での計測
• Real timeとUser CPU timeの計測

時間計測結果の対応状況を以下の表にまとめた。

この結果から，全ての条件を満たしている\time -pがプログラムの実行時間の計測方法として最善と判断した。実際，計測手順も簡単で応用しやすいので順当な結果だろう。

Conclusion

プログラムの実行時間のPOSIXに準拠した計測方法を紹介した。プログラムを書く上で，実行速度はとても重要な要素である。「シェルスクリプトは速度が遅い」などといわれないように，複数の実現方法が思いついたときtimeコマンドで時間を計測し，最善の方法を検討しよう。

最後に，冒頭で掲示した変数VARと文字列TARGETが一致するかの3通りの方法（test，grep，case）の実行速度の測定コードと測定結果を示す。

#!/bin/sh -u
## \file time-match.sh

N=20000 VAR=TARGET \time -p sh -c 'for i in $(yes | head -n $N); do [ "$VAR" = "TARGET" ] && echo MATCH; done' >/dev/null
N=20000 VAR=TARGET \time -p sh -c 'for i in $(yes | head -n $N); do printf %s "$VAR" | grep -q ^TARGET$ && echo MATCH; done' >/dev/null
N=20000 VAR=TARGET \time -p sh -c 'for i in $(yes | head -n $N); do case "$VAR" in TARGET) echo MATCH;; esac; done' >/dev/null

real 0.03
user 0.03
sys 0.00
real 15.38
user 0.19
sys 2.18
real 0.01
user 0.01
sys 0.00

組み込みコマンドのcaseが最も速く，grepによるものが最も遅い結果となった。このような結果になった理由を簡単に解説する。

caseはシェルの複合コマンド（Compound Commands，制御構造）であり，通常のコマンドと異なり新しいプロセスが生成されない。そのため，基本的に速度が速い。grepによるマッチでは文字列の出力のために他と比べて余分にコマンドを実行していることと，正規表現のマッチ自体の処理があるため遅くなったのだと思われる。