Now all the FORM linkages are in place.
[dwarf-doc.git] / dwarf5 / latexdoc / generaldescription.tex
1 \chapter{General Description}
2 \label{chap:generaldescription}
3 \section{The Debugging Entry (DIE)}
4 \label{chap:thedebuggingentrydie}
5 DWARF uses a series of debugging information entries (DIEs) to 
6 define a low\dash{} level
7 representation of a source program. 
8 Each debugging information entry consists of an identifying
9 tag and a series of attributes. 
10 An entry, or group of entries together, provide a description of a
11 corresponding entity in the source program. 
12 The tag specifies the class to which an entry belongs
13 and the attributes define the specific characteristics of the entry.
14
15 The set of tag names is listed in Figure 1. 
16 The debugging information entries they identify are
17 described in Sections 3, 4 and 5.
18
19 The debugging information entry descriptions 
20 in Sections 3, 4 and 5 generally include mention of
21 most, but not necessarily all, of the attributes 
22 that are normally or possibly used with the entry.
23 Some attributes, whose applicability tends to be 
24 pervasive and invariant across many kinds of
25 debugging information entries, are described in 
26 this section and not necessarily mentioned in all
27 contexts where they may be appropriate. 
28 Examples include \livelink{chap:DWATartificial}{DW\-\_AT\-\_artificial}, the declaration
29 coordinates, and \livelink{chap:DWATdescription}{DW\-\_AT\-\_description}, among others.
30
31 The debugging information entries are contained 
32 in the .debug\_info and .debug\_types
33 sections of an object file.
34
35
36
37 \section{Attribute Types}
38 \label{chap:attributetypes}
39 Each attribute value is characterized by an attribute name. 
40 No more than one attribute with a given name may appear in any
41 debugging information entry. 
42 There are no limitations on the
43 ordering of attributes within a debugging information entry.
44
45 The attributes are listed in Figure 2.  
46
47 The permissible values
48 for an attribute belong to one or more classes of attribute
49 value forms.  
50 Each form class may be represented in one or more ways. 
51 For example, some attribute values consist
52 of a single piece of constant data. 
53 ``Constant data''
54 is the class of attribute value that those attributes may have. 
55 There are several representations of constant data,
56 however (one, two, ,four, or eight bytes, and variable length
57 data). 
58 The particular representation for any given instance
59 of an attribute is encoded along with the attribute name as
60 part of the information that guides the interpretation of a
61 debugging information entry.  
62
63 Attribute value forms belong
64 to one of the classes shown in Figure \refersec{tab:classesofattributevalue}.
65
66 % These each need to link to definition page: FIXME
67 \begin{figure}[here]
68 \autorows[0pt]{c}{2}{l}{
69 \livelink{chap:DWTAGaccessdeclaration}{DW\-\_TAG\-\_access\-\_declaration},
70 \livelink{chap:DWTAGarraytype}{DW\-\_TAG\-\_array\-\_type},
71 \livelink{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type},
72 \livelink{chap:DWTAGcatchblock}{DW\-\_TAG\-\_catch\-\_block},
73 \livelink{chap:DWTAGclasstype}{DW\-\_TAG\-\_class\-\_type},
74 \livelink{chap:DWTAGcommonblock}{DW\-\_TAG\-\_common\-\_block},
75 \livelink{chap:DWTAGcommoninclusion}{DW\-\_TAG\-\_common\-\_inclusion},
76 \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit},
77 \livelink{chap:DWTAGcondition}{DW\-\_TAG\-\_condition},
78 \livelink{chap:DWTAGconsttype}{DW\-\_TAG\-\_const\-\_type},
79 \livelink{chap:DWTAGconstant}{DW\-\_TAG\-\_constant},
80 \livelink{chap:DWTAGdwarfprocedure}{DW\-\_TAG\-\_dwarf\-\_procedure},
81 \livelink{chap:DWTAGentrypoint}{DW\-\_TAG\-\_entry\-\_point},
82 \livelink{chap:DWTAGenumerationtype}{DW\-\_TAG\-\_enumeration\-\_type},
83 \livelink{chap:DWTAGenumerator}{DW\-\_TAG\-\_enumerator},
84 \livelink{chap:DWTAGfiletype}{DW\-\_TAG\-\_file\-\_type},
85 \livelink{chap:DWTAGformalparameter}{DW\-\_TAG\-\_formal\-\_parameter},
86 \livelink{chap:DWTAGfriend}{DW\-\_TAG\-\_friend},
87 \livelink{chap:DWTAGimporteddeclaration}{DW\-\_TAG\-\_imported\-\_declaration},
88 \livelink{chap:DWTAGimportedmodule}{DW\-\_TAG\-\_imported\-\_module},
89 \livelink{chap:DWTAGimportedunit}{DW\-\_TAG\-\_imported\-\_unit},
90 \livelink{chap:DWTAGinheritance}{DW\-\_TAG\-\_inheritance},
91 \livelink{chap:DWTAGinlinedsubroutine}{DW\-\_TAG\-\_inlined\-\_subroutine},
92 \livelink{chap:DWTAGinterfacetype}{DW\-\_TAG\-\_interface\-\_type},
93 \livelink{chap:DWTAGlabel}{DW\-\_TAG\-\_label},
94 \livelink{chap:DWTAGlexicalblock}{DW\-\_TAG\-\_lexical\-\_block},
95 \livelink{chap:DWTAGmodule}{DW\-\_TAG\-\_module},
96 \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member},
97 \livelink{chap:DWTAGnamelist}{DW\-\_TAG\-\_namelist},
98 \livelink{chap:DWTAGnamelistitem}{DW\-\_TAG\-\_namelist\-\_item},
99 \livelink{chap:DWTAGnamespace}{DW\-\_TAG\-\_namespace},
100 \livelink{chap:DWTAGpackedtype}{DW\-\_TAG\-\_packed\-\_type},
101 \livelink{chap:DWTAGpartialunit}{DW\-\_TAG\-\_partial\-\_unit},
102 \livelink{chap:DWTAGpointertype}{DW\-\_TAG\-\_pointer\-\_type},
103 \livelink{chap:DWTAGptrtomembertype}{DW\-\_TAG\-\_ptr\-\_to\-\_member\-\_type},
104 \livelink{chap:DWTAGreferencetype}{DW\-\_TAG\-\_reference\-\_type},
105 \livelink{chap:DWTAGrestricttype}{DW\-\_TAG\-\_restrict\-\_type},
106 \livelink{chap:DWTAGrvaluereferencetype}{DW\-\_TAG\-\_rvalue\-\_reference\-\_type},
107 \livelink{chap:DWTAGsettype}{DW\-\_TAG\-\_set\-\_type},
108 \livelink{chap:DWTAGsharedtype}{DW\-\_TAG\-\_shared\-\_type},
109 \livelink{chap:DWTAGstringtype}{DW\-\_TAG\-\_string\-\_type},
110 \livelink{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type},
111 \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram},
112 \livelink{chap:DWTAGsubrangetype}{DW\-\_TAG\-\_subrange\-\_type},
113 \livelink{chap:DWTAGsubroutinetype}{DW\-\_TAG\-\_subroutine\-\_type},
114 \livelink{chap:DWTAGtemplatealias}{DW\-\_TAG\-\_template\-\_alias},
115 \livelink{chap:DWTAGtemplatetypeparameter}{DW\-\_TAG\-\_template\-\_type\-\_parameter},
116 \livelink{chap:DWTAGtemplatevalueparameter}{DW\-\_TAG\-\_template\-\_value\-\_parameter},
117 \livelink{chap:DWTAGthrowntype}{DW\-\_TAG\-\_thrown\-\_type},
118 \livelink{chap:DWTAGtryblock}{DW\-\_TAG\-\_try\-\_block},
119 \livelink{chap:DWTAGtypedef}{DW\-\_TAG\-\_typedef},
120 \livelink{chap:DWTAGtypeunit}{DW\-\_TAG\-\_type\-\_unit},
121 \livelink{chap:DWTAGuniontype}{DW\-\_TAG\-\_union\-\_type},
122 \livelink{chap:DWTAGunspecifiedparameters}{DW\-\_TAG\-\_unspecified\-\_parameters},
123 \livelink{chap:DWTAGunspecifiedtype}{DW\-\_TAG\-\_unspecified\-\_type},
124 \livelink{chap:DWTAGvariable}{DW\-\_TAG\-\_variable},
125 \livelink{chap:DWTAGvariant}{DW\-\_TAG\-\_variant},
126 \livelink{chap:DWTAGvariantpart}{DW\-\_TAG\-\_variant\-\_part},
127 \livelink{chap:DWTAGvolatiletype}{DW\-\_TAG\-\_volatile\-\_type},
128 \livelink{chap:DWTAGwithstmt}{DW\-\_TAG\-\_with\-\_stmt},
129 }
130 \caption{Tag names}\label{fig:tagnames}
131 \end{figure}
132
133 \label{tab:attributenames}
134 \setlength{\extrarowheight}{0.1cm}
135 \begin{longtable}{l|p{9cm}}
136   \caption{Attribute names} \\
137   \hline \\ \bfseries Attribute&\bfseries Identifies or Specifies \\ \hline
138 \endfirsthead
139   \bfseries Attribute&\bfseries Identifies or Specifies \\ \hline
140 \endhead
141   \hline \emph{Continued on next page}
142 \endfoot
143   \hline
144 \endlastfoot
145 \livetarg{chap:DWATabstractorigin}{DW\-\_AT\-\_abstract\-\_origin}
146 &Inline instances of inline subprograms \\
147 &Out\dash{} of\dash{} line instances of inline subprograms \\
148 \livetarg{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility}
149 &C++ and Ada declarations \\
150 &C++ base classes \\
151 &C++ inherited members \\
152 \livetarg{chap:DWATaddressclass}{DW\-\_AT\-\_address\-\_class}
153 &Pointer or reference types \\
154 &Subroutine or subroutine type \\
155 \livetarg{chap:DWATallocated}{DW\-\_AT\-\_allocated}
156 &Allocation status of types \\
157 \livetarg{chap:DWATartificial}{DW\-\_AT\-\_artificial}
158 &Objects or types that are not
159 actually declared in the source \\
160 \livetarg{chap:DWATassociated}{DW\-\_AT\-\_associated} 
161 &Association status of types \\
162 \livetarg{chap:DWATbasetypes}{DW\-\_AT\-\_base\-\_types} 
163 &Primitive data types of compilation unit \\
164 \livetarg{chap:DWATbinaryscale}{DW\-\_AT\-\_binary\-\_scale} 
165 &Binary scale factor for fixed\dash point type \\
166 \livetarg{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} 
167 &Base type bit location \\
168 &Data member bit location \\
169 \livetarg{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} 
170 &Base type bit size \\
171 &Data member bit size \\
172 \livetarg{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride} 
173 &Array element stride (of array type) \\
174 &Subrange stride (dimension of array type) \\
175 &Enumeration stride (dimension of array type) \\
176 \livetarg{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} 
177 &Data object or data type size \\
178 \livetarg{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride} 
179 &Array element stride (of array type) \\
180 &Subrange stride (dimension of array type) \\
181 &Enumeration stride (dimension of array type) \\
182 \livetarg{chap:DWATcallcolumn}{DW\-\_AT\-\_call\-\_column} 
183 &Column position of inlined subroutine call \\
184 \livetarg{chap:DWATcallfile}{DW\-\_AT\-\_call\-\_file}
185 &File containing inlined subroutine call \\
186 \livetarg{chap:DWATcallline}{DW\-\_AT\-\_call\-\_line} 
187 &Line number of inlined subroutine call \\
188 \livetarg{chap:DWATcallingconvention}{DW\-\_AT\-\_calling\-\_convention} 
189 &Subprogram calling convention \\
190 &\livetarg{chap:DWATcommonreference}{DW\-\_AT\-\_common\-\_reference} \\
191 &Common block usage \\
192 \livetarg{chap:DWATcompdir}{DW\-\_AT\-\_comp\-\_dir}
193 &Compilation directory \\
194 \livetarg{chap:DWATconstvalue}{DW\-\_AT\-\_const\-\_value}
195 &Constant object \\
196 \livetarg{chap:DWATconstvalue}{DW\-\_AT\-\_const\-\_value}
197 &Enumeration literal value \\
198 &Template value parameter \\
199 \livetarg{chap:DWATconstexpr}{DW\-\_AT\-\_const\-\_expr}
200 &Compile\dash time constant object \\
201 &Compile\dash time constant function \\
202 \livetarg{chap:DWATcontainingtype}{DW\-\_AT\-\_containing\-\_type}
203 &Containing type of pointer to member type \\
204 \livetarg{chap:DWATcount}{DW\-\_AT\-\_count}
205 &Elements of subrange type \\
206 \livetarg{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset}
207 &Base type bit location \\
208 &Data member bit location \\
209 \livetarg{chap:DWATdatalocation}{DW\-\_AT\-\_data\-\_location} 
210 &Indirection to actual data \\
211 \livetarg{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location}
212 &Data member location \\
213 &Inherited member location \\
214 \livetarg{chap:DWATdecimalscale}{DW\-\_AT\-\_decimal\-\_scale}
215 &Decimal scale factor \\
216 \livetarg{chap:DWATdecimalsign}{DW\-\_AT\-\_decimal\-\_sign}
217 &Decimal sign representation \\
218 \livetarg{chap:DWATdeclcolumn}{DW\-\_AT\-\_decl\-\_column}
219 &Column position of source declaration \\
220 \livetarg{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file}
221 &File containing source declaration \\
222 \livetarg{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line}
223 &Line number of source declaration \\
224 \livetarg{chap:DWATdeclaration}{DW\-\_AT\-\_declaration}
225 &Incomplete, non\dash defining, or separate entity declaration \\
226 \livetarg{chap:DWATdefaultvalue}{DW\-\_AT\-\_default\-\_value}
227 &Default value of parameter \\
228 \livetarg{chap:DWATdescription}{DW\-\_AT\-\_description} 
229 & Artificial name or description \\
230 \livetarg{chap:DWATdigitcount}{DW\-\_AT\-\_digit\-\_count}
231 &Digit count for packed decimal or numeric string type\\
232 \livetarg{chap:DWATdiscr}{DW\-\_AT\-\_discr}
233 &Discriminant of variant part\\
234 \livetarg{chap:DWATdiscrlist}{DW\-\_AT\-\_discr\-\_list}
235 &List of discriminant values\\
236 \livetarg{chap:DWATdiscrvalue}{DW\-\_AT\-\_discr\-\_value}
237 &Discriminant value\\
238 \livetarg{chap:DWATelemental}{DW\-\_AT\-\_elemental}
239 &Elemental property of a subroutine\\
240 \livetarg{chap:DWATencoding}{DW\-\_AT\-\_encoding}
241 &Encoding of base type\\
242 \livetarg{chap:DWATendianity}{DW\-\_AT\-\_endianity}
243 &Endianity of data\\
244 \livetarg{chap:DWATentrypc}{DW\-\_AT\-\_entry\-\_pc}
245 &Entry address of module initialization\\
246 &Entry address of subprogram\\
247 &Entry address of inlined subprogram\\
248 \livetarg{chap:DWATenumclass}{DW\-\_AT\-\_enum\-\_class}
249 &Type safe enumeration definition\\
250 \livetarg{chap:DWATexplicit}{DW\-\_AT\-\_explicit}
251 &Explicit property of member function\\
252 \livetarg{chap:DWATextension}{DW\-\_AT\-\_extension}
253 &Previous namespace extension or original namespace\\
254 \livetarg{chap:DWATexternal}{DW\-\_AT\-\_external}
255 &External subroutine\\
256 &External variable\\
257 \livetarg{chap:DWATframebase}{DW\-\_AT\-\_frame\-\_base}
258 &Subroutine frame base address\\
259 \livetarg{chap:DWATfriend}{DW\-\_AT\-\_friend}
260 &Friend relationship\\
261 \livetarg{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc}
262 &Contiguous range of code addresses\\
263 \livetarg{chap:DWATidentifiercase}{DW\-\_AT\-\_identifier\-\_case}
264 &Identifier case rule \\
265 \livetarg{chap:DWATimport}{DW\-\_AT\-\_import}
266 &Imported declaration \\
267 &Imported unit \\
268 &Namespace alias \\
269 &Namespace using declaration \\
270 &Namespace using directive \\
271 \livetarg{chap:DWATinline}{DW\-\_AT\-\_inline}
272 &Abstract instance\\
273 &Inlined subroutine\\
274 \livetarg{chap:DWATisoptional}{DW\-\_AT\-\_is\-\_optional}
275 &Optional parameter\\
276 \livetarg{chap:DWATlanguage}{DW\-\_AT\-\_language}
277 &Programming language\\
278 \livetarg{chap:DWATlinkagename}{DW\-\_AT\-\_linkage\-\_name}
279 &Object file linkage name of an entity\\
280 \livetarg{chap:DWATlocation}{DW\-\_AT\-\_location}
281 &Data object location\\
282 \livetarg{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc}
283 &Code address or range of addresses\\
284 \livetarg{chap:DWATlowerbound}{DW\-\_AT\-\_lower\-\_bound}
285 &Lower bound of subrange\\
286 \livetarg{chap:DWATmacroinfo}{DW\-\_AT\-\_macro\-\_info}
287 &Macro information (\#define, \#undef)\\
288 \livetarg{chap:DWATmainsubprogram}{DW\-\_AT\-\_main\-\_subprogram}
289 &Main or starting subprogram\\
290 &Unit containing main or starting subprogram\\
291 \livetarg{chap:DWATmutable}{DW\-\_AT\-\_mutable}
292 &Mutable property of member data\\
293 \livetarg{chap:DWATname}{DW\-\_AT\-\_name}
294 &Name of declaration\\
295 &Path name of compilation source\\
296 \livetarg{chap:DWATnamelistitem}{DW\-\_AT\-\_namelist\-\_item}
297 &Namelist item\\
298 \livetarg{chap:DWATobjectpointer}{DW\-\_AT\-\_object\-\_pointer}
299 &Object (this, self) pointer of member function\\
300 \livetarg{chap:DWATordering}{DW\-\_AT\-\_ordering}
301 &Array row/column ordering\\
302 \livetarg{chap:DWATpicturestring}{DW\-\_AT\-\_picture\-\_string}
303 &Picture string for numeric string type\\
304 \livetarg{chap:DWATpriority}{DW\-\_AT\-\_priority}
305 &Module priority\\
306 \livetarg{chap:DWATproducer}{DW\-\_AT\-\_producer}
307 &Compiler identification\\
308 \livetarg{chap:DWATprototyped}{DW\-\_AT\-\_prototyped}
309 &Subroutine prototype\\
310 \livetarg{chap:DWATpure}{DW\-\_AT\-\_pure}
311 &Pure property of a subroutine\\
312 \livetarg{chap:DWATranges}{DW\-\_AT\-\_ranges}
313 &Non\dash contiguous range of code addresses\\
314 \livetarg{chap:DWATrecursive}{DW\-\_AT\-\_recursive}
315 &Recursive property of a subroutine\\
316 \livetarg{chap:DWATreturnaddr}{DW\-\_AT\-\_return\-\_addr}
317 &Subroutine return address save location\\
318 \livetarg{chap:DWATsegment}{DW\-\_AT\-\_segment}
319 &Addressing information\\
320 \livetarg{chap:DWATsibling}{DW\-\_AT\-\_sibling}
321 &Debugging information entry relationship\\
322 \livetarg{chap:DWATsmall}{DW\-\_AT\-\_small}
323 &Scale factor for fixed\dash point type\\
324 \livetarg{chap:DWATsignature}{DW\-\_AT\-\_signature}
325 &Type signature\\
326 \livetarg{chap:DWATspecification}{DW\-\_AT\-\_specification}
327 &Incomplete, non\dash defining, or separate declaration
328 corresponding to a declaration\\
329 \livetarg{chap:DWATstartscope}{DW\-\_AT\-\_start\-\_scope}
330 &Object declaration\\
331 &Type declaration\\
332 \livetarg{chap:DWATstaticlink}{DW\-\_AT\-\_static\-\_link}
333 &Location of uplevel frame\\
334 \livetarg{chap:DWATstmtlist}{DW\-\_AT\-\_stmt\-\_list}
335 &Line number information for unit\\
336 \livetarg{chap:DWATstringlength}{DW\-\_AT\-\_string\-\_length}
337 &String length of string type\\
338 \livetarg{chap:DWATthreadsscaled}{DW\-\_AT\-\_threads\-\_scaled}
339 &UPC array bound THREADS scale factor\\
340 \livetarg{chap:DWATtrampoline}{DW\-\_AT\-\_trampoline}
341 &Target subroutine\\
342 \livetarg{chap:DWATtype}{DW\-\_AT\-\_type}
343 &Type of declaration\\
344 &Type of subroutine return\\
345 \livetarg{chap:DWATupperbound}{DW\-\_AT\-\_upper\-\_bound}
346 &Upper bound of subrange\\
347 \livetarg{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location}
348 &Member location for pointer to member type\\
349 \livetarg{chap:DWATuseUTF8}{DW\-\_AT\-\_use\-\_UTF8}
350 &Compilation unit uses UTF\dash 8 strings \\
351 \livetarg{chap:DWATvariableparameter}{DW\-\_AT\-\_variable\-\_parameter}
352 &Non\dash constant parameter flag \\
353 \livetarg{chap:DWATvirtuality}{DW\-\_AT\-\_virtuality}
354 &Virtuality indication \\
355 &Virtuality of base class \\
356 &Virtuality of function \\
357 \livetarg{chap:DWATvisibility}{DW\-\_AT\-\_visibility}
358 &Visibility of declaration\\
359 \livetarg{chap:DWATvtableelemlocation}{DW\-\_AT\-\_vtable\-\_elem\-\_location}
360 &Virtual function vtable slot\\
361 \end{longtable}
362
363 \begin{figure}[here]
364 \centering
365 % Attribute Class entries need a ref to definition point.
366 \setlength{\extrarowheight}{0.1cm}
367 \label{tab:classesofattributevalue}
368 \begin{tabular}{l|p{10cm}} \hline
369 Attribute Class & General Use and Encoding \\ \hline
370 \livetargi{chap:address}{address}{address class}
371 &Refers to some location in the address space of the described program.
372  \\ 
373 \livetargi{chap:block}{block}{block class}
374 & An arbitrary number of uninterpreted bytes of data.
375  \\
376 \livetargi{chap:constant}{constant}{constant class}
377 &One, two, four or eight bytes of uninterpreted data, or data
378 encoded in the variable length format known as LEB128 (see
379 Section 7.6.).
380
381 \textit{Most constant values are integers of one kind or
382 another (codes, offsets, counts, and so on); these are
383 sometimes called ``integer constants'' for emphasis.} \\
384
385 \livetargi{chap:exprloc}{exprloc}{exprloc class}
386 &A DWARF expression or location description.
387 \\
388 \livetargi{chap:flag}{flag}{flag class}
389 &A small constant that indicates the presence or absence of an attribute.
390 \\
391 \livetargi{chap:lineptr}{lineptr}{lineptr class}
392 &Refers to a location in the DWARF section that holds line number information.
393 \\
394 \livetargi{chap:loclistptr}{loclistptr}{loclistptr class}
395 &Refers to a location in the DWARF section that holds location lists, which
396 describe objects whose location can change during their lifetime.
397 \\
398 \livetargi{chap:macptr}{macptr}{macptr class}
399 & Refers to a location in the DWARF section that holds macro definition
400  information.  \\
401 \livetargi{chap:rangelistptr}{rangelistptr}{rangelistptr class}
402 & Refers to a location in the DWARF section that holds non\dash contiguous address ranges.  \\
403
404 \livetargi{chap:reference}{reference}{reference class}
405 & Refers to one of the debugging information
406 entries that describe the program.  There are three types of
407 reference. The first is an offset relative to the beginning
408 of the compilation unit in which the reference occurs and must
409 refer to an entry within that same compilation unit. The second
410 type of reference is the offset of a debugging information
411 entry in any compilation unit, including one different from
412 the unit containing the reference. The third type of reference
413 is an indirect reference to a type definition using a 64\dash
414 bit signature for that type.  \\
415
416 \livetargi{chap:string}{string}{string class}
417 & A null\dash terminated sequence of zero or more
418 (non\dash null) bytes. Data in this class are generally
419 printable strings. Strings may be represented directly in
420 the debugging information entry or as an offset in a separate
421 string table.  
422 \end{tabular}
423 \caption{Classes of Attribute value}
424 \end{figure}
425 % It is difficult to get the above table to appear before
426 % the end of the chapter without a clearpage here.
427 \clearpage
428 \section{Relationship of Debugging Information Entries}
429 \label{chap:relationshipofdebugginginformationentries}
430 \textit{
431 A variety of needs can be met by permitting a single
432 debugging information entry to “own” an arbitrary number
433 of other debugging entries and by permitting the same debugging
434 information entry to be one of many owned by another debugging
435 information entry. 
436 This makes it possible, for example, to
437 describe the static block structure within a source file,
438 to show the members of a structure, union, or class, and to
439 associate declarations with source files or source files
440 with shared objects.  
441 }
442
443
444 The ownership relation of debugging
445 information entries is achieved naturally because the debugging
446 information is represented as a tree. 
447 The nodes of the tree
448 are the debugging information entries themselves. 
449 The child
450 entries of any node are exactly those debugging information
451 entries owned by that node.  
452
453 \textit{
454 While the ownership relation
455 of the debugging information entries is represented as a
456 tree, other relations among the entries exist, for example,
457 a reference from an entry representing a variable to another
458 entry representing the type of that variable. 
459 If all such
460 relations are taken into account, the debugging entries
461 form a graph, not a tree.  
462 }
463
464 The tree itself is represented
465 by flattening it in prefix order. 
466 Each debugging information
467 entry is defined either to have child entries or not to have
468 child entries (see Section 7.5.3). 
469 If an entry is defined not
470 to have children, the next physically succeeding entry is a
471 sibling. 
472 If an entry is defined to have children, the next
473 physically succeeding entry is its first child. 
474 Additional
475 children are represented as siblings of the first child. 
476 A chain of sibling entries is terminated by a null entry.
477
478 In cases where a producer of debugging information feels that
479 it will be important for consumers of that information to
480 quickly scan chains of sibling entries, while ignoring the
481 children of individual siblings, that producer may attach a
482 \livelink{chap:DWATsibling}{DW\-\_AT\-\_sibling} attribute to any debugging information entry. 
483 The
484 value of this attribute is a reference to the sibling entry
485 of the entry to which the attribute is attached.
486
487
488 \section{Target Addresses}
489 \label{chap:targetaddresses}
490 Many places in this document refer to the size of an address
491 on the target architecture (or equivalently, target machine)
492 to which a DWARF description applies. For processors which
493 can be configured to have different address sizes or different
494 instruction sets, the intent is to refer to the configuration
495 which is either the default for that processor or which is
496 specified by the object file or executable file which contains
497 the DWARF information.
498
499
500
501 \textit{
502 For example, if a particular target architecture supports
503 both 32\dash bit and 64\dash bit addresses, the compiler will generate
504 an object file which specifies that it contains executable
505 code generated for one or the other of these address sizes. In
506 that case, the DWARF debugging information contained in this
507 object file will use the same address size.
508 }
509
510 \textit{
511 Architectures which have multiple instruction sets are
512 supported by the isa entry in the line number information
513 (see Section \refersec{chap:statemachineregisters}).
514 }
515
516
517 \section{DWARF Expressions}
518 \label{chap:dwarfexpressions}
519 DWARF expressions describe how to compute a value or name a
520 location during debugging of a program. 
521 They are expressed in
522 terms of DWARF operations that operate on a stack of values.
523
524 All DWARF operations are encoded as a stream of opcodes that
525 are each followed by zero or more literal operands. 
526 The number
527 of operands is determined by the opcode.  
528
529 In addition to the
530 general operations that are defined here, operations that are
531 specific to location descriptions are defined in 
532 Section \refersec{chap:locationdescriptions} .
533
534 \subsection{General Operations}
535 \label{chap:generaloperations}
536 Each general operation represents a postfix operation on
537 a simple stack machine. Each element of the stack is the
538 size of an address on the target machine. The value on the
539 top of the stack after ``executing'' the DWARF expression
540 is taken to be the result (the address of the object, the
541 value of the array bound, the length of a dynamic string,
542 the desired value itself, and so on).
543
544 \subsubsection{Literal Encodings}
545 \label{chap:literalencodings}
546 The following operations all push a value onto the DWARF
547 stack. If the value of a constant in one of these operations
548 is larger than can be stored in a single stack element, the
549 value is truncated to the element size and the low\dash order bits
550 are pushed on the stack.
551
552 \begin{enumerate}[1]
553 \item DW\-\_OP\-\_lit0, DW\-\_OP\-\_lit1, \dots, DW\-\_OP\-\_lit31 \\
554 The DW\-\_OP\-\_litn operations encode the unsigned literal values
555 from 0 through 31, inclusive.
556
557 \item DW\-\_OP\-\_addr \\
558 The DW\-\_OP\-\_addr operation has a single operand that encodes
559 a machine address and whose size is the size of an address
560 on the target machine.
561
562 \item DW\-\_OP\-\_const1u, DW\-\_OP\-\_const2u, DW\-\_OP\-\_const4u, DW\-\_OP\-\_const8u \\
563 The single operand of a DW\-\_OP\-\_constnu operation provides a 1,
564 2, 4, or 8\dash byte unsigned integer constant, respectively.
565
566 \item DW\-\_OP\-\_const1s , DW\-\_OP\-\_const2s, DW\-\_OP\-\_const4s, DW\-\_OP\-\_const8s \\
567 The single operand of a DW\-\_OP\-\_constns operation provides a 1,
568 2, 4, or 8\dash byte signed integer constant, respectively.
569
570 \item DW\-\_OP\-\_constu \\
571 The single operand of the DW\-\_OP\-\_constu operation provides
572 an unsigned LEB128 integer constant.
573
574 \item DW\-\_OP\-\_consts \\
575 The single operand of the DW\-\_OP\-\_consts operation provides
576 a signed LEB128 integer constant.
577
578 \end{enumerate}
579
580
581 \subsubsection{Register Based Addressing}
582 \label{chap:registerbasedaddressing}
583 The following operations push a value onto the stack that is
584 the result of adding the contents of a register to a given
585 signed offset.
586
587 \begin{enumerate}[1]
588
589 \item DW\-\_OP\-\_fbreg \\
590 The DW\-\_OP\-\_fbreg operation provides a signed LEB128 offset
591 from the address specified by the location description in the
592 \livelink{chap:DWATframebase}{DW\-\_AT\-\_frame\-\_base} attribute of the current function. (This
593 is typically a “stack pointer” register plus or minus
594 some offset. On more sophisticated systems it might be a
595 location list that adjusts the offset according to changes
596 in the stack pointer as the PC changes.)
597
598 \item DW\-\_OP\-\_breg0, DW\-\_OP\-\_breg1, \dots, DW\-\_OP\-\_breg31\\
599 The single operand of the DW\-\_OP\-\_bregn operations provides
600 a signed LEB128 offset from
601 the specified register.
602
603 \item DW\-\_OP\-\_bregx \\
604 The DW\-\_OP\-\_bregx operation has two operands: a register
605 which is specified by an unsigned LEB128 number, followed by
606 a signed LEB128 offset.
607
608 \end{enumerate}
609
610
611 \subsubsection{Stack Operations}
612 \label{chap:stackoperations}
613 The following operations manipulate the DWARF stack. Operations
614 that index the stack assume that the top of the stack (most
615 recently added entry) has index 0.
616
617 \begin{enumerate}[1]
618 \item \livetarg{chap:DWOPdup}{DW\-\_OP\-\_dup} \\
619 The DW\-\_OP\-\_dup operation duplicates the value at the top of the stack.
620
621 \item \livetarg{chap:DWOPdrop}{DW\-\_OP\-\_drop} \\
622 The DW\-\_OP\-\_drop operation pops the value at the top of the stack.
623
624 \item \livetarg{chap:DWOPpick}{DW\-\_OP\-\_pick} \\
625 The single operand of the DW\-\_OP\-\_pick operation provides a
626 1\dash byte index. A copy of the stack entry with the specified
627 index (0 through 255, inclusive) is pushed onto the stack.
628
629 \item \livetarg{chap:DWOPover}{DW\-\_OP\-\_over} \\
630 The DW\-\_OP\-\_over operation duplicates the entry currently second
631 in the stack at the top of the stack. 
632 This is equivalent to
633 a DW\-\_OP\-\_pick operation, with index 1.  
634
635 \item \livetarg{chap:DWOPswap}{DW\-\_OP\-\_swap} \\
636 The DW\-\_OP\-\_swap operation swaps the top two stack entries. 
637 The entry at the top of the
638 stack becomes the second stack entry, 
639 and the second entry becomes the top of the stack.
640
641 \item \livetarg{chap:DWOProt}{DW\-\_OP\-\_rot} \\
642 The DW\-\_OP\-\_rot operation rotates the first three stack
643 entries. The entry at the top of the stack becomes the third
644 stack entry, the second entry becomes the top of the stack,
645 and the third entry becomes the second entry.
646
647 \item  \livetarg{chap:DWOPderef}{DW\-\_OP\-\_deref} \\
648 The DW\-\_OP\-\_deref operation pops the top stack entry and 
649 treats it as an address. The value
650 retrieved from that address is pushed. 
651 The size of the data retrieved from the dereferenced
652 address is the size of an address on the target machine.
653
654 \item \livetarg{chap:DWOPderefsize}{DW\-\_OP\-\_deref\-\_size} \\
655 The DW\-\_OP\-\_deref\-\_size operation behaves like the DW\-\_OP\-\_deref
656 operation: it pops the top stack entry and treats it as an
657 address. The value retrieved from that address is pushed. In
658 the DW\-\_OP\-\_deref\-\_size operation, however, the size in bytes
659 of the data retrieved from the dereferenced address is
660 specified by the single operand. This operand is a 1\dash byte
661 unsigned integral constant whose value may not be larger
662 than the size of an address on the target machine. The data
663 retrieved is zero extended to the size of an address on the
664 target machine before being pushed onto the expression stack.
665
666 \item \livetarg{chap:DWOPxderef}{DW\-\_OP\-\_xderef} \\
667 The DW\-\_OP\-\_xderef operation provides an extended dereference
668 mechanism. The entry at the top of the stack is treated as an
669 address. The second stack entry is treated as an “address
670 space identifier” for those architectures that support
671 multiple address spaces. The top two stack elements are popped,
672 and a data item is retrieved through an implementation\dash defined
673 address calculation and pushed as the new stack top. The size
674 of the data retrieved from the dereferenced address is the
675 size of an address on the target machine.
676
677 \item \livetarg{chap:DWOPxderefsize}{DW\-\_OP\-\_xderef\-\_size}\\
678 The DW\-\_OP\-\_xderef\-\_size operation behaves like the
679 DW\-\_OP\-\_xderef operation.The entry at the top of the stack is
680 treated as an address. The second stack entry is treated as
681 an “address space identifier” for those architectures
682 that support multiple address spaces. The top two stack
683 elements are popped, and a data item is retrieved through an
684 implementation\dash defined address calculation and pushed as the
685 new stack top. In the DW\-\_OP\-\_xderef\-\_size operation, however,
686 the size in bytes of the data retrieved from the dereferenced
687 address is specified by the single operand. This operand is a
688 1\dash byte unsigned integral constant whose value may not be larger
689 than the size of an address on the target machine. The data
690 retrieved is zero extended to the size of an address on the
691 target machine before being pushed onto the expression stack.
692
693 \item \livetarg{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address}\\
694 The DW\-\_OP\-\_push\-\_object\-\_address operation pushes the address
695 of the object currently being evaluated as part of evaluation
696 of a user presented expression. This object may correspond
697 to an independent variable described by its own debugging
698 information entry or it may be a component of an array,
699 structure, or class whose address has been dynamically
700 determined by an earlier step during user expression
701 evaluation.  This operator provides explicit functionality
702 (especially for arrays involving descriptors) that is analogous
703 to the implicit push of the base address of a structure prior
704 to evaluation of a \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} to access a
705 data member of a structure. For an example, see 
706 Appendix \refersec{app:aggregateexamples}.
707
708 \item \livetarg{chap:DWOPformtlsaddress}{DW\-\_OP\-\_form\-\_tls\-\_address} \\
709 The DW\-\_OP\-\_form\-\_tls\-\_address operation pops a value from the
710 stack, translates it into an address in the current thread's
711 thread\dash local storage block, and pushes the address. If the
712 DWARF expression containing the DW\-\_OP\-\_form\-\_tls\-\_address
713 operation belongs to the main executable's DWARF info, the
714 operation uses the main executable's thread\dash local storage
715 block; if the expression belongs to a shared library's
716 DWARF info, then it uses that shared library's thread\dash local
717 storage block.  Some implementations of C and C++ support a
718 \_\_thread storage class. Variables with this storage class
719 have distinct values and addresses in distinct threads, much
720 as automatic variables have distinct values and addresses in
721 each function invocation. Typically, there is a single block
722 of storage containing all \_\_thread variables declared in
723 the main executable, and a separate block for the variables
724 declared in each shared library. Computing the address of
725 the appropriate block can be complex (in some cases, the
726 compiler emits a function call to do it), and difficult
727 to describe using ordinary DWARF location descriptions.
728 DW\-\_OP\-\_form\-\_tls\-\_address leaves the computation to the
729 consumer.
730
731 \item \livetarg{chap:DWOPcallframecfa}{DW\-\_OP\-\_call\-\_frame\-\_cfa} \\
732 The DW\-\_OP\-\_call\-\_frame\-\_cfa operation pushes the value of the
733 CFA, obtained from the Call Frame Information 
734 (see Section \refersec{chap:callframeinformation}).
735 Although the value of \livelink{chap:DWATframebase}{DW\-\_AT\-\_frame\-\_base}
736 can be computed using other DWARF expression operators,
737 in some cases this would require an extensive location list
738 because the values of the registers used in computing the
739 CFA change during a subroutine. If the 
740 Call Frame Information 
741 is present, then it already encodes such changes, and it is
742 space efficient to reference that.
743 \end{enumerate}
744
745 \subsubsection{Arithmetic and Logical Operations}
746 The following provide arithmetic and logical operations. Except
747 as otherwise specified, the arithmetic operations perfom
748 addressing arithmetic, that is, unsigned arithmetic that is
749 performed modulo one plus the largest representable address
750 (for example, 0x100000000 when the size of an address is 32
751 bits). Such operations do not cause an exception on overflow.
752
753 \begin{enumerate}[1]
754 \item \livetarg{chap:DWOPabs}{DW\-\_OP\-\_abs}  \\
755 The DW\-\_OP\-\_abs operation pops the top stack entry, interprets
756 it as a signed value and pushes its absolute value. If the
757 absolute value cannot be represented, the result is undefined.
758
759 \item \livetarg{chap:DWOPand}{DW\-\_OP\-\_and} \\
760 The DW\-\_OP\-\_and operation pops the top two stack values, performs
761 a bitwise and operation on the two, and pushes the result.
762
763 \item \label{chap:DWOPdiv}{DW\-\_OP\-\_div} \\
764 The DW\-\_OP\-\_div operation pops the top two stack values, divides the former second entry by
765 the former top of the stack using signed division, and pushes the result.
766
767 \item \livetarg{chap:DWOPminus}{DW\-\_OP\-\_minus} \\
768 The DW\-\_OP\-\_minus operation pops the top two stack values, subtracts the former top of the
769 stack from the former second entry, and pushes the result.
770
771 \item \livetarg{chap:DWOPmod}{DW\-\_OP\-\_mod}\\
772 The DW\-\_OP\-\_mod operation pops the top two stack values and pushes the result of the
773 calculation: former second stack entry modulo the former top of the stack.
774
775 \item \livetarg{chap:DWOPmul}{DW\-\_OP\-\_mul} \\
776 The DW\-\_OP\-\_mul operation pops the top two stack entries, multiplies them together, and
777 pushes the result.
778
779 \item  \livetarg{chap:DWOPneg}{DW\-\_OP\-\_neg} \\
780 The DW\-\_OP\-\_neg operation pops the top stack entry, interprets
781 it as a signed value and pushes its negation. If the negation
782 cannot be represented, the result is undefined.
783
784 \item  \livetarg{chap:DWOPnot}{DW\-\_OP\-\_not} \\
785 The DW\-\_OP\-\_not operation pops the top stack entry, and pushes
786 its bitwise complement.
787
788 \item  \livetarg{chap:DWOPor}{DW\-\_OP\-\_or} \\
789 The DW\-\_OP\-\_or operation pops the top two stack entries, performs
790 a bitwise or operation on the two, and pushes the result.
791
792 \item  \livetarg{chap:DWOPplus}{DW\-\_OP\-\_plus} \\
793 The DW\-\_OP\-\_plus operation pops the top two stack entries,
794 adds them together, and pushes the result.
795
796 \item  \livetarg{chap:DWOPplusuconst}{DW\-\_OP\-\_plus\-\_uconst} \\
797 The DW\-\_OP\-\_plus\-\_uconst operation pops the top stack entry,
798 adds it to the unsigned LEB128 constant operand and pushes
799 the result.  This operation is supplied specifically to be
800 able to encode more field offsets in two bytes than can be
801 done with “DW\-\_OP\-\_litn DW\-\_OP\-\_plus”.
802
803 \item \livetarg{chap:DWOPshl}{DW\-\_OP\-\_shl} \\
804 The DW\-\_OP\-\_shl operation pops the top two stack entries,
805 shifts the former second entry left (filling with zero bits)
806 by the number of bits specified by the former top of the stack,
807 and pushes the result.
808
809 \item \livetarg{chap:DWOPshr}{DW\-\_OP\-\_shr} \\
810 The DW\-\_OP\-\_shr operation pops the top two stack entries,
811 shifts the former second entry right logically (filling with
812 zero bits) by the number of bits specified by the former top
813 of the stack, and pushes the result.
814
815 \item \livetarg{chap:DWOPshra}{DW\-\_OP\-\_shra} \\
816 The DW\-\_OP\-\_shra operation pops the top two stack entries,
817 shifts the former second entry right arithmetically (divide
818 the magnitude by 2, keep the same sign for the result) by
819 the number of bits specified by the former top of the stack,
820 and pushes the result.
821
822 \item \livetarg{chap:DWOPxor}{DW\-\_OP\-\_xor} \\
823 The DW\-\_OP\-\_xor operation pops the top two stack entries,
824 performs a bitwise exclusive\dash or operation on the two, and
825 pushes the result.
826
827 \end{enumerate}
828
829 \subsubsection{Control Flow Operations}
830 \label{chap:controlflowoperations}
831 The following operations provide simple control of the flow of a DWARF expression.
832 \begin{enumerate}[1]
833 \item  DW\-\_OP\-\_le, DW\-\_OP\-\_ge, DW\-\_OP\-\_eq, DW\-\_OP\-\_lt, DW\-\_OP\-\_gt, DW\-\_OP\-\_ne \\
834 The six relational operators each:
835 \begin{itemize}
836 \item pop the top two stack values,
837
838 \item compare the operands:
839 \textless~former second entry~\textgreater  \textless~relational operator~\textgreater \textless~former top entry~\textgreater
840
841 \item push the constant value 1 onto the stack 
842 if the result of the operation is true or the
843 constant value 0 if the result of the operation is false.
844 \end{itemize}
845
846 Comparisons are performed as signed operations. The six
847 operators are DW\-\_OP\-\_le (less than or equal to), DW\-\_OP\-\_ge
848 (greater than or equal to), DW\-\_OP\-\_eq (equal to), DW\-\_OP\-\_lt (less
849 than), DW\-\_OP\-\_gt (greater than) and DW\-\_OP\-\_ne (not equal to).
850
851 \item DW\-\_OP\-\_skip \\
852 DW\-\_OP\-\_skip is an unconditional branch. Its single operand
853 is a 2\dash byte signed integer constant. The 2\dash byte constant is
854 the number of bytes of the DWARF expression to skip forward
855 or backward from the current operation, beginning after the
856 2\dash byte constant.
857
858 \item DW\-\_OP\-\_bra \\
859 DW\-\_OP\-\_bra is a conditional branch. Its single operand is a
860 2\dash byte signed integer constant.  This operation pops the
861 top of stack. If the value popped is not the constant 0,
862 the 2\dash byte constant operand is the number of bytes of the
863 DWARF expression to skip forward or backward from the current
864 operation, beginning after the 2\dash byte constant.
865
866 % The following item does not correctly hyphenate leading
867 % to an overfull hbox and a visible artifact. 
868 % So we use \- to suggest hyphenation in this rare situation.
869 \item DW\-\_OP\-\_call2, DW\-\_OP\-\_call4, DW\-\_OP\-\_call\-\_ref \\
870 DW\-\_OP\-\_call2, DW\-\_OP\-\_call4, and DW\-\_OP\-\_call\-\_ref perform
871 subroutine calls during evaluation of a DWARF expression or
872 location description. 
873 For DW\-\_OP\-\_call2 and 
874 DW\-\_OP\-\_call4, 
875 the
876 operand is the 2\dash~ or 4\dash byte 
877 unsigned offset, respectively,
878 of a debugging information entry in the current compilation
879 unit. The DW\-\_OP\-\_call\-\_ref operator has a single operand. In the
880 32\dash bit DWARF format, the operand is a 4\dash byte unsigned value;
881 in the 64\dash bit DWARF format, it is an 8\dash byte unsigned value
882 (see Section \refersec{datarep:32bitand64bitdwarfformats}). 
883 The operand is used as the offset of a
884 debugging information entry in a .debug\_info or .debug\_types
885 section which may be contained in a shared object or executable
886 other than that containing the operator. For references from
887 one shared object or executable to another, the relocation
888 must be performed by the consumer.  
889
890 \textit{Operand interpretation of
891 DW\-\_OP\-\_call2, DW\-\_OP\-\_call4 and DW\-\_OP\-\_call\-\_ref is exactly like
892 that for \livelink{chap:DWFORMref2}{DW\-\_FORM\-\_ref2}, \livelink{chap:DWFORMref4}{DW\-\_FORM\-\_ref4} and \livelink{chap:DWFORMrefaddr}{DW\-\_FORM\-\_ref\-\_addr},
893 respectively  
894 (see Section  \refersec{datarep:attributeencodings}).  
895 }
896
897 These operations transfer
898 control of DWARF expression evaluation to the 
899 \livelink{chap:DWATlocation}{DW\-\_AT\-\_location}
900 attribute of the referenced debugging information entry. If
901 there is no such attribute, then there is no effect. Execution
902 of the DWARF expression of a \livelink{chap:DWATlocation}{DW\-\_AT\-\_location} attribute may add
903 to and/or remove from values on the stack. Execution returns
904 to the point following the call when the end of the attribute
905 is reached. Values on the stack at the time of the call may be
906 used as parameters by the called expression and values left on
907 the stack by the called expression may be used as return values
908 by prior agreement between the calling and called expressions.
909 \end{enumerate}
910
911
912 \subsubsection{Special Operations}
913 There is one special operation currently defined:
914 \begin{enumerate}[1]
915 \item DW\-\_OP\-\_nop \\
916 The DW\-\_OP\-\_nop operation is a place holder. It has no effect
917 on the location stack or any of its values.
918
919 \end{enumerate}
920 \subsection{Example Stack Operations}
921 \textit {The stack operations defined in 
922 Section \refersec{chap:stackoperations}.
923 are fairly conventional, but the following
924 examples illustrate their behavior graphically.
925 }
926
927 \begin{tabular}{rrcrr} 
928  &Before & Operation&& After \\
929
930 0& 17& \livelink{chap:DWOPdup}{DW\-\_OP\-\_dup} &0 &17 \\
931 1&   29& &  1 & 17 \\
932 2& 1000 & & 2 & 29\\
933 & & &         3&1000\\
934 & & & & \\
935 0 & 17 & \livelink{chap:DWOPdrop}{DW\-\_OP\-\_drop} & 0 & 29 \\
936 1 &29  &            & 1 & 1000 \\
937 2 &1000& & &          \\
938
939 & & & & \\
940 0 & 17 & \livelink{chap:DWOPpick}{DW\-\_OP\-\_pick} & 0 & 1000 \\
941 1 & 29 & & 1&17 \\
942 2 &1000& &2&29 \\
943   &    & &3&1000 \\
944
945 & & & & \\
946 0&17& \livelink{chap:DWOPover}{DW\-\_OP\-\_over}&0&29 \\
947 1&29& &  1&17 \\
948 2&1000 & & 2&29\\
949  &     & & 3&1000 \\
950
951 & & & & \\
952 0&17& \livelink{chap:DWOPswap}{DW\-\_OP\-\_swap} &0&29 \\
953 1&29& &  1&17 \\
954 2&1000 & & 2&1000 \\
955
956 & & & & \\
957 0&17&\livelink{chap:DWOProt}{DW\-\_OP\-\_rot} & 0 &29 \\
958 1&29 & & 1 & 1000 \\
959 2& 1000 & &  2 & 17 \\
960 \end{tabular}
961
962 \section{Location Descriptions}
963 \label{chap:locationdescriptions}
964 \textit{ Debugging information must provide consumers a way to find
965 the location of program variables, determine the bounds
966 of dynamic arrays and strings, and possibly to find the
967 base address of a subroutine’s stack frame or the return
968 address of a subroutine. Furthermore, to meet the needs of
969 recent computer architectures and optimization techniques,
970 debugging information must be able to describe the location of
971 an object whose location changes over the object’s lifetime.}
972
973 Information about the location of program objects is provided
974 by location descriptions. Location descriptions can be either
975 of two forms:
976 \begin{enumerate}[1]
977 \item \textit{Single location descriptions}, which are a language independent representation of
978 addressing rules of arbitrary complexity built from 
979 DWARF expressions (See section \refersec{chap:dwarfexpressions}) 
980 and/or other
981 DWARF operations specific to describing locations. They are
982 sufficient for describing the location of any object as long
983 as its lifetime is either static or the same as the lexical
984 block that owns it, and it does not move during its lifetime.
985
986 Single location descriptions are of two kinds:
987 \begin{enumerate}[a]
988 \item Simple location descriptions, which describe the location
989 of one contiguous piece (usually all) of an object. A simple
990 location description may describe a location in addressable
991 memory, or in a register, or the lack of a location (with or
992 without a known value).
993
994 \item  Composite location descriptions, which describe an
995 object in terms of pieces each of which may be contained in
996 part of a register or stored in a memory location unrelated
997 to other pieces.
998
999 \end{enumerate}
1000 \item \textit{Location lists}, which are used to describe
1001 objects that have a limited lifetime or change their location
1002 during their lifetime. Location lists are more completely
1003 described below.
1004
1005 \end{enumerate}
1006
1007 The two forms are distinguished in a context sensitive
1008 manner. As the value of an attribute, a location description
1009 is encoded using class \livelink{chap:exprloc}{exprloc}  
1010 and a location list is encoded
1011 using class \livelink{chap:loclistptr}{loclistptr} (which serves as an offset into a
1012 separate location list table).
1013
1014
1015 \subsection{Single Location Descriptions}
1016 A single location description is either:
1017
1018 \begin{enumerate}[1]
1019 \item A simple location description, representing an object
1020 which exists in one contiguous piece at the given location, or 
1021 \item A composite location description consisting of one or more
1022 simple location descriptions, each of which is followed by
1023 one composition operation. Each simple location description
1024 describes the location of one piece of the object; each
1025 composition operation describes which part of the object is
1026 located there. Each simple location description that is a
1027 DWARF expression is evaluated independently of any others
1028 (as though on its own separate stack, if any). 
1029 \end{enumerate}
1030
1031
1032
1033 \subsubsection{Simple Location Descriptions}
1034
1035 A simple location description consists of one 
1036 contiguous piece or all of an object or value.
1037
1038
1039 \paragraph{Memory Location Descriptions}
1040
1041 A memory location description consists of a non\dash empty DWARF
1042 expression (see 
1043 Section \refersec{chap:dwarfexpressions}
1044 ), whose value is the address of
1045 a piece or all of an object or other entity in memory.
1046
1047 \paragraph{Register Location Descriptions}
1048
1049 A register location description consists of a register name
1050 operation, which represents a piece or all of an object
1051 located in a given register.
1052
1053 \textit{Register location descriptions describe an object
1054 (or a piece of an object) that resides in a register, while
1055 the opcodes listed in 
1056 Section \refersec{chap:registerbasedaddressing}
1057 are used to describe an object (or a piece of
1058 an object) that is located in memory at an address that is
1059 contained in a register (possibly offset by some constant). A
1060 register location description must stand alone as the entire
1061 description of an object or a piece of an object.
1062 }
1063
1064 The following DWARF operations can be used to name a register.
1065
1066
1067 \textit{Note that the register number represents a DWARF specific
1068 mapping of numbers onto the actual registers of a given
1069 architecture. The mapping should be chosen to gain optimal
1070 density and should be shared by all users of a given
1071 architecture. It is recommended that this mapping be defined
1072 by the ABI authoring committee for each architecture.
1073 }
1074 \begin{enumerate}[1]
1075 \item DW\-\_OP\-\_reg0, DW\-\_OP\-\_reg1, ..., DW\-\_OP\-\_reg31 \\
1076 The DW\-\_OP\-\_regn operations encode the names of up to 32
1077 registers, numbered from 0 through 31, inclusive. The object
1078 addressed is in register n.
1079
1080 \item DW\-\_OP\-\_regx \\
1081 The DW\-\_OP\-\_regx operation has a single unsigned LEB128 literal
1082 operand that encodes the name of a register.  
1083 \end{enumerate}
1084
1085 \textit{These operations name a register location. To
1086 fetch the contents of a register, it is necessary to use
1087 one of the register based addressing operations, such as
1088 DW\-\_OP\-\_bregx 
1089 (Section \refersec{chap:registerbasedaddressing})}.
1090
1091
1092 \paragraph{Implicit Location Descriptions}
1093
1094 An implicit location description represents a piece or all
1095 of an object which has no actual location but whose contents
1096 are nonetheless either known or known to be undefined.
1097
1098 The following DWARF operations may be used to specify a value
1099 that has no location in the program but is a known constant
1100 or is computed from other locations and values in the program.
1101
1102 The following DWARF operations may be used to specify a value
1103 that has no location in the program but is a known constant
1104 or is computed from other locations and values in the program.
1105
1106 \begin{enumerate}[1]
1107 \item DW\-\_OP\-\_implicit\-\_value \\
1108 The DW\-\_OP\-\_implicit\-\_value operation specifies an immediate value
1109 using two operands: an unsigned LEB128 length, followed by
1110 a block representing the value in the memory representation
1111 of the target machine. The length operand gives the length
1112 in bytes of the block.
1113
1114 \item DW\-\_OP\-\_stack\-\_value \\
1115 The DW\-\_OP\-\_stack\-\_value operation specifies that the object
1116 does not exist in memory but its value is nonetheless known
1117 and is at the top of the DWARF expression stack. In this form
1118 of location description, the DWARF expression represents the
1119 actual value of the object, rather than its location. The
1120 DW\-\_OP\-\_stack\-\_value operation terminates the expression.
1121 \end{enumerate}
1122
1123
1124 \paragraph{Empty Location Descriptions}
1125
1126 An empty location description consists of a DWARF expression
1127 containing no operations. It represents a piece or all of an
1128 object that is present in the source but not in the object code
1129 (perhaps due to optimization).
1130
1131 \subsubsection{Composite Location Descriptions}
1132 A composite location description describes an object or
1133 value which may be contained in part of a register or stored
1134 in more than one location. Each piece is described by a
1135 composition operation, which does not compute a value nor
1136 store any result on the DWARF stack. There may be one or
1137 more composition operations in a single composite location
1138 description. A series of such operations describes the parts
1139 of a value in memory address order.
1140
1141 Each composition operation is immediately preceded by a simple
1142 location description which describes the location where part
1143 of the resultant value is contained.
1144
1145 \begin{enumerate}[1]
1146 \item DW\-\_OP\-\_piece \\
1147 The DW\-\_OP\-\_piece operation takes a single operand, which is an
1148 unsigned LEB128 number.  The number describes the size in bytes
1149 of the piece of the object referenced by the preceding simple
1150 location description. If the piece is located in a register,
1151 but does not occupy the entire register, the placement of
1152 the piece within that register is defined by the ABI.
1153
1154 \textit{Many compilers store a single variable in sets of registers,
1155 or store a variable partially in memory and partially in
1156 registers. DW\-\_OP\-\_piece provides a way of describing how large
1157 a part of a variable a particular DWARF location description
1158 refers to. }
1159
1160 \item DW\-\_OP\-\_bit\-\_piece \\
1161 The DW\-\_OP\-\_bit\-\_piece operation takes two operands. The first
1162 is an unsigned LEB128 number that gives the size in bits
1163 of the piece. The second is an unsigned LEB128 number that
1164 gives the offset in bits from the location defined by the
1165 preceding DWARF location description.  
1166
1167 Interpretation of the
1168 offset depends on the kind of location description. If the
1169 location description is empty, the offset doesn’t matter and
1170 the DW\-\_OP\-\_bit\-\_piece operation describes a piece consisting
1171 of the given number of bits whose values are undefined. If
1172 the location is a register, the offset is from the least
1173 significant bit end of the register. If the location is a
1174 memory address, the DW\-\_OP\-\_bit\-\_piece operation describes a
1175 sequence of bits relative to the location whose address is
1176 on the top of the DWARF stack using the bit numbering and
1177 direction conventions that are appropriate to the current
1178 language on the target system. If the location is any implicit
1179 value or stack value, the DW\-\_OP\-\_bit\-\_piece operation describes
1180 a sequence of bits using the least significant bits of that
1181 value.  
1182 \end{enumerate}
1183
1184 \textit{DW\-\_OP\-\_bit\-\_piece is used instead of DW\-\_OP\-\_piece when
1185 the piece to be assembled into a value or assigned to is not
1186 byte-sized or is not at the start of a register or addressable
1187 unit of memory.}
1188
1189
1190
1191
1192 \subsubsection{Example Single Location Descriptions}
1193
1194 Here are some examples of how DWARF operations are used to form location descriptions:
1195
1196 DW\-\_OP\-\_reg3
1197 \begin{myindentpara}{1cm}
1198 The value is in register 3.
1199 \end{myindentpara}
1200
1201 DW\-\_OP\-\_regx 54
1202 \begin{myindentpara}{1cm}
1203 The value is in register 54.
1204 \end{myindentpara}
1205
1206 DW\-\_OP\-\_addr 0x80d0045c
1207 \begin{myindentpara}{1cm}
1208 The value of a static variable is at machine address 0x80d0045c.
1209 \end{myindentpara}
1210
1211 DW\-\_OP\-\_breg11 44
1212 \begin{myindentpara}{1cm}
1213 Add 44 to the value in register 11 to get the address of an automatic
1214 variable instance.
1215 \end{myindentpara}
1216
1217 DW\-\_OP\-\_fbreg -50
1218 \begin{myindentpara}{1cm}
1219 Given a \livelink{chap:DWATframebase}{DW\-\_AT\-\_frame\-\_base} value of ``DW\-\_OP\-\_breg31 64,''this example
1220 computes the address of a local variable that is -50 bytes from a
1221 logical frame pointer that is computed by adding 64 to the current
1222 stack pointer (register 31).
1223 \end{myindentpara}
1224
1225 DW\-\_OP\-\_bregx 54 32 DW\-\_OP\-\_deref
1226 \begin{myindentpara}{1cm}
1227 A call-by-reference parameter whose address is in the word 32 bytes
1228 from where register 54 points.
1229 \end{myindentpara}
1230
1231 DW\-\_OP\-\_plus\-\_uconst 4
1232 \begin{myindentpara}{1cm}
1233 A structure member is four bytes from the start of the structure
1234 instance. The base address is assumed to be already on the stack.
1235 \end{myindentpara}
1236
1237 DW\-\_OP\-\_reg3 DW\-\_OP\-\_piece 4 DW\-\_OP\-\_reg10 DW\-\_OP\-\_piece 2
1238 \begin{myindentpara}{1cm}
1239 A variable whose first four bytes reside in register 3 and whose next
1240 two bytes reside in register 10.
1241 \end{myindentpara}
1242
1243 DW\-\_OP\-\_reg0 DW\-\_OP\-\_piece 4 DW\-\_OP\-\_piece 4 DW\-\_OP\-\_fbreg -12 DW\-\_OP\-\_piece 4
1244 \begin{myindentpara}{1cm}
1245 A twelve byte value whose first four bytes reside in register zero,
1246 whose middle four bytes are unavailable (perhaps due to optimization),
1247 and whose last four bytes are in memory, 12 bytes before the frame
1248 base.
1249 \end{myindentpara}
1250
1251 DW\-\_OP\-\_breg1 0 DW\-\_OP\-\_breg2 0 DW\-\_OP\-\_plus DW\-\_OP\-\_stack\-\_value
1252 \begin{myindentpara}{1cm}
1253 Add the contents of r1 and r2 to compute a value. This value is the
1254 “contents” of an otherwise anonymous location.
1255 \end{myindentpara}
1256
1257 DW\-\_OP\-\_lit1 DW\-\_OP\-\_stack\-\_value DW\-\_OP\-\_piece a \\
1258 DW\-\_OP\-\_breg3 0 DW\-\_OP\-\_breg4 0 DW\-\_OP\-\_plus DW\-\_OP\-\_stack\-\_value DW\-\_OP\-\_piece 4
1259 \begin{myindentpara}{1cm}
1260 The object value is found in an anonymous (virtual) location whose
1261 value consists of two parts, given in memory address order: the 4 byte
1262 value 1 followed by the four byte value computed from the sum of the
1263 contents of r3 and r4.
1264 \end{myindentpara}
1265
1266
1267 \subsection{Location Lists}
1268 \label{chap:locationlists}
1269 Location lists are used in place of location expressions
1270 whenever the object whose location is being described
1271 can change location during its lifetime. Location lists
1272 are contained in a separate object file section called
1273 .debug\_loc. A location list is indicated by a location
1274 attribute whose value is an offset from the beginning of
1275 the .debug\_loc section to the first byte of the list for the
1276 object in question.
1277
1278 Each entry in a location list is either a location list entry,
1279 a base address selection entry, or an end of list entry.
1280
1281 A location list entry consists of:
1282
1283 \begin{enumerate}[1]
1284 \item A beginning address offset. 
1285 This address offset has the size of an address and is
1286 relative to the applicable base address of the compilation
1287 unit referencing this location list. It marks the beginning
1288 of the address range over which the location is valid.
1289
1290 \item An ending address offset.  This address offset again
1291 has the size of an address and is relative to the applicable
1292 base address of the compilation unit referencing this location
1293 list. It marks the first address past the end of the address
1294 range over which the location is valid. The ending address
1295 must be greater than or equal to the beginning address.
1296
1297 \textit{A location list entry (but not a base address selection or end of list entry) whose beginning
1298 and ending addresses are equal has no effect because the size of the range covered by such
1299 an entry is zero.}
1300
1301 \item A single location description 
1302 describing the location of the object over the range specified by
1303 the beginning and end addresses.
1304 \end{enumerate}
1305
1306 The applicable base address of a location list entry is
1307 determined by the closest preceding base address selection
1308 entry (see below) in the same location list. If there is
1309 no such selection entry, then the applicable base address
1310 defaults to the base address of the compilation unit (see
1311 Section \refersec{chap:normalandpartialcompilationunitentries}).  
1312 In the case of a compilation unit where all of
1313 the machine code is contained in a single contiguous section,
1314 no base address selection entry is needed.
1315
1316 Address ranges may overlap. When they do, they describe a
1317 situation in which an object exists simultaneously in more than
1318 one place. If all of the address ranges in a given location
1319 list do not collectively cover the entire range over which the
1320 object in question is defined, it is assumed that the object is
1321 not available for the portion of the range that is not covered.
1322
1323 A base address selection entry consists of:
1324 \begin{enumerate}[1]
1325 \item The value of the largest representable 
1326 address offset (for example, 0xffffffff when the size of
1327 an address is 32 bits).
1328 \item An address, which defines the 
1329 appropriate base address for use in interpreting the beginning
1330 and ending address offsets of subsequent entries of the location list.
1331 \end{enumerate}
1332
1333
1334 \textit{A base address selection entry 
1335 affects only the list in which it is contained.}
1336
1337 The end of any given location list is marked by an end of
1338 list entry, which consists of a 0 for the beginning address
1339 offset and a 0 for the ending address offset. A location list
1340 containing only an end of list entry describes an object that
1341 exists in the source code but not in the executable program.
1342
1343 Neither a base address selection entry nor an end of list
1344 entry includes a location description.
1345
1346 \textit{A base address selection entry and an end of list
1347 entry for a location list are identical to a base address
1348 selection entry and end of list entry, respectively, for a
1349 range list 
1350 (see Section \refersec{chap:noncontiguousaddressranges}) 
1351 in interpretation
1352 and representation.}
1353
1354
1355
1356
1357
1358
1359 \section{Types of Program Entities}
1360 \label{chap:typesofprogramentities}
1361 Any debugging information entry describing a declaration that
1362 has a type has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute, whose value is a
1363 reference to another debugging information entry. The entry
1364 referenced may describe a base type, that is, a type that is
1365 not defined in terms of other data types, or it may describe a
1366 user-defined type, such as an array, structure or enumeration.
1367 Alternatively, the entry referenced may describe a type
1368 modifier, such as constant, packed, pointer, reference or
1369 volatile, which in turn will reference another entry describing
1370 a type or type modifier (using a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute of its
1371 own). See 
1372 Section  \refersec{chap:typeentries} 
1373 for descriptions of the entries describing
1374 base types, user-defined types and type modifiers.
1375
1376
1377
1378 \section{Accessibility of Declarations}
1379 \label{chap:accessibilityofdeclarations}
1380 \textit{Some languages, notably C++ and Ada, have the concept of
1381 the accessibility of an object or of some other program
1382 entity. The accessibility specifies which classes of other
1383 program objects are permitted access to the object in question.}
1384
1385 The accessibility of a declaration is represented by a \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility} attribute, whose
1386 value is a constant drawn from the set of codes listed in Figure 
1387 \ref{fig:accessibilitycodes}.
1388
1389 \begin{figure}[here]
1390 \begin{description}
1391 \centering
1392 \item [DW\-\_ACCESS\-\_public]
1393 \item [DW\-\_ACCESS\-\_private]
1394 \item [DW\-\_ACCESS\-\_protected]
1395 \end{description}
1396 \caption{Accessibility codes}
1397 \label{fig:accessibilitycodes}
1398 \end{figure}
1399
1400 \section{Visibility of Declarations}
1401 \label{chap:visibilityofdeclarations}
1402
1403 \textit{Several languages (such as Modula-2) 
1404 have the concept of the visibility of a declaration. The
1405 visibility specifies which declarations are to be 
1406 visible outside of the entity in which they are
1407 declared.}
1408
1409 The visibility of a declaration is represented 
1410 by a \livelink{chap:DWATvisibility}{DW\-\_AT\-\_visibility} attribute, whose value is a
1411 constant drawn from the set of codes listed in 
1412 Figure \ref{fig:visibilitycodes}.
1413
1414 \begin{figure}[here]
1415 \begin{description}
1416 \centering
1417 \item [DW\-\_VIS\-\_local]
1418 \item [DW\-\_VIS\-\_exported]
1419 \item [DW\-\_VIS\-\_qualified]
1420 \end{description}
1421 \caption{Visibility codes}
1422 \label{fig:visibilitycodes}
1423 \end{figure}
1424
1425 \section{Virtuality of Declarations}
1426 \label{chap:virtualityofdeclarations}
1427 \textit{C++ provides for virtual and pure virtual structure or class
1428 member functions and for virtual base classes.}
1429
1430 The virtuality of a declaration is represented by a
1431 \livelink{chap:DWATvirtuality}{DW\-\_AT\-\_virtuality} attribute, whose value is a constant drawn
1432 from the set of codes listed in 
1433 Figure \ref{fig:virtualitycodes}.
1434
1435 \begin{figure}[here]
1436 \begin{description}
1437 \centering
1438 \item [DW\-\_VIRTUALITY\-\_none]
1439 \item [DW\-\_VIRTUALITY\-\_virtual]
1440 \item [DW\-\_VIRTUALITY\-\_pure\-\_virtual]
1441 \end{description}
1442 \caption{Virtuality codes}
1443 \label{fig:virtualitycodes}
1444 \end{figure}
1445
1446 \section{Artificial Entries}
1447 \label{chap:artificialentries}
1448 \textit{A compiler may wish to generate debugging information entries
1449 for objects or types that were not actually declared in the
1450 source of the application. An example is a formal parameter
1451 entry to represent the hidden this parameter that most C++
1452 implementations pass as the first argument to non-static member
1453 functions.}  
1454
1455 Any debugging information entry representing the
1456 declaration of an object or type artificially generated by
1457 a compiler and not explicitly declared by the source program
1458 may have a \livelink{chap:DWATartificial}{DW\-\_AT\-\_artificial} attribute, which is a flag.
1459
1460 \section{Segmented Addresses}
1461 \label{chap:segmentedaddresses}
1462 \textit{In some systems, addresses are specified as offsets within a
1463 given segment rather than as locations within a single flat
1464 address space.}
1465
1466 Any debugging information entry that contains a description
1467 of the location of an object or subroutine may have
1468 a \livelink{chap:DWATsegment}{DW\-\_AT\-\_segment} attribute, whose value is a location
1469 description. The description evaluates to the segment selector
1470 of the item being described. If the entry containing the
1471 \livelink{chap:DWATsegment}{DW\-\_AT\-\_segment} attribute has a \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc}, \livelink{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc},
1472 \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} or \livelink{chap:DWATentrypc}{DW\-\_AT\-\_entry\-\_pc} attribute, or a location
1473 description that evaluates to an address, then those address
1474 values represent the offset portion of the address within
1475 the segment specified by \livelink{chap:DWATsegment}{DW\-\_AT\-\_segment}.
1476
1477 If an entry has no \livelink{chap:DWATsegment}{DW\-\_AT\-\_segment} attribute, it inherits
1478 the segment value from its parent entry.  If none of the
1479 entries in the chain of parents for this entry back to
1480 its containing compilation unit entry have \livelink{chap:DWATsegment}{DW\-\_AT\-\_segment}
1481 attributes, then the entry is assumed to exist within a flat
1482 address space. Similarly, if the entry has a \livelink{chap:DWATsegment}{DW\-\_AT\-\_segment}
1483 attribute containing an empty location description, that
1484 entry is assumed to exist within a flat address space.
1485
1486 \textit{Some systems support different classes of addresses. The
1487 address class may affect the way a pointer is dereferenced
1488 or the way a subroutine is called.}
1489
1490
1491 Any debugging information entry representing a pointer or
1492 reference type or a subroutine or subroutine type may have
1493 a \livelink{chap:DWATaddressclass}{DW\-\_AT\-\_address\-\_class} attribute, whose value is an integer
1494 constant.  The set of permissible values is specific to
1495 each target architecture. The value DW\-\_ADDR\-\_none, however,
1496 is common to all encodings, and means that no address class
1497 has been specified.
1498
1499 \textit {For example, the Intel386 ™ processor might use the following values:}
1500
1501 \begin{figure}[here]
1502 \centering
1503 \begin{tabular}{lll} 
1504 Name&Value&Meaning  \\
1505 \hline
1506 \textit{DW\-\_ADDR\-\_none}&   0 & \textit{no class specified} \\
1507 \textit{DW\-\_ADDR\-\_near16}& 1 & \textit{16\dash bit offset, no segment} \\
1508 \textit{DW\-\_ADDR\-\_far16}&  2 & \textit{16\dash bit offset, 16\dash bit segment} \\
1509 \textit{DW\-\_ADDR\-\_huge16}& 3 & \textit{16\dash bit offset, 16\dash bit segment} \\
1510 \textit{DW\-\_ADDR\-\_near32}& 4 & \textit{32\dash bit offset, no segment} \\
1511 \textit{DW\-\_ADDR\-\_far32}&  5 & \textit{32\dash bit offset, 16\dash bit segment}
1512 \end{tabular}
1513 \caption{Example address class codes}
1514 \label{fig:inteladdressclasstable}
1515 \end{figure}
1516
1517 \section{Non-Defining Declarations and Completions}
1518 \label{nondefiningdeclarationsandcompletions}
1519 A debugging information entry representing a program entity
1520 typically represents the defining declaration of that
1521 entity. In certain contexts, however, a debugger might need
1522 information about a declaration of an entity that is not
1523 also a definition, or is otherwise incomplete, to evaluate
1524 an expression correctly.
1525
1526 \textit{As an example, consider the following fragment of C code:}
1527
1528 \begin{lstlisting}
1529 void myfunc()
1530 {
1531   int x;
1532   {
1533     extern float x;
1534     g(x);
1535   }
1536 }
1537 \end{lstlisting}
1538
1539
1540 \textit{C scoping rules require that the 
1541 value of the variable x passed to the function g is the value of the
1542 global variable x rather than of the local version.}
1543
1544
1545 \section{Declaration Coordinates}
1546 \label{chap:declarationcoordinates}
1547 \textit{It is sometimes useful in a debugger to be able to associate
1548 a declaration with its occurrence in the program source.
1549 }
1550
1551 Any debugging information entry representing the
1552 declaration of an object, module, subprogram or type may have
1553 \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file}, \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} and \livelink{chap:DWATdeclcolumn}{DW\-\_AT\-\_decl\-\_column}
1554 attributes each of whose value is an unsigned integer constant.
1555
1556 The value of the \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file} attribute corresponds to
1557 a file number from the line number information table for the
1558 compilation unit containing the debugging information entry and
1559 represents the source file in which the declaration appeared
1560 (see Section 6.2). The value 0 indicates that no source file
1561 has been specified.
1562
1563 The value of the \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} attribute represents
1564 the source line number at which the first character of
1565 the identifier of the declared object appears. The value 0
1566 indicates that no source line has been specified.
1567
1568 The value of the \livelink{chap:DWATdeclcolumn}{DW\-\_AT\-\_decl\-\_column} attribute represents
1569 the source column number at which the first character of
1570 the identifier of the declared object appears. The value 0
1571 indicates that no column has been specified.
1572
1573 \section{Identifier Names}
1574 \label{chap:identifiernames}
1575 Any debugging information entry representing a program entity
1576 that has been given a name may have a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute,
1577 whose value is a string representing the name as it appears in
1578 the source program. A debugging information entry containing
1579 no name attribute, or containing a name attribute whose value
1580 consists of a name containing a single null byte, represents
1581 a program entity for which no name was given in the source.
1582
1583 \textit{Because the names of program objects described by DWARF are the
1584 names as they appear in the source program, implementations
1585 of language translators that use some form of mangled name
1586 (as do many implementations of C++) should use the unmangled
1587 form of the name in the DWARF \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute,
1588 including the keyword operator (in names such as “operator
1589 +”), if present. See also 
1590 Section \refersec{chap:linkagenames} regarding the use
1591 of \livelink{chap:DWATlinkagename}{DW\-\_AT\-\_linkage\-\_name} for mangled names. Sequences of
1592 multiple whitespace characters may be compressed.}
1593
1594 \section{Data Locations and DWARF Procedures}
1595 Any debugging information entry describing a data object (which
1596 includes variables and parameters) or common block may have a
1597 \livelink{chap:DWATlocation}{DW\-\_AT\-\_location} attribute, whose value is a location description
1598 (see Section 2.6).  
1599
1600 A DWARF procedure is represented by any
1601 kind of debugging information entry that has a \livelink{chap:DWATlocation}{DW\-\_AT\-\_location}
1602 attribute. If a suitable entry is not otherwise available,
1603 a DWARF procedure can be represented using a debugging
1604 information entry with the 
1605 tag \livetarg{chap:DWTAGdwarfprocedure}{DW\-\_TAG\-\_dwarf\-\_procedure}
1606 together with a \livelink{chap:DWATlocation}{DW\-\_AT\-\_location} attribute.  
1607
1608 A DWARF procedure
1609 is called by a DW\-\_OP\-\_call2, 
1610 DW\-\_OP\-\_call4 or 
1611 DW\-\_OP\-\_call\-\_ref
1612 DWARF expression operator 
1613 (see Section \refersec{chap:controlflowoperations}).
1614
1615 \section{Code Addresses and Ranges}
1616 \label{chap:codeaddressesandranges}
1617 Any debugging information entry describing an entity that has
1618 a machine code address or range of machine code addresses,
1619 which includes compilation units, module initialization,
1620 subroutines, ordinary blocks, try/catch blocks, labels and
1621 the like, may have
1622
1623 \begin{itemize}
1624 \item A \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} and \livelink{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc} pair of 
1625 attributes for a single contiguous range of
1626 addresses, or
1627
1628 \item A \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} attribute for a non-contiguous range of addresses.
1629 \end{itemize}
1630
1631 In addition, a non-contiguous range of 
1632 addresses may also be specified for the
1633 \livelink{chap:DWATstartscope}{DW\-\_AT\-\_start\-\_scope} attribute.
1634 If an entity has no associated machine code, 
1635 none of these attributes are specified.
1636
1637 \subsection{Single Address} 
1638 When there is a single address associated with an entity,
1639 such as a label or alternate entry point of a subprogram,
1640 the entry has a \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} attribute whose value is the
1641 relocated address for the entity.  While the \livelink{chap:DWATentrypc}{DW\-\_AT\-\_entry\-\_pc}
1642 attribute might also seem appropriate for this purpose,
1643 historically the \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} attribute was used before the
1644 \livelink{chap:DWATentrypc}{DW\-\_AT\-\_entry\-\_pc} was introduced (in DWARF Version 3). There is
1645 insufficient reason to change this.
1646
1647 \subsection{Continuous Address Range}
1648 \label{chap:contiguousaddressranges}
1649 When the set of addresses of a debugging information entry can
1650 be described as a single continguous range, the entry may have
1651 a \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} and \livelink{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc} pair of attributes. The value
1652 of the \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} attribute is the relocated address of the
1653 first instruction associated with the entity. If the value of
1654 the \livelink{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc} is of class address, it is the relocated
1655 address of the first location past the last instruction
1656 associated with the entity; if it is of class constant, the
1657 value is an unsigned integer offset which when added to the
1658 low PC gives the address of the first location past the last
1659 instruction associated with the entity.  The high PC value
1660 may be beyond the last valid instruction in the executable.
1661 The presence of low and high PC attributes for an entity
1662 implies that the code generated for the entity is contiguous
1663 and exists totally within the boundaries specified by those
1664 two attributes. If that is not the case, no low and high PC
1665 attributes should be produced.
1666
1667 \subsection{Non\dash Contiguous Address Ranges}
1668 \label{chap:noncontiguousaddressranges}
1669 When the set of addresses of a debugging information entry
1670 cannot be described as a single contiguous range, the entry has
1671 a \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} attribute whose value is of class \livelink{chap:rangelistptr}{rangelistptr}
1672 and indicates the beginning of a range list. Similarly,
1673 a \livelink{chap:DWATstartscope}{DW\-\_AT\-\_start\-\_scope} attribute may have a value of class
1674 \livelink{chap:rangelistptr}{rangelistptr} for the same reason.  
1675
1676 Range lists are contained
1677 in a separate object file section called .debug\_ranges. A
1678 range list is indicated by a \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} attribute whose
1679 value is represented as an offset from the beginning of the
1680 .debug\_ranges section to the beginning of the range list.
1681
1682 Each entry in a range list is either a range list entry,
1683 a base address selection entry, or an end of list entry.
1684
1685 A range list entry consists of:
1686
1687 \begin{enumerate}[1]
1688 \item A beginning address offset. This address offset has the size of an address and is relative to
1689 the applicable base address of the compilation unit referencing this range list. It marks the
1690 beginning of an address range.
1691
1692 \item An ending address offset. This address offset again has the size of an address and is relative
1693 to the applicable base address of the compilation unit referencing this range list. It marks the
1694 first address past the end of the address range.The ending address must be greater than or
1695 equal to the beginning address.
1696
1697 \textit{A range list entry (but not a base address selection or end of list entry) whose beginning and
1698 ending addresses are equal has no effect because the size of the range covered by such an
1699 entry is zero.}
1700 \end{enumerate}
1701
1702 The applicable base address of a range list entry is determined
1703 by the closest preceding base address selection entry (see
1704 below) in the same range list. If there is no such selection
1705 entry, then the applicable base address defaults to the base
1706 address of the compilation unit 
1707 (see Section \refersec{chap:normalandpartialcompilationunitentries}).
1708
1709 \textit{In the case of a compilation unit where all of the machine
1710 code is contained in a single contiguous section, no base
1711 address selection entry is needed.}
1712
1713 Address range entries in
1714 a range list may not overlap. There is no requirement that
1715 the entries be ordered in any particular way.
1716
1717 A base address selection entry consists of:
1718
1719 \begin{enumerate}[1]
1720 \item The value of the largest representable address offset (for example, 0xffffffff when the size of
1721 an address is 32 bits).
1722
1723 \item An address, which defines the appropriate base address for use in interpreting the beginning
1724 and ending address offsets of subsequent entries of the location list.
1725 \end{enumerate}
1726 \textit{A base address selection entry 
1727 affects only the list in which it is contained.}
1728
1729
1730 The end of any given range list is marked by an end of
1731 list entry, which consists of a 0 for the beginning address
1732 offset and a 0 for the ending address offset. A range list
1733 containing only an end of list entry describes an empty scope
1734 (which contains no instructions).
1735
1736 \textit{A base address selection entry and an end of list entry for
1737 a range list are identical to a base address selection entry
1738 and end of list entry, respectively, for a location list
1739 (see Section 2.6.2) in interpretation and representation.}
1740
1741
1742
1743 \section{Entry Address}
1744 \label{chap:entryaddress}
1745 \textit{The entry or first executable instruction generated
1746 for an entity, if applicable, is often the lowest addressed
1747 instruction of a contiguous range of instructions. In other
1748 cases, the entry address needs to be specified explicitly.}
1749
1750 Any debugging information entry describing an entity that has
1751 a range of code addresses, which includes compilation units,
1752 module initialization, subroutines, ordinary blocks, try/catch
1753 blocks, and the like, may have a \livelink{chap:DWATentrypc}{DW\-\_AT\-\_entry\-\_pc} attribute to
1754 indicate the first executable instruction within that range
1755 of addresses. The value of the \livelink{chap:DWATentrypc}{DW\-\_AT\-\_entry\-\_pc} attribute is a
1756 relocated address. If no \livelink{chap:DWATentrypc}{DW\-\_AT\-\_entry\-\_pc} attribute is present,
1757 then the entry address is assumed to be the same as the
1758 value of the \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} attribute, if present; otherwise,
1759 the entry address is unknown.
1760
1761 \section{Static and Dynamic Values of Attributes}
1762 \label{chap:staticanddynamicvaluesofattributes}
1763
1764 Some attributes that apply to types specify a property (such
1765 as the lower bound of an array) that is an integer value,
1766 where the value may be known during compilation or may be
1767 computed dynamically during execution.  The value of these
1768 attributes is determined based on the class as follows:
1769
1770 \begin{itemize}
1771 \item For a \livelink{chap:constant}{constant}, the value of the constant is the value of
1772 the attribute.
1773
1774 \item For a \livelink{chap:reference}{reference}, the
1775 value is a reference to another
1776 entity which specifies the value of the attribute.
1777
1778 \item For an \livelink{chap:exprloc}{exprloc}, the value is interpreted as a 
1779 DWARF expression; 
1780 evaluation of the expression yields the value of
1781 the attribute.
1782 \end{itemize}
1783
1784 \textit{
1785 Whether an attribute value can be dynamic depends on the
1786 rules of the applicable programming language.
1787 }
1788
1789 \textit{The applicable attributes include: 
1790 \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated},
1791 \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated}, 
1792 \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset}, 
1793 \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size},
1794 \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, 
1795 \livelink{chap:DWATcount}{DW\-\_AT\-\_count}, 
1796 \livelink{chap:DWATlowerbound}{DW\-\_AT\-\_lower\-\_bound},
1797 \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride}, 
1798 \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride}, 
1799 \livelink{chap:DWATupperbound}{DW\-\_AT\-\_upper\-\_bound} (and
1800 possibly others).}
1801
1802
1803 \section{Entity Descriptions}
1804 \textit{Some debugging information entries may describe entities
1805 in the program that are artificial, or which otherwise are
1806 ``named'' in ways which are not valid identifiers in the
1807 programming language. For example, several languages may
1808 capture or freeze the value of a variable at a particular
1809 point in the program. Ada 95 has package elaboration routines,
1810 type descriptions of the form typename’Class, and 
1811 ``access typename'' parameters.  }
1812
1813 Generally, any debugging information
1814 entry that has, or may have, a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, may
1815 also have a \livelink{chap:DWATdescription}{DW\-\_AT\-\_description} attribute whose value is a
1816 null-terminated string providing a description of the entity.
1817
1818
1819 \textit{It is expected that a debugger will only display these
1820 descriptions as part of the description of other entities. It
1821 should not accept them in expressions, nor allow them to be
1822 assigned, or the like.}
1823
1824 \section{Byte and Bit Sizes}
1825 \label{chap:byteandbitsizes}
1826 % Some trouble here with hbox full, so we try optional word breaks.
1827 Many debugging information entries allow either a
1828 \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute or a \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute,
1829 whose integer constant value 
1830 (see \refersec{chap:staticanddynamicvaluesofattributes}) 
1831 specifies an
1832 amount of storage. The value of the \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute
1833 is interpreted in bytes and the value of the \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size}
1834 attribute is interpreted in bits.  
1835
1836 Similarly, the integer
1837 constant value of a \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride} attribute is interpreted
1838 in bytes and the integer constant value of a \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride}
1839 attribute is interpreted in bits.
1840
1841 \section{Linkage Names}
1842 \label{chap:linkagenames}
1843 \textit{Some language implementations, notably C++ and similar
1844 languages, make use of implementation defined names within
1845 object files that are different from the identifier names
1846 (see \refersec{chap:identifiernames}) of entities as they appear in the
1847 source. Such names, sometimes known as mangled names,
1848 are used in various ways, such as: to encode additional
1849 information about an entity, to distinguish multiple entities
1850 that have the same name, and so on. When an entity has an
1851 associated distinct linkage name it may sometimes be useful
1852 for a producer to include this name in the DWARF description
1853 of the program to facilitate consumer access to and use of
1854 object file information about an entity and/or information
1855 that is encoded in the linkage name itself.  
1856 }
1857
1858 % Some trouble maybe with hbox full, so we try optional word breaks.
1859 A debugging
1860 information entry may have a \livelink{chap:DWATlinkagename}{DW\-\_AT\-\_linkage\-\_name} attribute
1861 whose value is a null-terminated string describing the object
1862 file linkage name associated with the corresponding entity.
1863
1864 % Some trouble here with hbox full, so we try optional word breaks.
1865 \textit{Debugging information entries to which \livelink{chap:DWATlinkagename}{DW\-\_AT\-\_linkage\-\_name}
1866 may apply include: \livelink{chap:DWTAGcommonblock}{DW\-\_TAG\-\_common\-\_block}, \livelink{chap:DWTAGconstant}{DW\-\_TAG\-\_constant},
1867 \livelink{chap:DWTAGentrypoint}{DW\-\_TAG\-\_entry\-\_point}, \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram} 
1868 and \livelink{chap:DWTAGvariable}{DW\-\_TAG\-\_variable}.
1869 }