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