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