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