第12章 プログラミング

多くのシステムスクリプトは POSIX シェル (表1.13「シェルプログラムのリスト」を参照下さい) のどれで解釈されるか分かりません。

全ての POSIX シェル間でポータブルとするために bashisms や zshisms を使うシェルスクリプトを書くのを避けます。checkbashisms(1) を使うとこれがチェックできます。

"echo" コマンドはその実装がシェルビルトインや外部コマンド間で相違しているので以下の注意点を守って使わなければいけません。

	注記
	"-n" オプションは実は POSIX シンタックスではありませんが、一般的に許容されています。

	ヒント
	出力文字列にエスケープシーケンスを埋め込む必要がある場合には、"echo" コマンドの代わりに "printf" コマンドを使います。

特別なシェルパラメーターがシェルスクリプト中ではよく使われます。

覚えておくべき基本的なパラメーター展開を次に記します。

ここで、これら全てのオペレーターのコロン ":" は実際はオプションです。

各コマンドは条件式に使えるエグジットステイタスを返します。

	注記
	シェル条件文の文脈において "0" は "真" を意味しますが、C 条件文の文脈では "0" は "偽" を意味します。

	注記
	"[" は、"]" までの引数を条件式として評価する、test コマンドと等価です。

覚えておくべき基本的な条件文の慣用句は次です。

if [ conditional_expression ]; then
 if_success_run_this_command
else
 if_not_success_run_this_command
fi

ここで、シェルが "-e" フラグ付きで起動された際にシェルスクリプトがこの行で誤って exit しないようにするために、末尾の "|| true" が必要です。

条件式中の算術整数比較演算子は "-eq" と "-ne" と "-lt" と "-le" と "-gt" と "-ge" です。

POSIX シェル中で使われるループの慣用句があります。

	ヒント
	C 言語のような数字の繰り返しは "foo1 foo2 ..." 生成に seq(1) 使って実現します。

	ヒント
	「ファイルに関してループしながらコマンドを反復実行」を参照下さい。

普通の人気あるシェル コマンド プロンプトがあなたのスクリプト実行環境下使えないかもしれません。

シェルはおおよそ以下のシーケンスでスクリプトを処理します。

ダブルクォート中のシングルクォートに効果はありません。

シェル環境中で "set -x" を実行したり、シェルを "-x" オプションで起動すると、シェルは実行するコマンドを全てプリントするようになります。これはデバグをするのに非常に便利です。

Debian システム上でできるだけポータブルなシェルプログラムとするには、ユーティリティープログラムを essential パッケージで提供されるプログラムだけに制約するのが賢明です。

	ヒント
	moreutils は Debian の外では存在しないかも知れませんが、興味深い小さなプログラムを提供します。もっとも特記すべきは、オリジナルファイルを上書きしたいときに非常に有効な sponge(8) です。

例は「Unix 的テキスト処理」を参照下さい。

ほとんどのインタープリターは基本的文法チェックやコード追跡の機能を提供します。

dash のコードチェックの際には、 bash のようなインタラクティブ環境を用意する「Readline のラッパー」を試します。

perl のコードチェックの際には、Pythonのような REPL (=READ + EVAL + PRINT + LOOP) 環境を提供するPerl 用の環境を試しましょう。

シェルスクリプトは魅力的な GUI プログラムを作るまで改善できます。echo や read コマンドを使う鈍いやりとりに代えて、いわゆるダイアログプログラムを使うのがこのトリックです。

簡単なシェルスクリプトだけでできるほど GUI プログラムがいかに簡単ということを示す GUI プログラムの例は以下です。

このスクリプトはファイルの選択(デフォルトは/etc/motd) に zenity を使い、それを表示します。

このスクリプトの GUI ローンチャーは以下のようにして生成できます 「GUI からプログラムをスタート」.

#!/bin/sh -e
# Copyright (C) 2021 Osamu Aoki <[email protected]>, Public Domain
# vim:set sw=2 sts=2 et:
DATA_FILE=$(zenity --file-selection --filename="/etc/motd" --title="Select a file to check") || \
  ( echo "E: File selection error" >&2 ; exit 1 )
# Check size of archive
if ( file -ib "$DATA_FILE" | grep -qe '^text/' ) ; then
  zenity --info --title="Check file: $DATA_FILE" --width 640  --height 400 \
    --text="$(head -n 20 "$DATA_FILE")"
else
  zenity --info --title="Check file: $DATA_FILE" --width 640  --height 400 \
    --text="The data is MIME=$(file -ib "$DATA_FILE")"
fi

シェル スクリプトでの GUI プログラムへのこのようなアプローチは簡単な選択ケースでのみ有効です。何らかの複雑のあるプログラムを書く場合には、もっと能力あるプラットフォームで書くことを考えましょう。

GUI ファイラー プログラムは、追加の拡張パッケージを使って選択されたファイルに対していくつかの人気ある動作を実行するように拡張できます。また、GUI ファイラー プログラムはあなたの特定のスクリプトを追加することで非常に特定のカスタム動作を実行するようにもできます。

データー処理をするためには、cut や grep や sed 等を実行するサブプロセスを起動する必要が sh ではあり、遅いです。一方、データーを処理する内部機能が perl ではあり、高速です。そのため、多くの Debian のシステム メンテナンス スクリプトは perl を使います。

以下の AWK スクリプトとそれと等価Perl スクリプトの断片を考えましょう。

awk '($2=="1957") { print $3 }' |

これは以下の数行のどれとも等価です。

perl -ne '@f=split; if ($f[1] eq "1957") { print "$f[2]\n"}' |

perl -ne 'if ((@f=split)[1] eq "1957") { print "$f[2]\n"}' |

perl -ne '@f=split; print $f[2] if ( $f[1]==1957 )' |

perl -lane 'print $F[2] if $F[1] eq "1957"' |

perl -lane 'print$F[2]if$F[1]eq+1957' |

最後のスクリプトは謎々状態です。Perl の以下の機能を利用しています。

このフレキシビリティーは Perl の強みです。同時に、これは我々に読解不能な絡まったコードを書くことを許容します。だから注意して下さい。

C プログラム言語で書かれたプログラムをコンパイルする適正な環境を以下のようにして設定できます。

# apt-get install glibc-doc manpages-dev libc6-dev gcc build-essential

GNU C ライブラリーパッケージである libc6-dev パッケージは、C プログラム言語で使われるヘッダーファイルやライブラリールーチンの集合である C 標準ライブラリーを提供します。

C のリファレンスは以下を参照下さい。

簡単な例の "example.c" は"libm" ライブラリーを使って実行プログラム "run_example" に以下のようにしてコンパイル出来ます。

$ cat > example.c << EOF
#include <stdio.h>
#include <math.h>
#include <string.h>

int main(int argc, char **argv, char **envp){
        double x;
        char y[11];
        x=sqrt(argc+7.5);
        strncpy(y, argv[0], 10); /* prevent buffer overflow */
        y[10] = '\0'; /* fill to make sure string ends with '\0' */
        printf("%5i, %5.3f, %10s, %10s\n", argc, x, y, argv[1]);
        return 0;
}
EOF
$ gcc -Wall -g -o run_example example.c -lm
$ ./run_example
        1, 2.915, ./run_exam,     (null)
$ ./run_example 1234567890qwerty
        2, 3.082, ./run_exam, 1234567890qwerty

ここで、"-lm" はsqrt(3) のために libc6 パッケージで提供されるライブラリー "/usr/lib/libm.so" をリンクするのに必要です。実際のライブラリーは "/lib/" 中にあるファイル名 "libm.so.6" で、それは "libm-2.7.so" にシムリンクされています。

出力テキスト中の最後のパラメーターを良く見ましょう。"%10s" が指定されているにもかかわらず10文字以上あります。

上記のオーバーラン効果を悪用するバッファーオーバーフロー攻撃を防止のために、sprintf(3) や strcpy(3) 等の境界チェック無しのポインターメモリー操作関数の使用は推奨できません。これに代えて snprintf(3) や strncpy(3) を使います。

Flex はLex 互換の高速字句解析生成ソフトです。

flex(1) の入門書は "info flex" の中にあります。

シンプルな例が "/usr/share/doc/flex/examples/" の下にあります。 ^[7]

Yacc 互換の前方参照可能な LR パーサーとか LALR パーサー生成ソフトは、いくつかのパッケージによって Debian 上で提供されています。

bison(1) の入門書は "info bison" の中にあります。

あなた自身の "main()" と "yyerror()" を供給する必要があります。"main()" は、Flex によって通常作成された "yylex()" を呼び出す "yyparse()" を呼び出します。

シンプルなターミナル上の計算機プログラムの作成例をここに示します。

example.y を作成しましょう:

/* calculator source for bison */
%{
#include <stdio.h>
extern int yylex(void);
extern int yyerror(char *);
%}

/* declare tokens */
%token NUMBER
%token OP_ADD OP_SUB OP_MUL OP_RGT OP_LFT OP_EQU

%%
calc:
 | calc exp OP_EQU    { printf("Y: RESULT = %d\n", $2); }
 ;

exp: factor
 | exp OP_ADD factor  { $$ = $1 + $3; }
 | exp OP_SUB factor  { $$ = $1 - $3; }
 ;

factor: term
 | factor OP_MUL term { $$ = $1 * $3; }
 ;

term: NUMBER
 | OP_LFT exp OP_RGT  { $$ = $2; }
  ;
%%

int main(int argc, char **argv)
{
  yyparse();
}

int yyerror(char *s)
{
  fprintf(stderr, "error: '%s'\n", s);
}

example.l を作成しましょう:

/* calculator source for flex */
%{
#include "example.tab.h"
%}

%%
[0-9]+ { printf("L: NUMBER = %s\n", yytext); yylval = atoi(yytext); return NUMBER; }
"+"    { printf("L: OP_ADD\n"); return OP_ADD; }
"-"    { printf("L: OP_SUB\n"); return OP_SUB; }
"*"    { printf("L: OP_MUL\n"); return OP_MUL; }
"("    { printf("L: OP_LFT\n"); return OP_LFT; }
")"    { printf("L: OP_RGT\n"); return OP_RGT; }
"="    { printf("L: OP_EQU\n"); return OP_EQU; }
"exit" { printf("L: exit\n");   return YYEOF; } /* YYEOF = 0 */
.      { /* ignore all other */ }
%%

そして、これを試すためにシェルプロンプトから以下を実行しましょう:

$ bison -d example.y
$ flex example.l
$ gcc -lfl example.tab.c lex.yy.c -o example
$ ./example
1 + 2 * ( 3 + 1 ) =
L: NUMBER = 1
L: OP_ADD
L: NUMBER = 2
L: OP_MUL
L: OP_LFT
L: NUMBER = 3
L: OP_ADD
L: NUMBER = 1
L: OP_RGT
L: OP_EQU
Y: RESULT = 9

exit
L: exit

Debian 上の第一義的デバッガは、実行中のプログラムを検査できるようにする gdb(1) です。

gdb と関連プログラムを以下のようにインストールしましょう。

# apt-get install gdb gdb-doc build-essential devscripts

gdb のよいチュートリアルについては以下を参照下さい:

次は gdb(1) を"-g" を使ってデバッグ情報を付けてコンパイルされた "program" に使う簡単な例です。

$ gdb program
(gdb) b 1                # set break point at line 1
(gdb) run args           # run program with args
(gdb) next               # next line
...
(gdb) step               # step forward
...
(gdb) p parm             # print parm
...
(gdb) p parm=12          # set value to 12
...
(gdb) quit

	ヒント
	多くの gdb(1) コマンドは省略できます。タブ展開はシェル同様に機能します。

全てのインストールされたバイナリーはデフォルトでは Debian システム上ではストリップされているべきなので、ほとんどのデバグシンボルは普通のパッケージからは除かれています。gdb(1) を使って Debian パッケージをデバグするためには、*-dbgsym パッケージ(例えばcoreutils の場合は coreutils-dbgsym)をインストールする必要があります。ソースパッケージは、普通のバイナリーパッケージとともに *-dbgsym パッケージを自動生成し、そうしたデバグパッケージは別にして debian-debug アーカイブ中に置かれます。詳細は Debian Wiki の記事を参照下さい。

デバッグしようとしているパッケージに*-dbgsym パッケージが無い場合は、以下のようにしてリビルドした後でインストールする必要があります。

$ mkdir /path/new ; cd /path/new
$ sudo apt-get update
$ sudo apt-get dist-upgrade
$ sudo apt-get install fakeroot devscripts build-essential
$ apt-get source package_name
$ cd package_name*
$ sudo apt-get build-dep ./

必要に応じてバグを修正します。

例えば以下のように、既存パッケージを再コンパイルする時は "+debug1" を後ろに付けたり、リリース前のパッケージをコンパイルする時は "~pre1" を後ろに付けたりと、正規の Debian バージョンとかち合わないようにパッケージバージョンを増やします。

$ dch -i

以下のようにしてデバグシンボル付きでパッケージをコンパイルしてインストールします。

$ export DEB_BUILD_OPTIONS="nostrip noopt"
$ debuild
$ cd ..
$ sudo debi package_name*.changes

パッケージのビルドスクリプトを確認して、バイナリーのコンパイルに確実に "CFLAGS=-g -Wall" が使われているようにします。

プログラムがクラッシュするのに出会った場合に、バックトレース情報をバグレポートに切り貼りして報告するのは良い考えです。

バックトレースはgdb(1) によって以下のような段取りで得られます。

無限ループやキーボードが凍結した場合、Ctrl-\ か Ctrl-C を押すか “kill -ABRT PID” を実行することでプログラムを強制終了できます。(「プロセスの停止」を参照下さい)

	ヒント
	しばしば、一番上数行が "malloc()" か "g_malloc()" 中にあるバックトレースを見かけます。こういったことが起こる場合は、大体あまりあなたのバックトレースは役に立ちません。有用な情報を見つけるもっとも簡単な方法は環境変数 "$MALLOC_CHECK_" の値を 2と設定することです (malloc(3))。gdb を実行しながらこれを実行するには以下のようにします。 $ MALLOC_CHECK_=2 gdb hello

以下のように ldd(1) を使ってプログラムのライブラリーへの依存関係をみつけだします。

$ ldd /usr/bin/ls
        librt.so.1 => /lib/librt.so.1 (0x4001e000)
        libc.so.6 => /lib/libc.so.6 (0x40030000)
        libpthread.so.0 => /lib/libpthread.so.0 (0x40153000)
        /lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0x40000000)

`chroot` された環境下で ls(1) が機能するには、上記ライブラリーがあなたの `chroot` された環境内で利用可能である必要があります。

「プログラム活動の追跡」を参照下さい。

Debian 中に複数の動的呼び出し追跡ツールがあります。「プログラム活動の監視と制御と起動」 を参照下さい。

GNOME プログラム preview1 が X エラーを受けると、以下のようなメッセージが見つかります。

The program 'preview1' received an X Window System error.

このような場合には、プログラムを "--sync" 付きで実行して、バックトレースを得るために "gdk_x_error" 関数上で停止するようにしてみます。

Debian にはメモリーリークを検出するプログラムがいくつか利用可能です。

以下のように objdump(1) を使ってバイナリーコードをディスアッセンブルできます。

$  objdump -m i386 -b binary -D /usr/lib/grub/x86_64-pc/stage1

	注記
	gdb(1) は対話的にコードをディスアッセンブルするのに使えます。

Make はプログラムのグループを管理するためのユーティリティーです。make(1) を実行すると、make は"Makefile" というルールファイルを読み、ターゲットが最後に変更された後で変更された前提ファイルにターゲットが依存している場合やターゲットが存在しない場合にはターゲットを更新します。このような更新は同時並行的にされるかもしれません。

ルールファイルのシンタックスは以下の通りです。

target: [ prerequisites ... ]
 [TAB]  command1
 [TAB]  -command2 # ignore errors
 [TAB]  @command3 # suppress echoing

上記で、"[TAB]" は TAB コードです。各行は make による変数置換後シェルによって解釈されます。スクリプトを継続する行末には "\" を使います。シェルスクリプトの環境変数のための "$" を入力するためには "$$" を使います。

ターゲットや前提に関するインプリシット (暗黙) ルールは、例えば以下のように書けます。

%.o: %.c header.h

上記で、ターゲットは "%" という文字を (1つだけ) 含んでいます。"%" は実際のターゲットファイル名の空でないいかなる部分文字列ともマッチします。前提もまた同様にそれらの名前が実際のターゲットファイル名にどう関連するかを示すために "%" を用いることができます。

"make -p -f/dev/null" を実行して自動的な内部ルールを確認下さい。

Autotools は多くの Unix-like システムに移植可能なソースコードパッケージを作ることを援助するように設計された一連のプログラムツールです。

12.6.2.1. プログラムをコンパイルとインストール

	警告
	システムファイルをあなたがコンパイルしたプログラムでインストールする時に上書きしてはいけません。

Debian は"/usr/local/" とか "/opt" 中のファイルに触れません。プログラムをソースからコンパイルする場合、Debian とかち合わないようにそれを "/usr/local/" の中にインストールします。

$ cd src
$ ./configure --prefix=/usr/local
$ make # this compiles program
$ sudo make install # this installs the files in the system

$ ./configure all-of-the-options-you-gave-it
$ sudo make uninstall

# find /usr/local -type f -print0 | xargs -0 rm -f

ソフトウェアービルドシステムは進化してきています:

"The Meson Build system" や "The Ninja build system" にある文書を参照下さい。