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