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