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