f5f1b38719c502bc96e4bbecc2a5b0dadbb38128
[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 ``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} (\#define, \#undef)\\
310 \livetarg{chap:DWATmainsubprogram}{DW\_AT\_main\_subprogram}
311 &\livelinki{chap:DWATmainsubprogrammainorstartingsubprogram}{Main or starting subprogram}{main or starting subprogram} \\
312 &\livelinki{chap:DWATmainsubprogramunitcontainingmainorstartingsubprogram}{Unit containing main or starting subprogram}{unit containing main or starting subprogram}\\
313 \livetarg{chap:DWATmutable}{DW\_AT\_mutable}
314 &\livelinki{chap:DWATmutablemutablepropertyofmemberdata}{Mutable property of member data}{mutable property of member data} \\
315 \livetarg{chap:DWATname}{DW\_AT\_name}
316 &\livelinki{chap:DWATnamenameofdeclaration}{Name of declaration}{name of declaration}\\
317 &\livelinki{chap:DWATnamepathnameofcompilationsource}{Path name of compilation source}{path name of compilation source} \\
318 \livetarg{chap:DWATnamelistitem}{DW\_AT\_namelist\_item}
319 &\livelinki{chap:DWATnamelistitemnamelistitem}{Namelist item}{namelist item}\\
320 \livetarg{chap:DWATobjectpointer}{DW\_AT\_object\_pointer}
321 &\livelinki{chap:DWATobjectpointerobjectthisselfpointerofmemberfunction}{Object (this, self) pointer of member function}{object (this, self) pointer of member function}\\
322 \livetarg{chap:DWATordering}{DW\_AT\_ordering}
323 &\livelinki{chap:DWATorderingarrayrowcolumnordering}{Array row/column ordering} {array row/column ordering}\\
324 \livetarg{chap:DWATpicturestring}{DW\_AT\_picture\_string}
325 &\livelinki{chap:DWATpicturestringpicturestringfornumericstringtype}{Picture string for numeric string type}{picture string for numeric string type} \\
326 \livetarg{chap:DWATpriority}{DW\_AT\_priority}
327 &\livelinki{chap:DWATprioritymodulepriority}{Module priority}{module priority}\\
328 \livetarg{chap:DWATproducer}{DW\_AT\_producer}
329 &\livelinki{chap:DWATproducercompileridentification}{Compiler identification}{compiler identification}\\
330 \livetarg{chap:DWATprototyped}{DW\_AT\_prototyped}
331 &\livelinki{chap:DWATprototypedsubroutineprototype}{Subroutine prototype}{subroutine prototype}\\
332 \livetarg{chap:DWATpure}{DW\_AT\_pure}
333 &\livelinki{chap:DWATpurepurepropertyofasubroutine}{Pure property of a subroutine}{pure property of a subroutine} \\
334 \livetarg{chap:DWATranges}{DW\_AT\_ranges}
335 &\livelinki{chap:DWATrangesnoncontiguousrangeofcodeaddresses}{Non-contiguous range of code addresses}{non-contiguous range of code addresses} \\
336 \livetarg{chap:DWATrecursive}{DW\_AT\_recursive}
337 &\livelinki{chap:DWATrecursiverecursivepropertyofasubroutine}{Recursive property of a subroutine}{recursive property of a subroutine} \\
338 \livetarg{chap:DWATreturnaddr}{DW\_AT\_return\_addr}
339 &\livelinki{chap:DWATreturnaddrsubroutinereturnaddresssavelocation}{Subroutine return address save location}{subroutine return address save location} \\
340 \livetarg{chap:DWATsegment}{DW\_AT\_segment}
341 &\livelinki{chap:DWATsegmentaddressinginformation}{Addressing information}{addressing information} \\
342 \livetarg{chap:DWATsibling}{DW\_AT\_sibling}
343 &\livelinki{chap:DWATsiblingdebugginginformationentryrelationship}{Debugging information entry relationship}{debugging information entry relationship} \\
344 \livetarg{chap:DWATsmall}{DW\_AT\_small}
345 &\livelinki{chap:DWATsmallscalefactorforfixedpointtype}{Scale factor for fixed-point type}{scale factor for fixed-point type} \\
346 \livetarg{chap:DWATsignature}{DW\_AT\_signature}
347 &\livelinki{chap:DWATsignaturetypesignature}{Type signature}{type signature}\\
348 \livetarg{chap:DWATspecification}{DW\_AT\_specification}
349 &\livelinki{chap:DWATspecificationincompletenondefiningorseparatedeclaration}{Incomplete, non-defining, or separate declaration corresponding to a declaration}{incomplete, non-defining, or separate declaration corresponding to a declaration} \\
350 \livetarg{chap:DWATstartscope}{DW\_AT\_start\_scope}
351 &\livelinki{chap:DWATstartscopeobjectdeclaration}{Object declaration}{object declaration}\\
352 &\livelinki{chap:DWATstartscopetypedeclaration}{Type declaration}{type declaration}\\
353 \livetarg{chap:DWATstaticlink}{DW\_AT\_static\_link}
354 &\livelinki{chap:DWATstaticlinklocationofuplevelframe}{Location of uplevel frame}{location of uplevel frame} \\
355 \livetarg{chap:DWATstmtlist}{DW\_AT\_stmt\_list}
356 &\livelinki{chap:DWATstmtlistlinenumberinformationforunit}{Line number information for unit}{line number information for unit}\\
357 \livetarg{chap:DWATstringlength}{DW\_AT\_string\_length}
358 &\livelinki{chap:DWATstringlengthstringlengthofstringtype}{String length of string type}{string length of string type}
359  \\
360 \livetarg{chap:DWATthreadsscaled}{DW\_AT\_threads\_scaled}
361 &\livelink{chap:DWATthreadsscaledupcarrayboundthreadsscalfactor}{UPC!array bound THREADS scale factor}\\
362 \livetarg{chap:DWATtrampoline}{DW\_AT\_trampoline}
363 &\livelinki{chap:DWATtrampolinetargetsubroutine}{Target subroutine}{target subroutine of trampoline} \\
364 \livetarg{chap:DWATtype}{DW\_AT\_type}
365 &\livelinki{chap:DWATtypetypeofdeclaration}{Type of declaration}{type of declaration} \\
366 &\livelinki{chap:DWATtypetypeofsubroutinereturn}{Type of subroutine return}{type of subroutine return} \\
367 \livetarg{chap:DWATupperbound}{DW\_AT\_upper\_bound}
368 &\livelinki{chap:DWATupperboundupperboundofsubrange}{Upper bound of subrange}{upper bound of subrange} \\
369 \livetarg{chap:DWATuselocation}{DW\_AT\_use\_location}
370 &\livelinki{chap:DWATuselocationmemberlocationforpointertomembertype}{Member location for pointer to member type}{member location for pointer to member type} \\
371 \livetarg{chap:DWATuseUTF8}{DW\_AT\_use\_UTF8}\addtoindexx{use UTF8 attribute}\addtoindexx{UTF-8}
372 &\livelinki{chap:DWATuseUTF8compilationunitusesutf8strings}{Compilation unit uses UTF-8 strings}{compilation unit uses UTF-8 strings} \\
373 \livetarg{chap:DWATvariableparameter}{DW\_AT\_variable\_parameter}
374 &\livelinki{chap:DWATvariableparameternonconstantparameterflag}{Non-constant parameter flag}{non-constant parameter flag}  \\
375 \livetarg{chap:DWATvirtuality}{DW\_AT\_virtuality}
376 &\livelinki{chap:DWATvirtualityvirtualityindication}{Virtuality indication}{virtuality indication} \\
377 &\livelinki{chap:DWATvirtualityvirtualityofbaseclass}{Virtuality of base class} {virtuality of base class} \\
378 &\livelinki{chap:DWATvirtualityvirtualityoffunction}{Virtuality of function}{virtuality of function} \\
379 \livetarg{chap:DWATvisibility}{DW\_AT\_visibility}
380 &\livelinki{chap:DWATvisibilityvisibilityofdeclaration}{Visibility of declaration}{visibility of declaration} \\
381 \livetarg{chap:DWATvtableelemlocation}{DW\_AT\_vtable\_elem\_location}
382 &\livelinki{chap:DWATvtableelemlocationvirtualfunctiontablevtableslot}{Virtual function vtable slot}{virtual function vtable slot}\\
383 \end{longtable}
384
385 \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 ``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 \itembfnl{\livetarg{chap:DWOPxderef}{DW\_OP\_xderef}}
764 The \livetarg{chap:DWOPxderef}{DW\_OP\_xderef} operation provides an extended dereference
765 mechanism. The entry at the top of the stack is treated as an
766 address. The second stack entry is treated as an \doublequote{address
767 space identifier} for those architectures that support
768 \addtoindexi{multiple}{address space!multiple}
769 address spaces. The top two stack elements are popped,
770 and a data item is retrieved through an implementation-defined
771 address calculation and pushed as the new stack top. The size
772 of the data retrieved from the 
773 \addtoindexi{dereferenced}{address!dereference operator}
774 address is the
775 \addtoindex{size of an address} on the target machine.
776
777 \itembfnl{\livetarg{chap:DWOPxderefsize}{DW\_OP\_xderef\_size}}
778 The \livetarg{chap:DWOPxderefsize}{DW\_OP\_xderef\_size} operation behaves like the
779 \livelink{chap:DWOPxderef}{DW\_OP\_xderef} operation. The entry at the top of the stack is
780 treated as an address. The second stack entry is treated as
781 an \doublequote{address space identifier} for those architectures
782 that support 
783 \addtoindexi{multiple}{address space!multiple}
784 address spaces. The top two stack
785 elements are popped, and a data item is retrieved through an
786 implementation\dash defined address calculation and pushed as the
787 new stack top. In the \addtoindex{DW\_OP\_xderef\_size} operation, however,
788 the size in bytes of the data retrieved from the 
789 \addtoindexi{dereferenced}{address!dereference operator}
790 address is specified by the single operand. This operand is a
791 1\dash byte unsigned integral constant whose value may not be larger
792 than the \addtoindex{size of an address} on the target machine. The data
793 retrieved is zero extended to the \addtoindex{size of an address} on the
794 target machine before being pushed onto the expression stack.
795
796 \itembfnl{\livetarg{chap:DWOPpushobjectaddress}{DW\_OP\_push\_object\_address}}
797 The \livetarg{chap:DWOPpushobjectaddress}{DW\_OP\_push\_object\_address}
798 operation pushes the address
799 of the object currently being evaluated as part of evaluation
800 of a user presented expression. This object may correspond
801 to an independent variable described by its own debugging
802 information entry or it may be a component of an array,
803 structure, or class whose address has been dynamically
804 determined by an earlier step during user expression
805 evaluation.
806
807 \textit{This operator provides explicit functionality
808 (especially for arrays involving descriptors) that is analogous
809 to the implicit push of the base 
810 \addtoindexi{address}{address!implicit push of base}
811 of a structure prior to evaluation of a 
812 \livelink{chap:DWATdatamemberlocation}{DW\_AT\_data\_member\_location} 
813 to access a data member of a structure. For an example, see 
814 Appendix \refersec{app:aggregateexamples}.}
815
816 \needlines{4}
817 \itembfnl{\livetarg{chap:DWOPformtlsaddress}{DW\_OP\_form\_tls\_address}}
818 The \livetarg{chap:DWOPformtlsaddress}{DW\_OP\_form\_tls\_address} 
819 operation pops a value from the
820 stack, translates it into an address in the current thread's
821 \addtoindexx{thread-local storage}
822 thread\dash local storage \nolink{block}, and pushes the address. If the
823 DWARF expression containing 
824 the \addtoindex{DW\_OP\_form\_tls\_address}
825 operation belongs to the main executable's DWARF info, the
826 operation uses the main executable's thread\dash local storage
827 \nolink{block}; if the expression belongs to a shared library's
828 DWARF info, then it uses that shared library's 
829 \addtoindexx{thread-local storage}
830 thread\dash local storage \nolink{block}.
831
832 \textit{Some implementations of 
833 \addtoindex{C} and \addtoindex{C++} support a
834 \_\_thread storage class. Variables with this storage class
835 have distinct values and addresses in distinct threads, much
836 as automatic variables have distinct values and addresses in
837 each function invocation. Typically, there is a single \nolink{block}
838 of storage containing all \_\_thread variables declared in
839 the main executable, and a separate \nolink{block} for the variables
840 declared in each shared library. Computing the address of
841 the appropriate \nolink{block} can be complex (in some cases, the
842 compiler emits a function call to do it), and difficult
843 to describe using ordinary DWARF location descriptions.
844 \addtoindex{DW\_OP\_form\_tls\_address} leaves the computation to the
845 consumer.}
846
847 \itembfnl{\livetarg{chap:DWOPcallframecfa}{DW\_OP\_call\_frame\_cfa}}
848 The \livetarg{chap:DWOPcallframecfa}{DW\_OP\_call\_frame\_cfa} 
849 operation pushes the value of the
850 CFA, obtained from the Call Frame Information 
851 (see Section \refersec{chap:callframeinformation}).
852
853 \textit{Although the value of \addtoindex{DW\_AT\_frame\_base}
854 can be computed using other DWARF expression operators,
855 in some cases this would require an extensive location list
856 because the values of the registers used in computing the
857 CFA change during a subroutine. If the 
858 Call Frame Information 
859 is present, then it already encodes such changes, and it is
860 space efficient to reference that.}
861 \end{enumerate}
862
863 \subsubsection{Arithmetic and Logical Operations}
864 The 
865 \addtoindexx{DWARF expression!arithmetic operations}
866 following 
867 \addtoindexx{DWARF expression!logical operations}
868 provide arithmetic and logical operations. Except
869 as otherwise specified, the arithmetic operations perfom
870 addressing arithmetic, that is, unsigned arithmetic that is
871 performed modulo one plus the largest representable address
872 (for example, 0x100000000 when the 
873 \addtoindex{size of an address} is 32
874 bits). 
875 Such operations do not cause an exception on overflow.
876 \begin{enumerate}[1. ]
877 \itembfnl{\livetarg{chap:DWOPabs}{DW\_OP\_abs}}
878 The \livetarg{chap:DWOPabs}{DW\_OP\_abs} operation pops the top stack entry, interprets
879 it as a signed value and pushes its absolute value. If the
880 absolute value cannot be represented, the result is undefined.
881
882 \itembfnl{\livetarg{chap:DWOPand}{DW\_OP\_and}}
883 The \livetarg{chap:DWOPand}{DW\_OP\_and} operation pops the top two stack values, performs
884 a bitwise and operation on the two, and pushes the result.
885
886 \itembfnl{\livetarg{chap:DWOPdiv}{DW\_OP\_div}}
887 The \livetarg{chap:DWOPdiv}{DW\_OP\_div} operation pops the top two stack values, divides the former second entry by
888 the former top of the stack using signed division, and pushes the result.
889
890 \itembfnl{\livetarg{chap:DWOPminus}{DW\_OP\_minus}}
891 The \livetarg{chap:DWOPminus}{DW\_OP\_minus} operation pops the top two stack values, subtracts the former top of the
892 stack from the former second entry, and pushes the result.
893
894 \itembfnl{\livetarg{chap:DWOPmod}{DW\_OP\_mod}}
895 The \livetarg{chap:DWOPmod}{DW\_OP\_mod} operation pops the top two stack values and pushes the result of the
896 calculation: former second stack entry modulo the former top of the stack.
897
898 \itembfnl{\livetarg{chap:DWOPmul}{DW\_OP\_mul}}
899 The \livetarg{chap:DWOPmul}{DW\_OP\_mul} operation pops the top two stack entries, multiplies them together, and
900 pushes the result.
901
902 \itembfnl{\livetarg{chap:DWOPneg}{DW\_OP\_neg}}
903 The \livetarg{chap:DWOPneg}{DW\_OP\_neg} operation pops the top stack entry, interprets
904 it as a signed value and pushes its negation. If the negation
905 cannot be represented, the result is undefined.
906
907 \itembfnl{\livetarg{chap:DWOPnot}{DW\_OP\_not}}
908 The \livetarg{chap:DWOPnot}{DW\_OP\_not} operation pops the top stack entry, and pushes
909 its bitwise complement.
910
911 \itembfnl{\livetarg{chap:DWOPor}{DW\_OP\_or}}
912 The \livetarg{chap:DWOPor}{DW\_OP\_or} operation pops the top two stack entries, performs
913 a bitwise or operation on the two, and pushes the result.
914
915 \itembfnl{\livetarg{chap:DWOPplus}{DW\_OP\_plus}}
916 The \livetarg{chap:DWOPplus}{DW\_OP\_plus} operation pops the top two stack entries,
917 adds them together, and pushes the result.
918
919 \itembfnl{\livetarg{chap:DWOPplusuconst}{DW\_OP\_plus\_uconst}}
920 The \livetarg{chap:DWOPplusuconst}{DW\_OP\_plus\_uconst} operation pops the top stack entry,
921 adds it to the unsigned LEB128 constant operand and pushes
922 the result.
923
924 \textit{This operation is supplied specifically to be
925 able to encode more field offsets in two bytes than can be
926 done with
927 \doublequote{\livelink{chap:DWOPlit}{DW\_OP\_lit\textit{n}} \livelink{chap:DWOPplus}{DW\_OP\_plus}}.}
928
929 \needlines{3}
930 \itembfnl{\livetarg{chap:DWOPshl}{DW\_OP\_shl}}
931 The \livetarg{chap:DWOPshl}{DW\_OP\_shl} operation pops the top two stack entries,
932 shifts the former second entry left (filling with zero bits)
933 by the number of bits specified by the former top of the stack,
934 and pushes the result.
935
936 \itembfnl{\livetarg{chap:DWOPshr}{DW\_OP\_shr}}
937 The \livetarg{chap:DWOPshr}{DW\_OP\_shr} operation pops the top two stack entries,
938 shifts the former second entry right logically (filling with
939 zero bits) by the number of bits specified by the former top
940 of the stack, and pushes the result.
941
942 \needlines{6}
943 \itembfnl{\livetarg{chap:DWOPshra}{DW\_OP\_shra}}
944 The \livetarg{chap:DWOPshra}{DW\_OP\_shra} operation pops the top two stack entries,
945 shifts the former second entry right arithmetically (divide
946 the magnitude by 2, keep the same sign for the result) by
947 the number of bits specified by the former top of the stack,
948 and pushes the result.
949
950 \itembfnl{\livetarg{chap:DWOPxor}{DW\_OP\_xor}}
951 The \livetarg{chap:DWOPxor}{DW\_OP\_xor} operation pops the top two stack entries,
952 performs a bitwise exclusive\dash or operation on the two, and
953 pushes the result.
954
955 \end{enumerate}
956
957 \subsubsection{Control Flow Operations}
958 \label{chap:controlflowoperations}
959 The 
960 \addtoindexx{DWARF expression!control flow operations}
961 following operations provide simple control of the flow of a DWARF expression.
962 \begin{enumerate}[1. ]
963 \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}}
964 The six relational operators each:
965 \begin{itemize}
966 \item pop the top two stack values,
967
968 \item compare the operands:
969 \linebreak
970 \textless~former second entry~\textgreater  \textless~relational operator~\textgreater \textless~former top entry~\textgreater
971
972 \item push the constant value 1 onto the stack 
973 if the result of the operation is true or the
974 constant value 0 if the result of the operation is false.
975 \end{itemize}
976
977 Comparisons are performed as signed operations. The six
978 operators are \addtoindex{DW\_OP\_le} (less than or equal to), \addtoindex{DW\_OP\_ge}
979 (greater than or equal to), \addtoindex{DW\_OP\_eq} (equal to), \addtoindex{DW\_OP\_lt} (less
980 than), \addtoindex{DW\_OP\_gt} (greater than) and \addtoindex{DW\_OP\_ne} (not equal to).
981
982 \needlines{6}
983 \itembfnl{\livetarg{chap:DWOPskip}{DW\_OP\_skip}}
984 \livetarg{chap:DWOPskip}{DW\_OP\_skip} is an unconditional branch. Its single operand
985 is a 2\dash byte signed integer constant. The 2\dash byte constant is
986 the number of bytes of the DWARF expression to skip forward
987 or backward from the current operation, beginning after the
988 2\dash byte constant.
989
990 \itembfnl{\livetarg{chap:DWOPbra}{DW\_OP\_bra}}
991 \livetarg{chap:DWOPbra}{DW\_OP\_bra} is a conditional branch. Its single operand is a
992 2\dash byte signed integer constant.  This operation pops the
993 top of stack. If the value popped is not the constant 0,
994 the 2\dash byte constant operand is the number of bytes of the
995 DWARF expression to skip forward or backward from the current
996 operation, beginning after the 2\dash byte constant.
997
998 % The following item does not correctly hyphenate leading
999 % to an overfull hbox and a visible artifact. 
1000 % So we use \- to suggest hyphenation in this rare situation.
1001 \itembfnl{\livetarg{chap:DWOPcall2}{DW\_OP\_call2}, \livetarg{chap:DWOPcall4}{DW\_OP\_call4}, \livetarg{chap:DWOPcallref}{DW\_OP\_call\_ref}}
1002 \addtoindex{DW\_OP\_call2}, 
1003 \addtoindex{DW\_OP\_call4}, 
1004 and \addtoindex{DW\_OP\_call\_ref} perform
1005 subroutine calls during evaluation of a DWARF expression or
1006 location description. 
1007 For \addtoindex{DW\_OP\_call2} and \addtoindex{DW\_OP\_call4}, 
1008 the operand is the 2\dash~ or 4\dash byte unsigned offset, respectively,
1009 of a debugging information entry in the current compilation
1010 unit. The \addtoindex{DW\_OP\_call\_ref} operator has a single operand. In the
1011 \thirtytwobitdwarfformat,
1012 the operand is a 4\dash byte unsigned value;
1013 in the \sixtyfourbitdwarfformat, it is an 8\dash byte unsigned value
1014 (see Section \refersec{datarep:32bitand64bitdwarfformats}). 
1015 The operand is used as the offset of a
1016 debugging information entry in a 
1017 \dotdebuginfo{}
1018 or
1019 \dotdebugtypes{}
1020 section which may be contained in a shared object or executable
1021 other than that containing the operator. For references from
1022 one shared object or executable to another, the relocation
1023 must be performed by the consumer.  
1024
1025 \textit{Operand interpretation of
1026 \addtoindex{DW\_OP\_call2}, \addtoindex{DW\_OP\_call4} and \addtoindex{DW\_OP\_call\_ref} is exactly like
1027 that for \livelink{chap:DWFORMref2}{DW\_FORM\_ref2}, \livelink{chap:DWFORMref4}{DW\_FORM\_ref4} and \livelink{chap:DWFORMrefaddr}{DW\_FORM\_ref\_addr},
1028 respectively  
1029 (see Section  \refersec{datarep:attributeencodings}).  
1030 }
1031
1032 These operations transfer
1033 control of DWARF expression evaluation to 
1034 \addtoindexx{location attribute}
1035 the 
1036 \livelink{chap:DWATlocation}{DW\_AT\_location}
1037 attribute of the referenced debugging information entry. If
1038 there is no such attribute, then there is no effect. Execution
1039 of the DWARF expression of 
1040 \addtoindexx{location attribute}
1041
1042 \livelink{chap:DWATlocation}{DW\_AT\_location} attribute may add
1043 to and/or remove from values on the stack. Execution returns
1044 to the point following the call when the end of the attribute
1045 is reached. Values on the stack at the time of the call may be
1046 used as parameters by the called expression and values left on
1047 the stack by the called expression may be used as return values
1048 by prior agreement between the calling and called expressions.
1049 \end{enumerate}
1050
1051 \needlines{7}
1052 \subsubsection{Special Operations}
1053 There 
1054 \addtoindexx{DWARF expression!special operations}
1055 is one special operation currently defined:
1056 \begin{enumerate}[1. ]
1057 \itembfnl{\livetarg{chap:DWOPnop}{DW\_OP\_nop}}
1058 The \livetarg{chap:DWOPnop}{DW\_OP\_nop} operation is a place holder. It has no effect
1059 on the location stack or any of its values.
1060 \end{enumerate}
1061
1062 \subsection{Example Stack Operations}
1063 \textit {The 
1064 \addtoindexx{DWARF expression!examples}
1065 stack operations defined in 
1066 Section \refersec{chap:stackoperations}.
1067 are fairly conventional, but the following
1068 examples illustrate their behavior graphically.}
1069
1070 \begin{longtable}[c]{rrcrr} 
1071 \multicolumn{2}{c}{Before} & Operation & \multicolumn{2}{c}{After} \\
1072 \hline
1073 \endhead
1074 \endfoot
1075 0& 17& \livelink{chap:DWOPdup}{DW\_OP\_dup} &0 &17 \\
1076 1&   29& &  1 & 17 \\
1077 2& 1000 & & 2 & 29\\
1078 & & &         3&1000\\
1079
1080 & & & & \\
1081 0 & 17 & \livelink{chap:DWOPdrop}{DW\_OP\_drop} & 0 & 29 \\
1082 1 &29  &            & 1 & 1000 \\
1083 2 &1000& & &          \\
1084
1085 & & & & \\
1086 0 & 17 & \livelink{chap:DWOPpick}{DW\_OP\_pick, 2} & 0 & 1000 \\
1087 1 & 29 & & 1&17 \\
1088 2 &1000& &2&29 \\
1089   &    & &3&1000 \\
1090
1091 & & & & \\
1092 0&17& \livelink{chap:DWOPover}{DW\_OP\_over}&0&29 \\
1093 1&29& &  1&17 \\
1094 2&1000 & & 2&29\\
1095  &     & & 3&1000 \\
1096
1097 & & & & \\
1098 0&17& \livelink{chap:DWOPswap}{DW\_OP\_swap} &0&29 \\
1099 1&29& &  1&17 \\
1100 2&1000 & & 2&1000 \\
1101
1102 & & & & \\
1103 0&17&\livelink{chap:DWOProt}{DW\_OP\_rot} & 0 &29 \\
1104 1&29 & & 1 & 1000 \\
1105 2& 1000 & &  2 & 17 \\
1106 \end{longtable}
1107
1108 \section{Location Descriptions}
1109 \label{chap:locationdescriptions}
1110 \textit{Debugging information 
1111 \addtoindexx{location description}
1112 must 
1113 \addtoindexx{location description|see{\textit{also} DWARF expression}}
1114 provide consumers a way to find
1115 the location of program variables, determine the bounds
1116 of dynamic arrays and strings, and possibly to find the
1117 base address of a subroutine\textquoteright s stack frame or the return
1118 address of a subroutine. Furthermore, to meet the needs of
1119 recent computer architectures and optimization techniques,
1120 debugging information must be able to describe the location of
1121 an object whose location changes over the object\textquoteright s lifetime.}
1122
1123 Information about the location of program objects is provided
1124 by location descriptions. Location descriptions can be either
1125 of two forms:
1126 \begin{enumerate}[1. ]
1127 \item \textit{Single location descriptions}, 
1128 which 
1129 \addtoindexx{location description!single}
1130 are 
1131 \addtoindexx{single location description}
1132 a language independent representation of
1133 addressing rules of arbitrary complexity built from 
1134 DWARF expressions (See Section \refersec{chap:dwarfexpressions}) 
1135 and/or other
1136 DWARF operations specific to describing locations. They are
1137 sufficient for describing the location of any object as long
1138 as its lifetime is either static or the same as the 
1139 \livelink{chap:lexicalblock}{lexical block} that owns it, 
1140 and it does not move during its lifetime.
1141
1142 Single location descriptions are of two kinds:
1143 \begin{enumerate}[a) ]
1144 \item Simple location descriptions, which describe the location
1145 \addtoindexx{location description!simple}
1146 of one contiguous piece (usually all) of an object. A simple
1147 location description may describe a location in addressable
1148 memory, or in a register, or the lack of a location (with or
1149 without a known value).
1150
1151 \item  Composite location descriptions, which describe an
1152 \addtoindexx{location description!composite}
1153 object in terms of pieces each of which may be contained in
1154 part of a register or stored in a memory location unrelated
1155 to other pieces.
1156
1157 \end{enumerate}
1158 \item \textit{Location lists}, which are used to 
1159 \addtoindexx{location list}
1160 describe
1161 \addtoindexx{location description!use in location list}
1162 objects that have a limited lifetime or change their location
1163 during their lifetime. Location lists are more completely
1164 described below.
1165
1166 \end{enumerate}
1167
1168 The two forms are distinguished in a context sensitive
1169 manner. As the value of an attribute, a location description
1170 is encoded using 
1171 \addtoindexx{exprloc class}
1172 class \livelink{chap:classexprloc}{exprloc}  
1173 and a location list is encoded
1174 using class \livelink{chap:classloclistptr}{loclistptr}
1175 (which 
1176 \addtoindex{loclistptr}
1177 serves as an offset into a
1178 separate 
1179 \addtoindexx{location list}
1180 location list table).
1181
1182
1183 \subsection{Single Location Descriptions}
1184 A single location description is either:
1185 \begin{enumerate}[1. ]
1186 \item A simple location description, representing an object
1187 \addtoindexx{location description!simple}
1188 which 
1189 \addtoindexx{simple location description}
1190 exists in one contiguous piece at the given location, or 
1191 \item A composite location description consisting of one or more
1192 \addtoindexx{location description!composite}
1193 simple location descriptions, each of which is followed by
1194 one composition operation. Each simple location description
1195 describes the location of one piece of the object; each
1196 composition operation describes which part of the object is
1197 located there. Each simple location description that is a
1198 DWARF expression is evaluated independently of any others
1199 (as though on its own separate stack, if any). 
1200 \end{enumerate}
1201
1202
1203
1204 \subsubsection{Simple Location Descriptions}
1205
1206
1207 \addtoindexx{location description!simple}
1208 simple location description consists of one 
1209 contiguous piece or all of an object or value.
1210
1211
1212 \subsubsubsection{Memory Location Descriptions}
1213
1214 \addtoindexx{location description!memory}
1215 memory location description 
1216 \addtoindexx{memory location description}
1217 consists of a non\dash empty DWARF
1218 expression (see 
1219 Section \refersec{chap:dwarfexpressions}
1220 ), whose value is the address of
1221 a piece or all of an object or other entity in memory.
1222
1223 \subsubsubsection{Register Location Descriptions}
1224 A register location description consists of a register name
1225 operation, which represents a piece or all of an object
1226 located in a given register.
1227
1228 \textit{Register location descriptions describe an object
1229 (or a piece of an object) that resides in a register, while
1230 the opcodes listed in 
1231 Section \refersec{chap:registerbasedaddressing}
1232 are used to describe an object (or a piece of
1233 an object) that is located in memory at an address that is
1234 contained in a register (possibly offset by some constant). A
1235 register location description must stand alone as the entire
1236 description of an object or a piece of an object.
1237 }
1238
1239 The following DWARF operations can be used to name a register.
1240
1241
1242 \textit{Note that the register number represents a DWARF specific
1243 mapping of numbers onto the actual registers of a given
1244 architecture. The mapping should be chosen to gain optimal
1245 density and should be shared by all users of a given
1246 architecture. It is recommended that this mapping be defined
1247 by the ABI authoring committee for each architecture.
1248 }
1249 \begin{enumerate}[1. ]
1250 \itembfnl{\livetarg{chap:DWOPreg0}{DW\_OP\_reg0}, \livetarg{chap:DWOPreg1}{DW\_OP\_reg1}, ..., \livetarg{chap:DWOPreg31}{DW\_OP\_reg31}}
1251 The \livetarg{chap:DWOPreg}{DW\_OP\_reg}\textit{n} operations encode the names of up to 32
1252 registers, numbered from 0 through 31, inclusive. The object
1253 addressed is in register \textit{n}.
1254
1255 \itembfnl{\livetarg{chap:DWOPregx}{DW\_OP\_regx}}
1256 The \livetarg{chap:DWOPregx}{DW\_OP\_regx} operation has a single unsigned LEB128 literal
1257 operand that encodes the name of a register.  
1258
1259 \end{enumerate}
1260
1261 \textit{These operations name a register location. To
1262 fetch the contents of a register, it is necessary to use
1263 one of the register based addressing operations, such as
1264 \livelink{chap:DWOPbregx}{DW\_OP\_bregx} 
1265 (Section \refersec{chap:registerbasedaddressing})}.
1266
1267 \subsubsubsection{Implicit Location Descriptions}
1268 An \addtoindex{implicit location description}
1269 represents a piece or all
1270 \addtoindexx{location description!implicit}
1271 of an object which has no actual location but whose contents
1272 are nonetheless either known or known to be undefined.
1273
1274 The following DWARF operations may be used to specify a value
1275 that has no location in the program but is a known constant
1276 or is computed from other locations and values in the program.
1277
1278 The following DWARF operations may be used to specify a value
1279 that has no location in the program but is a known constant
1280 or is computed from other locations and values in the program.
1281 \begin{enumerate}[1. ]
1282 \itembfnl{\livetarg{chap:DWOPimplicitvalue}{DW\_OP\_implicit\_value}}
1283 The \livetarg{chap:DWOPimplicitvalue}{DW\_OP\_implicit\_value} 
1284 operation specifies an immediate value
1285 using two operands: an unsigned LEB128 length, followed by
1286 %FIXME: should this block be a reference? To what?
1287 a \nolink{block} representing the value in the memory representation
1288 of the target machine. The length operand gives the length
1289 in bytes of the \nolink{block}.
1290
1291 \itembfnl{\livetarg{chap:DWOPstackvalue}{DW\_OP\_stack\_value}}
1292 The \livetarg{chap:DWOPstackvalue}{DW\_OP\_stack\_value} 
1293 operation specifies that the object
1294 does not exist in memory but its value is nonetheless known
1295 and is at the top of the DWARF expression stack. In this form
1296 of location description, the DWARF expression represents the
1297 actual value of the object, rather than its location. The
1298 \addtoindex{DW\_OP\_stack\_value} operation terminates the expression.
1299 \end{enumerate}
1300
1301
1302 \paragraph{Empty Location Descriptions}
1303
1304 An \addtoindex{empty location description}
1305 consists of a DWARF expression
1306 \addtoindexx{location description!empty}
1307 containing no operations. It represents a piece or all of an
1308 object that is present in the source but not in the object code
1309 (perhaps due to optimization).
1310
1311 \subsubsection{Composite Location Descriptions}
1312 A composite location description describes an object or
1313 value which may be contained in part of a register or stored
1314 in more than one location. Each piece is described by a
1315 composition operation, which does not compute a value nor
1316 store any result on the DWARF stack. There may be one or
1317 more composition operations in a single composite location
1318 description. A series of such operations describes the parts
1319 of a value in memory address order.
1320
1321 Each composition operation is immediately preceded by a simple
1322 location description which describes the location where part
1323 of the resultant value is contained.
1324 \begin{enumerate}[1. ]
1325 \itembfnl{\livetarg{chap:DWOPpiece}{DW\_OP\_piece}}
1326 The \livetarg{chap:DWOPpiece}{DW\_OP\_piece} operation takes a 
1327 single operand, which is an
1328 unsigned LEB128 number.  The number describes the size in bytes
1329 of the piece of the object referenced by the preceding simple
1330 location description. If the piece is located in a register,
1331 but does not occupy the entire register, the placement of
1332 the piece within that register is defined by the ABI.
1333
1334 \textit{Many compilers store a single variable in sets of registers,
1335 or store a variable partially in memory and partially in
1336 registers. \addtoindex{DW\_OP\_piece} provides a way of describing how large
1337 a part of a variable a particular DWARF location description
1338 refers to. }
1339
1340 \itembfnl{\livetarg{chap:DWOPbitpiece}{DW\_OP\_bit\_piece}}
1341 The \livetarg{chap:DWOPbitpiece}{DW\_OP\_bit\_piece} 
1342 operation takes two operands. The first
1343 is an unsigned LEB128 number that gives the size in bits
1344 of the piece. The second is an unsigned LEB128 number that
1345 gives the offset in bits from the location defined by the
1346 preceding DWARF location description.  
1347
1348 Interpretation of the
1349 offset depends on the kind of location description. If the
1350 location description is empty, the offset doesn\textquoteright t matter and
1351 the \addtoindex{DW\_OP\_bit\_piece} operation describes a piece consisting
1352 of the given number of bits whose values are undefined. If
1353 the location is a register, the offset is from the least
1354 significant bit end of the register. If the location is a
1355 memory address, the \addtoindex{DW\_OP\_bit\_piece} operation describes a
1356 sequence of bits relative to the location whose address is
1357 on the top of the DWARF stack using the bit numbering and
1358 direction conventions that are appropriate to the current
1359 language on the target system. If the location is any implicit
1360 value or stack value, the \addtoindex{DW\_OP\_bit\_piece} operation describes
1361 a sequence of bits using the least significant bits of that
1362 value.  
1363 \end{enumerate}
1364
1365 \textit{\addtoindex{DW\_OP\_bit\_piece} is 
1366 used instead of \addtoindex{DW\_OP\_piece} when
1367 the piece to be assembled into a value or assigned to is not
1368 byte-sized or is not at the start of a register or addressable
1369 unit of memory.}
1370
1371
1372
1373
1374 \subsubsection{Example Single Location Descriptions}
1375
1376 Here are some examples of how DWARF operations are used to form location descriptions:
1377 % Probably the only place that this will be used, so not in dwarf.tex?
1378 \newcommand{\descriptionitemnl}[1]{\item[#1]\mbox{}\\}
1379 \begin{description}
1380 \descriptionitemnl{\livelink{chap:DWOPreg}{DW\_OP\_reg3}}
1381 The value is in register 3.
1382
1383 \descriptionitemnl{\livelink{chap:DWOPregx}{DW\_OP\_regx} 54}
1384 The value is in register 54.
1385
1386 \descriptionitemnl{\livelink{chap:DWOPaddr}{DW\_OP\_addr} 0x80d0045c}
1387 The value of a static variable is at machine address 0x80d0045c.
1388
1389 \descriptionitemnl{\livelink{chap:DWOPbreg}{DW\_OP\_breg11} 44}
1390 Add 44 to the value in register 11 to get the address of an automatic
1391 variable instance.
1392
1393 \descriptionitemnl{\livelink{chap:DWOPfbreg}{DW\_OP\_fbreg} -50}
1394 Given a \livelink{chap:DWATframebase}{DW\_AT\_frame\_base} value of
1395 \doublequote{\livelink{chap:DWOPbreg31}{DW\_OP\_breg31} 64,} this example
1396 computes the address of a local variable that is -50 bytes from a
1397 logical frame pointer that is computed by adding 64 to the current
1398 stack pointer (register 31).
1399
1400 \descriptionitemnl{\livelink{chap:DWOPbregx}{DW\_OP\_bregx} 54 32 \livelink{chap:DWOPderef}{DW\_OP\_deref}}
1401 A call-by-reference parameter whose address is in the word 32 bytes
1402 from where register 54 points.
1403
1404 \descriptionitemnl{\livelink{chap:DWOPplusuconst}{DW\_OP\_plus\_uconst} 4}
1405 A structure member is four bytes from the start of the structure
1406 instance. The base address is assumed to be already on the stack.
1407
1408 \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}
1409 A variable whose first four bytes reside in register 3 and whose next
1410 two bytes reside in register 10.
1411
1412 \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}
1413 A twelve byte value whose first four bytes reside in register zero,
1414 whose middle four bytes are unavailable (perhaps due to optimization),
1415 and whose last four bytes are in memory, 12 bytes before the frame
1416 base.
1417
1418 \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} }
1419 Add the contents of r1 and r2 to compute a value. This value is the
1420 \doublequote{contents} of an otherwise anonymous location.
1421
1422 \descriptionitemnl{\livelink{chap:DWOPlit1}{DW\_OP\_lit1} \livelink{chap:DWOPstackvalue}{DW\_OP\_stack\_value} \livelink{chap:DWOPpiece}{DW\_OP\_piece} 4 }
1423 \vspace{-\parsep}
1424 \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}
1425 The object value is found in an anonymous (virtual) location whose
1426 value consists of two parts, given in memory address order: the 4 byte
1427 value 1 followed by the four byte value computed from the sum of the
1428 contents of r3 and r4.
1429 \end{description}
1430
1431
1432 \subsection{Location Lists}
1433 \label{chap:locationlists}
1434 Location lists 
1435 \addtoindexx{location list}
1436 are used in place of location expressions
1437 whenever the object whose location is being described
1438 can change location during its lifetime. 
1439 Location lists
1440 \addtoindexx{location list}
1441 are contained in a separate object file section called
1442 \dotdebugloc{}. A location list is indicated by a location
1443 attribute whose value is an offset from the beginning of
1444 the \dotdebugloc{} section to the first byte of the list for the
1445 object in question.
1446
1447 Each entry in a location list is either a location 
1448 \addtoindexi{list}{address selection|see{base address selection}} 
1449 entry,
1450
1451 \addtoindexi{base}{base address selection entry!in location list} 
1452 address selection entry, 
1453 \addtoindexx{location list!base address selection entry}
1454 or an 
1455 \addtoindexx{end of list entry!in location list}
1456 end of list entry.
1457
1458
1459 \addtoindexx{location list!entry}
1460 location list entry consists of:
1461 \begin{enumerate}[1. ]
1462 \item A beginning address offset. 
1463 This address offset has the \addtoindex{size of an address} and is
1464 relative to the applicable base address of the compilation
1465 unit referencing this location list. It marks the beginning
1466 of the address 
1467 \addtoindexi{range}{address range!in location list} 
1468 over which the location is valid.
1469
1470 \item An ending address offset.  This address offset again
1471 has the \addtoindex{size of an address} and is relative to the applicable
1472 base address of the compilation unit referencing this location
1473 list. It marks the first address past the end of the address
1474 range over which the location is valid. The ending address
1475 must be greater than or equal to the beginning address.
1476
1477 \textit{A location list entry (but not a base address selection or 
1478 end of list entry) whose beginning
1479 and ending addresses are equal has no effect 
1480 because the size of the range covered by such
1481 an entry is zero.}
1482
1483 \item A \addtoindex{single location description} 
1484 describing the location of the object over the range specified by
1485 the beginning and end addresses.
1486 \end{enumerate}
1487
1488 The applicable base address of a 
1489 location list entry is
1490 \addtoindexx{location list!base address selection entry}
1491 determined by the closest preceding base address selection
1492 entry (see below) in the same location list. If there is
1493 no such selection entry, then the applicable base address
1494 defaults to the base address of the compilation unit (see
1495 Section \refersec{chap:normalandpartialcompilationunitentries}).  
1496
1497 \textit{In the case of a compilation unit where all of
1498 the machine code is contained in a single contiguous section,
1499 no base address selection entry is needed.}
1500
1501 Address ranges may overlap. When they do, they describe a
1502 situation in which an object exists simultaneously in more than
1503 one place. If all of the address ranges in a given location
1504 list do not collectively cover the entire range over which the
1505 object in question is defined, it is assumed that the object is
1506 not available for the portion of the range that is not covered.
1507
1508 \needlines{5}
1509 A base 
1510 \addtoindexi{address}{address selection|see{base address selection}}
1511 selection 
1512 \addtoindexi{entry}{base address selection entry!in location list}
1513 consists of:
1514 \begin{enumerate}[1. ]
1515 \item The value of the largest representable 
1516 address offset (for example, \wffffffff when the size of
1517 an address is 32 bits).
1518 \item An address, which defines the 
1519 appropriate base address for use in interpreting the beginning
1520 and ending address offsets of subsequent entries of the location list.
1521 \end{enumerate}
1522
1523
1524 \textit{A base address selection entry 
1525 affects only the list in which it is contained.}
1526
1527 The end of any given location list is marked by an 
1528 \addtoindexx{location list!enf of list entry}
1529 end of list entry, which consists of a 0 for the beginning address
1530 offset and a 0 for the ending address offset. A location list
1531 containing only an 
1532 \addtoindexx{end of list entry!in location list}
1533 end of list entry describes an object that
1534 exists in the source code but not in the executable program.
1535
1536 Neither a base address selection entry nor an end of list
1537 entry includes a location description.
1538
1539 \textit{A base address selection entry and an end of list
1540 entry for a location list are identical to a base address
1541 selection entry and end of list entry, respectively, for a
1542 \addtoindex{range list}
1543 (see Section \refersec{chap:noncontiguousaddressranges}) 
1544 in interpretation
1545 and representation.}
1546
1547
1548 \section{Types of Program Entities}
1549 \label{chap:typesofprogramentities}
1550 Any 
1551 \hypertarget{chap:DWATtypetypeofdeclaration}
1552 debugging information entry describing a declaration that
1553 has a type has 
1554 \addtoindexx{type attribute}
1555 a \livelink{chap:DWATtype}{DW\_AT\_type} attribute, whose value is a
1556 reference to another debugging information entry. The entry
1557 referenced may describe a base type, that is, a type that is
1558 not defined in terms of other data types, or it may describe a
1559 user-defined type, such as an array, structure or enumeration.
1560 Alternatively, the entry referenced may describe a type
1561 modifier, such as constant, packed, pointer, reference or
1562 volatile, which in turn will reference another entry describing
1563 a type or type modifier (using 
1564 \addtoindexx{type attribute}
1565 a \livelink{chap:DWATtype}{DW\_AT\_type} attribute of its
1566 own). See 
1567 Section  \refersec{chap:typeentries} 
1568 for descriptions of the entries describing
1569 base types, user-defined types and type modifiers.
1570
1571
1572
1573 \section{Accessibility of Declarations}
1574 \label{chap:accessibilityofdeclarations}
1575 \textit{Some languages, notably C++ and 
1576 \addtoindex{Ada}, have the concept of
1577 the accessibility of an object or of some other program
1578 entity. The accessibility specifies which classes of other
1579 program objects are permitted access to the object in question.}
1580
1581 The accessibility of a declaration is 
1582 \hypertarget{chap:DWATaccessibilitycandadadeclarations}
1583 represented by a 
1584 \livelink{chap:DWATaccessibility}{DW\_AT\_accessibility} 
1585 attribute, whose
1586 \addtoindexx{accessibility attribute}
1587 value is a constant drawn from the set of codes listed in Table 
1588 \refersec{tab:accessibilitycodes}.
1589
1590 \begin{simplenametable}[1.9in]{Accessibility codes}{tab:accessibilitycodes}
1591 \livetarg{chap:DWACCESSpublic}{DW\_ACCESS\_public}          \\
1592 \livetarg{chap:DWACCESSprivate}{DW\_ACCESS\_private}        \\
1593 \livetarg{chap:DWACCESSprotected}{DW\_ACCESS\_protected}    \\
1594 \end{simplenametable}
1595
1596 \section{Visibility of Declarations}
1597 \label{chap:visibilityofdeclarations}
1598
1599 \textit{Several languages (such as \addtoindex{Modula-2}) 
1600 have the concept of the visibility of a declaration. The
1601 visibility specifies which declarations are to be 
1602 visible outside of the entity in which they are
1603 declared.}
1604
1605 The 
1606 \hypertarget{chap:DWATvisibilityvisibilityofdeclaration}
1607 visibility of a declaration is represented 
1608 by a \livelink{chap:DWATvisibility}{DW\_AT\_visibility}
1609 attribute\addtoindexx{visibility attribute}, whose value is a
1610 constant drawn from the set of codes listed in 
1611 Table \refersec{tab:visibilitycodes}.
1612
1613 \begin{simplenametable}[1.5in]{Visibility Codes}{tab:visibilitycodes}
1614 \livetarg{chap:DWVISlocal}{DW\_VIS\_local}          \\
1615 \livetarg{chap:DWVISexported}{DW\_VIS\_exported}    \\
1616 \livetarg{chap:DWVISqualified}{DW\_VIS\_qualified}  \\
1617 \end{simplenametable}
1618
1619 \section{Virtuality of Declarations}
1620 \label{chap:virtualityofdeclarations}
1621 \textit{C++ provides for virtual and pure virtual structure or class
1622 member functions and for virtual base classes.}
1623
1624 The 
1625 \hypertarget{chap:DWATvirtualityvirtualityindication}
1626 virtuality of a declaration is represented by a
1627 \livelink{chap:DWATvirtuality}{DW\_AT\_virtuality}
1628 attribute\addtoindexx{virtuality attribute}, whose value is a constant drawn
1629 from the set of codes listed in 
1630 Table \refersec{tab:virtualitycodes}.
1631
1632 \begin{simplenametable}[2.4in]{Virtuality codes}{tab:virtualitycodes}
1633 \livetarg{chap:DWVIRTUALITYnone}{DW\_VIRTUALITY\_none}                      \\
1634 \livetarg{chap:DWVIRTUALITYvirtual}{DW\_VIRTUALITY\_virtual}                \\
1635 \livetarg{chap:DWVIRTUALITYpurevirtual}{DW\_VIRTUALITY\_pure\_virtual}    \\
1636 \end{simplenametable}
1637
1638 \section{Artificial Entries}
1639 \label{chap:artificialentries}
1640 \textit{A compiler may wish to generate debugging information entries
1641 for objects or types that were not actually declared in the
1642 source of the application. An example is a formal parameter
1643 %FIXME: The word 'this' should be rendered like a variant italic,
1644 %FIXME: not as a quoted name. Changed to tt font--RB
1645 entry to represent the 
1646 \texttt{this} parameter\index{this parameter@\texttt{this} parameter}
1647 hidden \texttt{this} parameter that most C++
1648 implementations pass as the first argument to non-static member
1649 functions.}  
1650
1651 Any debugging information entry representing the
1652 \addtoindexx{artificial attribute}
1653 declaration of an object or type artificially generated by
1654 a compiler and not explicitly declared by the source program
1655 \hypertarget{chap:DWATartificialobjectsortypesthat}
1656 may have a 
1657 \livelink{chap:DWATartificial}{DW\_AT\_artificial} attribute, 
1658 which is a \livelink{chap:classflag}{flag}.
1659
1660 \section{Segmented Addresses}
1661 \label{chap:segmentedaddresses}
1662 \textit{In some systems, addresses are specified as offsets within a
1663 given 
1664 \addtoindexx{address space!segmented}
1665 segment 
1666 \addtoindexx{segmented addressing|see{address space}}
1667 rather than as locations within a single flat
1668 \addtoindexx{address space!flat}.
1669 address space.}
1670
1671 Any debugging information entry that contains a description
1672 \hypertarget{chap:DWATsegmentaddressinginformation}
1673 of the location of an object or subroutine may have
1674
1675 \livelink{chap:DWATsegment}{DW\_AT\_segment} attribute, 
1676 \addtoindexx{segment attribute}
1677 whose value is a location
1678 description. The description evaluates to the segment selector
1679 of the item being described. If the entry containing the
1680 \livelink{chap:DWATsegment}{DW\_AT\_segment} attribute has a 
1681 \livelink{chap:DWATlowpc}{DW\_AT\_low\_pc}, 
1682 \livelink{chap:DWAThighpc}{DW\_AT\_high\_pc},
1683 \livelink{chap:DWATranges}{DW\_AT\_ranges} or 
1684 \livelink{chap:DWATentrypc}{DW\_AT\_entry\_pc} attribute, 
1685 \addtoindexx{entry pc attribute}
1686 or 
1687 a location
1688 description that evaluates to an address, then those address
1689 values represent the offset portion of the address within
1690 the segment specified 
1691 \addtoindexx{segment attribute}
1692 by \livelink{chap:DWATsegment}{DW\_AT\_segment}.
1693
1694 If an entry has no 
1695 \livelink{chap:DWATsegment}{DW\_AT\_segment} attribute, it inherits
1696 \addtoindexx{segment attribute}
1697 the segment value from its parent entry.  If none of the
1698 entries in the chain of parents for this entry back to
1699 its containing compilation unit entry have 
1700 \livelink{chap:DWATsegment}{DW\_AT\_segment} attributes, 
1701 then the entry is assumed to exist within a flat
1702 address space. 
1703 Similarly, if the entry has a 
1704 \livelink{chap:DWATsegment}{DW\_AT\_segment} attribute 
1705 \addtoindexx{segment attribute}
1706 containing an empty location description, that
1707 entry is assumed to exist within a 
1708 \addtoindexi{flat}{address space!flat}.
1709 address space.
1710
1711 \textit{Some systems support different classes of 
1712 addresses
1713 \addtoindexx{address class!attribute}. 
1714 The
1715 address class may affect the way a pointer is dereferenced
1716 or the way a subroutine is called.}
1717
1718
1719 Any debugging information entry representing a pointer or
1720 reference type or a subroutine or subroutine type may 
1721 have a 
1722 \livelink{chap:DWATaddressclass}{DW\_AT\_address\_class}
1723 attribute, whose value is an integer
1724 constant.  The set of permissible values is specific to
1725 each target architecture. The value \livetarg{chap:DWADDRnone}{DW\_ADDR\_none}, 
1726 however,
1727 is common to all encodings, and means that no address class
1728 has been specified.
1729
1730 \textit {For example, the Intel386 \texttrademark\  processor might use the following values:}
1731
1732 \begin{table}[here]
1733 \caption{Example address class codes}
1734 \label{tab:inteladdressclasstable}
1735 \centering
1736 \begin{tabular}{l|c|l}
1737 \hline
1738 Name&Value&Meaning  \\
1739 \hline
1740 \textit{DW\_ADDR\_none}&   0 & \textit{no class specified} \\
1741 \textit{DW\_ADDR\_near16}& 1 & \textit{16\dash bit offset, no segment} \\
1742 \textit{DW\_ADDR\_far16}&  2 & \textit{16\dash bit offset, 16\dash bit segment} \\
1743 \textit{DW\_ADDR\_huge16}& 3 & \textit{16\dash bit offset, 16\dash bit segment} \\
1744 \textit{DW\_ADDR\_near32}& 4 & \textit{32\dash bit offset, no segment} \\
1745 \textit{DW\_ADDR\_far32}&  5 & \textit{32\dash bit offset, 16\dash bit segment} \\
1746 \hline
1747 \end{tabular}
1748 \end{table}
1749
1750 \needlines{6}
1751 \section{Non-Defining Declarations and Completions}
1752 \label{nondefiningdeclarationsandcompletions}
1753 A debugging information entry representing a program entity
1754 typically represents the defining declaration of that
1755 entity. In certain contexts, however, a debugger might need
1756 information about a declaration of an entity that is not
1757 \addtoindexx{incomplete declaration}
1758 also a definition, or is otherwise incomplete, to evaluate
1759 \hypertarget{chap:DWATdeclarationincompletenondefiningorseparateentitydeclaration}
1760 an expression correctly.
1761
1762 \textit{As an example, consider the following fragment of \addtoindex{C} code:}
1763
1764 \begin{lstlisting}
1765 void myfunc()
1766 {
1767   int x;
1768   {
1769     extern float x;
1770     g(x);
1771   }
1772 }
1773 \end{lstlisting}
1774
1775
1776 \textit{\addtoindex{C} scoping rules require that the 
1777 value of the variable x passed to the function g is the value of the
1778 global variable x rather than of the local version.}
1779
1780 \subsection{Non-Defining Declarations}
1781 A debugging information entry that 
1782 represents a non-defining or 
1783 \addtoindex{non-defining declaration}
1784 otherwise 
1785 \addtoindex{incomplete declaration}
1786 of a program entity has 
1787 \addtoindexx{declaration attribute}
1788
1789 \livelink{chap:DWATdeclaration}{DW\_AT\_declaration} 
1790 attribute, which is a 
1791 \livelink{chap:classflag}{flag}.
1792
1793 \subsection{Declarations Completing Non-Defining Declarations}
1794 A debugging information entry that represents a 
1795 \hypertarget{chap:DWATspecificationincompletenondefiningorseparatedeclaration}
1796 declaration that completes another (earlier) 
1797 non\dash defining declaration may have a 
1798 \livelink{chap:DWATspecification}{DW\_AT\_specification}
1799 attribute whose value is a \livelink{chap:classreference}{reference} to
1800 the debugging information entry representing the non-defining declaration. A debugging
1801 information entry with a 
1802 \livelink{chap:DWATspecification}{DW\_AT\_specification} 
1803 attribute does not need to duplicate information
1804 provided by the debugging information entry referenced by that specification attribute.
1805
1806 It is not the case that all attributes of the debugging information entry referenced by a
1807 \livelink{chap:DWATspecification}{DW\_AT\_specification} attribute 
1808 apply to the referring debugging information entry.
1809
1810 \textit{For 
1811 \addtoindexx{declaration attribute}
1812 example,
1813 \livelink{chap:DWATsibling}{DW\_AT\_sibling} and 
1814 \livelink{chap:DWATdeclaration}{DW\_AT\_declaration} 
1815 \addtoindexx{declaration attribute}
1816 clearly cannot apply to a 
1817 \addtoindexx{declaration attribute}
1818 referring
1819 \addtoindexx{sibling attribute}
1820 entry.}
1821
1822
1823
1824 \section{Declaration Coordinates}
1825 \label{chap:declarationcoordinates}
1826 \livetargi{chap:declarationcoordinates}{}{declaration coordinates}
1827 \textit{It is sometimes useful in a debugger to be able to associate
1828 a declaration with its occurrence in the program source.}
1829
1830 Any debugging information 
1831 \hypertarget{chap:DWATdeclfilefilecontainingsourcedeclaration}
1832 entry 
1833 \hypertarget{chap:DWATdecllinelinenumberofsourcedeclaration}
1834 representing 
1835 \hypertarget{chap:DWATdeclcolumncolumnpositionofsourcedeclaration}
1836 the
1837 \addtoindexx{line number of declaration}
1838 declaration of an object, module, subprogram or
1839 \addtoindex{declaration column attribute}
1840 type 
1841 \addtoindex{declaration file attribute}
1842 may 
1843 \addtoindex{declaration line attribute}
1844 have
1845 \livelink{chap:DWATdeclfile}{DW\_AT\_decl\_file}, 
1846 \livelink{chap:DWATdeclline}{DW\_AT\_decl\_line} and 
1847 \livelink{chap:DWATdeclcolumn}{DW\_AT\_decl\_column}
1848 attributes each of whose value is an unsigned
1849 \livelink{chap:classconstant}{integer constant}.
1850
1851 The value of 
1852 \addtoindexx{declaration file attribute}
1853 the 
1854 \livelink{chap:DWATdeclfile}{DW\_AT\_decl\_file}
1855 attribute 
1856 \addtoindexx{file containing declaration}
1857 corresponds to
1858 a file number from the line number information table for the
1859 compilation unit containing the debugging information entry and
1860 represents the source file in which the declaration appeared
1861 (see Section \refersec{chap:linenumberinformation}). 
1862 The value 0 indicates that no source file
1863 has been specified.
1864
1865 The value of 
1866 \addtoindexx{declaration line attribute}
1867 the \livelink{chap:DWATdeclline}{DW\_AT\_decl\_line} attribute represents
1868 the source line number at which the first character of
1869 the identifier of the declared object appears. The value 0
1870 indicates that no source line has been specified.
1871
1872 The value of 
1873 \addtoindexx{declaration column attribute}
1874 the \livelink{chap:DWATdeclcolumn}{DW\_AT\_decl\_column} attribute represents
1875 the source column number at which the first character of
1876 the identifier of the declared object appears. The value 0
1877 indicates that no column has been specified.
1878
1879 \section{Identifier Names}
1880 \label{chap:identifiernames}
1881 Any 
1882 \hypertarget{chap:DWATnamenameofdeclaration}
1883 debugging information entry 
1884 \addtoindexx{identifier names}
1885 representing 
1886 \addtoindexx{names!identifier}
1887 a program entity
1888 that has been given a name may have a 
1889 \livelink{chap:DWATname}{DW\_AT\_name} attribute,
1890 whose 
1891 \addtoindexx{name attribute}
1892 value is a \livelink{chap:classstring}{string} 
1893 representing the name as it appears in
1894 the source program. A debugging information entry containing
1895 no name attribute, or containing a name attribute whose value
1896 consists of a name containing a single null byte, represents
1897 a program entity for which no name was given in the source.
1898
1899 \textit{Because the names of program objects described by DWARF are the
1900 names as they appear in the source program, implementations
1901 of language translators that use some form of mangled name
1902 \addtoindex{mangled names}
1903 (as do many implementations of C++) should use the unmangled
1904 form of the name in the 
1905 DWARF \livelink{chap:DWATname}{DW\_AT\_name} attribute,
1906 \addtoindexx{name attribute}
1907 including the keyword operator (in names such as \doublequote{operator +}),
1908 if present. See also 
1909 Section \refersec{chap:linkagenames} regarding the use
1910 of \livelink{chap:DWATlinkagename}{DW\_AT\_linkage\_name} for 
1911 \addtoindex{mangled names}
1912 mangled names. 
1913 Sequences of
1914 multiple whitespace characters may be compressed.}
1915
1916 \section{Data Locations and DWARF Procedures}
1917 Any debugging information entry describing a data object (which
1918 \hypertarget{chap:DWATlocationdataobjectlocation}
1919 includes variables and parameters) or 
1920 \livelink{chap:commonblockentry}{common blocks}
1921 may have 
1922 \addtoindexx{location attribute}
1923 a
1924 \livelink{chap:DWATlocation}{DW\_AT\_location} attribute,
1925 \addtoindexx{location attribute}
1926 whose value is a location description
1927 (see Section \refersec{chap:locationdescriptions}).
1928
1929
1930 \addtoindex{DWARF procedure}
1931 is represented by any
1932 kind of debugging information entry that has 
1933 \addtoindexx{location attribute}
1934
1935 \livelink{chap:DWATlocation}{DW\_AT\_location}
1936 attribute. 
1937 \addtoindexx{location attribute}
1938 If a suitable entry is not otherwise available,
1939 a DWARF procedure can be represented using a debugging
1940 \addtoindexx{DWARF procedure entry}
1941 information entry with the 
1942 tag \livetarg{chap:DWTAGdwarfprocedure}{DW\_TAG\_dwarf\_procedure}
1943 together with 
1944 \addtoindexx{location attribute}
1945 a \livelink{chap:DWATlocation}{DW\_AT\_location} attribute.  
1946
1947 A DWARF procedure
1948 is called by a \livelink{chap:DWOPcall2}{DW\_OP\_call2}, 
1949 \livelink{chap:DWOPcall4}{DW\_OP\_call4} or 
1950 \livelink{chap:DWOPcallref}{DW\_OP\_call\_ref}
1951 DWARF expression operator 
1952 (see Section \refersec{chap:controlflowoperations}).
1953
1954 \needlines{5}
1955 \section{Code Addresses and Ranges}
1956 \label{chap:codeaddressesandranges}
1957 Any debugging information entry describing an entity that has
1958 a machine code address or range of machine code addresses,
1959 which includes compilation units, module initialization,
1960 \hypertarget{chap:DWATrangesnoncontiguousrangeofcodeaddresses}
1961 subroutines, ordinary \nolink{blocks}, 
1962 try/catch \nolink{blocks} (see Section\refersec{chap:tryandcatchblockentries}), 
1963 labels and the like, may have
1964 \begin{itemize}
1965 \item A \livelink{chap:DWATlowpc}{DW\_AT\_low\_pc} attribute for
1966 \hypertarget{chap:DWATlowpccodeaddressorrangeofaddresses}
1967 a single address,
1968
1969 \item A \livelink{chap:DWATlowpc}{DW\_AT\_low\_pc}
1970 \addtoindexx{low PC attribute}
1971 and 
1972 \livelink{chap:DWAThighpc}{DW\_AT\_high\_pc}
1973 \addtoindexx{high PC attribute}
1974 \hypertarget{chap:DWAThighpccontiguousrangeofcodeaddresses}
1975 pair of attributes for 
1976 a single contiguous range of
1977 addresses, or
1978
1979 \item A \livelink{chap:DWATranges}{DW\_AT\_ranges} attribute 
1980 \addtoindexx{ranges attribute}
1981 for a non-contiguous range of addresses.
1982 \end{itemize}
1983
1984 In addition, a non-contiguous range of 
1985 addresses may also be specified for the
1986 \livelink{chap:DWATstartscope}{DW\_AT\_start\_scope} attribute.
1987 \addtoindexx{start scope attribute}
1988
1989 If an entity has no associated machine code, 
1990 none of these attributes are specified.
1991
1992 \subsection{Single Address} 
1993 When there is a single address associated with an entity,
1994 such as a label or alternate entry point of a subprogram,
1995 the entry has a \livelink{chap:DWATlowpc}{DW\_AT\_low\_pc} attribute whose value is the
1996 relocated address for the entity.
1997
1998 \textit{While the \livelink{chap:DWATentrypc}{DW\_AT\_entry\_pc}
1999 attribute might also seem appropriate for this purpose,
2000 historically the \livelink{chap:DWATlowpc}{DW\_AT\_low\_pc} attribute was used before the
2001 \livelink{chap:DWATentrypc}{DW\_AT\_entry\_pc} was introduced 
2002 (in \addtoindex{DWARF Version 3}). There is
2003 insufficient reason to change this.}
2004
2005 \subsection{Continuous Address Range}
2006 \label{chap:contiguousaddressranges}
2007 When the set of addresses of a debugging information entry can
2008 be described as a single contiguous range, the entry 
2009 \addtoindexx{high PC attribute}
2010 may 
2011 \addtoindexx{low PC attribute}
2012 have
2013 a \livelink{chap:DWATlowpc}{DW\_AT\_low\_pc} and 
2014 \livelink{chap:DWAThighpc}{DW\_AT\_high\_pc} pair of attributes. 
2015 The value
2016 of the 
2017 \livelink{chap:DWATlowpc}{DW\_AT\_low\_pc} attribute 
2018 is the relocated address of the
2019 first instruction associated with the entity. If the value of
2020 the \livelink{chap:DWAThighpc}{DW\_AT\_high\_pc} is of class address, it is the relocated
2021 address of the first location past the last instruction
2022 associated with the entity; if it is of class constant, the
2023 value is an unsigned integer offset which when added to the
2024 low PC gives the address of the first location past the last
2025 instruction associated with the entity.
2026
2027 \textit{The high PC value
2028 may be beyond the last valid instruction in the executable.}
2029
2030 The presence of low and high PC attributes for an entity
2031 implies that the code generated for the entity is contiguous
2032 and exists totally within the boundaries specified by those
2033 two attributes. If that is not the case, no low and high PC
2034 attributes should be produced.
2035
2036 \subsection{Non\dash Contiguous Address Ranges}
2037 \label{chap:noncontiguousaddressranges}
2038 When the set of addresses of a debugging information entry
2039 \addtoindexx{non-contiguous address ranges}
2040 cannot be described as a single contiguous range, the entry has
2041 a \livelink{chap:DWATranges}{DW\_AT\_ranges} attribute 
2042 \addtoindexx{ranges attribute}
2043 whose value is of class \livelink{chap:classrangelistptr}{rangelistptr}
2044 and indicates the beginning of a \addtoindex{range list}.
2045 Similarly,
2046 a \livelink{chap:DWATstartscope}{DW\_AT\_start\_scope} attribute 
2047 \addtoindexx{start scope attribute}
2048 may have a value of class
2049 \livelink{chap:classrangelistptr}{rangelistptr} for the same reason.  
2050
2051 Range lists are contained
2052 in a separate object file section called 
2053 \dotdebugranges{}. A
2054 \addtoindex{range list} is indicated by a 
2055 \livelink{chap:DWATranges}{DW\_AT\_ranges} attribute whose
2056 \addtoindexx{ranges attribute}
2057 value is represented as an offset from the beginning of the
2058 \dotdebugranges{} section to the beginning of the 
2059 \addtoindex{range list}.
2060
2061 Each entry in a \addtoindex{range list} is either a 
2062 \addtoindex{range list} entry,
2063 \addtoindexx{base address selection entry!in range list}
2064 a base address selection entry, or an 
2065 \addtoindexx{end of list entry!in range list}
2066 end of list entry.
2067
2068 A \addtoindex{range list} entry consists of:
2069 \begin{enumerate}[1. ]
2070 \item A beginning address offset. This address offset has the 
2071 \addtoindex{size of an address} and is relative to
2072 the applicable base address of the compilation unit referencing this 
2073 \addtoindex{range list}. 
2074 It marks the
2075 beginning of an 
2076 \addtoindexi{address}{address range!in range list} 
2077 range.
2078
2079 \item An ending address offset. This address offset again has the 
2080 \addtoindex{size of an address} and is relative
2081 to the applicable base address of the compilation unit referencing 
2082 this \addtoindex{range list}.
2083 It marks the
2084 first address past the end of the address range.
2085 The ending address must be greater than or
2086 equal to the beginning address.
2087
2088 \textit{A \addtoindex{range list} entry (but not a base address selection or end of list entry) whose beginning and
2089 ending addresses are equal has no effect because the size of the range covered by such an
2090 entry is zero.}
2091 \end{enumerate}
2092
2093 The applicable base address of a \addtoindex{range list} entry
2094 is determined
2095 by the closest preceding base address selection entry (see
2096 below) in the same range list. If there is no such selection
2097 entry, then the applicable base address defaults to the base
2098 address of the compilation unit 
2099 (see Section \refersec{chap:normalandpartialcompilationunitentries}).
2100
2101 \textit{In the case of a compilation unit where all of the machine
2102 code is contained in a single contiguous section, no base
2103 address selection entry is needed.}
2104
2105 Address range entries in
2106 a \addtoindex{range list} may not overlap.
2107 There is no requirement that
2108 the entries be ordered in any particular way.
2109
2110 \needlines{5}
2111 A base address selection entry consists of:
2112 \begin{enumerate}[1. ]
2113 \item The value of the largest representable address offset (for example, \wffffffff when the size of
2114 an address is 32 bits).
2115
2116 \item An address, which defines the appropriate base address for use in interpreting the beginning
2117 and ending address offsets of subsequent entries of the location list.
2118 \end{enumerate}
2119 \textit{A base address selection entry 
2120 affects only the list in which it is contained.}
2121
2122
2123 The end of any given \addtoindex{range list} is marked by an 
2124 \addtoindexx{end of list entry!in range list}
2125 end of list entry, 
2126 which consists of a 0 for the beginning address
2127 offset and a 0 for the ending address offset. 
2128 A \addtoindex{range list}
2129 containing only an end of list entry describes an empty scope
2130 (which contains no instructions).
2131
2132 \textit{A base address selection entry and an 
2133 \addtoindexx{end of list entry!in range list}
2134 end of list entry for
2135 a \addtoindex{range list} 
2136 are identical to a base address selection entry
2137 and end of list entry, respectively, for a location list
2138 (see Section \refersec{chap:locationlists}) 
2139 in interpretation and representation.}
2140
2141
2142
2143 \section{Entry Address}
2144 \label{chap:entryaddress}
2145 \textit{The entry or first executable instruction generated
2146 for an entity, if applicable, is often the lowest addressed
2147 instruction of a contiguous range of instructions. In other
2148 cases, the entry address needs to be specified explicitly.}
2149
2150 Any debugging information entry describing an entity that has
2151 a range of code addresses, which includes compilation units,
2152 module initialization, subroutines, 
2153 ordinary \livelink{chap:lexicalblock}{block}, 
2154 try/catch \nolink{blocks} (see Section \refersec{chap:tryandcatchblockentries}),
2155 and the like, 
2156 may have a \livelink{chap:DWATentrypc}{DW\_AT\_entry\_pc} attribute to
2157 indicate the first executable instruction within that range
2158 of addresses. The value of the \livelink{chap:DWATentrypc}{DW\_AT\_entry\_pc} attribute is a
2159 relocated address. If no \livelink{chap:DWATentrypc}{DW\_AT\_entry\_pc} attribute is present,
2160 then the entry address is assumed to be the same as the
2161 value of the \livelink{chap:DWATlowpc}{DW\_AT\_low\_pc} attribute, if present; otherwise,
2162 the entry address is unknown.
2163
2164 \section{Static and Dynamic Values of Attributes}
2165 \label{chap:staticanddynamicvaluesofattributes}
2166
2167 Some attributes that apply to types specify a property (such
2168 as the lower bound of an array) that is an integer value,
2169 where the value may be known during compilation or may be
2170 computed dynamically during execution.
2171
2172 The value of these
2173 attributes is determined based on the class as follows:
2174 \begin{itemize}
2175 \item For a \livelink{chap:classconstant}{constant}, the value of the constant is the value of
2176 the attribute.
2177
2178 \item For a \livelink{chap:classreference}{reference}, the
2179 value is a \livelink{chap:classreference}{reference} to another
2180 entity which specifies the value of the attribute.
2181
2182 \item For an \livelink{chap:classexprloc}{exprloc}, the value is interpreted as a 
2183 DWARF expression; 
2184 evaluation of the expression yields the value of
2185 the attribute.
2186 \end{itemize}
2187
2188 \textit{%
2189 Whether an attribute value can be dynamic depends on the
2190 rules of the applicable programming language.
2191 }
2192
2193 \textit{The applicable attributes include: 
2194 \livelink{chap:DWATallocated}{DW\_AT\_allocated},
2195 \livelink{chap:DWATassociated}{DW\_AT\_associated}, 
2196 \livelink{chap:DWATbitoffset}{DW\_AT\_bit\_offset}, 
2197 \livelink{chap:DWATbitsize}{DW\_AT\_bit\_size},
2198 \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size}, 
2199 \livelink{chap:DWATcount}{DW\_AT\_count}, 
2200 \livelink{chap:DWATlowerbound}{DW\_AT\_lower\_bound},
2201 \livelink{chap:DWATbytestride}{DW\_AT\_byte\_stride}, 
2202 \livelink{chap:DWATbitstride}{DW\_AT\_bit\_stride}, 
2203 \livelink{chap:DWATupperbound}{DW\_AT\_upper\_bound} (and
2204 possibly others).}
2205
2206
2207 \section{Entity Descriptions}
2208 \textit{Some debugging information entries may describe entities
2209 in the program that are artificial, or which otherwise are
2210 ``named'' in ways which are not valid identifiers in the
2211 programming language. For example, several languages may
2212 capture or freeze the value of a variable at a particular
2213 point in the program. 
2214 \addtoindex{Ada} 95 has package elaboration routines,
2215 type descriptions of the form typename\textquoteright Class, and 
2216 ``access typename'' parameters.  }
2217
2218 Generally, any debugging information
2219 entry that 
2220 \hypertarget{chap:DWATdescriptionartificialnameordescription}
2221 has, or may have, 
2222 \addtoindexx{name attribute}
2223
2224 \livelink{chap:DWATname}{DW\_AT\_name} attribute, may
2225 also have 
2226 \addtoindexx{description attribute}
2227
2228 \livelink{chap:DWATdescription}{DW\_AT\_description} attribute whose value is a
2229 null-terminated string providing a description of the entity.
2230
2231
2232 \textit{It is expected that a debugger will only display these
2233 descriptions as part of the description of other entities. It
2234 should not accept them in expressions, nor allow them to be
2235 assigned, or the like.}
2236
2237 \section{Byte and Bit Sizes}
2238 \label{chap:byteandbitsizes}
2239 % Some trouble here with hbox full, so we try optional word breaks.
2240 Many debugging information entries allow either a
2241 \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} attribute or a 
2242 \livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} attribute,
2243 whose \livelink{chap:classconstant}{integer constant} value 
2244 (see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
2245 specifies an
2246 amount of storage. The value of the \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} attribute
2247 is interpreted in bytes and the value of the \livelink{chap:DWATbitsize}{DW\_AT\_bit\_size}
2248 attribute is interpreted in bits.  
2249
2250 Similarly, the \livelink{chap:classconstant}{integer constant}
2251 value of a \livelink{chap:DWATbytestride}{DW\_AT\_byte\_stride} attribute is interpreted
2252 in bytes and the \livelink{chap:classconstant}{integer constant} value of a 
2253 \livelink{chap:DWATbitstride}{DW\_AT\_bit\_stride}
2254 attribute is interpreted in bits.
2255
2256 \section{Linkage Names}
2257 \label{chap:linkagenames}
2258 \textit{Some language implementations, notably 
2259 \addtoindex{C++} and similar
2260 languages, 
2261 make use of implementation-defined names within
2262 object files that are different from the identifier names
2263 (see Section \refersec{chap:identifiernames}) of entities as they appear in the
2264 source. Such names, sometimes known 
2265 \addtoindex{names!mangled}
2266 as 
2267 \addtoindexx{mangled names}
2268 mangled names,
2269 are used in various ways, such as: to encode additional
2270 information about an entity, to distinguish multiple entities
2271 that have the same name, and so on. When an entity has an
2272 associated distinct linkage name it may sometimes be useful
2273 for a producer to include this name in the DWARF description
2274 of the program to facilitate consumer access to and use of
2275 object file information about an entity and/or information
2276 \hypertarget{chap:DWATlinkagenameobjectfilelinkagenameofanentity}
2277 that is encoded in the linkage name itself.  
2278 }
2279
2280 % Some trouble maybe with hbox full, so we try optional word breaks.
2281 A debugging
2282 information entry may have 
2283 \addtoindexx{linkage name attribute}
2284
2285 \livelink{chap:DWATlinkagename}{DW\_AT\_linkage\_name}
2286 attribute
2287 whose value is a null-terminated string describing the object
2288 file linkage name associated with the corresponding entity.
2289
2290 % Some trouble here with hbox full, so we try optional word breaks.
2291 \textit{Debugging information entries to which \livelink{chap:DWATlinkagename}{DW\_AT\_linkage\_name}
2292 may apply include: \livelink{chap:DWTAGcommonblock}{DW\_TAG\_common\_block}, \livelink{chap:DWTAGconstant}{DW\_TAG\_constant},
2293 \livelink{chap:DWTAGentrypoint}{DW\_TAG\_entry\_point}, \livelink{chap:DWTAGsubprogram}{DW\_TAG\_subprogram} 
2294 and \livelink{chap:DWTAGvariable}{DW\_TAG\_variable}.
2295 }