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