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