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