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