Try out newly discovered needspace package; it is wonderful...
[dwarf-doc.git] / dwarf5 / latexdoc / generaldescription.tex
1 \chapter{General Description}
2 \label{chap:generaldescription}
3 \section{The Debugging 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 &\livelink{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 of 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
409 \livetargi{chap:exprloc}{exprloc}{exprloc class}
410 &A DWARF expression or location description.
411 \\
412 \livetargi{chap:flag}{flag}{flag class}
413 &A small constant that indicates the presence or absence of an attribute.
414 \\
415 \livetargi{chap:lineptr}{lineptr}{lineptr class}
416 &Refers to a location in the DWARF section that holds line number information.
417 \\
418 \livetargi{chap:loclistptr}{loclistptr}{loclistptr class}
419 &Refers to a location in the DWARF section that holds location lists, which
420 describe objects whose location can change during their lifetime.
421 \\
422 \livetargi{chap:macptr}{macptr}{macptr class}
423 & Refers to a location in the DWARF section that holds macro definition
424  information.  \\
425 \livetargi{chap:rangelistptr}{rangelistptr}{rangelistptr class}
426 & Refers to a location in the DWARF section that holds non\dash contiguous address ranges.  \\
427
428 \livetargi{chap:reference}{reference}{reference class}
429 & Refers to one of the debugging information
430 entries that describe the program.  There are three types of
431 reference. The first is an offset relative to the beginning
432 of the compilation unit in which the reference occurs and must
433 refer to an entry within that same compilation unit. The second
434 type of reference is the offset of a debugging information
435 entry in any compilation unit, including one different from
436 the unit containing the reference. The third type of reference
437 is an indirect reference to a 
438 \addtoindexx{type signature}
439 type definition using a 64\dash bit signature 
440 for that type.  \\
441
442 \livetargi{chap:string}{string}{string class}
443 & A null\dash terminated sequence of zero or more
444 (non\dash null) bytes. Data in this class are generally
445 printable strings. Strings may be represented directly in
446 the debugging information entry or as an offset in a separate
447 string table. \\
448 \hline
449 \end{tabular}
450 \end{table}
451
452 % It is difficult to get the above table to appear before
453 % the end of the chapter without a clearpage here.
454 \clearpage
455 \section{Relationship of Debugging Information Entries}
456 \label{chap:relationshipofdebugginginformationentries}
457 \textit{%
458 A variety of needs can be met by permitting a single
459 \addtoindexx{debugging information entry!ownership relation}
460 debugging information entry to \doublequote{own} an arbitrary number
461 of other debugging entries and by permitting the same debugging
462 information entry to be one of many owned by another debugging
463 information entry. 
464 This makes it possible, for example, to
465 describe the static \livelink{chap:lexicalblock}{block} structure 
466 within a source file,
467 to show the members of a structure, union, or class, and to
468 associate declarations with source files or source files
469 with shared objects.  
470 }
471
472
473 The ownership relation 
474 \addtoindexx{debugging information entry!ownership relation}
475 of debugging
476 information entries is achieved naturally because the debugging
477 information is represented as a tree. 
478 The nodes of the tree
479 are the debugging information entries themselves. 
480 The child
481 entries of any node are exactly those debugging information
482 entries owned by that node.  
483
484 \textit{%
485 While the ownership relation
486 of the debugging information entries is represented as a
487 tree, other relations among the entries exist, for example,
488 a reference from an entry representing a variable to another
489 entry representing the type of that variable. 
490 If all such
491 relations are taken into account, the debugging entries
492 form a graph, not a tree.  
493 }
494
495 The tree itself is represented
496 by flattening it in prefix order. 
497 Each debugging information
498 entry is defined either to have child entries or not to have
499 child entries (see Section \refersec{datarep:abbreviationstables}). 
500 If an entry is defined not
501 to have children, the next physically succeeding entry is a
502 sibling. 
503 If an entry is defined to have children, the next
504 physically succeeding entry is its first child. 
505 Additional
506 children are represented as siblings of the first child. 
507 A chain of sibling entries is terminated by a null entry.
508
509 In cases where a producer of debugging information feels that
510 \hypertarget{chap:DWATsiblingdebugginginformationentryrelationship}
511 it will be important for consumers of that information to
512 quickly scan chains of sibling entries, while ignoring the
513 children of individual siblings, that producer may attach 
514 \addtoindexx{sibling attribute}
515 a
516 \livelink{chap:DWATsibling}{DW\-\_AT\-\_sibling} attribute 
517 to any debugging information entry. 
518 The
519 value of this attribute is a reference to the sibling entry
520 of the entry to which the attribute is attached.
521
522
523 \section{Target Addresses}
524 \label{chap:targetaddresses}
525 Many places in this document 
526 refer
527 \addtoindexx{address size|see{size of an address}}
528 to the size 
529 of an
530 \addtoindexi{address}{size of an address}
531 on the target architecture (or equivalently, target machine)
532 to which a DWARF description applies. For processors which
533 can be configured to have different address sizes or different
534 instruction sets, the intent is to refer to the configuration
535 which is either the default for that processor or which is
536 specified by the object file or executable file which contains
537 the DWARF information.
538
539 \textit{%
540 For example, if a particular target architecture supports
541 both 32\dash bit and 64\dash bit addresses, the compiler will generate
542 an object file which specifies that it contains executable
543 code generated for one or the other of these 
544 \addtoindexx{size of an address}
545 address sizes. In
546 that case, the DWARF debugging information contained in this
547 object file will use the same address size.
548 }
549
550 \textit{%
551 Architectures which have multiple instruction sets are
552 supported by the isa entry in the line number information
553 (see Section \refersec{chap:statemachineregisters}).
554 }
555
556 \section{DWARF Expressions}
557 \label{chap:dwarfexpressions}
558 DWARF expressions describe how to compute a value or name a
559 location during debugging of a program. 
560 They are expressed in
561 terms of DWARF operations that operate on a stack of values.
562
563 All DWARF operations are encoded as a stream of opcodes that
564 are each followed by zero or more literal operands. 
565 The number
566 of operands is determined by the opcode.  
567
568 In addition to the
569 general operations that are defined here, operations that are
570 specific to location descriptions are defined in 
571 Section \refersec{chap:locationdescriptions}.
572
573 \subsection{General Operations}
574 \label{chap:generaloperations}
575 Each general operation represents a postfix operation on
576 a simple stack machine. Each element of the stack is the
577 \addtoindex{size of an address} on the target machine. 
578 The value on the
579 top of the stack after ``executing'' the 
580 \addtoindex{DWARF expression}
581 is 
582 \addtoindexx{DWARF expression|see{location description}}
583 taken to be the result (the address of the object, the
584 value of the array bound, the length of a dynamic string,
585 the desired value itself, and so on).
586
587 \subsubsection{Literal Encodings}
588 \label{chap:literalencodings}
589 The 
590 \addtoindexx{DWARF expression!literal encodings}
591 following operations all push a value onto the DWARF
592 stack. 
593 \addtoindexx{DWARF expression!stack operations}
594 If the value of a constant in one of these operations
595 is larger than can be stored in a single stack element, the
596 value is truncated to the element size and the low\dash order bits
597 are pushed on the stack.
598
599 \begin{enumerate}[1.]
600 \item \livetarg{chap:DWOPlit0}{DW\-\_OP\-\_lit0}, \livetarg{chap:DWOPlit1}{DW\-\_OP\-\_lit1}, \dots, \livetarg{chap:DWOPlit31}{DW\-\_OP\-\_lit31} \\
601 The \livetarg{chap:DWOPlit}{DW\-\_OP\-\_lit}n operations encode the unsigned literal values
602 from 0 through 31, inclusive.
603
604 \item \livetarg{chap:DWOPaddr}{DW\-\_OP\-\_addr} \\
605 The \livelink{chap:DWOPaddr}{DW\-\_OP\-\_addr} operation has a single operand that encodes
606 a machine address and whose size is the \addtoindex{size of an address}
607 on the target machine.
608
609 \item \livetarg{chap:DWOPconst1u}{DW\-\_OP\-\_const1u}, \livetarg{chap:DWOPconst2u}{DW\-\_OP\-\_const2u}, \livetarg{chap:DWOPconst4u}{DW\-\_OP\-\_const4u}, \livetarg{chap:DWOPconst8u}{DW\-\_OP\-\_const8u} \\
610 The single operand of a \livetarg{chap:DWOPconstnu}{DW\-\_OP\-\_constnu} operation provides a 1,
611 2, 4, or 8\dash byte unsigned integer constant, respectively.
612
613 \item \livetarg{chap:DWOPconst1s}{DW\-\_OP\-\_const1s} , \livetarg{chap:DWOPconst2s}{DW\-\_OP\-\_const2s}, \livetarg{chap:DWOPconst4s}{DW\-\_OP\-\_const4s}, \livetarg{chap:DWOPconst8s}{DW\-\_OP\-\_const8s} \\
614 The single operand of a \livetarg{chap:DWOPconstns}{DW\-\_OP\-\_constns} operation provides a 1,
615 2, 4, or 8\dash byte signed integer constant, respectively.
616
617 \item \livetarg{chap:DWOPconstu}{DW\-\_OP\-\_constu} \\
618 The single operand of the \livelink{chap:DWOPconstu}{DW\-\_OP\-\_constu} operation provides
619 an unsigned LEB128 integer constant.
620
621 \item \livetarg{chap:DWOPconsts}{DW\-\_OP\-\_consts} \\
622 The single operand of the \livelink{chap:DWOPconsts}{DW\-\_OP\-\_consts} operation provides
623 a signed LEB128 integer constant.
624
625 \end{enumerate}
626
627
628 \subsubsection{Register Based Addressing}
629 \label{chap:registerbasedaddressing}
630 The following operations push a value onto the stack that is
631 \addtoindexx{DWARF expression!register based addressing}
632 the result of adding the contents of a register to a given
633 signed offset.
634
635 \begin{enumerate}[1.]
636
637 \item \livetarg{chap:DWOPfbreg}{DW\-\_OP\-\_fbreg} \\
638 The \livelink{chap:DWOPfbreg}{DW\-\_OP\-\_fbreg} operation provides a signed LEB128 offset
639 from the address specified by the location description in the
640 \livelink{chap:DWATframebase}{DW\-\_AT\-\_frame\-\_base} attribute of the current function. (This
641 is typically a \doublequote{stack pointer} register plus or minus
642 some offset. On more sophisticated systems it might be a
643 location list that adjusts the offset according to changes
644 in the stack pointer as the PC changes.)
645
646 \item \livetarg{chap:DWOPbreg0}{DW\-\_OP\-\_breg0}, \livetarg{chap:DWOPbreg1}{DW\-\_OP\-\_breg1}, \dots, \livetarg{chap:DWOPbreg31}{DW\-\_OP\-\_breg31} \\
647 The single operand of the \livetarg{chap:DWOPbreg}{DW\-\_OP\-\_breg}n 
648 operations provides
649 a signed LEB128 offset from
650 the specified register.
651
652 \item \livetarg{chap:DWOPbregx}{DW\-\_OP\-\_bregx} \\
653 The \livelink{chap:DWOPbregx}{DW\-\_OP\-\_bregx} operation has two operands: a register
654 which is specified by an unsigned LEB128 number, followed by
655 a signed LEB128 offset.
656
657 \end{enumerate}
658
659
660 \subsubsection{Stack Operations}
661 \label{chap:stackoperations}
662 The following 
663 \addtoindexx{DWARF expression!stack operations}
664 operations manipulate the DWARF stack. Operations
665 that index the stack assume that the top of the stack (most
666 recently added entry) has index 0.
667
668 \begin{enumerate}[1.]
669 \item \livetarg{chap:DWOPdup}{DW\-\_OP\-\_dup} \\
670 The \livelink{chap:DWOPdup}{DW\-\_OP\-\_dup} operation duplicates the value at the top of the stack.
671
672 \item \livetarg{chap:DWOPdrop}{DW\-\_OP\-\_drop} \\
673 The \livelink{chap:DWOPdrop}{DW\-\_OP\-\_drop} operation pops the value at the top of the stack.
674
675 \item \livetarg{chap:DWOPpick}{DW\-\_OP\-\_pick} \\
676 The single operand of the \livelink{chap:DWOPpick}{DW\-\_OP\-\_pick} operation provides a
677 1\dash byte index. A copy of the stack entry with the specified
678 index (0 through 255, inclusive) is pushed onto the stack.
679
680 \item \livetarg{chap:DWOPover}{DW\-\_OP\-\_over} \\
681 The \livelink{chap:DWOPover}{DW\-\_OP\-\_over} operation duplicates the entry currently second
682 in the stack at the top of the stack. 
683 This is equivalent to
684 a \livelink{chap:DWOPpick}{DW\-\_OP\-\_pick} operation, with index 1.  
685
686 \item \livetarg{chap:DWOPswap}{DW\-\_OP\-\_swap} \\
687 The \livelink{chap:DWOPswap}{DW\-\_OP\-\_swap} operation swaps the top two stack entries. 
688 The entry at the top of the
689 stack becomes the second stack entry, 
690 and the second entry becomes the top of the stack.
691
692 \item \livetarg{chap:DWOProt}{DW\-\_OP\-\_rot} \\
693 The \livelink{chap:DWOProt}{DW\-\_OP\-\_rot} operation rotates the first three stack
694 entries. The entry at the top of the stack becomes the third
695 stack entry, the second entry becomes the top of the stack,
696 and the third entry becomes the second entry.
697
698 \item  \livetarg{chap:DWOPderef}{DW\-\_OP\-\_deref} \\
699 The 
700 \livelink{chap:DWOPderef}{DW\-\_OP\-\_deref} 
701 operation 
702 pops the top stack entry and 
703 treats it as an address. The value
704 retrieved from that address is pushed. 
705 The size of the data retrieved from the 
706 \addtoindexi{dereferenced}{address!dereference operator}
707 address is the \addtoindex{size of an address} on the target machine.
708
709 \item \livetarg{chap:DWOPderefsize}{DW\-\_OP\-\_deref\-\_size} \\
710 The \livelink{chap:DWOPderefsize}{DW\-\_OP\-\_deref\-\_size} operation behaves like the \livelink{chap:DWOPderef}{DW\-\_OP\-\_deref}
711 operation: it pops the top stack entry and treats it as an
712 address. The value retrieved from that address is pushed. In
713 the \livelink{chap:DWOPderefsize}{DW\-\_OP\-\_deref\-\_size} operation, however, the size in bytes
714 of the data retrieved from the dereferenced address is
715 specified by the single operand. This operand is a 1\dash byte
716 unsigned integral constant whose value may not be larger
717 than the \addtoindex{size of an address} on the target machine. The data
718 retrieved is zero extended to the size of an address on the
719 target machine before being pushed onto the expression stack.
720
721 \item \livetarg{chap:DWOPxderef}{DW\-\_OP\-\_xderef} \\
722 The \livelink{chap:DWOPxderef}{DW\-\_OP\-\_xderef} operation provides an extended dereference
723 mechanism. The entry at the top of the stack is treated as an
724 address. The second stack entry is treated as an \doublequote{address
725 space identifier} for those architectures that support
726 \addtoindexi{multiple}{address space!multiple}
727 address spaces. The top two stack elements are popped,
728 and a data item is retrieved through an implementation-defined
729 address calculation and pushed as the new stack top. The size
730 of the data retrieved from the 
731 \addtoindexi{dereferenced}{address!dereference operator}
732 address is the
733 \addtoindex{size of an address} on the target machine.
734
735 \item \livetarg{chap:DWOPxderefsize}{DW\-\_OP\-\_xderef\-\_size}\\
736 The \livelink{chap:DWOPxderefsize}{DW\-\_OP\-\_xderef\-\_size} operation behaves like the
737 \livelink{chap:DWOPxderef}{DW\-\_OP\-\_xderef} operation.The entry at the top of the stack is
738 treated as an address. The second stack entry is treated as
739 an ``address space identifier'' for those architectures
740 that support 
741 \addtoindexi{multiple}{address space!multiple}
742 address spaces. The top two stack
743 elements are popped, and a data item is retrieved through an
744 implementation\dash defined address calculation and pushed as the
745 new stack top. In the \livelink{chap:DWOPxderefsize}{DW\-\_OP\-\_xderef\-\_size} operation, however,
746 the size in bytes of the data retrieved from the 
747 \addtoindexi{dereferenced}{address!dereference operator}
748 address is specified by the single operand. This operand is a
749 1\dash byte unsigned integral constant whose value may not be larger
750 than the \addtoindex{size of an address} on the target machine. The data
751 retrieved is zero extended to the \addtoindex{size of an address} on the
752 target machine before being pushed onto the expression stack.
753
754 \item \livetarg{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address}\\
755 The \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address}
756 operation pushes the address
757 of the object currently being evaluated as part of evaluation
758 of a user presented expression. This object may correspond
759 to an independent variable described by its own debugging
760 information entry or it may be a component of an array,
761 structure, or class whose address has been dynamically
762 determined by an earlier step during user expression
763 evaluation.
764
765 \textit{This operator provides explicit functionality
766 (especially for arrays involving descriptors) that is analogous
767 to the implicit push of the base 
768 \addtoindexi{address}{address!implicit push of base}
769 of a structure prior
770 to evaluation of a \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} to access a
771 data member of a structure. For an example, see 
772 Appendix \refersec{app:aggregateexamples}.}
773
774 \item \livetarg{chap:DWOPformtlsaddress}{DW\-\_OP\-\_form\-\_tls\-\_address} \\
775 The \livelink{chap:DWOPformtlsaddress}{DW\-\_OP\-\_form\-\_tls\-\_address} operation pops a value from the
776 stack, translates it into an address in the current thread's
777 \addtoindexx{thread-local storage}
778 thread\dash local storage \nolink{block}, and pushes the address. If the
779 DWARF expression containing 
780 the \livelink{chap:DWOPformtlsaddress}{DW\-\_OP\-\_form\-\_tls\-\_address}
781 operation belongs to the main executable's DWARF info, the
782 operation uses the main executable's thread\dash local storage
783 \nolink{block}; if the expression belongs to a shared library's
784 DWARF info, then it uses that shared library's 
785 \addtoindexx{thread-local storage}
786 thread\dash local storage \nolink{block}.
787
788 \textit{Some implementations of 
789 \addtoindex{C} and \addtoindex{C++} support a
790 \_\_thread storage class. Variables with this storage class
791 have distinct values and addresses in distinct threads, much
792 as automatic variables have distinct values and addresses in
793 each function invocation. Typically, there is a single \nolink{block}
794 of storage containing all \_\_thread variables declared in
795 the main executable, and a separate \nolink{block} for the variables
796 declared in each shared library. Computing the address of
797 the appropriate \nolink{block} can be complex (in some cases, the
798 compiler emits a function call to do it), and difficult
799 to describe using ordinary DWARF location descriptions.
800 \livelink{chap:DWOPformtlsaddress}{DW\-\_OP\-\_form\-\_tls\-\_address} leaves the computation to the
801 consumer.}
802
803 \item \livetarg{chap:DWOPcallframecfa}{DW\-\_OP\-\_call\-\_frame\-\_cfa} \\
804 The \livelink{chap:DWOPcallframecfa}{DW\-\_OP\-\_call\-\_frame\-\_cfa} operation pushes the value of the
805 CFA, obtained from the Call Frame Information 
806 (see Section \refersec{chap:callframeinformation}).
807
808 \textit{Although the value of \livelink{chap:DWATframebase}{DW\-\_AT\-\_frame\-\_base}
809 can be computed using other DWARF expression operators,
810 in some cases this would require an extensive location list
811 because the values of the registers used in computing the
812 CFA change during a subroutine. If the 
813 Call Frame Information 
814 is present, then it already encodes such changes, and it is
815 space efficient to reference that.}
816 \end{enumerate}
817
818 \subsubsection{Arithmetic and Logical Operations}
819 The 
820 \addtoindexx{DWARF expression!arithmetic operations}
821 following 
822 \addtoindexx{DWARF expression!logical operations}
823 provide arithmetic and logical operations. Except
824 as otherwise specified, the arithmetic operations perfom
825 addressing arithmetic, that is, unsigned arithmetic that is
826 performed modulo one plus the largest representable address
827 (for example, 0x100000000 when the 
828 \addtoindex{size of an address} is 32
829 bits). 
830 Such operations do not cause an exception on overflow.
831
832 \begin{enumerate}[1.]
833 \item \livetarg{chap:DWOPabs}{DW\-\_OP\-\_abs}  \\
834 The \livelink{chap:DWOPabs}{DW\-\_OP\-\_abs} operation pops the top stack entry, interprets
835 it as a signed value and pushes its absolute value. If the
836 absolute value cannot be represented, the result is undefined.
837
838 \item \livetarg{chap:DWOPand}{DW\-\_OP\-\_and} \\
839 The \livelink{chap:DWOPand}{DW\-\_OP\-\_and} operation pops the top two stack values, performs
840 a bitwise and operation on the two, and pushes the result.
841
842 \item \livetarg{chap:DWOPdiv}{DW\-\_OP\-\_div} \\
843 The \livelink{chap:DWOPdiv}{DW\-\_OP\-\_div} operation pops the top two stack values, divides the former second entry by
844 the former top of the stack using signed division, and pushes the result.
845
846 \item \livetarg{chap:DWOPminus}{DW\-\_OP\-\_minus} \\
847 The \livelink{chap:DWOPminus}{DW\-\_OP\-\_minus} operation pops the top two stack values, subtracts the former top of the
848 stack from the former second entry, and pushes the result.
849
850 \item \livetarg{chap:DWOPmod}{DW\-\_OP\-\_mod}\\
851 The \livelink{chap:DWOPmod}{DW\-\_OP\-\_mod} operation pops the top two stack values and pushes the result of the
852 calculation: former second stack entry modulo the former top of the stack.
853
854 \item \livetarg{chap:DWOPmul}{DW\-\_OP\-\_mul} \\
855 The \livelink{chap:DWOPmul}{DW\-\_OP\-\_mul} operation pops the top two stack entries, multiplies them together, and
856 pushes the result.
857
858 \item  \livetarg{chap:DWOPneg}{DW\-\_OP\-\_neg} \\
859 The \livelink{chap:DWOPneg}{DW\-\_OP\-\_neg} operation pops the top stack entry, interprets
860 it as a signed value and pushes its negation. If the negation
861 cannot be represented, the result is undefined.
862
863 \item  \livetarg{chap:DWOPnot}{DW\-\_OP\-\_not} \\
864 The \livelink{chap:DWOPnot}{DW\-\_OP\-\_not} operation pops the top stack entry, and pushes
865 its bitwise complement.
866
867 \item  \livetarg{chap:DWOPor}{DW\-\_OP\-\_or} \\
868 The \livelink{chap:DWOPor}{DW\-\_OP\-\_or} operation pops the top two stack entries, performs
869 a bitwise or operation on the two, and pushes the result.
870
871 \item  \livetarg{chap:DWOPplus}{DW\-\_OP\-\_plus} \\
872 The \livelink{chap:DWOPplus}{DW\-\_OP\-\_plus} operation pops the top two stack entries,
873 adds them together, and pushes the result.
874
875 \item  \livetarg{chap:DWOPplusuconst}{DW\-\_OP\-\_plus\-\_uconst} \\
876 The \livelink{chap:DWOPplusuconst}{DW\-\_OP\-\_plus\-\_uconst} operation pops the top stack entry,
877 adds it to the unsigned LEB128 constant operand and pushes
878 the result.
879
880 \textit{This operation is supplied specifically to be
881 able to encode more field offsets in two bytes than can be
882 done with
883 \doublequote{\livelink{chap:DWOPlit}{DW\-\_OP\-\_lit\textit{n}} \livelink{chap:DWOPplus}{DW\-\_OP\-\_plus}}.}
884
885 \needspace{3\baselineskip}
886 \item \livetarg{chap:DWOPshl}{DW\-\_OP\-\_shl} \\
887 The \livelink{chap:DWOPshl}{DW\-\_OP\-\_shl} operation pops the top two stack entries,
888 shifts the former second entry left (filling with zero bits)
889 by the number of bits specified by the former top of the stack,
890 and pushes the result.
891
892 \item \livetarg{chap:DWOPshr}{DW\-\_OP\-\_shr} \\
893 The \livelink{chap:DWOPshr}{DW\-\_OP\-\_shr} operation pops the top two stack entries,
894 shifts the former second entry right logically (filling with
895 zero bits) by the number of bits specified by the former top
896 of the stack, and pushes the result.
897
898 \item \livetarg{chap:DWOPshra}{DW\-\_OP\-\_shra} \\
899 The \livelink{chap:DWOPshra}{DW\-\_OP\-\_shra} operation pops the top two stack entries,
900 shifts the former second entry right arithmetically (divide
901 the magnitude by 2, keep the same sign for the result) by
902 the number of bits specified by the former top of the stack,
903 and pushes the result.
904
905 \item \livetarg{chap:DWOPxor}{DW\-\_OP\-\_xor} \\
906 The \livelink{chap:DWOPxor}{DW\-\_OP\-\_xor} operation pops the top two stack entries,
907 performs a bitwise exclusive\dash or operation on the two, and
908 pushes the result.
909
910 \end{enumerate}
911
912 \subsubsection{Control Flow Operations}
913 \label{chap:controlflowoperations}
914 The 
915 \addtoindexx{DWARF expression!control flow operations}
916 following operations provide simple control of the flow of a DWARF expression.
917 \begin{enumerate}[1.]
918 \item  \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} \\
919 The six relational operators each:
920 \begin{itemize}
921 \item pop the top two stack values,
922
923 \item compare the operands:
924 \textless~former second entry~\textgreater  \textless~relational operator~\textgreater \textless~former top entry~\textgreater
925
926 \item push the constant value 1 onto the stack 
927 if the result of the operation is true or the
928 constant value 0 if the result of the operation is false.
929 \end{itemize}
930
931 Comparisons are performed as signed operations. The six
932 operators are \livelink{chap:DWOPle}{DW\-\_OP\-\_le} (less than or equal to), \livelink{chap:DWOPge}{DW\-\_OP\-\_ge}
933 (greater than or equal to), \livelink{chap:DWOPeq}{DW\-\_OP\-\_eq} (equal to), \livelink{chap:DWOPlt}{DW\-\_OP\-\_lt} (less
934 than), \livelink{chap:DWOPgt}{DW\-\_OP\-\_gt} (greater than) and \livelink{chap:DWOPne}{DW\-\_OP\-\_ne} (not equal to).
935
936 \item \livetarg{chap:DWOPskip}{DW\-\_OP\-\_skip} \\
937 \livelink{chap:DWOPskip}{DW\-\_OP\-\_skip} is an unconditional branch. Its single operand
938 is a 2\dash byte signed integer constant. The 2\dash byte constant is
939 the number of bytes of the DWARF expression to skip forward
940 or backward from the current operation, beginning after the
941 2\dash byte constant.
942
943 \item \livetarg{chap:DWOPbra}{DW\-\_OP\-\_bra} \\
944 \livelink{chap:DWOPbra}{DW\-\_OP\-\_bra} is a conditional branch. Its single operand is a
945 2\dash byte signed integer constant.  This operation pops the
946 top of stack. If the value popped is not the constant 0,
947 the 2\dash byte constant operand is the number of bytes of the
948 DWARF expression to skip forward or backward from the current
949 operation, beginning after the 2\dash byte constant.
950
951 % The following item does not correctly hyphenate leading
952 % to an overfull hbox and a visible artifact. 
953 % So we use \- to suggest hyphenation in this rare situation.
954 \item \livetarg{chap:DWOPcall2}{DW\-\_OP\-\_call2}, \livetarg{chap:DWOPcall4}{DW\-\_OP\-\_call4}, \livetarg{chap:DWOPcallref}{DW\-\_OP\-\_call\-\_ref} \\
955 \livelink{chap:DWOPcall2}{DW\-\_OP\-\_call2}, \livelink{chap:DWOPcall4}{DW\-\_OP\-\_call4}, 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 \item \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  &Before & Operation&& 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 lexical
1092 \livelink{chap:lexicalblock}{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
1139 \begin{enumerate}[1.]
1140 \item A simple location description, representing an object
1141 \addtoindexx{location description!simple}
1142 which 
1143 \addtoindexx{simple location description}
1144 exists in one contiguous piece at the given location, or 
1145 \item A composite location description consisting of one or more
1146 \addtoindexx{location description!composite}
1147 simple location descriptions, each of which is followed by
1148 one composition operation. Each simple location description
1149 describes the location of one piece of the object; each
1150 composition operation describes which part of the object is
1151 located there. Each simple location description that is a
1152 DWARF expression is evaluated independently of any others
1153 (as though on its own separate stack, if any). 
1154 \end{enumerate}
1155
1156
1157
1158 \subsubsection{Simple Location Descriptions}
1159
1160
1161 \addtoindexx{location description!simple}
1162 simple location description consists of one 
1163 contiguous piece or all of an object or value.
1164
1165
1166 \subsubsubsection{Memory Location Descriptions}
1167
1168 \addtoindexx{location description!memory}
1169 memory location description 
1170 \addtoindexx{memory location description}
1171 consists of a non\dash empty DWARF
1172 expression (see 
1173 Section \refersec{chap:dwarfexpressions}
1174 ), whose value is the address of
1175 a piece or all of an object or other entity in memory.
1176
1177 \subsubsubsection{Register Location Descriptions}
1178 A register location description consists of a register name
1179 operation, which represents a piece or all of an object
1180 located in a given register.
1181
1182 \textit{Register location descriptions describe an object
1183 (or a piece of an object) that resides in a register, while
1184 the opcodes listed in 
1185 Section \refersec{chap:registerbasedaddressing}
1186 are used to describe an object (or a piece of
1187 an object) that is located in memory at an address that is
1188 contained in a register (possibly offset by some constant). A
1189 register location description must stand alone as the entire
1190 description of an object or a piece of an object.
1191 }
1192
1193 The following DWARF operations can be used to name a register.
1194
1195
1196 \textit{Note that the register number represents a DWARF specific
1197 mapping of numbers onto the actual registers of a given
1198 architecture. The mapping should be chosen to gain optimal
1199 density and should be shared by all users of a given
1200 architecture. It is recommended that this mapping be defined
1201 by the ABI authoring committee for each architecture.
1202 }
1203 \begin{enumerate}[1.]
1204 \item \livetarg{chap:DWOPreg0}{DW\-\_OP\-\_reg0}, \livetarg{chap:DWOPreg1}{DW\-\_OP\-\_reg1}, ..., \livetarg{chap:DWOPreg31}{DW\-\_OP\-\_reg31} \\
1205 The \livetarg{chap:DWOPreg}{DW\-\_OP\-\_reg}n operations encode the names of up to 32
1206 registers, numbered from 0 through 31, inclusive. The object
1207 addressed is in register n.
1208
1209 \item \livetarg{chap:DWOPregx}{DW\-\_OP\-\_regx} \\
1210 The \livelink{chap:DWOPregx}{DW\-\_OP\-\_regx} operation has a single unsigned LEB128 literal
1211 operand that encodes the name of a register.  
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
1221 \subsubsubsection{Implicit Location Descriptions}
1222 An \addtoindex{implicit location description}
1223 represents a piece or all
1224 \addtoindexx{location description!implicit}
1225 of an object which has no actual location but whose contents
1226 are nonetheless either known or known to be undefined.
1227
1228 The following DWARF operations may be used to specify a value
1229 that has no location in the program but is a known constant
1230 or is computed from other locations and values in the program.
1231
1232 The following DWARF operations may be used to specify a value
1233 that has no location in the program but is a known constant
1234 or is computed from other locations and values in the program.
1235
1236 \begin{enumerate}[1.]
1237 \item \livetarg{chap:DWOPimplicitvalue}{DW\-\_OP\-\_implicit\-\_value} \\
1238 The \livelink{chap:DWOPimplicitvalue}{DW\-\_OP\-\_implicit\-\_value} operation specifies an immediate value
1239 using two operands: an unsigned LEB128 length, followed by
1240 %FIXME: should this block be a reference? To what?
1241 a \nolink{block} representing the value in the memory representation
1242 of the target machine. The length operand gives the length
1243 in bytes of the \nolink{block}.
1244
1245 \item \livetarg{chap:DWOPstackvalue}{DW\-\_OP\-\_stack\-\_value} \\
1246 The \livelink{chap:DWOPstackvalue}{DW\-\_OP\-\_stack\-\_value} operation specifies that the object
1247 does not exist in memory but its value is nonetheless known
1248 and is at the top of the DWARF expression stack. In this form
1249 of location description, the DWARF expression represents the
1250 actual value of the object, rather than its location. The
1251 \livelink{chap:DWOPstackvalue}{DW\-\_OP\-\_stack\-\_value} operation terminates the expression.
1252 \end{enumerate}
1253
1254
1255 \paragraph{Empty Location Descriptions}
1256
1257 An \addtoindex{empty location description}
1258 consists of a DWARF expression
1259 \addtoindexx{location description!empty}
1260 containing no operations. It represents a piece or all of an
1261 object that is present in the source but not in the object code
1262 (perhaps due to optimization).
1263
1264 \subsubsection{Composite Location Descriptions}
1265 A composite location description describes an object or
1266 value which may be contained in part of a register or stored
1267 in more than one location. Each piece is described by a
1268 composition operation, which does not compute a value nor
1269 store any result on the DWARF stack. There may be one or
1270 more composition operations in a single composite location
1271 description. A series of such operations describes the parts
1272 of a value in memory address order.
1273
1274 Each composition operation is immediately preceded by a simple
1275 location description which describes the location where part
1276 of the resultant value is contained.
1277
1278 \begin{enumerate}[1.]
1279 \item \livetarg{chap:DWOPpiece}{DW\-\_OP\-\_piece} \\
1280 The \livelink{chap:DWOPpiece}{DW\-\_OP\-\_piece} operation takes a 
1281 single operand, which is an
1282 unsigned LEB128 number.  The number describes the size in bytes
1283 of the piece of the object referenced by the preceding simple
1284 location description. If the piece is located in a register,
1285 but does not occupy the entire register, the placement of
1286 the piece within that register is defined by the ABI.
1287
1288 \textit{Many compilers store a single variable in sets of registers,
1289 or store a variable partially in memory and partially in
1290 registers. \livelink{chap:DWOPpiece}{DW\-\_OP\-\_piece} provides a way of describing how large
1291 a part of a variable a particular DWARF location description
1292 refers to. }
1293
1294 \item \livetarg{chap:DWOPbitpiece}{DW\-\_OP\-\_bit\-\_piece} \\
1295 The \livelink{chap:DWOPbitpiece}{DW\-\_OP\-\_bit\-\_piece} operation takes two operands. The first
1296 is an unsigned LEB128 number that gives the size in bits
1297 of the piece. The second is an unsigned LEB128 number that
1298 gives the offset in bits from the location defined by the
1299 preceding DWARF location description.  
1300
1301 Interpretation of the
1302 offset depends on the kind of location description. If the
1303 location description is empty, the offset doesn\textquoteright t matter and
1304 the \livelink{chap:DWOPbitpiece}{DW\-\_OP\-\_bit\-\_piece} operation describes a piece consisting
1305 of the given number of bits whose values are undefined. If
1306 the location is a register, the offset is from the least
1307 significant bit end of the register. If the location is a
1308 memory address, the \livelink{chap:DWOPbitpiece}{DW\-\_OP\-\_bit\-\_piece} operation describes a
1309 sequence of bits relative to the location whose address is
1310 on the top of the DWARF stack using the bit numbering and
1311 direction conventions that are appropriate to the current
1312 language on the target system. If the location is any implicit
1313 value or stack value, the \livelink{chap:DWOPbitpiece}{DW\-\_OP\-\_bit\-\_piece} operation describes
1314 a sequence of bits using the least significant bits of that
1315 value.  
1316 \end{enumerate}
1317
1318 \textit{\livelink{chap:DWOPbitpiece}{DW\-\_OP\-\_bit\-\_piece} is 
1319 used instead of \livelink{chap:DWOPpiece}{DW\-\_OP\-\_piece} when
1320 the piece to be assembled into a value or assigned to is not
1321 byte-sized or is not at the start of a register or addressable
1322 unit of memory.}
1323
1324
1325
1326
1327 \subsubsection{Example Single Location Descriptions}
1328
1329 Here are some examples of how DWARF operations are used to form location descriptions:
1330
1331 \livetarg{chap:DWOPreg3}{DW\-\_OP\-\_reg3}
1332 \begin{myindentpara}{1cm}
1333 The value is in register 3.
1334 \end{myindentpara}
1335
1336 \livelink{chap:DWOPregx}{DW\-\_OP\-\_regx} 54
1337 \begin{myindentpara}{1cm}
1338 The value is in register 54.
1339 \end{myindentpara}
1340
1341 \livelink{chap:DWOPaddr}{DW\-\_OP\-\_addr} 0x80d0045c
1342 \begin{myindentpara}{1cm}
1343 The value of a static variable is at machine address 0x80d0045c.
1344 \end{myindentpara}
1345
1346 \livetarg{chap:DWOPbreg11}{DW\-\_OP\-\_breg11} 44
1347 \begin{myindentpara}{1cm}
1348 Add 44 to the value in register 11 to get the address of an automatic
1349 variable instance.
1350 \end{myindentpara}
1351
1352 \livelink{chap:DWOPfbreg}{DW\-\_OP\-\_fbreg} -50
1353 \begin{myindentpara}{1cm}
1354 Given a \livelink{chap:DWATframebase}{DW\-\_AT\-\_frame\-\_base} value of
1355 ``\livelink{chap:DWOPbreg31}{DW\-\_OP\-\_breg31} 64,'' this example
1356 computes the address of a local variable that is -50 bytes from a
1357 logical frame pointer that is computed by adding 64 to the current
1358 stack pointer (register 31).
1359 \end{myindentpara}
1360
1361 \needlines{3}
1362 \livelink{chap:DWOPbregx}{DW\-\_OP\-\_bregx} 54 32 \livelink{chap:DWOPderef}{DW\-\_OP\-\_deref}
1363 \begin{myindentpara}{1cm}
1364 A call-by-reference parameter whose address is in the word 32 bytes
1365 from where register 54 points.
1366 \end{myindentpara}
1367
1368 \livelink{chap:DWOPplusuconst}{DW\-\_OP\-\_plus\-\_uconst} 4
1369 \begin{myindentpara}{1cm}
1370 A structure member is four bytes from the start of the structure
1371 instance. The base address is assumed to be already on the stack.
1372 \end{myindentpara}
1373
1374 \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
1375 \begin{myindentpara}{1cm}
1376 A variable whose first four bytes reside in register 3 and whose next
1377 two bytes reside in register 10.
1378 \end{myindentpara}
1379
1380 \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
1381 \begin{myindentpara}{1cm}
1382 A twelve byte value whose first four bytes reside in register zero,
1383 whose middle four bytes are unavailable (perhaps due to optimization),
1384 and whose last four bytes are in memory, 12 bytes before the frame
1385 base.
1386 \end{myindentpara}
1387
1388 \livelink{chap:DWOPbreg1}{DW\-\_OP\-\_breg1} 0 \livetarg{chap:DWOPbreg2}{DW\-\_OP\-\_breg2} 0 \livelink{chap:DWOPplus}{DW\-\_OP\-\_plus} \livelink{chap:DWOPstackvalue}{DW\-\_OP\-\_stack\-\_value}
1389 \begin{myindentpara}{1cm}
1390 Add the contents of r1 and r2 to compute a value. This value is the
1391 \doublequote{contents} of an otherwise anonymous location.
1392 \end{myindentpara}
1393
1394 \livelink{chap:DWOPlit1}{DW\-\_OP\-\_lit1} \livelink{chap:DWOPstackvalue}{DW\-\_OP\-\_stack\-\_value} \livelink{chap:DWOPpiece}{DW\-\_OP\-\_piece} 4 \\
1395 \livetarg{chap:DWOPbreg3}{DW\-\_OP\-\_breg3} 0 \livetarg{chap:DWOPbreg4}{DW\-\_OP\-\_breg4} 0 \livelink{chap:DWOPplus}{DW\-\_OP\-\_plus} \livelink{chap:DWOPstackvalue}{DW\-\_OP\-\_stack\-\_value} \livelink{chap:DWOPpiece}{DW\-\_OP\-\_piece} 4
1396 \begin{myindentpara}{1cm}
1397 The object value is found in an anonymous (virtual) location whose
1398 value consists of two parts, given in memory address order: the 4 byte
1399 value 1 followed by the four byte value computed from the sum of the
1400 contents of r3 and r4.
1401 \end{myindentpara}
1402
1403
1404 \subsection{Location Lists}
1405 \label{chap:locationlists}
1406 Location lists 
1407 \addtoindexx{location list}
1408 are used in place of location expressions
1409 whenever the object whose location is being described
1410 can change location during its lifetime. 
1411 Location lists
1412 \addtoindexx{location list}
1413 are contained in a separate object file section called
1414 \addtoindex{.debug\_loc}. A location list is indicated by a location
1415 attribute whose value is an offset from the beginning of
1416 the \addtoindex{.debug\_loc} section to the first byte of the list for the
1417 object in question.
1418
1419 Each entry in a location list is either a location 
1420 \addtoindexi{list}{address selection|see{base address selection}} 
1421 entry,
1422
1423 \addtoindexi{base}{base address selection entry!in location list} 
1424 address selection entry, 
1425 \addtoindexx{location list!base address selection entry}
1426 or an 
1427 \addtoindexx{end of list entry!in location list}
1428 end of list entry.
1429
1430
1431 \addtoindexx{location list!entry}
1432 location list entry consists of:
1433 \begin{enumerate}[1.]
1434 \item A beginning address offset. 
1435 This address offset has the \addtoindex{size of an address} and is
1436 relative to the applicable base address of the compilation
1437 unit referencing this location list. It marks the beginning
1438 of the address 
1439 \addtoindexi{range}{address range!in location list} 
1440 over which the location is valid.
1441
1442 \item An ending address offset.  This address offset again
1443 has the \addtoindex{size of an address} and is relative to the applicable
1444 base address of the compilation unit referencing this location
1445 list. It marks the first address past the end of the address
1446 range over which the location is valid. The ending address
1447 must be greater than or equal to the beginning address.
1448
1449 \textit{A location list entry (but not a base address selection or 
1450 end of list entry) whose beginning
1451 and ending addresses are equal has no effect 
1452 because the size of the range covered by such
1453 an entry is zero.}
1454
1455 \item A \addtoindex{single location description} 
1456 describing the location of the object over the range specified by
1457 the beginning and end addresses.
1458 \end{enumerate}
1459
1460 The applicable base address of a 
1461 location list entry is
1462 \addtoindexx{location list!base address selection entry}
1463 determined by the closest preceding base address selection
1464 entry (see below) in the same location list. If there is
1465 no such selection entry, then the applicable base address
1466 defaults to the base address of the compilation unit (see
1467 Section \refersec{chap:normalandpartialcompilationunitentries}).  
1468
1469 \textit{In the case of a compilation unit where all of
1470 the machine code is contained in a single contiguous section,
1471 no base address selection entry is needed.}
1472
1473 Address ranges may overlap. When they do, they describe a
1474 situation in which an object exists simultaneously in more than
1475 one place. If all of the address ranges in a given location
1476 list do not collectively cover the entire range over which the
1477 object in question is defined, it is assumed that the object is
1478 not available for the portion of the range that is not covered.
1479
1480 A base 
1481 \addtoindexi{address}{address selection|see{base address selection}}
1482 selection 
1483 \addtoindexi{entry}{base address selection entry!in location list}
1484 consists of:
1485 \begin{enumerate}[1.]
1486 \item The value of the largest representable 
1487 address offset (for example, 0xffffffff when the size of
1488 an address is 32 bits).
1489 \item An address, which defines the 
1490 appropriate base address for use in interpreting the beginning
1491 and ending address offsets of subsequent entries of the location list.
1492 \end{enumerate}
1493
1494
1495 \textit{A base address selection entry 
1496 affects only the list in which it is contained.}
1497
1498 The end of any given location list is marked by an 
1499 \addtoindexx{location list!enf of list entry}
1500 end of list entry, which consists of a 0 for the beginning address
1501 offset and a 0 for the ending address offset. A location list
1502 containing only an 
1503 \addtoindexx{end of list entry!in location list}
1504 end of list entry describes an object that
1505 exists in the source code but not in the executable program.
1506
1507 Neither a base address selection entry nor an end of list
1508 entry includes a location description.
1509
1510 \textit{A base address selection entry and an end of list
1511 entry for a location list are identical to a base address
1512 selection entry and end of list entry, respectively, for a
1513 \addtoindex{range list}
1514 (see Section \refersec{chap:noncontiguousaddressranges}) 
1515 in interpretation
1516 and representation.}
1517
1518
1519 \section{Types of Program Entities}
1520 \label{chap:typesofprogramentities}
1521 Any 
1522 \hypertarget{chap:DWATtypetypeofdeclaration}
1523 debugging information entry describing a declaration that
1524 has a type has 
1525 \addtoindexx{type attribute}
1526 a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute, whose value is a
1527 reference to another debugging information entry. The entry
1528 referenced may describe a base type, that is, a type that is
1529 not defined in terms of other data types, or it may describe a
1530 user-defined type, such as an array, structure or enumeration.
1531 Alternatively, the entry referenced may describe a type
1532 modifier, such as constant, packed, pointer, reference or
1533 volatile, which in turn will reference another entry describing
1534 a type or type modifier (using 
1535 \addtoindexx{type attribute}
1536 a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute of its
1537 own). See 
1538 Section  \refersec{chap:typeentries} 
1539 for descriptions of the entries describing
1540 base types, user-defined types and type modifiers.
1541
1542
1543
1544 \section{Accessibility of Declarations}
1545 \label{chap:accessibilityofdeclarations}
1546 \textit{Some languages, notably C++ and 
1547 \addtoindex{Ada}, have the concept of
1548 the accessibility of an object or of some other program
1549 entity. The accessibility specifies which classes of other
1550 program objects are permitted access to the object in question.}
1551
1552 The accessibility of a declaration is 
1553 \hypertarget{chap:DWATaccessibilitycandadadeclarations}
1554 represented by a 
1555 \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility} 
1556 attribute, whose
1557 \addtoindexx{accessibility attribute}
1558 value is a constant drawn from the set of codes listed in Table 
1559 \refersec{tab:accessibilitycodes}.
1560
1561 \begin{simplenametable}[1.9in]{Accessibility codes}{tab:accessibilitycodes}
1562 \livetarg{chap:DWACCESSpublic}{DW\-\_ACCESS\-\_public}          \\
1563 \livetarg{chap:DWACCESSprivate}{DW\-\_ACCESS\-\_private}        \\
1564 \livetarg{chap:DWACCESSprotected}{DW\-\_ACCESS\-\_protected}    \\
1565 \end{simplenametable}
1566
1567 \section{Visibility of Declarations}
1568 \label{chap:visibilityofdeclarations}
1569
1570 \textit{Several languages (such as \addtoindex{Modula-2}) 
1571 have the concept of the visibility of a declaration. The
1572 visibility specifies which declarations are to be 
1573 visible outside of the entity in which they are
1574 declared.}
1575
1576 The 
1577 \hypertarget{chap:DWATvisibilityvisibilityofdeclaration}
1578 visibility of a declaration is represented 
1579 by a \livelink{chap:DWATvisibility}{DW\-\_AT\-\_visibility}
1580 attribute\addtoindexx{visibility attribute}, whose value is a
1581 constant drawn from the set of codes listed in 
1582 Table \refersec{tab:visibilitycodes}.
1583
1584 \begin{simplenametable}[1.5in]{Visibility Codes}{tab:visibilitycodes}
1585 \livetarg{chap:DWVISlocal}{DW\-\_VIS\-\_local}          \\
1586 \livetarg{chap:DWVISexported}{DW\-\_VIS\-\_exported}    \\
1587 \livetarg{chap:DWVISqualified}{DW\-\_VIS\-\_qualified}  \\
1588 \end{simplenametable}
1589
1590 \section{Virtuality of Declarations}
1591 \label{chap:virtualityofdeclarations}
1592 \textit{C++ provides for virtual and pure virtual structure or class
1593 member functions and for virtual base classes.}
1594
1595 The 
1596 \hypertarget{chap:DWATvirtualityvirtualityindication}
1597 virtuality of a declaration is represented by a
1598 \livelink{chap:DWATvirtuality}{DW\-\_AT\-\_virtuality}
1599 attribute\addtoindexx{virtuality attribute}, whose value is a constant drawn
1600 from the set of codes listed in 
1601 Table \refersec{tab:virtualitycodes}.
1602
1603 \begin{simplenametable}[2.4in]{Virtuality codes}{tab:virtualitycodes}
1604 \livetarg{chap:DWVIRTUALITYnone}{DW\-\_VIRTUALITY\-\_none}                      \\
1605 \livetarg{chap:DWVIRTUALITYvirtual}{DW\-\_VIRTUALITY\-\_virtual}                \\
1606 \livetarg{chap:DWVIRTUALITYpurevirtual}{DW\-\_VIRTUALITY\-\_pure\-\_virtual}    \\
1607 \end{simplenametable}
1608
1609 \section{Artificial Entries}
1610 \label{chap:artificialentries}
1611 \textit{A compiler may wish to generate debugging information entries
1612 for objects or types that were not actually declared in the
1613 source of the application. An example is a formal parameter
1614 %FIXME: The word 'this' should be rendered like a variant italic,
1615 %FIXME: not as a quoted name. Changed to tt font--RB
1616 entry to represent the 
1617 \addtoindexx{\texttt{this} parameter}
1618 hidden \texttt{this} parameter that most C++
1619 implementations pass as the first argument to non-static member
1620 functions.}  
1621
1622 Any debugging information entry representing the
1623 \addtoindexx{artificial attribute}
1624 declaration of an object or type artificially generated by
1625 a compiler and not explicitly declared by the source program
1626 \hypertarget{chap:DWATartificialobjectsortypesthat}
1627 may have a 
1628 \livelink{chap:DWATartificial}{DW\-\_AT\-\_artificial} attribute, 
1629 which is a \livelink{chap:flag}{flag}.
1630
1631 \section{Segmented Addresses}
1632 \label{chap:segmentedaddresses}
1633 \textit{In some systems, addresses are specified as offsets within a
1634 given 
1635 \addtoindexx{address space!segmented}
1636 segment 
1637 \addtoindexx{segmented addressing|see{address space}}
1638 rather than as locations within a single flat
1639 \addtoindexx{address space!flat}.
1640 address space.}
1641
1642 Any debugging information entry that contains a description
1643 \hypertarget{chap:DWATsegmentaddressinginformation}
1644 of the location of an object or subroutine may have
1645
1646 \livelink{chap:DWATsegment}{DW\-\_AT\-\_segment} attribute, 
1647 \addtoindexx{segment attribute}
1648 whose value is a location
1649 description. The description evaluates to the segment selector
1650 of the item being described. If the entry containing the
1651 \livelink{chap:DWATsegment}{DW\-\_AT\-\_segment} attribute has a 
1652 \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc}, 
1653 \livelink{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc},
1654 \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} or 
1655 \livelink{chap:DWATentrypc}{DW\-\_AT\-\_entry\-\_pc} attribute, 
1656 \addtoindexx{entry pc attribute}
1657 or 
1658 a location
1659 description that evaluates to an address, then those address
1660 values represent the offset portion of the address within
1661 the segment specified 
1662 \addtoindexx{segment attribute}
1663 by \livelink{chap:DWATsegment}{DW\-\_AT\-\_segment}.
1664
1665 If an entry has no 
1666 \livelink{chap:DWATsegment}{DW\-\_AT\-\_segment} attribute, it inherits
1667 \addtoindexx{segment attribute}
1668 the segment value from its parent entry.  If none of the
1669 entries in the chain of parents for this entry back to
1670 its containing compilation unit entry have 
1671 \livelink{chap:DWATsegment}{DW\-\_AT\-\_segment} attributes, 
1672 then the entry is assumed to exist within a flat
1673 address space. 
1674 Similarly, if the entry has a 
1675 \livelink{chap:DWATsegment}{DW\-\_AT\-\_segment} attribute 
1676 \addtoindexx{segment attribute}
1677 containing an empty location description, that
1678 entry is assumed to exist within a 
1679 \addtoindexi{flat}{address space!flat}.
1680 address space.
1681
1682 \textit{Some systems support different classes of 
1683 addresses
1684 \addtoindexx{address class!attribute}. 
1685 The
1686 address class may affect the way a pointer is dereferenced
1687 or the way a subroutine is called.}
1688
1689
1690 Any debugging information entry representing a pointer or
1691 reference type or a subroutine or subroutine type may 
1692 have a 
1693 \livelink{chap:DWATaddressclass}{DW\-\_AT\-\_address\-\_class}
1694 attribute, whose value is an integer
1695 constant.  The set of permissible values is specific to
1696 each target architecture. The value \livetarg{chap:DWADDRnone}{DW\-\_ADDR\-\_none}, 
1697 however,
1698 is common to all encodings, and means that no address class
1699 has been specified.
1700
1701 \textit {For example, the Intel386 \texttrademark\  processor might use the following values:}
1702
1703 \begin{table}[here]
1704 \caption{Example address class codes}
1705 \label{tab:inteladdressclasstable}
1706 \centering
1707 \begin{tabular}{l|c|l}
1708 \hline
1709 Name&Value&Meaning  \\
1710 \hline
1711 \textit{DW\-\_ADDR\-\_none}&   0 & \textit{no class specified} \\
1712 \textit{DW\-\_ADDR\-\_near16}& 1 & \textit{16\dash bit offset, no segment} \\
1713 \textit{DW\-\_ADDR\-\_far16}&  2 & \textit{16\dash bit offset, 16\dash bit segment} \\
1714 \textit{DW\-\_ADDR\-\_huge16}& 3 & \textit{16\dash bit offset, 16\dash bit segment} \\
1715 \textit{DW\-\_ADDR\-\_near32}& 4 & \textit{32\dash bit offset, no segment} \\
1716 \textit{DW\-\_ADDR\-\_far32}&  5 & \textit{32\dash bit offset, 16\dash bit segment} \\
1717 \hline
1718 \end{tabular}
1719 \end{table}
1720
1721 \section{Non-Defining Declarations and Completions}
1722 \label{nondefiningdeclarationsandcompletions}
1723 A debugging information entry representing a program entity
1724 typically represents the defining declaration of that
1725 entity. In certain contexts, however, a debugger might need
1726 information about a declaration of an entity that is not
1727 \addtoindexx{incomplete declaration}
1728 also a definition, or is otherwise incomplete, to evaluate
1729 \hypertarget{chap:DWATdeclarationincompletenondefiningorseparateentitydeclaration}
1730 an expression correctly.
1731
1732 \textit{As an example, consider the following fragment of \addtoindex{C} code:}
1733
1734 \begin{lstlisting}
1735 void myfunc()
1736 {
1737   int x;
1738   {
1739     extern float x;
1740     g(x);
1741   }
1742 }
1743 \end{lstlisting}
1744
1745
1746 \textit{\addtoindex{C} scoping rules require that the 
1747 value of the variable x passed to the function g is the value of the
1748 global variable x rather than of the local version.}
1749
1750 \subsection{Non-Defining Declarations}
1751 A debugging information entry that 
1752 represents a non-defining or 
1753 \addtoindex{non-defining declaration}
1754 otherwise 
1755 \addtoindex{incomplete declaration}
1756 of a program entity has 
1757 \addtoindexx{declaration attribute}
1758
1759 \livelink{chap:DWATdeclaration}{DW\-\_AT\-\_declaration} 
1760 attribute, which is a 
1761 \livelink{chap:flag}{flag}.
1762
1763 \subsection{Declarations Completing Non-Defining Declarations}
1764 A debugging information entry that represents a 
1765 \hypertarget{chap:DWATspecificationincompletenondefiningorseparatedeclaration}
1766 declaration that completes another (earlier) 
1767 non\dash defining declaration may have a 
1768 \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification}
1769 attribute whose value is a reference to
1770 the debugging information entry representing the non-defining declaration. A debugging
1771 information entry with a 
1772 \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification} 
1773 attribute does not need to duplicate information
1774 provided by the debugging information entry referenced by that specification attribute.
1775
1776 It is not the case that all attributes of the debugging information entry referenced by a
1777 \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification} attribute 
1778 apply to the referring debugging information entry.
1779
1780 \textit{For 
1781 \addtoindexx{declaration attribute}
1782 example,
1783 \livelink{chap:DWATsibling}{DW\-\_AT\-\_sibling} and 
1784 \livelink{chap:DWATdeclaration}{DW\-\_AT\-\_declaration} 
1785 \addtoindexx{declaration attribute}
1786 clearly cannot apply to a 
1787 \addtoindexx{declaration attribute}
1788 referring
1789 \addtoindexx{sibling attribute}
1790 entry.}
1791
1792
1793
1794 \section{Declaration Coordinates}
1795 \label{chap:declarationcoordinates}
1796 \textit{It is 
1797 \addtoindexx{declaration coordinates}
1798 sometimes useful in a debugger to be able to associate
1799 a declaration with its occurrence in the program source.
1800 }
1801
1802 Any debugging information 
1803 \hypertarget{chap:DWATdeclfilefilecontainingsourcedeclaration}
1804 entry 
1805 \hypertarget{chap:DWATdecllinelinenumberofsourcedeclaration}
1806 representing 
1807 \hypertarget{chap:DWATdeclcolumncolumnpositionofsourcedeclaration}
1808 the
1809 \addtoindexx{line number of declaration}
1810 declaration of an object, module, subprogram or
1811 \addtoindex{declaration column attribute}
1812 type 
1813 \addtoindex{declaration file attribute}
1814 may 
1815 \addtoindex{declaration line attribute}
1816 have
1817 \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file}, 
1818 \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} and 
1819 \livelink{chap:DWATdeclcolumn}{DW\-\_AT\-\_decl\-\_column}
1820 attributes each of whose value is an unsigned integer constant.
1821
1822 The value of 
1823 \addtoindex{declaration file attribute}
1824 the 
1825 \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file}
1826 attribute 
1827 \addtoindexx{file containing declaration}
1828 corresponds to
1829 a file number from the line number information table for the
1830 compilation unit containing the debugging information entry and
1831 represents the source file in which the declaration appeared
1832 (see Section \refersec{chap:linenumberinformation}). 
1833 The value 0 indicates that no source file
1834 has been specified.
1835
1836 The value of 
1837 \addtoindex{declaration line attribute}
1838 the \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} attribute represents
1839 the source line number at which the first character of
1840 the identifier of the declared object appears. The value 0
1841 indicates that no source line has been specified.
1842
1843 The value of 
1844 \addtoindex{declaration column attribute}
1845 the \livelink{chap:DWATdeclcolumn}{DW\-\_AT\-\_decl\-\_column} attribute represents
1846 the source column number at which the first character of
1847 the identifier of the declared object appears. The value 0
1848 indicates that no column has been specified.
1849
1850 \section{Identifier Names}
1851 \label{chap:identifiernames}
1852 Any 
1853 \hypertarget{chap:DWATnamenameofdeclaration}
1854 debugging information entry 
1855 \addtoindexx{identifier names}
1856 representing 
1857 \addtoindexx{names!identifier}
1858 a program entity
1859 that has been given a name may have a 
1860 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute,
1861 whose 
1862 \addtoindexx{name attribute}
1863 value is a string representing the name as it appears in
1864 the source program. A debugging information entry containing
1865 no name attribute, or containing a name attribute whose value
1866 consists of a name containing a single null byte, represents
1867 a program entity for which no name was given in the source.
1868
1869 \textit{Because the names of program objects described by DWARF are the
1870 names as they appear in the source program, implementations
1871 of language translators that use some form of mangled name
1872 \addtoindex{mangled names}
1873 (as do many implementations of C++) should use the unmangled
1874 form of the name in the 
1875 DWARF \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute,
1876 \addtoindexx{name attribute}
1877 including the keyword operator (in names such as \doublequote{operator +}),
1878 if present. See also 
1879 Section \refersec{chap:linkagenames} regarding the use
1880 of \livelink{chap:DWATlinkagename}{DW\-\_AT\-\_linkage\-\_name} for 
1881 \addtoindex{mangled names}
1882 mangled names. 
1883 Sequences of
1884 multiple whitespace characters may be compressed.}
1885
1886 \section{Data Locations and DWARF Procedures}
1887 Any debugging information entry describing a data object (which
1888 \hypertarget{chap:DWATlocationdataobjectlocation}
1889 includes variables and parameters) or 
1890 common \livelink{chap:commonblockentry}{block}
1891 may have 
1892 \addtoindexx{location attribute}
1893 a
1894 \livelink{chap:DWATlocation}{DW\-\_AT\-\_location} attribute
1895 \addtoindexx{location attribute}
1896 , whose value is a location description
1897 (see Section \refersec{chap:locationdescriptions}).
1898
1899
1900 \addtoindex{DWARF procedure}
1901 is represented by any
1902 kind of debugging information entry that has 
1903 \addtoindexx{location attribute}
1904
1905 \livelink{chap:DWATlocation}{DW\-\_AT\-\_location}
1906 attribute. 
1907 \addtoindexx{location attribute}
1908 If a suitable entry is not otherwise available,
1909 a DWARF procedure can be represented using a debugging
1910 \addtoindexx{DWARF procedure entry}
1911 information entry with the 
1912 tag \livetarg{chap:DWTAGdwarfprocedure}{DW\-\_TAG\-\_dwarf\-\_procedure}
1913 together with 
1914 \addtoindexx{location attribute}
1915 a \livelink{chap:DWATlocation}{DW\-\_AT\-\_location} attribute.  
1916
1917 A DWARF procedure
1918 is called by a \livelink{chap:DWOPcall2}{DW\-\_OP\-\_call2}, 
1919 \livelink{chap:DWOPcall4}{DW\-\_OP\-\_call4} or 
1920 \livelink{chap:DWOPcallref}{DW\-\_OP\-\_call\-\_ref}
1921 DWARF expression operator 
1922 (see Section \refersec{chap:controlflowoperations}).
1923
1924 \section{Code Addresses and Ranges}
1925 \label{chap:codeaddressesandranges}
1926 Any debugging information entry describing an entity that has
1927 a machine code address or range of machine code addresses,
1928 which includes compilation units, module initialization,
1929 \hypertarget{chap:DWATrangesnoncontiguousrangeofcodeaddresses}
1930 subroutines, ordinary \livelink{chap:lexicalblock}{block}, 
1931 try/catch \nolink{blocks} (see Section\refersec{chap:tryandcatchblockentries}), 
1932 labels 
1933 \hypertarget{chap:DWATlowpccodeaddressorrangeofaddresses}
1934 and
1935 \hypertarget{chap:DWAThighpccontiguousrangeofcodeaddresses}
1936 the like, may have
1937
1938 \begin{itemize}
1939 \item A \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} attribute for
1940 a single address,
1941
1942 \item A \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} and 
1943 \livelink{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc} pair of 
1944 attributes 
1945 \addtoindexx{high PC attribute}
1946 for 
1947 \addtoindexx{low PC attribute}
1948 a single contiguous range of
1949 addresses, or
1950
1951 \item A \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} attribute 
1952 \addtoindexx{ranges attribute}
1953 for a non-contiguous range of addresses.
1954 \end{itemize}
1955
1956 In addition, a non-contiguous range of 
1957 addresses may also be specified for the
1958 \livelink{chap:DWATstartscope}{DW\-\_AT\-\_start\-\_scope} attribute.
1959 \addtoindexx{start scope attribute}
1960
1961 If an entity has no associated machine code, 
1962 none of these attributes are specified.
1963
1964 \subsection{Single Address} 
1965 When there is a single address associated with an entity,
1966 such as a label or alternate entry point of a subprogram,
1967 the entry has a \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} attribute whose value is the
1968 relocated address for the entity.
1969
1970 \textit{While the \livelink{chap:DWATentrypc}{DW\-\_AT\-\_entry\-\_pc}
1971 attribute might also seem appropriate for this purpose,
1972 historically the \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} attribute was used before the
1973 \livelink{chap:DWATentrypc}{DW\-\_AT\-\_entry\-\_pc} was introduced 
1974 (in \addtoindex{DWARF Version 3}). There is
1975 insufficient reason to change this.}
1976
1977 \subsection{Continuous Address Range}
1978 \label{chap:contiguousaddressranges}
1979 When the set of addresses of a debugging information entry can
1980 be described as a single contiguous range, the entry 
1981 \addtoindexx{high PC attribute}
1982 may 
1983 \addtoindexx{low PC attribute}
1984 have
1985 a \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} and 
1986 \livelink{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc} pair of attributes. 
1987 The value
1988 of the 
1989 \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} attribute 
1990 is the relocated address of the
1991 first instruction associated with the entity. If the value of
1992 the \livelink{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc} is of class address, it is the relocated
1993 address of the first location past the last instruction
1994 associated with the entity; if it is of class constant, the
1995 value is an unsigned integer offset which when added to the
1996 low PC gives the address of the first location past the last
1997 instruction associated with the entity.
1998
1999 \textit{The high PC value
2000 may be beyond the last valid instruction in the executable.}
2001
2002 The presence of low and high PC attributes for an entity
2003 implies that the code generated for the entity is contiguous
2004 and exists totally within the boundaries specified by those
2005 two attributes. If that is not the case, no low and high PC
2006 attributes should be produced.
2007
2008 \subsection{Non\dash Contiguous Address Ranges}
2009 \label{chap:noncontiguousaddressranges}
2010 When the set of addresses of a debugging information entry
2011 \addtoindexx{non-contiguous address ranges}
2012 cannot be described as a single contiguous range, the entry has
2013 a \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} attribute 
2014 \addtoindexx{ranges attribute}
2015 whose value is of class \livelink{chap:rangelistptr}{rangelistptr}
2016 and indicates the beginning of a \addtoindex{range list}.
2017 Similarly,
2018 a \livelink{chap:DWATstartscope}{DW\-\_AT\-\_start\-\_scope} attribute 
2019 \addtoindexx{start scope attribute}
2020 may have a value of class
2021 \livelink{chap:rangelistptr}{rangelistptr} for the same reason.  
2022
2023 Range lists are contained
2024 in a separate object file section called 
2025 \addtoindex{.debug\_ranges}. A
2026 \addtoindex{range list} is indicated by a 
2027 \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} attribute whose
2028 \addtoindexx{ranges attribute}
2029 value is represented as an offset from the beginning of the
2030 \addtoindex{.debug\_ranges} section to the beginning of the 
2031 \addtoindex{range list}.
2032
2033 Each entry in a \addtoindex{range list} is either a 
2034 \addtoindex{range list} entry,
2035 \addtoindexx{base address selection entry!in range list}
2036 a base address selection entry, or an 
2037 \addtoindexx{end of list entry!in range list}
2038 end of list entry.
2039
2040 A \addtoindex{range list} entry consists of:
2041
2042 \begin{enumerate}[1.]
2043 \item A beginning address offset. This address offset has the 
2044 \addtoindex{size of an address} and is relative to
2045 the applicable base address of the compilation unit referencing this 
2046 \addtoindex{range list}. 
2047 It marks the
2048 beginning of an 
2049 \addtoindexi{address}{address range!in range list} 
2050 range.
2051
2052 \item An ending address offset. This address offset again has the 
2053 \addtoindex{size of an address} and is relative
2054 to the applicable base address of the compilation unit referencing 
2055 this \addtoindex{range list}.
2056 It marks the
2057 first address past the end of the address range.
2058 The ending address must be greater than or
2059 equal to the beginning address.
2060
2061 \textit{A \addtoindex{range list} entry (but not a base address selection or end of list entry) whose beginning and
2062 ending addresses are equal has no effect because the size of the range covered by such an
2063 entry is zero.}
2064 \end{enumerate}
2065
2066 The applicable base address of a \addtoindex{range list} entry
2067 is determined
2068 by the closest preceding base address selection entry (see
2069 below) in the same range list. If there is no such selection
2070 entry, then the applicable base address defaults to the base
2071 address of the compilation unit 
2072 (see Section \refersec{chap:normalandpartialcompilationunitentries}).
2073
2074 \textit{In the case of a compilation unit where all of the machine
2075 code is contained in a single contiguous section, no base
2076 address selection entry is needed.}
2077
2078 Address range entries in
2079 a \addtoindex{range list} may not overlap.
2080 There is no requirement that
2081 the entries be ordered in any particular way.
2082
2083 A base address selection entry consists of:
2084
2085 \begin{enumerate}[1.]
2086 \item The value of the largest representable address offset (for example, 0xffffffff when the size of
2087 an address is 32 bits).
2088
2089 \item An address, which defines the appropriate base address for use in interpreting the beginning
2090 and ending address offsets of subsequent entries of the location list.
2091 \end{enumerate}
2092 \textit{A base address selection entry 
2093 affects only the list in which it is contained.}
2094
2095
2096 The end of any given \addtoindex{range list} is marked by an 
2097 \addtoindexx{end of list entry!in range list}
2098 end of list entry, 
2099 which consists of a 0 for the beginning address
2100 offset and a 0 for the ending address offset. 
2101 A \addtoindex{range list}
2102 containing only an end of list entry describes an empty scope
2103 (which contains no instructions).
2104
2105 \textit{A base address selection entry and an 
2106 \addtoindexx{end of list entry!in range list}
2107 end of list entry for
2108 a \addtoindex{range list} 
2109 are identical to a base address selection entry
2110 and end of list entry, respectively, for a location list
2111 (see Section \refersec{chap:locationlists}) 
2112 in interpretation and representation.}
2113
2114
2115
2116 \section{Entry Address}
2117 \label{chap:entryaddress}
2118 \textit{The entry or first executable instruction generated
2119 for an entity, if applicable, is often the lowest addressed
2120 instruction of a contiguous range of instructions. In other
2121 cases, the entry address needs to be specified explicitly.}
2122
2123 Any debugging information entry describing an entity that has
2124 a range of code addresses, which includes compilation units,
2125 module initialization, subroutines, 
2126 ordinary \livelink{chap:lexicalblock}{block}, 
2127 try/catch \nolink{blocks} (see Section \refersec{chap:tryandcatchblockentries}),
2128 and the like, 
2129 may have a \livelink{chap:DWATentrypc}{DW\-\_AT\-\_entry\-\_pc} attribute to
2130 indicate the first executable instruction within that range
2131 of addresses. The value of the \livelink{chap:DWATentrypc}{DW\-\_AT\-\_entry\-\_pc} attribute is a
2132 relocated address. If no \livelink{chap:DWATentrypc}{DW\-\_AT\-\_entry\-\_pc} attribute is present,
2133 then the entry address is assumed to be the same as the
2134 value of the \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} attribute, if present; otherwise,
2135 the entry address is unknown.
2136
2137 \section{Static and Dynamic Values of Attributes}
2138 \label{chap:staticanddynamicvaluesofattributes}
2139
2140 Some attributes that apply to types specify a property (such
2141 as the lower bound of an array) that is an integer value,
2142 where the value may be known during compilation or may be
2143 computed dynamically during execution.
2144
2145 The value of these
2146 attributes is determined based on the class as follows:
2147
2148 \begin{itemize}
2149 \item For a \livelink{chap:constant}{constant}, the value of the constant is the value of
2150 the attribute.
2151
2152 \item For a \livelink{chap:reference}{reference}, the
2153 value is a reference to another
2154 entity which specifies the value of the attribute.
2155
2156 \item For an \livelink{chap:exprloc}{exprloc}, the value is interpreted as a 
2157 DWARF expression; 
2158 evaluation of the expression yields the value of
2159 the attribute.
2160 \end{itemize}
2161
2162 \textit{%
2163 Whether an attribute value can be dynamic depends on the
2164 rules of the applicable programming language.
2165 }
2166
2167 \textit{The applicable attributes include: 
2168 \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated},
2169 \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated}, 
2170 \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset}, 
2171 \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size},
2172 \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, 
2173 \livelink{chap:DWATcount}{DW\-\_AT\-\_count}, 
2174 \livelink{chap:DWATlowerbound}{DW\-\_AT\-\_lower\-\_bound},
2175 \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride}, 
2176 \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride}, 
2177 \livelink{chap:DWATupperbound}{DW\-\_AT\-\_upper\-\_bound} (and
2178 possibly others).}
2179
2180
2181 \section{Entity Descriptions}
2182 \textit{Some debugging information entries may describe entities
2183 in the program that are artificial, or which otherwise are
2184 ``named'' in ways which are not valid identifiers in the
2185 programming language. For example, several languages may
2186 capture or freeze the value of a variable at a particular
2187 point in the program. 
2188 \addtoindex{Ada} 95 has package elaboration routines,
2189 type descriptions of the form typename\textquoteright Class, and 
2190 ``access typename'' parameters.  }
2191
2192 Generally, any debugging information
2193 entry that 
2194 \hypertarget{chap:DWATdescriptionartificialnameordescription}
2195 has, or may have, 
2196 \addtoindexx{name attribute}
2197
2198 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, may
2199 also have 
2200 \addtoindexx{description attribute}
2201
2202 \livelink{chap:DWATdescription}{DW\-\_AT\-\_description} attribute whose value is a
2203 null-terminated string providing a description of the entity.
2204
2205
2206 \textit{It is expected that a debugger will only display these
2207 descriptions as part of the description of other entities. It
2208 should not accept them in expressions, nor allow them to be
2209 assigned, or the like.}
2210
2211 \section{Byte and Bit Sizes}
2212 \label{chap:byteandbitsizes}
2213 % Some trouble here with hbox full, so we try optional word breaks.
2214 Many debugging information entries allow either a
2215 \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute or a \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute,
2216 whose integer constant value 
2217 (see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
2218 specifies an
2219 amount of storage. The value of the \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute
2220 is interpreted in bytes and the value of the \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size}
2221 attribute is interpreted in bits.  
2222
2223 Similarly, the integer
2224 constant value of a \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride} attribute is interpreted
2225 in bytes and the integer constant value of a \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride}
2226 attribute is interpreted in bits.
2227
2228 \section{Linkage Names}
2229 \label{chap:linkagenames}
2230 \textit{Some language implementations, notably 
2231 \addtoindex{C++} and similar
2232 languages, 
2233 make use of implementation-defined names within
2234 object files that are different from the identifier names
2235 (see Section \refersec{chap:identifiernames}) of entities as they appear in the
2236 source. Such names, sometimes known 
2237 \addtoindex{names!mangled}
2238 as 
2239 \addtoindexx{mangled names}
2240 mangled names,
2241 are used in various ways, such as: to encode additional
2242 information about an entity, to distinguish multiple entities
2243 that have the same name, and so on. When an entity has an
2244 associated distinct linkage name it may sometimes be useful
2245 for a producer to include this name in the DWARF description
2246 of the program to facilitate consumer access to and use of
2247 object file information about an entity and/or information
2248 \hypertarget{chap:DWATlinkagenameobjectfilelinkagenameofanentity}
2249 that is encoded in the linkage name itself.  
2250 }
2251
2252 % Some trouble maybe with hbox full, so we try optional word breaks.
2253 A debugging
2254 information entry may have 
2255 \addtoindexx{linkage name attribute}
2256
2257 \livelink{chap:DWATlinkagename}{DW\-\_AT\-\_linkage\-\_name}
2258 attribute
2259 whose value is a null-terminated string describing the object
2260 file linkage name associated with the corresponding entity.
2261
2262 % Some trouble here with hbox full, so we try optional word breaks.
2263 \textit{Debugging information entries to which \livelink{chap:DWATlinkagename}{DW\-\_AT\-\_linkage\-\_name}
2264 may apply include: \livelink{chap:DWTAGcommonblock}{DW\-\_TAG\-\_common\-\_block}, \livelink{chap:DWTAGconstant}{DW\-\_TAG\-\_constant},
2265 \livelink{chap:DWTAGentrypoint}{DW\-\_TAG\-\_entry\-\_point}, \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram} 
2266 and \livelink{chap:DWTAGvariable}{DW\-\_TAG\-\_variable}.
2267 }