LLVM IRおよびそこから出力する実行可能ファイルにデバッグ情報を埋め込む方法を調べるため、下準備としていろいろやったのでその記録を残しておく。
基本的にWindows環境を想定しているが、Linuxのgdbでの動作確認も行っている。
実施した内容は以下。
- clangでデバッグ情報付きLLVM IRを出力
- LLVM IRからobjファイルとpdbファイルを生成
- objファイルをリンクしてexeファイルを生成
- デバッガでブレーク、ステップ実行や変数の中身の確認ができることを確認
- コアダンプの解析とかまでは試していない
LLVMのバージョンは10.0.0。 clangやLLVM関連のツールはこの手順でセットアップしている。
目次
Cソースコード → LLVM IR → obj → exe & pdb
まずは何でもいいので適当なCソースコードを書く。
int main() { int x = 1; x = x + 20; return x; }
それをClangでデバッグ情報付きLLVM IRに変換するため、以下のコマンドを実行。
clang -S -O0 -g -emit-llvm example.c
以下のようなLLVM IRが出力される。
; ModuleID = 'example.c' source_filename = "example.c" target datalayout = "e-m:w-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128" target triple = "x86_64-pc-windows-msvc19.26.28806" ; Function Attrs: noinline nounwind optnone uwtable define dso_local i32 @main() #0 !dbg !8 { %1 = alloca i32, align 4 %2 = alloca i32, align 4 store i32 0, i32* %1, align 4 call void @llvm.dbg.declare(metadata i32* %2, metadata !12, metadata !DIExpression()), !dbg !13 store i32 1, i32* %2, align 4, !dbg !13 %3 = load i32, i32* %2, align 4, !dbg !14 %4 = add nsw i32 %3, 20, !dbg !14 store i32 %4, i32* %2, align 4, !dbg !14 %5 = load i32, i32* %2, align 4, !dbg !15 ret i32 %5, !dbg !15 } ; Function Attrs: nounwind readnone speculatable willreturn declare void @llvm.dbg.declare(metadata, metadata, metadata) #1 attributes #0 = { noinline nounwind optnone uwtable "correctly-rounded-divide-sqrt-fp-math"="false" "disable-tail-calls"="false" "frame-pointer"="none" "less-precise-fpmad"="false" "min-legal-vector-width"="0" "no-infs-fp-math"="false" "no-jump-tables"="false" "no-nans-fp-math"="false" "no-signed-zeros-fp-math"="false" "no-trapping-math"="false" "stack-protector-buffer-size"="8" "target-cpu"="x86-64" "target-features"="+cx8,+fxsr,+mmx,+sse,+sse2,+x87" "unsafe-fp-math"="false" "use-soft-float"="false" } attributes #1 = { nounwind readnone speculatable willreturn } !llvm.dbg.cu = !{!0} !llvm.module.flags = !{!3, !4, !5, !6} !llvm.ident = !{!7} !0 = distinct !DICompileUnit(language: DW_LANG_C99, file: !1, producer: "clang version 10.0.0 ", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, enums: !2, nameTableKind: None) !1 = !DIFile(filename: "example.c", directory: "C:\\paht\\to\\source-directory", checksumkind: CSK_MD5, checksum: "bda5f894a9ecbcdac581adc13d782cc2") !2 = !{} !3 = !{i32 2, !"CodeView", i32 1} !4 = !{i32 2, !"Debug Info Version", i32 3} !5 = !{i32 1, !"wchar_size", i32 2} !6 = !{i32 7, !"PIC Level", i32 2} !7 = !{!"clang version 10.0.0 "} !8 = distinct !DISubprogram(name: "main", scope: !1, file: !1, line: 1, type: !9, scopeLine: 1, spFlags: DISPFlagDefinition, unit: !0, retainedNodes: !2) !9 = !DISubroutineType(types: !10) !10 = !{!11} !11 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed) !12 = !DILocalVariable(name: "x", scope: !8, file: !1, line: 2, type: !11) !13 = !DILocation(line: 2, scope: !8) !14 = !DILocation(line: 3, scope: !8) !15 = !DILocation(line: 4, scope: !8)
ここらへんの詳細は後でLLVM言語リファレンスをじっくり読んで調査する予定。
このLLVM IRをobjファイルに変換するため、以下のコマンドを実行する。
llc -filetype=obj example.ll
objファイルが出力されるので、リンクしてexeとpdbファイルを作成するため、Visual Studioのリンカを使う。
スタートメニューからVisual Studio 2019
- x64 Native Tools Command Prompt for VS 2019
を起動。
コマンドプロンプトが開いたら以下のコマンドを実行。
link /defaultlib:libcmt /DEBUG example.obj
これで、exeとpdbファイルが出力される。
WinDbgでデバッグ
MicrofostのWindows用デバッガであるWinDbg Previewで動作確認をする。
以下からダウンロードしてインストール。
実行手順は以下の通り。
ファイル
-Start debugging
-Launch executable
から実行可能ファイル(exeファイル)を開くファイル
-Settings
-Debugging settings
-Debugging paths
-Default symbol path:
にpdbファイルがあるフォルダのフルパスを追記。Source
タブのOpen Source File...
からソースコードを開く。- 開かれたソースコード内の任意の行を右クリックし、
Insert or Remove Breakpoint
でブレークポイントを設定 Go
ボタンを押して実行
WIndows環境での問題点
WinDbgはソースファイルの拡張子がサポート対象のもの(.c
等)でないと、ソースコードを表示してくれない。
独自のプログラミング言語を作った場合、拡張子も独自のものにするはずなので、WinDbgでデバッグするのは非現実的。一応、拡張子さえあっていればファイルの中身は何でもいいようなのでできなくはないが、C言語でないのに拡張子を.c
にするのもいろいろと不都合があるので避けたい。
そのため、LLVMのlldb
コマンドでデバッグするのがよさそうだが、lldb
コマンドのWindowsのサポート状況(2020年8月現在)は開発中(still under development)なので、しばらく待つ必要がある。
gdbでデバッグ
Linux環境のgdbで確認した場合は問題なく独自のソースコードも表示でき、ブレークポイントも設定できた。
Linux環境でのビルド手順は以下の通り。
- 手書きで適当なデバッグ情報入りLLVM IRコードを書く。あるいは、適当なCのコードを
clang -O0 -g -S -emit-llvm example.c
でコンパイルする。 llc -filetpe=obj example.ll
でオブジェクトファイル(.o
ファイル)を作成clang example.o
で実行可能ファイルを作成(gcc example.o
でも可)
あとはgdb ./a.out
でデバッグを開始。
lldb ./a.out
でもできるはず。