1c4fa2781ba281a7e7c5b458de90c23b64d65461
[dwarf-doc.git] / dwarf5 / latexdoc / generaldescription.tex
1 \chapter{General Description}
2 \label{chap:generaldescription}
3 \section{The Debugging Information Entry (DIE)}
4 \label{chap:thedebuggingentrydie}
5 DWARF 
6 \addtoindexx{debugging information entry}
7 uses 
8 \addtoindexx{DIE|see{debugging information entry}}
9 a series of debugging information entries (DIEs) to 
10 define a low-level
11 representation of a source program. 
12 Each debugging information entry consists of an identifying
13 \addtoindex{tag} and a series of 
14 \addtoindex{attributes}. 
15 An entry, or group of entries together, provide a description of a
16 corresponding 
17 \addtoindex{entity} in the source program. 
18 The tag specifies the class to which an entry belongs
19 and the attributes define the specific characteristics of the entry.
20
21 The set of tag names 
22 \addtoindexx{tag names|see{debugging information entry}}
23 is listed in Table \refersec{tab:tagnames}. 
24 The debugging information entries they identify are
25 described in Chapters 3, 4 and 5.
26
27 % These each need to link to definition page: FIXME
28
29 \begin{table}[p]
30 \caption{Tag names}
31 \label{tab:tagnames}
32 \simplerule[6in]
33 \autocols[0pt]{c}{2}{l}{
34 \DWTAGaccessdeclaration,
35 \DWTAGarraytype,
36 \DWTAGatomictype,
37 \DWTAGbasetype,
38 \DWTAGcallsite,
39 \DWTAGcallsiteparameter,
40 \DWTAGcatchblock,
41 \DWTAGclasstype,
42 \DWTAGcoarraytype,
43 \DWTAGcommonblock,
44 \DWTAGcommoninclusion,
45 \DWTAGcompileunit,
46 \DWTAGcondition,
47 \DWTAGconsttype,
48 \DWTAGconstant,
49 \DWTAGdwarfprocedure,
50 \DWTAGdynamictype,
51 \DWTAGentrypoint,
52 \DWTAGenumerationtype,
53 \DWTAGenumerator,
54 \DWTAGfiletype,
55 \DWTAGformalparameter,
56 \DWTAGfriend,
57 \DWTAGgenericsubrange,
58 \DWTAGimporteddeclaration,
59 \DWTAGimportedmodule,
60 \DWTAGimportedunit,
61 \DWTAGinheritance,
62 \DWTAGinlinedsubroutine,
63 \DWTAGinterfacetype,
64 \DWTAGlabel,
65 \DWTAGlexicalblock,
66 \DWTAGmodule,
67 \DWTAGmember,
68 \DWTAGnamelist,
69 \DWTAGnamelistitem,
70 \DWTAGnamespace,
71 \DWTAGpackedtype,
72 \DWTAGpartialunit,
73 \DWTAGpointertype,
74 \DWTAGptrtomembertype,
75 \DWTAGreferencetype,
76 \DWTAGrestricttype,
77 \DWTAGrvaluereferencetype,
78 \DWTAGsettype,
79 \DWTAGsharedtype,
80 \DWTAGstringtype,
81 \DWTAGstructuretype,
82 \DWTAGsubprogram,
83 \DWTAGsubrangetype,
84 \DWTAGsubroutinetype,
85 \DWTAGtemplatealias,
86 \DWTAGtemplatetypeparameter,
87 \DWTAGtemplatevalueparameter,
88 \DWTAGthrowntype,
89 \DWTAGtryblock,
90 \DWTAGtypedef,
91 \DWTAGtypeunit,
92 \DWTAGuniontype,
93 \DWTAGunspecifiedparameters,
94 \DWTAGunspecifiedtype,
95 \DWTAGvariable,
96 \DWTAGvariant,
97 \DWTAGvariantpart,
98 \DWTAGvolatiletype,
99 \DWTAGwithstmt
100 }
101 \simplerule[6in]
102 \end{table}
103
104
105 \textit{The debugging information entry descriptions 
106 in Sections 3, 4 and 5 generally include mention of
107 most, but not necessarily all, of the attributes 
108 that are normally or possibly used with the entry.
109 Some attributes, whose applicability tends to be 
110 pervasive and invariant across many kinds of
111 debugging information entries, are described in 
112 this section and not necessarily mentioned in all
113 contexts where they may be appropriate. 
114 Examples include 
115 \DWATartificial, 
116 the \livelink{chap:declarationcoordinates}{declaration coordinates}, and 
117 \DWATdescription, 
118 among others.}
119
120 The debugging information entries are contained in the 
121 \dotdebuginfo{} sections of an object file.
122
123 \needlines{7}
124 Optionally, debugging information may be partitioned such
125 that the majority of the debugging information can remain in
126 individual object files without being processed by the
127 linker. These debugging information entries are contained in
128 the \dotdebuginfodwo{} sections. These
129 sections may be placed in the object file but marked so that
130 the linker ignores them, or they may be placed in a separate
131 DWARF object file that resides alongside the normal object
132 file. See Section \refersec{datarep:splitdwarfobjects} and
133 Appendix \refersec{app:splitdwarfobjectsinformative} for details.
134
135
136 \section{Attribute Types}
137 \label{chap:attributetypes}
138 Each attribute value is characterized by an attribute name. 
139 \addtoindexx{attribute duplication}
140 No more than one attribute with a given name may appear in any
141 debugging information entry. 
142 There are no limitations on the
143 \addtoindexx{attribute ordering}
144 ordering of attributes within a debugging information entry.
145
146 The attributes are listed in Table \referfol{tab:attributenames}.  
147
148 \setlength{\extrarowheight}{0.1cm}
149 \addtoindexx{attributes!list of}
150 \begin{longtable}{l|p{9cm}}
151   \caption{Attribute names} \label{tab:attributenames} \\
152   \hline \bfseries Attribute&\bfseries Identifies or Specifies \\ \hline
153 \endfirsthead
154   \bfseries Attribute&\bfseries Identifies or Specifies \\ \hline
155 \endhead
156   \hline \emph{Continued on next page}
157 \endfoot
158   \hline
159 \endlastfoot
160 \DWATabstractoriginTARG
161 &\livelinki{chap:DWATabstractorigininlineinstance}{Inline instances of inline subprograms} {inline instances of inline subprograms} \\
162 % Heren livelink we cannot use \dash or \dash{}.
163 &\livelinki{chap:DWATabstractoriginoutoflineinstance}{Out-of-line instances of inline subprograms}{out-of-line instances of inline subprograms} \\
164 \DWATaccessibilityTARG
165 &\livelink{chap:DWATaccessibilitycandadadeclarations}{C++ and Ada declarations} \addtoindexx{Ada} \\
166 &\livelink{chap:DWATaccessibilitycppbaseclasses}{C++ base classes} \\
167 &\livelink{chap:DWATaccessibilitycppinheritedmembers}{C++ inherited members} \\
168 \DWATaddressclassTARG
169 &\livelinki{chap:DWATadressclasspointerorreferencetypes}{Pointer or reference types}{pointer or reference types}  \\
170 &\livelinki{chap:DWATaddressclasssubroutineorsubroutinetype}{Subroutine or subroutine type}{subroutine or subroutine type} \\
171 \DWATaddrbaseTARG
172 &\livelinki{chap:DWATaddrbaseforaddresstable}{Base offset for address table}{address table} \\
173 \DWATallocatedTARG
174 &\livelinki{chap:DWATallocatedallocationstatusoftypes}{Allocation status of types}{allocation status of types}  \\
175 \DWATartificialTARG
176 &\livelinki{chap:DWATartificialobjectsortypesthat}{Objects or types that are not actually declared in the source}{objects or types that are not actually declared in the source}  \\
177 \DWATassociatedTARG{} 
178 &\livelinki{chap:DWATassociatedassociationstatusoftypes}{Association status of types}{association status of types} \\
179 \DWATbasetypesTARG{} 
180 &\livelinki{chap:DWATbasetypesprimitivedatatypesofcompilationunit}{Primitive data types of compilation unit}{primitive data types of compilation unit} \\
181 \DWATbinaryscaleTARG{} 
182 &\livelinki{chap:DWATbinaryscalebinaryscalefactorforfixedpointtype}{Binary scale factor for fixed-point type}{binary scale factor for fixed-point type} \\
183 \DWATbitoffsetTARG{} 
184 &\livelinki{chap:DWATbitoffsetbasetypebitlocation}{Base type bit location}{base type bit location} \\
185 &\livelinki{chap:DWATbitoffsetdatamemberbitlocation}{Data member bit location}{data member bit location} \\
186 \DWATbitsizeTARG{} 
187 &\livelinki{chap:DWATbitsizebasetypebitsize}{Base type bit size}{base type bit size} \\
188 &\livelinki{chap:DWATbitsizedatamemberbitsize}{Data member bit size}{data member bit size} \\
189 \DWATbitstrideTARG{} 
190 &\livelinki{chap:DWATbitstridearrayelementstrideofarraytype}{Array element stride (of array type)}{array element stride (of array type)} \\
191 &\livelinki{chap:DWATbitstridesubrangestridedimensionofarraytype}{Subrange stride (dimension of array type)}{subrange stride (dimension of array type)} \\
192 &\livelinki{chap:DWATbitstrideenumerationstridedimensionofarraytype}{Enumeration stride (dimension of array type)}{enumeration stride (dimension of array type)} \\
193 \DWATbytesizeTARG{} 
194 &\livelinki{chap:DWATbytesizedataobjectordatatypesize}{Data object or data type size}{data object or data type size} \\
195 \DWATbytestrideTARG{} 
196 &\livelinki{chap:DWATbytestridearrayelementstrideofarraytype}{Array element stride (of array type)}{array element stride (of array type)} \\
197 &\livelinki{chap:DWATbytestridesubrangestridedimensionofarraytype}{Subrange stride (dimension of array type)}{subrange stride (dimension of array type)} \\
198 &\livelinki{chap:DWATbytestrideenumerationstridedimensionofarraytype}
199            {Enumeration stride (dimension of array type)}
200            {enumeration stride (dimension of array type)} \\
201 \DWATcallallcallsTARG{}
202 &\livelinki{chap:DWATcallallcallsofasubprogram}
203            {All tail and normal calls in a subprogram are described by call site entries}
204            {all tail and normal calls in a subprogram are described by call site entries}
205            \index{call site!summary!all tail and normal calls are described} \\
206 \DWATcallallsourcecallsTARG{}
207 &\livelinki{chap:DWATcallallsourcecallsofasubprogram}
208            {All tail, normal and inlined calls in a subprogram are described by call site and inlined subprogram entries}
209            {all tail calls in a subprogram are described by call site and inlined subprogram entries}
210            \index{call site!summary!all tail, normal and inlined calls are described} \\
211 \DWATcallalltailcallsTARG{}
212 &\livelinki{chap:DWATcallalltailcallsofasubprogram}
213            {All tail calls in a subprogram are described by call site entries}
214            {all tail calls in a subprogram are described by call site entries}
215            \index{call site!summary!all tail calls are described} \\
216 \DWATcallcolumnTARG{} 
217 &\livelinki{chap:DWATcallcolumncolumnpositionofinlinedsubroutinecall}
218            {Column position of inlined subroutine call}
219            {column position of inlined subroutine call} \\
220 \DWATcalldatalocationTARG{}
221 &\livelinki{chap:DWATcalldatalocationofcallparameter}
222            {Address of the value pointed to by an argument passed in a call}
223            {address of the value pointed to by an argument passed in a call}
224            \index{call site!address of the value pointed to by an argument} \\
225 \DWATcalldatavalueTARG{}
226 &\livelinki{chap:DWATcalldatavalueofcallparameter}
227            {Value pointed to by an argument passed in a call}
228            {value pointed to by an argument passed in a call}
229            \index{call site!value pointed to by an argument} \\
230 \DWATcallfileTARG
231 &\livelinki{chap:DWATcallfilefilecontaininginlinedsubroutinecall}
232            {File containing inlined subroutine call}
233            {file containing inlined subroutine call} \\
234 \DWATcalllineTARG{} 
235 &\livelinki{chap:DWATcalllinelinenumberofinlinedsubroutinecall}
236            {Line number of inlined subroutine call}
237            {line number of inlined subroutine call} \\
238 \DWATcallingconventionTARG{} 
239 &\livelinki{chap:DWATcallingconventionsubprogramcallingconvention}
240            {Subprogram calling convention}
241            {subprogram calling convention} \\
242 \DWATcalloriginTARG{}
243 &\livelinki{chap:DWATcalloriginofcallsite}
244            {Subprogram called in a call}
245            {subprogram called in a call}
246            \index{call site!subprogram called} \\
247 \DWATcallparameterTARG{}
248 &\livelinki{chap:DWATcallparameterofcallparameter}
249            {Parameter entry in a call}
250            {parameter entry in a call}
251            \index{call site!parameter entry} \\
252 \DWATcallpcTARG{}
253 &\livelinki{chap:DWATcallpcofcallsite}
254            {Address of the call instruction in a call}
255            {address of the call instruction in a call}
256            \index{call site!address of the call instruction} \\
257 \DWATcallreturnpcTARG{}
258 &\livelinki{chap:DWATcallreturnpcofcallsite}
259            {Return address from a call}
260            {return address from a call}
261            \index{call site!return address} \\
262 \DWATcalltailcallTARG{}
263 &\livelinki{chap:DWATcalltailcallofcallsite}
264            {Call is a tail call}
265            {call is a tail call}
266            \index{call site!tail call} \\
267 \DWATcalltargetTARG{}
268 &\livelinki{chap:DWATcalltargetofcallsite}
269            {Address of called routine in a call}
270            {address of called routine in a call}
271            \index{call site!address of called routine} \\
272 \DWATcalltargetclobberedTARG{}
273 &\livelinki{chap:DWATcalltargetclobberedofcallsite}
274            {Address of called routine, which may be clobbered, in a call}
275            {address of called routine, which may be clobbered, in a call}
276            \index{call site!address of called routine, which may be clobbered} \\
277 \DWATcallvalueTARG{}
278 &\livelinki{chap:DWATcallvalueofcallparameter}
279            {Argument value passed in a call}
280            {argument value passed in a call}
281            \index{call site!argument value passed} \\
282 \DWATcommonreferenceTARG
283 &\livelinki{chap:commonreferencecommonblockusage}{Common block usage}{common block usage} \\
284 \DWATcompdirTARG
285 &\livelinki{chap:DWATcompdircompilationdirectory}{Compilation directory}{compilation directory} \\
286 \DWATconstvalueTARG
287 &\livelinki{chap:DWATconstvalueconstantobject}{Constant object}{constant object} \\
288 &\livelinki{chap:DWATconstvalueenumerationliteralvalue}{Enumeration literal value}{enumeration literal value} \\
289 &\livelinki{chap:DWATconstvaluetemplatevalueparameter}{Template value parameter}{template value parameter} \\
290 \DWATconstexprTARG
291 &\livelinki{chap:DWATconstexprcompiletimeconstantobject}{Compile-time constant object}{compile-time constant object} \\
292 &\livelinki{chap:DWATconstexprcompiletimeconstantfunction}{Compile-time constant function}{compile-time constant function} \\
293 \DWATcontainingtypeTARG
294 &\livelinki{chap:DWATcontainingtypecontainingtypeofpointertomembertype}{Containing type of pointer to member type}{containing type of pointer to member type} \\
295 \DWATcountTARG
296 &\livelinki{chap:DWATcountelementsofsubrangetype}{Elements of subrange type}{elements ofbreg subrange type} \\
297 \DWATdatabitoffsetTARG
298 &\livelinki{chap:DWATdatabitoffsetbasetypebitlocation}{Base type bit location}{base type bit location} \\
299 &\livelinki{chap:DWATdatabitoffsetdatamemberbitlocation}{Data member bit location}{data member bit location} \\
300 \DWATdatalocationTARG{} 
301 &\livelinki{chap:DWATdatalocationindirectiontoactualdata}{Indirection to actual data}{indirection to actual data} \\
302 \DWATdatamemberlocationTARG
303 &\livelinki{chap:DWATdatamemberlocationdatamemberlocation}{Data member location}{data member location} \\
304 &\livelinki{chap:DWATdatamemberlocationinheritedmemberlocation}{Inherited member location}{inherited member location} \\
305 \DWATdecimalscaleTARG
306 &\livelinki{chap:DWATdecimalscaledecimalscalefactor}{Decimal scale factor}{decimal scale factor} \\
307 \DWATdecimalsignTARG
308 &\livelinki{chap:DWATdecimalsigndecimalsignrepresentation}{Decimal sign representation}{decimal sign representation} \\
309 \DWATdeclcolumnTARG
310 &\livelinki{chap:DWATdeclcolumncolumnpositionofsourcedeclaration}{Column position of source declaration}{column position of source declaration} \\
311 \DWATdeclfileTARG
312 &\livelinki{chap:DWATdeclfilefilecontainingsourcedeclaration}{File containing source declaration}{file containing source declaration} \\
313 \DWATdecllineTARG
314 &\livelinki{chap:DWATdecllinelinenumberofsourcedeclaration}{Line number of source declaration}{line number of source declaration} \\
315 \DWATdeclarationTARG
316 &\livelinki{chap:DWATdeclarationincompletenondefiningorseparateentitydeclaration}{Incomplete, non-defining, or separate entity declaration}{incomplete, non-defining, or separate entity declaration} \\
317 \DWATdefaultvalueTARG
318 &\livelinki{chap:DWATdefaultvaluedefaultvalueofparameter}{Default value of parameter}{default value of parameter} \\
319 \DWATdescriptionTARG{} 
320 &\livelinki{chap:DWATdescriptionartificialnameordescription}{Artificial name or description}{artificial name or description} \\
321 \DWATdigitcountTARG
322 &\livelinki{chap:DWATdigitcountdigitcountforpackeddecimalornumericstringtype}{Digit count for packed decimal or numeric string type}{digit count for packed decimal or numeric string type} \\
323 \DWATdiscrTARG
324 &\livelinki{chap:DWATdiscrdiscriminantofvariantpart}{Discriminant of variant part}{discriminant of variant part} \\
325 \DWATdiscrlistTARG
326 &\livelinki{chap:DWATdiscrlistlistofdiscriminantvalues}{List of discriminant values}{list of discriminant values} \\
327 \DWATdiscrvalueTARG
328 &\livelinki{chap:DWATdiscrvaluediscriminantvalue}{Discriminant value}{discriminant value} \\
329 \DWATdwoidTARG
330 &\livelinki{chap:DWATdwoidforunit}{Signature for compilation unit}{split DWARF object file!unit signature} \\
331 \DWATdwonameTARG
332 &\livelinki{chap:DWATdwonameforunit}{Name of split DWARF object file}{split DWARF object file!object file name} \\
333 \DWATelementalTARG
334 &\livelinki{chap:DWATelementalelementalpropertyofasubroutine}{Elemental property of a subroutine}{elemental property of a subroutine} \\
335 \DWATencodingTARG
336 &\livelinki{chap:DWATencodingencodingofbasetype}{Encoding of base type}{encoding of base type} \\
337 \DWATendianityTARG
338 &\livelinki{chap:DWATendianityendianityofdata}{Endianity of data}{endianity of data} \\
339 \DWATentrypcTARG
340 &\livelinki{chap:entryaddressofscope}{Entry address of a scope (compilation unit, \mbox{subprogram,} and so on)}{} \\
341 \DWATenumclassTARG
342 &\livelinki{chap:DWATenumclasstypesafeenumerationdefinition}{Type safe enumeration definition}{type safe enumeration definition}\\
343 \DWATexplicitTARG
344 &\livelinki{chap:DWATexplicitexplicitpropertyofmemberfunction}{Explicit property of member function}{explicit property of member function}\\
345 \DWATextensionTARG
346 &\livelinki{chap:DWATextensionpreviousnamespaceextensionororiginalnamespace}{Previous namespace extension or original namespace}{previous namespace extension or original namespace}\\
347 \DWATexternalTARG
348 &\livelinki{chap:DWATexternalexternalsubroutine}{External subroutine}{external subroutine} \\
349 &\livelinki{chap:DWATexternalexternalvariable}{External variable}{external variable} \\
350 \DWATframebaseTARG
351 &\livelinki{chap:DWATframebasesubroutineframebaseaddress}{Subroutine frame base address}{subroutine frame base address} \\
352 \DWATfriendTARG
353 &\livelinki{chap:DWATfriendfriendrelationship}{Friend relationship}{friend relationship} \\
354 \DWAThighpcTARG
355 &\livelinki{chap:DWAThighpccontiguousrangeofcodeaddresses}{Contiguous range of code addresses}{contiguous range of code addresses} \\
356 \DWATidentifiercaseTARG
357 &\livelinki{chap:DWATidentifiercaseidentifiercaserule}{Identifier case rule}{identifier case rule} \\
358 \DWATimportTARG
359 &\livelinki{chap:DWATimportimporteddeclaration}{Imported declaration}{imported declaration} \\
360 &\livelinki{chap:DWATimportimportedunit}{Imported unit}{imported unit} \\
361 &\livelinki{chap:DWATimportnamespacealias}{Namespace alias}{namespace alias} \\
362 &\livelinki{chap:DWATimportnamespaceusingdeclaration}{Namespace using declaration}{namespace using declaration} \\
363 &\livelinki{chap:DWATimportnamespaceusingdirective}{Namespace using directive}{namespace using directive} \\
364 \DWATinlineTARG
365 &\livelinki{chap:DWATinlineabstracttinstance}{Abstract instance}{abstract instance} \\
366 &\livelinki{chap:DWATinlineinlinedsubroutine}{Inlined subroutine}{inlined subroutine} \\
367 \DWATisoptionalTARG
368 &\livelinki{chap:DWATisoptionaloptionalparameter}{Optional parameter}{optional parameter} \\
369 \DWATlanguageTARG
370 &\livelinki{chap:DWATlanguageprogramminglanguage}{Programming language}{programming language} \\
371 \DWATlinkagenameTARG
372 &\livelinki{chap:DWATlinkagenameobjectfilelinkagenameofanentity}{Object file linkage name of an entity}{object file linkage name of an entity}\\
373 \DWATlocationTARG
374 &\livelinki{chap:DWATlocationdataobjectlocation}{Data object location}{data object location}\\
375 \DWATlowpcTARG
376 &\livelinki{chap:DWATlowpccodeaddressorrangeofaddresses}{Code address or range of addresses}{code address or range of addresses}\\
377 \DWATlowerboundTARG
378 &\livelinki{chap:DWATlowerboundlowerboundofsubrange}{Lower bound of subrange}{lower bound of subrange} \\
379 \DWATmacroinfoTARG
380 &\livelinki{chap:DWATmacroinfomacroinformation}{Macro information (for pre-\DWARFVersionV{} compatibility)} {macro information (legacy)} \\
381 \DWATmacrosTARG
382 &\livelinki{chap:DWATmacrosmacroinformation}{Macro information} {macro information} (\texttt{\#define}, \texttt{\#undef}, and so on)\\
383 \DWATmainsubprogramTARG
384 &\livelinki{chap:DWATmainsubprogrammainorstartingsubprogram}{Main or starting subprogram}{main or starting subprogram} \\
385 &\livelinki{chap:DWATmainsubprogramunitcontainingmainorstartingsubprogram}{Unit containing main or starting subprogram}{unit containing main or starting subprogram}\\
386 \DWATmutableTARG
387 &\livelinki{chap:DWATmutablemutablepropertyofmemberdata}{Mutable property of member data}{mutable property of member data} \\
388 \DWATnameTARG
389 &\livelinki{chap:DWATnamenameofdeclaration}{Name of declaration}{name of declaration}\\
390 &\livelinki{chap:DWATnamepathnameofcompilationsource}{Path name of compilation source}{path name of compilation source} \\
391 \DWATnamelistitemTARG
392 &\livelinki{chap:DWATnamelistitemnamelistitem}{Namelist item}{namelist item}\\
393 \DWATnoreturnTARG
394 &\livelinki{chap:DWATnoreturnofsubprogram}{\doublequote{no return} property of a subprogram}{noreturn attribute} \\
395 \DWATobjectpointerTARG
396 &\livelinki{chap:DWATobjectpointerobjectthisselfpointerofmemberfunction}{Object (\texttt{this}, \texttt{self}) pointer of member function}{object (\texttt{this}, \texttt{self}) pointer of member function}\\
397 \DWATorderingTARG
398 &\livelinki{chap:DWATorderingarrayrowcolumnordering}{Array row/column ordering} {array row/column ordering}\\
399 \DWATpicturestringTARG
400 &\livelinki{chap:DWATpicturestringpicturestringfornumericstringtype}{Picture string for numeric string type}{picture string for numeric string type} \\
401 \DWATpriorityTARG
402 &\livelinki{chap:DWATprioritymodulepriority}{Module priority}{module priority}\\
403 \DWATproducerTARG
404 &\livelinki{chap:DWATproducercompileridentification}{Compiler identification}{compiler identification}\\
405 \DWATprototypedTARG
406 &\livelinki{chap:DWATprototypedsubroutineprototype}{Subroutine prototype}{subroutine prototype}\\
407 \DWATpureTARG
408 &\livelinki{chap:DWATpurepurepropertyofasubroutine}{Pure property of a subroutine}{pure property of a subroutine} \\
409 \DWATrangesTARG
410 &\livelinki{chap:DWATrangesnoncontiguousrangeofcodeaddresses}{Non-contiguous range of code addresses}{non-contiguous range of code addresses} \\
411 \DWATrangesbaseTARG
412 &\livelinki{chap:DWATrangesbaseforrangelists}{Base offset for range lists}{Ranges lists} \\
413 \DWATrankTARG
414 &\livelinki{chap:DWATrankofdynamicarray}{Dynamic number of array dimensions}{dynamic number of array dimensions} \\
415 \DWATrecursiveTARG
416 &\livelinki{chap:DWATrecursiverecursivepropertyofasubroutine}{Recursive property of a subroutine}{recursive property of a subroutine} \\
417 \DWATreferenceTARG
418 &\livelink{chap:DWATreferenceofnonstaticmember}{\&-qualified non-static member function} \\
419 \DWATreturnaddrTARG
420 &\livelinki{chap:DWATreturnaddrsubroutinereturnaddresssavelocation}{Subroutine return address save location}{subroutine return address save location} \\
421 \DWATrvaluereferenceTARG
422 &\livelink{chap:DWATrvaluereferenceofnonstaticmember}{\&\&-qualified non-static member function} \\
423
424 \DWATsegmentTARG
425 &\livelinki{chap:DWATsegmentaddressinginformation}{Addressing information}{addressing information} \\
426 \DWATsiblingTARG
427 &\livelinki{chap:DWATsiblingdebugginginformationentryrelationship}{Debugging information entry relationship}{debugging information entry relationship} \\
428 \DWATsmallTARG
429 &\livelinki{chap:DWATsmallscalefactorforfixedpointtype}{Scale factor for fixed-point type}{scale factor for fixed-point type} \\
430 \DWATsignatureTARG
431 &\livelinki{chap:DWATsignaturetypesignature}{Type signature}{type signature}\\
432 \DWATspecificationTARG
433 &\livelinki{chap:DWATspecificationincompletenondefiningorseparatedeclaration}{Incomplete, non-defining, or separate declaration corresponding to a declaration}{incomplete, non-defining, or separate declaration corresponding to a declaration} \\
434 \DWATstartscopeTARG
435 &\livelinki{chap:DWATstartscopeobjectdeclaration}{Object declaration}{object declaration}\\
436 &\livelinki{chap:DWATstartscopetypedeclaration}{Type declaration}{type declaration}\\
437 \DWATstaticlinkTARG
438 &\livelinki{chap:DWATstaticlinklocationofuplevelframe}{Location of uplevel frame}{location of uplevel frame} \\
439 \DWATstmtlistTARG
440 &\livelinki{chap:DWATstmtlistlinenumberinformationforunit}{Line number information for unit}{line number information for unit}\\
441 \DWATstringlengthTARG
442 &\livelinki{chap:DWATstringlengthstringlengthofstringtype}{String length of string type}{string length of string type}
443  \\
444 \DWATstringlengthbitsizeTARG
445 &\livelinki{chap:DWATstringlengthstringlengthofstringtype}{Size of string length of string type}{string length of string type!size of}
446  \\
447 \DWATstringlengthbytesizeTARG
448 &\livelinki{chap:DWATstringlengthstringlengthofstringtype}{Size of string length of string type}{string length of string type!size of}
449  \\
450 \DWATstroffsetsbaseTARG
451 &\livelinki{chap:DWATstroffsetbaseforindirectstringtable}{Base of string offsets table}{string offsets table} \\
452 \DWATthreadsscaledTARG
453 &\livelink{chap:DWATthreadsscaledupcarrayboundthreadsscalfactor}{UPC array bound THREADS scale factor}\\
454 \DWATtrampolineTARG
455 &\livelinki{chap:DWATtrampolinetargetsubroutine}{Target subroutine}{target subroutine of trampoline} \\
456 \DWATtypeTARG
457 &\livelinki{chap:DWATtypeofcallsite}{Type of call site}{type!of call site} \\
458 &\livelinki{char:DWAATtypeofstringtype}{Type of string type components}{type!of string type components} \\
459 &\livelinki{chap:DWATtypetypeofsubroutinereturn}{Type of subroutine return}{type!of subroutine return} \\
460 &\livelinki{chap:DWATtypetypeofdeclaration}{Type of declaration}{type!of declaration} \\
461 \DWATupperboundTARG
462 &\livelinki{chap:DWATupperboundupperboundofsubrange}{Upper bound of subrange}{upper bound of subrange} \\
463 \DWATuselocationTARG
464 &\livelinki{chap:DWATuselocationmemberlocationforpointertomembertype}{Member location for pointer to member type}{member location for pointer to member type} \\
465 \DWATuseUTFeightTARG\addtoindexx{use UTF8 attribute}\addtoindexx{UTF-8}
466 &\livelinki{chap:DWATuseUTF8compilationunitusesutf8strings}{Compilation unit uses UTF-8 strings}{compilation unit uses UTF-8 strings} \\
467 \DWATvariableparameterTARG
468 &\livelinki{chap:DWATvariableparameternonconstantparameterflag}{Non-constant parameter flag}{non-constant parameter flag}  \\
469 \DWATvirtualityTARG
470 &\livelinki{chap:DWATvirtualityvirtualityindication}{Virtuality indication}{virtuality indication} \\
471 &\livelinki{chap:DWATvirtualityvirtualityofbaseclass}{Virtuality of base class} {virtuality of base class} \\
472 &\livelinki{chap:DWATvirtualityvirtualityoffunction}{Virtuality of function}{virtuality of function} \\
473 \DWATvisibilityTARG
474 &\livelinki{chap:DWATvisibilityvisibilityofdeclaration}{Visibility of declaration}{visibility of declaration} \\
475 \DWATvtableelemlocationTARG
476 &\livelinki{chap:DWATvtableelemlocationvirtualfunctiontablevtableslot}{Virtual function vtable slot}{virtual function vtable slot}\\
477 \end{longtable}
478
479 \addtoindexx{address|see {\textit{also} address class}}
480 \addtoindexx{addrptr|see {\textit{also} addrptr class}}
481 \addtoindexx{block|see {\textit{also} block class}}
482 \addtoindexx{constant|see {\textit{also} constant class}}
483 \addtoindexx{exprloc|see {\textit{also} exprloc class}}
484 \addtoindexx{flag|see {\textit{also} flag class}}
485 \addtoindexx{lineptr|see {\textit{also} lineptr class}}
486 \addtoindexx{loclistptr|see {\textit{also} loclistptr class}}
487 \addtoindexx{macptr|see {\textit{also} macptr class}}
488 \addtoindexx{rangelistptr|see {\textit{also} rangelistptr class}}
489 \addtoindexx{reference|see {\textit{also} reference class}}
490 \addtoindexx{string|see {\textit{also} string class}}
491 \addtoindexx{stroffsetsptr|see {\textit{also} stroffsetsptr class}}
492
493 \addtoindexx{class of attribute value!address|see {address class}}
494 \addtoindexx{class of attribute value!addrptr|see {addrptr class}}
495 \addtoindexx{class of attribute value!block|see {block class}}
496 \addtoindexx{class of attribute value!constant|see {constant class}}
497 \addtoindexx{class of attribute value!exprloc|see {exprloc class}}
498 \addtoindexx{class of attribute value!flag|see {flag class}}
499 \addtoindexx{class of attribute value!lineptr|see {lineptr class}}
500 \addtoindexx{class of attribute value!loclistptr|see {loclistptr class}}
501 \addtoindexx{class of attribute value!macptr|see {macptr class}}
502 \addtoindexx{class of attribute value!rangelistptr|see {rangelistptr class}}
503 \addtoindexx{class of attribute value!reference|see {reference class}}
504 \addtoindexx{class of attribute value!string|see {string class}}
505 \addtoindexx{class of attribute value!stroffsetsptr|see {stroffsetsptr class}}
506
507 The permissible values
508 \addtoindexx{attribute value classes}
509 for an attribute belong to one or more classes of attribute
510 value forms.  
511 Each form class may be represented in one or more ways. 
512 For example, some attribute values consist
513 of a single piece of constant data. 
514 \doublequote{Constant data}
515 is the class of attribute value that those attributes may have. 
516 There are several representations of constant data,
517 however (one, two, ,four, or eight bytes, and variable length
518 data). 
519 The particular representation for any given instance
520 of an attribute is encoded along with the attribute name as
521 part of the information that guides the interpretation of a
522 debugging information entry.  
523
524 Attribute value forms belong
525 \addtoindexx{tag names!list of}
526 to one of the classes shown in Table \referfol{tab:classesofattributevalue}.
527
528 \begin{longtable}{l|p{11cm}}
529 \caption{Classes of attribute value}
530 \label{tab:classesofattributevalue} \\
531 \hline \bfseries Attribute Class & \bfseries General Use and Encoding \\ \hline
532 \endfirsthead
533   \bfseries Attribute Class & \bfseries General Use and Encoding \\ \hline
534 \endhead
535   \hline \emph{Continued on next page}
536 \endfoot
537   \hline
538 \endlastfoot
539
540 \hypertarget{chap:classaddress}{}
541 \livelinki{datarep:classaddress}{address}{address class}
542 &Refers to some location in the address space of the described program.
543 \\
544
545 \hypertarget{chap:classaddrptr}{}
546 \livelinki{datarep:classaddrptr}{addrptr}{addrptr class}
547 &Refers to a base location in the DWARF section that holds
548 a series of machine address values. Certain attributes refer
549 one of these addresses by indexing relative to this base
550 location.
551 \\
552
553 \hypertarget{chap:classblock}{}
554 \livelinki{datarep:classblock}{block}{block class}
555 & An arbitrary number of uninterpreted bytes of data.
556 \\
557  
558 \hypertarget{chap:classconstant}{}
559 \livelinki{datarep:classconstant}{constant}{constant class}
560 &One, two, four or eight bytes of uninterpreted data, or data
561 encoded in the variable length format known as LEB128 
562 (see Section \refersec{datarep:variablelengthdata}).
563
564 \textit{Most constant values are integers of one kind or
565 another (codes, offsets, counts, and so on); these are
566 sometimes called \doublequote{integer constants} for emphasis.}
567 \addtoindexx{integer constant}
568 \addtoindexx{constant class!integer}
569 \\
570
571 \hypertarget{chap:classexprloc}{}
572 \livelinki{datarep:classexprloc}{exprloc}{exprloc class}
573 &A DWARF expression or location description.
574 \\
575
576 \hypertarget{chap:classflag}{}
577 \livelinki{datarep:classflag}{flag}{flag class}
578 &A small constant that indicates the presence or absence of an attribute.
579 \\
580
581 \hypertarget{chap:classlineptr}{}
582 \livelinki{datarep:classlineptr}{lineptr}{lineptr class}
583 &Refers to a location in the DWARF section that holds line number information.
584 \\
585
586 \hypertarget{chap:classloclistptr}{}
587 \livelinki{datarep:classloclistptr}{loclistptr}{loclistptr class}
588 &Refers to a location in the DWARF section that holds location lists, which
589 describe objects whose location can change during their lifetime.
590 \\
591
592 \hypertarget{chap:classmacptr}{}
593 \livelinki{datarep:classmacptr}{macptr}{macptr class}
594 & Refers to a location in the DWARF section that holds macro definition
595  information.
596 \\
597
598 \hypertarget{chap:classrangelistptr}{}
599 \livelinki{datarep:classrangelistptr}{rangelistptr}{rangelistptr class}
600 & Refers to a location in the DWARF section that holds non\dash contiguous address ranges.
601 \\
602
603 \hypertarget{chap:classreference}{}
604 \livelinki{datarep:classreference}{reference}{reference class}
605 & Refers to one of the debugging information
606 entries that describe the program.  There are three types of
607 reference. The first is an offset relative to the beginning
608 of the compilation unit in which the reference occurs and must
609 refer to an entry within that same compilation unit. The second
610 type of reference is the offset of a debugging information
611 entry in any compilation unit, including one different from
612 the unit containing the reference. The third type of reference
613 is an indirect reference to a 
614 \addtoindexx{type signature}
615 type definition using a 64\dash bit signature 
616 for that type.
617 \\
618
619 \hypertarget{chap:classstring}{}
620 \livelinki{datarep:classstring}{string}{string class}
621 & A null\dash terminated sequence of zero or more
622 (non\dash null) bytes. Data in this class are generally
623 printable strings. Strings may be represented directly in
624 the debugging information entry or as an offset in a separate
625 string table.
626 \\
627
628 \hypertarget{chap:classstroffsetsptr}{}
629 \livelinki{datarep:classstroffsetsptr}{stroffsetsptr}{stroffsetsptr class}
630 &Refers to a base location in the DWARF section that holds
631 a series of offsets in the DWARF section that holds strings.
632 Certain attributes refer one of these offets by indexing 
633 relative to this base location. The resulting offset is then 
634 used to index into the DWARF string section.
635 \\
636
637 \hline
638 \end{longtable}
639
640
641 \section{Relationship of Debugging Information Entries}
642 \label{chap:relationshipofdebugginginformationentries}
643 \textit{%
644 A variety of needs can be met by permitting a single
645 \addtoindexx{debugging information entry!ownership relation}
646 debugging information entry to \doublequote{own} an arbitrary number
647 of other debugging entries and by permitting the same debugging
648 information entry to be one of many owned by another debugging
649 information entry. 
650 This makes it possible, for example, to
651 describe the static \livelink{chap:lexicalblock}{block} structure 
652 within a source file,
653 to show the members of a structure, union, or class, and to
654 associate declarations with source files or source files
655 with shared objects.  
656 }
657
658
659 The ownership relation 
660 \addtoindexx{debugging information entry!ownership relation}
661 of debugging
662 information entries is achieved naturally because the debugging
663 information is represented as a tree. 
664 The nodes of the tree
665 are the debugging information entries themselves. 
666 The child
667 entries of any node are exactly those debugging information
668 entries owned by that node.  
669
670 \textit{%
671 While the ownership relation
672 of the debugging information entries is represented as a
673 tree, other relations among the entries exist, for example,
674 a reference from an entry representing a variable to another
675 entry representing the type of that variable. 
676 If all such
677 relations are taken into account, the debugging entries
678 form a graph, not a tree.  
679 }
680
681 \needlines{4}
682 The tree itself is represented
683 by flattening it in prefix order. 
684 Each debugging information
685 entry is defined either to have child entries or not to have
686 child entries (see Section \refersec{datarep:abbreviationstables}). 
687 If an entry is defined not
688 to have children, the next physically succeeding entry is a
689 sibling. 
690 If an entry is defined to have children, the next
691 physically succeeding entry is its first child. 
692 Additional
693 children are represented as siblings of the first child. 
694 A chain of sibling entries is terminated by a null entry.
695
696 In cases where a producer of debugging information feels that
697 \hypertarget{chap:DWATsiblingdebugginginformationentryrelationship}{}
698 it will be important for consumers of that information to
699 quickly scan chains of sibling entries, while ignoring the
700 children of individual siblings, that producer may attach 
701 \addtoindexx{sibling attribute}
702 a
703 \DWATsibling{} attribute 
704 to any debugging information entry. 
705 The
706 value of this attribute is a reference to the sibling entry
707 of the entry to which the attribute is attached.
708
709
710 \section{Target Addresses}
711 \label{chap:targetaddresses}
712 Many places in this document 
713 refer
714 \addtoindexx{address size|see{size of an address}}
715 to the size 
716 of an
717 \addtoindexi{address}{size of an address}
718 on the target architecture (or equivalently, target machine)
719 to which a DWARF description applies. For processors which
720 can be configured to have different address sizes or different
721 instruction sets, the intent is to refer to the configuration
722 which is either the default for that processor or which is
723 specified by the object file or executable file which contains
724 the DWARF information.
725
726 \textit{%
727 For example, if a particular target architecture supports
728 both 32\dash bit and 64\dash bit addresses, the compiler will generate
729 an object file which specifies that it contains executable
730 code generated for one or the other of these 
731 \addtoindexx{size of an address}
732 address sizes. In
733 that case, the DWARF debugging information contained in this
734 object file will use the same address size.
735 }
736
737 \textit{%
738 Architectures which have multiple instruction sets are
739 supported by the isa entry in the line number information
740 (see Section \refersec{chap:statemachineregisters}).
741 }
742
743 \section{DWARF Expressions}
744 \label{chap:dwarfexpressions}
745 DWARF expressions describe how to compute a value or name a
746 location during debugging of a program. 
747 They are expressed in
748 terms of DWARF operations that operate on a stack of values.
749
750 All DWARF operations are encoded as a stream of opcodes that
751 are each followed by zero or more literal operands. 
752 The number
753 of operands is determined by the opcode.  
754
755 In addition to the
756 general operations that are defined here, operations that are
757 specific to location descriptions are defined in 
758 Section \refersec{chap:locationdescriptions}.
759
760 \subsection{General Operations}
761 \label{chap:generaloperations}
762 Each general operation represents a postfix operation on
763 a simple stack machine. 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 \needlines{4}
1517 \itembfnl{\DWOPimplicitpointerTARG}
1518 The \DWOPimplicitpointerNAME{} operation specifies that the object
1519 is a pointer that cannot be represented as a real pointer,
1520 even though the value it would point to can be described. In
1521 this form of location description, the DWARF expression refers
1522 to a debugging information entry that represents the actual
1523 value of the object to which the pointer would point. Thus, a
1524 consumer of the debug information would be able to show the
1525 value of the dereferenced pointer, even when it cannot show
1526 the value of the pointer itself.
1527
1528 \needlines{5}
1529 The \DWOPimplicitpointerNAME{} operation has two operands: a 
1530 reference to a debugging information entry that describes 
1531 the dereferenced object's value, and a signed number that 
1532 is treated as a byte offset from the start of that value. 
1533 The first operand is a 4-byte unsigned value in the 32-bit 
1534 DWARF format, or an 8-byte unsigned value in the 64-bit 
1535 DWARF format (see Section 
1536 \refersec{datarep:32bitand64bitdwarfformats}).
1537 The second operand is a 
1538 signed LEB128\addtoindexx{LEB128!signed} number.
1539
1540 The first operand is used as the offset of a debugging
1541 information entry in a \dotdebuginfo{} section, which may be
1542 contained in a shared object or executable other than that
1543 containing the operator. For references from one shared object
1544 or executable to another, the relocation must be performed by
1545 the consumer.
1546
1547 \textit{The debugging information entry referenced by a 
1548 \DWOPimplicitpointerNAME{} operation is typically a
1549 \DWTAGvariable{} or \DWTAGformalparameter{} entry whose
1550 \DWATlocation{} attribute gives a second DWARF expression or a
1551 location list that describes the value of the object, but the
1552 referenced entry may be any entry that contains a \DWATlocation{}
1553 or \DWATconstvalue{} attribute (for example, \DWTAGdwarfprocedure).
1554 By using the second DWARF expression, a consumer can
1555 reconstruct the value of the object when asked to dereference
1556 the pointer described by the original DWARF expression
1557 containing the \DWOPimplicitpointer{} operation.}
1558
1559 \end{enumerate}
1560
1561 \textit{DWARF location expressions are intended to yield the \textbf{location}
1562 of a value rather than the value itself. An optimizing compiler
1563 may perform a number of code transformations where it becomes
1564 impossible to give a location for a value, but remains possible
1565 to describe the value itself. 
1566 Section \refersec{chap:registerlocationdescriptions}
1567 describes operators that can be used to
1568 describe the location of a value when that value exists in a
1569 register but not in memory. The operations in this section are
1570 used to describe values that exist neither in memory nor in a
1571 single register.}
1572
1573 \paragraph{Empty Location Descriptions}
1574
1575 An \addtoindex{empty location description}
1576 consists of a DWARF expression
1577 \addtoindexx{location description!empty}
1578 containing no operations. It represents a piece or all of an
1579 object that is present in the source but not in the object code
1580 (perhaps due to optimization).
1581
1582 \needlines{5}
1583 \subsubsection{Composite Location Descriptions}
1584 A composite location description describes an object or
1585 value which may be contained in part of a register or stored
1586 in more than one location. Each piece is described by a
1587 composition operation, which does not compute a value nor
1588 store any result on the DWARF stack. There may be one or
1589 more composition operations in a single composite location
1590 description. A series of such operations describes the parts
1591 of a value in memory address order.
1592
1593 Each composition operation is immediately preceded by a simple
1594 location description which describes the location where part
1595 of the resultant value is contained.
1596 \begin{enumerate}[1. ]
1597 \itembfnl{\DWOPpieceTARG}
1598 The \DWOPpieceTARG{} operation takes a 
1599 single operand, which is an
1600 unsigned LEB128\addtoindexx{LEB128!unsigned} number.  
1601 The number describes the size in bytes
1602 of the piece of the object referenced by the preceding simple
1603 location description. If the piece is located in a register,
1604 but does not occupy the entire register, the placement of
1605 the piece within that register is defined by the ABI.
1606
1607 \textit{Many compilers store a single variable in sets of registers,
1608 or store a variable partially in memory and partially in
1609 registers. \DWOPpieceNAME{} provides a way of describing how large
1610 a part of a variable a particular DWARF location description
1611 refers to. }
1612
1613 \itembfnl{\DWOPbitpieceTARG}
1614 The \DWOPbitpieceTARG{} 
1615 operation takes two operands. The first
1616 is an unsigned LEB128\addtoindexx{LEB128!unsigned} 
1617 number that gives the size in bits
1618 of the piece. The second is an 
1619 unsigned LEB128\addtoindexx{LEB128!unsigned} number that
1620 gives the offset in bits from the location defined by the
1621 preceding DWARF location description.  
1622
1623 Interpretation of the
1624 offset depends on the kind of location description. If the
1625 location description is empty, the offset doesn\textquoteright t matter and
1626 the \DWOPbitpieceNAME{} operation describes a piece consisting
1627 of the given number of bits whose values are undefined. If
1628 the location is a register, the offset is from the least
1629 significant bit end of the register. If the location is a
1630 memory address, the \DWOPbitpieceNAME{} operation describes a
1631 sequence of bits relative to the location whose address is
1632 on the top of the DWARF stack using the bit numbering and
1633 direction conventions that are appropriate to the current
1634 language on the target system. If the location is any implicit
1635 value or stack value, the \DWOPbitpieceNAME{} operation describes
1636 a sequence of bits using the least significant bits of that
1637 value.  
1638 \end{enumerate}
1639
1640 \textit{\DWOPbitpieceNAME{} is 
1641 used instead of \DWOPpieceNAME{} when
1642 the piece to be assembled into a value or assigned to is not
1643 byte-sized or is not at the start of a register or addressable
1644 unit of memory.}
1645
1646
1647
1648
1649 \subsubsection{Example Single Location Descriptions}
1650
1651 Here are some examples of how DWARF operations are used to form location descriptions:
1652 % Probably the only place that this will be used, so not in dwarf.tex?
1653 \newcommand{\descriptionitemnl}[1]{\item[#1]\mbox{}\\}
1654 \begin{description}
1655 \descriptionitemnl{\DWOPregthree}
1656 The value is in register 3.
1657
1658 \descriptionitemnl{\DWOPregx{} 54}
1659 The value is in register 54.
1660
1661 \descriptionitemnl{\DWOPaddr{} 0x80d0045c}
1662 The value of a static variable is at machine address 0x80d0045c.
1663
1664 \descriptionitemnl{\DWOPbregeleven{} 44}
1665 Add 44 to the value in register 11 to get the address of an automatic
1666 variable instance.
1667
1668 \needlines{4}
1669 \descriptionitemnl{\DWOPfbreg{} -50}
1670 Given a \DWATframebase{} value of
1671 \doublequote{\DWOPbregthirtyone{} 64,} this example
1672 computes the address of a local variable that is -50 bytes from a
1673 logical frame pointer that is computed by adding 64 to the current
1674 stack pointer (register 31).
1675
1676 \descriptionitemnl{\DWOPbregx{} 54 32 \DWOPderef}
1677 A call-by-reference parameter whose address is in the word 32 bytes
1678 from where register 54 points.
1679
1680 \needlines{4}
1681 \descriptionitemnl{\DWOPplusuconst{} 4}
1682 A structure member is four bytes from the start of the structure
1683 instance. The base address is assumed to be already on the stack.
1684
1685 \descriptionitemnl{\DWOPregthree{} \DWOPpiece{} 4 \DWOPregten{} \DWOPpiece{} 2}
1686 A variable whose first four bytes reside in register 3 and whose next
1687 two bytes reside in register 10.
1688
1689 \descriptionitemnl{\DWOPregzero{} \DWOPpiece{} 4 \DWOPpiece{} 4 \DWOPfbreg{} -12 \DWOPpiece{} 4}
1690 \vspace{-2\parsep}A twelve byte value whose first four bytes reside in register zero,
1691 whose middle four bytes are unavailable (perhaps due to optimization),
1692 and whose last four bytes are in memory, 12 bytes before the frame
1693 base.
1694
1695 \descriptionitemnl{\DWOPbregone{} 0 \DWOPbregtwo{} 0 \DWOPplus{} \DWOPstackvalue{} }
1696 Add the contents of r1 and r2 to compute a value. This value is the
1697 \doublequote{contents} of an otherwise anonymous location.
1698
1699 \needlines{4}
1700 \descriptionitemnl{\DWOPlitone{} \DWOPstackvalue{} \DWOPpiece{} 4 \DWOPbregthree{} 0 \DWOPbregfour{} 0}
1701 \vspace{-2\parsep}\descriptionitemnl{
1702 \hspace{0.5cm}\DWOPplus{} \DWOPstackvalue{} \DWOPpiece{} 4 \DWOPpiece{} 4}
1703 The object value is found in an anonymous (virtual) location whose
1704 value consists of two parts, given in memory address order: the 4 byte
1705 value 1 followed by the four byte value computed from the sum of the
1706 contents of r3 and r4.
1707
1708 \descriptionitemnl{\DWOPentryvalue{} 1 \DWOPregone{} \DWOPstackvalue }
1709 The value register 1 had upon entering the current subprogram.
1710
1711 \descriptionitemnl{\DWOPentryvalue{} 2 \DWOPbregone{} 0 \DWOPstackvalue }
1712 The value register 1 had upon entering the current subprogram (same as the previous example).
1713 %Both of these location descriptions evaluate to the value register 1 had upon
1714 %entering the current subprogram.
1715
1716 %FIXME: The following gets an undefined control sequence error for reasons unknown... 
1717 %\descriptionitemnl{\DWOPentryvalue{} 1 \DWOPregthirtyone{} \DWOPregone{} \DWOPadd{} \DWOPstackvalue }
1718 %The value register 31 had upon entering the current subprogram
1719 %plus the value register 1 currently has.
1720
1721 \descriptionitemnl{\DWOPentryvalue{} 3 \DWOPbregfour{} 16 \DWOPderef{} \DWOPstackvalue }
1722 %FIXME: similar undefined as just above
1723 %\descriptionitemnl{\DWOPentryvalue{} 6 \DWOPentryvalue{} 1 \DWOPregfour{} \DWOPplusuconst{} 16 \DWOPderef{} \DWOPstackvalue }
1724 %These two location expressions do the same thing, p
1725 Push the value of the
1726 memory location with the size of an address pointed to by the value of
1727 register 4 upon entering the current subprogram and add 16.
1728
1729 \end{description}
1730
1731
1732 \subsection{Location Lists}
1733 \label{chap:locationlists}
1734 There are two forms of location lists. The first form 
1735 is intended for use in other than a split DWARF object,
1736 while the second is intended for use in a split DWARF object
1737 (see Section \refersec{datarep:splitdwarfobjects}). The two
1738 forms are otherwise equivalent.
1739
1740 \textit{The form for split DWARF objects is new in \DWARFVersionV.}
1741
1742 \subsubsection{Location Lists in Non-split Objects}
1743 \label{chap:locationlistsinnonsplitobjects}
1744 Location lists 
1745 \addtoindexx{location list}
1746 are used in place of location expressions
1747 whenever the object whose location is being described
1748 can change location during its lifetime. 
1749 Location lists
1750 \addtoindexx{location list}
1751 are contained in a separate object file section called
1752 \dotdebugloc{}. A location list is indicated by a location
1753 attribute whose value is an offset from the beginning of
1754 the \dotdebugloc{} section to the first byte of the list for the
1755 object in question.
1756
1757 Each entry in a location list is either a location 
1758 \addtoindexi{list}{address selection|see{base address selection}} 
1759 entry,
1760
1761 \addtoindexi{base}{base address selection entry!in location list} 
1762 address selection entry, 
1763 \addtoindexx{location list!base address selection entry}
1764 or an 
1765 \addtoindexx{end of list entry!in location list}
1766 end of list entry.
1767
1768 A location list entry has two forms:
1769 a normal location list entry and a default location list entry.
1770
1771 \needlines{4}
1772 A \addtoindexx{location list!normal entry}
1773 normal location list entry consists of:
1774 \begin{enumerate}[1. ]
1775 \item A beginning address offset. 
1776 This address offset has the \addtoindex{size of an address} and is
1777 relative to the applicable base address of the compilation
1778 unit referencing this location list. It marks the beginning
1779 of the address 
1780 \addtoindexi{range}{address range!in location list} 
1781 over which the location is valid.
1782
1783 \item An ending address offset.  This address offset again
1784 has the \addtoindex{size of an address} and is relative to the applicable
1785 base address of the compilation unit referencing this location
1786 list. It marks the first address past the end of the address
1787 range over which the location is valid. The ending address
1788 must be greater than or equal to the beginning address.
1789
1790 \textit{A location list entry (but not a base address selection or 
1791 end of list entry) whose beginning
1792 and ending addresses are equal has no effect 
1793 because the size of the range covered by such
1794 an entry is zero.}
1795
1796 \item An unsigned 2-byte length describing the length of the location 
1797 description that follows.
1798
1799 \item A \addtoindex{single location description} 
1800 describing the location of the object over the range specified by
1801 the beginning and end addresses.
1802 \end{enumerate}
1803
1804 \needlines{5}
1805 The applicable base address of a normal
1806 location list entry is
1807 \addtoindexx{location list!base address selection entry}
1808 determined by the closest preceding base address selection
1809 entry (see below) in the same location list. If there is
1810 no such selection entry, then the applicable base address
1811 defaults to the base address of the compilation unit (see
1812 Section \refersec{chap:normalandpartialcompilationunitentries}).  
1813
1814 \textit{In the case of a compilation unit where all of
1815 the machine code is contained in a single contiguous section,
1816 no base address selection entry is needed.}
1817
1818 Address ranges defined by normal location list entries
1819 may overlap. When they do, they describe a
1820 situation in which an object exists simultaneously in more than
1821 one place. If all of the address ranges in a given location
1822 list do not collectively cover the entire range over which the
1823 object in question is defined, it is assumed that the object is
1824 not available for the portion of the range that is not covered.
1825
1826 A default location list entry consists of:
1827 \addtoindexx{location list!default entry}
1828 \begin{enumerate}[1. ]
1829 \item The value 0.
1830 \item The value of the largest representable address offset (for
1831       example, \wffffffff when the size of an address is 32 bits).
1832 \item A simple location description describing the location of the
1833       object when there is no prior normal location list entry
1834       that applies in the same location list.
1835 \end{enumerate}
1836
1837 A default location list entry is independent of any applicable
1838 base address (except to the extent to which base addresses
1839 affect prior normal location list entries).
1840
1841 A default location list entry must be the last location list
1842 entry of a location list except for the terminating end of list
1843 entry.
1844
1845 A default location list entry describes an unlimited number
1846 (zero, one or more) of address ranges, none of which overlap
1847 any of the address ranges defined earlier in the same location
1848 list. Further, all such address ranges have the same simple
1849 location.
1850
1851 \needlines{5}
1852 A base 
1853 \addtoindexi{address}{address selection|see{base address selection}}
1854 \addtoindexx{location list!base address selection entry}
1855 selection 
1856 \addtoindexi{entry}{base address selection entry!in location list}
1857 consists of:
1858 \begin{enumerate}[1. ]
1859 \item The value of the largest representable 
1860 address offset (for example, \wffffffff when the size of
1861 an address is 32 bits).
1862 \item An address, which defines the 
1863 appropriate base address for use in interpreting the beginning
1864 and ending address offsets of subsequent entries of the location list.
1865 \end{enumerate}
1866
1867 \textit{A base address selection entry 
1868 affects only the list in which it is contained.}
1869
1870 \needlines{5}
1871 The end of any given location list is marked by an 
1872 \addtoindexx{location list!end of list entry}
1873 end of list entry, which consists of a 0 for the beginning address
1874 offset and a 0 for the ending address offset. A location list
1875 containing only an 
1876 \addtoindexx{end of list entry!in location list}
1877 end of list entry describes an object that
1878 exists in the source code but not in the executable program.
1879
1880 Neither a base address selection entry nor an end of list
1881 entry includes a location description.
1882
1883 \textit{When a DWARF consumer is parsing and decoding a location
1884 list, it must recognize the beginning and ending address
1885 offsets of (0, 0) for an end of list entry and (0, \doublequote{-1}) for
1886 a default location list entry prior to applying any base
1887 address. Any other pair of offsets beginning with 0 is a
1888 valid normal location list entry. Next, it must recognize the
1889 beginning address offset of \doublequote{-1} for a base address selection
1890 entry prior to applying any base address. The current base
1891 address is not applied to the subsequent value (although there
1892 may be an underlying object language relocation that affects
1893 that value).}
1894
1895 \textit{A base address selection entry and an end of list
1896 entry for a location list are identical to a base address
1897 selection entry and end of list entry, respectively, for a
1898 \addtoindex{range list}
1899 (see Section \refersec{chap:noncontiguousaddressranges}) 
1900 in interpretation
1901 and representation.}
1902
1903 \subsubsection{Location Lists in Split Objects}
1904 \label{chap:locationlistsinsplitobjects}
1905 In a split DWARF object (see 
1906 Section \refersec{datarep:splitdwarfobjects}), 
1907 location lists are contained in the \dotdebuglocdwo{} section.
1908
1909 Each entry in the location list
1910 begins with a type code, which is a single unsigned byte that
1911 identifies the type of entry. There are five types of entries:
1912 \begin{enumerate}
1913 \itembfnl{\DWLLEendoflistentryTARG}
1914 This entry indicates the end of a location list, and
1915 contains no further data.
1916
1917 \itembfnl{\DWLLEbaseaddressselectionentryTARG}
1918 This entry contains an 
1919 unsigned LEB128\addtoindexx{LEB128!unsigned} value immediately
1920 following the type code. This value is the index of an
1921 address in the \dotdebugaddr{} section, which is then used as
1922 the base address when interpreting offsets in subsequent
1923 location list entries of type \DWLLEoffsetpairentry.
1924 This index is relative to the value of the 
1925 \DWATaddrbase{} attribute of the associated compilation unit.
1926
1927 \itembfnl{\DWLLEstartendentryTARG}
1928 This entry contains two unsigned LEB128\addtoindexx{LEB128!unsigned}
1929 values immediately following the type code. These values are the
1930 indices of two addresses in the \dotdebugaddr{} section.
1931 These indices are relative to the value of the 
1932 \DWATaddrbase{} attribute of the associated compilation unit.
1933 These indicate the starting and ending addresses,
1934 respectively, that define the address range for which
1935 this location is valid. The starting and ending addresses
1936 given by this type of entry are not relative to the
1937 compilation unit base address. A single location
1938 description follows the fields that define the address range.
1939
1940 \itembfnl{\DWLLEstartlengthentryTARG}
1941 This entry contains one unsigned LEB128\addtoindexx{LEB128!unsigned}
1942 value and a 4-byte
1943 unsigned value immediately following the type code. The
1944 first value is the index of an address in the \dotdebugaddr{}
1945 section, which marks the beginning of the address range
1946 over which the location is valid.
1947 This index is relative to the value of the 
1948 \DWATaddrbase{} attribute of the associated compilation unit.
1949 The starting address given by this
1950 type of entry is not relative to the compilation unit
1951 base address. The second value is the
1952 length of the range. A single location
1953 description follows the fields that define the address range.
1954
1955 \itembfnl{\DWLLEoffsetpairentryTARG}
1956 This entry contains two 4-byte unsigned values
1957 immediately following the type code. These values are the
1958 starting and ending offsets, respectively, relative to
1959 the applicable base address, that define the address
1960 range for which this location is valid. A single location
1961 description follows the fields that define the address range.
1962 \end{enumerate}
1963
1964
1965 \section{Types of Program Entities}
1966 \label{chap:typesofprogramentities}
1967 Any 
1968 \hypertarget{chap:DWATtypetypeofdeclaration}{}
1969 debugging information entry describing a declaration that
1970 has a type has 
1971 \addtoindexx{type attribute}
1972 a \DWATtype{} attribute, whose value is a
1973 reference to another debugging information entry. The entry
1974 referenced may describe a base type, that is, a type that is
1975 not defined in terms of other data types, or it may describe a
1976 user-defined type, such as an array, structure or enumeration.
1977 Alternatively, the entry referenced may describe a type
1978 modifier, such as constant, packed, pointer, reference or
1979 volatile, which in turn will reference another entry describing
1980 a type or type modifier (using 
1981 \addtoindexx{type attribute}
1982 a \DWATtype{} attribute of its
1983 own). See 
1984 Section  \referfol{chap:typeentries} 
1985 for descriptions of the entries describing
1986 base types, user-defined types and type modifiers.
1987
1988
1989
1990 \section{Accessibility of Declarations}
1991 \label{chap:accessibilityofdeclarations}
1992 \textit{Some languages, notably \addtoindex{C++} and 
1993 \addtoindex{Ada}, have the concept of
1994 the accessibility of an object or of some other program
1995 entity. The accessibility specifies which classes of other
1996 program objects are permitted access to the object in question.}
1997
1998 The accessibility of a declaration is 
1999 \hypertarget{chap:DWATaccessibilitycandadadeclarations}{}
2000 represented by a 
2001 \DWATaccessibility{} 
2002 attribute, whose
2003 \addtoindexx{accessibility attribute}
2004 value is a constant drawn from the set of codes listed in Table 
2005 \refersec{tab:accessibilitycodes}.
2006
2007 \begin{simplenametable}[1.9in]{Accessibility codes}{tab:accessibilitycodes}
2008 \DWACCESSpublicTARG{}          \\
2009 \DWACCESSprivateTARG{}        \\
2010 \DWACCESSprotectedTARG{}    \\
2011 \end{simplenametable}
2012
2013 \section{Visibility of Declarations}
2014 \label{chap:visibilityofdeclarations}
2015
2016 \textit{Several languages (such as \addtoindex{Modula-2}) 
2017 have the concept of the visibility of a declaration. The
2018 visibility specifies which declarations are to be 
2019 visible outside of the entity in which they are
2020 declared.}
2021
2022 The 
2023 \hypertarget{chap:DWATvisibilityvisibilityofdeclaration}{}
2024 visibility of a declaration is represented 
2025 by a \DWATvisibility{}
2026 attribute\addtoindexx{visibility attribute}, whose value is a
2027 constant drawn from the set of codes listed in 
2028 Table \refersec{tab:visibilitycodes}.
2029
2030 \begin{simplenametable}[1.5in]{Visibility codes}{tab:visibilitycodes}
2031 \DWVISlocalTARG{}          \\
2032 \DWVISexportedTARG{}    \\
2033 \DWVISqualifiedTARG{}  \\
2034 \end{simplenametable}
2035
2036 \section{Virtuality of Declarations}
2037 \label{chap:virtualityofdeclarations}
2038 \textit{\addtoindex{C++} provides for virtual and pure virtual structure or class
2039 member functions and for virtual base classes.}
2040
2041 The 
2042 \hypertarget{chap:DWATvirtualityvirtualityindication}{}
2043 virtuality of a declaration is represented by a
2044 \DWATvirtuality{}
2045 attribute\addtoindexx{virtuality attribute}, whose value is a constant drawn
2046 from the set of codes listed in 
2047 Table \refersec{tab:virtualitycodes}.
2048
2049 \begin{simplenametable}[2.5in]{Virtuality codes}{tab:virtualitycodes}
2050 \DWVIRTUALITYnoneTARG{}                      \\
2051 \DWVIRTUALITYvirtualTARG{}                \\
2052 \DWVIRTUALITYpurevirtualTARG{}    \\
2053 \end{simplenametable}
2054
2055 \section{Artificial Entries}
2056 \label{chap:artificialentries}
2057 \textit{A compiler may wish to generate debugging information entries
2058 for objects or types that were not actually declared in the
2059 source of the application. An example is a formal parameter
2060 %FIXME: The word 'this' should be rendered like a variant italic,
2061 %FIXME: not as a quoted name. Changed to tt font--RB
2062 entry to represent the 
2063 \texttt{this} parameter\index{this parameter@\texttt{this} parameter}
2064 hidden \texttt{this} parameter that most \addtoindex{C++}
2065 implementations pass as the first argument to non-static member
2066 functions.}  
2067
2068 Any debugging information entry representing the
2069 \addtoindexx{artificial attribute}
2070 declaration of an object or type artificially generated by
2071 a compiler and not explicitly declared by the source program
2072 \hypertarget{chap:DWATartificialobjectsortypesthat}{}
2073 may have a 
2074 \DWATartificial{} attribute, 
2075 which is a \livelink{chap:classflag}{flag}.
2076
2077 \needlines{6}
2078 \section{Segmented Addresses}
2079 \label{chap:segmentedaddresses}
2080 \textit{In some systems, addresses are specified as offsets within a
2081 given 
2082 \addtoindexx{address space!segmented}
2083 segment 
2084 \addtoindexx{segmented addressing|see{address space}}
2085 rather than as locations within a single flat
2086 \addtoindexx{address space!flat}
2087 address space.}
2088
2089 Any debugging information entry that contains a description
2090 \hypertarget{chap:DWATsegmentaddressinginformation}{}
2091 of the location of an object or subroutine may have a 
2092 \DWATsegment{} attribute, 
2093 \addtoindexx{segment attribute}
2094 whose value is a location
2095 description. The description evaluates to the segment selector
2096 of the item being described. If the entry containing the
2097 \DWATsegment{} attribute has a 
2098 \DWATlowpc, 
2099 \DWAThighpc,
2100 \DWATranges{} or 
2101 \DWATentrypc{} attribute, 
2102 \addtoindexx{entry pc attribute}
2103 or 
2104 a location
2105 description that evaluates to an address, then those address
2106 values represent the offset portion of the address within
2107 the segment specified 
2108 \addtoindexx{segment attribute}
2109 by \DWATsegment.
2110
2111 If an entry has no 
2112 \DWATsegment{} attribute, it inherits
2113 \addtoindexx{segment attribute}
2114 the segment value from its parent entry.  If none of the
2115 entries in the chain of parents for this entry back to
2116 its containing compilation unit entry have 
2117 \DWATsegment{} attributes, 
2118 then the entry is assumed to exist within a flat
2119 address space. 
2120 Similarly, if the entry has a 
2121 \DWATsegment{} attribute 
2122 \addtoindexx{segment attribute}
2123 containing an empty location description, that
2124 entry is assumed to exist within a 
2125 \addtoindexi{flat}{address space!flat}
2126 address space.
2127
2128 \textit{Some systems support different classes of 
2129 addresses
2130 \addtoindexx{address class!attribute}. 
2131 The
2132 address class may affect the way a pointer is dereferenced
2133 or the way a subroutine is called.}
2134
2135
2136 Any debugging information entry representing a pointer or
2137 reference type or a subroutine or subroutine type may 
2138 have a 
2139 \DWATaddressclass{}
2140 attribute, whose value is an integer
2141 constant.  The set of permissible values is specific to
2142 each target architecture. The value \DWADDRnoneTARG, 
2143 however,
2144 is common to all encodings, and means that no address class
2145 has been specified.
2146
2147 \textit {For example, the Intel386 \texttrademark\  processor might use the following values:}
2148
2149 \begin{table}[here]
2150 \caption{Example address class codes}
2151 \label{tab:inteladdressclasstable}
2152 \centering
2153 \begin{tabular}{l|c|l}
2154 \hline
2155 Name&Value&Meaning  \\
2156 \hline
2157 \textit{DW\_ADDR\_none}&   0 & \textit{no class specified} \\
2158 \textit{DW\_ADDR\_near16}& 1 & \textit{16\dash bit offset, no segment} \\
2159 \textit{DW\_ADDR\_far16}&  2 & \textit{16\dash bit offset, 16\dash bit segment} \\
2160 \textit{DW\_ADDR\_huge16}& 3 & \textit{16\dash bit offset, 16\dash bit segment} \\
2161 \textit{DW\_ADDR\_near32}& 4 & \textit{32\dash bit offset, no segment} \\
2162 \textit{DW\_ADDR\_far32}&  5 & \textit{32\dash bit offset, 16\dash bit segment} \\
2163 \hline
2164 \end{tabular}
2165 \end{table}
2166
2167 \needlines{6}
2168 \section{Non-Defining Declarations and Completions}
2169 \label{nondefiningdeclarationsandcompletions}
2170 A debugging information entry representing a program entity
2171 typically represents the defining declaration of that
2172 entity. In certain contexts, however, a debugger might need
2173 information about a declaration of an entity that is not
2174 \addtoindexx{incomplete declaration}
2175 also a definition, or is otherwise incomplete, to evaluate
2176 \hypertarget{chap:DWATdeclarationincompletenondefiningorseparateentitydeclaration}{}
2177 an expression correctly.
2178
2179 \needlines{10}
2180 \textit{As an example, consider the following fragment of \addtoindex{C} code:}
2181
2182 \begin{lstlisting}
2183 void myfunc()
2184 {
2185   int x;
2186   {
2187     extern float x;
2188     g(x);
2189   }
2190 }
2191 \end{lstlisting}
2192
2193
2194 \textit{\addtoindex{C} scoping rules require that the 
2195 value of the variable x passed to the function g is the value of the
2196 global variable x rather than of the local version.}
2197
2198 \subsection{Non-Defining Declarations}
2199 A debugging information entry that 
2200 represents a non-defining 
2201 \addtoindexx{non-defining declaration}
2202 or otherwise 
2203 \addtoindex{incomplete declaration}
2204 of a program entity has a
2205 \addtoindexx{declaration attribute}
2206 \DWATdeclaration{} attribute, which is a 
2207 \livelink{chap:classflag}{flag}.
2208
2209 \subsection{Declarations Completing Non-Defining Declarations}
2210 A debugging information entry that represents a 
2211 \hypertarget{chap:DWATspecificationincompletenondefiningorseparatedeclaration}{}
2212 declaration that completes another (earlier) 
2213 non\dash defining declaration may have a 
2214 \DWATspecification{}
2215 attribute whose value is a \livelink{chap:classreference}{reference} to
2216 the debugging information entry representing the non-defining declaration. A debugging
2217 information entry with a 
2218 \DWATspecification{} 
2219 attribute does not need to duplicate information
2220 provided by the debugging information entry referenced by that specification attribute.
2221
2222 When the non-defining declaration is contained within a type that has
2223 been placed in a separate type unit (see Section \refersec{chap:separatetypeunitentries}), 
2224 the \DWATspecification{} attribute cannot refer directly to the entry in
2225 the type unit. Instead, the current compilation unit may contain a
2226 \doublequote{skeleton} declaration of the type, which contains only the relevant
2227 declaration and its ancestors as necessary to provide the context
2228 (including containing types and namespaces). The \DWATspecification{}
2229 attribute would then be a reference to the declaration entry within
2230 the skeleton declaration tree. The debugging information entry for the
2231 top-level type in the skeleton tree may contain a \DWATsignature{}
2232 attribute whose value is the type signature 
2233 (see Section \refersec{datarep:typesignaturecomputation}).
2234
2235
2236 It is not the case that all attributes of the debugging information entry referenced by a
2237 \DWATspecification{} attribute 
2238 apply to the referring debugging information entry.
2239
2240 \textit{For 
2241 \addtoindexx{declaration attribute}
2242 example,
2243 \DWATsibling{} and 
2244 \DWATdeclaration{} 
2245 \addtoindexx{declaration attribute}
2246 clearly cannot apply to a 
2247 \addtoindexx{declaration attribute}
2248 referring
2249 \addtoindexx{sibling attribute}
2250 entry.}
2251
2252
2253
2254 \section{Declaration Coordinates}
2255 \label{chap:declarationcoordinates}
2256 \livetargi{chap:declarationcoordinates}{}{declaration coordinates}
2257 \textit{It is sometimes useful in a debugger to be able to associate
2258 a declaration with its occurrence in the program source.}
2259
2260 Any debugging information 
2261 \hypertarget{chap:DWATdeclfilefilecontainingsourcedeclaration}{}
2262 entry 
2263 \hypertarget{chap:DWATdecllinelinenumberofsourcedeclaration}{}
2264 representing 
2265 \hypertarget{chap:DWATdeclcolumncolumnpositionofsourcedeclaration}{}
2266 the
2267 \addtoindexx{line number of declaration}
2268 declaration of an object, module, subprogram or
2269 \addtoindex{declaration column attribute}
2270 type 
2271 \addtoindex{declaration file attribute}
2272 may 
2273 \addtoindex{declaration line attribute}
2274 have
2275 \DWATdeclfile, 
2276 \DWATdeclline{} and 
2277 \DWATdeclcolumn{}
2278 attributes each of whose value is an unsigned
2279 \livelink{chap:classconstant}{integer constant}.
2280
2281 The value of 
2282 \addtoindexx{declaration file attribute}
2283 the 
2284 \DWATdeclfile{}
2285 attribute 
2286 \addtoindexx{file containing declaration}
2287 corresponds to
2288 a file number from the line number information table for the
2289 compilation unit containing the debugging information entry and
2290 represents the source file in which the declaration appeared
2291 (see Section \refersec{chap:linenumberinformation}). 
2292 The value 0 indicates that no source file
2293 has been specified.
2294
2295 The value of 
2296 \addtoindexx{declaration line attribute}
2297 the \DWATdeclline{} attribute represents
2298 the source line number at which the first character of
2299 the identifier of the declared object appears. The value 0
2300 indicates that no source line has been specified.
2301
2302 The value of 
2303 \addtoindexx{declaration column attribute}
2304 the \DWATdeclcolumn{} attribute represents
2305 the source column number at which the first character of
2306 the identifier of the declared object appears. The value 0
2307 indicates that no column has been specified.
2308
2309 \section{Identifier Names}
2310 \label{chap:identifiernames}
2311 Any 
2312 \hypertarget{chap:DWATnamenameofdeclaration}{}
2313 debugging information entry 
2314 \addtoindexx{identifier names}
2315 representing 
2316 \addtoindexx{names!identifier}
2317 a program entity
2318 that has been given a name may have a 
2319 \DWATname{} attribute,
2320 whose 
2321 \addtoindexx{name attribute}
2322 value is a \livelink{chap:classstring}{string} 
2323 representing the name as it appears in
2324 the source program. A debugging information entry containing
2325 no name attribute, or containing a name attribute whose value
2326 consists of a name containing a single null byte, represents
2327 a program entity for which no name was given in the source.
2328
2329 \textit{Because the names of program objects described by DWARF are the
2330 names as they appear in the source program, implementations
2331 of language translators that use some form of mangled name
2332 \addtoindexx{mangled names}
2333 (as do many implementations of \addtoindex{C++}) should use the unmangled
2334 form of the name in the 
2335 DWARF \DWATname{} attribute,
2336 \addtoindexx{name attribute}
2337 including the keyword operator (in names such as \doublequote{operator +}),
2338 if present. See also 
2339 Section \referfol{chap:linkagenames} regarding the use
2340 of \DWATlinkagename{} for 
2341 \addtoindex{mangled names}.
2342 Sequences of
2343 multiple whitespace characters may be compressed.}
2344
2345 \section{Data Locations and DWARF Procedures}
2346 Any debugging information entry describing a data object (which
2347 \hypertarget{chap:DWATlocationdataobjectlocation}{}
2348 includes variables and parameters) or 
2349 \livelink{chap:commonblockentry}{common blocks}
2350 may have 
2351 \addtoindexx{location attribute}
2352 a
2353 \DWATlocation{} attribute,
2354 \addtoindexx{location attribute}
2355 whose value is a location description
2356 (see Section \refersec{chap:locationdescriptions}).
2357
2358 \needlines{4}
2359
2360 \addtoindex{DWARF procedure}
2361 is represented by any
2362 kind of debugging information entry that has 
2363 \addtoindexx{location attribute}
2364
2365 \DWATlocation{}
2366 attribute. 
2367 \addtoindexx{location attribute}
2368 If a suitable entry is not otherwise available,
2369 a DWARF procedure can be represented using a debugging
2370 \addtoindexx{DWARF procedure entry}
2371 information entry with the 
2372 tag \DWTAGdwarfprocedureTARG{}
2373 together with 
2374 \addtoindexx{location attribute}
2375 a \DWATlocation{} attribute.  
2376
2377 A DWARF procedure
2378 is called by a \DWOPcalltwo, 
2379 \DWOPcallfour{} or 
2380 \DWOPcallref{}
2381 DWARF expression operator 
2382 (see Section \refersec{chap:controlflowoperations}).
2383
2384 \needlines{5}
2385 \section{Code Addresses and Ranges}
2386 \label{chap:codeaddressesandranges}
2387 Any debugging information entry describing an entity that has
2388 a machine code address or range of machine code addresses,
2389 which includes compilation units, module initialization,
2390 \hypertarget{chap:DWATrangesnoncontiguousrangeofcodeaddresses}{}
2391 subroutines, ordinary \nolink{blocks}, 
2392 try/catch \nolink{blocks} (see Section\refersec{chap:tryandcatchblockentries}), 
2393 labels and the like, may have
2394 \begin{itemize}
2395 \item A \DWATlowpc{} attribute for
2396 \hypertarget{chap:DWATlowpccodeaddressorrangeofaddresses}{}
2397 a single address,
2398
2399 \item A \DWATlowpc{}
2400 \addtoindexx{low PC attribute}
2401 and 
2402 \DWAThighpc{}
2403 \addtoindexx{high PC attribute}
2404 \hypertarget{chap:DWAThighpccontiguousrangeofcodeaddresses}{}
2405 pair of attributes for 
2406 a single contiguous range of
2407 addresses, or
2408
2409 \item A \DWATranges{} attribute 
2410 \addtoindexx{ranges attribute}
2411 for a non-contiguous range of addresses.
2412 \end{itemize}
2413
2414 In addition, a non-contiguous range of 
2415 addresses may also be specified for the
2416 \DWATstartscope{} attribute.
2417 \addtoindexx{start scope attribute}
2418
2419 If an entity has no associated machine code, 
2420 none of these attributes are specified.
2421
2422 \subsection{Single Address} 
2423 When there is a single address associated with an entity,
2424 such as a label or alternate entry point of a subprogram,
2425 the entry has a \DWATlowpc{} attribute whose value is the
2426 relocated address for the entity.
2427
2428 \textit{While the \DWATentrypc{}
2429 attribute might also seem appropriate for this purpose,
2430 historically the \DWATlowpc{} attribute was used before the
2431 \DWATentrypc{} was introduced 
2432 (in \addtoindex{DWARF Version 3}). There is
2433 insufficient reason to change this.}
2434
2435 \needlines{8}
2436 \subsection{Continuous Address Range}
2437 \label{chap:contiguousaddressranges}
2438 When the set of addresses of a debugging information entry can
2439 be described as a single contiguous range, the entry 
2440 \addtoindexx{high PC attribute}
2441 may 
2442 \addtoindexx{low PC attribute}
2443 have
2444 a \DWATlowpc{} and 
2445 \DWAThighpc{} pair of attributes. 
2446 The value
2447 of the 
2448 \DWATlowpc{} attribute 
2449 is the relocated address of the
2450 first instruction associated with the entity. If the value of
2451 the \DWAThighpc{} is of class address, it is the relocated
2452 address of the first location past the last instruction
2453 associated with the entity; if it is of class constant, the
2454 value is an unsigned integer offset which when added to the
2455 low PC gives the address of the first location past the last
2456 instruction associated with the entity.
2457
2458 \textit{The high PC value
2459 may be beyond the last valid instruction in the executable.}
2460
2461 \needlines{5}
2462 The presence of low and high PC attributes for an entity
2463 implies that the code generated for the entity is contiguous
2464 and exists totally within the boundaries specified by those
2465 two attributes. If that is not the case, no low and high PC
2466 attributes should be produced.
2467
2468 \subsection{Non\dash Contiguous Address Ranges}
2469 \label{chap:noncontiguousaddressranges}
2470 When the set of addresses of a debugging information entry
2471 \addtoindexx{non-contiguous address ranges}
2472 cannot be described as a single contiguous range, the entry has
2473 a \DWATranges{} attribute 
2474 \addtoindexx{ranges attribute}
2475 whose value is of class \livelink{chap:classrangelistptr}{rangelistptr}
2476 and indicates the beginning of a \addtoindex{range list}.
2477 Similarly,
2478 a \DWATstartscope{} attribute 
2479 \addtoindexx{start scope attribute}
2480 may have a value of class
2481 \livelink{chap:classrangelistptr}{rangelistptr} for the same reason.  
2482
2483 Range lists are contained in a separate object file section called 
2484 \dotdebugranges{}. A
2485 \addtoindex{range list} is indicated by a 
2486 \DWATranges{} attribute whose
2487 \addtoindexx{ranges attribute}
2488 value is represented as an offset from the beginning of the
2489 \dotdebugranges{} section to the beginning of the 
2490 \addtoindex{range list}.
2491
2492 \needlines{4}
2493 If the current compilation unit contains a \DWATrangesbase{}
2494 attribute, the value of that attribute establishes a base
2495 offset within the \dotdebugranges{} section for the compilation
2496 unit. The offset given by the \DWATranges{} attribute is
2497 relative to that base.
2498
2499 \textit{The \DWATrangesbase{} attribute is new in \addtoindex{DWARF Version 5}.
2500 The advantage of this attribute is that is reduces the number of
2501 object language relocations needed for references to the \dotdebugranges{}
2502 section from one for each reference to a single relocation that
2503 applies for the entire compilation unit.}
2504
2505 Each entry in a \addtoindex{range list} is either a 
2506 \addtoindex{range list} entry,
2507 \addtoindexx{base address selection entry!in range list}
2508 a base address selection entry, or an 
2509 \addtoindexx{end of list entry!in range list}
2510 end of list entry.
2511
2512 A \addtoindex{range list} entry consists of:
2513 \begin{enumerate}[1. ]
2514 \item A beginning address offset. This address offset has the 
2515 \addtoindex{size of an address} and is relative to
2516 the applicable base address of the compilation unit referencing this 
2517 \addtoindex{range list}. 
2518 It marks the
2519 beginning of an 
2520 \addtoindexi{address}{address range!in range list} 
2521 range.
2522
2523 \item An ending address offset. This address offset again has the 
2524 \addtoindex{size of an address} and is relative
2525 to the applicable base address of the compilation unit referencing 
2526 this \addtoindex{range list}.
2527 It marks the
2528 first address past the end of the address range.
2529 The ending address must be greater than or
2530 equal to the beginning address.
2531
2532 \textit{A \addtoindex{range list} entry (but not a base address selection or end of list entry) whose beginning and
2533 ending addresses are equal has no effect because the size of the range covered by such an
2534 entry is zero.}
2535 \end{enumerate}
2536
2537 The applicable base address of a \addtoindex{range list} entry
2538 is determined
2539 by the closest preceding base address selection entry (see
2540 below) in the same range list. If there is no such selection
2541 entry, then the applicable base address defaults to the base
2542 address of the compilation unit 
2543 (see Section \refersec{chap:normalandpartialcompilationunitentries}).
2544
2545 \textit{In the case of a compilation unit where all of the machine
2546 code is contained in a single contiguous section, no base
2547 address selection entry is needed.}
2548
2549 Address range entries in
2550 a \addtoindex{range list} may not overlap.
2551 There is no requirement that
2552 the entries be ordered in any particular way.
2553
2554 \needlines{5}
2555 A base address selection entry consists of:
2556 \begin{enumerate}[1. ]
2557 \item The value of the largest representable address offset (for example, \wffffffff when the size of
2558 an address is 32 bits).
2559
2560 \item An address, which defines the appropriate base address for use in interpreting the beginning
2561 and ending address offsets of subsequent entries of the location list.
2562 \end{enumerate}
2563 \textit{A base address selection entry 
2564 affects only the list in which it is contained.}
2565
2566
2567 The end of any given \addtoindex{range list} is marked by an 
2568 \addtoindexx{end of list entry!in range list}
2569 end of list entry, 
2570 which consists of a 0 for the beginning address
2571 offset and a 0 for the ending address offset. 
2572 A \addtoindex{range list}
2573 containing only an end of list entry describes an empty scope
2574 (which contains no instructions).
2575
2576 \textit{A base address selection entry and an 
2577 \addtoindexx{end of list entry!in range list}
2578 end of list entry for
2579 a \addtoindex{range list} 
2580 are identical to a base address selection entry
2581 and end of list entry, respectively, for a location list
2582 (see Section \refersec{chap:locationlists}) 
2583 in interpretation and representation.}
2584
2585
2586
2587 \section{Entry Address}
2588 \label{chap:entryaddress}
2589 \textit{The entry or first executable instruction generated
2590 for an entity, if applicable, is often the lowest addressed
2591 instruction of a contiguous range of instructions. In other
2592 cases, the entry address needs to be specified explicitly.}
2593
2594 Any debugging information entry describing an entity that has
2595 a range of code addresses, which includes compilation units,
2596 module initialization, subroutines, 
2597 ordinary \livelink{chap:lexicalblock}{block}, 
2598 try/catch \nolink{blocks} (see Section 
2599 \refersec{chap:tryandcatchblockentries}),
2600 and the like, may have a \DWATentrypcNAME{} attribute to
2601 indicate the first executable instruction within that range
2602 \hypertarget{chap:entryaddressofscope}{}
2603 of addresses. The value of the \DWATentrypcNAME{} attribute is a
2604 relocated address if the
2605 value of \DWATentrypcNAME{} is of class address; or if it is of class
2606 constant, the value is an unsigned integer offset which, when
2607 added to the base address of the function, gives the entry
2608 address. 
2609
2610 The base address of the containing scope is given by either the
2611 \DWATlowpc{} attribute, or the first range entry in the list of
2612 ranges given by the \DWATranges{} attribute. 
2613 If no \DWATentrypcNAME{} attribute is present,
2614 then the entry address is assumed to be the same as the
2615 value of the \DWATlowpc{} attribute, if present; otherwise,
2616 the entry address is unknown.
2617
2618 \section{Static and Dynamic Values of Attributes}
2619 \label{chap:staticanddynamicvaluesofattributes}
2620
2621 Some attributes that apply to types specify a property (such
2622 as the lower bound of an array) that is an integer value,
2623 where the value may be known during compilation or may be
2624 computed dynamically during execution.
2625
2626 \needlines{5}
2627 The value of these
2628 attributes is determined based on the class as follows:
2629 \begin{itemize}
2630 \item For a \livelink{chap:classconstant}{constant}, the value of the constant is the value of
2631 the attribute.
2632
2633 \item For a \livelink{chap:classreference}{reference}, the
2634 value is a reference to another DIE.  This DIE may:
2635 \begin{itemize}
2636 \renewcommand{\itemsep}{0cm}
2637 \item describe a constant which is the attribute value,
2638 \item describe a variable which contains the attribute value, or
2639 \item contain a DWARF expression which computes the attribute value
2640       (for example, be a \DWTAGdwarfprocedure{} entry).
2641 \end{itemize}
2642
2643 \item For an \livelink{chap:classexprloc}{exprloc}, the value is interpreted as a 
2644 DWARF expression; 
2645 evaluation of the expression yields the value of
2646 the attribute.
2647 \end{itemize}
2648
2649 \textit{%
2650 Whether an attribute value can be dynamic depends on the
2651 rules of the applicable programming language.
2652 }
2653
2654 \textit{The applicable attributes include: 
2655 \DWATallocated,
2656 \DWATassociated, 
2657 \DWATbitoffset, 
2658 \DWATbitsize,
2659 \DWATbitstride,
2660 \DWATbytesize,
2661 \DWATbytestride, 
2662 \DWATcount, 
2663 \DWATlowerbound,
2664 \DWATrank,
2665 \DWATupperbound,
2666 (and possibly others).}
2667
2668 \needlines{4}
2669 \section{Entity Descriptions}
2670 \textit{Some debugging information entries may describe entities
2671 in the program that are artificial, or which otherwise are
2672 \doublequote{named} in ways which are not valid identifiers in the
2673 programming language. For example, several languages may
2674 capture or freeze the value of a variable at a particular
2675 point in the program. 
2676 \addtoindex{Ada} 95 has package elaboration routines,
2677 type descriptions of the form typename\textquoteright Class, and 
2678 \doublequote{access typename} parameters.  }
2679
2680 Generally, any debugging information
2681 entry that 
2682 \hypertarget{chap:DWATdescriptionartificialnameordescription}{}
2683 has, or may have, 
2684 \addtoindexx{name attribute}
2685
2686 \DWATname{} attribute, may
2687 also have 
2688 \addtoindexx{description attribute}
2689
2690 \DWATdescription{} attribute whose value is a
2691 null-terminated string providing a description of the entity.
2692
2693
2694 \textit{It is expected that a debugger will only display these
2695 descriptions as part of the description of other entities. It
2696 should not accept them in expressions, nor allow them to be
2697 assigned, or the like.}
2698
2699 \needlines{4}
2700 \section{Byte and Bit Sizes}
2701 \label{chap:byteandbitsizes}
2702 % Some trouble here with hbox full, so we try optional word breaks.
2703 Many debugging information entries allow either a
2704 \DWATbytesize{} attribute or a 
2705 \DWATbitsize{} attribute,
2706 whose \livelink{chap:classconstant}{integer constant} value 
2707 (see Section \ref{chap:staticanddynamicvaluesofattributes}) 
2708 specifies an
2709 amount of storage. The value of the 
2710 \DWATbytesize{} attribute
2711 is interpreted in bytes and the value of the 
2712 \DWATbitsize{}
2713 attribute is interpreted in bits. The
2714 \DWATstringlengthbytesize{} and 
2715 \DWATstringlengthbitsize{} 
2716 attributes are similar.
2717
2718 In addition, the \livelink{chap:classconstant}{integer constant}
2719 value of a \DWATbytestride{} attribute is interpreted
2720 in bytes and the \livelink{chap:classconstant}{integer constant} value of a 
2721 \DWATbitstride{}
2722 attribute is interpreted in bits.
2723
2724 \section{Linkage Names}
2725 \label{chap:linkagenames}
2726 \textit{Some language implementations, notably 
2727 \addtoindex{C++} and similar
2728 languages, 
2729 make use of implementation-defined names within
2730 object files that are different from the identifier names
2731 (see Section \refersec{chap:identifiernames}) of entities as they appear in the
2732 source. Such names, sometimes known 
2733 \addtoindexx{names!mangled}
2734 as 
2735 \addtoindex{mangled names},
2736 are used in various ways, such as: to encode additional
2737 information about an entity, to distinguish multiple entities
2738 that have the same name, and so on. When an entity has an
2739 associated distinct linkage name it may sometimes be useful
2740 for a producer to include this name in the DWARF description
2741 of the program to facilitate consumer access to and use of
2742 object file information about an entity and/or information
2743 \hypertarget{chap:DWATlinkagenameobjectfilelinkagenameofanentity}{}
2744 that is encoded in the linkage name itself.  
2745 }
2746
2747 % Some trouble maybe with hbox full, so we try optional word breaks.
2748 A debugging
2749 information entry may have 
2750 \addtoindexx{linkage name attribute}
2751
2752 \DWATlinkagename{}
2753 attribute
2754 whose value is a null-terminated string describing the object
2755 file linkage name associated with the corresponding entity.
2756
2757 % Some trouble here with hbox full, so we try optional word breaks.
2758 \textit{Debugging information entries to which \DWATlinkagename{}
2759 may apply include: \DWTAGcommonblock, \DWTAGconstant,
2760 \DWTAGentrypoint, \DWTAGsubprogram{} 
2761 and \DWTAGvariable.
2762 }
2763
2764 \section{Template Parameters}
2765 \label{chap:templateparameters}
2766 \textit{
2767 In \addtoindex{C++}, a template is a generic definition of a class, function, member
2768 function, or typedef (alias).  A template has formal parameters that
2769 can be types or constant values; the class, function,
2770 member function, or typedef is instantiated differently for each
2771 distinct combination of type or value actual parameters.  DWARF does
2772 not represent the generic template definition, but does represent each
2773 instantiation.
2774 }
2775
2776 A debugging information entry that represents a 
2777 \addtoindex{template instantiation}
2778 will contain child entries describing the actual template parameters.
2779 The containing entry and each of its child entries reference a template
2780 parameter entry in any circumstance where the template definition
2781 referenced a formal template parameter.
2782
2783 A template type parameter is represented by a debugging information
2784 entry with the tag
2785 \addtoindexx{template type parameter entry}
2786 \DWTAGtemplatetypeparameterTARG. 
2787 A template value parameter is represented by a debugging information
2788 entry with the tag
2789 \addtoindexx{template value parameter entry}
2790 \DWTAGtemplatevalueparameterTARG.
2791 The actual template parameter entries appear in the same order as the 
2792 corresponding template formal parameter declarations in the 
2793 source program.
2794
2795 \needlines{4}
2796 A type or value parameter entry may have a \DWATname{} attribute, 
2797 \addtoindexx{name attribute}
2798 whose value is a
2799 null\dash terminated string containing the name of the corresponding 
2800 formal parameter as it appears in the source program.
2801 The entry may also have a 
2802 \DWATdefaultvalue{} attribute, which is a flag indicating 
2803 that the value corresponds to the default argument for the 
2804 template parameter.
2805
2806
2807 A
2808 \addtoindexx{formal type parameter|see{template type parameter entry}}
2809 template type parameter entry has a
2810 \addtoindexx{type attribute}
2811 \DWATtype{} attribute
2812 describing the actual type by which the formal is replaced.
2813
2814
2815 A template value parameter entry has a \DWATtype{} attribute 
2816 describing the type of the parameterized value.
2817 The entry also has an attribute giving the 
2818 actual compile-time or run-time constant value 
2819 of the value parameter for this instantiation.
2820 This can be a 
2821 \DWATconstvalue{}\livetarg{chap:DWATconstvaluetemplatevalueparameter}{} 
2822 attribute, whose
2823 value is the compile-time constant value as represented 
2824 on the target architecture. 
2825 Or, the attribute can be a \DWATlocation{} attribute, whose value is a 
2826 single location description for the run-time constant address.
2827