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