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