Indexes more entries starting with a.
[dwarf-doc.git] / dwarf5 / latexdoc / introduction.tex
1 \chapter{Introduction}
2 \label{chap:introduction}
3 This document defines a format for describing programs to
4 facilitate user source level debugging. This description
5 can be generated by compilers, assemblers and linkage
6 editors. 
7 It can be used by debuggers and other tools. 
8 The
9 debugging information format does not favor the design of any
10 compiler or debugger. 
11 Instead, the goal is to create a method
12 of communicating an accurate picture of the source program
13 to any debugger in a form that is extensible to different
14 languages while retaining compatibility.  
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 C++ virtual functions or
28 Fortran common \nolink{blocks}, are accommodated by creating attributes
29 that are used only for those languages. 
30 This document is
31 believed to cover most debugging information needs of 
32 addtoindex{Ada},
33 C, C++, COBOL, and Fortran; it also covers the basic needs
34 of various other languages.
35
36 This document describes DWARF Version 4, the fourth generation
37 of debugging information based on the DWARF format. DWARF
38 Version 4 extends DWARF Version 3 in a compatible manner.
39
40 The intended audience for this document is the developers
41 of both producers and consumers of debugging information,
42 typically compilers, debuggers and other tools that need to
43 interpret a binary program in terms of its original source.
44
45 \section{Overview}
46
47
48 There are two major pieces to the description of the DWARF
49 format in this document. The first piece is the informational
50 content of the debugging entries. The second piece is the
51 way the debugging information is encoded and represented in
52 an object file.
53
54 The informational content is described in 
55 Sections \refersec{chap:generaldescription} 
56 through
57 \refersec{chap:otherdebugginginformation}. 
58 Section  \refersec{chap:generaldescription}
59 describes the overall structure of the information
60 and attributes that is common to many or all of the different
61 debugging information entries. 
62 Sections \refersec{chap:programscopeentries}, 
63 \refersec{chap:dataobjectandobjectlistentries} and 
64 \refersec{chap:typeentries} describe
65 the specific debugging information entries and how they
66 communicate the necessary information about the source program
67 to a debugger. 
68 Section \refersec{chap:otherdebugginginformation} 
69 describes debugging information
70 contained outside of the debugging information entries. The
71 encoding of the DWARF information is presented in 
72 Section \refersec{datarep:datarepresentation}.
73
74 This organization closely follows that used in the DWARF
75 Version 3 document. Except where needed to incorporate
76 new material or to correct errors, the DWARF Version 3
77 text is generally reused in this document with little or
78 no modification.
79
80 In the following sections, text in normal font describes
81 required aspects of the DWARF format.  Text in italics is
82 explanatory or supplementary material, and not part of the
83 format definition itself. The several appendices consist only
84 of explanatory or supplementary material, and are not part
85 of the formal definition.
86 \section{Vendor Extensibility}
87
88 This document does not attempt to cover all interesting
89 languages or even to cover all of the interesting debugging
90 information needs for its primary target languages. 
91 Therefore,
92 the document provides vendors a way to define their own
93 debugging information tags, attributes, base type encodings,
94 location operations, language names, calling conventions and
95 call frame instructions by reserving a subset of the valid
96 values for these constructs for vendor specific additions
97 and defining related naming conventions. 
98 Vendors may also use
99 debugging information entries and attributes defined here in
100 new situations. 
101 Future versions of this document will not use
102 names or values reserved for vendor specific additions. 
103 All
104 names and values not reserved for vendor additions, however,
105 are reserved for future versions of this document.
106
107 DWARF Version 5 is intended to be permissive rather than
108 prescriptive. 
109 Where this specification provides a means for
110 describing the source language, implementors are expected
111 to adhere to that specification. 
112 For language features that
113 are not supported, implementors may use existing attributes
114 in novel ways or add vendor-defined attributes. 
115 Implementors
116 who make extensions are strongly encouraged to design them
117 to be compatible with this specification in the absence of
118 those extensions.
119
120 The DWARF format is organized so that a consumer can skip over
121 data which it does not recognize. 
122 This may allow a consumer
123 to read and process files generated according to a later
124 version of this standard or which contain vendor extensions,
125 albeit possibly in a degraded manner.
126
127
128 \section[Changes Version 4 to 5]{Changes from Version 4 to Version 5}
129 TBD
130 \section[Changes Version 3 to 4]{Changes from Version 3 to Version 4}
131 The following is a list of the major changes made to the DWARF Debugging Information
132 Format since Version 3 was published. The list is not meant to be exhaustive.
133
134
135 \begin{itemize}
136
137 \item Reformulate 
138 Section 2.6 (Location Descriptions) 
139 to better distinguish DWARF location descriptions, which
140 compute the location where a value is found (such as an address in memory or a register
141 name) from DWARF expressions, which compute a final value (such as an array bound).
142 \item Add support for bundled instructions on machine architectures where instructions do not
143 occupy a whole number of bytes.
144 \item Add a new attribute form for section offsets, \livelink{chap:DWFORMsecoffset}{DW\-\_FORM\-\_sec\-\_offset}, to replace the use
145 of \livelink{chap:DWFORMdata4}{DW\-\_FORM\-\_data4} and \livelink{chap:DWFORMdata8}{DW\-\_FORM\-\_data8} for section offsets.
146 \item Add an attribute, \livelink{chap:DWATmainsubprogram}{DW\-\_AT\-\_main\-\_subprogram}, to identify the main subprogram of a
147 program.
148 \item Define default array lower bound values for each supported language.
149 \item Add a new technique using separate type units, type signatures and COMDAT sections to
150 improve compression and duplicate elimination of DWARF information.
151 \item Add support for new C++ language constructs, including rvalue references, generalized
152 constant expressions, Unicode character types and template aliases.
153 \item Clarify and generalize support for packed arrays and structures.
154 \item Add new line number table support to facilitate profile based compiler optimization.
155 \item Add additional support for template parameters in instantiations.
156 \item Add support for strongly typed enumerations in languages (such as C++) that have two
157 kinds of enumeration declarations.
158 DWARF Version 4 is compatible with DWARF Version 3 except as follows:
159 \item DWARF attributes that use any of the new forms of attribute value representation (for
160 section offsets, flag compression, type signature references, and so on) cannot be read by
161 DWARF Version 3 consumers because the consumer will not know how to skip over the
162 unexpected form of data.
163 \item DWARF frame and line table sections include a additional fields that affect the location
164 and interpretation of other data in the section.
165 \end{itemize}
166
167
168 Contents needed.
169 \section{Changes from Version 2 to Version 3}
170 The following is a list of the major differences between
171 Version 2 and Version 3 of the DWARF Debugging Information
172 Format. The list is not meant to be exhaustive.
173
174 \begin{itemize}
175 \item
176 Make provision for DWARF information files that are larger
177 than 4 GBytes.
178
179 \item
180 Allow attributes to refer to debugging information entries
181 in other shared libraries.
182
183 \item
184 Add support for Fortran 90 modules as well as allocatable
185 array and pointer types.
186
187 \item
188 Add additional base types for C (as revised for 1999).
189
190 \item
191 Add support for Java and COBOL.
192
193 \item
194 Add namespace support for C++.
195
196 \item
197 Add an optional section for global type names (similar to
198 the global section for objects and functions).
199
200 \item
201 Adopt UTF-8 as the preferred representation of program name strings.
202 \item
203 Add improved support for optimized code (discontiguous
204 scopes, end of prologue determination, multiple section
205 code generation).  
206
207 \item Improve the ability to eliminate
208 duplicate DWARF information during linking.  
209
210 \end{itemize}
211
212 DWARF Version 3 is compatible with DWARF Version 2 except as follows:
213
214 \begin{itemize}
215 \item
216 Certain very large values of the initial length fields that
217 begin DWARF sections as well as certain structures are reserved
218 to act as escape codes for future extension; one such extension
219 is defined to increase the possible size of DWARF descriptions
220 (see Section 7.4).
221
222 \item
223 References that use the attribute form \livelink{chap:DWFORMrefaddr}{DW\-\_FORM\-\_ref\-\_addr}
224 are specified to be four bytes in the DWARF 32-bit format and
225 eight bytes in the DWARF 64-bit format, while DWARF Version
226 2 specifies that such references have the same size as an
227 address on the target system (see Sections 7.4 and 7.5.4).
228
229 \item
230 The return\_address\_register field in a Common Information
231 Entry record for call frame information is changed to unsigned
232 LEB representation (see Section 6.4.1).
233
234 \end{itemize}
235
236
237 \section[Changes Version1 to 2]{Changes from Version 1 to Version 2}
238 DWARF Version 2 describes the second generation of debugging
239 information based on the DWARF format. While DWARF Version
240 2 provides new debugging information not available in
241 Version 1, the primary focus of the changes for Version
242 2 is the representation of the information, rather than
243 the information content itself. The basic structure of
244 the Version 2 format remains as in Version 1: the debugging
245 information is represented as a series of debugging information
246 entries, each containing one or more attributes (name/value
247 pairs). The Version 2 representation, however, is much more
248 compact than the Version 1 representation. In some cases,
249 this greater density has been achieved at the expense of
250 additional complexity or greater difficulty in producing and
251 processing the DWARF information. The definers believe that the
252 reduction in I/O and in memory paging should more than make
253 up for any increase in processing time.  
254
255 The representation
256 of information changed from Version 1 to Version 2, so that
257 Version 2 DWARF information is not binary compatible with
258 Version 1 information. To make it easier for consumers to
259 support both Version 1 and Version 2 DWARF information, the
260 Version 2 information has been moved to a different object
261 file section, \addtoindex{.debug\_info}.  
262
263 \textit{
264 A summary of the major changes
265 made in DWARF Version 2 compared to the DWARF Version 1 may
266 be found in the DWARF Version 2 document
267 }
268