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