◀返回
使用 GDB 调试原生可执行文件
使用哪个 GDB？
- 请使用 GDB 14.2 或更高版本。调试信息已通过
mx debuginfotest对 14.2 进行了测试。 - 请注意，更高版本可能对调试器输出的格式略有不同（例如，这可能导致 CI/CD 门禁检查失败）。
- 最近 Linux 版本中捆绑的 GDB 完全适用于调试会话。
构建带有调试信息的本地可执行文件
要构建带有调试信息的本地可执行文件，请在编译应用程序时为 javac 提供 -g 命令行选项，然后将其提供给 native-image 构建器。这可以启用源级调试，调试器 (GDB) 随后会将机器指令与 Java 文件中的特定源代码行关联起来。
将 -g 添加到 native-image 参数会导致生成调试信息。在本地可执行文件旁边，会有一个包含调试信息的 <executable_name>.debug 文件和一个包含 Java 源文件的 sources/ 目录，调试器会使用这些文件来显示行信息的源。例如
hello_image
hello_image.debug
sources
GDB 会自动为给定的本地可执行文件 <executable_name> 加载 <executable_name>.debug 文件。（本地可执行文件与其 *.debug 文件之间存在链接。）
为了获得更好的调试体验，我们建议将
-g与-O0结合使用。后者选项会禁用 Graal 编译器的内联和其他优化，否则这些优化会在调试器中可见（例如，调试器可能会在行之间来回跳转，而不是允许您从一行单步执行到下一行）。同时，-O0还会启用在编译器中收集额外的元数据，这有助于调试器解析（例如）局部变量。
将 GDB 与新调试信息一起使用
构建信息
*.debug 文件包含有关构建的额外信息，可以按如下方式访问
readelf -p .debug.svm.imagebuild.classpath hello_image.debug
它列出了用于构建本地可执行文件的所有类路径条目。
String dump of section '.debug.svm.imagebuild.classpath':
[ 0] /home/user/.mx/cache/HAMCREST_e237ae735aac4fa5a7253ec693191f42ef7ddce384c11d29fbf605981c0be077d086757409acad53cb5b9e53d86a07cc428d459ff0f5b00d32a8cbbca390be49/hamcrest.jar
[ b0] /home/user/.mx/cache/JUNIT_5974670c3d178a12da5929ba5dd9b4f5ff461bdc1b92618c2c36d53e88650df7adbf3c1684017bb082b477cb8f40f15dcf7526f06f06183f93118ba9ebeaccce/junit.jar
[ 15a] /home/user/mx/mxbuild/jdk20/dists/jdk9/junit-tool.jar
[ 1a9] /home/user/graal/substratevm/mxbuild/jdk20/com.oracle.svm.test/bin
以下部分可用
- .debug.svm.imagebuild.classpath
- .debug.svm.imagebuild.modulepath
- .debug.svm.imagebuild.arguments
- .debug.svm.imagebuild.java.properties
main() 方法在哪里？
使用
info functions ::main
查找所有名为 main 的方法，然后使用 b <main method name>，例如
(gdb) info functions ::main
All functions matching regular expression "::main":
File hello/Hello.java:
76: void hello.Hello::main(java.lang.String[]*);
File java/util/Timer.java:
534: void java.util.TimerThread::mainLoop();
(gdb) b 'hello.Hello::main'
Breakpoint 1 at 0x83c030: file hello/Hello.java, line 76.
设置断点
首先，找到要设置断点的方法类型，例如
(gdb) info types ArrayList
All types matching regular expression "ArrayList":
...
File java/util/ArrayList.java:
java.util.ArrayList;
java.util.ArrayList$ArrayListSpliterator;
java.util.ArrayList$Itr;
java.util.ArrayList$ListItr;
...
现在使用以下 GDB 自动补全
(gdb) b 'java.util.ArrayList::
现在按两次 Tab 键会显示所有 ArrayList 方法供选择。
java.util.ArrayList::ArrayList(int) java.util.ArrayList::iterator()
java.util.ArrayList::ArrayList(java.util.Collection*) java.util.ArrayList::lastIndexOf(java.lang.Object*)
java.util.ArrayList::add(int, java.lang.Object*) java.util.ArrayList::lastIndexOfRange(java.lang.Object*, int, int)
java.util.ArrayList::add(java.lang.Object*) java.util.ArrayList::listIterator()
java.util.ArrayList::add(java.lang.Object*, java.lang.Object[]*, int) java.util.ArrayList::listIterator(int)
java.util.ArrayList::addAll(int, java.util.Collection*) java.util.ArrayList::nBits(int)
java.util.ArrayList::addAll(java.util.Collection*) java.util.ArrayList::outOfBoundsMsg(int)
...
如果用以下内容完成
(gdb) b 'java.util.ArrayList::add`
则安装所有 add 变体中的断点。
数组
数组有一个 data 字段，可以通过索引访问以获取单个数组元素，例如
Thread 1 "hello_image" hit Breakpoint 1, hello.Hello::main(java.lang.String[]*) (args=0x7ff33f800898) at hello/Hello.java:76
76 Greeter greeter = Greeter.greeter(args);
(gdb) p args
$1 = (java.lang.String[] *) 0x7ff33f800898
(gdb) p *args
$2 = {
<java.lang.Object> = {
<_objhdr> = {
hub = 0x1e37be0
}, <No data fields>},
members of java.lang.String[]:
len = 4,
data = 0x7ff33f8008a0
}
(gdb) p args.data
$3 = 0x7ff33f8008a0
(gdb) ptype args.data
type = class _z_.java.lang.String : public java.lang.String {
} *[0]
此处 args.data 可以通过索引访问。
在此示例中，四个数组元素中的第一个是指向 String 的指针。
(gdb) p args.data[0]
$4 = (_z_.java.lang.String *) 0x27011a
字符串
要查看 Java String 对象的实际内容，请查看其 value 字段，例如
(gdb) p args.data[0]
$4 = (_z_.java.lang.String *) 0x27011a
args.data[0] 指向一个 String 对象。我们来解引用。
(gdb) p *args.data[0]
$5 = {
<java.lang.String> = {
<java.lang.Object> = {
<_objhdr> = {
hub = 0x1bb4780
}, <No data fields>},
members of java.lang.String:
value = 0x270118,
hash = 0,
coder = 0 '\000',
hashIsZero = false,
static CASE_INSENSITIVE_ORDER = 0x19d752,
...
static COMPACT_STRINGS = true
}, <No data fields>}
value 字段保存 String 数据。我们来检查 value 的类型。
(gdb) p args.data[0].value
$3 = (_z_.byte[] *) 0x250119
value 的类型是 byte[]。
如您之前所学，数组的元素可以通过其 data 字段访问。
(gdb) p args.data[0].value.data
$10 = 0x7ff33f8008c8 "this\376\376\376\376\200G\273\001\030\001'"
GDB 足够智能，可以开箱即用地将字节指针解释为 C 字符串。但本质上，它是一个数组。以下内容为我们提供了 this 中的 t。
(gdb) p args.data[0].value.data[0]
$13 = 116 't'
最后一个字符后面的垃圾数据的原因是 Java String 值不是以 0 终止的（与 C 字符串不同）。要了解垃圾数据从何处开始，可以检查 len 字段。
(gdb) p args.data[0].value.len
$14 = 4
向下转型
假设您的源代码使用静态类型为 Greeter 的变量，并且您想要检查其数据。
75 public static void main(String[] args) {
76 Greeter greeter = Greeter.greeter(args);
77 greeter.greet(); // Here you might have a NamedGreeter
如您所见，当前 GDB 在第 77 行只知道 greeter 的静态类型。
Thread 1 "hello_image" hit Breakpoint 2, hello.Hello::main(java.lang.String[]*) (args=<optimized out>) at hello/Hello.java:77
77 greeter.greet();
(gdb) p greeter
$17 = (hello.Hello$Greeter *) 0x7ff7f9101208
此外，您无法看到只存在于 NamedGreeter 子类中的字段。
(gdb) p *greeter
$18 = {
<java.lang.Object> = {
<_objhdr> = {
hub = 0x1d1cae0
}, <No data fields>}, <No data fields>}
但是您确实有 hub 字段，它指向对象的类对象。因此，它允许您确定地址 0x7ff7f9101208 处 Greeter 对象的运行时类型。
(gdb) p greeter.hub
$19 = (_z_.java.lang.Class *) 0x1d1cae0
(gdb) p *greeter.hub
$20 = {
<java.lang.Class> = {
<java.lang.Object> = {
<_objhdr> = {
hub = 0x1bec910
}, <No data fields>},
members of java.lang.Class:
typeCheckStart = 1188,
name = 0xb94a2, <<<< WE ARE INTERESTED IN THIS FIELD
superHub = 0x90202,
...
monitorOffset = 8,
optionalIdentityHashOffset = 12,
flags = 0,
instantiationFlags = 3 '\003'
}, <No data fields>}
(gdb) p greeter.hub.name
$21 = (_z_.java.lang.String *) 0xb94a2
(gdb) p greeter.hub.name.value.data
$22 = 0x7ff7f80705b8 "hello.Hello$NamedGreeter\351\001~*"
因此，您了解到该对象的实际类型是 hello.Hello$NamedGreeter。
现在转换为该类型。
(gdb) set $rt_greeter = ('hello.Hello$NamedGreeter' *) greeter
现在您可以检查向下转型的便捷变量 rt_greeter。
(gdb) p $rt_greeter
$23 = (hello.Hello$NamedGreeter *) 0x7ff7f9101208
(gdb) p *$rt_greeter
$24 = {
<hello.Hello$Greeter> = {
<java.lang.Object> = {
<_objhdr> = {
hub = 0x1d1cae0
}, <No data fields>}, <No data fields>},
members of hello.Hello$NamedGreeter:
name = 0x270119
}
现在您可以看到只存在于 NamedGreeter 子类型中的 name 字段。
(gdb) p $rt_greeter.name
$25 = (_z_.java.lang.String *) 0x270119
因此 name 字段的类型是 String。您已经知道如何查看 String 的内容。
(gdb) p $rt_greeter.name.value.data
$26 = 0x7ff7f91008c0 "FooBar\376\376\200G\273\001\027\001'"
注意：如果您要向下转型的静态类型是压缩引用，那么向下转型中使用的类型也需要是压缩引用类型。
例如，如果您有
(gdb) p elementData.data[0]
$38 = (_z_.java.lang.Object *) 0x290fcc
在 ArrayList 的内部数组中，第一个条目指向一个带有 _z_. 前缀的 java.lang.Object，表示这是一个压缩引用。
要检查该对象的运行时类型是什么，请使用
(gdb) p elementData.data[0].hub.name.value.data
$40 = 0x7ff7f8665600 "java.lang.String=\256\271`"
现在您知道压缩引用实际上指向一个 java.lang.String。
然后，当您进行类型转换时，不要忘记使用 _z_. 前缀。
(gdb) p ('_z_.java.lang.String' *) elementData.data[0]
$41 = (_z_.java.lang.String *) 0x290fcc
(gdb) p *$41
$43 = {
<java.lang.String> = {
<java.lang.Object> = {
<_objhdr> = {
hub = 0x1bb4780
}, <No data fields>},
members of java.lang.String:
value = 0x290fce,
...
要查看该 String 的内容，再次使用
(gdb) p $41.value.data
$44 = 0x7ff7f9207e78 "#subsys_name\thierarchy\tnum_cgroups\tenabled"
在实例方法中使用 this 变量
(gdb) bt
#0 hello.Hello$NamedGreeter::greet() (this=0x7ff7f9101208) at hello/Hello.java:71
#1 0x000000000083c060 in hello.Hello::main(java.lang.String[]*) (args=<optimized out>) at hello/Hello.java:77
#2 0x0000000000413355 in com.oracle.svm.core.JavaMainWrapper::runCore0() () at com/oracle/svm/core/JavaMainWrapper.java:178
#3 0x00000000004432e5 in com.oracle.svm.core.JavaMainWrapper::runCore() () at com/oracle/svm/core/JavaMainWrapper.java:136
#4 com.oracle.svm.core.JavaMainWrapper::doRun(int, org.graalvm.nativeimage.c.type.CCharPointerPointer*) (argc=<optimized out>, argv=<optimized out>) at com/oracle/svm/core/JavaMainWrapper.java:233
#5 com.oracle.svm.core.JavaMainWrapper::run(int, org.graalvm.nativeimage.c.type.CCharPointerPointer*) (argc=<optimized out>, argv=<optimized out>) at com/oracle/svm/core/JavaMainWrapper.java:219
#6 com.oracle.svm.core.code.IsolateEnterStub::JavaMainWrapper_run_e6899342f5939c89e6e2f78e2c71f5f4926b786d(int, org.graalvm.nativeimage.c.type.CCharPointerPointer*) (__0=<optimized out>, __1=<optimized out>)
at com/oracle/svm/core/code/IsolateEnterStub.java:1
(gdb) p this
$1 = (hello.Hello$NamedGreeter *) 0x7ff7f9001218
(gdb) p *this
$2 = {
<hello.Hello$Greeter> = {
<java.lang.Object> = {
<_objhdr> = {
hub = 0x1de2260
}, <No data fields>}, <No data fields>},
members of hello.Hello$NamedGreeter:
name = 0x25011b
}
(gdb) p this.name
$3 = (_z_.java.lang.String *) 0x270119
就像在 Java 或 C++ 代码中一样，在实例方法中，不需要加 this. 前缀。
(gdb) p name
$7 = (_z_.java.lang.String *) 0x270119
(gdb) p name.value.data
$8 = 0x7ff7f91008c0 "FooBar\376\376\200G\273\001\027\001'"
访问静态字段
虽然在打印对象实例时会显示静态字段，但您只想查看特定静态字段的值。
(gdb) p 'java.math.BigDecimal::BIG_TEN_POWERS_TABLE'
$23 = (_z_.java.math.BigInteger[] *) 0x132b95
要获取所有静态字段的列表，请使用
(gdb) info variables ::
检查 .class 对象
对于镜像中的每个 Java 类型，都有一种简单的方法来访问其类对象（也称为 hub）。
(gdb) info types PrintStream
All types matching regular expression "PrintStream":
...
File java/io/PrintStream.java:
java.io.PrintStream;
java.io.PrintStream$1;
...
要访问 java.io.PrintStream 的 hub，可以使用 .class 后缀
(gdb) p 'java.io.PrintStream.class'
$4 = {
<java.lang.Object> = {
<_objhdr> = {
hub = 0x1bec910
}, <No data fields>},
members of java.lang.Class:
typeCheckStart = 1340,
name = 0xbab58,
superHub = 0x901ba,
...
sourceFileName = 0xbab55,
classInitializationInfo = 0x14d189,
module = 0x14cd8d,
nestHost = 0xde78d,
simpleBinaryName = 0x0,
companion = 0x149856,
signature = 0x0,
...
}
例如，这允许您检查 java.io.PrintStream 属于哪个模块。
(gdb) p 'java.io.PrintStream.class'.module.name.value.data
$12 = 0x7ff7f866b000 "java.base"
内联方法
在 PrintStream.writeln 中设置断点
(gdb) b java.io.PrintStream::writeln
Breakpoint 2 at 0x4080cb: java.io.PrintStream::writeln. (35 locations)
现在您导航到
(gdb) bt
#0 java.io.BufferedWriter::min(int, int) (this=<optimized out>, a=8192, b=14) at java/io/BufferedWriter.java:216
#1 java.io.BufferedWriter::implWrite(java.lang.String*, int, int) (this=0x7ff7f884e828, s=0x7ff7f9101230, off=<optimized out>, len=<optimized out>) at java/io/BufferedWriter.java:329
#2 0x000000000084c50d in java.io.BufferedWriter::write(java.lang.String*, int, int) (this=<optimized out>, s=<optimized out>, off=<optimized out>, len=<optimized out>) at java/io/BufferedWriter.java:313
#3 0x0000000000901369 in java.io.Writer::write(java.lang.String*) (this=<optimized out>, str=<optimized out>) at java/io/Writer.java:278
#4 0x00000000008df465 in java.io.PrintStream::implWriteln(java.lang.String*) (this=0x7ff7f87e67b8, s=<optimized out>) at java/io/PrintStream.java:846
#5 0x00000000008e10a5 in java.io.PrintStream::writeln(java.lang.String*) (this=0x7ff7f87e67b8, s=<optimized out>) at java/io/PrintStream.java:826
#6 0x000000000083c00c in java.io.PrintStream::println(java.lang.String*) (this=<optimized out>, x=<optimized out>) at java/io/PrintStream.java:1168
#7 hello.Hello$NamedGreeter::greet() (this=<optimized out>) at hello/Hello.java:71
#8 0x000000000083c060 in hello.Hello::main(java.lang.String[]*) (args=<optimized out>) at hello/Hello.java:77
#9 0x0000000000413355 in com.oracle.svm.core.JavaMainWrapper::runCore0() () at com/oracle/svm/core/JavaMainWrapper.java:178
#10 0x00000000004432e5 in com.oracle.svm.core.JavaMainWrapper::runCore() () at com/oracle/svm/core/JavaMainWrapper.java:136
#11 com.oracle.svm.core.JavaMainWrapper::doRun(int, org.graalvm.nativeimage.c.type.CCharPointerPointer*) (argc=<optimized out>, argv=<optimized out>) at com/oracle/svm/core/JavaMainWrapper.java:233
#12 com.oracle.svm.core.JavaMainWrapper::run(int, org.graalvm.nativeimage.c.type.CCharPointerPointer*) (argc=<optimized out>, argv=<optimized out>) at com/oracle/svm/core/JavaMainWrapper.java:219
#13 com.oracle.svm.core.code.IsolateEnterStub::JavaMainWrapper_run_e6899342f5939c89e6e2f78e2c71f5f4926b786d(int, org.graalvm.nativeimage.c.type.CCharPointerPointer*) (__0=<optimized out>, __1=<optimized out>)
at com/oracle/svm/core/code/IsolateEnterStub.java:1
如果您查询顶层帧的额外信息，您会看到 min 已内联到 implWrite 中。
(gdb) info frame
Stack level 0, frame at 0x7fffffffdb20:
rip = 0x84af8a in java.io.BufferedWriter::min(int, int) (java/io/BufferedWriter.java:216); saved rip = 0x84c50d
inlined into frame 1
source language unknown.
Arglist at unknown address.
Locals at unknown address, Previous frame's sp in rsp
现在单步进入 min 的使用点，您会看到 min 返回了值 14（正如预期）。
(gdb) bt
#0 java.lang.String::getChars(int, int, char[]*, int) (this=0x7ff7f9101230, srcBegin=0, srcEnd=14, dst=0x7ff7f858ac58, dstBegin=0) at java/lang/String.java:1688
#1 java.io.BufferedWriter::implWrite(java.lang.String*, int, int) (this=0x7ff7f884e828, s=0x7ff7f9101230, off=<optimized out>, len=<optimized out>) at java/io/BufferedWriter.java:330
...
在调试期间调用 svm_dbg_ 辅助函数
当镜像使用 -H:+IncludeDebugHelperMethods 构建时，会定义额外的 @CEntryPoint 函数，这些函数可以在调试期间从 GDB 调用，例如
(gdb) p greeter
$3 = (hello.Hello$Greeter *) 0x7ffff6881900
这里，您再次有一个名为 greeter 的局部变量，其静态类型为 hello.Hello$Greeter。要查看其运行时类型，您可以使用上面已描述的方法。
或者，您可以使用 svm_dbg_ 辅助函数。例如，在正在运行的调试会话中，您可以调用
void svm_dbg_print_hub(graal_isolatethread_t* thread, size_t hubPtr)
您必须传递 graal_isolatethread_t 的值以及您要打印的 hub 的绝对地址。在大多数情况下，graal_isolatethread_t 的值就是当前 IsolateThread 的值，可以在特定于平台的寄存器中找到。
| 平台 | 寄存器 |
|---|---|
amd64 |
$r15 |
aarch64 |
$r28 |
最后，在您可以调用 svm_dbg_print_hub 之前，请确保您拥有要打印的 hub 的绝对地址。使用
(gdb) p greeter.hub
$4 = (_z_.java.lang.Class *) 0x837820 <java.io.ObjectOutputStream::ObjectOutputStream(java.io.OutputStream*)+1120>
显示在当前情况下，greeter 中的 hub 字段包含对 hub 的压缩引用（hub-type 前缀为 _z_.）。因此，您首先需要使用另一个 svm_dbg_ 辅助方法获取 hub 字段的绝对地址。
(gdb) call svm_dbg_obj_uncompress($r15, greeter.hub)
$5 = 140737339160608
(gdb) p/x $5
$6 = 0x7ffff71b7820
在调用 svm_dbg_obj_uncompress 的帮助下，您现在知道 hub 位于地址 0x7ffff71b7820，并且最终可以调用 svm_dbg_print_hub。
(gdb) call (void) svm_dbg_print_hub($r15, 0x7ffff71b7820)
hello.Hello$NamedGreeter
这两个对 svm_dbg_ 辅助函数的调用可以组合成一个命令行。
(gdb) call (void) svm_dbg_print_hub($r15, svm_dbg_obj_uncompress($r15, greeter.hub))
hello.Hello$NamedGreeter
当前定义了以下 svm_dbg_ 辅助方法
int svm_dbg_ptr_isInImageHeap(graal_isolatethread_t* thread, size_t ptr);
int svm_dbg_ptr_isObject(graal_isolatethread_t* thread, size_t ptr);
int svm_dbg_hub_getLayoutEncoding(graal_isolatethread_t* thread, size_t hubPtr);
int svm_dbg_hub_getArrayElementSize(graal_isolatethread_t* thread, size_t hubPtr);
int svm_dbg_hub_getArrayBaseOffset(graal_isolatethread_t* thread, size_t hubPtr);
int svm_dbg_hub_isArray(graal_isolatethread_t* thread, size_t hubPtr);
int svm_dbg_hub_isPrimitiveArray(graal_isolatethread_t* thread, size_t hubPtr);
int svm_dbg_hub_isObjectArray(graal_isolatethread_t* thread, size_t hubPtr);
int svm_dbg_hub_isInstance(graal_isolatethread_t* thread, size_t hubPtr);
int svm_dbg_hub_isReference(graal_isolatethread_t* thread, size_t hubPtr);
long long int svm_dbg_obj_getHub(graal_isolatethread_t* thread, size_t objPtr);
long long int svm_dbg_obj_getObjectSize(graal_isolatethread_t* thread, size_t objPtr);
int svm_dbg_obj_getArrayElementSize(graal_isolatethread_t* thread, size_t objPtr);
long long int svm_dbg_obj_getArrayBaseOffset(graal_isolatethread_t* thread, size_t objPtr);
int svm_dbg_obj_isArray(graal_isolatethread_t* thread, size_t objPtr);
int svm_dbg_obj_isPrimitiveArray(graal_isolatethread_t* thread, size_t objPtr);
int svm_dbg_obj_isObjectArray(graal_isolatethread_t* thread, size_t objPtr);
int svm_dbg_obj_isInstance(graal_isolatethread_t* thread, size_t objPtr);
int svm_dbg_obj_isReference(graal_isolatethread_t* thread, size_t objPtr);
long long int svm_dbg_obj_uncompress(graal_isolatethread_t* thread, size_t compressedPtr);
long long int svm_dbg_obj_compress(graal_isolatethread_t* thread, size_t objPtr);
int svm_dbg_string_length(graal_isolatethread_t* thread, size_t strPtr);
void svm_dbg_print_hub(graal_isolatethread_t* thread, size_t hubPtr);
void svm_dbg_print_obj(graal_isolatethread_t* thread, size_t objPtr);
void svm_dbg_print_string(graal_isolatethread_t* thread, size_t strPtr);
void svm_dbg_print_fatalErrorDiagnostics(graal_isolatethread_t* thread, size_t sp, void * ip);
void svm_dbg_print_locationInfo(graal_isolatethread_t* thread, size_t mem);