Added a make check target to list missing references.
[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.
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.
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.
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.
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.
52 \section{Overview}
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.
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}.
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.
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}
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.
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.
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.
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 TBD...
140 \end{itemize}
142 DWARF Version 5 is compatible with DWARF Version 4 except as follows:
143 \begin{itemize}
144 \item A location list entry (see Section \refersec{chap:locationlists}) with 
145 the address range (0, \doublequote{-1}) is defined as the new default location 
146 list entry.
147 \item In a string type (see Section \refersec{chap:stringtypeentries}, a \DWATbytesize{}
148 attribute is defined to always describe the size of the string type. (Previously
149 it described the size of the optional string length data field if the \DWATstringlength{}
150 attribute was present.)
151 \end{itemize}
153 \section{Changes from Version 3 to Version 4}
154 \addtoindexx{DWARF Version 4}
155 The following is a list of the major changes made to the DWARF Debugging Information
156 Format since Version 3 was published. The list is not meant to be exhaustive.
157 \begin{itemize}
158 \item Reformulate 
159 Section 2.6 (Location Descriptions) 
160 to better distinguish DWARF location descriptions, which
161 compute the location where a value is found (such as an address in memory or a register
162 name) from DWARF expressions, which compute a final value (such as an array bound).
163 \item Add support for bundled instructions on machine architectures where instructions do not
164 occupy a whole number of bytes.
165 \item Add a new attribute form for 
166 section offsets, \livelink{chap:DWFORMsecoffset}{DW\_FORM\_sec\_offset}, 
167 \addtoindexx{section offset}
168 to replace the use
169 of \livelink{chap:DWFORMdata4}{DW\_FORM\_data4} and \livelink{chap:DWFORMdata8}{DW\_FORM\_data8} for section offsets.
170 \item Add an attribute, \livelink{chap:DWATmainsubprogram}{DW\_AT\_main\_subprogram}, to identify the main subprogram of a
171 program.
172 \item Define default array lower bound values for each supported language.
173 \item Add a new technique using separate type units, type signatures and COMDAT sections to
174 improve compression and duplicate elimination of DWARF information.
175 \item Add support for new C++ language constructs, including rvalue references, generalized
176 constant expressions, Unicode character types and template aliases.
177 \item Clarify and generalize support for packed arrays and structures.
178 \item Add new line number table support to facilitate profile based compiler optimization.
179 \item Add additional support for template parameters in instantiations.
180 \item Add support for strongly typed enumerations in languages (such as C++) that have two
181 kinds of enumeration declarations.
182 \end{itemize}
183 \addtoindex{DWARF Version 4} is compatible with 
184 \addtoindex{DWARF Version 3} except as follows:
185 \begin{itemize}
186 \item DWARF attributes that use any of the new forms of attribute value representation (for
187 section offsets, flag compression, type signature references, and so on) cannot be read by
188 \addtoindex{DWARF Version 3}
189 consumers because the consumer will not know how to skip over the
190 unexpected form of data.
191 \item DWARF frame and line table sections include a additional fields that affect the location
192 and interpretation of other data in the section.
193 \end{itemize}
195 \section{Changes from Version 2 to Version 3}
196 \addtoindexx{DWARF Version 3}
197 The following is a list of the major differences between
198 Version 2 and Version 3 of the DWARF Debugging Information
199 Format. The list is not meant to be exhaustive.
200 \begin{itemize}
201 \item
202 Make provision for DWARF information files that are larger
203 than 4 GBytes.
204 \item
205 Allow attributes to refer to debugging information entries
206 in other shared libraries.
207 \item
208 Add support for \addtoindex{Fortran 90} modules as well as allocatable
209 array and pointer types.
210 \item
211 Add additional base types for \addtoindex{C} (as revised for 1999).
212 \item
213 Add support for \addtoindex{Java} and \addtoindex{COBOL}.
214 \item
215 Add namespace support for \addtoindex{C++}.
216 \item
217 Add an optional section for global type names (similar to
218 the global section for objects and functions).
219 \item
220 Adopt \addtoindex{UTF-8} as the preferred representation of program name strings.
221 \item
222 Add improved support for optimized code (discontiguous
223 scopes, end of prologue determination, multiple section
224 code generation).  
225 \item Improve the ability to eliminate
226 duplicate DWARF information during linking.  
227 \end{itemize}
229 \addtoindex{DWARF Version 3}
230 is compatible with 
231 \addtoindex{DWARF Version 2} except as follows:
232 \begin{itemize}
233 \item
234 Certain very large values of the initial length fields that
235 begin DWARF sections as well as certain structures are reserved
236 to act as escape codes for future extension; one such extension
237 is defined to increase the possible size of DWARF descriptions
238 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
239 \item
240 References that use the attribute form 
241 \livelink{chap:DWFORMrefaddr}{DW\_FORM\_ref\_addr}
242 are specified to be four bytes in the DWARF 32-bit format and
243 eight bytes in the DWARF 64-bit format, while 
244 \addtoindex{DWARF Version 2} 
245 specifies that such references have the same size as an
246 address on the target system (see Sections 
247 \refersec{datarep:32bitand64bitdwarfformats} and 
248 \refersec{datarep:attributeencodings}).
249 \item
250 The return\_address\_register field in a Common Information
251 Entry record for call frame information is changed to unsigned
252 LEB representation (see Section 
253 \refersec{chap:structureofcallframeinformation}).
254 \end{itemize}
256 \section{Changes from Version 1 to Version 2}
257 \addtoindex{DWARF Version 2} 
258 describes the second generation of debugging
259 information based on the DWARF format. While 
260 \addtoindex{DWARF Version 2}
261 provides new debugging information not available in
262 Version 1, the primary focus of the changes for Version
263 2 is the representation of the information, rather than
264 the information content itself. The basic structure of
265 the Version 2 format remains as in Version 1: the debugging
266 information is represented as a series of debugging information
267 entries, each containing one or more attributes (name/value
268 pairs). The Version 2 representation, however, is much more
269 compact than the Version 1 representation. In some cases,
270 this greater density has been achieved at the expense of
271 additional complexity or greater difficulty in producing and
272 processing the DWARF information. The definers believe that the
273 reduction in I/O and in memory paging should more than make
274 up for any increase in processing time.  
276 The representation
277 of information changed from Version 1 to Version 2, so that
278 Version 2 DWARF information is not binary compatible with
279 Version 1 information. To make it easier for consumers to
280 support both Version 1 and Version 2 DWARF information, the
281 Version 2 information has been moved to a different object
282 file section, \dotdebuginfo{}.  
284 \textit{
285 A summary of the major changes made in 
286 \addtoindex{DWARF Version 2}
287 compared to the DWARF Version 1 may be found in the 
288 \addtoindex{DWARF Version 2}
289 document.
290 }