e4ec950f6a05de939b5c3d02ed0ddfa73cdbd047
[dwarf-doc.git] / dwarf5 / latexdoc / generaldescription.tex
1 \chapter{General Description}
2 \label{chap:generaldescription}
3 \section{The Debugging Information Entry (DIE)}
4 \label{chap:thedebuggingentrydie}
5 DWARF 
6 \addtoindexx{debugging information entry}
7 uses 
8 \addtoindexx{DIE|see{debugging information entry}}
9 a series of debugging information entries (DIEs) to 
10 define a low-level
11 representation of a source program. 
12 Each debugging information entry consists of an identifying
13 \addtoindex{tag} and a series of 
14 \addtoindex{attributes}. 
15 An entry, or group of entries together, provide a description of a
16 corresponding 
17 \addtoindex{entity} in the source program. 
18 The tag specifies the class to which an entry belongs
19 and the attributes define the specific characteristics of the entry.
20
21 The set of tag names 
22 \addtoindexx{tag names|see{debugging information entry}}
23 is listed in Table \refersec{tab:tagnames}. 
24 The debugging information entries they identify are
25 described in Chapters 3, 4 and 5.
26
27 % These each need to link to definition page: FIXME
28
29 \begin{table}[p]
30 \caption{Tag names}
31 \label{tab:tagnames}
32 \simplerule[6in]
33 \autocols[0pt]{c}{2}{l}{
34 \DWTAGaccessdeclaration,
35 \DWTAGarraytype,
36 \DWTAGatomictype,
37 \DWTAGbasetype,
38 \DWTAGcallsite,
39 \DWTAGcallsiteparameter,
40 \DWTAGcatchblock,
41 \DWTAGclasstype,
42 \DWTAGcoarraytype,
43 \DWTAGcommonblock,
44 \DWTAGcommoninclusion,
45 \DWTAGcompileunit,
46 \DWTAGcondition,
47 \DWTAGconsttype,
48 \DWTAGconstant,
49 \DWTAGdwarfprocedure,
50 \DWTAGdynamictype,
51 \DWTAGentrypoint,
52 \DWTAGenumerationtype,
53 \DWTAGenumerator,
54 \DWTAGfiletype,
55 \DWTAGformalparameter,
56 \DWTAGfriend,
57 \DWTAGgenericsubrange,
58 \DWTAGimporteddeclaration,
59 \DWTAGimportedmodule,
60 \DWTAGimportedunit,
61 \DWTAGinheritance,
62 \DWTAGinlinedsubroutine,
63 \DWTAGinterfacetype,
64 \DWTAGlabel,
65 \DWTAGlexicalblock,
66 \DWTAGmodule,
67 \DWTAGmember,
68 \DWTAGnamelist,
69 \DWTAGnamelistitem,
70 \DWTAGnamespace,
71 \DWTAGpackedtype,
72 \DWTAGpartialunit,
73 \DWTAGpointertype,
74 \DWTAGptrtomembertype,
75 \DWTAGreferencetype,
76 \DWTAGrestricttype,
77 \DWTAGrvaluereferencetype,
78 \DWTAGsettype,
79 \DWTAGsharedtype,
80 \DWTAGstringtype,
81 \DWTAGstructuretype,
82 \DWTAGsubprogram,
83 \DWTAGsubrangetype,
84 \DWTAGsubroutinetype,
85 \DWTAGtemplatealias,
86 \DWTAGtemplatetypeparameter,
87 \DWTAGtemplatevalueparameter,
88 \DWTAGthrowntype,
89 \DWTAGtryblock,
90 \DWTAGtypedef,
91 \DWTAGtypeunit,
92 \DWTAGuniontype,
93 \DWTAGunspecifiedparameters,
94 \DWTAGunspecifiedtype,
95 \DWTAGvariable,
96 \DWTAGvariant,
97 \DWTAGvariantpart,
98 \DWTAGvolatiletype,
99 \DWTAGwithstmt
100 }
101 \simplerule[6in]
102 \end{table}
103
104
105 \textit{The debugging information entry descriptions 
106 in Sections 3, 4 and 5 generally include mention of
107 most, but not necessarily all, of the attributes 
108 that are normally or possibly used with the entry.
109 Some attributes, whose applicability tends to be 
110 pervasive and invariant across many kinds of
111 debugging information entries, are described in 
112 this section and not necessarily mentioned in all
113 contexts where they may be appropriate. 
114 Examples include 
115 \DWATartificial, 
116 the \livelink{chap:declarationcoordinates}{declaration coordinates}, and 
117 \DWATdescription, 
118 among others.}
119
120 The debugging information entries are contained in the 
121 \dotdebuginfo{} sections of an object file.
122
123 \needlines{7}
124 Optionally, debugging information may be partitioned such
125 that the majority of the debugging information can remain in
126 individual object files without being processed by the
127 linker. These debugging information entries are contained in
128 the \dotdebuginfodwo{} sections. These
129 sections may be placed in the object file but marked so that
130 the linker ignores them, or they may be placed in a separate
131 DWARF object file that resides alongside the normal object
132 file. See Section \refersec{datarep:splitdwarfobjects} and
133 Appendix \refersec{app:splitdwarfobjectsinformative} for details.
134
135 As a further option, debugging information entries and other debugging
136 information that are the same in multiple executables or shared objects 
137 may be found in a separate \addtoindex{supplementary object file} that 
138 contains supplementary debug sections.
139 The executable or shared object which contains references to
140 those debugging information entries contain a \dotdebugsup{} section
141 with information that identifies the supplementary object file; the 
142 supplementary object file contains a variant of this same section
143 that is used to unambiguously associate it with the referencing object.
144 See Section \refersec{data:dwarfsupplemetaryobjectfiles} for
145 further details.
146  
147 \section{Attribute Types}
148 \label{chap:attributetypes}
149 Each attribute value is characterized by an attribute name. 
150 \addtoindexx{attribute duplication}
151 No more than one attribute with a given name may appear in any
152 debugging information entry. 
153 There are no limitations on the
154 \addtoindexx{attribute ordering}
155 ordering of attributes within a debugging information entry.
156
157 The attributes are listed in Table \referfol{tab:attributenames}.  
158
159 \setlength{\extrarowheight}{0.1cm}
160 \addtoindexx{attributes!list of}
161 \begin{longtable}{l|p{9cm}}
162   \caption{Attribute names} \label{tab:attributenames} \\
163   \hline \bfseries Attribute&\bfseries Identifies or Specifies \\ \hline
164 \endfirsthead
165   \bfseries Attribute&\bfseries Identifies or Specifies \\ \hline
166 \endhead
167   \hline \emph{Continued on next page}
168 \endfoot
169   \hline
170 \endlastfoot
171 \DWATabstractoriginTARG
172 &\livelinki{chap:DWATabstractorigininlineinstance}{Inline instances of inline subprograms} {inline instances of inline subprograms} \\
173 % Heren livelink we cannot use \dash or \dash{}.
174 &\livelinki{chap:DWATabstractoriginoutoflineinstance}{Out-of-line instances of inline subprograms}{out-of-line instances of inline subprograms} \\
175 \DWATaccessibilityTARG
176 &\livelink{chap:DWATaccessibilitycandadadeclarations}{C++ and Ada declarations} \addtoindexx{Ada} \\
177 &\livelink{chap:DWATaccessibilitycppbaseclasses}{C++ base classes} \\
178 &\livelink{chap:DWATaccessibilitycppinheritedmembers}{C++ inherited members} \\
179 \DWATaddressclassTARG
180 &\livelinki{chap:DWATadressclasspointerorreferencetypes}{Pointer or reference types}{pointer or reference types}  \\
181 &\livelinki{chap:DWATaddressclasssubroutineorsubroutinetype}
182            {Subroutine or subroutine type}
183            {subroutine or subroutine type} \\
184 \DWATaddrbaseTARG
185 &\livelinki{chap:DWATaddrbaseforaddresstable}{Base offset for address table}{address table} \\
186 \DWATalignmentTARG
187 &\livelinki{chap:DWATalignmentnondefault}
188            {Non-default alignment of type, subprogram or variable}
189            {non-default alignment} \addtoindexx{alignment!non-default} \\
190 \DWATallocatedTARG
191 &\livelinki{chap:DWATallocatedallocationstatusoftypes}{Allocation status of types}{allocation status of types}  \\
192 \DWATartificialTARG
193 &\livelinki{chap:DWATartificialobjectsortypesthat}
194            {Objects or types that are not actually declared in the source}
195            {objects or types that are not actually declared in the source}  \\
196 \DWATassociatedTARG{} 
197 &\livelinki{chap:DWATassociatedassociationstatusoftypes}{Association status of types}{association status of types} \\
198 \DWATbasetypesTARG{} 
199 &\livelinki{chap:DWATbasetypesprimitivedatatypesofcompilationunit}
200            {Primitive data types of compilation unit}
201            {primitive data types of compilation unit} \\
202 \DWATbinaryscaleTARG{} 
203 &\livelinki{chap:DWATbinaryscalebinaryscalefactorforfixedpointtype}
204            {Binary scale factor for fixed-point type}
205            {binary scale factor for fixed-point type} \\
206 %\DWATbitoffsetTARG{} 
207 %&\livelinki{chap:DWATbitoffsetbasetypebitlocation}{Base type bit location}{base type bit location} \\
208 %&\livelinki{chap:DWATbitoffsetdatamemberbitlocation}{Data member bit location}{data member bit location} \\
209 \DWATbitsizeTARG{} 
210 &\livelinki{chap:DWATbitsizebasetypebitsize}{Size of a base in bits}{base type bit size} \\
211 &\livelinki{chap:DWATbitsizedatamemberbitsize}{Size of a data member in bits}{data member bit size} \\
212 \DWATbitstrideTARG{} 
213 &\livelinki{chap:DWATbitstridearrayelementstrideofarraytype}
214            {Array element stride (of array type)}
215            {array element stride (of array type)} \\
216 &\livelinki{chap:DWATbitstridesubrangestridedimensionofarraytype}
217            {Subrange stride (dimension of array type)}
218            {subrange stride (dimension of array type)} \\
219 &\livelinki{chap:DWATbitstrideenumerationstridedimensionofarraytype}
220            {Enumeration stride (dimension of array type)}
221            {enumeration stride (dimension of array type)} \\
222 \DWATbytesizeTARG{} 
223 &\livelinki{chap:DWATbytesizedataobjectordatatypesize}
224            {Size of a data object or data type in bytes}{data object or data type size} \\
225 \DWATbytestrideTARG{} 
226 &\livelinki{chap:DWATbytestridearrayelementstrideofarraytype}
227            {Array element stride (of array type)}
228            {array element stride (of array type)} \\
229 &\livelinki{chap:DWATbytestridesubrangestridedimensionofarraytype}
230            {Subrange stride (dimension of array type)}
231            {subrange stride (dimension of array type)} \\
232 &\livelinki{chap:DWATbytestrideenumerationstridedimensionofarraytype}
233            {Enumeration stride (dimension of array type)}
234            {enumeration stride (dimension of array type)} \\
235 \DWATcallallcallsTARG{}
236 &\livelinki{chap:DWATcallallcallsofasubprogram}
237            {All tail and normal calls in a subprogram are described by call site entries}
238            {all tail and normal calls are described}
239            \index{call site!summary!all tail and normal calls are described} \\
240 \DWATcallallsourcecallsTARG{}
241 &\livelinki{chap:DWATcallallsourcecallsofasubprogram}
242            {All tail, normal and inlined calls in a subprogram are described by call site and inlined subprogram entries}
243            {all tail, normal and inlined calls are described}
244            \index{call site!summary!all tail, normal and inlined calls are described} \\
245 \DWATcallalltailcallsTARG{}
246 &\livelinki{chap:DWATcallalltailcallsofasubprogram}
247            {All tail calls in a subprogram are described by call site entries}
248            {all tail calls are described}
249            \index{call site!summary!all tail calls are described} \\
250 \DWATcallcolumnTARG{} 
251 &\livelinki{chap:DWATcallcolumncolumnpositionofinlinedsubroutinecall}
252            {Column position of inlined subroutine call}
253            {column position of inlined subroutine call} \\
254 \DWATcalldatalocationTARG{}
255 &\livelinki{chap:DWATcalldatalocationofcallparameter}
256            {Address of the value pointed to by an argument passed in a call}
257            {address of the value pointed to by an argument}
258            \index{call site!address of the value pointed to by an argument} \\
259 \DWATcalldatavalueTARG{}
260 &\livelinki{chap:DWATcalldatavalueofcallparameter}
261            {Value pointed to by an argument passed in a call}
262            {value pointed to by an argument}
263            \index{call site!value pointed to by an argument} \\
264 \DWATcallfileTARG
265 &\livelinki{chap:DWATcallfilefilecontaininginlinedsubroutinecall}
266            {File containing inlined subroutine call}
267            {file containing inlined subroutine call} \\
268 \DWATcalllineTARG{} 
269 &\livelinki{chap:DWATcalllinelinenumberofinlinedsubroutinecall}
270            {Line number of inlined subroutine call}
271            {line number of inlined subroutine call} \\
272 \DWATcallingconventionTARG{} 
273 &\livelinki{chap:DWATcallingconventionforsubprograms}
274            {Calling convention for subprograms}
275            {Calling convention!for subprograms} \\
276 &\livelinki{chap:DWATcallingconventionfortypes}
277            {Calling convention for types}
278            {Calling convention!for types} \\
279 \DWATcalloriginTARG{}
280 &\livelinki{chap:DWATcalloriginofcallsite}
281            {Subprogram called in a call}
282            {subprogram called}
283            \index{call site!subprogram called} \\
284 \DWATcallparameterTARG{}
285 &\livelinki{chap:DWATcallparameterofcallparameter}
286            {Parameter entry in a call}
287            {parameter entry}
288            \index{call site!parameter entry} \\
289 \DWATcallpcTARG{}
290 &\livelinki{chap:DWATcallpcofcallsite}
291            {Address of the call instruction in a call}
292            {address of call instruction}
293            \index{call site!address of the call instruction} \\
294 \DWATcallreturnpcTARG{}
295 &\livelinki{chap:DWATcallreturnpcofcallsite}
296            {Return address from a call}
297            {return address from a call}
298            \index{call site!return address} \\
299 \DWATcalltailcallTARG{}
300 &\livelinki{chap:DWATcalltailcallofcallsite}
301            {Call is a tail call}
302            {call is a tail call}
303            \index{call site!tail call} \\
304 \DWATcalltargetTARG{}
305 &\livelinki{chap:DWATcalltargetofcallsite}
306            {Address of called routine in a call}
307            {address of called routine}
308            \index{call site!address of called routine} \\
309 \DWATcalltargetclobberedTARG{}
310 &\livelinki{chap:DWATcalltargetclobberedofcallsite}
311            {Address of called routine, which may be clobbered, in a call}
312            {address of called routine, which may be clobbered}
313            \index{call site!address of called routine, which may be clobbered} \\
314 \DWATcallvalueTARG{}
315 &\livelinki{chap:DWATcallvalueofcallparameter}
316            {Argument value passed in a call}
317            {argument value passed}
318            \index{call site!argument value passed} \\
319 \DWATcommonreferenceTARG
320 &\livelinki{chap:commonreferencecommonblockusage}{Common block usage}{common block usage} \\
321 \DWATcompdirTARG
322 &\livelinki{chap:DWATcompdircompilationdirectory}{Compilation directory}{compilation directory} \\
323 \DWATconstvalueTARG
324 &\livelinki{chap:DWATconstvalueconstantobject}{Constant object}{constant object} \\
325 &\livelinki{chap:DWATconstvalueenumerationliteralvalue}{Enumeration literal value}{enumeration literal value} \\
326 &\livelinki{chap:DWATconstvaluetemplatevalueparameter}{Template value parameter}{template value parameter} \\
327 \DWATconstexprTARG
328 &\livelinki{chap:DWATconstexprcompiletimeconstantobject}{Compile-time constant object}{compile-time constant object} \\
329 &\livelinki{chap:DWATconstexprcompiletimeconstantfunction}{Compile-time constant function}{compile-time constant function} \\
330 \DWATcontainingtypeTARG
331 &\livelinki{chap:DWATcontainingtypecontainingtypeofpointertomembertype}{Containing type of pointer to member type}{containing type of pointer to member type} \\
332 \DWATcountTARG
333 &\livelinki{chap:DWATcountelementsofsubrangetype}{Elements of subrange type}{elements of breg subrange type} \\
334 \DWATdatabitoffsetTARG
335 &\livelinki{chap:DWATdatabitoffsetbasetypebitlocation}{Base type bit location}{base type bit location} \\
336 &\livelinki{chap:DWATdatabitoffsetdatamemberbitlocation}{Data member bit location}{data member bit location} \\
337 \DWATdatalocationTARG{} 
338 &\livelinki{chap:DWATdatalocationindirectiontoactualdata}{Indirection to actual data}{indirection to actual data} \\
339 \DWATdatamemberlocationTARG
340 &\livelinki{chap:DWATdatamemberlocationdatamemberlocation}{Data member location}{data member location} \\
341 &\livelinki{chap:DWATdatamemberlocationinheritedmemberlocation}{Inherited member location}{inherited member location} \\
342 \DWATdecimalscaleTARG
343 &\livelinki{chap:DWATdecimalscaledecimalscalefactor}{Decimal scale factor}{decimal scale factor} \\
344 \DWATdecimalsignTARG
345 &\livelinki{chap:DWATdecimalsigndecimalsignrepresentation}{Decimal sign representation}{decimal sign representation} \\
346 \DWATdeclcolumnTARG
347 &\livelinki{chap:DWATdeclcolumncolumnpositionofsourcedeclaration}{Column position of source declaration}{column position of source declaration} \\
348 \DWATdeclfileTARG
349 &\livelinki{chap:DWATdeclfilefilecontainingsourcedeclaration}{File containing source declaration}{file containing source declaration} \\
350 \DWATdecllineTARG
351 &\livelinki{chap:DWATdecllinelinenumberofsourcedeclaration}{Line number of source declaration}{line number of source declaration} \\
352 \DWATdeclarationTARG
353 &\livelinki{chap:DWATdeclarationincompletenondefiningorseparateentitydeclaration}{Incomplete, non-defining, or separate entity declaration}{incomplete, non-defining, or separate entity declaration} \\
354 \DWATdefaultedTARG
355 &\livelinki{chap:DWATdefaulteddef}{Whether a member function has been declared as default}{defaulted attribute} \\
356 \DWATdefaultvalueTARG
357 &\livelinki{chap:DWATdefaultvaluedefaultvalueofparameter}{Default value of parameter}{default value of parameter} \\
358 \DWATdeletedTARG
359 &\livelinki{chap:DWATdeleteddef}{Whether a member has been declared as deleted}{Deletion of member function} \\
360 \DWATdescriptionTARG{} 
361 &\livelinki{chap:DWATdescriptionartificialnameordescription}{Artificial name or description}{artificial name or description} \\
362 \DWATdigitcountTARG
363 &\livelinki{chap:DWATdigitcountdigitcountforpackeddecimalornumericstringtype}{Digit count for packed decimal or numeric string type}{digit count for packed decimal or numeric string type} \\
364 \DWATdiscrTARG
365 &\livelinki{chap:DWATdiscrdiscriminantofvariantpart}{Discriminant of variant part}{discriminant of variant part} \\
366 \DWATdiscrlistTARG
367 &\livelinki{chap:DWATdiscrlistlistofdiscriminantvalues}{List of discriminant values}{list of discriminant values} \\
368 \DWATdiscrvalueTARG
369 &\livelinki{chap:DWATdiscrvaluediscriminantvalue}{Discriminant value}{discriminant value} \\
370 \DWATdwoidTARG
371 &\livelinki{chap:DWATdwoidforunit}{Signature for compilation unit}{split DWARF object file!unit signature} \\
372 \DWATdwonameTARG
373 &\livelinki{chap:DWATdwonameforunit}{Name of split DWARF object file}{split DWARF object file!object file name} \\
374 \DWATelementalTARG
375 &\livelinki{chap:DWATelementalelementalpropertyofasubroutine}{Elemental property of a subroutine}{elemental property of a subroutine} \\
376 \DWATencodingTARG
377 &\livelinki{chap:DWATencodingencodingofbasetype}{Encoding of base type}{encoding of base type} \\
378 \DWATendianityTARG
379 &\livelinki{chap:DWATendianityendianityofdata}{Endianity of data}{endianity of data} \\
380 \DWATentrypcTARG
381 &\livelinki{chap:entryaddressofscope}{Entry address of a scope (compilation unit, \mbox{subprogram,} and so on)}{} \\
382 \DWATenumclassTARG
383 &\livelinki{chap:DWATenumclasstypesafeenumerationdefinition}{Type safe enumeration definition}{type safe enumeration definition}\\
384 \DWATexplicitTARG
385 &\livelinki{chap:DWATexplicitexplicitpropertyofmemberfunction}{Explicit property of member function}{explicit property of member function}\\
386 \DWATexportsymbolsTARG
387 &\livelinki{chap:DWATexportsymbolsofnamespace}{Export (inline) symbols of namespace}
388                {export symbols of a namespace} \\
389 &\livelinki{chap:DWATexportsymbolsofstructunionclass}{Export symbols of a structure, union or class}
390                {export symbols of a structure, union or class} \\
391 \DWATextensionTARG
392 &\livelinki{chap:DWATextensionpreviousnamespaceextensionororiginalnamespace}{Previous namespace extension or original namespace}{previous namespace extension or original namespace}\\
393 \DWATexternalTARG
394 &\livelinki{chap:DWATexternalexternalsubroutine}{External subroutine}{external subroutine} \\
395 &\livelinki{chap:DWATexternalexternalvariable}{External variable}{external variable} \\
396 \DWATframebaseTARG
397 &\livelinki{chap:DWATframebasesubroutineframebaseaddress}{Subroutine frame base address}{subroutine frame base address} \\
398 \DWATfriendTARG
399 &\livelinki{chap:DWATfriendfriendrelationship}{Friend relationship}{friend relationship} \\
400 \DWAThighpcTARG
401 &\livelinki{chap:DWAThighpccontiguousrangeofcodeaddresses}{Contiguous range of code addresses}{contiguous range of code addresses} \\
402 \DWATidentifiercaseTARG
403 &\livelinki{chap:DWATidentifiercaseidentifiercaserule}{Identifier case rule}{identifier case rule} \\
404 \DWATimportTARG
405 &\livelinki{chap:DWATimportimporteddeclaration}{Imported declaration}{imported declaration} \\
406 &\livelinki{chap:DWATimportimportedunit}{Imported unit}{imported unit} \\
407 &\livelinki{chap:DWATimportnamespacealias}{Namespace alias}{namespace alias} \\
408 &\livelinki{chap:DWATimportnamespaceusingdeclaration}{Namespace using declaration}{namespace using declaration} \\
409 &\livelinki{chap:DWATimportnamespaceusingdirective}{Namespace using directive}{namespace using directive} \\
410 \DWATinlineTARG
411 &\livelinki{chap:DWATinlineabstracttinstance}{Abstract instance}{abstract instance} \\
412 &\livelinki{chap:DWATinlineinlinedsubroutine}{Inlined subroutine}{inlined subroutine} \\
413 \DWATisoptionalTARG
414 &\livelinki{chap:DWATisoptionaloptionalparameter}{Optional parameter}{optional parameter} \\
415 \DWATlanguageTARG
416 &\livelinki{chap:DWATlanguageprogramminglanguage}{Programming language}{programming language} \\
417 \DWATlinkagenameTARG
418 &\livelinki{chap:DWATlinkagenameobjectfilelinkagenameofanentity}{Object file linkage name of an entity}{object file linkage name of an entity}\\
419 \DWATlocationTARG
420 &\livelinki{chap:DWATlocationdataobjectlocation}{Data object location}{data object location}\\
421 \DWATlowpcTARG
422 &\livelinki{chap:DWATlowpccodeaddressorrangeofaddresses}{Code address or range of addresses}{code address or range of addresses}\\
423 \DWATlowerboundTARG
424 &\livelinki{chap:DWATlowerboundlowerboundofsubrange}{Lower bound of subrange}{lower bound of subrange} \\
425 \DWATmacroinfoTARG
426 &\livelinki{chap:DWATmacroinfomacroinformation}
427            {Macro preprocessor information (legacy)} 
428            {macro preprocessor information (legacy)} \\
429 &          \textit{(reserved for coexistence with \DWARFVersionIV{} and earlier)} \\
430 \DWATmacrosTARG
431 &\livelinki{chap:DWATmacrosmacroinformation}
432            {Macro preprocessor information} 
433            {macro preprocessor information} \\
434 &          \textit{(\texttt{\#define}, \texttt{\#undef}, and so on in \addtoindex{C}, 
435                 \addtoindex{C++} and similar languages)} \\
436 \DWATmainsubprogramTARG
437 &\livelinki{chap:DWATmainsubprogrammainorstartingsubprogram}{Main or starting subprogram}{main or starting subprogram} \\
438 &\livelinki{chap:DWATmainsubprogramunitcontainingmainorstartingsubprogram}{Unit containing main or starting subprogram}{unit containing main or starting subprogram}\\
439 \DWATmutableTARG
440 &\livelinki{chap:DWATmutablemutablepropertyofmemberdata}{Mutable property of member data}{mutable property of member data} \\
441 \DWATnameTARG
442 &\livelinki{chap:DWATnamenameofdeclaration}{Name of declaration}{name of declaration}\\
443 &\livelinki{chap:DWATnamepathnameofcompilationsource}{Path name of compilation source}{path name of compilation source} \\
444 \DWATnamelistitemTARG
445 &\livelinki{chap:DWATnamelistitemnamelistitem}{Namelist item}{namelist item}\\
446 \DWATnoreturnTARG
447 &\livelinki{chap:DWATnoreturnofsubprogram}{\doublequote{no return} property of a subprogram}{noreturn attribute} \\
448 \DWATobjectpointerTARG
449 &\livelinki{chap:DWATobjectpointerobjectthisselfpointerofmemberfunction}{Object (\texttt{this}, \texttt{self}) pointer of member function}{object (\texttt{this}, \texttt{self}) pointer of member function}\\
450 \DWATorderingTARG
451 &\livelinki{chap:DWATorderingarrayrowcolumnordering}{Array row/column ordering} {array row/column ordering}\\
452 \DWATpicturestringTARG
453 &\livelinki{chap:DWATpicturestringpicturestringfornumericstringtype}{Picture string for numeric string type}{picture string for numeric string type} \\
454 \DWATpriorityTARG
455 &\livelinki{chap:DWATprioritymodulepriority}{Module priority}{module priority}\\
456 \DWATproducerTARG
457 &\livelinki{chap:DWATproducercompileridentification}{Compiler identification}{compiler identification}\\
458 \DWATprototypedTARG
459 &\livelinki{chap:DWATprototypedsubroutineprototype}{Subroutine prototype}{subroutine prototype}\\
460 \DWATpureTARG
461 &\livelinki{chap:DWATpurepurepropertyofasubroutine}{Pure property of a subroutine}{pure property of a subroutine} \\
462 \DWATrangesTARG
463 &\livelinki{chap:DWATrangesnoncontiguousrangeofcodeaddresses}{Non-contiguous range of code addresses}{non-contiguous range of code addresses} \\
464 \DWATrangesbaseTARG
465 &\livelinki{chap:DWATrangesbaseforrangelists}{Base offset for range lists}{ranges lists} \\
466 \DWATrankTARG
467 &\livelinki{chap:DWATrankofdynamicarray}{Dynamic number of array dimensions}{dynamic number of array dimensions} \\
468 \DWATrecursiveTARG
469 &\livelinki{chap:DWATrecursiverecursivepropertyofasubroutine}{Recursive property of a subroutine}{recursive property of a subroutine} \\
470 \DWATreferenceTARG
471 &\livelink{chap:DWATreferenceofnonstaticmember}
472           {\&-qualified non-static member function} \textit{(\addtoindex{C++})} \\
473 \DWATreturnaddrTARG
474 &\livelinki{chap:DWATreturnaddrsubroutinereturnaddresssavelocation}
475            {Subroutine return address save location}
476            {subroutine return address save location} \\
477 \DWATrvaluereferenceTARG
478 &\livelink{chap:DWATrvaluereferenceofnonstaticmember}
479           {\&\&-qualified non-static member function} \textit{(\addtoindex{C++})} \\
480
481 \DWATsegmentTARG
482 &\livelinki{chap:DWATsegmentaddressinginformation}{Addressing information}{addressing information} \\
483 \DWATsiblingTARG
484 &\livelinki{chap:DWATsiblingdebugginginformationentryrelationship}
485            {Debugging information entry relationship}
486            {debugging information entry relationship} \\
487 \DWATsmallTARG
488 &\livelinki{chap:DWATsmallscalefactorforfixedpointtype}
489            {Scale factor for fixed-point type}
490            {scale factor for fixed-point type} \\
491 \DWATsignatureTARG
492 &\livelinki{chap:DWATsignaturetypesignature}
493            {Type signature}
494            {type signature}\\
495 \DWATspecificationTARG
496 &\livelinki{chap:DWATspecificationincompletenondefiningorseparatedeclaration}
497            {Incomplete, non-defining, or separate declaration corresponding to a declaration}
498            {incomplete, non-defining, or separate declaration corresponding to a declaration} \\
499 \DWATstartscopeTARG
500 &\livelinki{chap:DWATstartscopeobjectdeclaration}{Object declaration}{object declaration}\\*
501 &\livelinki{chap:DWATstartscopetypedeclaration}{Type declaration}{type declaration}\\
502 \DWATstaticlinkTARG
503 &\livelinki{chap:DWATstaticlinklocationofuplevelframe}{Location of uplevel frame}{location of uplevel frame} \\
504 \DWATstmtlistTARG
505 &\livelinki{chap:DWATstmtlistlinenumberinformationforunit}
506            {Line number information for unit}
507            {line number information for unit}\\
508 \DWATstringlengthTARG
509 &\livelinki{chap:DWATstringlengthstringlengthofstringtype}
510            {String length of string type}
511            {string length of string type} \\
512 \DWATstringlengthbitsizeTARG
513 &\livelinki{chap:DWATstringlengthstringlengthofstringtype}{Size of string length of string type}{string length of string type!size of}
514  \\
515 \DWATstringlengthbytesizeTARG
516 &\livelinki{chap:DWATstringlengthstringlengthofstringtype}{Size of string length of string type}{string length of string type!size of}
517  \\
518 \DWATstroffsetsbaseTARG
519 &\livelinki{chap:DWATstroffsetbaseforindirectstringtable}{Base of string offsets table}{string offsets table} \\
520 \DWATthreadsscaledTARG
521 &\livelink{chap:DWATthreadsscaledupcarrayboundthreadsscalfactor}{UPC array bound THREADS scale factor}\\
522 \DWATtrampolineTARG
523 &\livelinki{chap:DWATtrampolinetargetsubroutine}{Target subroutine}{target subroutine of trampoline} \\
524 \DWATtypeTARG
525 &\livelinki{chap:DWATtypeofcallsite}{Type of call site}{type!of call site} \\
526 &\livelinki{char:DWAATtypeofstringtype}{Type of string type components}{type!of string type components} \\
527 &\livelinki{chap:DWATtypetypeofsubroutinereturn}{Type of subroutine return}{type!of subroutine return} \\
528 &\livelinki{chap:DWATtypetypeofdeclaration}{Type of declaration}{type!of declaration} \\
529 \DWATupperboundTARG
530 &\livelinki{chap:DWATupperboundupperboundofsubrange}{Upper bound of subrange}{upper bound of subrange} \\
531 \DWATuselocationTARG
532 &\livelinki{chap:DWATuselocationmemberlocationforpointertomembertype}{Member location for pointer to member type}{member location for pointer to member type} \\
533 \DWATuseUTFeightTARG\addtoindexx{use UTF8 attribute}\addtoindexx{UTF-8}
534 &\livelinki{chap:DWATuseUTF8compilationunitusesutf8strings}{Compilation unit uses UTF-8 strings}{compilation unit uses UTF-8 strings} \\
535 \DWATvariableparameterTARG
536 &\livelinki{chap:DWATvariableparameternonconstantparameterflag}{Non-constant parameter flag}{non-constant parameter flag}  \\
537 \DWATvirtualityTARG
538 &\livelinki{chap:DWATvirtualityvirtualityindication}{Virtuality indication}{virtuality indication} \\
539 &\livelinki{chap:DWATvirtualityvirtualityofbaseclass}{Virtuality of base class} {virtuality of base class} \\
540 &\livelinki{chap:DWATvirtualityvirtualityoffunction}{Virtuality of function}{virtuality of function} \\
541 \DWATvisibilityTARG
542 &\livelinki{chap:DWATvisibilityvisibilityofdeclaration}{Visibility of declaration}{visibility of declaration} \\
543 \DWATvtableelemlocationTARG
544 &\livelinki{chap:DWATvtableelemlocationvirtualfunctiontablevtableslot}{Virtual function vtable slot}{virtual function vtable slot}\\
545 \end{longtable}
546
547 \addtoindexx{address|see {\textit{also} address class}}
548 \addtoindexx{addrptr|see {\textit{also} addrptr class}}
549 \addtoindexx{block|see {\textit{also} block class}}
550 \addtoindexx{constant|see {\textit{also} constant class}}
551 \addtoindexx{exprloc|see {\textit{also} exprloc class}}
552 \addtoindexx{flag|see {\textit{also} flag class}}
553 \addtoindexx{lineptr|see {\textit{also} lineptr class}}
554 \addtoindexx{loclistptr|see {\textit{also} loclistptr class}}
555 \addtoindexx{macptr|see {\textit{also} macptr class}}
556 \addtoindexx{rangelistptr|see {\textit{also} rangelistptr class}}
557 \addtoindexx{reference|see {\textit{also} reference class}}
558 \addtoindexx{string|see {\textit{also} string class}}
559 \addtoindexx{stroffsetsptr|see {\textit{also} stroffsetsptr class}}
560
561 \addtoindexx{class of attribute value!address|see {address class}}
562 \addtoindexx{class of attribute value!addrptr|see {addrptr class}}
563 \addtoindexx{class of attribute value!block|see {block class}}
564 \addtoindexx{class of attribute value!constant|see {constant class}}
565 \addtoindexx{class of attribute value!exprloc|see {exprloc class}}
566 \addtoindexx{class of attribute value!flag|see {flag class}}
567 \addtoindexx{class of attribute value!lineptr|see {lineptr class}}
568 \addtoindexx{class of attribute value!loclistptr|see {loclistptr class}}
569 \addtoindexx{class of attribute value!macptr|see {macptr class}}
570 \addtoindexx{class of attribute value!rangelistptr|see {rangelistptr class}}
571 \addtoindexx{class of attribute value!reference|see {reference class}}
572 \addtoindexx{class of attribute value!string|see {string class}}
573 \addtoindexx{class of attribute value!stroffsetsptr|see {stroffsetsptr class}}
574
575 The permissible values
576 \addtoindexx{attribute value classes}
577 for an attribute belong to one or more classes of attribute
578 value forms.  
579 Each form class may be represented in one or more ways. 
580 For example, some attribute values consist
581 of a single piece of constant data. 
582 \doublequote{Constant data}
583 is the class of attribute value that those attributes may have. 
584 There are several representations of constant data,
585 however (one, two, four, or eight bytes, and variable length
586 data). 
587 The particular representation for any given instance
588 of an attribute is encoded along with the attribute name as
589 part of the information that guides the interpretation of a
590 debugging information entry.  
591
592 \needlines{4}
593 Attribute value forms belong
594 \addtoindexx{tag names!list of}
595 to one of the classes shown in Table \referfol{tab:classesofattributevalue}.
596
597 \begin{longtable}{l|p{11cm}}
598 \caption{Classes of attribute value}
599 \label{tab:classesofattributevalue} \\
600 \hline \bfseries Attribute Class & \bfseries General Use and Encoding \\ \hline
601 \endfirsthead
602   \bfseries Attribute Class & \bfseries General Use and Encoding \\ \hline
603 \endhead
604   \hline \emph{Continued on next page}
605 \endfoot
606   \hline
607 \endlastfoot
608
609 \hypertarget{chap:classaddress}{}
610 \livelinki{datarep:classaddress}{address}{address class}
611 &Refers to some location in the address space of the \mbox{described} program.
612 \\
613
614 \hypertarget{chap:classaddrptr}{}
615 \livelinki{datarep:classaddrptr}{addrptr}{addrptr class}
616 &Refers to a base location in the DWARF section that holds
617 a series of machine address values. Certain attributes \mbox{refer}
618 one of these addresses by indexing relative to this base
619 location.
620 \\
621
622 \hypertarget{chap:classblock}{}
623 \livelinki{datarep:classblock}{block}{block class}
624 & An arbitrary number of uninterpreted bytes of data.
625 \\
626  
627 \hypertarget{chap:classconstant}{}
628 \livelinki{datarep:classconstant}{constant}{constant class}
629 &One, two, four or eight bytes of uninterpreted data, or data
630 encoded in the variable length format known as LEB128 
631 (see Section \refersec{datarep:variablelengthdata}).
632
633 \textit{Most constant values are integers of one kind or
634 another (codes, offsets, counts, and so on); these are
635 sometimes called \doublequote{integer constants} for emphasis.}
636 \addtoindexx{integer constant}
637 \addtoindexx{constant class!integer}
638 \\
639
640 \hypertarget{chap:classexprloc}{}
641 \livelinki{datarep:classexprloc}{exprloc}{exprloc class}
642 &A DWARF expression for a value or a location in the \mbox{address} space of the described program.
643 \\
644
645 \hypertarget{chap:classflag}{}
646 \livelinki{datarep:classflag}{flag}{flag class}
647 &A small constant that indicates the presence or absence of an attribute.
648 \\
649
650 \hypertarget{chap:classlineptr}{}
651 \livelinki{datarep:classlineptr}{lineptr}{lineptr class}
652 &Refers to a location in the DWARF section that holds line number information.
653 \\
654
655 \hypertarget{chap:classloclistptr}{}
656 \livelinki{datarep:classloclistptr}{loclistptr}{loclistptr class}
657 &Refers to a location in the DWARF section that holds \mbox{location} lists, which
658 describe objects whose location can change during their lifetime.
659 \\
660
661 \hypertarget{chap:classmacptr}{}
662 \livelinki{datarep:classmacptr}{macptr}{macptr class}
663 & Refers to a location in the DWARF section that holds macro definition
664  information.
665 \\
666
667 \hypertarget{chap:classrangelistptr}{}
668 \livelinki{datarep:classrangelistptr}{rangelistptr}{rangelistptr class}
669 & Refers to a location in the DWARF section that holds non\dash contiguous address ranges.
670 \\
671
672 \hypertarget{chap:classreference}{}
673 \livelinki{datarep:classreference}{reference}{reference class}
674 & Refers to one of the debugging information
675 entries that \mbox{describe} the program.  There are four types of
676 \mbox{reference}. The first is an offset relative to the beginning
677 of the \mbox{compilation} unit in which the reference occurs and must
678 refer to an entry within that same compilation unit. The second
679 type of reference is the offset of a debugging \mbox{information}
680 entry in any compilation unit, including one different from
681 the unit containing the reference. The third type of reference
682 is an indirect reference to a 
683 \addtoindexx{type signature}
684 type definition using a 64\dash bit \mbox{signature} 
685 for that type. The fourth type of reference is a reference from within the 
686 \dotdebuginfo{} section of the executable or shared object to
687 a debugging information entry in the \dotdebuginfo{} section of 
688 a \addtoindex{supplementary object file}.
689 \\
690
691 \hypertarget{chap:classstring}{}
692 \livelinki{datarep:classstring}{string}{string class}
693 & A null\dash terminated sequence of zero or more
694 (non\dash null) bytes. Data in this class are generally
695 printable strings. Strings may be represented directly in
696 the debugging \mbox{information} entry or as an offset in a separate
697 string table.
698 \\
699
700 \hypertarget{chap:classstroffsetsptr}{}
701 \livelinki{datarep:classstroffsetsptr}{stroffsetsptr}{stroffsetsptr class}
702 &Refers to a base location in the DWARF section that holds
703 a series of offsets in the DWARF section that holds strings.
704 Certain attributes refer one of these offsets by indexing 
705 \mbox{relative} to this base location. The resulting offset is then 
706 used to index into the DWARF string section.
707 \\
708
709 \hline
710 \end{longtable}
711
712
713 \section{Relationship of Debugging Information Entries}
714 \label{chap:relationshipofdebugginginformationentries}
715 \textit{%
716 A variety of needs can be met by permitting a single
717 \addtoindexx{debugging information entry!ownership relation}
718 debugging information entry to \doublequote{own} an arbitrary number
719 of other debugging entries and by permitting the same debugging
720 information entry to be one of many owned by another debugging
721 information entry. 
722 This makes it possible, for example, to
723 describe the static \livelink{chap:lexicalblock}{block} structure 
724 within a source file,
725 to show the members of a structure, union, or class, and to
726 associate declarations with source files or source files
727 with shared objects.  
728 }
729
730
731 The ownership relation 
732 \addtoindexx{debugging information entry!ownership relation}
733 of debugging
734 information entries is achieved naturally because the debugging
735 information is represented as a tree. 
736 The nodes of the tree
737 are the debugging information entries themselves. 
738 The child
739 entries of any node are exactly those debugging information
740 entries owned by that node.  
741
742 \textit{%
743 While the ownership relation
744 of the debugging information entries is represented as a
745 tree, other relations among the entries exist, for example,
746 a reference from an entry representing a variable to another
747 entry representing the type of that variable. 
748 If all such
749 relations are taken into account, the debugging entries
750 form a graph, not a tree.  
751 }
752
753 \needlines{4}
754 The tree itself is represented
755 by flattening it in prefix order. 
756 Each debugging information
757 entry is defined either to have child entries or not to have
758 child entries (see Section \refersec{datarep:abbreviationstables}). 
759 If an entry is defined not
760 to have children, the next physically succeeding entry is a
761 sibling. 
762 If an entry is defined to have children, the next
763 physically succeeding entry is its first child. 
764 Additional
765 children are represented as siblings of the first child. 
766 A chain of sibling entries is terminated by a null entry.
767
768 In cases where a producer of debugging information feels that
769 \hypertarget{chap:DWATsiblingdebugginginformationentryrelationship}{}
770 it will be important for consumers of that information to
771 quickly scan chains of sibling entries, while ignoring the
772 children of individual siblings, that producer may attach 
773 \addtoindexx{sibling attribute}
774 a
775 \DWATsibling{} attribute 
776 to any debugging information entry. 
777 The
778 value of this attribute is a reference to the sibling entry
779 of the entry to which the attribute is attached.
780
781
782 \section{Target Addresses}
783 \label{chap:targetaddresses}
784 Many places in this document refer to the size of an
785 \addtoindexx{size of an address|see{\textit{also} \texttt{address\_size}}}
786 \addtoindexi{address}{size of an address}
787 \addtoindexx{address size|see{size of an address}}
788 \addtoindexx{address size|see{\textit{also} \texttt{address\_size}}}
789 on the target architecture (or equivalently, target machine)
790 to which a DWARF description applies. For processors which
791 can be configured to have different address sizes or different
792 instruction sets, the intent is to refer to the configuration
793 which is either the default for that processor or which is
794 specified by the object file or executable file which contains
795 the DWARF information.
796
797 \textit{%
798 For example, if a particular target architecture supports
799 both 32\dash bit and 64\dash bit addresses, the compiler will generate
800 an object file which specifies that it contains executable
801 code generated for one or the other of these 
802 \addtoindexx{size of an address}
803 address sizes. In
804 that case, the DWARF debugging information contained in this
805 object file will use the same address size.
806 }
807
808 \textit{%
809 Architectures which have multiple instruction sets are
810 supported by the isa entry in the line number information
811 (see Section \refersec{chap:statemachineregisters}).
812 }
813
814 \section{DWARF Expressions}
815 \label{chap:dwarfexpressions}
816 DWARF expressions describe how to compute a value or name a
817 location during debugging of a program. 
818 They are expressed in
819 terms of DWARF operations that operate on a stack of values.
820
821 All DWARF operations are encoded as a stream of opcodes that
822 are each followed by zero or more literal operands. 
823 The number
824 of operands is determined by the opcode.  
825
826 In addition to the
827 general operations that are defined here, operations that are
828 specific to location descriptions are defined in 
829 Section \refersec{chap:locationdescriptions}.
830
831 \subsection{General Operations}
832 \label{chap:generaloperations}
833 Each general operation represents a postfix operation on
834 a simple stack machine. 
835 Each element of the stack has a type and a value, and can represent
836 a value of any supported base type of the target machine.  Instead of
837 a base type, elements can have a special address type, 
838 which is an integral type that has the 
839 \addtoindex{size of an address} on the target machine and 
840 unspecified signedness. The value on the top of the stack after 
841 \doublequote{executing} the 
842 \addtoindex{DWARF expression}
843 is 
844 \addtoindexx{DWARF expression|see{\textit{also} location description}}
845 taken to be the result (the address of the object, the
846 value of the array bound, the length of a dynamic string,
847 the desired value itself, and so on).
848
849 \needlines{4}
850 \textit{While the abstract definition of the stack calls for variable-size entries
851 able to hold any supported base type, in practice it is expected that each
852 element of the stack can be represented as a fixed-size element large enough
853 to hold a value of any type supported by the DWARF consumer for that target,
854 plus a small identifier sufficient to encode the type of that element.
855 Support for base types other than what is required to do address arithmetic
856 is intended only for debugging of optimized code, and the completeness of the
857 DWARF consumer's support for the full set of base types is a
858 quality-of-implementation issue. If a consumer encounters a DWARF expression
859 that uses a type it does not support, it should ignore the entire expression
860 and report its inability to provide the requested information.}
861
862 \textit{It should also be noted that floating-point arithmetic is highly dependent
863 on the computational environment. It is not the intention of this expression
864 evaluation facility to produce identical results to those produced by the
865 program being debugged while executing on the target machine. Floating-point
866 computations in this stack machine will be done with precision control and
867 rounding modes as defined by the implementation.}
868
869 \needlines{4}
870 \subsubsection{Literal Encodings}
871 \label{chap:literalencodings}
872 The 
873 \addtoindexx{DWARF expression!literal encodings}
874 following operations all push a value onto the DWARF
875 stack. 
876 \addtoindexx{DWARF expression!stack operations}
877 Operations other than \DWOPconsttype{} push a value with the special 
878 address type, and if the value of a constant in one of these operations
879 is larger than can be stored in a single stack element, the
880 value is truncated to the element size and the low-order bits
881 are pushed on the stack.
882 \begin{enumerate}[1. ]
883 \itembfnl{\DWOPlitzeroTARG, \DWOPlitoneTARG, \dots, \DWOPlitthirtyoneTARG}
884 The \DWOPlitnTARG{} operations encode the unsigned literal values
885 from 0 through 31, inclusive.
886
887 \itembfnl{\DWOPaddrTARG}
888 The \DWOPaddrNAME{} operation has a single operand that encodes
889 a machine address and whose size is the \addtoindex{size of an address}
890 on the target machine.
891
892 \itembfnl{\DWOPconstoneuTARG, \DWOPconsttwouTARG, \DWOPconstfouruTARG, \DWOPconsteightuTARG}
893 \DWOPconstnxMARK{}
894 The single operand of a \DWOPconstnuNAME{} operation provides a 1,
895 2, 4, or 8\dash byte unsigned integer constant, respectively.
896
897 \itembfnl{\DWOPconstonesTARG, \DWOPconsttwosTARG, \DWOPconstfoursTARG, \DWOPconsteightsTARG}
898 The single operand of a \DWOPconstnsNAME{} operation provides a 1,
899 2, 4, or 8\dash byte signed integer constant, respectively.
900
901 \itembfnl{\DWOPconstuTARG}
902 The single operand of the \DWOPconstuNAME{} operation provides
903 an unsigned LEB128\addtoindexx{LEB128!unsigned} integer constant.
904
905 \itembfnl{\DWOPconstsTARG}
906 The single operand of the \DWOPconstsNAME{} operation provides
907 a signed LEB128\addtoindexx{LEB128!unsigned} integer constant.
908
909 \needlines{4}
910 \itembfnl{\DWOPaddrxTARG}
911 The \DWOPaddrxNAME{} operation has a single operand that
912 encodes an unsigned LEB128\addtoindexx{LEB128!unsigned} value, 
913 which is a zero-based index into the \dotdebugaddr{} section, 
914 where a machine address is stored.
915 This index is relative to the value of the 
916 \DWATaddrbase{} attribute of the associated compilation unit.
917
918 \itembfnl{\DWOPconstxTARG}
919 The \DWOPconstxNAME{} operation has a single operand that
920 encodes an unsigned LEB128\addtoindexx{LEB128!unsigned} value, 
921 which is a zero-based
922 index into the \dotdebugaddr{} section, where a constant, the
923 size of a machine address, is stored.
924 This index is relative to the value of the 
925 \DWATaddrbase{} attribute of the associated compilation unit.
926
927 \needlines{3}
928 \textit{The \DWOPconstxNAME{} operation is provided for constants that
929 require link-time relocation but should not be
930 interpreted by the consumer as a relocatable address
931 (for example, offsets to thread-local storage).}
932
933 \itembfnl{\DWOPconsttypeTARG}
934 The \DWOPconsttypeNAME{} operation takes three operands. The first operand 
935 is an unsigned LEB128 integer that represents the offset of a debugging
936 information entry in the current compilation unit, which must be a
937 \DWTAGbasetype{} entry that provides the type of the constant provided. The
938 second operand is 1-byte unsigned integer that specifies the size of the
939 constant value, which may not be larger than the size of the largest supported
940 base type of the target machine. The third operand is a block of specified 
941 size that is to be interpreted as a value of the referenced type.
942
943 \textit{While the size of the constant could be inferred from the base type
944 definition, it is encoded explicitly into the expression so that the
945 expression can be parsed easily without reference to the \dotdebuginfo{}
946 section.}
947
948 \end{enumerate}
949
950 \needlines{10}
951 \subsubsection{Register Values}
952 \label{chap:registervalues}
953 The following operations push a value onto the stack that is either the
954 contents of a register or the result of adding the contents of a register
955 to a given signed offset. 
956 \addtoindexx{DWARF expression!register based addressing}
957 \DWOPregvaltype{} pushes the contents
958 of the register together with the given base type, while the other operations
959 push the result of adding the contents of a register to a given
960 signed offset together with the special address type.
961
962 \needlines{4}
963 \begin{enumerate}[1. ]
964 \itembfnl{\DWOPfbregTARG}
965 The \DWOPfbregNAME{} operation provides a 
966 signed LEB128\addtoindexx{LEB128!signed} offset
967 from the address specified by the location description in the
968 \DWATframebase{} attribute of the current function. (This
969 is typically a \doublequote{stack pointer} register plus or minus
970 some offset. On more sophisticated systems it might be a
971 location list that adjusts the offset according to changes
972 in the stack pointer as the PC changes.)
973
974 \itembfnl{\DWOPbregzeroTARG, \DWOPbregoneTARG, \dots, \DWOPbregthirtyoneTARG}
975 The single operand of the \DWOPbregnTARG{} 
976 operations provides
977 a signed LEB128\addtoindexx{LEB128!signed} offset from
978 the specified register.
979
980 \itembfnl{\DWOPbregxTARG}
981 The \DWOPbregxNAME{} operation has two operands: a register
982 which is specified by an unsigned LEB128\addtoindexx{LEB128!unsigned}
983 number, followed by a signed LEB128\addtoindexx{LEB128!signed} offset.
984
985 \itembfnl{\DWOPregvaltypeTARG}
986 The \DWOPregvaltypeNAME{} operation takes two operands. The first 
987 operand is an unsigned LEB128\addtoindexx{LEB128!unsigned} number, 
988 which identifies a register whose contents is to
989 be pushed onto the stack. The second operand is an 
990 unsigned LEB128\addtoindexx{LEB128!unsigned} number
991 that represents the offset of a debugging information entry in the current
992 compilation unit, which must be a \DWTAGbasetype{} entry that provides the
993 type of the value contained in the specified register.
994
995 \end{enumerate}
996
997 \needlines{6}
998 \subsubsection{Stack Operations}
999 \label{chap:stackoperations}
1000 The following 
1001 \addtoindexx{DWARF expression!stack operations}
1002 operations manipulate the DWARF stack. Operations
1003 that index the stack assume that the top of the stack (most
1004 recently added entry) has index 0.
1005
1006 The \DWOPdup{}, \DWOPdrop{}, \DWOPpick{}, \DWOPover{}, \DWOPswap{}
1007 and \DWOProt{} operations manipulate the elements of the stack as pairs
1008 consisting of the value together with its type identifier. 
1009 The \DWOPderef{}, \DWOPderefsize{}, \DWOPxderef{}, \DWOPxderefsize{} 
1010 and \DWOPformtlsaddress{}
1011 operations require the popped values to have an integral type, either the
1012 special address type or some other integral base type, and push a 
1013 value with the special address type.  
1014 \DWOPdereftype{} and \DWOPxdereftype{} operations have the
1015 same requirement on the popped values, but push a value together 
1016 with the same type as the popped values.
1017 All other operations push a value together with the special address type.
1018
1019 \begin{enumerate}[1. ]
1020 \itembfnl{\DWOPdupTARG}
1021 The \DWOPdupNAME{} operation duplicates the value (including its 
1022 type identifier) at the top of the stack.
1023
1024 \itembfnl{\DWOPdropTARG}
1025 The \DWOPdropNAME{} operation pops the value (including its type 
1026 identifier) at the top of the stack.
1027
1028 \itembfnl{\DWOPpickTARG}
1029 The single operand of the \DWOPpickNAME{} operation provides a
1030 1\dash byte index. A copy of the stack entry (including its 
1031 type identifier) with the specified
1032 index (0 through 255, inclusive) is pushed onto the stack.
1033
1034 \itembfnl{\DWOPoverTARG}
1035 The \DWOPoverNAME{} operation duplicates the entry currently second
1036 in the stack at the top of the stack. 
1037 This is equivalent to a
1038 \DWOPpick{} operation, with index 1.  
1039
1040 \itembfnl{\DWOPswapTARG}
1041 The \DWOPswapNAME{} operation swaps the top two stack entries. 
1042 The entry at the top of the stack (including its type identifier)
1043 becomes the second stack entry, and the second entry (including 
1044 its type identifier) becomes the top of the stack.
1045
1046 \itembfnl{\DWOProtTARG}
1047 The \DWOProtNAME{} operation rotates the first three stack
1048 entries. The entry at the top of the stack (including its 
1049 type identifier) becomes the third stack entry, the second 
1050 entry (including its type identifier) becomes the top of 
1051 the stack, and the third entry (including its type identifier)
1052 becomes the second entry.
1053
1054 \itembfnl{\DWOPderefTARG}
1055 The \DWOPderefNAME{} operation pops the top stack entry and 
1056 treats it as an address. The popped value must have an integral type.
1057 The value retrieved from that address is pushed, together with the
1058 special address type identifier. 
1059 The size of the data retrieved from the 
1060 \addtoindexi{dereferenced}{address!dereference operator}
1061 address is the \addtoindex{size of an address} on the target machine.
1062
1063 \needlines{4}
1064 \itembfnl{\DWOPderefsizeTARG}
1065 The \DWOPderefsizeNAME{} operation behaves like the 
1066 \DWOPderef{}
1067 operation: it pops the top stack entry and treats it as an
1068 address. The popped value must have an integral type.
1069 The value retrieved from that address is pushed, together with the
1070 special address type identifier. In
1071 the \DWOPderefsizeNAME{} operation, however, the size in bytes
1072 of the data retrieved from the dereferenced address is
1073 specified by the single operand. This operand is a 1\dash byte
1074 unsigned integral constant whose value may not be larger
1075 than the \addtoindex{size of an address} on the target machine. The data
1076 retrieved is zero extended to the size of an address on the
1077 target machine before being pushed onto the expression stack.
1078
1079 \itembfnl{\DWOPdereftypeTARG}
1080 The \DWOPdereftypeNAME{} operation behaves like the \DWOPderefsize{} operation:
1081 it pops the top stack entry and treats it as an address. 
1082 The popped value must have an integral type.
1083 The value retrieved from that address is pushed together with a type identifier. 
1084 In the \DWOPdereftypeNAME{} operation, the size in
1085 bytes of the data retrieved from the dereferenced address is specified by
1086 the first operand. This operand is a 1-byte unsigned integral constant whose
1087 value may not be larger than the size of the largest supported base type on
1088 the target machine. The second operand is an unsigned LEB128 integer that
1089 represents the offset of a debugging information entry in the current
1090 compilation unit, which must be a \DWTAGbasetype{} entry that provides the
1091 type of the data pushed.
1092
1093 \needlines{7}
1094 \itembfnl{\DWOPxderefTARG}
1095 The \DWOPxderefNAME{} operation provides an extended dereference
1096 mechanism. The entry at the top of the stack is treated as an
1097 address. The second stack entry is treated as an \doublequote{address
1098 space identifier} for those architectures that support
1099 \addtoindexi{multiple}{address space!multiple}
1100 address spaces. 
1101 Both of these entries must have integral type identifiers.
1102 The top two stack elements are popped,
1103 and a data item is retrieved through an implementation-defined
1104 address calculation and pushed as the new stack top together with the
1105 special address type identifier.
1106 The size of the data retrieved from the 
1107 \addtoindexi{dereferenced}{address!dereference operator}
1108 address is the
1109 \addtoindex{size of an address} on the target machine.
1110
1111 \itembfnl{\DWOPxderefsizeTARG}
1112 The \DWOPxderefsizeNAME{} operation behaves like the
1113 \DWOPxderef{} operation. The entry at the top of the stack is
1114 treated as an address. The second stack entry is treated as
1115 an \doublequote{address space identifier} for those architectures
1116 that support 
1117 \addtoindexi{multiple}{address space!multiple}
1118 address spaces. 
1119 Both of these entries must have integral type identifiers.
1120 The top two stack
1121 elements are popped, and a data item is retrieved through an
1122 implementation\dash defined address calculation and pushed as the
1123 new stack top. In the \DWOPxderefsizeNAME{} operation, however,
1124 the size in bytes of the data retrieved from the 
1125 \addtoindexi{dereferenced}{address!dereference operator}
1126 address is specified by the single operand. This operand is a
1127 1\dash byte unsigned integral constant whose value may not be larger
1128 than the \addtoindex{size of an address} on the target machine. The data
1129 retrieved is zero extended to the \addtoindex{size of an address} on the
1130 target machine before being pushed onto the expression stack together
1131 with the special address type identifier.
1132
1133 \itembfnl{\DWOPxdereftypeTARG}
1134 The \DWOPxdereftypeNAME{} operation behaves like the \DWOPxderefsize{}
1135 operation: it pops the top two stack entries, treats them as an address and
1136 an address space identifier, and pushes the value retrieved. In the
1137 \DWOPxdereftypeNAME{} operation, the size in bytes of the data retrieved from
1138 the dereferenced address is specified by the first operand. This operand is
1139 a 1-byte unsigned integral constant whose value may not be larger than the
1140 size of the largest supported base type on the target machine. The second
1141 operand is an unsigned LEB128 integer that represents the offset of a
1142 debugging information entry in the current compilation unit, which must be a
1143 \DWTAGbasetype{} entry that provides the type of the data pushed.
1144
1145 \needlines{6}
1146 \itembfnl{\DWOPpushobjectaddressTARG}
1147 The \DWOPpushobjectaddressNAME{}
1148 operation pushes the address
1149 of the object currently being evaluated as part of evaluation
1150 of a user presented expression. This object may correspond
1151 to an independent variable described by its own debugging
1152 information entry or it may be a component of an array,
1153 structure, or class whose address has been dynamically
1154 determined by an earlier step during user expression
1155 evaluation.
1156
1157 \textit{This operator provides explicit functionality
1158 (especially for arrays involving descriptors) that is analogous
1159 to the implicit push of the base 
1160 \addtoindexi{address}{address!implicit push of base}
1161 of a structure prior to evaluation of a 
1162 \DWATdatamemberlocation{} 
1163 to access a data member of a structure. For an example, see 
1164 Appendix \refersec{app:aggregateexamples}.}
1165
1166 \needlines{4}
1167 \itembfnl{\DWOPformtlsaddressTARG}
1168 The \DWOPformtlsaddressNAME{} 
1169 operation pops a value from the stack, which must have an 
1170 integral type identifier, translates this
1171 value into an address in the 
1172 \addtoindexx{thread-local storage}
1173 thread\dash local storage for a thread, and pushes the address 
1174 onto the stack together with the special address type identifier. 
1175 The meaning of the value on the top of the stack prior to this 
1176 operation is defined by the run-time environment.  If the run-time 
1177 environment supports multiple thread\dash local storage 
1178 \nolink{blocks} for a single thread, then the \nolink{block} 
1179 corresponding to the executable or shared 
1180 library containing this DWARF expression is used.
1181    
1182 \textit{Some implementations of 
1183 \addtoindex{C}, \addtoindex{C++}, \addtoindex{Fortran}, and other 
1184 languages, support a 
1185 thread-local storage class. Variables with this storage class
1186 have distinct values and addresses in distinct threads, much
1187 as automatic variables have distinct values and addresses in
1188 each function invocation. Typically, there is a single \nolink{block}
1189 of storage containing all thread\dash local variables declared in
1190 the main executable, and a separate \nolink{block} for the variables
1191 declared in each shared library. Each 
1192 thread\dash local variable can then be accessed in its block using an
1193 identifier. This identifier is typically an offset into the block and 
1194 pushed onto the DWARF stack by one of the 
1195 \DWOPconstnx{} operations prior to the
1196 \DWOPformtlsaddress{} operation. 
1197 Computing the address of
1198 the appropriate \nolink{block} can be complex (in some cases, the
1199 compiler emits a function call to do it), and difficult
1200 to describe using ordinary DWARF location descriptions.
1201 Instead of    forcing complex thread-local storage calculations into 
1202 the DWARF expressions, the \DWOPformtlsaddress{} allows the consumer 
1203 to perform the computation based on the run-time environment.}
1204
1205 \needlines{4}
1206 \itembfnl{\DWOPcallframecfaTARG}
1207 The \DWOPcallframecfaNAME{} 
1208 operation pushes the value of the
1209 CFA, obtained from the Call Frame Information 
1210 (see Section \refersec{chap:callframeinformation}).
1211
1212 \textit{Although the value of \DWATframebase{}
1213 can be computed using other DWARF expression operators,
1214 in some cases this would require an extensive location list
1215 because the values of the registers used in computing the
1216 CFA change during a subroutine. If the 
1217 Call Frame Information 
1218 is present, then it already encodes such changes, and it is
1219 space efficient to reference that.}
1220 \end{enumerate}
1221
1222 \subsubsection{Arithmetic and Logical Operations} 
1223 \addtoindexx{DWARF expression!arithmetic operations}
1224 \addtoindexx{DWARF expression!logical operations}
1225 The following provide arithmetic and logical operations.  If an operation
1226 pops two values from the stack, both values must have the same type,
1227 either the same base type or both the special address type.
1228 The result of the operation which is pushed back has the same type
1229 as the type of the operands.  
1230
1231 If the type of the operands is the special
1232 address type, except as otherwise specified, the arithmetic operations
1233 perform addressing arithmetic, that is, unsigned arithmetic that is performed
1234 modulo one plus the largest representable address (for example, 0x100000000
1235 when the \addtoindex{size of an address} is 32 bits). 
1236
1237 Operations other than \DWOPabs{},
1238 \DWOPdiv{}, \DWOPminus{}, \DWOPmul{}, \DWOPneg{} and \DWOPplus{} require integral
1239 types of the operand (either integral base type or the special address
1240 type).  Operations do not cause an exception on overflow.
1241
1242
1243 \needlines{4}
1244 \begin{enumerate}[1. ]
1245 \itembfnl{\DWOPabsTARG}
1246 The \DWOPabsTARG{} operation pops the top stack entry, interprets
1247 it as a signed value and pushes its absolute value. If the
1248 absolute value cannot be represented, the result is undefined.
1249
1250 \needlines{4}
1251 \itembfnl{\DWOPandTARG}
1252 The \DWOPandTARG{} operation pops the top two stack values, performs
1253 a bitwise and operation on the two, and pushes the result.
1254
1255 \itembfnl{\DWOPdivTARG}
1256 The \DWOPdivTARG{} operation pops the top two stack values, divides the former second entry by
1257 the former top of the stack using signed division, and pushes the result.
1258
1259 \itembfnl{\DWOPminusTARG}
1260 The \DWOPminusTARG{} operation pops the top two stack values, subtracts the former top of the
1261 stack from the former second entry, and pushes the result.
1262
1263 \itembfnl{\DWOPmodTARG}
1264 The \DWOPmodTARG{} operation pops the top two stack values and pushes the result of the
1265 calculation: former second stack entry modulo the former top of the stack.
1266
1267 \needlines{4}
1268 \itembfnl{\DWOPmulTARG}
1269 The \DWOPmulTARG{} operation pops the top two stack entries, multiplies them together, and
1270 pushes the result.
1271
1272 \itembfnl{\DWOPnegTARG}
1273 The \DWOPnegTARG{} operation pops the top stack entry, interprets
1274 it as a signed value and pushes its negation. If the negation
1275 cannot be represented, the result is undefined.
1276
1277 \itembfnl{\DWOPnotTARG}
1278 The \DWOPnotTARG{} operation pops the top stack entry, and pushes
1279 its bitwise complement.
1280
1281 \itembfnl{\DWOPorTARG}
1282 The \DWOPorTARG{} operation pops the top two stack entries, performs
1283 a bitwise or operation on the two, and pushes the result.
1284
1285 \itembfnl{\DWOPplusTARG}
1286 The \DWOPplusTARG{} operation pops the top two stack entries,
1287 adds them together, and pushes the result.
1288
1289 \needlines{6}
1290 \itembfnl{\DWOPplusuconstTARG}
1291 The \DWOPplusuconstTARG{} operation pops the top stack entry,
1292 adds it to the unsigned LEB128\addtoindexx{LEB128!unsigned}
1293 constant operand and pushes the result.
1294
1295 \textit{This operation is supplied specifically to be
1296 able to encode more field offsets in two bytes than can be
1297 done with
1298 \doublequote{\DWOPlitn~\DWOPplus.}}
1299
1300 \needlines{3}
1301 \itembfnl{\DWOPshlTARG}
1302 The \DWOPshlTARG{} operation pops the top two stack entries,
1303 shifts the former second entry left (filling with zero bits)
1304 by the number of bits specified by the former top of the stack,
1305 and pushes the result.
1306
1307 \itembfnl{\DWOPshrTARG}
1308 The \DWOPshrTARG{} operation pops the top two stack entries,
1309 shifts the former second entry right logically (filling with
1310 zero bits) by the number of bits specified by the former top
1311 of the stack, and pushes the result.
1312
1313 \needlines{3}
1314 \itembfnl{\DWOPshraTARG}
1315 The \DWOPshraTARG{} operation pops the top two stack entries,
1316 shifts the former second entry right arithmetically (divide
1317 the magnitude by 2, keep the same sign for the result) by
1318 the number of bits specified by the former top of the stack,
1319 and pushes the result.
1320
1321 \itembfnl{\DWOPxorTARG}
1322 The \DWOPxorTARG{} operation pops the top two stack entries,
1323 performs a bitwise exclusive\dash or operation on the two, and
1324 pushes the result.
1325
1326 \end{enumerate}
1327
1328 \subsubsection{Control Flow Operations}
1329 \label{chap:controlflowoperations}
1330 The 
1331 \addtoindexx{DWARF expression!control flow operations}
1332 following operations provide simple control of the flow of a DWARF expression.
1333 \begin{enumerate}[1. ]
1334 \itembfnl{\DWOPleTARG, \DWOPgeTARG, \DWOPeqTARG, \DWOPltTARG, \DWOPgtTARG, \DWOPneTARG}
1335 The six relational operators each:
1336 \begin{itemize}
1337 \item pop the top two stack values, which should both have the same type,
1338 either the same base type or both the special address type, 
1339
1340 \item compare the operands:
1341 \linebreak
1342 \textless~former second entry~\textgreater  \textless~relational operator~\textgreater \textless~former top entry~\textgreater
1343
1344 \item push the constant value 1 onto the stack 
1345 if the result of the operation is true or the
1346 constant value 0 if the result of the operation is false.
1347 The pushed value has the special address type.
1348 \end{itemize}
1349
1350 If the operands have the special address type, the comparisons  
1351 are performed as signed operations.
1352 The six operators are \DWOPleNAME{} (less than or equal to), \DWOPgeNAME{}
1353 (greater than or equal to), \DWOPeqNAME{} (equal to), \DWOPltNAME{} (less
1354 than), \DWOPgtNAME{} (greater than) and \DWOPneNAME{} (not equal to).
1355
1356 \needlines{6}
1357 \itembfnl{\DWOPskipTARG}
1358 \DWOPskipNAME{} is an unconditional branch. Its single operand
1359 is a 2\dash byte signed integer constant. The 2\dash byte constant is
1360 the number of bytes of the DWARF expression to skip forward
1361 or backward from the current operation, beginning after the
1362 2\dash byte constant.
1363
1364 \itembfnl{\DWOPbraTARG}
1365 \DWOPbraNAME{} is a conditional branch. Its single operand is a
1366 2\dash byte signed integer constant.  This operation pops the
1367 top of stack. If the value popped is not the constant 0,
1368 the 2\dash byte constant operand is the number of bytes of the
1369 DWARF expression to skip forward or backward from the current
1370 operation, beginning after the 2\dash byte constant.
1371
1372 % The following item does not correctly hyphenate leading
1373 % to an overfull hbox and a visible artifact. 
1374 % So we use \- to suggest hyphenation in this rare situation.
1375 \itembfnl{\DWOPcalltwoTARG, \DWOPcallfourTARG, \DWOPcallrefTARG}
1376 \DWOPcalltwoNAME, 
1377 \DWOPcallfourNAME, 
1378 and \DWOPcallrefNAME{} perform
1379 DWARF procedure calls during evaluation of a DWARF expression or
1380 location description. 
1381 For \DWOPcalltwoNAME{} and \DWOPcallfourNAME{}, 
1382 the operand is the 2\dash~ or 4\dash byte unsigned offset, respectively,
1383 of a debugging information entry in the current compilation
1384 unit. The \DWOPcallrefNAME{} operator has a single operand. In the
1385 \thirtytwobitdwarfformat,
1386 the operand is a 4\dash byte unsigned value;
1387 in the \sixtyfourbitdwarfformat, it is an 8\dash byte unsigned value
1388 (see Section \referfol{datarep:32bitand64bitdwarfformats}). 
1389 The operand is used as the offset of a
1390 debugging information entry in a 
1391 \dotdebuginfo{}
1392 section which may be contained in a shared object or executable
1393 other than that containing the operator. For references from
1394 one shared object or executable to another, the relocation
1395 must be performed by the consumer.  
1396
1397 \textit{Operand interpretation of
1398 \DWOPcalltwo, \DWOPcallfour{} and \DWOPcallref{} is exactly like
1399 that for \DWFORMreftwo, \DWFORMreffour{} and \DWFORMrefaddr,
1400 respectively  
1401 (see Section  \refersec{datarep:attributeencodings}).  
1402 }
1403
1404 These operations transfer
1405 control of DWARF expression evaluation to 
1406 \addtoindexx{location attribute}
1407 the 
1408 \DWATlocation{}
1409 attribute of the referenced debugging information entry. If
1410 there is no such attribute, then there is no effect. Execution
1411 of the DWARF expression of 
1412 \addtoindexx{location attribute}
1413
1414 \DWATlocation{} attribute may add
1415 to and/or remove from values on the stack. Execution returns
1416 to the point following the call when the end of the attribute
1417 is reached. Values on the stack at the time of the call may be
1418 used as parameters by the called expression and values left on
1419 the stack by the called expression may be used as return values
1420 by prior agreement between the calling and called expressions.
1421 \end{enumerate}
1422
1423 \subsubsection{Type Conversions}
1424 \label{chap:typeconversions}
1425 The following operations provides for explicit type conversion.
1426
1427 \begin{enumerate}[1. ]
1428 \itembfnl{\DWOPconvertTARG}
1429 The \DWOPconvertNAME{} operation pops the top stack entry, converts it to a
1430 different type, then pushes the result. It takes one operand, which is an
1431 unsigned LEB128 integer that represents the offset of a debugging
1432 information entry in the current compilation unit, or value 0 which
1433 represents the special address type. If the operand is non-zero, the
1434 referenced entry must be a \DWTAGbasetype{} entry that provides the type
1435 to which the value is converted.
1436
1437 \itembfnl{\DWOPreinterpretTARG}
1438 The \DWOPreinterpretNAME{} operation pops the top stack entry, reinterprets
1439 the bits in its value as a value of a different type, then pushes the
1440 result. It takes one operand, which is an unsigned LEB128 integer that
1441 represents the offset of a debugging information entry in the current
1442 compilation unit, or value 0 which represents the special address type.
1443 If the operand is non-zero, the referenced entry must be a
1444 \DWTAGbasetype{} entry that provides the type to which the value is converted.
1445 The type of the operand and result type should have the same size in bits.
1446
1447 \textit{The semantics of the reinterpretation of a value is as if in 
1448 \addtoindex{C} or \addtoindex{C++}
1449 there are two variables, one with the type of the operand, into which
1450 the popped value is stored, then copied using \texttt{memcpy} into the other variable
1451 with the type of the result and the pushed result value is the value of the
1452 other variable after \texttt{memcpy}.}
1453
1454 \end{enumerate}
1455
1456 \needlines{7}
1457 \subsubsection{Special Operations}
1458 \label{chap:specialoperations}
1459 There 
1460 \addtoindexx{DWARF expression!special operations}
1461 are these special operations currently defined:
1462 \begin{enumerate}[1. ]
1463 \itembfnl{\DWOPnopNAME}
1464 The \DWOPnopTARG{} operation is a place holder. It has no effect
1465 on the location stack or any of its values.
1466
1467 \itembfnl{\DWOPentryvalueNAME}
1468 The \DWOPentryvalueTARG{} operation pushes a value that had a known location
1469 upon entering the current subprogram.  It has two operands: an 
1470 unsigned LEB128\addtoindexx{LEB128!unsigned} length, followed by 
1471 a block containing a DWARF expression or
1472 a simple register location description.  The length operand specifies the length
1473 in bytes of the block.  If the block contains a register location
1474 description, \DWOPentryvalueNAME{} pushes the value that register had upon
1475 entering the current subprogram.  If the block contains a DWARF expression,
1476 the DWARF expression is evaluated as if it has been evaluated upon entering
1477 the current subprogram.  The DWARF expression should not assume any values
1478 being present on the DWARF stack initially and should result in exactly one
1479 value being pushed on the DWARF stack when completed.  That value is the value
1480 being pushed by the \DWOPentryvalueNAME{} operation.  
1481
1482 \DWOPpushobjectaddress{} is not meaningful inside of this DWARF operation.
1483
1484 \textit{The \DWOPentryvalueNAME{} operation can be used by consumers if they are able
1485 to find the call site in the caller function, can unwind to it, and the corresponding
1486 \DWTAGcallsiteparameter{} entry has \DWATcallvalue{} or
1487 \DWATcalldatavalue{} attributes that can be evaluated to find out the
1488 value a function parameter had on the first instruction in the function.
1489 Non-interactive consumers which know what variables will need to be
1490 inspected ahead of running the debugged program could put breakpoints
1491 on the first instruction in functions where there is no other way to find(see 
1492 some variable's value, other than evaluating the \DWOPentryvalueNAME{} 
1493 operation.  The consumer can collect the value of registers or 
1494 memory referenced in
1495 \DWOPentryvalueNAME{} operations, then continue to breakpoints where the values
1496 of variables or parameters need to be inspected and there use the remembered
1497 register or memory values during \DWOPentryvalueNAME{} evaluation.
1498 }
1499
1500 \end{enumerate}
1501
1502 \subsection{Example Stack Operations}
1503 \textit {The 
1504 \addtoindexx{DWARF expression!examples}
1505 stack operations defined in 
1506 Section \refersec{chap:stackoperations}.
1507 are fairly conventional, but the following
1508 examples illustrate their behavior graphically.}
1509
1510 \begin{longtable}[c]{rrcrr} 
1511 \multicolumn{2}{c}{Before} & Operation & \multicolumn{2}{c}{After} \\
1512 \hline
1513 \endhead
1514 \endfoot
1515 0& 17& \DWOPdup{} &0 &17 \\*
1516 1&   29& &  1 & 17 \\*
1517 2& 1000 & & 2 & 29\\*
1518 & & &         3&1000\\
1519
1520 & & & & \\
1521 0 & 17 & \DWOPdrop{} & 0 & 29 \\*
1522 1 &29  &            & 1 & 1000 \\*
1523 2 &1000& & &          \\
1524
1525 & & & & \\
1526 0 & 17 & \DWOPpick, 2 & 0 & 1000 \\*
1527 1 & 29 & & 1&17 \\*
1528 2 &1000& &2&29 \\*
1529   &    & &3&1000 \\
1530
1531 & & & & \\
1532 0&17& \DWOPover&0&29 \\*
1533 1&29& &  1&17 \\*
1534 2&1000 & & 2&29\\*
1535  &     & & 3&1000 \\
1536
1537 & & & & \\
1538 0&17& \DWOPswap{} &0&29 \\*
1539 1&29& &  1&17 \\*
1540 2&1000 & & 2&1000 \\
1541
1542 & & & & \\
1543 0&17&\DWOProt{} & 0 &29 \\*
1544 1&29 & & 1 & 1000 \\*
1545 2& 1000 & &  2 & 17 \\
1546 \end{longtable}
1547
1548 \section{Location Descriptions}
1549 \label{chap:locationdescriptions}
1550 \textit{Debugging information 
1551 \addtoindexx{location description}
1552 must 
1553 \addtoindexx{location description|see{\textit{also} DWARF expression}}
1554 provide consumers a way to find
1555 the location of program variables, determine the bounds
1556 of dynamic arrays and strings, and possibly to find the
1557 base address of a subroutine\textquoteright s stack frame or the return
1558 address of a subroutine. Furthermore, to meet the needs of
1559 recent computer architectures and optimization techniques,
1560 debugging information must be able to describe the location of
1561 an object whose location changes over the object\textquoteright s lifetime.}
1562
1563 Information about the location of program objects is provided
1564 by location descriptions. Location descriptions can be either
1565 of two forms:
1566 \begin{enumerate}[1. ]
1567 \item \textit{Single location descriptions}, 
1568 which 
1569 \addtoindexx{location description!single}
1570 are 
1571 \addtoindexx{single location description}
1572 a language independent representation of
1573 addressing rules of arbitrary complexity built from 
1574 DWARF expressions (See Section \refersec{chap:dwarfexpressions}) 
1575 and/or other
1576 DWARF operations specific to describing locations. They are
1577 sufficient for describing the location of any object as long
1578 as its lifetime is either static or the same as the 
1579 \livelink{chap:lexicalblock}{lexical block} that owns it, 
1580 and it does not move during its lifetime.
1581
1582 Single location descriptions are of two kinds:
1583 \begin{enumerate}[a) ]
1584 \item Simple location descriptions, which describe the location
1585 \addtoindexx{location description!simple}
1586 of one contiguous piece (usually all) of an object. A simple
1587 location description may describe a location in addressable
1588 memory, or in a register, or the lack of a location (with or
1589 without a known value).
1590
1591 \item  Composite location descriptions, which describe an
1592 \addtoindexx{location description!composite}
1593 object in terms of pieces each of which may be contained in
1594 part of a register or stored in a memory location unrelated
1595 to other pieces.
1596
1597 \end{enumerate}
1598
1599 \needlines{3}
1600 \item \textit{Location lists}, which are used to 
1601 \addtoindexx{location list}
1602 describe
1603 \addtoindexx{location description!use in location list}
1604 objects that have a limited lifetime or change their location
1605 during their lifetime. Location lists are described in
1606 Section \refersec{chap:locationlists} below.
1607
1608 \end{enumerate}
1609
1610 Location descriptions are distinguished in a context sensitive
1611 manner. As the value of an attribute, a location description
1612 is encoded using 
1613 \addtoindexx{exprloc class}
1614 class \livelink{chap:classexprloc}{exprloc}  
1615 and a location list is encoded
1616 using class \livelink{chap:classloclistptr}{loclistptr}
1617 (which 
1618 \addtoindex{loclistptr}
1619 serves as an offset into a
1620 separate 
1621 \addtoindexx{location list}
1622 location list table).
1623
1624
1625 \subsection{Single Location Descriptions}
1626 A single location description is either:
1627 \begin{enumerate}[1. ]
1628 \item A simple location description, representing an object
1629 \addtoindexx{location description!simple}
1630 which 
1631 \addtoindexx{simple location description}
1632 exists in one contiguous piece at the given location, or 
1633 \item A composite location description consisting of one or more
1634 \addtoindexx{location description!composite}
1635 simple location descriptions, each of which is followed by
1636 one composition operation. Each simple location description
1637 describes the location of one piece of the object; each
1638 composition operation describes which part of the object is
1639 located there. Each simple location description that is a
1640 DWARF expression is evaluated independently of any others
1641 (as though on its own separate stack, if any). 
1642 \end{enumerate}
1643
1644
1645
1646 \subsubsection{Simple Location Descriptions}
1647
1648 \addtoindexx{location description!simple}
1649 simple location description consists of one 
1650 contiguous piece or all of an object or value.
1651
1652
1653 \subsubsubsection{Memory Location Descriptions}
1654
1655 \addtoindexx{location description!memory}
1656 memory location description 
1657 \addtoindexx{memory location description}
1658 consists of a non\dash empty DWARF
1659 expression (see 
1660 Section \refersec{chap:dwarfexpressions}
1661 ), whose value is the address of
1662 a piece or all of an object or other entity in memory.
1663
1664 \subsubsubsection{Register Location Descriptions}
1665 \label{chap:registerlocationdescriptions}
1666 A register location description consists of a register name
1667 operation, which represents a piece or all of an object
1668 located in a given register.
1669
1670 \textit{Register location descriptions describe an object
1671 (or a piece of an object) that resides in a register, while
1672 the opcodes listed in 
1673 Section \refersec{chap:registervalues}
1674 are used to describe an object (or a piece of
1675 an object) that is located in memory at an address that is
1676 contained in a register (possibly offset by some constant). A
1677 register location description must stand alone as the entire
1678 description of an object or a piece of an object.
1679 }
1680
1681 The following DWARF operations can be used to name a register.
1682
1683
1684 \textit{Note that the register number represents a DWARF specific
1685 mapping of numbers onto the actual registers of a given
1686 architecture. The mapping should be chosen to gain optimal
1687 density and should be shared by all users of a given
1688 architecture. It is recommended that this mapping be defined
1689 by the ABI authoring committee for each architecture.
1690 }
1691 \begin{enumerate}[1. ]
1692 \itembfnl{\DWOPregzeroTARG, \DWOPregoneTARG, ..., \DWOPregthirtyoneTARG}
1693 The \DWOPregnTARG{} operations encode the names of up to 32
1694 registers, numbered from 0 through 31, inclusive. The object
1695 addressed is in register \textit{n}.
1696
1697 \needlines{4}
1698 \itembfnl{\DWOPregxTARG}
1699 The \DWOPregxTARG{} operation has a single 
1700 unsigned LEB128\addtoindexx{LEB128!unsigned} literal
1701 operand that encodes the name of a register.  
1702
1703 \end{enumerate}
1704
1705 \textit{These operations name a register location. To
1706 fetch the contents of a register, it is necessary to use
1707 one of the register based addressing operations, such as
1708 \DWOPbregx{} 
1709 (Section \refersec{chap:registervalues})}.
1710
1711 \subsubsubsection{Implicit Location Descriptions}
1712 An \addtoindex{implicit location description}
1713 represents a piece or all
1714 \addtoindexx{location description!implicit}
1715 of an object which has no actual location but whose contents
1716 are nonetheless either known or known to be undefined.
1717
1718 The following DWARF operations may be used to specify a value
1719 that has no location in the program but is a known constant
1720 or is computed from other locations and values in the program.
1721 \begin{enumerate}[1. ]
1722 \itembfnl{\DWOPimplicitvalueTARG}
1723 The \DWOPimplicitvalueTARG{} 
1724 operation specifies an immediate value
1725 using two operands: an unsigned LEB128\addtoindexx{LEB128!unsigned}
1726 length, followed by
1727 %FIXME: should this block be a reference? To what?
1728 a \nolink{block} representing the value in the memory representation
1729 of the target machine. The length operand gives the length
1730 in bytes of the \nolink{block}.
1731
1732 \itembfnl{\DWOPstackvalueTARG}
1733 The \DWOPstackvalueTARG{} 
1734 operation specifies that the object
1735 does not exist in memory but its value is nonetheless known
1736 and is at the top of the DWARF expression stack. In this form
1737 of location description, the DWARF expression represents the
1738 actual value of the object, rather than its location. The
1739 \DWOPstackvalueNAME{} operation terminates the expression.
1740
1741 \needlines{4}
1742 \itembfnl{\DWOPimplicitpointerTARG}
1743 The \DWOPimplicitpointerNAME{} operation specifies that the object
1744 is a pointer that cannot be represented as a real pointer,
1745 even though the value it would point to can be described. In
1746 this form of location description, the DWARF expression refers
1747 to a debugging information entry that represents the actual
1748 value of the object to which the pointer would point. Thus, a
1749 consumer of the debug information would be able to show the
1750 value of the dereferenced pointer, even when it cannot show
1751 the value of the pointer itself.
1752
1753 \needlines{5}
1754 The \DWOPimplicitpointerNAME{} operation has two operands: a 
1755 reference to a debugging information entry that describes 
1756 the dereferenced object's value, and a signed number that 
1757 is treated as a byte offset from the start of that value. 
1758 The first operand is a 4-byte unsigned value in the 32-bit 
1759 DWARF format, or an 8-byte unsigned value in the 64-bit 
1760 DWARF format (see Section 
1761 \refersec{datarep:32bitand64bitdwarfformats}).
1762 The second operand is a 
1763 signed LEB128\addtoindexx{LEB128!signed} number.
1764
1765 The first operand is used as the offset of a debugging
1766 information entry in a \dotdebuginfo{} section, which may be
1767 contained in a shared object or executable other than that
1768 containing the operator. For references from one shared object
1769 or executable to another, the relocation must be performed by
1770 the consumer.
1771
1772 \textit{The debugging information entry referenced by a 
1773 \DWOPimplicitpointerNAME{} operation is typically a
1774 \DWTAGvariable{} or \DWTAGformalparameter{} entry whose
1775 \DWATlocation{} attribute gives a second DWARF expression or a
1776 location list that describes the value of the object, but the
1777 referenced entry may be any entry that contains a \DWATlocation{}
1778 or \DWATconstvalue{} attribute (for example, \DWTAGdwarfprocedure).
1779 By using the second DWARF expression, a consumer can
1780 reconstruct the value of the object when asked to dereference
1781 the pointer described by the original DWARF expression
1782 containing the \DWOPimplicitpointer{} operation.}
1783
1784 \end{enumerate}
1785
1786 \textit{DWARF location expressions are intended to yield the \textbf{location}
1787 of a value rather than the value itself. An optimizing compiler
1788 may perform a number of code transformations where it becomes
1789 impossible to give a location for a value, but remains possible
1790 to describe the value itself. 
1791 Section \refersec{chap:registerlocationdescriptions}
1792 describes operators that can be used to
1793 describe the location of a value when that value exists in a
1794 register but not in memory. The operations in this section are
1795 used to describe values that exist neither in memory nor in a
1796 single register.}
1797
1798 \paragraph{Empty Location Descriptions}
1799
1800 An \addtoindex{empty location description}
1801 consists of a DWARF expression
1802 \addtoindexx{location description!empty}
1803 containing no operations. It represents a piece or all of an
1804 object that is present in the source but not in the object code
1805 (perhaps due to optimization).
1806
1807 \needlines{5}
1808 \subsubsection{Composite Location Descriptions}
1809 A composite location description describes an object or
1810 value which may be contained in part of a register or stored
1811 in more than one location. Each piece is described by a
1812 composition operation, which does not compute a value nor
1813 store any result on the DWARF stack. There may be one or
1814 more composition operations in a single composite location
1815 description. A series of such operations describes the parts
1816 of a value in memory address order.
1817
1818 Each composition operation is immediately preceded by a simple
1819 location description which describes the location where part
1820 of the resultant value is contained.
1821 \begin{enumerate}[1. ]
1822 \itembfnl{\DWOPpieceTARG}
1823 The \DWOPpieceTARG{} operation takes a 
1824 single operand, which is an
1825 unsigned LEB128\addtoindexx{LEB128!unsigned} number.  
1826 The number describes the size in bytes
1827 of the piece of the object referenced by the preceding simple
1828 location description. If the piece is located in a register,
1829 but does not occupy the entire register, the placement of
1830 the piece within that register is defined by the ABI.
1831
1832 \textit{Many compilers store a single variable in sets of registers,
1833 or store a variable partially in memory and partially in
1834 registers. \DWOPpieceNAME{} provides a way of describing how large
1835 a part of a variable a particular DWARF location description
1836 refers to. }
1837
1838 \itembfnl{\DWOPbitpieceTARG}
1839 The \DWOPbitpieceTARG{} 
1840 operation takes two operands. The first
1841 is an unsigned LEB128\addtoindexx{LEB128!unsigned} 
1842 number that gives the size in bits
1843 of the piece. The second is an 
1844 unsigned LEB128\addtoindexx{LEB128!unsigned} number that
1845 gives the offset in bits from the location defined by the
1846 preceding DWARF location description.  
1847
1848 Interpretation of the
1849 offset depends on the kind of location description. If the
1850 location description is empty, the offset doesn\textquoteright t matter and
1851 the \DWOPbitpieceNAME{} operation describes a piece consisting
1852 of the given number of bits whose values are undefined. If
1853 the location is a register, the offset is from the least
1854 significant bit end of the register. If the location is a
1855 memory address, the \DWOPbitpieceNAME{} operation describes a
1856 sequence of bits relative to the location whose address is
1857 on the top of the DWARF stack using the bit numbering and
1858 direction conventions that are appropriate to the current
1859 language on the target system. If the location is any implicit
1860 value or stack value, the \DWOPbitpieceNAME{} operation describes
1861 a sequence of bits using the least significant bits of that
1862 value.  
1863 \end{enumerate}
1864
1865 \textit{\DWOPbitpieceNAME{} is 
1866 used instead of \DWOPpieceNAME{} when
1867 the piece to be assembled into a value or assigned to is not
1868 byte-sized or is not at the start of a register or addressable
1869 unit of memory.}
1870
1871
1872
1873
1874 \subsubsection{Example Single Location Descriptions}
1875
1876 Here are some examples of how DWARF operations are used to form location descriptions:
1877 % Probably the only place that this will be used, so not in dwarf.tex?
1878 \newcommand{\descriptionitemnl}[1]{\item[#1]\mbox{}\\}
1879 \begin{description}
1880 \descriptionitemnl{\DWOPregthree}
1881 The value is in register 3.
1882
1883 \descriptionitemnl{\DWOPregx{} 54}
1884 The value is in register 54.
1885
1886 \descriptionitemnl{\DWOPaddr{} 0x80d0045c}
1887 The value of a static variable is at machine address 0x80d0045c.
1888
1889 \descriptionitemnl{\DWOPbregeleven{} 44}
1890 Add 44 to the value in register 11 to get the address of an automatic
1891 variable instance.
1892
1893 \needlines{4}
1894 \descriptionitemnl{\DWOPfbreg{} -50}
1895 Given a \DWATframebase{} value of
1896 \doublequote{\DWOPbregthirtyone{} 64,} this example
1897 computes the address of a local variable that is -50 bytes from a
1898 logical frame pointer that is computed by adding 64 to the current
1899 stack pointer (register 31).
1900
1901 \descriptionitemnl{\DWOPbregx{} 54 32 \DWOPderef}
1902 A call-by-reference parameter whose address is in the word 32 bytes
1903 from where register 54 points.
1904
1905 \needlines{4}
1906 \descriptionitemnl{\DWOPplusuconst{} 4}
1907 A structure member is four bytes from the start of the structure
1908 instance. The base address is assumed to be already on the stack.
1909
1910 \descriptionitemnl{\DWOPregthree{} \DWOPpiece{} 4 \DWOPregten{} \DWOPpiece{} 2}
1911 A variable whose first four bytes reside in register 3 and whose next
1912 two bytes reside in register 10.
1913
1914 \descriptionitemnl{\DWOPregzero{} \DWOPpiece{} 4 \DWOPpiece{} 4 \DWOPfbreg{} -12 \DWOPpiece{} 4}
1915 \vspace{-2\parsep}A twelve byte value whose first four bytes reside in register zero,
1916 whose middle four bytes are unavailable (perhaps due to optimization),
1917 and whose last four bytes are in memory, 12 bytes before the frame
1918 base.
1919
1920 \descriptionitemnl{\DWOPbregone{} 0 \DWOPbregtwo{} 0 \DWOPplus{} \DWOPstackvalue{} }
1921 Add the contents of r1 and r2 to compute a value. This value is the
1922 \doublequote{contents} of an otherwise anonymous location.
1923
1924 \needlines{4}
1925 \descriptionitemnl{\DWOPlitone{} \DWOPstackvalue{} \DWOPpiece{} 4 \DWOPbregthree{} 0 \DWOPbregfour{} 0}
1926 \vspace{-2\parsep}\descriptionitemnl{
1927 \hspace{0.5cm}\DWOPplus{} \DWOPstackvalue{} \DWOPpiece{} 4 \DWOPpiece{} 4}
1928 The object value is found in an anonymous (virtual) location whose
1929 value consists of two parts, given in memory address order: the 4 byte
1930 value 1 followed by the four byte value computed from the sum of the
1931 contents of r3 and r4.
1932
1933 \descriptionitemnl{\DWOPentryvalue{} 1 \DWOPregone{} \DWOPstackvalue }
1934 The value register 1 had upon entering the current subprogram.
1935
1936 \descriptionitemnl{\DWOPentryvalue{} 2 \DWOPbregone{} 0 \DWOPstackvalue }
1937 The value register 1 had upon entering the current subprogram (same as the previous example).
1938 %Both of these location descriptions evaluate to the value register 1 had upon
1939 %entering the current subprogram.
1940
1941 %FIXME: The following gets an undefined control sequence error for reasons unknown... 
1942 %\descriptionitemnl{\DWOPentryvalue{} 1 \DWOPregthirtyone{} \DWOPregone{} \DWOPadd{} \DWOPstackvalue }
1943 %The value register 31 had upon entering the current subprogram
1944 %plus the value register 1 currently has.
1945
1946 \descriptionitemnl{\DWOPentryvalue{} 3 \DWOPbregfour{} 16 \DWOPderef{} \DWOPstackvalue }
1947 %FIXME: similar undefined as just above
1948 %\descriptionitemnl{\DWOPentryvalue{} 6 \DWOPentryvalue{} 1 \DWOPregfour{} \DWOPplusuconst{} 16 \DWOPderef{} \DWOPstackvalue }
1949 %These two location expressions do the same thing, p
1950 Add 16 to the value register 4 had upon entering the current subprogram
1951 to form an address and then push the value of the memory location at that address.
1952
1953 \end{description}
1954
1955
1956 \subsection{Location Lists}
1957 \label{chap:locationlists}
1958 There are two forms of location lists. The first form 
1959 is intended for use in other than a split DWARF object file,
1960 while the second is intended for use in a split DWARF object
1961 (see Section \refersec{datarep:splitdwarfobjects}). The two
1962 forms are otherwise equivalent.
1963
1964 \textit{The form for split DWARF objects is new in \DWARFVersionV.}
1965
1966 \subsubsection{Location Lists in Non-split Objects}
1967 \label{chap:locationlistsinnonsplitobjects}
1968 Location lists 
1969 \addtoindexx{location list}
1970 are used in place of location expressions
1971 whenever the object whose location is being described
1972 can change location during its lifetime. 
1973 Location lists
1974 \addtoindexx{location list}
1975 are contained in a separate object file section called
1976 \dotdebugloc{}. A location list is indicated by a location
1977 attribute whose value is an offset from the beginning of
1978 the \dotdebugloc{} section to the first byte of the list for the
1979 object in question.
1980
1981 Each entry in a location list is either a location 
1982 \addtoindexi{list}{address selection|see{base address selection}} 
1983 entry,
1984
1985 \addtoindexi{base}{base address selection entry!in location list} 
1986 address selection entry, 
1987 \addtoindexx{location list!base address selection entry}
1988 or an 
1989 \addtoindexx{end-of-list entry!in location list}
1990 end-of-list entry.
1991
1992 A location list entry has two forms:
1993 a normal location list entry and a default location list entry.
1994
1995 \needlines{4}
1996 A \addtoindexx{location list!normal entry}
1997 normal location list entry consists of:
1998 \begin{enumerate}[1. ]
1999 \item A beginning address offset. 
2000 This address offset has the \addtoindex{size of an address} and is
2001 relative to the applicable base address of the compilation
2002 unit referencing this location list. It marks the beginning
2003 of the address 
2004 \addtoindexi{range}{address range!in location list} 
2005 over which the location is valid.
2006
2007 \item An ending address offset.  This address offset again
2008 has the \addtoindex{size of an address} and is relative to the applicable
2009 base address of the compilation unit referencing this location
2010 list. It marks the first address past the end of the address
2011 range over which the location is valid. The ending address
2012 must be greater than or equal to the beginning address.
2013
2014 \textit{A location list entry (but not a base address selection or 
2015 end-of-list entry) whose beginning
2016 and ending addresses are equal has no effect 
2017 because the size of the range covered by such
2018 an entry is zero.}
2019
2020 \item An unsigned 2-byte length describing the length of the location 
2021 description that follows.
2022
2023 \item A \addtoindex{single location description} 
2024 describing the location of the object over the range specified by
2025 the beginning and end addresses.
2026 \end{enumerate}
2027
2028 \needlines{5}
2029 The applicable base address of a normal
2030 location list entry is
2031 \addtoindexx{location list!base address selection entry}
2032 determined by the closest preceding base address selection
2033 entry (see below) in the same location list. If there is
2034 no such selection entry, then the applicable base address
2035 defaults to the base address of the compilation unit (see
2036 Section \refersec{chap:normalandpartialcompilationunitentries}).  
2037
2038 \textit{In the case of a compilation unit where all of
2039 the machine code is contained in a single contiguous section,
2040 no base address selection entry is needed.}
2041
2042 Address ranges defined by normal location list entries
2043 may overlap. When they do, they describe a
2044 situation in which an object exists simultaneously in more than
2045 one place. If all of the address ranges in a given location
2046 list do not collectively cover the entire range over which the
2047 object in question is defined, it is assumed that the object is
2048 not available for the portion of the range that is not covered.
2049
2050 \needlines{4}
2051 A default location list entry consists of:
2052 \addtoindexx{location list!default entry}
2053 \begin{enumerate}[1. ]
2054 \item The value 0.
2055 \item The value of the largest representable address offset (for
2056       example, \wffffffff when the size of an address is 32 bits).
2057 \item A simple location description describing the location of the
2058       object when there is no prior normal location list entry
2059       that applies in the same location list.
2060 \end{enumerate}
2061
2062 A default location list entry is independent of any applicable
2063 base address (except to the extent to which base addresses
2064 affect prior normal location list entries).
2065
2066 A default location list entry must be the last location list
2067 entry of a location list except for the terminating end-of-list
2068 entry.
2069
2070 A default location list entry describes an unlimited number
2071 (zero, one or more) of address ranges, none of which overlap
2072 any of the address ranges defined earlier in the same location
2073 list. Further, all such address ranges have the same simple
2074 location.
2075
2076 \needlines{5}
2077 A base 
2078 \addtoindexi{address}{address selection|see{base address selection}}
2079 \addtoindexx{location list!base address selection entry}
2080 selection 
2081 \addtoindexi{entry}{base address selection entry!in location list}
2082 consists of:
2083 \begin{enumerate}[1. ]
2084 \item The value of the largest representable 
2085 address offset (for example, \wffffffff when the size of
2086 an address is 32 bits).
2087 \item An address, which defines the 
2088 appropriate base address for use in interpreting the beginning
2089 and ending address offsets of subsequent entries of the location list.
2090 \end{enumerate}
2091
2092 \textit{A base address selection entry 
2093 affects only the list in which it is contained.}
2094
2095 \needlines{5}
2096 The end of any given location list is marked by an 
2097 \addtoindexx{location list!end-of-list entry}
2098 end-of-list entry, which consists of a 0 for the beginning address
2099 offset and a 0 for the ending address offset. A location list
2100 containing only an 
2101 \addtoindexx{end-of-list entry!in location list}
2102 end-of-list entry describes an object that
2103 exists in the source code but not in the executable program.
2104
2105 Neither a base address selection entry nor an end-of-list
2106 entry includes a location description.
2107
2108 \needlines{4}
2109 \textit{When a DWARF consumer is parsing and decoding a location
2110 list, it must recognize the beginning and ending address
2111 offsets of (0, 0) for an end-of-list entry and 
2112 \mbox{(0, \texttt{maximum-address})} for
2113 a default location list entry prior to applying any base
2114 address. Any other pair of offsets beginning with 0 is a
2115 valid normal location list entry. Next, it must recognize the
2116 beginning address offset of \texttt{maximum-address} for a base address selection
2117 entry prior to applying any base address. The current base
2118 address is not applied to the subsequent value (although there
2119 may be an underlying object language relocation that affects
2120 that value).}
2121
2122 \textit{A base address selection entry and an end-of-list
2123 entry for a location list are identical to a base address
2124 selection entry and end-of-list entry, respectively, for a
2125 \addtoindex{range list}
2126 (see Section \refersec{chap:noncontiguousaddressranges}) 
2127 in interpretation and representation.}
2128
2129 \subsubsection{Location Lists in Split Objects}
2130 \label{chap:locationlistsinsplitobjects}
2131 In a split DWARF object (see 
2132 Section \refersec{datarep:splitdwarfobjects}), 
2133 location lists are contained in the \dotdebuglocdwo{} section.
2134
2135 Each entry in the location list
2136 begins with a type code, which is a single unsigned byte that
2137 identifies the type of entry. There are five types of entries:
2138 \begin{enumerate}
2139 \itembfnl{\DWLLEendoflistentryTARG}
2140 This entry indicates the end of a location list, and
2141 contains no further data.
2142
2143 \itembfnl{\DWLLEbaseaddressselectionentryTARG}
2144 This entry contains an 
2145 unsigned LEB128\addtoindexx{LEB128!unsigned} value immediately
2146 following the type code. This value is the index of an
2147 address in the \dotdebugaddr{} section, which is then used as
2148 the base address when interpreting offsets in subsequent
2149 location list entries of type \DWLLEoffsetpairentry.
2150 This index is relative to the value of the 
2151 \DWATaddrbase{} attribute of the associated compilation unit.
2152
2153 \itembfnl{\DWLLEstartendentryTARG}
2154 This entry contains two unsigned LEB128\addtoindexx{LEB128!unsigned}
2155 values immediately following the type code. These values are the
2156 indices of two addresses in the \dotdebugaddr{} section.
2157 These indices are relative to the value of the 
2158 \DWATaddrbase{} attribute of the associated compilation unit.
2159 These indicate the starting and ending addresses,
2160 respectively, that define the address range for which
2161 this location is valid. The starting and ending addresses
2162 given by this type of entry are not relative to the
2163 compilation unit base address. A single location
2164 description follows the fields that define the address range.
2165
2166 \itembfnl{\DWLLEstartlengthentryTARG}
2167 This entry contains one unsigned LEB128\addtoindexx{LEB128!unsigned}
2168 value and a 4-byte
2169 unsigned value immediately following the type code. The
2170 first value is the index of an address in the \dotdebugaddr{}
2171 section, which marks the beginning of the address range
2172 over which the location is valid.
2173 This index is relative to the value of the 
2174 \DWATaddrbase{} attribute of the associated compilation unit.
2175 The starting address given by this
2176 type of entry is not relative to the compilation unit
2177 base address. The second value is the
2178 length of the range. A single location
2179 description follows the fields that define the address range.
2180
2181 \itembfnl{\DWLLEoffsetpairentryTARG}
2182 This entry contains two 4-byte unsigned values
2183 immediately following the type code. These values are the
2184 starting and ending offsets, respectively, relative to
2185 the applicable base address, that define the address
2186 range for which this location is valid. A single location
2187 description follows the fields that define the address range.
2188 \end{enumerate}
2189
2190
2191 \section{Types of Program Entities}
2192 \label{chap:typesofprogramentities}
2193 \hypertarget{chap:DWATtypetypeofdeclaration}{}
2194 Any debugging information entry describing a declaration that
2195 has a type has 
2196 \addtoindexx{type attribute}
2197 a \DWATtype{} attribute, whose value is a
2198 reference to another debugging information entry. The entry
2199 referenced may describe a base type, that is, a type that is
2200 not defined in terms of other data types, or it may describe a
2201 user-defined type, such as an array, structure or enumeration.
2202 Alternatively, the entry referenced may describe a type
2203 modifier, such as constant, packed, pointer, reference or
2204 volatile, which in turn will reference another entry describing
2205 a type or type modifier (using 
2206 \addtoindexx{type attribute}
2207 a \DWATtype{} attribute of its
2208 own). See 
2209 Section  \referfol{chap:typeentries} 
2210 for descriptions of the entries describing
2211 base types, user-defined types and type modifiers.
2212
2213
2214 \needlines{6}
2215 \section{Accessibility of Declarations}
2216 \label{chap:accessibilityofdeclarations}
2217 \textit{Some languages, notably \addtoindex{C++} and 
2218 \addtoindex{Ada}, have the concept of
2219 the accessibility of an object or of some other program
2220 entity. The accessibility specifies which classes of other
2221 program objects are permitted access to the object in question.}
2222
2223 The accessibility of a declaration is 
2224 \hypertarget{chap:DWATaccessibilitycandadadeclarations}{}
2225 represented by a 
2226 \DWATaccessibility{} 
2227 attribute, whose
2228 \addtoindexx{accessibility attribute}
2229 value is a constant drawn from the set of codes listed in Table 
2230 \refersec{tab:accessibilitycodes}.
2231
2232 \begin{simplenametable}[1.9in]{Accessibility codes}{tab:accessibilitycodes}
2233 \DWACCESSpublicTARG{}          \\
2234 \DWACCESSprivateTARG{}        \\
2235 \DWACCESSprotectedTARG{}    \\
2236 \end{simplenametable}
2237
2238 \needlines{5}
2239 \section{Visibility of Declarations}
2240 \label{chap:visibilityofdeclarations}
2241
2242 \textit{Several languages (such as \addtoindex{Modula-2}) 
2243 have the concept of the visibility of a declaration. The
2244 visibility specifies which declarations are to be 
2245 visible outside of the entity in which they are
2246 declared.}
2247
2248 The 
2249 \hypertarget{chap:DWATvisibilityvisibilityofdeclaration}{}
2250 visibility of a declaration is represented 
2251 by a \DWATvisibility{}
2252 attribute\addtoindexx{visibility attribute}, whose value is a
2253 constant drawn from the set of codes listed in 
2254 Table \refersec{tab:visibilitycodes}.
2255
2256 \begin{simplenametable}[1.5in]{Visibility codes}{tab:visibilitycodes}
2257 \DWVISlocalTARG{}          \\
2258 \DWVISexportedTARG{}    \\
2259 \DWVISqualifiedTARG{}  \\
2260 \end{simplenametable}
2261
2262 \needlines{8}
2263 \section{Virtuality of Declarations}
2264 \label{chap:virtualityofdeclarations}
2265 \textit{\addtoindex{C++} provides for virtual and pure virtual structure or class
2266 member functions and for virtual base classes.}
2267
2268 The 
2269 \hypertarget{chap:DWATvirtualityvirtualityindication}{}
2270 virtuality of a declaration is represented by a
2271 \DWATvirtuality{}
2272 attribute\addtoindexx{virtuality attribute}, whose value is a constant drawn
2273 from the set of codes listed in 
2274 Table \refersec{tab:virtualitycodes}.
2275
2276 \begin{simplenametable}[2.5in]{Virtuality codes}{tab:virtualitycodes}
2277 \DWVIRTUALITYnoneTARG{}                      \\
2278 \DWVIRTUALITYvirtualTARG{}                \\
2279 \DWVIRTUALITYpurevirtualTARG{}    \\
2280 \end{simplenametable}
2281
2282 \needlines{8}
2283 \section{Artificial Entries}
2284 \label{chap:artificialentries}
2285 \textit{A compiler may wish to generate debugging information entries
2286 for objects or types that were not actually declared in the
2287 source of the application. An example is a formal parameter
2288 %FIXME: The word 'this' should be rendered like a variant italic,
2289 %FIXME: not as a quoted name. Changed to tt font--RB
2290 entry to represent the hidden 
2291 \texttt{this} parameter\index{this parameter@\texttt{this} parameter}
2292 that most \addtoindex{C++} implementations pass as the first argument 
2293 to non-static member functions.}  
2294
2295 Any debugging information entry representing the
2296 \addtoindexx{artificial attribute}
2297 declaration of an object or type artificially generated by
2298 a compiler and not explicitly declared by the source program
2299 \hypertarget{chap:DWATartificialobjectsortypesthat}{}
2300 may have a 
2301 \DWATartificial{} attribute, 
2302 which is a \livelink{chap:classflag}{flag}.
2303
2304 \needlines{6}
2305 \section{Segmented Addresses}
2306 \label{chap:segmentedaddresses}
2307 \textit{In some systems, addresses are specified as offsets within a
2308 given 
2309 \addtoindexx{address space!segmented}
2310 segment 
2311 \addtoindexx{segmented addressing|see{address space}}
2312 rather than as locations within a single flat
2313 \addtoindexx{address space!flat}
2314 address space.}
2315
2316 Any debugging information entry that contains a description
2317 \hypertarget{chap:DWATsegmentaddressinginformation}{}
2318 of the location of an object or subroutine may have a 
2319 \DWATsegment{} attribute, 
2320 \addtoindexx{segment attribute}
2321 whose value is a location
2322 description. The description evaluates to the segment selector
2323 of the item being described. If the entry containing the
2324 \DWATsegment{} attribute has a 
2325 \DWATlowpc, 
2326 \DWAThighpc,
2327 \DWATranges{} or 
2328 \DWATentrypc{} attribute, 
2329 \addtoindexx{entry pc attribute}
2330 or 
2331 a location
2332 description that evaluates to an address, then those address
2333 values represent the offset portion of the address within
2334 the segment specified 
2335 \addtoindexx{segment attribute}
2336 by \DWATsegment.
2337
2338 If an entry has no 
2339 \DWATsegment{} attribute, it inherits
2340 \addtoindexx{segment attribute}
2341 the segment value from its parent entry.  If none of the
2342 entries in the chain of parents for this entry back to
2343 its containing compilation unit entry have 
2344 \DWATsegment{} attributes, 
2345 then the entry is assumed to exist within a flat
2346 address space. 
2347 Similarly, if the entry has a 
2348 \DWATsegment{} attribute 
2349 \addtoindexx{segment attribute}
2350 containing an empty location description, that
2351 entry is assumed to exist within a 
2352 \addtoindexi{flat}{address space!flat}
2353 address space.
2354
2355 \textit{Some systems support different 
2356 classes of addresses\addtoindexx{address class}. 
2357 The address class may affect the way a pointer is dereferenced
2358 or the way a subroutine is called.}
2359
2360
2361 Any debugging information entry representing a pointer or
2362 reference type or a subroutine or subroutine type may 
2363 have a 
2364 \DWATaddressclass{}
2365 attribute, whose value is an integer
2366 constant.  The set of permissible values is specific to
2367 each target architecture. The value \DWADDRnoneTARG, 
2368 however,
2369 is common to all encodings, and means that no address class
2370 has been specified.
2371
2372 \needlines{4}
2373 \textit {For example, the Intel386 \texttrademark\  processor might use the following values:}
2374
2375 \begin{table}[here]
2376 \caption{Example address class codes}
2377 \label{tab:inteladdressclasstable}
2378 \centering
2379 \begin{tabular}{l|c|l}
2380 \hline
2381 Name&Value&Meaning  \\
2382 \hline
2383 \textit{DW\_ADDR\_none}&   0 & \textit{no class specified} \\
2384 \textit{DW\_ADDR\_near16}& 1 & \textit{16\dash bit offset, no segment} \\
2385 \textit{DW\_ADDR\_far16}&  2 & \textit{16\dash bit offset, 16\dash bit segment} \\
2386 \textit{DW\_ADDR\_huge16}& 3 & \textit{16\dash bit offset, 16\dash bit segment} \\
2387 \textit{DW\_ADDR\_near32}& 4 & \textit{32\dash bit offset, no segment} \\
2388 \textit{DW\_ADDR\_far32}&  5 & \textit{32\dash bit offset, 16\dash bit segment} \\
2389 \hline
2390 \end{tabular}
2391 \end{table}
2392
2393 \needlines{6}
2394 \section{Non-Defining Declarations and Completions}
2395 \label{nondefiningdeclarationsandcompletions}
2396 A debugging information entry representing a program entity
2397 typically represents the defining declaration of that
2398 entity. In certain contexts, however, a debugger might need
2399 information about a declaration of an entity that is not
2400 \addtoindexx{incomplete declaration}
2401 also a definition, or is otherwise incomplete, to evaluate
2402 \hypertarget{chap:DWATdeclarationincompletenondefiningorseparateentitydeclaration}{}
2403 an expression correctly.
2404
2405 \needlines{10}
2406 \textit{As an example, consider the following fragment of \addtoindex{C} code:}
2407
2408 \begin{lstlisting}
2409 void myfunc()
2410 {
2411   int x;
2412   {
2413     extern float x;
2414     g(x);
2415   }
2416 }
2417 \end{lstlisting}
2418
2419
2420 \textit{\addtoindex{C} scoping rules require that the 
2421 value of the variable x passed to the function g is the value of the
2422 global variable x rather than of the local version.}
2423
2424 \subsection{Non-Defining Declarations}
2425 A debugging information entry that 
2426 represents a non-defining 
2427 \addtoindexx{non-defining declaration}
2428 or otherwise 
2429 \addtoindex{incomplete declaration}
2430 of a program entity has a
2431 \addtoindexx{declaration attribute}
2432 \DWATdeclaration{} attribute, which is a 
2433 \livelink{chap:classflag}{flag}.
2434
2435 \subsection{Declarations Completing Non-Defining Declarations}
2436 A debugging information entry that represents a 
2437 declaration\hypertarget{chap:DWATspecificationincompletenondefiningorseparatedeclaration}{}
2438 that completes another (earlier) non-defining declaration may have a 
2439 \DWATspecification{}
2440 attribute whose value is a \livelink{chap:classreference}{reference} to
2441 the debugging information entry representing the non-defining declaration. 
2442 A debugging information entry with a 
2443 \DWATspecification{} 
2444 attribute does not need to duplicate information provided by the 
2445 debugging information entry referenced by that specification attribute.
2446
2447 When the non-defining declaration is contained within a type that has
2448 been placed in a separate type unit (see Section \refersec{chap:typeunitentries}), 
2449 the \DWATspecification{} attribute cannot refer directly to the entry in
2450 the type unit. Instead, the current compilation unit may contain a
2451 \doublequote{skeleton} declaration of the type, which contains only the relevant
2452 declaration and its ancestors as necessary to provide the context
2453 (including containing types and namespaces). The \DWATspecification{}
2454 attribute would then be a reference to the declaration entry within
2455 the skeleton declaration tree. The debugging information entry for the
2456 top-level type in the skeleton tree may contain a \DWATsignature{}
2457 attribute whose value is the type signature 
2458 (see Section \refersec{datarep:typesignaturecomputation}).
2459
2460
2461 Not all attributes of the debugging information entry referenced by a
2462 \DWATspecification{} attribute 
2463 apply to the referring debugging information entry.
2464
2465 \textit{For 
2466 \addtoindexx{declaration attribute}
2467 example,
2468 \DWATsibling{} and 
2469 \DWATdeclaration{} 
2470 \addtoindexx{declaration attribute}
2471 clearly cannot apply to a 
2472 \addtoindexx{declaration attribute}
2473 referring
2474 \addtoindexx{sibling attribute}
2475 entry.}
2476
2477
2478
2479 \section{Declaration Coordinates}
2480 \label{chap:declarationcoordinates}
2481 \livetargi{chap:declarationcoordinates}{}{declaration coordinates}
2482 \textit{It is sometimes useful in a debugger to be able to associate
2483 a declaration with its occurrence in the program source.}
2484
2485 Any debugging information 
2486 \hypertarget{chap:DWATdeclfilefilecontainingsourcedeclaration}{}
2487 entry 
2488 \hypertarget{chap:DWATdecllinelinenumberofsourcedeclaration}{}
2489 representing 
2490 \hypertarget{chap:DWATdeclcolumncolumnpositionofsourcedeclaration}{}
2491 the
2492 \addtoindexx{line number of declaration}
2493 declaration of an object, module, subprogram or
2494 \addtoindex{declaration column attribute}
2495 type 
2496 \addtoindex{declaration file attribute}
2497 may 
2498 \addtoindex{declaration line attribute}
2499 have
2500 \DWATdeclfile, 
2501 \DWATdeclline{} and 
2502 \DWATdeclcolumn{}
2503 attributes each of whose value is an unsigned
2504 \livelink{chap:classconstant}{integer constant}.
2505
2506 The value of 
2507 \addtoindexx{declaration file attribute}
2508 the 
2509 \DWATdeclfile{}
2510 attribute 
2511 \addtoindexx{file containing declaration}
2512 corresponds to
2513 a file number from the line number information table for the
2514 compilation unit containing the debugging information entry and
2515 represents the source file in which the declaration appeared
2516 (see Section \refersec{chap:linenumberinformation}). 
2517 The value 0 indicates that no source file
2518 has been specified.
2519
2520 The value of 
2521 \addtoindexx{declaration line attribute}
2522 the \DWATdeclline{} attribute represents
2523 the source line number at which the first character of
2524 the identifier of the declared object appears. The value 0
2525 indicates that no source line has been specified.
2526
2527 The value of 
2528 \addtoindexx{declaration column attribute}
2529 the \DWATdeclcolumn{} attribute represents
2530 the source column number at which the first character of
2531 the identifier of the declared object appears. The value 0
2532 indicates that no column has been specified.
2533
2534 \section{Identifier Names}
2535 \label{chap:identifiernames}
2536 Any\hypertarget{chap:DWATnamenameofdeclaration}{}
2537 debugging information entry 
2538 \addtoindexx{identifier names}
2539 representing 
2540 \addtoindexx{names!identifier}
2541 a program entity
2542 that has been given a name may have a 
2543 \DWATname{} attribute,
2544 whose 
2545 \addtoindexx{name attribute}
2546 value is a \livelink{chap:classstring}{string} 
2547 representing the name as it appears in
2548 the source program. A debugging information entry containing
2549 no name attribute, or containing a name attribute whose value
2550 consists of a name containing a single null byte, represents
2551 a program entity for which no name was given in the source.
2552
2553 \textit{Because the names of program objects described by DWARF are 
2554 the names as they appear in the source program, implementations
2555 of language translators that use some form of mangled name
2556 \addtoindexx{mangled names}
2557 (as do many implementations of \addtoindex{C++}) should use the 
2558 unmangled form of the name in the 
2559 \DWATname{} attribute,
2560 \addtoindexx{name attribute}
2561 including the keyword operator (in names such as \doublequote{operator +}),
2562 if present. See also 
2563 Section \referfol{chap:linkagenames} regarding the use of 
2564 \DWATlinkagename{} for 
2565 \addtoindex{mangled names}.
2566 Sequences of multiple whitespace characters may be compressed.}
2567
2568 \section{Data Locations and DWARF Procedures}
2569 Any debugging information entry describing a data object (which
2570 \hypertarget{chap:DWATlocationdataobjectlocation}{}
2571 includes variables and parameters) or 
2572 \livelink{chap:commonblockentry}{common blocks}
2573 may have 
2574 \addtoindexx{location attribute}
2575 a
2576 \DWATlocation{} attribute,
2577 \addtoindexx{location attribute}
2578 whose value is a location description
2579 (see Section \refersec{chap:locationdescriptions}).
2580
2581 \needlines{4}
2582
2583 \addtoindex{DWARF procedure}
2584 is represented by any
2585 kind of debugging information entry that has 
2586 \addtoindexx{location attribute}
2587
2588 \DWATlocation{}
2589 attribute. 
2590 \addtoindexx{location attribute}
2591 If a suitable entry is not otherwise available,
2592 a DWARF procedure can be represented using a debugging
2593 \addtoindexx{DWARF procedure entry}
2594 information entry with the 
2595 tag \DWTAGdwarfprocedureTARG{}
2596 together with 
2597 \addtoindexx{location attribute}
2598 a \DWATlocation{} attribute.  
2599
2600 A DWARF procedure
2601 is called by a \DWOPcalltwo, 
2602 \DWOPcallfour{} or 
2603 \DWOPcallref{}
2604 DWARF expression operator 
2605 (see Section \refersec{chap:controlflowoperations}).
2606
2607 \needlines{5}
2608 \section{Code Addresses and Ranges}
2609 \label{chap:codeaddressesandranges}
2610 Any debugging information entry describing an entity that has
2611 a machine code address or range of machine code addresses,
2612 which includes compilation units, module initialization,
2613 \hypertarget{chap:DWATrangesnoncontiguousrangeofcodeaddresses}{}
2614 subroutines, ordinary \nolink{blocks}, 
2615 try/catch \nolink{blocks} (see Section\refersec{chap:tryandcatchblockentries}), 
2616 labels and the like, may have
2617 \begin{itemize}
2618 \item A \DWATlowpc{} attribute for
2619 \hypertarget{chap:DWATlowpccodeaddressorrangeofaddresses}{}
2620 a single address,
2621
2622 \item A \DWATlowpc{}
2623 \addtoindexx{low PC attribute}
2624 and 
2625 \DWAThighpc{}
2626 \addtoindexx{high PC attribute}
2627 \hypertarget{chap:DWAThighpccontiguousrangeofcodeaddresses}{}
2628 pair of attributes for 
2629 a single contiguous range of
2630 addresses, or
2631
2632 \item A \DWATranges{} attribute 
2633 \addtoindexx{ranges attribute}
2634 for a non-contiguous range of addresses.
2635 \end{itemize}
2636
2637 In addition, a non-contiguous range of 
2638 addresses may also be specified for the
2639 \DWATstartscope{} attribute.
2640 \addtoindexx{start scope attribute}
2641
2642 If an entity has no associated machine code, 
2643 none of these attributes are specified.
2644
2645 \subsection{Single Address} 
2646 When there is a single address associated with an entity,
2647 such as a label or alternate entry point of a subprogram,
2648 the entry has a \DWATlowpc{} attribute whose value is the
2649 relocated address for the entity.
2650
2651 \textit{While the \DWATentrypc{}
2652 attribute might also seem appropriate for this purpose,
2653 historically the \DWATlowpc{} attribute was used before
2654 \DWATentrypc{} was introduced 
2655 (in \addtoindex{DWARF Version 3}). There is
2656 insufficient reason to change this;
2657 \DWATlowpc{} serves as a default entry PC address as described
2658 in Section \refersec{chap:entryaddress}.}
2659
2660 \needlines{8}
2661 \subsection{Continuous Address Range}
2662 \label{chap:contiguousaddressranges}
2663 When the set of addresses of a debugging information entry can
2664 be described as a single contiguous range, the entry 
2665 \addtoindexx{high PC attribute}
2666 may 
2667 \addtoindexx{low PC attribute}
2668 have
2669 a \DWATlowpc{} and 
2670 \DWAThighpc{} pair of attributes. 
2671 The value
2672 of the 
2673 \DWATlowpc{} attribute 
2674 is the relocated address of the
2675 first instruction associated with the entity. If the value of
2676 the \DWAThighpc{} is of class address, it is the relocated
2677 address of the first location past the last instruction
2678 associated with the entity; if it is of class constant, the
2679 value is an unsigned integer offset which when added to the
2680 low PC gives the address of the first location past the last
2681 instruction associated with the entity.
2682
2683 \textit{The high PC value
2684 may be beyond the last valid instruction in the executable.}
2685
2686 \needlines{5}
2687 The presence of low and high PC attributes for an entity
2688 implies that the code generated for the entity is contiguous
2689 and exists totally within the boundaries specified by those
2690 two attributes. If that is not the case, no low and high PC
2691 attributes should be produced.
2692
2693 \subsection{Non\dash Contiguous Address Ranges}
2694 \label{chap:noncontiguousaddressranges}
2695 When the set of addresses of a debugging information entry
2696 \addtoindexx{non-contiguous address ranges}
2697 cannot be described as a single contiguous range, the entry has
2698 a \DWATranges{} attribute 
2699 \addtoindexx{ranges attribute}
2700 whose value is of class \livelink{chap:classrangelistptr}{rangelistptr}
2701 and indicates the beginning of a \addtoindex{range list}.
2702 Similarly,
2703 a \DWATstartscope{} attribute 
2704 \addtoindexx{start scope attribute}
2705 may have a value of class
2706 \livelink{chap:classrangelistptr}{rangelistptr} for the same reason.  
2707
2708 Range lists are contained in a separate object file section called 
2709 \dotdebugranges{}. A
2710 \addtoindex{range list} is indicated by a 
2711 \DWATranges{} attribute whose
2712 \addtoindexx{ranges attribute}
2713 value is represented as an offset from the beginning of the
2714 \dotdebugranges{} section to the beginning of the 
2715 \addtoindex{range list}.
2716
2717 \needlines{4}
2718 If the current compilation unit contains a \DWATrangesbase{}
2719 attribute, the value of that attribute establishes a base
2720 offset within the \dotdebugranges{} section for the compilation
2721 unit. The offset given by the \DWATranges{} attribute is
2722 relative to that base.
2723
2724 \textit{The \DWATrangesbase{} attribute is new in \DWARFVersionV.
2725 The advantage of this attribute is that it reduces the number of
2726 object language relocations needed for references to the \dotdebugranges{}
2727 section from one for each range entry to a single relocation that
2728 applies for the entire compilation unit.}
2729
2730 Each entry in a \addtoindex{range list} is either a 
2731 \addtoindex{range list} entry,
2732 \addtoindexx{base address selection entry!in range list}
2733 a base address selection entry, or an 
2734 \addtoindexx{end-of-list entry!in range list}
2735 end-of-list entry.
2736
2737 A \addtoindex{range list} entry consists of:
2738 \begin{enumerate}[1. ]
2739 \item A beginning address offset. This address offset has the 
2740 \addtoindex{size of an address} and is relative to
2741 the applicable base address of the compilation unit referencing this 
2742 \addtoindex{range list}. 
2743 It marks the
2744 beginning of an 
2745 \addtoindexi{address}{address range!in range list} 
2746 range.
2747
2748 \item An ending address offset. This address offset again has the 
2749 \addtoindex{size of an address} and is relative
2750 to the applicable base address of the compilation unit referencing 
2751 this \addtoindex{range list}.
2752 It marks the
2753 first address past the end of the address range.
2754 The ending address must be greater than or
2755 equal to the beginning address.
2756
2757 \needlines{4}
2758 \textit{A \addtoindex{range list} entry (but not a base address 
2759 selection or end-of-list entry) whose beginning and
2760 ending addresses are equal has no effect because the size of the 
2761 range covered by such an entry is zero.}
2762 \end{enumerate}
2763
2764 The applicable base address of a \addtoindex{range list} entry
2765 is determined
2766 by the closest preceding base address selection entry (see
2767 below) in the same range list. If there is no such selection
2768 entry, then the applicable base address defaults to the base
2769 address of the compilation unit 
2770 (see Section \refersec{chap:normalandpartialcompilationunitentries}).
2771
2772 \textit{In the case of a compilation unit where all of the machine
2773 code is contained in a single contiguous section, no base
2774 address selection entry is needed.}
2775
2776 Address range entries in
2777 a \addtoindex{range list} may not overlap.
2778 There is no requirement that
2779 the entries be ordered in any particular way.
2780
2781 \needlines{5}
2782 A base address selection entry consists of:
2783 \begin{enumerate}[1. ]
2784 \item The value of the largest representable address offset (for example, \wffffffff when the size of
2785 an address is 32 bits).
2786
2787 \item An address, which defines the appropriate base address for use in interpreting the beginning
2788 and ending address offsets of subsequent entries of the location list.
2789 \end{enumerate}
2790 \textit{A base address selection entry 
2791 affects only the list in which it is contained.}
2792
2793
2794 The end of any given \addtoindex{range list} is marked by an 
2795 \addtoindexx{end-of-list entry!in range list}
2796 end-of-list entry, 
2797 which consists of a 0 for the beginning address
2798 offset and a 0 for the ending address offset. 
2799 A \addtoindex{range list}
2800 containing only an end-of-list entry describes an empty scope
2801 (which contains no instructions).
2802
2803 \textit{A base address selection entry and an 
2804 \addtoindexx{end-of-list entry!in range list}
2805 end-of-list entry for
2806 a \addtoindex{range list} 
2807 are identical to a base address selection entry
2808 and end-of-list entry, respectively, for a location list
2809 (see Section \refersec{chap:locationlists}) 
2810 in interpretation and representation.}
2811
2812
2813
2814 \section{Entry Address}
2815 \label{chap:entryaddress}
2816 \textit{The entry or first executable instruction generated
2817 for an entity, if applicable, is often the lowest addressed
2818 instruction of a contiguous range of instructions. In other
2819 cases, the entry address needs to be specified explicitly.}
2820
2821 Any debugging information entry describing an entity that has
2822 a range of code addresses, which includes compilation units,
2823 module initialization, subroutines, 
2824 \livelink{chap:lexicalblock}{lexical \nolink{blocks}},
2825 \livelink{chap:tryandcatchblockentries}{try/catch \nolink{blocks}},
2826 and the like, may have a \DWATentrypcNAME{} attribute to
2827 indicate the first executable instruction within that 
2828 range\hypertarget{chap:entryaddressofscope}{}
2829 of addresses. The value of the \DWATentrypcNAME{} attribute is a
2830 relocated address if the
2831 value of \DWATentrypcNAME{} is of class address; or if it is of class
2832 constant, the value is an unsigned integer offset which, when
2833 added to the base address of the function, gives the entry
2834 address. 
2835
2836 The base address of the containing scope is given by either the
2837 \DWATlowpc{} attribute, or the first range entry in the list of
2838 ranges given by the \DWATranges{} attribute. 
2839 If no \DWATentrypcNAME{} attribute is present,
2840 then the entry address is assumed to be the same as the
2841 value of the \DWATlowpc{} attribute, if present; otherwise,
2842 the entry address is unknown.
2843
2844 \section{Static and Dynamic Values of Attributes}
2845 \label{chap:staticanddynamicvaluesofattributes}
2846
2847 Some attributes that apply to types specify a property (such
2848 as the lower bound of an array) that is an integer value,
2849 where the value may be known during compilation or may be
2850 computed dynamically during execution.
2851
2852 \needlines{5}
2853 The value of these
2854 attributes is determined based on the class as follows:
2855 \begin{itemize}
2856 \item For a \livelink{chap:classconstant}{constant}, the value of the constant is the value of
2857 the attribute.
2858
2859 \item For a \livelink{chap:classreference}{reference}, the
2860 value is a reference to another DIE.  This DIE may:
2861 \begin{itemize}
2862 \renewcommand{\itemsep}{0cm}
2863 \item describe a constant which is the attribute value,
2864 \item describe a variable which contains the attribute value, or
2865 \item contain a DWARF expression which computes the attribute value
2866       (for example, be a \DWTAGdwarfprocedure{} entry).
2867 \end{itemize}
2868
2869 \item For an \livelink{chap:classexprloc}{exprloc}, the value is interpreted as a 
2870 DWARF expression; 
2871 evaluation of the expression yields the value of
2872 the attribute.
2873 \end{itemize}
2874
2875 \textit{%
2876 Whether an attribute value can be dynamic depends on the
2877 rules of the applicable programming language.
2878 }
2879
2880 \textit{The applicable attributes include: 
2881 \DWATallocated,
2882 \DWATassociated, 
2883 %\DWATbitoffset, 
2884 \DWATbitsize,
2885 \DWATbitstride,
2886 \DWATbytesize,
2887 \DWATbytestride, 
2888 \DWATcount, 
2889 \DWATlowerbound,
2890 \DWATrank,
2891 \DWATupperbound,
2892 and possibly others.}
2893
2894 \needlines{4}
2895 \section{Entity Descriptions}
2896 \textit{Some debugging information entries may describe entities
2897 in the program that are artificial, or which otherwise have a 
2898 \doublequote{name} that is not a valid identifier in the
2899 programming language. For example, several languages may
2900 capture or freeze the value of a variable at a particular
2901 point in the program. 
2902 \addtoindex{Ada} 95 has package elaboration routines,
2903 type descriptions of the form \texttt{typename\textquoteright Class}, and 
2904 \doublequote{access typename} parameters.  }
2905
2906 Generally, any debugging information
2907 entry that 
2908 \hypertarget{chap:DWATdescriptionartificialnameordescription}{}
2909 has, or may have, 
2910 \addtoindexx{name attribute}
2911
2912 \DWATname{} attribute, may
2913 also have 
2914 \addtoindexx{description attribute}
2915
2916 \DWATdescription{} attribute whose value is a
2917 null-terminated string providing a description of the entity.
2918
2919
2920 \textit{It is expected that a debugger will only display these
2921 descriptions as part of the description of other entities. It
2922 should not accept them in expressions, nor allow them to be
2923 assigned, or the like.}
2924
2925 \needlines{4}
2926 \section{Byte and Bit Sizes}
2927 \label{chap:byteandbitsizes}
2928 % Some trouble here with hbox full, so we try optional word breaks.
2929 Many debugging information entries allow either a
2930 \DWATbytesize{} attribute or a 
2931 \DWATbitsize{} attribute,
2932 whose \livelink{chap:classconstant}{integer constant} value 
2933 (see Section \ref{chap:staticanddynamicvaluesofattributes}) 
2934 specifies an
2935 amount of storage. The value of the 
2936 \DWATbytesize{} attribute
2937 is interpreted in bytes and the value of the 
2938 \DWATbitsize{}
2939 attribute is interpreted in bits. The
2940 \DWATstringlengthbytesize{} and 
2941 \DWATstringlengthbitsize{} 
2942 attributes are similar.
2943
2944 In addition, the \livelink{chap:classconstant}{integer constant}
2945 value of a \DWATbytestride{} attribute is interpreted
2946 in bytes and the \livelink{chap:classconstant}{integer constant} value of a 
2947 \DWATbitstride{}
2948 attribute is interpreted in bits.
2949
2950 \section{Linkage Names}
2951 \label{chap:linkagenames}
2952 \textit{Some language implementations, notably 
2953 \addtoindex{C++} and similar
2954 languages, 
2955 make use of implementation-defined names within
2956 object files that are different from the identifier names
2957 (see Section \refersec{chap:identifiernames}) of entities as they appear in the
2958 source. Such names, sometimes known 
2959 \addtoindexx{names!mangled}
2960 as 
2961 \addtoindex{mangled names},
2962 are used in various ways, such as: to encode additional
2963 information about an entity, to distinguish multiple entities
2964 that have the same name, and so on. When an entity has an
2965 associated distinct linkage name it may sometimes be useful
2966 for a producer to include this name in the DWARF description
2967 of the program to facilitate consumer access to and use of
2968 object file information about an entity and/or information
2969 \hypertarget{chap:DWATlinkagenameobjectfilelinkagenameofanentity}{}
2970 that is encoded in the linkage name itself.  
2971 }
2972
2973 % Some trouble maybe with hbox full, so we try optional word breaks.
2974 A debugging
2975 information entry may have 
2976 \addtoindexx{linkage name attribute}
2977
2978 \DWATlinkagename{}
2979 attribute
2980 whose value is a null-terminated string describing the object
2981 file linkage name associated with the corresponding entity.
2982
2983 % Some trouble here with hbox full, so we try optional word breaks.
2984 \textit{Debugging information entries to which \DWATlinkagename{}
2985 may apply include: \DWTAGcommonblock, \DWTAGconstant,
2986 \DWTAGentrypoint, \DWTAGsubprogram{} 
2987 and \DWTAGvariable.
2988 }
2989
2990 \section{Template Parameters}
2991 \label{chap:templateparameters}
2992 \textit{In \addtoindex{C++}, a template is a generic definition of a class, function, member
2993 function, or typedef (alias).  A template has formal parameters that
2994 can be types or constant values; the class, function,
2995 member function, or typedef is instantiated differently for each
2996 distinct combination of type or value actual parameters.  DWARF does
2997 not represent the generic template definition, but does represent each
2998 instantiation.
2999 }
3000
3001 A debugging information entry that represents a 
3002 \addtoindex{template instantiation}
3003 will contain child entries describing the actual template parameters.
3004 The containing entry and each of its child entries reference a template
3005 parameter entry in any circumstance where the template definition
3006 referenced a formal template parameter.
3007
3008 A template type parameter is represented by a debugging information
3009 entry with the tag
3010 \addtoindexx{template type parameter entry}
3011 \DWTAGtemplatetypeparameterTARG. 
3012 A template value parameter is represented by a debugging information
3013 entry with the tag
3014 \addtoindexx{template value parameter entry}
3015 \DWTAGtemplatevalueparameterTARG.
3016 The actual template parameter entries appear in the same order as the 
3017 corresponding template formal parameter declarations in the 
3018 source program.
3019
3020 \needlines{4}
3021 A type or value parameter entry may have a \DWATname{} attribute, 
3022 \addtoindexx{name attribute}
3023 whose value is a
3024 null\dash terminated string containing the name of the corresponding 
3025 formal parameter as it appears in the source program.
3026 The entry may also have a 
3027 \DWATdefaultvalue{} attribute, which is a flag indicating 
3028 that the value corresponds to the default argument for the 
3029 template parameter.
3030
3031 A
3032 \addtoindexx{formal type parameter|see{template type parameter entry}}
3033 template type parameter entry has a
3034 \addtoindexx{type attribute}
3035 \DWATtype{} attribute
3036 describing the actual type by which the formal is replaced.
3037
3038 A template value parameter entry has a \DWATtype{} attribute 
3039 describing the type of the parameterized value.
3040 The entry also has an attribute giving the 
3041 actual compile-time or run-time constant value 
3042 of the value parameter for this instantiation.
3043 This can be a 
3044 \DWATconstvalue{}\livetarg{chap:DWATconstvaluetemplatevalueparameter}{} 
3045 attribute, whose
3046 value is the compile-time constant value as represented 
3047 on the target architecture. 
3048 Or, the attribute can be a \DWATlocation{} attribute, whose value is a 
3049 single location description for the run-time constant address.
3050
3051 \section{Alignment}
3052 \label{chap:alignment}
3053 \livetarg{chap:DWATalignmentnondefault}{}
3054 A debugging information entry may have a 
3055 \DWATalignment{} attribute\addtoindexx{alignment attribute}
3056 that describes the (non-default) alignment requirements of the entry.
3057 \DWATalignment{} has a positive, non-zero, integer constant value
3058 describing the strictest specified (non-default) alignment of the entity. 
3059 This constant describes the actual alignment used by the compiler.
3060 (If there are multiple alignments specified by the user, or if the 
3061 user specified an alignment the compiler could not satisfy, then 
3062 only the strictest alignment is added using this attribute.)
3063
3064 \textit{Debugging information entries to which \DWATalignment{} may 
3065 apply include (but are not limited to):
3066 \DWTAGarraytype, \DWTAGatomictype, \DWTAGbasetype, 
3067 \DWTAGclasstype, 
3068 \DWTAGcoarraytype, \DWTAGconsttype, \DWTAGdynamictype,
3069 \DWTAGenumerationtype, \DWTAGfiletype, \DWTAGinterfacetype,
3070 \DWTAGpackedtype, \DWTAGpointertype, \DWTAGptrtomembertype,
3071 \DWTAGreferencetype, \DWTAGrestricttype, \DWTAGrvaluereferencetype,
3072 \DWTAGsettype, \DWTAGsharedtype, \DWTAGstringtype, \DWTAGstructuretype,
3073 \DWTAGsubprogram, \DWTAGsubrangetype, \DWTAGsubroutinetype,
3074 \DWTAGthrowntype, \DWTAGtypedef, \DWTAGuniontype, and \DWTAGvariable.}
3075
3076
3077