调试 JIT 编译的代码¶
背景¶
如果没有特殊的运行时支持，调试动态生成的代码可能会非常痛苦。调试器通常从磁盘上的目标文件中读取调试信息，但对于 JIT 编译的代码，没有这样的文件可供查找。
为了移交必要的调试信息，GDB 建立了一个接口，用于向调试器注册 JIT 编译的代码。LLDB 在 JITLoaderGDB 插件中实现了它。在 JIT 方面，LLVM MCJIT 确实为 ELF 目标文件实现了该接口。
在高层次上，每当 MCJIT 生成新的机器代码时，它都会在一个内存中的目标文件中执行此操作，该文件包含 DWARF 格式的调试信息。然后，MCJIT 将此内存中的目标文件添加到动态生成的目标文件的全局列表中，并调用调试器知道的特殊函数 __jit_debug_register_code。当调试器附加到进程时，它会在该函数中设置一个断点，并将一个特殊的处理程序与之关联。一旦 MCJIT 调用注册函数，调试器就会捕获断点信号，从下级内存加载新的目标文件并恢复执行。这样，它就可以获得纯内存目标文件的调试信息。
GDB 版本¶
为了调试 LLVM JIT 编译的代码，您需要 GDB 7.0 或更高版本，这在大多数现代 Linux 发行版上都可用。Apple 随 Xcode 提供的 GDB 版本已冻结在 6.3 版本一段时间了。
LLDB 版本¶
由于 6.0 版本中的回归，LLDB 一段时间内不支持 JIT 编译的代码调试。该错误最近已在主线版本中修复，因此从即将发布的 12.0 版本开始，应该可以再次调试 JIT 编译的 ELF 对象。在 macOS 上，必须使用 plugin.jit-loader.gdb.enable 设置显式启用该功能。
调试 MCJIT 编译的代码¶
LLVM 新兴的 MCJIT 组件允许使用 GDB 完全调试 JIT 编译的代码。这是因为 MCJIT 能够使用 MC 发射器向 GDB 提供完整的 DWARF 调试信息。
请注意，必须将 --jit-kind=mcjit 标志传递给 lli，以便使用 MCJIT 而不是更新的 ORC JIT 来 JIT 编译代码。
示例¶
考虑以下 C 代码（添加了行号以使示例更易于理解）
1 int compute_factorial(int n)
2 {
3 if (n <= 1)
4 return 1;
5
6 int f = n;
7 while (--n > 1)
8 f *= n;
9 return f;
10 }
11
12
13 int main(int argc, char** argv)
14 {
15 if (argc < 2)
16 return -1;
17 char firstletter = argv[1][0];
18 int result = compute_factorial(firstletter - '0');
19
20 // Returned result is clipped at 255...
21 return result;
22 }
这是一个示例命令行会话，演示了如何在 LLDB 中通过 lli 构建和运行此代码
> export BINPATH=/workspaces/llvm-project/build/bin
> $BINPATH/clang -g -S -emit-llvm --target=x86_64-unknown-unknown-elf showdebug.c
> lldb $BINPATH/lli
(lldb) target create "/workspaces/llvm-project/build/bin/lli"
Current executable set to '/workspaces/llvm-project/build/bin/lli' (x86_64).
(lldb) settings set plugin.jit-loader.gdb.enable on
(lldb) b compute_factorial
Breakpoint 1: no locations (pending).
WARNING: Unable to resolve breakpoint to any actual locations.
(lldb) run --jit-kind=mcjit showdebug.ll 5
1 location added to breakpoint 1
Process 21340 stopped
* thread #1, name = 'lli', stop reason = breakpoint 1.1
frame #0: 0x00007ffff7fd0007 JIT(0x45c2cb0)`compute_factorial(n=5) at showdebug.c:3:11
1 int compute_factorial(int n)
2 {
-> 3 if (n <= 1)
4 return 1;
5 int f = n;
6 while (--n > 1)
7 f *= n;
(lldb) p n
(int) $0 = 5
(lldb) b showdebug.c:9
Breakpoint 2: where = JIT(0x45c2cb0)`compute_factorial + 60 at showdebug.c:9:1, address = 0x00007ffff7fd003c
(lldb) c
Process 21340 resuming
Process 21340 stopped
* thread #1, name = 'lli', stop reason = breakpoint 2.1
frame #0: 0x00007ffff7fd003c JIT(0x45c2cb0)`compute_factorial(n=1) at showdebug.c:9:1
6 while (--n > 1)
7 f *= n;
8 return f;
-> 9 }
10
11 int main(int argc, char** argv)
12 {
(lldb) p f
(int) $1 = 120
(lldb) bt
* thread #1, name = 'lli', stop reason = breakpoint 2.1
* frame #0: 0x00007ffff7fd003c JIT(0x45c2cb0)`compute_factorial(n=1) at showdebug.c:9:1
frame #1: 0x00007ffff7fd0095 JIT(0x45c2cb0)`main(argc=2, argv=0x00000000046122f0) at showdebug.c:16:18
frame #2: 0x0000000002a8306e lli`llvm::MCJIT::runFunction(this=0x000000000458ed10, F=0x0000000004589ff8, ArgValues=ArrayRef<llvm::GenericValue> @ 0x00007fffffffc798) at MCJIT.cpp:554:31
frame #3: 0x00000000029bdb45 lli`llvm::ExecutionEngine::runFunctionAsMain(this=0x000000000458ed10, Fn=0x0000000004589ff8, argv=size=0, envp=0x00007fffffffe140) at ExecutionEngine.cpp:467:10
frame #4: 0x0000000001f2fc2f lli`main(argc=4, argv=0x00007fffffffe118, envp=0x00007fffffffe140) at lli.cpp:643:18
frame #5: 0x00007ffff788c09b libc.so.6`__libc_start_main(main=(lli`main at lli.cpp:387), argc=4, argv=0x00007fffffffe118, init=<unavailable>, fini=<unavailable>, rtld_fini=<unavailable>, stack_end=0x00007fffffffe108) at libc-start.c:308:16
frame #6: 0x0000000001f2dc7a lli`_start + 42
(lldb) finish
Process 21340 stopped
* thread #1, name = 'lli', stop reason = step out
Return value: (int) $2 = 120
frame #0: 0x00007ffff7fd0095 JIT(0x45c2cb0)`main(argc=2, argv=0x00000000046122f0) at showdebug.c:16:9
13 if (argc < 2)
14 return -1;
15 char firstletter = argv[1][0];
-> 16 int result = compute_factorial(firstletter - '0');
17
18 // Returned result is clipped at 255...
19 return result;
(lldb) p result
(int) $3 = 73670648
(lldb) n
Process 21340 stopped
* thread #1, name = 'lli', stop reason = step over
frame #0: 0x00007ffff7fd0098 JIT(0x45c2cb0)`main(argc=2, argv=0x00000000046122f0) at showdebug.c:19:12
16 int result = compute_factorial(firstletter - '0');
17
18 // Returned result is clipped at 255...
-> 19 return result;
20 }
(lldb) p result
(int) $4 = 120
(lldb) expr result=42
(int) $5 = 42
(lldb) p result
(int) $6 = 42
(lldb) c
Process 21340 resuming
Process 21340 exited with status = 42 (0x0000002a)
(lldb) exit