DWARF

Table of Contents

1. DWARF

1.1. Overview

Dwarf 用来在 ELF 中附加调试信息, 与 STAB 功能类似

Dwarf 在 ELF 中主要包含两部分:

  1. .debug_frame section

    .debug_frame 包含的是 CIE 和 FDE 项, 和 frame unwinding 有关, 例如: 当前 frame 各个寄存器的值是多少, 如何找到上一个 frame

  2. .debug_info section

    .debug_info 中包含许多 DIE 项, 针对的是源码级别的调试信息, 例如变量的类型, 所在的文件和行号, 保存在栈上的位置或在哪个寄存器中

1.2. debug_frame 与 frame unwinding

1.2.1. 测试代码

// 2018-12-18 09:13

int __attribute__((noinline))bar(int xxx) {
    abort();
    return xxx + 1;
}
void __attribute__((noinline)) foo (int xxx) {
    int yyy = 0x1234;
    xxx += 1;
    printf("%d\n", bar(xxx));
}

int main(int argc, char *argv[]) {
    int x = 0;
    scanf("%d", &x);
    /* 这里 x 从 scanf 中得到, 是为了防止 x 被优化为常量 */
    foo(x);
}

$> aarch64-linux-gnu-gcc test.c -O2 -g3 -static
$> qemu-aarch64-static ./a.out
$> aarch64-linux-gnu-objdum -W ./a.out > dwarf_dump

1.2.2. CIE 和 FDE

  • CIE

    CIE 为 Common Info Entry, 可以认为是把多个 FDE 中相同的部分提取出来得到的, Dwarf 在解析 FDE 时, 会先解析它对应的 CIE, 例如: 

    00000a38 000000000000000c ffffffff CIE
Version:               1
Augmentation:          ""
Code alignment factor: 4
Data alignment factor: -8
Return address column: 30

DW_CFA_def_cfa: r31 (sp) ofs 0
    • Return address column: 30 表示 frame 上保存的返回地址在 30 号 dwarf 寄存器上 (aarch64 即 x30)
    • DW_CFA_def_cfa: r31 (sp) ofs 0 表示 CFA 初始设为 sp+0.

  • CFA

    CFA 即 Canonical Frame Address, 表示当前 frame 的基址, 它是 dwarf 虚拟的寄存器, 作用和 frame register 类似 (ebp, x29 等)

  • FDE 

    00000a48 000000000000002c 00000a38 FDE cie=00000a38 pc=00000000004057b8..0000000000405ac0
  DW_CFA_advance_loc: 4 to 00000000004057bc
  DW_CFA_def_cfa_offset: 336
  DW_CFA_offset: r29 (x29) at cfa-336
  DW_CFA_offset: r30 (x30) at cfa-328
  DW_CFA_advance_loc: 4 to 00000000004057c0
  DW_CFA_def_cfa_register: r29 (x29)
  DW_CFA_advance_loc: 4 to 00000000004057c4
  DW_CFA_offset: r19 (x19) at cfa-320
  DW_CFA_offset: r20 (x20) at cfa-312
  DW_CFA_advance_loc: 24 to 00000000004057dc
  DW_CFA_offset: r21 (x21) at cfa-304
  DW_CFA_nop
  DW_CFA_nop
  DW_CFA_nop
  DW_CFA_nop
  DW_CFA_nop

    • FDE 可以抽象的表示为: 

      LOC CFA R0 R1 ... RN
L0
L1
...
LN

      因为代码执行到不同的 pc 值可能对应不同的寄存器值. 例如, x20 初始并没有保存在栈上, 当 pc 执行到 0x00000000004057c4 时才将 x20 保存在栈上. 或者在整个函数执行过程中, 有可能 x20 会被多次保存在栈上不同的位置. 所以需要多行对应不同的 LOC

    • cie=00000a38, 表示它的 CIE 的 id 为 a38

    • pc=00000000004057b8..0000000000405ac0 表示这个 frame 对应的代码, 实际上它对应 abort 函数 

      Dump of assembler code for function abort:
   0x00000000004057b8 <+0>:     stp     x29, x30, [sp, #-336]!
   0x00000000004057bc <+4>:     mov     x29, sp
   0x00000000004057c0 <+8>:     stp     x19, x20, [sp, #16]
   0x00000000004057c4 <+12>:    adrp    x19, 0x492000 <_dl_main_map+712>
   0x00000000004057c8 <+16>:    add     x0, x19, #0xcc0
   0x00000000004057cc <+20>:    mrs     x20, tpidr_el0
   0x00000000004057d0 <+24>:    sub     x20, x20, #0x6f0
   ...
    • DW_CFA_advance_loc: 4 to 00000000004057bc, 表示针对 0x00000000004057bc 地址插入新的一行
    • DW_CFA_def_cfa_offset: 336, 设置 CFA 的值为 CFA+336, 由于之前 CFA 为 SP, 所以 CFA 会指向 frame 的栈基址
    • DW_CFA_def_cfa_register: r29 (x29), 设置 CFA 为 x29 的值
    • DW_CFA_offset: r20 (x20) at cfa-312, 表示 x20 保存在 CFA-312 位置

1.2.3. 使用 CFI 进行 stack unwinding

  1. 根据当前 pc 找到对应的 FDE
  2. 若当前为栈顶, 则解析 FDE 对应的 CIE, 例如把 CFA 设置为 sp, 找到 Return PC 保存在哪个寄存器, 例如 x30
  3. 若当前不是栈顶, 则 CFA 使用上一次计算的结果即可
  4. 解析 FDE, 计算当前 frame 的 CFA, 根据 CFA 计算上一个 frame 的信息: 保存的寄存器, Return PC
  5. 根据 Return PC 重复步骤 1

1.2.4. gcc omit-frame-pointer

有了 CFI, Dwarf 不需要 frame pointer 就可以进行 stack unwinding, 以上面的 FDE 为例, 关键在于 `DW_CFA_def_cfa_offset: 336`, 其中的 336 表示栈基址在当前栈顶 + 336 处, 336 是编译时就确定的 frame 大小, 因此 frame pointer 不是必需的.

1.2.5. gdb info reg

gdb info reg 可以显示每个 frame 的寄存器, 但从前面的 FDE 能看到, 许多寄存器并没有保存, 因此 info reg 并不能确定某个 frame 里 `每一个` 寄存器的值. 通过 FDE 中 DW_CFA_offset 及 gdb info frame 可以确定哪些寄存器被保存了

1.2.6. example

$>gdb ./a.out
(gdb) core qemu_a.out.core
(gdb) bt
#0  0x00000000004056b8 in raise (sig=sig@entry=6) at ../sysdeps/unix/sysv/linux/raise.c:55
#1  0x0000000000405968 in abort () at abort.c:89
#2  0x0000000000400b0c in bar (xxx=<optimized out>) at test.c:9
#3  0x0000000000400b20 in foo (xxx=<optimized out>) at test.c:15
#4  0x000000000040096c in main (argc=<optimized out>, argv=<optimized out>) at test.c:21
(gdb) i f 1
Stack frame at 0x40007ff950:
 pc = 0x405968 in abort (abort.c:89); saved pc = 0x400b0c
 called by frame at 0x40007ff960, caller of frame at 0x40007ff800
 source language c.
 Arglist at 0x40007ff800, args:
 Locals at 0x40007ff800, Previous frame's sp is 0x40007ff950
 Saved registers:
  x19 at 0x40007ff810, x20 at 0x40007ff818, x21 at 0x40007ff820, x29 at 0x40007ff800, x30 at 0x40007ff808
(gdb) p $sp
$14 = (void *) 0x40007ff800

;; DW_CFA_def_cfa_offset: 336
(gdb) p /x $sp+336
$15 = 0x40007ff950
;; 0x40007ff950 是当前 frame 的栈基址

;; DW_CFA_offset: r20 (x20) at cfa-312
(gdb) p /x $sp+336-312
$16 = 0x40007ff818
;; x20 保存在 0x40007ff818
(gdb) x /x 0x40007ff818
0x40007ff818:   0x00401138

;; up 到上一个 frame 时能得到正确的 x20, 因为它被保存在栈上了
(gdb) p /x $x20
$18 = 0x494000
(gdb) up
#2  0x0000000000400b0c in bar (xxx=<optimized out>) at test.c:9
9           abort();
(gdb) p /x $x20
$19 = 0x401138

1.3. debug_info 与源码级别调试

1.3.1. 测试代码

// 2018-12-18 09:13

int __attribute__((noinline)) bar(int xxx) {
    abort();
    return xxx + 1;
}
void __attribute__((noinline)) foo (int xxx) {
    int yyy = 0x1234;
    xxx += 1;
    printf("%d\n", bar(xxx));
}

int main(int argc, char *argv[]) {
    foo(127);
}


$> aarch64-linux-gnu-gcc test.c -O0 -g3

1.3.2. DIE

DIE 即 Debugging Info Entry, 以上面的 foo 函数为例, 其 DIE 为: 

< 1><0x000000bb>    DW_TAG_subprogram
                      DW_AT_external              yes(1)
                      DW_AT_name                  foo
                      DW_AT_decl_file             0x00000001 /home/sunway/test.c
                      DW_AT_decl_line             0x0000000c
                      DW_AT_prototyped            yes(1)
                      DW_AT_low_pc                0x00400590
                      DW_AT_high_pc               <offset-from-lowpc>68
                      DW_AT_frame_base            len 0x0001: 9c: DW_OP_call_frame_cfa
                      DW_AT_GNU_all_tail_call_sites yes(1)
                      DW_AT_sibling               <0x000000f5>
< 2><0x000000d8>      DW_TAG_formal_parameter
                        DW_AT_name                  xxx
                        DW_AT_decl_file             0x00000001 /home/sunway/test.c
                        DW_AT_decl_line             0x0000000c
                        DW_AT_type                  <0x00000046>
                        DW_AT_location              len 0x0002: 916c: DW_OP_fbreg -20
< 2><0x000000e6>      DW_TAG_variable
                        DW_AT_name                  yyy
                        DW_AT_decl_file             0x00000001 /home/sunway/test.c
                        DW_AT_decl_line             0x0000000d
                        DW_AT_type                  <0x00000046>
                        DW_AT_location              len 0x0002: 917c: DW_OP_fbreg -4
  • DW_TAG_subprogram 表示函数, 包含名字, 所在文件, 行号, PC 范围, 以及参数, 变量等
  • DW_TAG_formal_parameter 表示参数, 其中 DW_AT_location 表示参数保存在哪里, DW_OP_fbreg -20 表示 CFA - 20 这个地址保存着参数. 除了 DW_OP_fbreg, 常用的还有 DW_OP_breg, DW_OP_reg, 以及更复杂的 dwarf expression
  • DW_AT_location 是 DW_OP_reg 时表示变量保存在寄存器中, 而不是通过寄存器指示的内存地址
  • DW_AT_location 可能不存在, 例如变量被优化编译器优化掉
$> aarch64-linux-gnu-gcc test.c -O2 -g3
$> dwarfdump a.out
< 2><0x000002ef>      DW_TAG_formal_parameter
                        DW_AT_name                  xxx
                        DW_AT_decl_file             0x00000001 /home/sunway/test.c
                        DW_AT_decl_line             0x0000000c
                        DW_AT_type                  <0x0000004d>
                        DW_AT_location              <loclist at offset 0x00000039 with 4 entries follows>
                        [ 0]< offset pair low-off : 0x00400550 addr  0x00400550 high-off  0x00400550 addr 0x00400550>DW_OP_reg0
                        [ 1]< offset pair low-off : 0x00400550 addr  0x00400550 high-off  0x00400558 addr 0x00400558>DW_OP_breg0+1 DW_OP_stack_value
                        [ 2]< offset pair low-off : 0x00400558 addr  0x00400558 high-off  0x0040055f addr 0x0040055f>DW_OP_reg0
                        [ 3]< offset pair low-off : 0x0040055f addr  0x0040055f high-off  0x00400560 addr 0x00400560>DW_OP_GNU_entry_value 0x00000001 contents 0x50 DW_OP_plus_uconst 1 DW_OP_stack_value
< 2><0x000002fe>      DW_TAG_variable
                        DW_AT_name                  yyy
                        DW_AT_decl_file             0x00000001 /home/sunway/test.c
                        DW_AT_decl_line             0x0000000d
                        DW_AT_type                  <0x0000004d>
                        DW_AT_const_value           4660

使用 O2 编译后, xxx 初始通过 DW_OP_reg0 被保存在 reg0 中, 然后在下一个 LOC 为 DW_OP_breg0+1 DW_OP_stack_value, 对应源码中的 `xxx+=1`, 该 Dwarf expression 的意义为:

  1. 取 reg0 的值后加 1

  2. 通过 DW_OP_stack_value 从 dwarf 表达式栈上取值, 并作为变量的`值`而不是`变量保存的地址` 

    DW_OP_stack_value

The DW_OP_stack_value operation specifies that the object does not exist in memory but its
value is nonetheless known and is at the top of the DWARF expression stack. In this form of
location description, the DWARF expression represents the actual value of the object, rather
than its location. The DW_OP_stack_value operation terminates the expression.

需要注意的是, 当优化编译器把变量放在寄存器上时, 虽然 DIE 有足够的信息, 但可能后面 FDE 并无法恢复相应的寄存器的值, 导致调试时还是无法得到相应的变量的值 (gdb 显示为 <optimized out>)

1.4. DWARF 表达式

dwarf 表达式的思想与 BPF 及 seccomp 类似: 通过一个小型的解释器, 达到比普通配置更大的灵活性.

Backlinks

Backtrace (Backtrace > unwind_backtrace > 基于 dwarf): DWARF

GCC Toy RISC-V Backend (GCC Toy RISC-V Backend > toy-20: add dwarf info): backend 可以在汇编中插入 cfi (call frame info) directive, 然后 assembler 可以根 据这些 directive 生成 dwarf 的信息 (gas cfi directives). gcc 编译时是否生成 cfi directive 取决于当前使用的 assember 是否支持这些 directive, 所以需要通过 DEFAULT_ASSEMBLER 指定 as 后才能生成 directive.

GDB Target Arch (GDB Target Arch > Overview): 1. symbol side, 主要是使用 DWARF 来解析符号

Linker Relaxation (Linker Relaxation > impls): 2. DWARF 的 debug 信息需要调整

Author: [email protected]
Date: 2018-12-20 Thu 00:00
Last updated: 2023-07-05 Wed 20:37

知识共享许可协议