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