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