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