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