開発ツール

gdbを使ってプログラムをデバッグする方法

C言語向けのデバッグツールとして有名なgdb。私自身、gdbを使ってデバッグできるようになりたいという気持ちが高まってきたので、その使い方を基本的な部分だけでもまとめてみることにしました。

デバッグするプログラム

今回はサンプルとしてこんなプログラムを作りました。変数の値に応じてメッセージを変えるというシンプルなプログラムです。

前準備

前準備として、gdbでデバッグできるようにプログラムをコンパイルします。コンパイル時のオプションに「-g -O0」を指定すればOKです。

# gcc main.c -o gdb_test -g -O0

ちなみに、「-O0」のオプションは「生成する実行ファイルを最適化しない」という意味です。なくてもgdb自体は動かせますが、余計な最適化によってデバッグができなくなるのを防ぐために付けています。

gdbで動かしてみる

gdbの実行

さっそく、gdbを使ってデバッグしてみます。gdbのオプションとして実行ファイル名を指定すればOKです。

# gdb gdb_test

そうすると、ライセンスやらの表示が出て入力待ちになります。これでgdbを使ってデバッグできるようになりました。

ブレイクポイント

まず、ブレイクポイントを設定します。例えば、こうコマンドを打てば、main関数に入る直前にブレイクポイントを張ることができます。

break main

試しに、先ほどのプログラムのmain関数でブレイクを張って「run」で実行してみるとこんな感じに。

Reading symbols from /home/corgi/workspace/gdb_test/gdb_test...done.
(gdb) break main
Breakpoint 1 at 0x4005a6: file main.c, line 25.
(gdb) run
Starting program: /home/corgi/workspace/gdb_test/gdb_test
Breakpoint 1, main () at main.c:25
25 int a = 1;
(gdb)

ちゃんとmain関数で一度実行が停止しているのが分かります。このようにプログラムを途中で停止させれば、それ以降の動きを順に追うことができます。

next実行とstep実行

ブレイクポイントで止めたプログラムを順に動かしていくには、nextとstepをよく使います。

まず、nextは行単位での実行というイメージでしょうか。main関数でブレイクを張った状態でnextを実行していくと、main関数内のプログラムが行単位で実行されていくのが分かります。

Breakpoint 1, main () at main.c:25
25 int a = 1;
(gdb) next
26 int b = 2;
(gdb) next
28 printMessage(a, b);
(gdb) next
'a' and 'b' is more then 0
30 return 0;
(gdb) next
31 }

ざっくりとしたプログラムの流れを追うならnextが便利ですが、もっと細かく動きを追いたいときもあります。例えば、nextではprintMessage関数の中までは見えませんでした。

そんなときにはstepを使えばOKです。こちらは途中に関数があれば、その中まで入って順に実行してくれます。

Breakpoint 1, main () at main.c:25
25 int a = 1;
(gdb) next
26 int b = 2;
(gdb) next
28 printMessage(a, b);
(gdb) step
printMessage (a=1, b=2) at main.c:5
5 if( a < 0 && b < 0 )
(gdb) step
9 else if( a < 0 && b > 0 )
(gdb) step
13 else if( a > 0 && b < 0 )
(gdb) step
17 else if( a > 0 && b > 0 )
(gdb) step
19 printf("'a' and 'b' is more then 0\n");
(gdb) continue
Continuing.
'a' and 'b' is more then 0
[Inferior 1 (process 2672) exited normally]

stepを使えばどんどん奥までプログラムを追えますが、適度なところでcontinueを叩いてプログラムを先に進めるとデバッグ作業には便利です。

変数の書き換え

個人的に強力だと思う機能が変数の書き換えです。gdbでは以下のコマンドで実行中のプログラムの変数を強制的に書き換えることができます。

set var <変数名> = <値>

試しに、今回のプログラムで変数aの値を書き換えてみます。ちなみに、変数の値は「print」コマンドで見ることができるので、ちゃんと変わったかどうか確認しながら進めると確実です。

Reading symbols from /home/corgi/workspace/gdb_test/gdb_test...done.
(gdb) break printMessage
Breakpoint 1 at 0x40053e: file main.c, line 5.
(gdb) run
Starting program: /home/corgi/workspace/gdb_test/gdb_testBreakpoint 1, printMessage (a=1, b=2) at main.c:5
5 if( a < 0 && b < 0 )
(gdb) set var a = -1
(gdb) print a
$1 = -1
(gdb) continue
Continuing.
only 'a' is less than 0
[Inferior 1 (process 2706) exited normally]

途中で変数を書き換えたことで、最終的な出力結果も変わっていることが分かります。このように、変数を書き換えることで条件分岐をひとつひとつ通せるようになるので、デバッグだけでなくカバレッジを取るときにも有効です。

まとめ

ここで挙げたのはgdbの使い方のほんの一例ですが、これだけでも開発作業がだいぶ楽になりそうです。特にLinuxだとデバッグ環境自体も選択肢が少ないので、嬉しい限りですね。

今後も便利な使い方を覚えたら備忘録として書いていきたいと思います。

ではでは

補足

環境によっては、gdb実行時にパッケージ不足でこのようなエラーが出るかもしれません。

Missing separate debuginfos, use: debuginfo-install glibc-2.17-106.el7_2.8.x86_64

この場合、CentOSでは以下のコマンドで必要なパッケージをインストールできます。

# yum install yum-utils
# debuginfo-install glibc-2.17-106.el7_2.8.x86_64

-開発ツール