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