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