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