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