Complete processing of review comments to date and do index improvements.
[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. 
8 It can be used by debuggers and other tools. 
9 The
10 debugging information format does not favor the design of any
11 compiler or debugger. 
12 Instead, the goal is to create a method
13 of communicating an accurate picture of the source program
14 to any debugger in a form that is extensible to different
15 languages while retaining compatibility.
16   
17 The design of the
18 debugging information format is open-ended, allowing for
19 the addition of new debugging information to accommodate new
20 languages or debugger capabilities while remaining compatible
21 with other languages or different debuggers.
22
23 \section{Purpose and Scope}
24 The debugging information format described in this document is
25 designed to meet the symbolic, source-level debugging needs of
26 different languages in a unified fashion by requiring language
27 independent debugging information whenever possible.  
28 Aspects
29 of individual languages, such as \addtoindex{C++} virtual functions or
30 \addtoindex{Fortran} common 
31 \nolink{blocks}, are accommodated by creating attributes
32 that are used only for those languages. 
33 This document is
34 believed to cover most debugging information needs of 
35 \addtoindex{Ada},
36 \addtoindex{C}, \addtoindex{C++}, \addtoindex{COBOL}, 
37 and \addtoindex{Fortran}; it also covers the basic needs
38 of various other languages.
39
40 This document describes \addtoindex{DWARF Version 4},
41 the fourth generation
42 of debugging information based on the DWARF format. DWARF
43 Version 4 extends \addtoindex{DWARF Version 3}
44 in a compatible manner.
45
46 The intended audience for this document is the developers
47 of both producers and consumers of debugging information,
48 typically compilers, debuggers and other tools that need to
49 interpret a binary program in terms of its original source.
50
51
52 \section{Overview}
53
54 There are two major pieces to the description of the DWARF
55 format in this document. The first piece is the informational
56 content of the debugging entries. The second piece is the
57 way the debugging information is encoded and represented in
58 an object file.
59
60 The informational content is described in 
61 Sections \ref{chap:generaldescription} 
62 through
63 \ref{chap:otherdebugginginformation}. 
64 Section  \ref{chap:generaldescription}
65 describes the overall structure of the information
66 and attributes that is common to many or all of the different
67 debugging information entries. 
68 Sections \ref{chap:programscopeentries}, 
69 \ref{chap:dataobjectandobjectlistentries} and 
70 \ref{chap:typeentries} describe
71 the specific debugging information entries and how they
72 communicate the necessary information about the source program
73 to a debugger. 
74 Section \ref{chap:otherdebugginginformation} 
75 describes debugging information
76 contained outside of the debugging information entries. The
77 encoding of the DWARF information is presented in 
78 Section \ref{datarep:datarepresentation}.
79
80 This organization closely follows that used in the DWARF
81 Version 3 document. Except where needed to incorporate
82 new material or to correct errors, the 
83 \addtoindex{DWARF Version 3}
84 text is generally reused in this document with little or
85 no modification.
86
87 In the following sections, text in normal font describes
88 required aspects of the DWARF format.  Text in \textit{italics} is
89 explanatory or supplementary material, and not part of the
90 format definition itself. The several appendices consist only
91 of explanatory or supplementary material, and are not part
92 of the formal definition.
93 \section{Vendor Extensibility}
94
95 This document does not attempt to cover all interesting
96 languages or even to cover all of the interesting debugging
97 information needs for its primary target languages. 
98 Therefore,
99 the document provides vendors a way to define their own
100 debugging information tags, attributes, base type encodings,
101 location operations, language names, calling conventions and
102 call frame instructions by reserving a subset of the valid
103 values for these constructs for vendor specific additions
104 and defining related naming conventions. 
105 Vendors may also use
106 debugging information entries and attributes defined here in
107 new situations. 
108 Future versions of this document will not use
109 names or values reserved for vendor specific additions. 
110 All
111 names and values not reserved for vendor additions, however,
112 are reserved for future versions of this document.
113
114 \addtoindex{DWARF Version 4} is intended to be permissive rather than
115 prescriptive. 
116 Where this specification provides a means for
117 describing the source language, implementors are expected
118 to adhere to that specification. 
119 For language features that
120 are not supported, implementors may use existing attributes
121 in novel ways or add vendor-defined attributes. 
122 Implementors
123 who make extensions are strongly encouraged to design them
124 to be compatible with this specification in the absence of
125 those extensions.
126
127 The DWARF format is organized so that a consumer can skip over
128 data which it does not recognize. 
129 This may allow a consumer
130 to read and process files generated according to a later
131 version of this standard or which contain vendor extensions,
132 albeit possibly in a degraded manner.
133
134 \section{Changes from Version 4 to Version 5}
135 \addtoindexx{DWARF Version 5}
136 The following is a list of the major changes made to the DWARF Debugging Information
137 Format since Version 4 was published. The list is not meant to be exhaustive.
138 \begin{itemize}
139 \item OTHERS TBD...
140 \item Add a split object file and package representations to allow most 
141 DWARF information to be compacted and/or kept separate from an executable 
142 or shared image. This includes new sections 
143 \dotdebugaddr, \dotdebugstroffsets, \dotdebugabbrevdwo, \dotdebuginfodwo, 
144 \dotdebuglinedwo, \dotdebuglocdwo, \dotdebugmacrodwo, \dotdebugstrdwo,
145 \dotdebugstroffsetsdwo, \dotdebugcuindex{} and \dotdebugtuindex{} 
146 together with new forms of attribute value for referencing these sections.
147 This enhances DWARF support for very large programs.
148 \item Replace the \dotdebugmacinfo{} macro information representation with
149 a much more compact \dotdebugmacro{} representation.
150 \item Add a new debugging information entry, related attributes and
151 DWARF expression operators, to describe call information, 
152 including identification of tail calls and tail recursion.
153 \item Add a new attribute, \DWATnoreturn{}, to identify a subprogram that 
154 does not return to its caller.
155 \item Add a new attribute, \DWATrank{}, to describe the dimensionality of
156 an array with dynamic rank.
157 \item Add a new tag, \DWTAGgenericsubrange{}, to describe the
158 bounds of Fortran assumed-rank arrays.
159 \item Add language codes for C 2011, C++ 2003, C++ 2011, Dylan, Go, Haskell, 
160 Julia, Modula 3, Ocaml, Rust, OpenCL and Swift.
161 \end{itemize}
162
163 DWARF Version 5 is compatible with DWARF Version 4 except as follows:
164 \begin{itemize}
165 \item A new field is included in the line number table header to allow use of an MD5
166 hash to validate source file version in use.
167 \item New operand forms for attribute values are defined (\DWFORMstrx, \DWFORMaddrx).
168 (Because a pre-DWARF Version 5 consumer will not be able to interpret these even to
169 ignore and skip over them, they must be considered incompatible.)
170 \item A location list entry (see Section \refersec{chap:locationlists}) with 
171 the address range \mbox{(0, \doublequote{-1})} is defined as the new default location 
172 list entry.
173 \item In a string type (see Section \refersec{chap:stringtypeentries}), a \DWATbytesize{}
174 attribute is defined to always describe the size of the string type. (Previously
175 it described the size of the optional string length data field if the \DWATstringlength{}
176 attribute was present.)
177 \end{itemize}
178
179 While not strictly an incompatibility, the macro information 
180 representation is completely new; further, producers 
181 and consumers may optionally continue to support the older 
182 representation. While the two representations cannot both be 
183 used in the same compilation unit, they can co-exist in 
184 executable or shared images.
185
186 \needlines{4}
187 \section{Changes from Version 3 to Version 4}
188 \addtoindexx{DWARF Version 4}
189 The following is a list of the major changes made to the DWARF Debugging Information
190 Format since Version 3 was published. The list is not meant to be exhaustive.
191 \begin{itemize}
192 \item Reformulate 
193 Section 2.6 (Location Descriptions) 
194 to better distinguish DWARF location descriptions, which
195 compute the location where a value is found (such as an address in memory or a register
196 name) from DWARF expressions, which compute a final value (such as an array bound).
197 \item Add support for bundled instructions on machine architectures where instructions do not
198 occupy a whole number of bytes.
199 \item Add a new attribute form for 
200 section offsets, \DWFORMsecoffset, 
201 \addtoindexx{section offset}
202 to replace the use
203 of \DWFORMdatafour{} and \DWFORMdataeight{} for section offsets.
204 \item Add an attribute, \DWATmainsubprogram, to identify the main subprogram of a
205 program.
206 \item Define default array lower bound values for each supported language.
207 \item Add a new technique using separate type units, type signatures and \COMDAT{} sections to
208 improve compression and duplicate elimination of DWARF information.
209 \item Add support for new \addtoindex{C++} language constructs, including rvalue references, generalized
210 constant expressions, Unicode character types and template aliases.
211 \item Clarify and generalize support for packed arrays and structures.
212 \item Add new line number table support to facilitate profile based compiler optimization.
213 \item Add additional support for template parameters in instantiations.
214 \item Add support for strongly typed enumerations in languages (such as \addtoindex{C++}) that have two
215 kinds of enumeration declarations.
216 \end{itemize}
217 \addtoindex{DWARF Version 4} is compatible with 
218 \addtoindex{DWARF Version 3} except as follows:
219 \begin{itemize}
220 \item DWARF attributes that use any of the new forms of attribute value representation (for
221 section offsets, flag compression, type signature references, and so on) cannot be read by
222 \addtoindex{DWARF Version 3}
223 consumers because the consumer will not know how to skip over the
224 unexpected form of data.
225 \item DWARF frame and line table sections include a additional fields that affect the location
226 and interpretation of other data in the section.
227 \end{itemize}
228
229 \section{Changes from Version 2 to Version 3}
230 \addtoindexx{DWARF Version 3}
231 The following is a list of the major differences between
232 Version 2 and Version 3 of the DWARF Debugging Information
233 Format. The list is not meant to be exhaustive.
234 \begin{itemize}
235 \item
236 Make provision for DWARF information files that are larger
237 than 4 GBytes.
238 \item
239 Allow attributes to refer to debugging information entries
240 in other shared libraries.
241 \item
242 Add support for \addtoindex{Fortran 90} modules as well as allocatable
243 array and pointer types.
244 \item
245 Add additional base types for \addtoindex{C} (as revised for 1999).
246 \item
247 Add support for \addtoindex{Java} and \addtoindex{COBOL}.
248 \item
249 Add namespace support for \addtoindex{C++}.
250 \item
251 Add an optional section for global type names (similar to
252 the global section for objects and functions).
253 \item
254 Adopt \addtoindex{UTF-8} as the preferred representation of program name strings.
255 \item
256 Add improved support for optimized code (discontiguous
257 scopes, end of prologue determination, multiple section
258 code generation).  
259 \item Improve the ability to eliminate
260 duplicate DWARF information during linking.  
261 \end{itemize}
262
263 \addtoindex{DWARF Version 3}
264 is compatible with 
265 \addtoindex{DWARF Version 2} except as follows:
266 \begin{itemize}
267 \item
268 Certain very large values of the initial length fields that
269 begin DWARF sections as well as certain structures are reserved
270 to act as escape codes for future extension; one such extension
271 is defined to increase the possible size of DWARF descriptions
272 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
273 \item
274 References that use the attribute form 
275 \DWFORMrefaddr{}
276 are specified to be four bytes in the DWARF 32-bit format and
277 eight bytes in the DWARF 64-bit format, while 
278 \addtoindex{DWARF Version 2} 
279 specifies that such references have the same size as an
280 address on the target system (see Sections 
281 \refersec{datarep:32bitand64bitdwarfformats} and 
282 \refersec{datarep:attributeencodings}).
283 \item
284 The return\_address\_register field in a Common Information
285 Entry record for call frame information is changed to unsigned
286 LEB representation (see Section 
287 \refersec{chap:structureofcallframeinformation}).
288 \end{itemize}
289
290 \section{Changes from Version 1 to Version 2}
291 \addtoindex{DWARF Version 2} 
292 describes the second generation of debugging
293 information based on the DWARF format. While 
294 \addtoindex{DWARF Version 2}
295 provides new debugging information not available in
296 Version 1, the primary focus of the changes for Version
297 2 is the representation of the information, rather than
298 the information content itself. The basic structure of
299 the Version 2 format remains as in Version 1: the debugging
300 information is represented as a series of debugging information
301 entries, each containing one or more attributes (name/value
302 pairs). The Version 2 representation, however, is much more
303 compact than the Version 1 representation. In some cases,
304 this greater density has been achieved at the expense of
305 additional complexity or greater difficulty in producing and
306 processing the DWARF information. The definers believe that the
307 reduction in I/O and in memory paging should more than make
308 up for any increase in processing time.  
309
310 The representation
311 of information changed from Version 1 to Version 2, so that
312 Version 2 DWARF information is not binary compatible with
313 Version 1 information. To make it easier for consumers to
314 support both Version 1 and Version 2 DWARF information, the
315 Version 2 information has been moved to a different object
316 file section, \dotdebuginfo{}.  
317
318 \textit{
319 A summary of the major changes made in 
320 \addtoindex{DWARF Version 2}
321 compared to the DWARF Version 1 may be found in the 
322 \addtoindex{DWARF Version 2}
323 document.
324 }
325