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