Save current state before a LaTeX/.git software update...
[dwarf-doc.git] / dwarf5 / latexdoc / introduction.tex
1 \chapter{Introduction}
2 \label{chap:introduction}
3 \pagenumbering{arabic}
4 This document defines a format for describing programs to
5 facilitate user source level debugging. This description
6 can be generated by compilers, assemblers and linkage
7 editors. It can be used by debuggers and other tools. 
8 The debugging information format does not favor the design of any
9 compiler or debugger. 
10 Instead, the goal is to create a method
11 of communicating an accurate picture of the source program
12 to any debugger in a form that is extensible to different
13 languages while retaining compatibility.
14   
15 The design of the
16 debugging information format is open-ended, allowing for
17 the addition of new debugging information to accommodate new
18 languages or debugger capabilities while remaining compatible
19 with other languages or different debuggers.
20
21 \section{Purpose and Scope}
22 The debugging information format described in this document is
23 designed to meet the symbolic, source-level debugging needs of
24 different languages in a unified fashion by requiring language
25 independent debugging information whenever possible.  
26 Aspects
27 of individual languages, such as \addtoindex{C++} virtual functions or
28 \addtoindex{Fortran} common 
29 \nolink{blocks}, are accommodated by creating attributes
30 that are used only for those languages. 
31 This document is
32 believed to cover most debugging information needs of 
33 \addtoindex{Ada},
34 \addtoindex{C}, \addtoindex{C++}, \addtoindex{COBOL}, 
35 and \addtoindex{Fortran}; it also covers the basic needs
36 of various other languages.
37
38 This document describes \DWARFVersionV,
39 the fifth generation
40 of debugging information based on the DWARF format. 
41 \DWARFVersionV{} extends \DWARFVersionIV{}
42 in a compatible manner.
43
44 The intended audience for this document is the developers
45 of both producers and consumers of debugging information,
46 typically compilers, debuggers and other tools that need to
47 interpret a binary program in terms of its original source.
48
49
50 \section{Overview}
51
52 There are two major pieces to the description of the DWARF
53 format in this document. The first piece is the informational
54 content of the debugging entries. The second piece is the
55 way the debugging information is encoded and represented in
56 an object file.
57
58 The informational content is described in Chapters
59 \ref{chap:generaldescription} through
60 \ref{chap:otherdebugginginformation}. Chapter 
61 \ref{chap:generaldescription}
62 describes the overall structure of the information
63 and attributes that are common to many or all of the different
64 debugging information entries. Chapters
65 \ref{chap:programscopeentries}, 
66 \ref{chap:dataobjectandobjectlistentries} and 
67 \ref{chap:typeentries} describe
68 the specific debugging information entries and how they
69 communicate the necessary information about the source program
70 to a debugger. Chapter \ref{chap:otherdebugginginformation} 
71 describes debugging information
72 contained outside of the debugging information entries. The
73 encoding of the DWARF information is presented in Chapter
74 \ref{datarep:datarepresentation}.
75
76 This organization closely follows that used in the 
77 \DWARFVersionIV{} document. Except where needed to incorporate
78 new material or to correct errors, the \DWARFVersionIV{}
79 text is generally reused in this document with little or
80 no modification.
81
82 In the following sections, text in normal font describes
83 required aspects of the DWARF format.  Text in \textit{italics} is
84 explanatory or supplementary material, and not part of the
85 format definition itself. The several appendices consist only
86 of explanatory or supplementary material, and are not part
87 of the formal definition.
88
89 \section{Objectives and Rationale}
90
91 DWARF has had a set of objectives since its inception which have 
92 guided the design and evolution of the debugging format.  A discussion 
93 of these objectives and the rationale behind them may help with an 
94 understanding of the DWARF Debugging Format. 
95
96 Although DWARF Version 1 was developed in the late 1980's as a 
97 format to support debugging C programs written for AT\&T hardware 
98 running SVR4, \DWARFVersionII{} and later has evolved far beyond 
99 this origin. One difference between DWARF and other formats 
100 is that the latter are often specific to a particular language, 
101 architecture, and/or operating system. 
102
103 \subsection{Language Independence}
104 DWARF is applicable to a broad range of existing procedural 
105 languages and is designed to be extensible to future languages.  
106 These languages may be considered to be "C-like" but the 
107 characteristics of C are not incorporated into DWARF Version 2 
108 and later, unlike DWARF Version 1 and other debugging formats.  
109 DWARF abstracts concepts as much as possible so that the 
110 description can be used to describe a program in any language. 
111 As an example, the DWARF descriptions used to describe C functions, 
112 Pascal subroutines, and Fortran subprograms are all the same, 
113 with different attributes used to specify the differences between 
114 these similar programming language features. 
115
116 On occasion, there is a feature which is specific to one 
117 particular language and which doesn't appear to have more 
118 general application.  For these, DWARF has a description 
119 designed to meet the language requirements, although, to the 
120 extent possible, an effort is made to generalize the attribute. 
121 An example of this is the \DWTAGconditionNAME{} 
122 debugging information entry, 
123 used to describe \addtoindex{COBOL} level 88 conditions, which 
124 is described in abstract terms rather than COBOL-specific terms.  
125 Conceivably, this TAG might be used with a different language 
126 which had similar functionality. 
127
128 \subsection{Architecture Independence}
129 DWARF can be used with a wide range of processor architectures, 
130 whether byte or word oriented, linear or segmented, with any 
131 word or byte size.  DWARF can be used with Von Neumann architectures, 
132 using a single address space for both code and data; Harvard 
133 architectures, with separate code and data address spaces; and 
134 potentially for other architectures such as DSPs with their 
135 idiosyncratic memory organizations.  DWARF can be used with 
136 common register-oriented architectures or with stack architectures. 
137
138 DWARF assumes that memory has individual units (words or bytes) 
139 which have unique addresses which are ordered.  (Some architectures 
140 like the i386 can represent the same physical machine location with 
141 different segment and offset pairs.  Identifying aliases is an 
142 implementation issue.)
143
144 \needlines{6}
145 \subsection{Operating System Independence}
146 DWARF is widely associated with SVR4 Unix and similar operating 
147 systems like BSD and Linux.  DWARF fits well with the section 
148 organization of the ELF object file format. Nonetheless, DWARF 
149 attempts to be independent of either the OS or the object file 
150 format.  There have been implementations of DWARF debugging 
151 data in COFF, Mach-O and other object file formats. 
152
153 DWARF assumes that any object file format will be able to 
154 distinguish the various DWARF data sections in some fashion, 
155 preferably by name. 
156
157 DWARF makes a few assumptions about functionality provided by 
158 the underlying operating system.  DWARF data sections can be 
159 read sequentially and independently.
160 Each DWARF data section is a sequence of 8-bit bytes, 
161 numbered starting with zero.  The presence of offsets from one 
162 DWARF data section into other data sections does not imply that 
163 the underlying OS must be able to position files randomly; a 
164 data section could be read sequentially and indexed using the offset. 
165
166 \subsection{Compact Data Representation} 
167 The DWARF description is designed to be a compact file-oriented 
168 representation. 
169
170 There are several encodings which achieve this goal, such as the 
171 TAG and attribute abbreviations or the line number encoding.  
172 References from one section to another, especially to refer to 
173 strings, allow these sections to be compacted to eliminate 
174 duplicate data. 
175
176 There are multiple schemes for eliminating duplicate data or 
177 reducing the size of the DWARF debug data associated with a 
178 given file.  These include COMDAT, used to eliminate duplicate 
179 function or data definitions, the split DWARF object files 
180 which allow a consumer to find DWARF data in files other than 
181 the executable, or the type units, which allow similar type 
182 definitions from multiple compilations to be combined. 
183
184 In most cases, it is anticipated that DWARF 
185 debug data will be read by a consumer (usually a debugger) and 
186 converted into a more efficiently accessed internal representation.  
187 For the most part, the DWARF data in a section is not the same as 
188 this internal representation.
189
190 \needlines{4}
191 \subsection{Efficient Processing} 
192 DWARF is designed to be processed efficiently, so that a 
193 producer (a compiler) can generate the debug descriptions 
194 incrementally and a consumer can read only the descriptions 
195 which it needs at a given time. The data formats are designed 
196 to be efficiently interpreted by a consumer.
197
198 As mentioned, there is a tension between this objective and 
199 the preceding one.  A DWARF data representation which resembles 
200 an internal data representation may lead to faster processing, 
201 but at the expense of larger data files. This may also constrain 
202 the possible implementations.
203
204 \subsection{Implementation Independence}
205 DWARF attempts to allow developers the greatest flexibility 
206 in designing implementations, without mandating any particular 
207 design decisions. Issues which can be described as 
208 quality-of-implementation are avoided.
209
210 \subsection{Explicit Rather Than Implicit Description}
211 DWARF describes the source to object translation explicitly 
212 rather than using common practice or convention as an implicit 
213 understanding between producer and consumer.  For example, where 
214 other debugging formats assume that a debugger knows how to 
215 unwind the stack, moving from one stack frame to the next using 
216 implicit knowledge about the architecture or operating system, 
217 DWARF makes this explicit in the Call Frame Information description.
218
219 \subsection{Avoid Duplication of Information}
220 DWARF has a goal of describing characteristics of a program once, 
221 rather than repeating the same information multiple times.  The 
222 string sections can be compacted to eliminate duplicate strings, 
223 for example.  Other compaction schemes or references between 
224 sections support this. Whether a particular implementation is 
225 effective at eliminating duplicate data, or even attempts to, 
226 is a quality-of-implementation issue.  
227
228 \subsection{Leverage Other Standards}
229 Where another standard exists which describes how to interpret 
230 aspects of a program, DWARF defers to that standard rather than 
231 attempting to duplicate the description.  For example, C++ has 
232 specific rules for deciding which function to call depending 
233 name, scope, argument types, and other factors.  DWARF describes 
234 the functions and arguments, but doesn't attempt to describe 
235 how one would be selected by a consumer performing any particular 
236 operation.
237
238 \subsection{Limited Dependence on Tools}
239 DWARF data is designed so that it can be processed by commonly 
240 available assemblers, linkers, and other support programs, 
241 without requiring additional functionality specifically to 
242 support DWARF data.  This may require the implementer to be 
243 careful that they do not generate DWARF data which cannot be 
244 processed by these programs.  Conversely, an assembler which 
245 can generate LEB128 (Little-Endian Base 128) 
246 values may allow the compiler to generate 
247 more compact descriptions, and a linker which understands the 
248 format of string sections can merge these sections.  Whether 
249 or not an implementation includes these functions is a 
250 quality-of-implementation issue, not mandated by the DWARF 
251 specification.
252
253 \subsection{Separate Description From Implementation}
254 DWARF intends to describe the translation of a program from 
255 source to object, while neither mandating any particular design 
256 nor making any other design difficult.  For example, DWARF 
257 describes how the arguments and local variables in a function 
258 are to be described, but doesn't specify how this data is 
259 collected or organized by a producer.  Where a particular DWARF 
260 feature anticipates that it will be implemented in a certain 
261 fashion, informative text will suggest but not require this design.
262
263 \subsection{Permissive Rather Than Prescriptive}
264 \bb
265 The DWARF Standard specifies the meaning of DWARF descriptions. It does not
266 specify in detail what a particular producer should generate for any source to
267 object conversion.  One producer may generate a more complete description
268 than another, it may describe features in a different order (unless the 
269 standard explicitly requires a particular order), or it may use
270 different abbreviations or compression methods.  Similarly, DWARF does not
271 specify exactly what a particular consumer should do with each part of the
272 description, although we believe that the potential uses for each description
273 should be evident.
274
275 DWARF is permissive, allowing different producers to generate different
276 descriptions for the same source to object conversion, and permitting
277 different consumers to provide more or less functionality or information
278 to the user.  This may result in debugging information being larger or
279 smaller, compilers or debuggers which are faster or slower, and more or
280 less functional.  These are described as differences in "Quality of
281 Implementation".
282
283 Each producer conforming to the DWARF standard must follow the format and
284 meaning as specified in the standard.  As long as the DWARF description
285 generated follows this specification, the producer is generating valid DWARF.
286 For example, DWARF allows a producer to identify the end of a function
287 prologue in the Line Information so that a debugger can stop at this location.
288 A producer which does this is generating valid DWARF, as is another which
289 doesn't.  As another example, one producer may generate descriptions
290 for variables which are moved from memory to a register in a certain range,
291 while another may only describe the variable's location in memory.  Both are
292 valid DWARF descriptions, while a consumer using the former would be able
293 to provide more accurate values for the variable while executing in that
294 range than a consumer using the latter.
295 \eb
296
297 \subsection{Vendor Extensibility}
298 This document does not attempt to cover all interesting
299 languages or even to cover all of the possible debugging
300 information needs for its primary target languages. 
301 Therefore,
302 the document provides vendors a way to define their own
303 debugging information tags, attributes, base type encodings,
304 location operations, language names, calling conventions and
305 call frame instructions by reserving a subset of the valid
306 values for these constructs for vendor specific additions
307 and defining related naming conventions. 
308 Vendors may also use
309 debugging information entries and attributes defined here in
310 new situations. 
311 Future versions of this document will not use
312 names or values reserved for vendor specific additions. 
313 All names and values not reserved for vendor additions, however,
314 are reserved for future versions of this document.
315
316 Where this specification provides a means for
317 describing the source language, implementors are expected
318 to adhere to that specification. 
319 For language features that
320 are not supported, implementors may use existing attributes
321 in novel ways or add vendor-defined attributes. 
322 Implementors
323 who make extensions are strongly encouraged to design them
324 to be compatible with this specification in the absence of
325 those extensions.
326
327 The DWARF format is organized so that a consumer can skip over
328 data which it does not recognize. This may allow a consumer
329 to read and process files generated according to a later
330 version of this standard or which contain vendor extensions,
331 albeit possibly in a degraded manner.
332
333 \section{Changes From Version 4 to Version 5}
334 \addtoindexx{DWARF Version 5}
335 The following is a list of the major changes made to the 
336 DWARF Debugging Information Format since Version 4 was published. 
337 The list is not meant to be exhaustive.
338 \begin{itemize}
339 \item The \dotdebugtypes{}
340 %\addtoindexi{\texttt{.debug\_types}}{\texttt{.debug\_types} (Version 4)}
341 section introduced in \DWARFVersionIV{} 
342 is eliminated and its contents instead contained in \dotdebuginfo{} sections.
343 \item Add support for collecting common DWARF information 
344 (debugging information entries and macro definitions)
345 across multiple executable and shared files and keeping it in a single
346 \addtoindex{supplementary object file}.
347 \needlines{6}
348 \item A new line number program header format 
349 provides the ability to use an MD5 hash to validate 
350 the source file version in use, allows pooling 
351 of directory and file name strings and makes provision for vendor-defined
352 extensions. It also adds a string section specific to the line number table 
353 (\dotdebuglinestr)
354 to properly support the common practice of stripping all DWARF sections
355 except for line number information.
356 \needlines{4}
357 \item Add a split object file and package representations to allow most 
358 DWARF information to be kept separate from an executable 
359 or shared image. This includes new sections 
360 \dotdebugaddr, \dotdebugstroffsets, \dotdebugabbrevdwo, \dotdebuginfodwo, 
361 \dotdebuglinedwo, \dotdebuglocdwo, \dotdebugmacrodwo, \dotdebugstrdwo,
362 \dotdebugstroffsetsdwo, \dotdebugcuindex{} and \dotdebugtuindex{} 
363 together with new forms of attribute value for referencing these sections.
364 This enhances DWARF support by reducing executable program size and
365 by improving link times.
366 \item Replace the \dotdebugmacinfo{} macro information representation with
367 with a \dotdebugmacro{} representation that can potentially be much more compact.
368
369 \item Replace the \dotdebugpubnames{} and \dotdebugpubtypes{} sections
370 with a single and more functional name index section, \dotdebugnames{}.
371 \item Add a new debugging information entry (\DWTAGcallsiteNAME), related 
372 attributes and DWARF expression operators to describe call site information, 
373 including identification of tail calls and tail recursion.
374 \item Add improved support for \addtoindex{FORTRAN} assumed rank arrays 
375 (\DWTAGgenericsubrangeNAME), dynamic rank arrays (\DWATrankNAME)
376 and co-arrays (\DWTAGcoarraytypeNAME{}).
377 \item Add new operations that allow support for 
378 a DWARF expression stack containing typed values.
379 \item Add improved support for the \addtoindex{C++}:
380 \texttt{auto} return type, deleted member functions (\DWATdeletedNAME), 
381 as well as defaulted constructors and destructors (\DWATdefaultedNAME).
382 \item Add a new attribute (\DWATnoreturnNAME{}), to identify 
383 a subprogram that does not return to its caller.
384 \item Add language codes for C 2011, C++ 2003, C++ 2011, C++ 2014,
385 Dylan, Fortran 2003, Fortran 2008, Go, Haskell, 
386 Julia, Modula 3, Ocaml, OpenCL, Rust and Swift.
387 \item Numerous other more minor additions to improve functionality
388 and performance.
389 \end{itemize}
390
391 DWARF Version 5 is compatible with DWARF Version 4 except as follows:
392 \begin{itemize}
393 \item The compilation unit header (in the \dotdebuginfo{} section) has
394 a new \HFNunittype{} field.
395 \needlines{4}
396 \item New operand forms for attribute values are defined 
397 (\DWFORMaddrxNAME, \DWFORMdatasixteenNAME, \DWFORMimplicitconstNAME, 
398 \DWFORMlinestrpNAME, 
399 \DWFORMrefsupNAME, \DWFORMstrpsupNAME{} and \DWFORMstrxNAME).
400
401 \textit{Because a pre-DWARF Version 5 consumer will not be able to interpret 
402 these even to ignore and skip over them, new forms must be 
403 considered incompatible additions.}
404 \item The line number table header is substantially revised.
405 \needlines{4}
406 \item A location list entry 
407 with the address range \mbox{(0, \textit{maximum-address})} is defined 
408 as the new default location list entry.
409 \item In a string type, the \DWATbytesizeNAME{} attribute is re-defined 
410 to always describe the size of the string type. 
411 (Previously it described the size of the optional string length data 
412 field if the \DWATstringlengthNAME{} attribute was also present.)
413 \end{itemize}
414
415 While not strictly an incompatibility, the macro information 
416 representation is completely new; further, producers 
417 and consumers may optionally continue to support the older 
418 representation. While the two representations cannot both be 
419 used in the same compilation unit, they can co-exist in 
420 executable or shared images.
421
422 Similar comments apply to replacement of the \dotdebugpubnames{} 
423 and \dotdebugpubtypes{} sections with the new \dotdebugnames{} 
424 section.
425
426 \needlines{4}
427 \section{Changes from Version 3 to Version 4}
428 \addtoindexx{DWARF Version 4}
429 The following is a list of the major changes made to the 
430 DWARF Debugging Information Format since Version 3 was 
431 published. The list is not meant to be exhaustive.
432 \begin{itemize}
433 \item Reformulate 
434 Section 2.6 (Location Descriptions) 
435 to better distinguish DWARF location descriptions, which
436 compute the location where a value is found (such as an 
437 address in memory or a register name) from DWARF expressions, 
438 which compute a final value (such as an array bound).
439 \item Add support for bundled instructions on machine architectures 
440 where instructions do not occupy a whole number of bytes.
441 \item Add a new attribute form for section offsets, 
442 \DWFORMsecoffsetNAME,\addtoindexx{section offset}
443 to replace the use of 
444 \DWFORMdatafourNAME{} and \DWFORMdataeightNAME{} for section offsets.
445 \item Add an attribute, \DWATmainsubprogramNAME, to identify the main subprogram of a
446 program.
447 \item Define default array lower bound values for each supported language.
448 \item Add a new technique using separate type units, type signatures and \COMDAT{} sections to
449 improve compression and duplicate elimination of DWARF information.
450 \item Add support for new \addtoindex{C++} language constructs, including rvalue references, generalized
451 constant expressions, Unicode character types and template aliases.
452 \item Clarify and generalize support for packed arrays and structures.
453 \item Add new line number table support to facilitate profile based compiler optimization.
454 \item Add additional support for template parameters in instantiations.
455 \item Add support for strongly typed enumerations in languages (such as \addtoindex{C++}) that have two
456 kinds of enumeration declarations.
457 \end{itemize}
458 \addtoindex{DWARF Version 4} is compatible with 
459 \addtoindex{DWARF Version 3} except as follows:
460 \begin{itemize}
461 \item DWARF attributes that use any of the new forms of attribute value representation (for
462 section offsets, flag compression, type signature references, and so on) cannot be read by
463 \addtoindex{DWARF Version 3}
464 consumers because the consumer will not know how to skip over the
465 unexpected form of data.
466 \item DWARF frame and line number table sections include additional fields that affect the location
467 and interpretation of other data in the section.
468 \end{itemize}
469
470 \section{Changes from Version 2 to Version 3}
471 \addtoindexx{DWARF Version 3}
472 The following is a list of the major differences between
473 Version 2 and Version 3 of the DWARF Debugging Information
474 Format. The list is not meant to be exhaustive.
475 \begin{itemize}
476 \item
477 Make provision for DWARF information files that are larger
478 than 4 GBytes.
479 \item
480 Allow attributes to refer to debugging information entries
481 in other shared libraries.
482 \item
483 Add support for \addtoindex{Fortran 90} modules as well as allocatable
484 array and pointer types.
485 \item
486 Add additional base types for \addtoindex{C} (as revised for 1999).
487 \item
488 Add support for \addtoindex{Java} and \addtoindex{COBOL}.
489 \item
490 Add namespace support for \addtoindex{C++}.
491 \item
492 Add an optional section for global type names (similar to
493 the global section for objects and functions).
494 \item
495 Adopt \addtoindex{UTF-8} as the preferred representation of program name strings.
496 \item
497 Add improved support for optimized code (discontiguous
498 scopes, end of prologue determination, multiple section
499 code generation).  
500 \item Improve the ability to eliminate
501 duplicate DWARF information during linking.  
502 \end{itemize}
503
504 \addtoindex{DWARF Version 3}
505 is compatible with 
506 \addtoindex{DWARF Version 2} except as follows:
507 \begin{itemize}
508 \item
509 Certain very large values of the initial length fields that
510 begin DWARF sections as well as certain structures are reserved
511 to act as escape codes for future extension; one such extension
512 is defined to increase the possible size of DWARF descriptions
513 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
514 \item
515 References that use the attribute form 
516 \DWFORMrefaddrNAME{}
517 are specified to be four bytes in the DWARF 32-bit format and
518 eight bytes in the DWARF 64-bit format, while 
519 \addtoindex{DWARF Version 2} 
520 specifies that such references have the same size as an
521 address on the target system (see Sections 
522 \refersec{datarep:32bitand64bitdwarfformats} and 
523 \refersec{datarep:attributeencodings}).
524 \item
525 The return\_address\_register field in a Common Information
526 Entry record for call frame information is changed to unsigned
527 LEB representation (see Section 
528 \refersec{chap:structureofcallframeinformation}).
529 \end{itemize}
530
531 \section{Changes from Version 1 to Version 2}
532 \addtoindex{DWARF Version 2} 
533 describes the second generation of debugging
534 information based on the DWARF format. While 
535 \addtoindex{DWARF Version 2}
536 provides new debugging information not available in
537 Version 1, the primary focus of the changes for Version
538 2 is the representation of the information, rather than
539 the information content itself. The basic structure of
540 the Version 2 format remains as in Version 1: the debugging
541 information is represented as a series of debugging information
542 entries, each containing one or more attributes (name/value
543 pairs). The Version 2 representation, however, is much more
544 compact than the Version 1 representation. In some cases,
545 this greater density has been achieved at the expense of
546 additional complexity or greater difficulty in producing and
547 processing the DWARF information. The definers believe that the
548 reduction in I/O and in memory paging should more than make
549 up for any increase in processing time.  
550
551 \needlines{5}
552 The representation
553 of information changed from Version 1 to Version 2, so that
554 Version 2 DWARF information is not binary compatible with
555 Version 1 information. To make it easier for consumers to
556 support both Version 1 and Version 2 DWARF information, the
557 Version 2 information has been moved to a different object
558 file section, \dotdebuginfo{}.  
559
560 \textit{
561 A summary of the major changes made in 
562 \addtoindex{DWARF Version 2}
563 compared to the DWARF Version 1 may be found in the 
564 \addtoindex{DWARF Version 2}
565 document.
566 }
567