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