Miscellaneous tweaks and repairs
[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:DWATcalldatalocationofcallsite}
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. Each element of the stack is the
764 \addtoindex{size of an address} on the target machine. 
765 The value on the
766 top of the stack after \doublequote{executing} the 
767 \addtoindex{DWARF expression}
768 is 
769 \addtoindexx{DWARF expression|see{location description}}
770 taken to be the result (the address of the object, the
771 value of the array bound, the length of a dynamic string,
772 the desired value itself, and so on).
773
774 \needlines{4}
775 \subsubsection{Literal Encodings}
776 \label{chap:literalencodings}
777 The 
778 \addtoindexx{DWARF expression!literal encodings}
779 following operations all push a value onto the DWARF
780 stack. 
781 \addtoindexx{DWARF expression!stack operations}
782 If the value of a constant in one of these operations
783 is larger than can be stored in a single stack element, the
784 value is truncated to the element size and the low\dash order bits
785 are pushed on the stack.
786 \begin{enumerate}[1. ]
787 \itembfnl{\DWOPlitzeroTARG, \DWOPlitoneTARG, \dots, \DWOPlitthirtyoneTARG}
788 The \DWOPlitnTARG{} operations encode the unsigned literal values
789 from 0 through 31, inclusive.
790
791 \itembfnl{\DWOPaddrTARG}
792 The \DWOPaddrNAME{} operation has a single operand that encodes
793 a machine address and whose size is the \addtoindex{size of an address}
794 on the target machine.
795
796 \itembfnl{\DWOPconstoneuTARG, \DWOPconsttwouTARG, \DWOPconstfouruTARG, \DWOPconsteightuTARG}
797 \DWOPconstnxMARK{}
798 The single operand of a \DWOPconstnuNAME{} operation provides a 1,
799 2, 4, or 8\dash byte unsigned integer constant, respectively.
800
801 \itembfnl{\DWOPconstonesTARG, \DWOPconsttwosTARG, \DWOPconstfoursTARG, \DWOPconsteightsTARG}
802 The single operand of a \DWOPconstnsNAME{} operation provides a 1,
803 2, 4, or 8\dash byte signed integer constant, respectively.
804
805 \itembfnl{\DWOPconstuTARG}
806 The single operand of the \DWOPconstuNAME{} operation provides
807 an unsigned LEB128\addtoindexx{LEB128!unsigned} integer constant.
808
809 \itembfnl{\DWOPconstsTARG}
810 The single operand of the \DWOPconstsNAME{} operation provides
811 a signed LEB128\addtoindexx{LEB128!unsigned} integer constant.
812
813 \needlines{4}
814 \itembfnl{\DWOPaddrxTARG}
815 The \DWOPaddrxNAME{} operation has a single operand that
816 encodes an unsigned LEB128\addtoindexx{LEB128!unsigned} value, 
817 which is a zero-based index into the \dotdebugaddr{} section, 
818 where a machine address is stored.
819 This index is relative to the value of the 
820 \DWATaddrbase{} attribute of the associated compilation unit.
821
822 \itembfnl{\DWOPconstxTARG}
823 The \DWOPconstxNAME{} operation has a single operand that
824 encodes an unsigned LEB128\addtoindexx{LEB128!unsigned} value, 
825 which is a zero-based
826 index into the \dotdebugaddr{} section, where a constant, the
827 size of a machine address, is stored.
828 This index is relative to the value of the 
829 \DWATaddrbase{} attribute of the associated compilation unit.
830
831 \needlines{3}
832 \textit{The \DWOPconstxNAME{} operation is provided for constants that
833 require link-time relocation but should not be
834 interpreted by the consumer as a relocatable address
835 (for example, offsets to thread-local storage).}
836
837 \end{enumerate}
838
839
840 \subsubsection{Register Based Addressing}
841 \label{chap:registerbasedaddressing}
842 The following operations push a value onto the stack that is
843 \addtoindexx{DWARF expression!register based addressing}
844 the result of adding the contents of a register to a given
845 signed offset.
846 \begin{enumerate}[1. ]
847 \itembfnl{\DWOPfbregTARG}
848 The \DWOPfbregTARG{} operation provides a 
849 signed LEB128\addtoindexx{LEB128!signed} offset
850 from the address specified by the location description in the
851 \DWATframebase{} attribute of the current function. (This
852 is typically a \doublequote{stack pointer} register plus or minus
853 some offset. On more sophisticated systems it might be a
854 location list that adjusts the offset according to changes
855 in the stack pointer as the PC changes.)
856
857 \itembfnl{\DWOPbregzeroTARG, \DWOPbregoneTARG, \dots, \DWOPbregthirtyoneTARG}
858 The single operand of the \DWOPbregnTARG{} 
859 operations provides
860 a signed LEB128\addtoindexx{LEB128!signed} offset from
861 the specified register.
862
863 \itembfnl{\DWOPbregxTARG{} }
864 The \DWOPbregxNAME{} operation has two operands: a register
865 which is specified by an unsigned LEB128\addtoindexx{LEB128!unsigned}
866 number, followed by a signed LEB128\addtoindexx{LEB128!signed} offset.
867
868 \end{enumerate}
869
870
871 \subsubsection{Stack Operations}
872 \label{chap:stackoperations}
873 The following 
874 \addtoindexx{DWARF expression!stack operations}
875 operations manipulate the DWARF stack. Operations
876 that index the stack assume that the top of the stack (most
877 recently added entry) has index 0.
878 \begin{enumerate}[1. ]
879 \itembfnl{\DWOPdupTARG}
880 The \DWOPdupTARG{} operation duplicates the value at the top of the stack.
881
882 \itembfnl{\DWOPdropTARG}
883 The \DWOPdropTARG{} operation pops the value at the top of the stack.
884
885 \itembfnl{\DWOPpickTARG}
886 The single operand of the \DWOPpickTARG{} operation provides a
887 1\dash byte index. A copy of the stack entry with the specified
888 index (0 through 255, inclusive) is pushed onto the stack.
889
890 \itembfnl{\DWOPoverTARG}
891 The \DWOPoverTARG{} operation duplicates the entry currently second
892 in the stack at the top of the stack. 
893 This is equivalent to
894 a \DWOPpick{} operation, with index 1.  
895
896 \itembfnl{\DWOPswapTARG}
897 The \DWOPswapTARG{} operation swaps the top two stack entries. 
898 The entry at the top of the
899 stack becomes the second stack entry, 
900 and the second entry becomes the top of the stack.
901
902 \itembfnl{\DWOProtTARG}
903 The \DWOProtTARG{} operation rotates the first three stack
904 entries. The entry at the top of the stack becomes the third
905 stack entry, the second entry becomes the top of the stack,
906 and the third entry becomes the second entry.
907
908 \itembfnl{\DWOPderefTARG}
909 The \DWOPderefTARG{} 
910 operation  pops the top stack entry and 
911 treats it as an address. The value
912 retrieved from that address is pushed. 
913 The size of the data retrieved from the 
914 \addtoindexi{dereferenced}{address!dereference operator}
915 address is the \addtoindex{size of an address} on the target machine.
916
917 \needlines{4}
918 \itembfnl{\DWOPderefsizeTARG}
919 The \DWOPderefsizeTARG{} operation behaves like the 
920 \DWOPderef{}
921 operation: it pops the top stack entry and treats it as an
922 address. The value retrieved from that address is pushed. In
923 the \DWOPderefsizeNAME{} operation, however, the size in bytes
924 of the data retrieved from the dereferenced address is
925 specified by the single operand. This operand is a 1\dash byte
926 unsigned integral constant whose value may not be larger
927 than the \addtoindex{size of an address} on the target machine. The data
928 retrieved is zero extended to the size of an address on the
929 target machine before being pushed onto the expression stack.
930
931 \needlines{7}
932 \itembfnl{\DWOPxderefTARG}
933 The \DWOPxderefTARG{} operation provides an extended dereference
934 mechanism. The entry at the top of the stack is treated as an
935 address. The second stack entry is treated as an \doublequote{address
936 space identifier} for those architectures that support
937 \addtoindexi{multiple}{address space!multiple}
938 address spaces. The top two stack elements are popped,
939 and a data item is retrieved through an implementation-defined
940 address calculation and pushed as the new stack top. The size
941 of the data retrieved from the 
942 \addtoindexi{dereferenced}{address!dereference operator}
943 address is the
944 \addtoindex{size of an address} on the target machine.
945
946 \itembfnl{\DWOPxderefsizeTARG}
947 The \DWOPxderefsizeTARG{} operation behaves like the
948 \DWOPxderef{} operation. The entry at the top of the stack is
949 treated as an address. The second stack entry is treated as
950 an \doublequote{address space identifier} for those architectures
951 that support 
952 \addtoindexi{multiple}{address space!multiple}
953 address spaces. The top two stack
954 elements are popped, and a data item is retrieved through an
955 implementation\dash defined address calculation and pushed as the
956 new stack top. In the \DWOPxderefsizeNAME{} operation, however,
957 the size in bytes of the data retrieved from the 
958 \addtoindexi{dereferenced}{address!dereference operator}
959 address is specified by the single operand. This operand is a
960 1\dash byte unsigned integral constant whose value may not be larger
961 than the \addtoindex{size of an address} on the target machine. The data
962 retrieved is zero extended to the \addtoindex{size of an address} on the
963 target machine before being pushed onto the expression stack.
964
965 \itembfnl{\DWOPpushobjectaddressTARG}
966 The \DWOPpushobjectaddressTARG{}
967 operation pushes the address
968 of the object currently being evaluated as part of evaluation
969 of a user presented expression. This object may correspond
970 to an independent variable described by its own debugging
971 information entry or it may be a component of an array,
972 structure, or class whose address has been dynamically
973 determined by an earlier step during user expression
974 evaluation.
975
976 \textit{This operator provides explicit functionality
977 (especially for arrays involving descriptors) that is analogous
978 to the implicit push of the base 
979 \addtoindexi{address}{address!implicit push of base}
980 of a structure prior to evaluation of a 
981 \DWATdatamemberlocation{} 
982 to access a data member of a structure. For an example, see 
983 Appendix \refersec{app:aggregateexamples}.}
984
985 \needlines{4}
986 \itembfnl{\DWOPformtlsaddressTARG}
987 The \DWOPformtlsaddressTARG{} 
988 operation pops a value from the stack, translates this
989 value into an address in the 
990 \addtoindexx{thread-local storage}
991 thread\dash local storage for a thread, and pushes the address 
992 onto the stack. 
993 The meaning of the value on the top of the stack prior to this 
994 operation is defined by the run-time environment.  If the run-time 
995 environment supports multiple thread\dash local storage 
996 \nolink{blocks} for a single thread, then the \nolink{block} 
997 corresponding to the executable or shared 
998 library containing this DWARF expression is used.
999    
1000 \textit{Some implementations of 
1001 \addtoindex{C} and \addtoindex{C++} support a
1002 thread\dash local storage class. Variables with this storage class
1003 have distinct values and addresses in distinct threads, much
1004 as automatic variables have distinct values and addresses in
1005 each function invocation. Typically, there is a single \nolink{block}
1006 of storage containing all thread\dash local variables declared in
1007 the main executable, and a separate \nolink{block} for the variables
1008 declared in each shared library. 
1009 Each thread\dash local variable can then be accessed in its block using an
1010 identifier. This identifier is typically an offset into the block and pushed
1011 onto the DWARF stack by one of the 
1012 \DWOPconstnx{} operations prior to the
1013 \DWOPformtlsaddress{} operation. 
1014 Computing the address of
1015 the appropriate \nolink{block} can be complex (in some cases, the
1016 compiler emits a function call to do it), and difficult
1017 to describe using ordinary DWARF location descriptions.
1018 Instead of    forcing complex thread-local storage calculations into 
1019 the DWARF expressions, the \DWOPformtlsaddress{} allows the consumer 
1020 to perform the computation based on the run-time environment.}
1021
1022 \needlines{4}
1023 \itembfnl{\DWOPcallframecfaTARG}
1024 The \DWOPcallframecfaTARG{} 
1025 operation pushes the value of the
1026 CFA, obtained from the Call Frame Information 
1027 (see Section \refersec{chap:callframeinformation}).
1028
1029 \textit{Although the value of \DWATframebase{}
1030 can be computed using other DWARF expression operators,
1031 in some cases this would require an extensive location list
1032 because the values of the registers used in computing the
1033 CFA change during a subroutine. If the 
1034 Call Frame Information 
1035 is present, then it already encodes such changes, and it is
1036 space efficient to reference that.}
1037 \end{enumerate}
1038
1039 \subsubsection{Arithmetic and Logical Operations}
1040 The 
1041 \addtoindexx{DWARF expression!arithmetic operations}
1042 following 
1043 \addtoindexx{DWARF expression!logical operations}
1044 provide arithmetic and logical operations. Except
1045 as otherwise specified, the arithmetic operations perform
1046 addressing arithmetic, that is, unsigned arithmetic that is
1047 performed modulo one plus the largest representable address
1048 (for example, 0x100000000 when the 
1049 \addtoindex{size of an address} is 32 bits). 
1050 Such operations do not cause an exception on overflow.
1051
1052 \needlines{4}
1053 \begin{enumerate}[1. ]
1054 \itembfnl{\DWOPabsTARG}
1055 The \DWOPabsTARG{} operation pops the top stack entry, interprets
1056 it as a signed value and pushes its absolute value. If the
1057 absolute value cannot be represented, the result is undefined.
1058
1059 \needlines{4}
1060 \itembfnl{\DWOPandTARG}
1061 The \DWOPandTARG{} operation pops the top two stack values, performs
1062 a bitwise and operation on the two, and pushes the result.
1063
1064 \itembfnl{\DWOPdivTARG}
1065 The \DWOPdivTARG{} operation pops the top two stack values, divides the former second entry by
1066 the former top of the stack using signed division, and pushes the result.
1067
1068 \itembfnl{\DWOPminusTARG}
1069 The \DWOPminusTARG{} operation pops the top two stack values, subtracts the former top of the
1070 stack from the former second entry, and pushes the result.
1071
1072 \itembfnl{\DWOPmodTARG}
1073 The \DWOPmodTARG{} operation pops the top two stack values and pushes the result of the
1074 calculation: former second stack entry modulo the former top of the stack.
1075
1076 \itembfnl{\DWOPmulTARG}
1077 The \DWOPmulTARG{} operation pops the top two stack entries, multiplies them together, and
1078 pushes the result.
1079
1080 \itembfnl{\DWOPnegTARG}
1081 The \DWOPnegTARG{} operation pops the top stack entry, interprets
1082 it as a signed value and pushes its negation. If the negation
1083 cannot be represented, the result is undefined.
1084
1085 \itembfnl{\DWOPnotTARG}
1086 The \DWOPnotTARG{} operation pops the top stack entry, and pushes
1087 its bitwise complement.
1088
1089 \itembfnl{\DWOPorTARG}
1090 The \DWOPorTARG{} operation pops the top two stack entries, performs
1091 a bitwise or operation on the two, and pushes the result.
1092
1093 \itembfnl{\DWOPplusTARG}
1094 The \DWOPplusTARG{} operation pops the top two stack entries,
1095 adds them together, and pushes the result.
1096
1097 \needlines{6}
1098 \itembfnl{\DWOPplusuconstTARG}
1099 The \DWOPplusuconstTARG{} operation pops the top stack entry,
1100 adds it to the unsigned LEB128\addtoindexx{LEB128!unsigned}
1101 constant operand and pushes the result.
1102
1103 \textit{This operation is supplied specifically to be
1104 able to encode more field offsets in two bytes than can be
1105 done with
1106 \doublequote{\DWOPlitn~\DWOPplus.}}
1107
1108 \needlines{3}
1109 \itembfnl{\DWOPshlTARG}
1110 The \DWOPshlTARG{} operation pops the top two stack entries,
1111 shifts the former second entry left (filling with zero bits)
1112 by the number of bits specified by the former top of the stack,
1113 and pushes the result.
1114
1115 \itembfnl{\DWOPshrTARG}
1116 The \DWOPshrTARG{} operation pops the top two stack entries,
1117 shifts the former second entry right logically (filling with
1118 zero bits) by the number of bits specified by the former top
1119 of the stack, and pushes the result.
1120
1121 \needlines{3}
1122 \itembfnl{\DWOPshraTARG}
1123 The \DWOPshraTARG{} operation pops the top two stack entries,
1124 shifts the former second entry right arithmetically (divide
1125 the magnitude by 2, keep the same sign for the result) by
1126 the number of bits specified by the former top of the stack,
1127 and pushes the result.
1128
1129 \itembfnl{\DWOPxorTARG}
1130 The \DWOPxorTARG{} operation pops the top two stack entries,
1131 performs a bitwise exclusive\dash or operation on the two, and
1132 pushes the result.
1133
1134 \end{enumerate}
1135
1136 \subsubsection{Control Flow Operations}
1137 \label{chap:controlflowoperations}
1138 The 
1139 \addtoindexx{DWARF expression!control flow operations}
1140 following operations provide simple control of the flow of a DWARF expression.
1141 \begin{enumerate}[1. ]
1142 \itembfnl{\DWOPleTARG, \DWOPgeTARG, \DWOPeqTARG, \DWOPltTARG, \DWOPgtTARG, \DWOPneTARG}
1143 The six relational operators each:
1144 \begin{itemize}
1145 \item pop the top two stack values,
1146
1147 \item compare the operands:
1148 \linebreak
1149 \textless~former second entry~\textgreater  \textless~relational operator~\textgreater \textless~former top entry~\textgreater
1150
1151 \item push the constant value 1 onto the stack 
1152 if the result of the operation is true or the
1153 constant value 0 if the result of the operation is false.
1154 \end{itemize}
1155
1156 Comparisons are performed as signed operations. The six
1157 operators are \DWOPleNAME{} (less than or equal to), \DWOPgeNAME{}
1158 (greater than or equal to), \DWOPeqNAME{} (equal to), \DWOPltNAME{} (less
1159 than), \DWOPgtNAME{} (greater than) and \DWOPneNAME{} (not equal to).
1160
1161 \needlines{6}
1162 \itembfnl{\DWOPskipTARG}
1163 \DWOPskipTARG{} is an unconditional branch. Its single operand
1164 is a 2\dash byte signed integer constant. The 2\dash byte constant is
1165 the number of bytes of the DWARF expression to skip forward
1166 or backward from the current operation, beginning after the
1167 2\dash byte constant.
1168
1169 \itembfnl{\DWOPbraTARG}
1170 \DWOPbraTARG{} is a conditional branch. Its single operand is a
1171 2\dash byte signed integer constant.  This operation pops the
1172 top of stack. If the value popped is not the constant 0,
1173 the 2\dash byte constant operand is the number of bytes of the
1174 DWARF expression to skip forward or backward from the current
1175 operation, beginning after the 2\dash byte constant.
1176
1177 % The following item does not correctly hyphenate leading
1178 % to an overfull hbox and a visible artifact. 
1179 % So we use \- to suggest hyphenation in this rare situation.
1180 \itembfnl{\DWOPcalltwoTARG, \DWOPcallfourTARG, \DWOPcallrefTARG}
1181 \DWOPcalltwoNAME, 
1182 \DWOPcallfourNAME, 
1183 and \DWOPcallrefNAME{} perform
1184 subroutine calls during evaluation of a DWARF expression or
1185 location description. 
1186 For \DWOPcalltwoNAME{} and \DWOPcallfourNAME{}, 
1187 the operand is the 2\dash~ or 4\dash byte unsigned offset, respectively,
1188 of a debugging information entry in the current compilation
1189 unit. The \DWOPcallrefNAME{} operator has a single operand. In the
1190 \thirtytwobitdwarfformat,
1191 the operand is a 4\dash byte unsigned value;
1192 in the \sixtyfourbitdwarfformat, it is an 8\dash byte unsigned value
1193 (see Section \refersec{datarep:32bitand64bitdwarfformats}). 
1194 The operand is used as the offset of a
1195 debugging information entry in a 
1196 \dotdebuginfo{}
1197 section which may be contained in a shared object or executable
1198 other than that containing the operator. For references from
1199 one shared object or executable to another, the relocation
1200 must be performed by the consumer.  
1201
1202 \textit{Operand interpretation of
1203 \DWOPcalltwo, \DWOPcallfour{} and \DWOPcallref{} is exactly like
1204 that for \DWFORMreftwo, \DWFORMreffour{} and \DWFORMrefaddr,
1205 respectively  
1206 (see Section  \refersec{datarep:attributeencodings}).  
1207 }
1208
1209 These operations transfer
1210 control of DWARF expression evaluation to 
1211 \addtoindexx{location attribute}
1212 the 
1213 \DWATlocation{}
1214 attribute of the referenced debugging information entry. If
1215 there is no such attribute, then there is no effect. Execution
1216 of the DWARF expression of 
1217 \addtoindexx{location attribute}
1218
1219 \DWATlocation{} attribute may add
1220 to and/or remove from values on the stack. Execution returns
1221 to the point following the call when the end of the attribute
1222 is reached. Values on the stack at the time of the call may be
1223 used as parameters by the called expression and values left on
1224 the stack by the called expression may be used as return values
1225 by prior agreement between the calling and called expressions.
1226 \end{enumerate}
1227
1228 \needlines{7}
1229 \subsubsection{Special Operations}
1230 There 
1231 \addtoindexx{DWARF expression!special operations}
1232 are these special operations currently defined:
1233 \begin{enumerate}[1. ]
1234 \itembfnl{\DWOPnopNAME}
1235 The \DWOPnopTARG{} operation is a place holder. It has no effect
1236 on the location stack or any of its values.
1237
1238 \itembfnl{\DWOPentryvalueNAME}
1239 The \DWOPentryvalueTARG{} operation pushes a value that had a known location
1240 upon entering the current subprogram.  It uses two operands: an 
1241 unsigned LEB128\addtoindexx{LEB128!unsigned} length, followed by 
1242 a block containing a DWARF expression or
1243 a simple register location description.  The length gives the length
1244 in bytes of the block.  If the block contains a register location
1245 description, \DWOPentryvalueNAME{} pushes the value that register had upon
1246 entering the current subprogram.  If the block contains a DWARF expression,
1247 the DWARF expression is evaluated as if it has been evaluated upon entering
1248 the current subprogram.  The DWARF expression should not assume any values
1249 being present on the DWARF stack initially and should result in exactly one
1250 value being pushed on the DWARF stack when completed.  That value is the value
1251 being pushed by the \DWOPentryvalueNAME{} operation.  
1252
1253 \DWOPpushobjectaddress{} is not meaningful inside of this DWARF operation.
1254
1255 \textit{The \DWOPentryvalueNAME{} operation can be used by consumers if they are able
1256 to find the call site in the caller function, unwind to it and the corresponding
1257 \DWTAGcallsiteparameter{} entry has \DWATcallvalue{} or
1258 \DWATcalldatavalue{} attributes that can be evaluated to find out the
1259 value a function parameter had on the first instruction in the function.
1260 Or non-interactive consumers which know what variables will need to be
1261 inspected ahead of running the debugged program could put breakpoint
1262 on the first instruction in functions where there is no other way to find
1263 some variable's value, but evaluating \DWOPentryvalueNAME{} operation.  The
1264 consumer can collect there the value of registers or memory referenced in
1265 \DWOPentryvalueNAME{} operations, then continue to breakpoints where the values
1266 of variables or parameters need to be inspected and use there the remembered
1267 register or memory values during \DWOPentryvalueNAME{} evaluation.
1268 }
1269
1270 \end{enumerate}
1271
1272 \subsection{Example Stack Operations}
1273 \textit {The 
1274 \addtoindexx{DWARF expression!examples}
1275 stack operations defined in 
1276 Section \refersec{chap:stackoperations}.
1277 are fairly conventional, but the following
1278 examples illustrate their behavior graphically.}
1279
1280 \begin{longtable}[c]{rrcrr} 
1281 \multicolumn{2}{c}{Before} & Operation & \multicolumn{2}{c}{After} \\
1282 \hline
1283 \endhead
1284 \endfoot
1285 0& 17& \DWOPdup{} &0 &17 \\
1286 1&   29& &  1 & 17 \\
1287 2& 1000 & & 2 & 29\\
1288 & & &         3&1000\\
1289
1290 & & & & \\
1291 0 & 17 & \DWOPdrop{} & 0 & 29 \\
1292 1 &29  &            & 1 & 1000 \\
1293 2 &1000& & &          \\
1294
1295 & & & & \\
1296 0 & 17 & \DWOPpick, 2 & 0 & 1000 \\
1297 1 & 29 & & 1&17 \\
1298 2 &1000& &2&29 \\
1299   &    & &3&1000 \\
1300
1301 & & & & \\
1302 0&17& \DWOPover&0&29 \\
1303 1&29& &  1&17 \\
1304 2&1000 & & 2&29\\
1305  &     & & 3&1000 \\
1306
1307 & & & & \\
1308 0&17& \DWOPswap{} &0&29 \\
1309 1&29& &  1&17 \\
1310 2&1000 & & 2&1000 \\
1311
1312 & & & & \\
1313 0&17&\DWOProt{} & 0 &29 \\
1314 1&29 & & 1 & 1000 \\
1315 2& 1000 & &  2 & 17 \\
1316 \end{longtable}
1317
1318 \section{Location Descriptions}
1319 \label{chap:locationdescriptions}
1320 \textit{Debugging information 
1321 \addtoindexx{location description}
1322 must 
1323 \addtoindexx{location description|see{\textit{also} DWARF expression}}
1324 provide consumers a way to find
1325 the location of program variables, determine the bounds
1326 of dynamic arrays and strings, and possibly to find the
1327 base address of a subroutine\textquoteright s stack frame or the return
1328 address of a subroutine. Furthermore, to meet the needs of
1329 recent computer architectures and optimization techniques,
1330 debugging information must be able to describe the location of
1331 an object whose location changes over the object\textquoteright s lifetime.}
1332
1333 Information about the location of program objects is provided
1334 by location descriptions. Location descriptions can be either
1335 of two forms:
1336 \begin{enumerate}[1. ]
1337 \item \textit{Single location descriptions}, 
1338 which 
1339 \addtoindexx{location description!single}
1340 are 
1341 \addtoindexx{single location description}
1342 a language independent representation of
1343 addressing rules of arbitrary complexity built from 
1344 DWARF expressions (See Section \refersec{chap:dwarfexpressions}) 
1345 and/or other
1346 DWARF operations specific to describing locations. They are
1347 sufficient for describing the location of any object as long
1348 as its lifetime is either static or the same as the 
1349 \livelink{chap:lexicalblock}{lexical block} that owns it, 
1350 and it does not move during its lifetime.
1351
1352 Single location descriptions are of two kinds:
1353 \begin{enumerate}[a) ]
1354 \item Simple location descriptions, which describe the location
1355 \addtoindexx{location description!simple}
1356 of one contiguous piece (usually all) of an object. A simple
1357 location description may describe a location in addressable
1358 memory, or in a register, or the lack of a location (with or
1359 without a known value).
1360
1361 \item  Composite location descriptions, which describe an
1362 \addtoindexx{location description!composite}
1363 object in terms of pieces each of which may be contained in
1364 part of a register or stored in a memory location unrelated
1365 to other pieces.
1366
1367 \end{enumerate}
1368
1369 \needlines{3}
1370 \item \textit{Location lists}, which are used to 
1371 \addtoindexx{location list}
1372 describe
1373 \addtoindexx{location description!use in location list}
1374 objects that have a limited lifetime or change their location
1375 during their lifetime. Location lists are described in
1376 Section \refersec{chap:locationlists} below.
1377
1378 \end{enumerate}
1379
1380 Location descriptions are distinguished in a context sensitive
1381 manner. As the value of an attribute, a location description
1382 is encoded using 
1383 \addtoindexx{exprloc class}
1384 class \livelink{chap:classexprloc}{exprloc}  
1385 and a location list is encoded
1386 using class \livelink{chap:classloclistptr}{loclistptr}
1387 (which 
1388 \addtoindex{loclistptr}
1389 serves as an offset into a
1390 separate 
1391 \addtoindexx{location list}
1392 location list table).
1393
1394
1395 \subsection{Single Location Descriptions}
1396 A single location description is either:
1397 \begin{enumerate}[1. ]
1398 \item A simple location description, representing an object
1399 \addtoindexx{location description!simple}
1400 which 
1401 \addtoindexx{simple location description}
1402 exists in one contiguous piece at the given location, or 
1403 \item A composite location description consisting of one or more
1404 \addtoindexx{location description!composite}
1405 simple location descriptions, each of which is followed by
1406 one composition operation. Each simple location description
1407 describes the location of one piece of the object; each
1408 composition operation describes which part of the object is
1409 located there. Each simple location description that is a
1410 DWARF expression is evaluated independently of any others
1411 (as though on its own separate stack, if any). 
1412 \end{enumerate}
1413
1414
1415
1416 \subsubsection{Simple Location Descriptions}
1417
1418
1419 \addtoindexx{location description!simple}
1420 simple location description consists of one 
1421 contiguous piece or all of an object or value.
1422
1423
1424 \subsubsubsection{Memory Location Descriptions}
1425
1426 \addtoindexx{location description!memory}
1427 memory location description 
1428 \addtoindexx{memory location description}
1429 consists of a non\dash empty DWARF
1430 expression (see 
1431 Section \refersec{chap:dwarfexpressions}
1432 ), whose value is the address of
1433 a piece or all of an object or other entity in memory.
1434
1435 \subsubsubsection{Register Location Descriptions}
1436 \label{chap:registerlocationdescriptions}
1437 A register location description consists of a register name
1438 operation, which represents a piece or all of an object
1439 located in a given register.
1440
1441 \textit{Register location descriptions describe an object
1442 (or a piece of an object) that resides in a register, while
1443 the opcodes listed in 
1444 Section \refersec{chap:registerbasedaddressing}
1445 are used to describe an object (or a piece of
1446 an object) that is located in memory at an address that is
1447 contained in a register (possibly offset by some constant). A
1448 register location description must stand alone as the entire
1449 description of an object or a piece of an object.
1450 }
1451
1452 The following DWARF operations can be used to name a register.
1453
1454
1455 \textit{Note that the register number represents a DWARF specific
1456 mapping of numbers onto the actual registers of a given
1457 architecture. The mapping should be chosen to gain optimal
1458 density and should be shared by all users of a given
1459 architecture. It is recommended that this mapping be defined
1460 by the ABI authoring committee for each architecture.
1461 }
1462 \begin{enumerate}[1. ]
1463 \itembfnl{\DWOPregzeroTARG, \DWOPregoneTARG, ..., \DWOPregthirtyoneTARG}
1464 The \DWOPregnTARG{} operations encode the names of up to 32
1465 registers, numbered from 0 through 31, inclusive. The object
1466 addressed is in register \textit{n}.
1467
1468 \needlines{4}
1469 \itembfnl{\DWOPregxTARG}
1470 The \DWOPregxTARG{} operation has a single 
1471 unsigned LEB128\addtoindexx{LEB128!unsigned} literal
1472 operand that encodes the name of a register.  
1473
1474 \end{enumerate}
1475
1476 \textit{These operations name a register location. To
1477 fetch the contents of a register, it is necessary to use
1478 one of the register based addressing operations, such as
1479 \DWOPbregx{} 
1480 (Section \refersec{chap:registerbasedaddressing})}.
1481
1482 \subsubsubsection{Implicit Location Descriptions}
1483 An \addtoindex{implicit location description}
1484 represents a piece or all
1485 \addtoindexx{location description!implicit}
1486 of an object which has no actual location but whose contents
1487 are nonetheless either known or known to be undefined.
1488
1489 The following DWARF operations may be used to specify a value
1490 that has no location in the program but is a known constant
1491 or is computed from other locations and values in the program.
1492
1493 The following DWARF operations may be used to specify a value
1494 that has no location in the program but is a known constant
1495 or is computed from other locations and values in the program.
1496 \begin{enumerate}[1. ]
1497 \itembfnl{\DWOPimplicitvalueTARG}
1498 The \DWOPimplicitvalueTARG{} 
1499 operation specifies an immediate value
1500 using two operands: an unsigned LEB128\addtoindexx{LEB128!unsigned}
1501 length, followed by
1502 %FIXME: should this block be a reference? To what?
1503 a \nolink{block} representing the value in the memory representation
1504 of the target machine. The length operand gives the length
1505 in bytes of the \nolink{block}.
1506
1507 \itembfnl{\DWOPstackvalueTARG}
1508 The \DWOPstackvalueTARG{} 
1509 operation specifies that the object
1510 does not exist in memory but its value is nonetheless known
1511 and is at the top of the DWARF expression stack. In this form
1512 of location description, the DWARF expression represents the
1513 actual value of the object, rather than its location. The
1514 \DWOPstackvalueNAME{} operation terminates the expression.
1515
1516 \itembfnl{\DWOPimplicitpointerTARG}
1517 The \DWOPimplicitpointerNAME{} operation specifies that the object
1518 is a pointer that cannot be represented as a real pointer,
1519 even though the value it would point to can be described. In
1520 this form of location description, the DWARF expression refers
1521 to a debugging information entry that represents the actual
1522 value of the object to which the pointer would point. Thus, a
1523 consumer of the debug information would be able to show the
1524 value of the dereferenced pointer, even when it cannot show
1525 the value of the pointer itself.
1526
1527 \needlines{5}
1528 The \DWOPimplicitpointerNAME{} operation has two operands: a 
1529 reference to a debugging information entry that describes 
1530 the dereferenced object's value, and a signed number that 
1531 is treated as a byte offset from the start of that value. 
1532 The first operand is a 4-byte unsigned value in the 32-bit 
1533 DWARF format, or an 8-byte unsigned value in the 64-bit 
1534 DWARF format (see Section 
1535 \refersec{datarep:32bitand64bitdwarfformats}).
1536 The second operand is a 
1537 signed LEB128\addtoindexx{LEB128!signed} number.
1538
1539 The first operand is used as the offset of a debugging
1540 information entry in a \dotdebuginfo{} section, which may be
1541 contained in a shared object or executable other than that
1542 containing the operator. For references from one shared object
1543 or executable to another, the relocation must be performed by
1544 the consumer.
1545
1546 \textit{The debugging information entry referenced by a 
1547 \DWOPimplicitpointerNAME{} operation is typically a
1548 \DWTAGvariable{} or \DWTAGformalparameter{} entry whose
1549 \DWATlocation{} attribute gives a second DWARF expression or a
1550 location list that describes the value of the object, but the
1551 referenced entry may be any entry that contains a \DWATlocation{}
1552 or \DWATconstvalue{} attribute (for example, \DWTAGdwarfprocedure).
1553 By using the second DWARF expression, a consumer can
1554 reconstruct the value of the object when asked to dereference
1555 the pointer described by the original DWARF expression
1556 containing the \DWOPimplicitpointer{} operation.}
1557
1558 \end{enumerate}
1559
1560 \textit{DWARF location expressions are intended to yield the \textbf{location}
1561 of a value rather than the value itself. An optimizing compiler
1562 may perform a number of code transformations where it becomes
1563 impossible to give a location for a value, but remains possible
1564 to describe the value itself. 
1565 Section \refersec{chap:registerlocationdescriptions}
1566 describes operators that can be used to
1567 describe the location of a value when that value exists in a
1568 register but not in memory. The operations in this section are
1569 used to describe values that exist neither in memory nor in a
1570 single register.}
1571
1572 \paragraph{Empty Location Descriptions}
1573
1574 An \addtoindex{empty location description}
1575 consists of a DWARF expression
1576 \addtoindexx{location description!empty}
1577 containing no operations. It represents a piece or all of an
1578 object that is present in the source but not in the object code
1579 (perhaps due to optimization).
1580
1581 \needlines{5}
1582 \subsubsection{Composite Location Descriptions}
1583 A composite location description describes an object or
1584 value which may be contained in part of a register or stored
1585 in more than one location. Each piece is described by a
1586 composition operation, which does not compute a value nor
1587 store any result on the DWARF stack. There may be one or
1588 more composition operations in a single composite location
1589 description. A series of such operations describes the parts
1590 of a value in memory address order.
1591
1592 Each composition operation is immediately preceded by a simple
1593 location description which describes the location where part
1594 of the resultant value is contained.
1595 \begin{enumerate}[1. ]
1596 \itembfnl{\DWOPpieceTARG}
1597 The \DWOPpieceTARG{} operation takes a 
1598 single operand, which is an
1599 unsigned LEB128\addtoindexx{LEB128!unsigned} number.  
1600 The number describes the size in bytes
1601 of the piece of the object referenced by the preceding simple
1602 location description. If the piece is located in a register,
1603 but does not occupy the entire register, the placement of
1604 the piece within that register is defined by the ABI.
1605
1606 \textit{Many compilers store a single variable in sets of registers,
1607 or store a variable partially in memory and partially in
1608 registers. \DWOPpieceNAME{} provides a way of describing how large
1609 a part of a variable a particular DWARF location description
1610 refers to. }
1611
1612 \itembfnl{\DWOPbitpieceTARG}
1613 The \DWOPbitpieceTARG{} 
1614 operation takes two operands. The first
1615 is an unsigned LEB128\addtoindexx{LEB128!unsigned} 
1616 number that gives the size in bits
1617 of the piece. The second is an 
1618 unsigned LEB128\addtoindexx{LEB128!unsigned} number that
1619 gives the offset in bits from the location defined by the
1620 preceding DWARF location description.  
1621
1622 Interpretation of the
1623 offset depends on the kind of location description. If the
1624 location description is empty, the offset doesn\textquoteright t matter and
1625 the \DWOPbitpieceNAME{} operation describes a piece consisting
1626 of the given number of bits whose values are undefined. If
1627 the location is a register, the offset is from the least
1628 significant bit end of the register. If the location is a
1629 memory address, the \DWOPbitpieceNAME{} operation describes a
1630 sequence of bits relative to the location whose address is
1631 on the top of the DWARF stack using the bit numbering and
1632 direction conventions that are appropriate to the current
1633 language on the target system. If the location is any implicit
1634 value or stack value, the \DWOPbitpieceNAME{} operation describes
1635 a sequence of bits using the least significant bits of that
1636 value.  
1637 \end{enumerate}
1638
1639 \textit{\DWOPbitpieceNAME{} is 
1640 used instead of \DWOPpieceNAME{} when
1641 the piece to be assembled into a value or assigned to is not
1642 byte-sized or is not at the start of a register or addressable
1643 unit of memory.}
1644
1645
1646
1647
1648 \subsubsection{Example Single Location Descriptions}
1649
1650 Here are some examples of how DWARF operations are used to form location descriptions:
1651 % Probably the only place that this will be used, so not in dwarf.tex?
1652 \newcommand{\descriptionitemnl}[1]{\item[#1]\mbox{}\\}
1653 \begin{description}
1654 \descriptionitemnl{\DWOPregthree}
1655 The value is in register 3.
1656
1657 \descriptionitemnl{\DWOPregx{} 54}
1658 The value is in register 54.
1659
1660 \descriptionitemnl{\DWOPaddr{} 0x80d0045c}
1661 The value of a static variable is at machine address 0x80d0045c.
1662
1663 \descriptionitemnl{\DWOPbregeleven{} 44}
1664 Add 44 to the value in register 11 to get the address of an automatic
1665 variable instance.
1666
1667 \needlines{4}
1668 \descriptionitemnl{\DWOPfbreg{} -50}
1669 Given a \DWATframebase{} value of
1670 \doublequote{\DWOPbregthirtyone{} 64,} this example
1671 computes the address of a local variable that is -50 bytes from a
1672 logical frame pointer that is computed by adding 64 to the current
1673 stack pointer (register 31).
1674
1675 \descriptionitemnl{\DWOPbregx{} 54 32 \DWOPderef}
1676 A call-by-reference parameter whose address is in the word 32 bytes
1677 from where register 54 points.
1678
1679 \needlines{4}
1680 \descriptionitemnl{\DWOPplusuconst{} 4}
1681 A structure member is four bytes from the start of the structure
1682 instance. The base address is assumed to be already on the stack.
1683
1684 \descriptionitemnl{\DWOPregthree{} \DWOPpiece{} 4 \DWOPregten{} \DWOPpiece{} 2}
1685 A variable whose first four bytes reside in register 3 and whose next
1686 two bytes reside in register 10.
1687
1688 \descriptionitemnl{\DWOPregzero{} \DWOPpiece{} 4 \DWOPpiece{} 4 \DWOPfbreg{} -12 \DWOPpiece{} 4}
1689 \vspace{-2\parsep}A twelve byte value whose first four bytes reside in register zero,
1690 whose middle four bytes are unavailable (perhaps due to optimization),
1691 and whose last four bytes are in memory, 12 bytes before the frame
1692 base.
1693
1694 \descriptionitemnl{\DWOPbregone{} 0 \DWOPbregtwo{} 0 \DWOPplus{} \DWOPstackvalue{} }
1695 Add the contents of r1 and r2 to compute a value. This value is the
1696 \doublequote{contents} of an otherwise anonymous location.
1697
1698 \needlines{4}
1699 \descriptionitemnl{\DWOPlitone{} \DWOPstackvalue{} \DWOPpiece{} 4 \DWOPbregthree{} 0 \DWOPbregfour{} 0}
1700 \vspace{-2\parsep}\descriptionitemnl{
1701 \hspace{0.5cm}\DWOPplus{} \DWOPstackvalue{} \DWOPpiece{} 4 \DWOPpiece{} 4}
1702 The object value is found in an anonymous (virtual) location whose
1703 value consists of two parts, given in memory address order: the 4 byte
1704 value 1 followed by the four byte value computed from the sum of the
1705 contents of r3 and r4.
1706
1707 \descriptionitemnl{\DWOPentryvalue{} 1 \DWOPregone{} \DWOPstackvalue }
1708 The value register 1 had upon entering the current subprogram.
1709
1710 \descriptionitemnl{\DWOPentryvalue{} 2 \DWOPbregone{} 0 \DWOPstackvalue }
1711 The value register 1 had upon entering the current subprogram (same as the previous example).
1712 %Both of these location descriptions evaluate to the value register 1 had upon
1713 %entering the current subprogram.
1714
1715 %FIXME: The following gets an undefined control sequence error for reasons unknown... 
1716 %\descriptionitemnl{\DWOPentryvalue{} 1 \DWOPregthirtyone{} \DWOPregone{} \DWOPadd{} \DWOPstackvalue }
1717 %The value register 31 had upon entering the current subprogram
1718 %plus the value register 1 currently has.
1719
1720 \descriptionitemnl{\DWOPentryvalue{} 3 \DWOPbregfour{} 16 \DWOPderef{} \DWOPstackvalue }
1721 %FIXME: similar undefined as just above
1722 %\descriptionitemnl{\DWOPentryvalue{} 6 \DWOPentryvalue{} 1 \DWOPregfour{} \DWOPplusuconst{} 16 \DWOPderef{} \DWOPstackvalue }
1723 %These two location expressions do the same thing, p
1724 Push the value of the
1725 memory location with the size of an address pointed to by the value of
1726 register 4 upon entering the current subprogram and add 16.
1727
1728 \end{description}
1729
1730
1731 \subsection{Location Lists}
1732 \label{chap:locationlists}
1733 There are two forms of location lists. The first form 
1734 is intended for use in other than a split DWARF object,
1735 while the second is intended for use in a split DWARF object
1736 (see Section \refersec{datarep:splitdwarfobjects}). The two
1737 forms are otherwise equivalent.
1738
1739 \textit{The form for split DWARF objects is new in \DWARFVersionV.}
1740
1741 \subsubsection{Location Lists in Non-split Objects}
1742 \label{chap:locationlistsinnonsplitobjects}
1743 Location lists 
1744 \addtoindexx{location list}
1745 are used in place of location expressions
1746 whenever the object whose location is being described
1747 can change location during its lifetime. 
1748 Location lists
1749 \addtoindexx{location list}
1750 are contained in a separate object file section called
1751 \dotdebugloc{}. A location list is indicated by a location
1752 attribute whose value is an offset from the beginning of
1753 the \dotdebugloc{} section to the first byte of the list for the
1754 object in question.
1755
1756 Each entry in a location list is either a location 
1757 \addtoindexi{list}{address selection|see{base address selection}} 
1758 entry,
1759
1760 \addtoindexi{base}{base address selection entry!in location list} 
1761 address selection entry, 
1762 \addtoindexx{location list!base address selection entry}
1763 or an 
1764 \addtoindexx{end of list entry!in location list}
1765 end of list entry.
1766
1767 A location list entry has two forms:
1768 a normal location list entry and a default location list entry.
1769
1770 \needlines{4}
1771 A \addtoindexx{location list!normal entry}
1772 normal location list entry consists of:
1773 \begin{enumerate}[1. ]
1774 \item A beginning address offset. 
1775 This address offset has the \addtoindex{size of an address} and is
1776 relative to the applicable base address of the compilation
1777 unit referencing this location list. It marks the beginning
1778 of the address 
1779 \addtoindexi{range}{address range!in location list} 
1780 over which the location is valid.
1781
1782 \item An ending address offset.  This address offset again
1783 has the \addtoindex{size of an address} and is relative to the applicable
1784 base address of the compilation unit referencing this location
1785 list. It marks the first address past the end of the address
1786 range over which the location is valid. The ending address
1787 must be greater than or equal to the beginning address.
1788
1789 \textit{A location list entry (but not a base address selection or 
1790 end of list entry) whose beginning
1791 and ending addresses are equal has no effect 
1792 because the size of the range covered by such
1793 an entry is zero.}
1794
1795 \item An unsigned 2-byte length describing the length of the location 
1796 description that follows.
1797
1798 \item A \addtoindex{single location description} 
1799 describing the location of the object over the range specified by
1800 the beginning and end addresses.
1801 \end{enumerate}
1802
1803 \needlines{5}
1804 The applicable base address of a normal
1805 location list entry is
1806 \addtoindexx{location list!base address selection entry}
1807 determined by the closest preceding base address selection
1808 entry (see below) in the same location list. If there is
1809 no such selection entry, then the applicable base address
1810 defaults to the base address of the compilation unit (see
1811 Section \refersec{chap:normalandpartialcompilationunitentries}).  
1812
1813 \textit{In the case of a compilation unit where all of
1814 the machine code is contained in a single contiguous section,
1815 no base address selection entry is needed.}
1816
1817 Address ranges defined by normal location list entries
1818 may overlap. When they do, they describe a
1819 situation in which an object exists simultaneously in more than
1820 one place. If all of the address ranges in a given location
1821 list do not collectively cover the entire range over which the
1822 object in question is defined, it is assumed that the object is
1823 not available for the portion of the range that is not covered.
1824
1825 A default location list entry consists of:
1826 \addtoindexx{location list!default entry}
1827 \begin{enumerate}[1. ]
1828 \item The value 0.
1829 \item The value of the largest representable address offset (for
1830       example, \wffffffff when the size of an address is 32 bits).
1831 \item A simple location description describing the location of the
1832       object when there is no prior normal location list entry
1833       that applies in the same location list.
1834 \end{enumerate}
1835
1836 A default location list entry is independent of any applicable
1837 base address (except to the extent to which base addresses
1838 affect prior normal location list entries).
1839
1840 A default location list entry must be the last location list
1841 entry of a location list except for the terminating end of list
1842 entry.
1843
1844 A default location list entry describes an unlimited number
1845 (zero, one or more) of address ranges, none of which overlap
1846 any of the address ranges defined earlier in the same location
1847 list. Further, all such address ranges have the same simple
1848 location.
1849
1850 \needlines{5}
1851 A base 
1852 \addtoindexi{address}{address selection|see{base address selection}}
1853 \addtoindexx{location list!base address selection entry}
1854 selection 
1855 \addtoindexi{entry}{base address selection entry!in location list}
1856 consists of:
1857 \begin{enumerate}[1. ]
1858 \item The value of the largest representable 
1859 address offset (for example, \wffffffff when the size of
1860 an address is 32 bits).
1861 \item An address, which defines the 
1862 appropriate base address for use in interpreting the beginning
1863 and ending address offsets of subsequent entries of the location list.
1864 \end{enumerate}
1865
1866 \textit{A base address selection entry 
1867 affects only the list in which it is contained.}
1868
1869 \needlines{5}
1870 The end of any given location list is marked by an 
1871 \addtoindexx{location list!end of list entry}
1872 end of list entry, which consists of a 0 for the beginning address
1873 offset and a 0 for the ending address offset. A location list
1874 containing only an 
1875 \addtoindexx{end of list entry!in location list}
1876 end of list entry describes an object that
1877 exists in the source code but not in the executable program.
1878
1879 Neither a base address selection entry nor an end of list
1880 entry includes a location description.
1881
1882 \textit{When a DWARF consumer is parsing and decoding a location
1883 list, it must recognize the beginning and ending address
1884 offsets of (0, 0) for an end of list entry and (0, \doublequote{-1}) for
1885 a default location list entry prior to applying any base
1886 address. Any other pair of offsets beginning with 0 is a
1887 valid normal location list entry. Next, it must recognize the
1888 beginning address offset of \doublequote{-1} for a base address selection
1889 entry prior to applying any base address. The current base
1890 address is not applied to the subsequent value (although there
1891 may be an underlying object language relocation that affects
1892 that value).}
1893
1894 \textit{A base address selection entry and an end of list
1895 entry for a location list are identical to a base address
1896 selection entry and end of list entry, respectively, for a
1897 \addtoindex{range list}
1898 (see Section \refersec{chap:noncontiguousaddressranges}) 
1899 in interpretation
1900 and representation.}
1901
1902 \subsubsection{Location Lists in Split Objects}
1903 \label{chap:locationlistsinsplitobjects}
1904 In a split DWARF object (see 
1905 Section \refersec{datarep:splitdwarfobjects}), 
1906 location lists are contained in the \dotdebuglocdwo{} section.
1907
1908 Each entry in the location list
1909 begins with a type code, which is a single unsigned byte that
1910 identifies the type of entry. There are five types of entries:
1911 \begin{enumerate}
1912 \itembfnl{\DWLLEendoflistentryTARG}
1913 This entry indicates the end of a location list, and
1914 contains no further data.
1915
1916 \itembfnl{\DWLLEbaseaddressselectionentryTARG}
1917 This entry contains an 
1918 unsigned LEB128\addtoindexx{LEB128!unsigned} value immediately
1919 following the type code. This value is the index of an
1920 address in the \dotdebugaddr{} section, which is then used as
1921 the base address when interpreting offsets in subsequent
1922 location list entries of type \DWLLEoffsetpairentry.
1923 This index is relative to the value of the 
1924 \DWATaddrbase{} attribute of the associated compilation unit.
1925
1926 \itembfnl{\DWLLEstartendentryTARG}
1927 This entry contains two unsigned LEB128\addtoindexx{LEB128!unsigned}
1928 values immediately following the type code. These values are the
1929 indices of two addresses in the \dotdebugaddr{} section.
1930 These indices are relative to the value of the 
1931 \DWATaddrbase{} attribute of the associated compilation unit.
1932 These indicate the starting and ending addresses,
1933 respectively, that define the address range for which
1934 this location is valid. The starting and ending addresses
1935 given by this type of entry are not relative to the
1936 compilation unit base address. A single location
1937 description follows the fields that define the address range.
1938
1939 \itembfnl{\DWLLEstartlengthentryTARG}
1940 This entry contains one unsigned LEB128\addtoindexx{LEB128!unsigned}
1941 value and a 4-byte
1942 unsigned value immediately following the type code. The
1943 first value is the index of an address in the \dotdebugaddr{}
1944 section, which marks the beginning of the address range
1945 over which the location is valid.
1946 This index is relative to the value of the 
1947 \DWATaddrbase{} attribute of the associated compilation unit.
1948 The starting address given by this
1949 type of entry is not relative to the compilation unit
1950 base address. The second value is the
1951 length of the range. A single location
1952 description follows the fields that define the address range.
1953
1954 \itembfnl{\DWLLEoffsetpairentryTARG}
1955 This entry contains two 4-byte unsigned values
1956 immediately following the type code. These values are the
1957 starting and ending offsets, respectively, relative to
1958 the applicable base address, that define the address
1959 range for which this location is valid. A single location
1960 description follows the fields that define the address range.
1961 \end{enumerate}
1962
1963
1964 \section{Types of Program Entities}
1965 \label{chap:typesofprogramentities}
1966 Any 
1967 \hypertarget{chap:DWATtypetypeofdeclaration}{}
1968 debugging information entry describing a declaration that
1969 has a type has 
1970 \addtoindexx{type attribute}
1971 a \DWATtype{} attribute, whose value is a
1972 reference to another debugging information entry. The entry
1973 referenced may describe a base type, that is, a type that is
1974 not defined in terms of other data types, or it may describe a
1975 user-defined type, such as an array, structure or enumeration.
1976 Alternatively, the entry referenced may describe a type
1977 modifier, such as constant, packed, pointer, reference or
1978 volatile, which in turn will reference another entry describing
1979 a type or type modifier (using 
1980 \addtoindexx{type attribute}
1981 a \DWATtype{} attribute of its
1982 own). See 
1983 Section  \referfol{chap:typeentries} 
1984 for descriptions of the entries describing
1985 base types, user-defined types and type modifiers.
1986
1987
1988
1989 \section{Accessibility of Declarations}
1990 \label{chap:accessibilityofdeclarations}
1991 \textit{Some languages, notably \addtoindex{C++} and 
1992 \addtoindex{Ada}, have the concept of
1993 the accessibility of an object or of some other program
1994 entity. The accessibility specifies which classes of other
1995 program objects are permitted access to the object in question.}
1996
1997 The accessibility of a declaration is 
1998 \hypertarget{chap:DWATaccessibilitycandadadeclarations}{}
1999 represented by a 
2000 \DWATaccessibility{} 
2001 attribute, whose
2002 \addtoindexx{accessibility attribute}
2003 value is a constant drawn from the set of codes listed in Table 
2004 \refersec{tab:accessibilitycodes}.
2005
2006 \begin{simplenametable}[1.9in]{Accessibility codes}{tab:accessibilitycodes}
2007 \DWACCESSpublicTARG{}          \\
2008 \DWACCESSprivateTARG{}        \\
2009 \DWACCESSprotectedTARG{}    \\
2010 \end{simplenametable}
2011
2012 \section{Visibility of Declarations}
2013 \label{chap:visibilityofdeclarations}
2014
2015 \textit{Several languages (such as \addtoindex{Modula-2}) 
2016 have the concept of the visibility of a declaration. The
2017 visibility specifies which declarations are to be 
2018 visible outside of the entity in which they are
2019 declared.}
2020
2021 The 
2022 \hypertarget{chap:DWATvisibilityvisibilityofdeclaration}{}
2023 visibility of a declaration is represented 
2024 by a \DWATvisibility{}
2025 attribute\addtoindexx{visibility attribute}, whose value is a
2026 constant drawn from the set of codes listed in 
2027 Table \refersec{tab:visibilitycodes}.
2028
2029 \begin{simplenametable}[1.5in]{Visibility codes}{tab:visibilitycodes}
2030 \DWVISlocalTARG{}          \\
2031 \DWVISexportedTARG{}    \\
2032 \DWVISqualifiedTARG{}  \\
2033 \end{simplenametable}
2034
2035 \section{Virtuality of Declarations}
2036 \label{chap:virtualityofdeclarations}
2037 \textit{\addtoindex{C++} provides for virtual and pure virtual structure or class
2038 member functions and for virtual base classes.}
2039
2040 The 
2041 \hypertarget{chap:DWATvirtualityvirtualityindication}{}
2042 virtuality of a declaration is represented by a
2043 \DWATvirtuality{}
2044 attribute\addtoindexx{virtuality attribute}, whose value is a constant drawn
2045 from the set of codes listed in 
2046 Table \refersec{tab:virtualitycodes}.
2047
2048 \begin{simplenametable}[2.5in]{Virtuality codes}{tab:virtualitycodes}
2049 \DWVIRTUALITYnoneTARG{}                      \\
2050 \DWVIRTUALITYvirtualTARG{}                \\
2051 \DWVIRTUALITYpurevirtualTARG{}    \\
2052 \end{simplenametable}
2053
2054 \section{Artificial Entries}
2055 \label{chap:artificialentries}
2056 \textit{A compiler may wish to generate debugging information entries
2057 for objects or types that were not actually declared in the
2058 source of the application. An example is a formal parameter
2059 %FIXME: The word 'this' should be rendered like a variant italic,
2060 %FIXME: not as a quoted name. Changed to tt font--RB
2061 entry to represent the 
2062 \texttt{this} parameter\index{this parameter@\texttt{this} parameter}
2063 hidden \texttt{this} parameter that most \addtoindex{C++}
2064 implementations pass as the first argument to non-static member
2065 functions.}  
2066
2067 Any debugging information entry representing the
2068 \addtoindexx{artificial attribute}
2069 declaration of an object or type artificially generated by
2070 a compiler and not explicitly declared by the source program
2071 \hypertarget{chap:DWATartificialobjectsortypesthat}{}
2072 may have a 
2073 \DWATartificial{} attribute, 
2074 which is a \livelink{chap:classflag}{flag}.
2075
2076 \section{Segmented Addresses}
2077 \label{chap:segmentedaddresses}
2078 \textit{In some systems, addresses are specified as offsets within a
2079 given 
2080 \addtoindexx{address space!segmented}
2081 segment 
2082 \addtoindexx{segmented addressing|see{address space}}
2083 rather than as locations within a single flat
2084 \addtoindexx{address space!flat}
2085 address space.}
2086
2087 Any debugging information entry that contains a description
2088 \hypertarget{chap:DWATsegmentaddressinginformation}{}
2089 of the location of an object or subroutine may have a 
2090 \DWATsegment{} attribute, 
2091 \addtoindexx{segment attribute}
2092 whose value is a location
2093 description. The description evaluates to the segment selector
2094 of the item being described. If the entry containing the
2095 \DWATsegment{} attribute has a 
2096 \DWATlowpc, 
2097 \DWAThighpc,
2098 \DWATranges{} or 
2099 \DWATentrypc{} attribute, 
2100 \addtoindexx{entry pc attribute}
2101 or 
2102 a location
2103 description that evaluates to an address, then those address
2104 values represent the offset portion of the address within
2105 the segment specified 
2106 \addtoindexx{segment attribute}
2107 by \DWATsegment.
2108
2109 If an entry has no 
2110 \DWATsegment{} attribute, it inherits
2111 \addtoindexx{segment attribute}
2112 the segment value from its parent entry.  If none of the
2113 entries in the chain of parents for this entry back to
2114 its containing compilation unit entry have 
2115 \DWATsegment{} attributes, 
2116 then the entry is assumed to exist within a flat
2117 address space. 
2118 Similarly, if the entry has a 
2119 \DWATsegment{} attribute 
2120 \addtoindexx{segment attribute}
2121 containing an empty location description, that
2122 entry is assumed to exist within a 
2123 \addtoindexi{flat}{address space!flat}
2124 address space.
2125
2126 \textit{Some systems support different classes of 
2127 addresses
2128 \addtoindexx{address class!attribute}. 
2129 The
2130 address class may affect the way a pointer is dereferenced
2131 or the way a subroutine is called.}
2132
2133
2134 Any debugging information entry representing a pointer or
2135 reference type or a subroutine or subroutine type may 
2136 have a 
2137 \DWATaddressclass{}
2138 attribute, whose value is an integer
2139 constant.  The set of permissible values is specific to
2140 each target architecture. The value \DWADDRnoneTARG, 
2141 however,
2142 is common to all encodings, and means that no address class
2143 has been specified.
2144
2145 \textit {For example, the Intel386 \texttrademark\  processor might use the following values:}
2146
2147 \begin{table}[here]
2148 \caption{Example address class codes}
2149 \label{tab:inteladdressclasstable}
2150 \centering
2151 \begin{tabular}{l|c|l}
2152 \hline
2153 Name&Value&Meaning  \\
2154 \hline
2155 \textit{DW\_ADDR\_none}&   0 & \textit{no class specified} \\
2156 \textit{DW\_ADDR\_near16}& 1 & \textit{16\dash bit offset, no segment} \\
2157 \textit{DW\_ADDR\_far16}&  2 & \textit{16\dash bit offset, 16\dash bit segment} \\
2158 \textit{DW\_ADDR\_huge16}& 3 & \textit{16\dash bit offset, 16\dash bit segment} \\
2159 \textit{DW\_ADDR\_near32}& 4 & \textit{32\dash bit offset, no segment} \\
2160 \textit{DW\_ADDR\_far32}&  5 & \textit{32\dash bit offset, 16\dash bit segment} \\
2161 \hline
2162 \end{tabular}
2163 \end{table}
2164
2165 \needlines{6}
2166 \section{Non-Defining Declarations and Completions}
2167 \label{nondefiningdeclarationsandcompletions}
2168 A debugging information entry representing a program entity
2169 typically represents the defining declaration of that
2170 entity. In certain contexts, however, a debugger might need
2171 information about a declaration of an entity that is not
2172 \addtoindexx{incomplete declaration}
2173 also a definition, or is otherwise incomplete, to evaluate
2174 \hypertarget{chap:DWATdeclarationincompletenondefiningorseparateentitydeclaration}{}
2175 an expression correctly.
2176
2177 \needlines{10}
2178 \textit{As an example, consider the following fragment of \addtoindex{C} code:}
2179
2180 \begin{lstlisting}
2181 void myfunc()
2182 {
2183   int x;
2184   {
2185     extern float x;
2186     g(x);
2187   }
2188 }
2189 \end{lstlisting}
2190
2191
2192 \textit{\addtoindex{C} scoping rules require that the 
2193 value of the variable x passed to the function g is the value of the
2194 global variable x rather than of the local version.}
2195
2196 \subsection{Non-Defining Declarations}
2197 A debugging information entry that 
2198 represents a non-defining 
2199 \addtoindexx{non-defining declaration}
2200 or otherwise 
2201 \addtoindex{incomplete declaration}
2202 of a program entity has a
2203 \addtoindexx{declaration attribute}
2204 \DWATdeclaration{} attribute, which is a 
2205 \livelink{chap:classflag}{flag}.
2206
2207 \subsection{Declarations Completing Non-Defining Declarations}
2208 A debugging information entry that represents a 
2209 \hypertarget{chap:DWATspecificationincompletenondefiningorseparatedeclaration}{}
2210 declaration that completes another (earlier) 
2211 non\dash defining declaration may have a 
2212 \DWATspecification{}
2213 attribute whose value is a \livelink{chap:classreference}{reference} to
2214 the debugging information entry representing the non-defining declaration. A debugging
2215 information entry with a 
2216 \DWATspecification{} 
2217 attribute does not need to duplicate information
2218 provided by the debugging information entry referenced by that specification attribute.
2219
2220 When the non-defining declaration is contained within a type that has
2221 been placed in a separate type unit (see Section \refersec{chap:separatetypeunitentries}), 
2222 the \DWATspecification{} attribute cannot refer directly to the entry in
2223 the type unit. Instead, the current compilation unit may contain a
2224 \doublequote{skeleton} declaration of the type, which contains only the relevant
2225 declaration and its ancestors as necessary to provide the context
2226 (including containing types and namespaces). The \DWATspecification{}
2227 attribute would then be a reference to the declaration entry within
2228 the skeleton declaration tree. The debugging information entry for the
2229 top-level type in the skeleton tree may contain a \DWATsignature{}
2230 attribute whose value is the type signature 
2231 (see Section \refersec{datarep:typesignaturecomputation}).
2232
2233
2234 It is not the case that all attributes of the debugging information entry referenced by a
2235 \DWATspecification{} attribute 
2236 apply to the referring debugging information entry.
2237
2238 \textit{For 
2239 \addtoindexx{declaration attribute}
2240 example,
2241 \DWATsibling{} and 
2242 \DWATdeclaration{} 
2243 \addtoindexx{declaration attribute}
2244 clearly cannot apply to a 
2245 \addtoindexx{declaration attribute}
2246 referring
2247 \addtoindexx{sibling attribute}
2248 entry.}
2249
2250
2251
2252 \section{Declaration Coordinates}
2253 \label{chap:declarationcoordinates}
2254 \livetargi{chap:declarationcoordinates}{}{declaration coordinates}
2255 \textit{It is sometimes useful in a debugger to be able to associate
2256 a declaration with its occurrence in the program source.}
2257
2258 Any debugging information 
2259 \hypertarget{chap:DWATdeclfilefilecontainingsourcedeclaration}{}
2260 entry 
2261 \hypertarget{chap:DWATdecllinelinenumberofsourcedeclaration}{}
2262 representing 
2263 \hypertarget{chap:DWATdeclcolumncolumnpositionofsourcedeclaration}{}
2264 the
2265 \addtoindexx{line number of declaration}
2266 declaration of an object, module, subprogram or
2267 \addtoindex{declaration column attribute}
2268 type 
2269 \addtoindex{declaration file attribute}
2270 may 
2271 \addtoindex{declaration line attribute}
2272 have
2273 \DWATdeclfile, 
2274 \DWATdeclline{} and 
2275 \DWATdeclcolumn{}
2276 attributes each of whose value is an unsigned
2277 \livelink{chap:classconstant}{integer constant}.
2278
2279 The value of 
2280 \addtoindexx{declaration file attribute}
2281 the 
2282 \DWATdeclfile{}
2283 attribute 
2284 \addtoindexx{file containing declaration}
2285 corresponds to
2286 a file number from the line number information table for the
2287 compilation unit containing the debugging information entry and
2288 represents the source file in which the declaration appeared
2289 (see Section \refersec{chap:linenumberinformation}). 
2290 The value 0 indicates that no source file
2291 has been specified.
2292
2293 The value of 
2294 \addtoindexx{declaration line attribute}
2295 the \DWATdeclline{} attribute represents
2296 the source line number at which the first character of
2297 the identifier of the declared object appears. The value 0
2298 indicates that no source line has been specified.
2299
2300 The value of 
2301 \addtoindexx{declaration column attribute}
2302 the \DWATdeclcolumn{} attribute represents
2303 the source column number at which the first character of
2304 the identifier of the declared object appears. The value 0
2305 indicates that no column has been specified.
2306
2307 \section{Identifier Names}
2308 \label{chap:identifiernames}
2309 Any 
2310 \hypertarget{chap:DWATnamenameofdeclaration}{}
2311 debugging information entry 
2312 \addtoindexx{identifier names}
2313 representing 
2314 \addtoindexx{names!identifier}
2315 a program entity
2316 that has been given a name may have a 
2317 \DWATname{} attribute,
2318 whose 
2319 \addtoindexx{name attribute}
2320 value is a \livelink{chap:classstring}{string} 
2321 representing the name as it appears in
2322 the source program. A debugging information entry containing
2323 no name attribute, or containing a name attribute whose value
2324 consists of a name containing a single null byte, represents
2325 a program entity for which no name was given in the source.
2326
2327 \textit{Because the names of program objects described by DWARF are the
2328 names as they appear in the source program, implementations
2329 of language translators that use some form of mangled name
2330 \addtoindexx{mangled names}
2331 (as do many implementations of \addtoindex{C++}) should use the unmangled
2332 form of the name in the 
2333 DWARF \DWATname{} attribute,
2334 \addtoindexx{name attribute}
2335 including the keyword operator (in names such as \doublequote{operator +}),
2336 if present. See also 
2337 Section \referfol{chap:linkagenames} regarding the use
2338 of \DWATlinkagename{} for 
2339 \addtoindex{mangled names}.
2340 Sequences of
2341 multiple whitespace characters may be compressed.}
2342
2343 \section{Data Locations and DWARF Procedures}
2344 Any debugging information entry describing a data object (which
2345 \hypertarget{chap:DWATlocationdataobjectlocation}{}
2346 includes variables and parameters) or 
2347 \livelink{chap:commonblockentry}{common blocks}
2348 may have 
2349 \addtoindexx{location attribute}
2350 a
2351 \DWATlocation{} attribute,
2352 \addtoindexx{location attribute}
2353 whose value is a location description
2354 (see Section \refersec{chap:locationdescriptions}).
2355
2356 \needlines{4}
2357
2358 \addtoindex{DWARF procedure}
2359 is represented by any
2360 kind of debugging information entry that has 
2361 \addtoindexx{location attribute}
2362
2363 \DWATlocation{}
2364 attribute. 
2365 \addtoindexx{location attribute}
2366 If a suitable entry is not otherwise available,
2367 a DWARF procedure can be represented using a debugging
2368 \addtoindexx{DWARF procedure entry}
2369 information entry with the 
2370 tag \DWTAGdwarfprocedureTARG{}
2371 together with 
2372 \addtoindexx{location attribute}
2373 a \DWATlocation{} attribute.  
2374
2375 A DWARF procedure
2376 is called by a \DWOPcalltwo, 
2377 \DWOPcallfour{} or 
2378 \DWOPcallref{}
2379 DWARF expression operator 
2380 (see Section \refersec{chap:controlflowoperations}).
2381
2382 \needlines{5}
2383 \section{Code Addresses and Ranges}
2384 \label{chap:codeaddressesandranges}
2385 Any debugging information entry describing an entity that has
2386 a machine code address or range of machine code addresses,
2387 which includes compilation units, module initialization,
2388 \hypertarget{chap:DWATrangesnoncontiguousrangeofcodeaddresses}{}
2389 subroutines, ordinary \nolink{blocks}, 
2390 try/catch \nolink{blocks} (see Section\refersec{chap:tryandcatchblockentries}), 
2391 labels and the like, may have
2392 \begin{itemize}
2393 \item A \DWATlowpc{} attribute for
2394 \hypertarget{chap:DWATlowpccodeaddressorrangeofaddresses}{}
2395 a single address,
2396
2397 \item A \DWATlowpc{}
2398 \addtoindexx{low PC attribute}
2399 and 
2400 \DWAThighpc{}
2401 \addtoindexx{high PC attribute}
2402 \hypertarget{chap:DWAThighpccontiguousrangeofcodeaddresses}{}
2403 pair of attributes for 
2404 a single contiguous range of
2405 addresses, or
2406
2407 \item A \DWATranges{} attribute 
2408 \addtoindexx{ranges attribute}
2409 for a non-contiguous range of addresses.
2410 \end{itemize}
2411
2412 In addition, a non-contiguous range of 
2413 addresses may also be specified for the
2414 \DWATstartscope{} attribute.
2415 \addtoindexx{start scope attribute}
2416
2417 If an entity has no associated machine code, 
2418 none of these attributes are specified.
2419
2420 \subsection{Single Address} 
2421 When there is a single address associated with an entity,
2422 such as a label or alternate entry point of a subprogram,
2423 the entry has a \DWATlowpc{} attribute whose value is the
2424 relocated address for the entity.
2425
2426 \textit{While the \DWATentrypc{}
2427 attribute might also seem appropriate for this purpose,
2428 historically the \DWATlowpc{} attribute was used before the
2429 \DWATentrypc{} was introduced 
2430 (in \addtoindex{DWARF Version 3}). There is
2431 insufficient reason to change this.}
2432
2433 \needlines{8}
2434 \subsection{Continuous Address Range}
2435 \label{chap:contiguousaddressranges}
2436 When the set of addresses of a debugging information entry can
2437 be described as a single contiguous range, the entry 
2438 \addtoindexx{high PC attribute}
2439 may 
2440 \addtoindexx{low PC attribute}
2441 have
2442 a \DWATlowpc{} and 
2443 \DWAThighpc{} pair of attributes. 
2444 The value
2445 of the 
2446 \DWATlowpc{} attribute 
2447 is the relocated address of the
2448 first instruction associated with the entity. If the value of
2449 the \DWAThighpc{} is of class address, it is the relocated
2450 address of the first location past the last instruction
2451 associated with the entity; if it is of class constant, the
2452 value is an unsigned integer offset which when added to the
2453 low PC gives the address of the first location past the last
2454 instruction associated with the entity.
2455
2456 \textit{The high PC value
2457 may be beyond the last valid instruction in the executable.}
2458
2459 \needlines{5}
2460 The presence of low and high PC attributes for an entity
2461 implies that the code generated for the entity is contiguous
2462 and exists totally within the boundaries specified by those
2463 two attributes. If that is not the case, no low and high PC
2464 attributes should be produced.
2465
2466 \subsection{Non\dash Contiguous Address Ranges}
2467 \label{chap:noncontiguousaddressranges}
2468 When the set of addresses of a debugging information entry
2469 \addtoindexx{non-contiguous address ranges}
2470 cannot be described as a single contiguous range, the entry has
2471 a \DWATranges{} attribute 
2472 \addtoindexx{ranges attribute}
2473 whose value is of class \livelink{chap:classrangelistptr}{rangelistptr}
2474 and indicates the beginning of a \addtoindex{range list}.
2475 Similarly,
2476 a \DWATstartscope{} attribute 
2477 \addtoindexx{start scope attribute}
2478 may have a value of class
2479 \livelink{chap:classrangelistptr}{rangelistptr} for the same reason.  
2480
2481 Range lists are contained in a separate object file section called 
2482 \dotdebugranges{}. A
2483 \addtoindex{range list} is indicated by a 
2484 \DWATranges{} attribute whose
2485 \addtoindexx{ranges attribute}
2486 value is represented as an offset from the beginning of the
2487 \dotdebugranges{} section to the beginning of the 
2488 \addtoindex{range list}.
2489
2490 If the current compilation unit contains a \DWATrangesbase{}
2491 attribute, the value of that attribute establishes a base
2492 offset within the \dotdebugranges{} section for the compilation
2493 unit. The offset given by the \DWATranges{} attribute is
2494 relative to that base.
2495
2496 \textit{The \DWATrangesbase{} attribute is new in \addtoindex{DWARF Version 5}.
2497 The advantage of this attribute is that is reduces the number of
2498 object language relocations needed for references to the \dotdebugranges{}
2499 section from one for each reference to a single relocation that
2500 applies for the entire compilation unit.}
2501
2502 Each entry in a \addtoindex{range list} is either a 
2503 \addtoindex{range list} entry,
2504 \addtoindexx{base address selection entry!in range list}
2505 a base address selection entry, or an 
2506 \addtoindexx{end of list entry!in range list}
2507 end of list entry.
2508
2509 A \addtoindex{range list} entry consists of:
2510 \begin{enumerate}[1. ]
2511 \item A beginning address offset. This address offset has the 
2512 \addtoindex{size of an address} and is relative to
2513 the applicable base address of the compilation unit referencing this 
2514 \addtoindex{range list}. 
2515 It marks the
2516 beginning of an 
2517 \addtoindexi{address}{address range!in range list} 
2518 range.
2519
2520 \item An ending address offset. This address offset again has the 
2521 \addtoindex{size of an address} and is relative
2522 to the applicable base address of the compilation unit referencing 
2523 this \addtoindex{range list}.
2524 It marks the
2525 first address past the end of the address range.
2526 The ending address must be greater than or
2527 equal to the beginning address.
2528
2529 \textit{A \addtoindex{range list} entry (but not a base address selection or end of list entry) whose beginning and
2530 ending addresses are equal has no effect because the size of the range covered by such an
2531 entry is zero.}
2532 \end{enumerate}
2533
2534 The applicable base address of a \addtoindex{range list} entry
2535 is determined
2536 by the closest preceding base address selection entry (see
2537 below) in the same range list. If there is no such selection
2538 entry, then the applicable base address defaults to the base
2539 address of the compilation unit 
2540 (see Section \refersec{chap:normalandpartialcompilationunitentries}).
2541
2542 \textit{In the case of a compilation unit where all of the machine
2543 code is contained in a single contiguous section, no base
2544 address selection entry is needed.}
2545
2546 Address range entries in
2547 a \addtoindex{range list} may not overlap.
2548 There is no requirement that
2549 the entries be ordered in any particular way.
2550
2551 \needlines{5}
2552 A base address selection entry consists of:
2553 \begin{enumerate}[1. ]
2554 \item The value of the largest representable address offset (for example, \wffffffff when the size of
2555 an address is 32 bits).
2556
2557 \item An address, which defines the appropriate base address for use in interpreting the beginning
2558 and ending address offsets of subsequent entries of the location list.
2559 \end{enumerate}
2560 \textit{A base address selection entry 
2561 affects only the list in which it is contained.}
2562
2563
2564 The end of any given \addtoindex{range list} is marked by an 
2565 \addtoindexx{end of list entry!in range list}
2566 end of list entry, 
2567 which consists of a 0 for the beginning address
2568 offset and a 0 for the ending address offset. 
2569 A \addtoindex{range list}
2570 containing only an end of list entry describes an empty scope
2571 (which contains no instructions).
2572
2573 \textit{A base address selection entry and an 
2574 \addtoindexx{end of list entry!in range list}
2575 end of list entry for
2576 a \addtoindex{range list} 
2577 are identical to a base address selection entry
2578 and end of list entry, respectively, for a location list
2579 (see Section \refersec{chap:locationlists}) 
2580 in interpretation and representation.}
2581
2582
2583
2584 \section{Entry Address}
2585 \label{chap:entryaddress}
2586 \textit{The entry or first executable instruction generated
2587 for an entity, if applicable, is often the lowest addressed
2588 instruction of a contiguous range of instructions. In other
2589 cases, the entry address needs to be specified explicitly.}
2590
2591 Any debugging information entry describing an entity that has
2592 a range of code addresses, which includes compilation units,
2593 module initialization, subroutines, 
2594 ordinary \livelink{chap:lexicalblock}{block}, 
2595 try/catch \nolink{blocks} (see Section 
2596 \refersec{chap:tryandcatchblockentries}),
2597 and the like, may have a \DWATentrypcNAME{} attribute to
2598 indicate the first executable instruction within that range
2599 \hypertarget{chap:entryaddressofscope}{}
2600 of addresses. The value of the \DWATentrypcNAME{} attribute is a
2601 relocated address if the
2602 value of \DWATentrypcNAME{} is of class address; or if it is of class
2603 constant, the value is an unsigned integer offset which, when
2604 added to the base address of the function, gives the entry
2605 address. 
2606
2607 The base address of the containing scope is given by either the
2608 \DWATlowpc{} attribute, or the first range entry in the list of
2609 ranges given by the \DWATranges{} attribute. 
2610 If no \DWATentrypcNAME{} attribute is present,
2611 then the entry address is assumed to be the same as the
2612 value of the \DWATlowpc{} attribute, if present; otherwise,
2613 the entry address is unknown.
2614
2615 \section{Static and Dynamic Values of Attributes}
2616 \label{chap:staticanddynamicvaluesofattributes}
2617
2618 Some attributes that apply to types specify a property (such
2619 as the lower bound of an array) that is an integer value,
2620 where the value may be known during compilation or may be
2621 computed dynamically during execution.
2622
2623 The value of these
2624 attributes is determined based on the class as follows:
2625 \begin{itemize}
2626 \item For a \livelink{chap:classconstant}{constant}, the value of the constant is the value of
2627 the attribute.
2628
2629 \item For a \livelink{chap:classreference}{reference}, the
2630 value is a DWARF procedure that computes the value of the attribute.
2631
2632 \item For an \livelink{chap:classexprloc}{exprloc}, the value is interpreted as a 
2633 DWARF expression; 
2634 evaluation of the expression yields the value of
2635 the attribute.
2636 \end{itemize}
2637
2638 \textit{%
2639 Whether an attribute value can be dynamic depends on the
2640 rules of the applicable programming language.
2641 }
2642
2643 \textit{The applicable attributes include: 
2644 \DWATallocated,
2645 \DWATassociated, 
2646 \DWATbitoffset, 
2647 \DWATbitsize,
2648 \DWATbitstride,
2649 \DWATbytesize,
2650 \DWATbytestride, 
2651 \DWATcount, 
2652 \DWATlowerbound,
2653 \DWATrank,
2654 \DWATupperbound,
2655 (and possibly others).}
2656
2657 \needlines{4}
2658 \section{Entity Descriptions}
2659 \textit{Some debugging information entries may describe entities
2660 in the program that are artificial, or which otherwise are
2661 \doublequote{named} in ways which are not valid identifiers in the
2662 programming language. For example, several languages may
2663 capture or freeze the value of a variable at a particular
2664 point in the program. 
2665 \addtoindex{Ada} 95 has package elaboration routines,
2666 type descriptions of the form typename\textquoteright Class, and 
2667 \doublequote{access typename} parameters.  }
2668
2669 Generally, any debugging information
2670 entry that 
2671 \hypertarget{chap:DWATdescriptionartificialnameordescription}{}
2672 has, or may have, 
2673 \addtoindexx{name attribute}
2674
2675 \DWATname{} attribute, may
2676 also have 
2677 \addtoindexx{description attribute}
2678
2679 \DWATdescription{} attribute whose value is a
2680 null-terminated string providing a description of the entity.
2681
2682
2683 \textit{It is expected that a debugger will only display these
2684 descriptions as part of the description of other entities. It
2685 should not accept them in expressions, nor allow them to be
2686 assigned, or the like.}
2687
2688 \section{Byte and Bit Sizes}
2689 \label{chap:byteandbitsizes}
2690 % Some trouble here with hbox full, so we try optional word breaks.
2691 Many debugging information entries allow either a
2692 \DWATbytesize{} attribute or a 
2693 \DWATbitsize{} attribute,
2694 whose \livelink{chap:classconstant}{integer constant} value 
2695 (see Section \ref{chap:staticanddynamicvaluesofattributes}) 
2696 specifies an
2697 amount of storage. The value of the 
2698 \DWATbytesize{} attribute
2699 is interpreted in bytes and the value of the 
2700 \DWATbitsize{}
2701 attribute is interpreted in bits. The
2702 \DWATstringlengthbytesize{} and 
2703 \DWATstringlengthbitsize{} 
2704 attributes are similar.
2705
2706 In addition, the \livelink{chap:classconstant}{integer constant}
2707 value of a \DWATbytestride{} attribute is interpreted
2708 in bytes and the \livelink{chap:classconstant}{integer constant} value of a 
2709 \DWATbitstride{}
2710 attribute is interpreted in bits.
2711
2712 \section{Linkage Names}
2713 \label{chap:linkagenames}
2714 \textit{Some language implementations, notably 
2715 \addtoindex{C++} and similar
2716 languages, 
2717 make use of implementation-defined names within
2718 object files that are different from the identifier names
2719 (see Section \refersec{chap:identifiernames}) of entities as they appear in the
2720 source. Such names, sometimes known 
2721 \addtoindexx{names!mangled}
2722 as 
2723 \addtoindex{mangled names},
2724 are used in various ways, such as: to encode additional
2725 information about an entity, to distinguish multiple entities
2726 that have the same name, and so on. When an entity has an
2727 associated distinct linkage name it may sometimes be useful
2728 for a producer to include this name in the DWARF description
2729 of the program to facilitate consumer access to and use of
2730 object file information about an entity and/or information
2731 \hypertarget{chap:DWATlinkagenameobjectfilelinkagenameofanentity}{}
2732 that is encoded in the linkage name itself.  
2733 }
2734
2735 % Some trouble maybe with hbox full, so we try optional word breaks.
2736 A debugging
2737 information entry may have 
2738 \addtoindexx{linkage name attribute}
2739
2740 \DWATlinkagename{}
2741 attribute
2742 whose value is a null-terminated string describing the object
2743 file linkage name associated with the corresponding entity.
2744
2745 % Some trouble here with hbox full, so we try optional word breaks.
2746 \textit{Debugging information entries to which \DWATlinkagename{}
2747 may apply include: \DWTAGcommonblock, \DWTAGconstant,
2748 \DWTAGentrypoint, \DWTAGsubprogram{} 
2749 and \DWTAGvariable.
2750 }
2751
2752 \section{Template Parameters}
2753 \label{chap:templateparameters}
2754 \textit{
2755 In \addtoindex{C++}, a template is a generic definition of a class, function, member
2756 function, or typedef (alias).  A template has formal parameters that
2757 can be types or constant values; the class, function,
2758 member function, or typedef is instantiated differently for each
2759 distinct combination of type or value actual parameters.  DWARF does
2760 not represent the generic template definition, but does represent each
2761 instantiation.
2762 }
2763
2764 A debugging information entry that represents a 
2765 \addtoindex{template instantiation}
2766 will contain child entries describing the actual template parameters.
2767 The containing entry and each of its child entries reference a template
2768 parameter entry in any circumstance where the template definition
2769 referenced a formal template parameter.
2770
2771 A template type parameter is represented by a debugging information
2772 entry with the tag
2773 \addtoindexx{template type parameter entry}
2774 \DWTAGtemplatetypeparameterTARG. 
2775 A template value parameter is represented by a debugging information
2776 entry with the tag
2777 \addtoindexx{template value parameter entry}
2778 \DWTAGtemplatevalueparameterTARG.
2779 The actual template parameter entries appear in the same order as the 
2780 corresponding template formal parameter declarations in the 
2781 source program.
2782
2783 \needlines{4}
2784 A type or value parameter entry may have a \DWATname{} attribute, 
2785 \addtoindexx{name attribute}
2786 whose value is a
2787 null\dash terminated string containing the name of the corresponding 
2788 formal parameter as it appears in the source program.
2789 The entry may also have a 
2790 \DWATdefaultvalue{} attribute, which is a flag indicating 
2791 that the value corresponds to the default argument for the 
2792 template parameter.
2793
2794
2795 A
2796 \addtoindexx{formal type parameter|see{template type parameter entry}}
2797 template type parameter entry has a
2798 \addtoindexx{type attribute}
2799 \DWATtype{} attribute
2800 describing the actual type by which the formal is replaced.
2801
2802
2803 A template value parameter entry has a \DWATtype{} attribute 
2804 describing the type of the parameterized value.
2805 The entry also has an attribute giving the 
2806 actual compile-time or run-time constant value 
2807 of the value parameter for this instantiation.
2808 This can be a 
2809 \DWATconstvalue{}\livetarg{chap:DWATconstvaluetemplatevalueparameter}{} 
2810 attribute, whose
2811 value is the compile-time constant value as represented 
2812 on the target architecture. 
2813 Or, the attribute can be a \DWATlocation{} attribute, whose value is a 
2814 single location description for the run-time constant address.
2815