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