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