苦学楽学塾 ホームページ
最終更新日：2025年1月2日
C言語プログラムのデバグについて考えます。
第1の方法は、プログラム中にprintf()(C言語の主要関数を参照)を入れて、プログラムの流れを追うとともに、変数の値をモニタすることです。例として、正規の関数strpbrk()関数と比較しながら、以下の同様機能の自作関数strpbrk_1()(勿論正しい動作をしません)を、デバグしてみます。
int strpbrk_1(char *pc1, char *pc2) {
char c1, c2;
while(c1 = *pc1++) {
while(c2 = *pc2++) {
if (c1 == c2) return pc1;
}
}
return (char *)NULL;
}
main()関数の中の呼び出し側は、
char delimiter[] = " .,";
char *pc1;
string = (char *)malloc(100);
strcpy(string, "abcdef ghi,jk");
pc1 = strpbrk_1(string, delimiter);
printf("文字列先頭：%lx, 結果：%lx\n", string, pc1);
となっているとします。これをstrpbrk()関数の結果と比較しながらデバグしてみます。
コンパイルして動作させると、画面には、
文字列先頭：800474f50, 結果：474f52
と表示されます。strpbrk()関数の結果は、800474f56です。似ているようで、大きく違うのは、strpbrk()の結果の800000000の部分が、strpbrk_1()でなくなっていることです。そこで、内側のwhileとifの間にprintfを入れてみます。
int strpbrk_1(char *pc1, char *pc2) {
char c1, c2;
while(c1 = *pc1++) {
while(c2 = *pc2++) {
printf("pc1:%lx\n");
if (c1 == c2) return pc1;
}
}
return (char *)NULL;
}
ここで、printfをインデントせずに、行頭から入れているのは、デバグ完了後に、目立つので、すぐにprintfを除去できるからです。コンパイルして動かすと、画面には、
pc1:800474f51
pc1:800474f51
pc1:800474f51
pc1:800474f52
pc1:800474f52
文字列先頭：800474f50, 結果：474f52
と表示されます。strpbrk_1の中ではpc1は4バイトを越える値になっているので、return pc1の問題ではないことがわかります。にもかかわらず、戻り値で800000000がなくなってしまうのは戻り値の指定の仕方に問題があるのです。そこで、関数定義int strpbrk_1(char *pc1, char *pc2)のintが戻り値を4バイトにしてしまっているのだと分かります。printfを一旦削除して、関数定義をintからchar *に直して、
char *strpbrk_1(char *pc1, char *pc2) {
char c1, c2;
while(c1 = *pc1++) {
while(c2 = *pc2++) {
if (c1 == c2) return pc1;
}
}
return (char *)NULL;
}
として、コンパイルし動作させると、画面には、
文字列先頭：800474f50, 結果：800474f52
と表示されます。文字列stringは、 "abcdef ghi,jk"となっているので、先頭から2バイトめという結果が返る、ということは、先頭から2バイトめの'c'がdelimiter[] = " .,"のどれかの文字とされている、ということです。そこで、今度は、whileとifの間に、pc1に加えて、c1とpc2，c2の内容を書くprintfを入れてみます。
char *strpbrk_1(char *pc1, char *pc2) {
char c1, c2;
while(c1 = *pc1++) {
while(c2 = *pc2++) {
printf("pc1:%lx, c1:%02x, pc2:%lx, c2:%02x\n", pc1, c1, pc2, c2);
if (c1 == c2) return pc1;
}
}
return (char *)NULL;
}
コンパイルして動作させると、画面に、
pc1:800474f51, c1:61, pc2:ffffc24d, c2:20
pc1:800474f51, c1:61, pc2:ffffc24e, c2:2e
pc1:800474f51, c1:61, pc2:ffffc24f, c2:2c
pc1:800474f52, c1:62, pc2:ffffc241, c2:61
pc1:800474f52, c1:62, pc2:ffffc242, c2:62
と表示されます。この結果はたまたまです。ならない、あるいは、ダーっと表示が流れる、最悪、SIGSEGVを起こして止まってしまう、という場合もあるかも知れません。strpbrk_1()が、800474f52を返していたのは、文字列stringの2文字めが'b'であって、delimiter[] = " .,"の3文字めが文字列末尾の0で、ここを行き過ぎて、delimiterから5文字めにたまたま'b'と書かれていて一致するので、whileを抜けてretrunしていたのです。delimiter[] = " .,"となっているとき、delimiterから4文字め以降に何が書かれているか、全く分かりません。
何が起きているかと言うと、pc2の先に末尾の0が出てきたら、ここで、pc2をdelimiterの先頭に戻さなければいけないのに、そのままインクリメントされて行き過ぎてしまう、ということです。そこで、strpbrk_1の最初で、pc2をpc0に保存しておいて、内側のwhileループを抜けたら、pc2をpc0に戻すようにします。
char *strpbrk_1(char *pc1, char *pc2) {
char c1, c2;
char *pc0;
pc0 = pc2;
while(c1 = *pc1++) {
while(c2 = *pc2++) {
printf("pc1:%lx, c1:%02x, pc2:%lx, c2:%02x\n", pc1, c1, pc2, c2);
if (c1 == c2) return pc1;
}
pc2 = pc0;
}
return (char *)NULL;
}
コンパイルして動かすと、
pc1:800474f51, c1:61, pc2:ffffc24d, c2:20
pc1:800474f51, c1:61, pc2:ffffc24e, c2:2e
pc1:800474f51, c1:61, pc2:ffffc24f, c2:2c
・・・・・・
pc1:800474f56, c1:66, pc2:ffffc24e, c2:2e
pc1:800474f56, c1:66, pc2:ffffc24f, c2:2c
pc1:800474f57, c1:20, pc2:ffffc24f, c2:20
文字列先頭：800474f50, 結果：800474f57
と表示されます。string中の空白のところで、delimiter[]中の空白' 'と一致してreturnするわけですが、strpbrk()関数では、800474f56が返るので、まだ正しくありません。1文字分行き過ぎてしまうのは、最初のwhileで、while(c1 = *pc1++)としていて、pc1から1文字読み出してすぐpc1をインクリメントしているので、return pc1するときに、空白の位置よりもpc1が1進んでしまうからです。そこで、pc1の位置から1文字読み出してもpc1をインクリメントせず、内側のwhileを抜けてからインクリメントするようにします。こうして、
char *strpbrk_1(char *pc1, char *pc2) {
char c1, c2;
char *pc0;
pc0 = pc2;
while(c1 = *pc1) {
while(c2 = *pc2++) {
if (c1 == c2) return pc1;
}
pc2 = pc0;
pc1++;
}
return (char *)NULL;
}
とすると、ようやく、strpbrk_1()関数が800474f56を返すようになります。ですが、色々動かしているうちに、またこの関数が障害を起こし、再びprintf()を入れる場合があるかも知れません。そこで、C言語のプリ・プロセッサを使います。以下のように、printf()を#ifdef DEBUGと#endifで挟みます。こうしておくと、プログラムの先頭で、#define DEBUGとすると、#ifdef DEBUGの次に進んで、printf()が有効になり、#define DEBUGを削除すると、#ifdef DEBUGと#endifの間がパスされて、printf()は無効になります。printf()をプログラム中のいたるところに散りばめる必要があるときには一括してprintf()の有効/無効を指定できるので便利です。
char *strpbrk_1(char *pc1, char *pc2) {
char c1, c2;
char *pc0;
pc0 = pc2;
while(c1 = *pc1) {
while(c2 = *pc2++) {
#ifdef DEBUG
printf("pc1:%lx, c1:%02x, pc2:%lx, c2:%02x\n", pc1, c1, pc2, c2);
#endif
if (c1 == c2) return pc1;
}
pc2 = pc0;
pc1++;
}
return (char *)NULL;
}
デバグの第2の方法は、C言語に用意されているデバガgdbを利用する方法です。printfデバグに比べて、詳細なデバグが可能です。printfデバグで容易にバグの原因がつかめない場合には、gdbを利用します。上記のstrpbrk_1()の場合、プログラムのファイルが、test.cだとして、gccでコンパイルするときに、-gオプションを付けて、
gcc -g -o test.exe test.c
とコンパイルしておきます。こうすると、test.exeの中に、行番号・変数名などの情報が入ります。こうしてできたtest.exeをデバグするときには、test.exeが、/home/owner/test以下にあるとして(このディレクトリを環境変数PATHに加えておかない場合、exeファイルの存在位置をフルパスで指定する必要があります)、
gdb /home/owner/test/test.exe
としてデバガを起動します。デバガを起動すると、初期メッセージを表示した後、(gdb)とプロンプトを表示して入力待ちになります。ここで使えるコマンド(省略形)には以下のものがあります。
b (breakの略)ブレーク・ポイントの設定
c (continueの略)停止位置から実行再開
d (deleteの略)ブレーク・ポイントの削除
f (frameの略)スタック・フレームの表示
h (helpの略)ヘルプの表示
i (infoの略)情報の表示
l (listの略)ソース・コードの表示
n (nextの略)シングル・ステップ動作(関数内に入らない)
p (printの略)変数の内容や式の結果を表示
q (quitの略)gdbの終了
r (runの略)プログラムの実行
s (stepの略)シングル・ステップ動作(関数内に入る)
x 配列データの表示
コマンド待ちのときに、
l 80
とすると、test.cの80行目の前後合わせて10行のソース・コードを表示します。これを見て、84行めで動作を止めたい場合には、
b 84
とします。これをブレーク・ポイントと言います。ブレーク・ポイントを設定して、
i b
とすると、
1 breakpoint keep y 0x0000000100401229 in stpblk_1 at test.c 84
という具合に、ブレーク・ポイントの情報を表示します。複数個のブレーク・ポイントが設定されているときも、ブレーク・ポイントごとに、番号に続けてブレーク・ポイントの情報を表示します。この番号に対して、
d 1
のようなコマンドを入力すると、1番のブレーク・ポイントを削除できます。strpbrk_1()関数の先頭にブレーク・ポイントをかけるときは、
b strpbrk_1
とします。ここで、
r
と打ち込むと、プログラムの動作が開始し、ブレーク・ポイントが設定されているので、
Brekapoint 2, strpbrk_1 (pc1=0x800028440 "abcdef ghi,jk", pc2=0xffffc21c " .,") at test.c 83)
83 pc0 = pc2;
と、呼び出された関数名、引数の情報を表示し、行番号と、ソース・コードのその行を表示して、コマンド入力待ちになります。ここで、
n
と打ち込むと、1行実行して次の行に行き、
84 while (c1 = *pc1) {
と、行番号と、ソース・コードのその行を表示して、コマンド入力待ちになります。ここで、変数pc0の内容を確認するために、
p pc0
と入力すると、
$1 = 0xffffc21c " .,"
のように、pc0の内容を表示します。ポインタの先にある情報も取得できます。
p *pc0
とすると、
$2 = 32 ' '
のように表示します。ポインタだけでなく、pの後に式を書くと式の値を表示します。ここで、
n
と打ち込むと、1行実行して次の行に行き、
85 while (c2 = *pc2++) {
と表示して、コマンド入力待ちになります。変数c1の内容を確認するために、
p c1
とすると、
$3 = 97 'a'
と整数で表示します。16進表示させたい場合には、
p/x c1
とすると、
$4 = 0x61
と表示します。あるアドレス(ポインタ)から1バイトずつ連続8バイトのデータを16進で表示したいというような場合にxコマンドを使います。"x/"に続けてデータの個数、出力形式の文字、データサイズの文字を続けます。出力形式の文字には、x(16進)，d(符号付き10進)，u(符号なし10進)などを、データサイスの文字にはb(バイト単位)，h(2バイト単位)，w(4バイト単位)，g(8バイト単位)などを指定します。pc1から1バイトずつ連続8バイトのデータを16進で表示する場合には、
x/8xb
とします。ここで、nコマンドを繰り返して使うと1ステップずつ進んでいきますが、1度nコマンドを使うと、コマンド待ちで単に[ENTER]を押下すれば、nコマンドが繰り返し実行されます。煩わしくなったら、再度ブレーク・ポイントを設定し、再開コマンド、
c
を入力すると、ブレーク・ポイントまで実行して停止します。ステップ動作のsコマンドは、関数呼び出ししているところで実行すると、関数内に入っていきますが、nコマンドでは関数呼び出しの次の行に行きます。
cコマンドやrコマンドでプログラムを動作させている間に、SIGSEGVなどの例外を起こして止まってしまうことがあります。このときに、
r
を入力すると、どうするかy/nで聞いてきますが、yとすると、プログラムを最初からやり直します。ブレーク・ポイントを設定しなおして、原因を追究することができます。また、プログラムのまずい部分が分かり、プログラムを修正する場合には、
q
と入力すると、y/nで聞いてきますが、yとすると、gdbから抜けます。
その他に、cd(カレント・ディレクトリの変更)，pwd(カレント・ディレクトリの表示)，watch，set，display，commandsなどのコマンドがあります。
プログラム中の特定の変数の動きを調べたい場合には、watchコマンドを使います。
watch pc1
とすると、pc1の内容に変化が生じた場合には、
Old value = 0x28446 ""
New Value = 0x800028446 " ghi,jk"
のように表示して、書き換えが起きた行で停止します。watchを余り多く設定すると、プログラムの動作が鈍くなります。
コマンドライン引数"-r -g:test1.txt"を付けてexeファイルを実行させる場合は、setコマンドを用いて、プログラムを動作せる前に、
set args -r -g:test1.txt
とします。setコマンドは、変数の値を設定するのにも使えます。
set pc1 = 0x800028443
とすると、変数pc1の値が、0x00028443になります。displayコマンドは、pコマンドとほぼ同様の動作をします。
プログラムが停止したときに決められたコマンドを実行させたい場合、例えば決められた変数の内容を表示させたいとき、commandsを使うことができます。コマンド待ちのときに、commandsに続けてブレーク・ポイントの番号(i bコマンドで確認できます)を記入し、
commands 1
p pc1
end
と入力しておくと、1番のブレーク・ポイントでが停止するたびに、pc1の内容を表示してくれます。
また、gdbには、.gdbinitというファイル(ファイル名の先頭がピリオド'.'であるファイルです)を事前に読み込むという機能があります。/homeディレクトリ直下に、
add-auto-loadsafe-path /home/owner/test/.gdbinit
set auto-load safe-path /
という内容の.gdbinitというファイル(改行コードが、Windowsの0D，0Aではなく、LINUXの0Aであることに注意してください)を置き、/home/owner/testの中に、gdbのコマンド、例えば、set argsとか、
b main
b strpbrk_1
commands 2
p pc1
end
r
と書いた.gdbinitというファイル(改行コードが、Windowsの0D，0Aではなく、LINUXの0Aであることに注意してください)を置いておくと、gdbが起動した直後に、これらのコマンドを実行してくれます。gdbの起動とともに、プログラムが動作開始し、mainで一旦停止、動作再開して、2番目のブレーク・ポイントstrpbrk_1で停止したときに、pc1の内容を表示します。
【広告】 ここから広告です。ご覧の皆さまのご支援ご理解を賜りたく、よろしくお願いいたします。
【広告】 広告はここまでです。