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