diff --git a/sources/tech/20110207 How debuggers work Part 3 - Debugging information.md b/sources/tech/20110207 How debuggers work Part 3 - Debugging information.md deleted file mode 100644 index bb9753b0b2..0000000000 --- a/sources/tech/20110207 How debuggers work Part 3 - Debugging information.md +++ /dev/null @@ -1,351 +0,0 @@ -YYforymj is translating. - -[How debuggers work: Part 3 - Debugging information][25] -============================================================ - - -This is the third part in a series of articles on how debuggers work. Make sure you read [the first][26] and [the second][27] parts before this one. - -### In this part - -I'm going to explain how the debugger figures out where to find the C functions and variables in the machine code it wades through, and the data it uses to map between C source code lines and machine language words. - -### Debugging information - -Modern compilers do a pretty good job converting your high-level code, with its nicely indented and nested control structures and arbitrarily typed variables into a big pile of bits called machine code, the sole purpose of which is to run as fast as possible on the target CPU. Most lines of C get converted into several machine code instructions. Variables are shoved all over the place - into the stack, into registers, or completely optimized away. Structures and objects don't even  _exist_  in the resulting code - they're merely an abstraction that gets translated to hard-coded offsets into memory buffers. - -So how does a debugger know where to stop when you ask it to break at the entry to some function? How does it manage to find what to show you when you ask it for the value of a variable? The answer is - debugging information. - -Debugging information is generated by the compiler together with the machine code. It is a representation of the relationship between the executable program and the original source code. This information is encoded into a pre-defined format and stored alongside the machine code. Many such formats were invented over the years for different platforms and executable files. Since the aim of this article isn't to survey the history of these formats, but rather to show how they work, we'll have to settle on something. This something is going to be DWARF, which is almost ubiquitously used today as the debugging information format for ELF executables on Linux and other Unix-y platforms. - -### The DWARF in the ELF - - ![](http://eli.thegreenplace.net/images/2011/02/dwarf_logo.gif) - -According to [its Wikipedia page][17], DWARF was designed alongside ELF, although it can in theory be embedded in other object file formats as well [[1]][18]. - -DWARF is a complex format, building on many years of experience with previous formats for various architectures and operating systems. It has to be complex, since it solves a very tricky problem - presenting debugging information from any high-level language to debuggers, providing support for arbitrary platforms and ABIs. It would take much more than this humble article to explain it fully, and to be honest I don't understand all its dark corners well enough to engage in such an endeavor anyway [[2]][19]. In this article I will take a more hands-on approach, showing just enough of DWARF to explain how debugging information works in practical terms. - -### Debug sections in ELF files - -First let's take a glimpse of where the DWARF info is placed inside ELF files. ELF defines arbitrary sections that may exist in each object file. A  _section header table_  defines which sections exist and their names. Different tools treat various sections in special ways - for example the linker is looking for some sections, the debugger for others. - -We'll be using an executable built from this C source for our experiments in this article, compiled into tracedprog2: - -``` -#include - -void do_stuff(int my_arg) -{ - int my_local = my_arg + 2; - int i; - - for (i = 0; i < my_local; ++i) - printf("i = %d\n", i); -} - -int main() -{ - do_stuff(2); - return 0; -} -``` - -Dumping the section headers from the ELF executable using objdump -h we'll notice several sections with names beginning with .debug_ - these are the DWARF debugging sections: - -``` -26 .debug_aranges 00000020 00000000 00000000 00001037 - CONTENTS, READONLY, DEBUGGING -27 .debug_pubnames 00000028 00000000 00000000 00001057 - CONTENTS, READONLY, DEBUGGING -28 .debug_info 000000cc 00000000 00000000 0000107f - CONTENTS, READONLY, DEBUGGING -29 .debug_abbrev 0000008a 00000000 00000000 0000114b - CONTENTS, READONLY, DEBUGGING -30 .debug_line 0000006b 00000000 00000000 000011d5 - CONTENTS, READONLY, DEBUGGING -31 .debug_frame 00000044 00000000 00000000 00001240 - CONTENTS, READONLY, DEBUGGING -32 .debug_str 000000ae 00000000 00000000 00001284 - CONTENTS, READONLY, DEBUGGING -33 .debug_loc 00000058 00000000 00000000 00001332 - CONTENTS, READONLY, DEBUGGING -``` - -The first number seen for each section here is its size, and the last is the offset where it begins in the ELF file. The debugger uses this information to read the section from the executable. - -Now let's see a few practical examples of finding useful debug information in DWARF. - -### Finding functions - -One of the most basic things we want to do when debugging is placing breakpoints at some function, expecting the debugger to break right at its entrance. To be able to perform this feat, the debugger must have some mapping between a function name in the high-level code and the address in the machine code where the instructions for this function begin. - -This information can be obtained from DWARF by looking at the .debug_info section. Before we go further, a bit of background. The basic descriptive entity in DWARF is called the Debugging Information Entry (DIE). Each DIE has a tag - its type, and a set of attributes. DIEs are interlinked via sibling and child links, and values of attributes can point at other DIEs. - -Let's run: - -``` -objdump --dwarf=info tracedprog2 -``` - -The output is quite long, and for this example we'll just focus on these lines [[3]][20]: - -``` -<1><71>: Abbrev Number: 5 (DW_TAG_subprogram) - <72> DW_AT_external : 1 - <73> DW_AT_name : (...): do_stuff - <77> DW_AT_decl_file : 1 - <78> DW_AT_decl_line : 4 - <79> DW_AT_prototyped : 1 - <7a> DW_AT_low_pc : 0x8048604 - <7e> DW_AT_high_pc : 0x804863e - <82> DW_AT_frame_base : 0x0 (location list) - <86> DW_AT_sibling : <0xb3> - -<1>: Abbrev Number: 9 (DW_TAG_subprogram) - DW_AT_external : 1 - DW_AT_name : (...): main - DW_AT_decl_file : 1 - DW_AT_decl_line : 14 - DW_AT_type : <0x4b> - DW_AT_low_pc : 0x804863e - DW_AT_high_pc : 0x804865a - DW_AT_frame_base : 0x2c (location list) -``` - -There are two entries (DIEs) tagged DW_TAG_subprogram, which is a function in DWARF's jargon. Note that there's an entry for do_stuff and an entry for main. There are several interesting attributes, but the one that interests us here is DW_AT_low_pc. This is the program-counter (EIP in x86) value for the beginning of the function. Note that it's 0x8048604 for do_stuff. Now let's see what this address is in the disassembly of the executable by running objdump -d: - -``` -08048604 : - 8048604: 55 push ebp - 8048605: 89 e5 mov ebp,esp - 8048607: 83 ec 28 sub esp,0x28 - 804860a: 8b 45 08 mov eax,DWORD PTR [ebp+0x8] - 804860d: 83 c0 02 add eax,0x2 - 8048610: 89 45 f4 mov DWORD PTR [ebp-0xc],eax - 8048613: c7 45 (...) mov DWORD PTR [ebp-0x10],0x0 - 804861a: eb 18 jmp 8048634 - 804861c: b8 20 (...) mov eax,0x8048720 - 8048621: 8b 55 f0 mov edx,DWORD PTR [ebp-0x10] - 8048624: 89 54 24 04 mov DWORD PTR [esp+0x4],edx - 8048628: 89 04 24 mov DWORD PTR [esp],eax - 804862b: e8 04 (...) call 8048534 - 8048630: 83 45 f0 01 add DWORD PTR [ebp-0x10],0x1 - 8048634: 8b 45 f0 mov eax,DWORD PTR [ebp-0x10] - 8048637: 3b 45 f4 cmp eax,DWORD PTR [ebp-0xc] - 804863a: 7c e0 jl 804861c - 804863c: c9 leave - 804863d: c3 ret -``` - -Indeed, 0x8048604 is the beginning of do_stuff, so the debugger can have a mapping between functions and their locations in the executable. - -### Finding variables - -Suppose that we've indeed stopped at a breakpoint inside do_stuff. We want to ask the debugger to show us the value of the my_local variable. How does it know where to find it? Turns out this is much trickier than finding functions. Variables can be located in global storage, on the stack, and even in registers. Additionally, variables with the same name can have different values in different lexical scopes. The debugging information has to be able to reflect all these variations, and indeed DWARF does. - -I won't cover all the possibilities, but as an example I'll demonstrate how the debugger can find my_local in do_stuff. Let's start at .debug_info and look at the entry for do_stuff again, this time also looking at a couple of its sub-entries: - -``` -<1><71>: Abbrev Number: 5 (DW_TAG_subprogram) - <72> DW_AT_external : 1 - <73> DW_AT_name : (...): do_stuff - <77> DW_AT_decl_file : 1 - <78> DW_AT_decl_line : 4 - <79> DW_AT_prototyped : 1 - <7a> DW_AT_low_pc : 0x8048604 - <7e> DW_AT_high_pc : 0x804863e - <82> DW_AT_frame_base : 0x0 (location list) - <86> DW_AT_sibling : <0xb3> - <2><8a>: Abbrev Number: 6 (DW_TAG_formal_parameter) - <8b> DW_AT_name : (...): my_arg - <8f> DW_AT_decl_file : 1 - <90> DW_AT_decl_line : 4 - <91> DW_AT_type : <0x4b> - <95> DW_AT_location : (...) (DW_OP_fbreg: 0) - <2><98>: Abbrev Number: 7 (DW_TAG_variable) - <99> DW_AT_name : (...): my_local - <9d> DW_AT_decl_file : 1 - <9e> DW_AT_decl_line : 6 - <9f> DW_AT_type : <0x4b> - DW_AT_location : (...) (DW_OP_fbreg: -20) -<2>: Abbrev Number: 8 (DW_TAG_variable) - DW_AT_name : i - DW_AT_decl_file : 1 - DW_AT_decl_line : 7 - DW_AT_type : <0x4b> - DW_AT_location : (...) (DW_OP_fbreg: -24) -``` - -Note the first number inside the angle brackets in each entry. This is the nesting level - in this example entries with <2> are children of the entry with <1>. So we know that the variable my_local (marked by the DW_TAG_variable tag) is a child of the do_stuff function. The debugger is also interested in a variable's type to be able to display it correctly. In the case of my_local the type points to another DIE - <0x4b>. If we look it up in the output of objdump we'll see it's a signed 4-byte integer. - -To actually locate the variable in the memory image of the executing process, the debugger will look at the DW_AT_location attribute. For my_local it says DW_OP_fbreg: -20. This means that the variable is stored at offset -20 from the DW_AT_frame_base attribute of its containing function - which is the base of the frame for the function. - -The DW_AT_frame_base attribute of do_stuff has the value 0x0 (location list), which means that this value actually has to be looked up in the location list section. Let's look at it: - -``` -$ objdump --dwarf=loc tracedprog2 - -tracedprog2: file format elf32-i386 - -Contents of the .debug_loc section: - - Offset Begin End Expression - 00000000 08048604 08048605 (DW_OP_breg4: 4 ) - 00000000 08048605 08048607 (DW_OP_breg4: 8 ) - 00000000 08048607 0804863e (DW_OP_breg5: 8 ) - 00000000 - 0000002c 0804863e 0804863f (DW_OP_breg4: 4 ) - 0000002c 0804863f 08048641 (DW_OP_breg4: 8 ) - 0000002c 08048641 0804865a (DW_OP_breg5: 8 ) - 0000002c -``` - -The location information we're interested in is the first one [[4]][21]. For each address where the debugger may be, it specifies the current frame base from which offsets to variables are to be computed as an offset from a register. For x86, bpreg4 refers to esp and bpreg5 refers to ebp. - -It's educational to look at the first several instructions of do_stuff again: - -``` -08048604 : - 8048604: 55 push ebp - 8048605: 89 e5 mov ebp,esp - 8048607: 83 ec 28 sub esp,0x28 - 804860a: 8b 45 08 mov eax,DWORD PTR [ebp+0x8] - 804860d: 83 c0 02 add eax,0x2 - 8048610: 89 45 f4 mov DWORD PTR [ebp-0xc],eax -``` - -Note that ebp becomes relevant only after the second instruction is executed, and indeed for the first two addresses the base is computed from esp in the location information listed above. Once ebp is valid, it's convenient to compute offsets relative to it because it stays constant while esp keeps moving with data being pushed and popped from the stack. - -So where does it leave us with my_local? We're only really interested in its value after the instruction at 0x8048610 (where its value is placed in memory after being computed in eax), so the debugger will be using the DW_OP_breg5: 8 frame base to find it. Now it's time to rewind a little and recall that the DW_AT_location attribute for my_local says DW_OP_fbreg: -20. Let's do the math: -20 from the frame base, which is ebp + 8. We get ebp - 12. Now look at the disassembly again and note where the data is moved from eax - indeed, ebp - 12 is where my_local is stored. - -### Looking up line numbers - -When we talked about finding functions in the debugging information, I was cheating a little. When we debug C source code and put a breakpoint in a function, we're usually not interested in the first  _machine code_  instruction [[5]][22]. What we're  _really_  interested in is the first  _C code_  line of the function. - -This is why DWARF encodes a full mapping between lines in the C source code and machine code addresses in the executable. This information is contained in the .debug_line section and can be extracted in a readable form as follows: - -``` -$ objdump --dwarf=decodedline tracedprog2 - -tracedprog2: file format elf32-i386 - -Decoded dump of debug contents of section .debug_line: - -CU: /home/eliben/eli/eliben-code/debugger/tracedprog2.c: -File name Line number Starting address -tracedprog2.c 5 0x8048604 -tracedprog2.c 6 0x804860a -tracedprog2.c 9 0x8048613 -tracedprog2.c 10 0x804861c -tracedprog2.c 9 0x8048630 -tracedprog2.c 11 0x804863c -tracedprog2.c 15 0x804863e -tracedprog2.c 16 0x8048647 -tracedprog2.c 17 0x8048653 -tracedprog2.c 18 0x8048658 -``` - -It shouldn't be hard to see the correspondence between this information, the C source code and the disassembly dump. Line number 5 points at the entry point to do_stuff - 0x8040604. The next line, 6, is where the debugger should really stop when asked to break in do_stuff, and it points at 0x804860a which is just past the prologue of the function. This line information easily allows bi-directional mapping between lines and addresses: - -* When asked to place a breakpoint at a certain line, the debugger will use it to find which address it should put its trap on (remember our friend int 3 from the previous article?) -* When an instruction causes a segmentation fault, the debugger will use it to find the source code line on which it happened. - -### libdwarf - Working with DWARF programmatically - -Employing command-line tools to access DWARF information, while useful, isn't fully satisfying. As programmers, we'd like to know how to write actual code that can read the format and extract what we need from it. - -Naturally, one approach is to grab the DWARF specification and start hacking away. Now, remember how everyone keeps saying that you should never, ever parse HTML manually but rather use a library? Well, with DWARF it's even worse. DWARF is  _much_  more complex than HTML. What I've shown here is just the tip of the iceberg, and to make things even harder, most of this information is encoded in a very compact and compressed way in the actual object file [[6]][23]. - -So we'll take another road and use a library to work with DWARF. There are two major libraries I'm aware of (plus a few less complete ones): - -1. BFD (libbfd) is used by the [GNU binutils][11], including objdump which played a star role in this article, ld (the GNU linker) and as (the GNU assembler). -2. libdwarf - which together with its big brother libelf are used for the tools on Solaris and FreeBSD operating systems. - -I'm picking libdwarf over BFD because it appears less arcane to me and its license is more liberal (LGPLvs. GPL). - -Since libdwarf is itself quite complex it requires a lot of code to operate. I'm not going to show all this code here, but [you can download][24] and run it yourself. To compile this file you'll need to have libelfand libdwarf installed, and pass the -lelf and -ldwarf flags to the linker. - -The demonstrated program takes an executable and prints the names of functions in it, along with their entry points. Here's what it produces for the C program we've been playing with in this article: - -``` -$ dwarf_get_func_addr tracedprog2 -DW_TAG_subprogram: 'do_stuff' -low pc : 0x08048604 -high pc : 0x0804863e -DW_TAG_subprogram: 'main' -low pc : 0x0804863e -high pc : 0x0804865a -``` - -The documentation of libdwarf (linked in the References section of this article) is quite good, and with some effort you should have no problem pulling any other information demonstrated in this article from the DWARF sections using it. - -### Conclusion and next steps - -Debugging information is a simple concept in principle. The implementation details may be intricate, but in the end of the day what matters is that we now know how the debugger finds the information it needs about the original source code from which the executable it's tracing was compiled. With this information in hand, the debugger bridges between the world of the user, who thinks in terms of lines of code and data structures, and the world of the executable, which is just a bunch of machine code instructions and data in registers and memory. - -This article, with its two predecessors, concludes an introductory series that explains the inner workings of a debugger. Using the information presented here and some programming effort, it should be possible to create a basic but functional debugger for Linux. - -As for the next steps, I'm not sure yet. Maybe I'll end the series here, maybe I'll present some advanced topics such as backtraces, and perhaps debugging on Windows. Readers can also suggest ideas for future articles in this series or related material. Feel free to use the comments or send me an email. - -### References - -* objdump man page -* Wikipedia pages for [ELF][12] and [DWARF][13]. -* [Dwarf Debugging Standard home page][14] - from here you can obtain the excellent DWARF tutorial by Michael Eager, as well as the DWARF standard itself. You'll probably want version 2 since it's what gccproduces. -* [libdwarf home page][15] - the download package includes a comprehensive reference document for the library -* [BFD documentation][16] - - -[1] DWARF is an open standard, published here by the DWARF standards committee. The DWARF logo displayed above is taken from that website. - -[2] At the end of the article I've collected some useful resources that will help you get more familiar with DWARF, if you're interested. Particularly, start with the DWARF tutorial. - -[3] Here and in subsequent examples, I'm placing (...) instead of some longer and un-interesting information for the sake of more convenient formatting. - -[4] Because the DW_AT_frame_base attribute of do_stuff contains offset 0x0 into the location list. Note that the same attribute for main contains the offset 0x2c which is the offset for the second set of location expressions. - -[5] Where the function prologue is usually executed and the local variables aren't even valid yet. - -[6] Some parts of the information (such as location data and line number data) are encoded as instructions for a specialized virtual machine. Yes, really. - -* * * - --------------------------------------------------------------------------------- - -via: http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information - -作者：[Eli Bendersky][a] -译者：[译者ID](https://github.com/译者ID) -校对：[校对者ID](https://github.com/校对者ID) - -本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译，[Linux中国](https://linux.cn/) 荣誉推出 - -[a]:http://eli.thegreenplace.net/ -[1]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id1 -[2]:http://dwarfstd.org/ -[3]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id2 -[4]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id3 -[5]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id4 -[6]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id5 -[7]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id6 -[8]:http://eli.thegreenplace.net/tag/articles -[9]:http://eli.thegreenplace.net/tag/debuggers -[10]:http://eli.thegreenplace.net/tag/programming -[11]:http://www.gnu.org/software/binutils/ -[12]:http://en.wikipedia.org/wiki/Executable_and_Linkable_Format -[13]:http://en.wikipedia.org/wiki/DWARF -[14]:http://dwarfstd.org/ -[15]:http://reality.sgiweb.org/davea/dwarf.html -[16]:http://sourceware.org/binutils/docs-2.21/bfd/index.html -[17]:http://en.wikipedia.org/wiki/DWARF -[18]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id7 -[19]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id8 -[20]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id9 -[21]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id10 -[22]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id11 -[23]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id12 -[24]:https://github.com/eliben/code-for-blog/blob/master/2011/dwarf_get_func_addr.c -[25]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information -[26]:http://eli.thegreenplace.net/2011/01/23/how-debuggers-work-part-1/ -[27]:http://eli.thegreenplace.net/2011/01/27/how-debuggers-work-part-2-breakpoints/ diff --git a/translated/tech/20110207 How debuggers work Part 3 - Debugging information.md b/translated/tech/20110207 How debuggers work Part 3 - Debugging information.md new file mode 100644 index 0000000000..ff5d53b9a1 --- /dev/null +++ b/translated/tech/20110207 How debuggers work Part 3 - Debugging information.md @@ -0,0 +1,339 @@ +[调试器的工作原理: 第3篇 - 调试信息][25] +============================================================ + + +这是调试器的工作原理系列文章的第三篇。阅读这篇文章之前应当先阅读[第一篇][26]与[第二篇][27]。 + +### 这篇文章的主要内容 + +本文将解释调试器是如何在机器码中，查找它将C语言源代码转换成机器语言代码时所需要的C语言函数、变量、与数据。 + +### 调试信息 + + +现代编译器能够将有着各种排版或嵌套的程序流程、各种数据类型的变量的高级语言代码转换为一大堆称之为机器码的 0/1 数据，这么做的唯一目的是尽可能快的在目标 CPU 上运行程序。通常来说一行C语言代码能够转换为若干条机器码。变量被分散在机器码中的各个部分，有的在堆栈中，有的在寄存器中，或者直接被优化掉了。数据结构与对象在机器码中甚至不“存在”，它们只是用于将数据按一定的结构编码存储进缓存。 + +那么调试器怎么知道，当你需要在某个函数入口处暂停时，程序要在哪停下来呢？它怎么知道当你查看某个变量值时，它怎么找到这个值？答案是，调试信息。 + +编译器在生成机器码时同时会生成相应的调试信息。调试信息代表了可执行程序与源代码之间的关系，并以一种提前定义好的格式，同机器码存放在一起。过去的数年里，人们针对不同的平台与可执行文件发明了很多种用于存储这些信息的格式。不过我们这篇文章不会讲这些格式的历史，而是将阐述这些调试信息是如何工作的，所以我们将专注于一些事情，比如 `DWARF`。`DWARF` 如今十分广泛的应用在类 `Unix` 平台上的可执行文件的调试。 + +### ELF 中的 DWARF + + ![](http://eli.thegreenplace.net/images/2011/02/dwarf_logo.gif) + +根据[它的维基百科][17] 所描述，虽然 `DWARF` 是同 `ELF` 一同设计的（`DWARF` 是由 `DWARF` 标准委员会推出的开放标准。上文中展示的 图标就来自这个网站。），但 `DWARF` 在理论上来说也可以嵌入到其他的可执行文件格式中。 + +`DWARF` 是一种复杂的格式，它的构建基于过去多年中许多不同的编译器与操作系统。正是因为它解决了一个为任意语言在任何平台与业务系统中产生调试信息的这样棘手的难题，它也必须很复杂。想要透彻的讲解 `DWARF` 仅仅是通过这单薄的一篇文章是远远不够的，说实话我也并没有充分地了解 `DWARF` 到每一个微小的细节，所以我也不能十分透彻的讲解 （如果你感兴趣的话，文末有一些能够帮助你的资源。建议从 `DWARF` 教程开始上手）。这篇文章中我将以浅显易懂的方式展示 `DWARF` 在实际应用中调试信息是如何工作的。 + +### ELF文件中的调试部分 + +首先让我们看看 `DWARF` 处在 ELF 文件中的什么位置。`ELF` 定义了每一个生成的目标文件中的每一部分。 _section header table_ 声明并定义了每一部分。不同的工具以不同的方式处理不同的部分，例如连接器会寻找连接器需要的部分，调试器会查找调试器需要的部分。 + +我们本文的实验会使用从这个C语言源文件构建的可执行文件，编译成 tracedprog2： + + +``` +#include + +void do_stuff(int my_arg)、 +{ + int my_local = my_arg + 2; + int i; + + for (i = 0; i < my_local; ++i) + printf("i = %d\n", i); +} + +int main() +{ + do_stuff(2); + return 0; +} +``` + + +使用 `objdump -h` 命令检查 `ELF` 可执行文件中的段落头，我们会看到几个以 .debug_ 开头的段落，这些就是 `DWARF` 的调试部分。 + +``` +26 .debug_aranges 00000020 00000000 00000000 00001037 + CONTENTS, READONLY, DEBUGGING +27 .debug_pubnames 00000028 00000000 00000000 00001057 + CONTENTS, READONLY, DEBUGGING +28 .debug_info 000000cc 00000000 00000000 0000107f + CONTENTS, READONLY, DEBUGGING +29 .debug_abbrev 0000008a 00000000 00000000 0000114b + CONTENTS, READONLY, DEBUGGING +30 .debug_line 0000006b 00000000 00000000 000011d5 + CONTENTS, READONLY, DEBUGGING +31 .debug_frame 00000044 00000000 00000000 00001240 + CONTENTS, READONLY, DEBUGGING +32 .debug_str 000000ae 00000000 00000000 00001284 + CONTENTS, READONLY, DEBUGGING +33 .debug_loc 00000058 00000000 00000000 00001332 + CONTENTS, READONLY, DEBUGGING +``` + +每个段落的第一个数字代表了这个段落的大小，最后一个数字代表了这个段落开始位置距离 `ELF` 的偏移量。调试器利用这些信息从可执行文件中读取段落。 + +现在让我们看看一些在 `DWARF` 中查找有用的调试信息的实际例子。 + +### 查找函数 + +调试器的基础任务之一，就是当我们在某个函数处设置断点时，调试器需要能够在入口处暂停。为此，必须为函数与函数在机器码地址这两者建立起某种映射关系。 + +为了获取这种映射关系，我们可以查找 `DWARF` 中的 .debug_info 段落。在我们深入之前，需要一点基础知识。`DWARF` 中每一个描述类型被称之为调试信息入口（`DIE`）。每个 `DIE` 都有关于它的属性之类的标签。`DIE` 之间通过兄弟节点或子节点连接，属性的值也可以指向其他的 `DIE`. + +运行以下命令 + +``` +objdump --dwarf=info tracedprog2 +``` + +输出文件相当的长，为了方便举例我们只关注这些行（从这里开始，无用的冗长信息我会以 （...）代替，方便排版。）： + +``` +<1><71>: Abbrev Number: 5 (DW_TAG_subprogram) + <72> DW_AT_external : 1 + <73> DW_AT_name : (...): do_stuff + <77> DW_AT_decl_file : 1 + <78> DW_AT_decl_line : 4 + <79> DW_AT_prototyped : 1 + <7a> DW_AT_low_pc : 0x8048604 + <7e> DW_AT_high_pc : 0x804863e + <82> DW_AT_frame_base : 0x0 (location list) + <86> DW_AT_sibling : <0xb3> + +<1>: Abbrev Number: 9 (DW_TAG_subprogram) + DW_AT_external : 1 + DW_AT_name : (...): main + DW_AT_decl_file : 1 + DW_AT_decl_line : 14 + DW_AT_type : <0x4b> + DW_AT_low_pc : 0x804863e + DW_AT_high_pc : 0x804865a + DW_AT_frame_base : 0x2c (location list) +``` + +上面的代码中有两个带有 DW_TAG_subprogram 标签的入口，在 `DWARF` 中这是对函数的指代。注意，这是两个段落入口，其中一个是 do_stuff 函数的入口，另一个是主函数的入口。这些信息中有很多值得关注的属性，但其中最值得注意的是 DW_AT_low_pc。它代表了函数开始处程序指针的值（在x86平台上是 `EIP`）。此处 0x8048604 代表了 do_stuff 函数开始处的程序指针。下面我们将利用 `objdump -d` 命令对可执行文件进行反汇编。来看看这块地址中都有什么： + +``` +08048604 : + 8048604: 55 push ebp + 8048605: 89 e5 mov ebp,esp + 8048607: 83 ec 28 sub esp,0x28 + 804860a: 8b 45 08 mov eax,DWORD PTR [ebp+0x8] + 804860d: 83 c0 02 add eax,0x2 + 8048610: 89 45 f4 mov DWORD PTR [ebp-0xc],eax + 8048613: c7 45 (...) mov DWORD PTR [ebp-0x10],0x0 + 804861a: eb 18 jmp 8048634 + 804861c: b8 20 (...) mov eax,0x8048720 + 8048621: 8b 55 f0 mov edx,DWORD PTR [ebp-0x10] + 8048624: 89 54 24 04 mov DWORD PTR [esp+0x4],edx + 8048628: 89 04 24 mov DWORD PTR [esp],eax + 804862b: e8 04 (...) call 8048534 + 8048630: 83 45 f0 01 add DWORD PTR [ebp-0x10],0x1 + 8048634: 8b 45 f0 mov eax,DWORD PTR [ebp-0x10] + 8048637: 3b 45 f4 cmp eax,DWORD PTR [ebp-0xc] + 804863a: 7c e0 jl 804861c + 804863c: c9 leave + 804863d: c3 ret +``` + +显然，0x8048604 是 do_stuff 的开始地址，这样一来，调试器就可以建立函数与其在可执行文件中的位置间的映射关系。 + +### 查找变量 + +假设我们当前在 do_staff 函数中某个位置上设置断点停了下来。我们想通过调试器取得 my_local 这个变量的值。调试器怎么知道在哪里去找这个值呢？很显然这要比查找函数更为困难。变量可能存储在全局存储区、堆栈、甚至是寄存器中。此外，同名变量在不同的作用域中可能有着不同的值。调试信息必须能够反映所有的这些变化，当然，`DWARF` 就能做到。 + +我不会逐一去将每一种可能的状况，但我会以调试器在 do_stuff 函数中查找 my_local 变量的过程来举个例子。下面我们再看一遍 .debug_info 中 do_stuff 的每一个入口，这次连它的子入口也要一起看。 + +``` +<1><71>: Abbrev Number: 5 (DW_TAG_subprogram) + <72> DW_AT_external : 1 + <73> DW_AT_name : (...): do_stuff + <77> DW_AT_decl_file : 1 + <78> DW_AT_decl_line : 4 + <79> DW_AT_prototyped : 1 + <7a> DW_AT_low_pc : 0x8048604 + <7e> DW_AT_high_pc : 0x804863e + <82> DW_AT_frame_base : 0x0 (location list) + <86> DW_AT_sibling : <0xb3> + <2><8a>: Abbrev Number: 6 (DW_TAG_formal_parameter) + <8b> DW_AT_name : (...): my_arg + <8f> DW_AT_decl_file : 1 + <90> DW_AT_decl_line : 4 + <91> DW_AT_type : <0x4b> + <95> DW_AT_location : (...) (DW_OP_fbreg: 0) + <2><98>: Abbrev Number: 7 (DW_TAG_variable) + <99> DW_AT_name : (...): my_local + <9d> DW_AT_decl_file : 1 + <9e> DW_AT_decl_line : 6 + <9f> DW_AT_type : <0x4b> + DW_AT_location : (...) (DW_OP_fbreg: -20) +<2>: Abbrev Number: 8 (DW_TAG_variable) + DW_AT_name : i + DW_AT_decl_file : 1 + DW_AT_decl_line : 7 + DW_AT_type : <0x4b> + DW_AT_location : (...) (DW_OP_fbreg: -24) +``` + +看到每个入口处第一对尖括号中的数字了吗？这些是嵌套的等级，在上面的例子中，以 <2> 开头的入口是以 <1> 开头的子入口。因此我们得知 my_local 变量（以 DW_TAG_variable 标签标记）是 do_stuff 函数的局部变量。除此之外，调试器也需要知道变量的数据类型，这样才能正确的使用与显示变量。上面的例子中 my_local 的变量类型指向另一个 `DIE` <0x4b>。如果使用 objdump 命令查看这个 `DIE` 部分的话，我们会发现这部分代表了有符号4字节整型数据。 + +而为了在实际运行的程序内存中查找变量的值，调试器需要使用到 DW_AT_location 属性。对于 my_local 而言，是 DW_OP_fbreg: -20。这个代码段的意思是说 my_local 存储在距离它所在函数起始地址偏移量为-20的地方。 + +do_stuff 函数的 DW_AT_frame_base 属性值为 0x0 (location list)。这意味着这个属性的值需要在 location list 中查找。下面我们来一起看看。 + +``` +$ objdump --dwarf=loc tracedprog2 + +tracedprog2: file format elf32-i386 + +Contents of the .debug_loc section: + + Offset Begin End Expression + 00000000 08048604 08048605 (DW_OP_breg4: 4 ) + 00000000 08048605 08048607 (DW_OP_breg4: 8 ) + 00000000 08048607 0804863e (DW_OP_breg5: 8 ) + 00000000 + 0000002c 0804863e 0804863f (DW_OP_breg4: 4 ) + 0000002c 0804863f 08048641 (DW_OP_breg4: 8 ) + 0000002c 08048641 0804865a (DW_OP_breg5: 8 ) + 0000002c +``` + +我们需要关注的是第一列（do_stuff 函数的 DW_AT_frame_base 属性包含 location list 中 0x0 的偏移量。而 main 函数的相同属性包含 0x2c 的偏移量，这个偏移量是第二套地址列表的偏移量。）。对于调试器可能定位到的每一个地址，它都会指定当前栈帧到变量间的偏移量，而这个偏移就是通过寄存器来计算的。对于x86平台而言，bpreg4 指向 esp，而 bpreg5 指向 ebp。 + +让我们再看看 do_stuff 函数的头几条指令。 + +``` +08048604 : + 8048604: 55 push ebp + 8048605: 89 e5 mov ebp,esp + 8048607: 83 ec 28 sub esp,0x28 + 804860a: 8b 45 08 mov eax,DWORD PTR [ebp+0x8] + 804860d: 83 c0 02 add eax,0x2 + 8048610: 89 45 f4 mov DWORD PTR [ebp-0xc],eax +``` + +只有当第二条指令执行后，ebp 寄存器才真正存储了有用的值。当然，前两条指令的基址是由上面所列出来的地址信息表计算出来的。一但 ebp 确定了，计算偏移量就十分方便了，因为尽管 esp 在操作堆栈的时候需要移动，但 ebp 作为栈底并不需要移动。 + +究竟我们应该去哪里找 my_local 的值呢？在 0x8048610 这块地址后， my_local 的值经过在 eax 中的计算后被存在了内存中，从这里开始我们才需要关注 my_local 的值。调试器会利用 DW_OP_breg5: 8 这个基址来查找。我们回想下，my_local 的 DW_AT_location 属性值为 DW_OP_fbreg: -20。所以应当从基址中 -20 ，同时由于 ebp 寄存器需要 + 8，所以最终结果为 - 12。现在再次查看反汇编代码，来看看数据从 eax 中被移动到哪里了。当然，这里 my_local 应当被存储在了 ebp - 12 的地址中。 + +### 查看行号 + +当我们谈论调试信息的时候，我们利用了些技巧。当调试C语言源代码并在某个函数出放置断点的时候，我们并不关注第一条“机器码”指令（函数的调用准备工作已经完成而局部变量还没有初始化。）。我们真正关注的是函数的第一行“C代码”。 + +这就是 `DWARF` 完全覆盖映射C源代码与可执行文件中机器码地址的原因。下面是 .debug_line 段中所包含的内容，我们将其转换为可读的格式展示如下。 + +``` +$ objdump --dwarf=decodedline tracedprog2 + +tracedprog2: file format elf32-i386 + +Decoded dump of debug contents of section .debug_line: + +CU: /home/eliben/eli/eliben-code/debugger/tracedprog2.c: +File name Line number Starting address +tracedprog2.c 5 0x8048604 +tracedprog2.c 6 0x804860a +tracedprog2.c 9 0x8048613 +tracedprog2.c 10 0x804861c +tracedprog2.c 9 0x8048630 +tracedprog2.c 11 0x804863c +tracedprog2.c 15 0x804863e +tracedprog2.c 16 0x8048647 +tracedprog2.c 17 0x8048653 +tracedprog2.c 18 0x8048658 +``` + +很容易就可以看出其中C源代码与反汇编代码之间的对应关系。第5行指向 do_stuff 函数的入口，0x8040604。第6行，指向 0x804860a ，正是调试器在调试 do_stuff 函数时需要停下来的地方。这里已经完成了函数调用的准备工作。上面的这些信息形成了行号与地址间的双向映射关系。 + +* 当在某一行设置断点的时候，调试器会利用这些信息去查找相应的地址来做断点工作（还记得上篇文章中的 int 3 指令吗？） +* 当指令造成代码段错误时，调试器会利用这些信息来查看源代码中发生的状况。 + +### libdwarf - 用 DWARF 编程 + +尽管使用命令行工具来获得 `DWARF` 很有用，但这仍然不够易用。作为程序员，我们应当知道当我们需要这些调试信息时应当怎么编程来获取这些信息。 + +自然我们想到的第一种方法就是阅读 `DWARF` 规范并按规范操作阅读使用。有句话说的好，分析 HTML 应当使用库函数，永远不要手工分析。对于 `DWARF` 来说这是如此。`DWARF` 比 HTML 要复杂得多。上面所展示出来的只是冰山一角。更糟糕的是，在实际的目标文件中，大部分信息是以压缩格式存储的，分析起来更加复杂（信息中的某些部分，例如位置信息与行号信息，在某些虚拟机下是以指令的方式编码的。）。 + +所以我们要使用库函数来处理 `DWARF`。下面是两种我熟悉的主流库（还有些不完整的库这里没有写） + +1. `BFD` (libbfd)，包含了 `objdump` （对，就是这篇文章中我们一直在用的这货），`ld`（`GNU` 连接器）与 `as`（`GNU` 编译器）。`BFD` 主要用于[GNU binutils][11]。 +2. `libdwarf` ，同它的哥哥 `libelf` 一同用于 `Solaris` 与 `FreeBSD` 中的调试信息分析。 + +相比较而言我更倾向于使用 `libdwarf`，因为我对它了解的更多，并且 `libdwarf` 的开源协议更开放。 + +因为 `libdwarf` 本身相当复杂，操作起来需要相当多的代码，所以我在这不会展示所有代码。你可以在 [这里][24] 下载代码并运行试试。运行这些代码需要提前安装 `libelfand` 与 `libdwarf` ，同时在使用连接器的时候要使用参数 `-lelf` 与 `-ldwarf`。 + +这个示例程序可以接受可执行文件并打印其中的函数名称与函数入口地址。下面是我们整篇文章中使用的C程序经过示例程序处理后的输出。 + +``` +$ dwarf_get_func_addr tracedprog2 +DW_TAG_subprogram: 'do_stuff' +low pc : 0x08048604 +high pc : 0x0804863e +DW_TAG_subprogram: 'main' +low pc : 0x0804863e +high pc : 0x0804865a +``` + +`libdwarf` 的文档很棒，如果你花些功夫，利用 `libdwarf` 获得这篇文章中所涉及到的 `DWARF` 信息应该并不困难。 + +### 结论与计划 + +原理上讲，调试信息是个很简单的概念。尽管实现细节可能比较复杂，但经过了上面的学习我想你应该了解了调试器是如何从可执行文件中获取它需要的源代码信息的了。对于程序员而言，程序只是代码段与数据结构；对可执行文件而言，程序只是一系列存储在内存或寄存器中的指令或数据。但利用调试信息，调试器就可以将这两者连接起来，从而完成调试工作。 + +此文与这系列的前两篇，一同介绍了调试器的内部工作过程。利用这里所讲到的知识，再敲些代码，应该可以完成一个 `Linux` 中最简单基础但也有一定功能的调试器。 + +下一步我并不确定要做什么，这个系列文章可能就此结束，也有可能我要讲些堆栈调用的事情，又或者讲 `Windows` 下的调试。你们有什么好的点子或者相关材料，可以直接评论或者发邮件给我。 + +### 参考 + +* objdump 参考手册 +* [ELF][12] 与 [DWARF][13]的维基百科 +* [Dwarf Debugging Standard home page][14]，这里有很棒的 DWARF 教程与 DWARF 标准，作者是 Michael Eager。第二版基于 GCC 也许更能吸引你。 +* [libdwarf home page][15]，这里可以下载到 libwarf 的完整库与参考手册 +* [BFD documentation][16] + +* * * + +-------------------------------------------------------------------------------- + +via: http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information + +作者：[Eli Bendersky][a] +译者：[YYforymj](https://github.com/YYforymj) +校对：[校对者ID](https://github.com/校对者ID) + +本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译，[Linux中国](https://linux.cn/) 荣誉推出 + +[a]:http://eli.thegreenplace.net/ +[1]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id1 +[2]:http://dwarfstd.org/ +[3]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id2 +[4]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id3 +[5]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id4 +[6]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id5 +[7]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id6 +[8]:http://eli.thegreenplace.net/tag/articles +[9]:http://eli.thegreenplace.net/tag/debuggers +[10]:http://eli.thegreenplace.net/tag/programming +[11]:http://www.gnu.org/software/binutils/ +[12]:http://en.wikipedia.org/wiki/Executable_and_Linkable_Format +[13]:http://en.wikipedia.org/wiki/DWARF +[14]:http://dwarfstd.org/ +[15]:http://reality.sgiweb.org/davea/dwarf.html +[16]:http://sourceware.org/binutils/docs-2.21/bfd/index.html +[17]:http://en.wikipedia.org/wiki/DWARF +[18]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id7 +[19]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id8 +[20]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id9 +[21]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id10 +[22]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id11 +[23]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information#id12 +[24]:https://github.com/eliben/code-for-blog/blob/master/2011/dwarf_get_func_addr.c +[25]:http://eli.thegreenplace.net/2011/02/07/how-debuggers-work-part-3-debugging-information +[26]:http://eli.thegreenplace.net/2011/01/23/how-debuggers-work-part-1/ +[27]:http://eli.thegreenplace.net/2011/01/27/how-debuggers-work-part-2-breakpoints/