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