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