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