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