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