Working copy for backup...
[dwarf-doc.git] / dwarf5 / latexdoc / generaldescription.tex
1 \chapter{General Description}
2 \label{chap:generaldescription}
3 \section{The Debugging Information Entry (DIE)}
4 \label{chap:thedebuggingentrydie}
5 DWARF 
6 \addtoindexx{debugging information entry}
7 uses 
8 \addtoindexx{DIE|see{debugging information entry}}
9 a series of debugging information entries (DIEs) to 
10 define a low-level
11 representation of a source program. 
12 Each debugging information entry consists of an identifying
13 \addtoindex{tag} and a series of 
14 \addtoindex{attributes}. 
15 An entry, or group of entries together, provide a description of a
16 corresponding 
17 \addtoindex{entity} in the source program. 
18 The tag specifies the class to which an entry belongs
19 and the attributes define the specific characteristics of the entry.
20
21 The set of tag names 
22 \addtoindexx{tag names|see{debugging information entry}}
23 is listed in Table \refersec{tab:tagnames}. 
24 The debugging information entries they identify are
25 described in Chapters 3, 4 and 5.
26
27 \begin{table}[p]
28 \caption{Tag names}
29 \label{tab:tagnames}
30 \simplerule[6in]
31 \autocols[0pt]{c}{2}{l}{
32 \DWTAGaccessdeclaration,
33 \DWTAGarraytype,
34 \DWTAGatomictype,
35 \DWTAGbasetype,
36 \DWTAGcallsite,
37 \DWTAGcallsiteparameter,
38 \DWTAGcatchblock,
39 \DWTAGclasstype,
40 \DWTAGcoarraytype,
41 \DWTAGcommonblock,
42 \DWTAGcommoninclusion,
43 \DWTAGcompileunit,
44 \DWTAGcondition,
45 \DWTAGconsttype,
46 \DWTAGconstant,
47 \DWTAGdwarfprocedure,
48 \DWTAGdynamictype,
49 \DWTAGentrypoint,
50 \DWTAGenumerationtype,
51 \DWTAGenumerator,
52 \DWTAGfiletype,
53 \DWTAGformalparameter,
54 \DWTAGfriend,
55 \DWTAGgenericsubrange,
56 \DWTAGimporteddeclaration,
57 \DWTAGimportedmodule,
58 \DWTAGimportedunit,
59 \DWTAGinheritance,
60 \DWTAGinlinedsubroutine,
61 \DWTAGinterfacetype,
62 \DWTAGlabel,
63 \DWTAGlexicalblock,
64 \DWTAGmodule,
65 \DWTAGmember,
66 \DWTAGnamelist,
67 \DWTAGnamelistitem,
68 \DWTAGnamespace,
69 \DWTAGpackedtype,
70 \DWTAGpartialunit,
71 \DWTAGpointertype,
72 \DWTAGptrtomembertype,
73 \DWTAGreferencetype,
74 \DWTAGrestricttype,
75 \DWTAGrvaluereferencetype,
76 \DWTAGsettype,
77 \DWTAGsharedtype,
78 \DWTAGstringtype,
79 \DWTAGstructuretype,
80 \DWTAGsubprogram,
81 \DWTAGsubrangetype,
82 \DWTAGsubroutinetype,
83 \DWTAGtemplatealias,
84 \DWTAGtemplatetypeparameter,
85 \DWTAGtemplatevalueparameter,
86 \DWTAGthrowntype,
87 \DWTAGtryblock,
88 \DWTAGtypedef,
89 \DWTAGtypeunit,
90 \DWTAGuniontype,
91 \DWTAGunspecifiedparameters,
92 \DWTAGunspecifiedtype,
93 \DWTAGvariable,
94 \DWTAGvariant,
95 \DWTAGvariantpart,
96 \DWTAGvolatiletype,
97 \DWTAGwithstmt
98 }
99 \simplerule[6in]
100 \end{table}
101
102
103 \textit{The debugging information entry descriptions 
104 in Sections 3, 4 and 5 generally include mention of
105 most, but not necessarily all, of the attributes 
106 that are normally or possibly used with the entry.
107 Some attributes, whose applicability tends to be 
108 pervasive and invariant across many kinds of
109 debugging information entries, are described in 
110 this section and not necessarily mentioned in all
111 contexts where they may be appropriate. 
112 Examples include 
113 \DWATartificial, 
114 the \livelink{chap:declarationcoordinates}{declaration coordinates}, and 
115 \DWATdescription, 
116 among others.}
117
118 The debugging information entries are contained in the 
119 \dotdebuginfo{} and/or \dotdebuginfodwo{} sections of an object file.
120
121 \needlines{7}
122 Optionally, debugging information may be partitioned such
123 that the majority of the debugging information can remain in
124 individual object files without being processed by the
125 linker. These debugging information entries are contained in
126 the \dotdebuginfodwo{} sections. These
127 sections may be placed in the object file but marked so that
128 the linker ignores them, or they may be placed in a separate
129 DWARF object file that resides alongside the normal object
130 file. See Section \refersec{datarep:splitdwarfobjectfiles} and
131 Appendix \refersec{app:splitdwarfobjectsinformative} for details.
132
133 As a further option, debugging information entries and other debugging
134 information that are the same in multiple executable or shared object files 
135 may be found in a separate \addtoindex{supplementary object file} that 
136 contains supplementary debug sections.
137 The executable or shared object file which contains references to
138 those debugging information entries contain a \dotdebugsup{} section
139 with information that identifies the \addtoindex{supplementary object file}; 
140 the \addtoindex{supplementary object file} contains a variant of this same section
141 that is used to unambiguously associate it with the referencing object.
142 See Section \refersec{datarep:dwarfsupplemetaryobjectfiles} for
143 further details.
144  
145 \section{Attribute Types}
146 \label{chap:attributetypes}
147 Each attribute value is characterized by an attribute name. 
148 \addtoindexx{attribute duplication}
149 No more than one attribute with a given name may appear in any
150 debugging information entry. 
151 There are no limitations on the
152 \addtoindexx{attribute ordering}
153 ordering of attributes within a debugging information entry.
154
155 The attributes are listed in Table \referfol{tab:attributenames}.  
156
157 \setlength{\extrarowheight}{0.1cm}
158 \addtoindexx{attributes!list of}
159 \begin{longtable}{P{6.2cm}|P{8.5cm}}
160   \caption{Attribute names} \label{tab:attributenames} \\
161   \hline \bfseries Attribute$^*$&\bfseries Identifies or Specifies \\ \hline
162 \endfirsthead
163   \bfseries Attribute$^*$&\bfseries Identifies or Specifies \\ \hline
164 \endhead
165   \hline
166   \multicolumn{2}{l}{
167   \parbox{15cm}{
168   \vspace{2mm}\emph{Continued on next page} \newline
169   $^*${\parbox[t]{15cm}{\tiny Links for attributes come to the left column of this table;
170   links in the right column "fan-out" to one or more descriptions.}} \newline
171   ~\newline}}
172 \endfoot
173   \hline
174   \multicolumn{2}{l}{
175   $^*${\parbox[t]{15cm}{\tiny Links for attributes come to the left column of this table;
176   links in the right column "fan-out" to one or more descriptions.}}}
177 \endlastfoot
178
179 \DWATabstractoriginTARG
180 &\livelinki{chap:DWATabstractorigininlineinstance}
181         {Inline instances of inline subprograms} 
182         {inline instances of inline subprograms} \\
183 % Heren livelink we cannot use \dash or \dash{}.
184 &\livelinki{chap:DWATabstractoriginoutoflineinstance}
185         {Out-of-line instances of inline subprograms}
186         {out-of-line instances of inline subprograms} \\
187 \DWATaccessibilityTARG
188 &\livelink{chap:DWATaccessibilitycandadadeclarations}
189         {Accessibility of declarations} (\addtoindex{C++}, \addtoindex{Ada}) \\
190 &\livelink{chap:DWATaccessibilitycppbaseclasses}
191         {Accessibility of base classes} (\addtoindex{C++}) \\
192 &\livelink{chap:DWATaccessibilitycppinheritedmembers}
193         {Accessibility of inherited members} (\addtoindex{C++}) \\
194 \DWATaddressclassTARG
195 &\livelinki{chap:DWATadressclasspointerorreferencetypes}
196         {Pointer or reference types}
197         {pointer or reference types}  \\
198 &\livelinki{chap:DWATaddressclasssubroutineorsubroutinetype}
199         {Subroutine or subroutine type}
200         {subroutine or subroutine type} \\
201 \DWATaddrbaseTARG
202 &\livelinki{chap:DWATaddrbaseforaddresstable}
203         {Base offset for address table}
204         {address table} \\
205 \DWATalignmentTARG
206 &\livelinki{chap:DWATalignmentnondefault}
207         {Non-default alignment of type, subprogram or variable}
208         {non-default alignment} \addtoindexx{alignment!non-default} \\
209 \DWATallocatedTARG
210 &\livelinki{chap:DWATallocatedallocationstatusoftypes}
211         {Allocation status of types}
212         {allocation status of types}  \\
213 \DWATartificialTARG
214 &\livelinki{chap:DWATartificialobjectsortypesthat}
215         {Objects or types that are not actually declared in the source}
216         {objects or types that are not actually declared in the source}  \\
217 \DWATassociatedTARG{} 
218 &\livelinki{chap:DWATassociatedassociationstatusoftypes}
219         {Association status of types}
220         {association status of types} \\
221 \DWATbasetypesTARG{} 
222 &\livelinki{chap:DWATbasetypesprimitivedatatypesofcompilationunit}
223         {Primitive data types of compilation unit}
224         {primitive data types of compilation unit} \\
225 \DWATbinaryscaleTARG{} 
226 &\livelinki{chap:DWATbinaryscalebinaryscalefactorforfixedpointtype}
227         {Binary scale factor for fixed-point type}
228         {binary scale factor for fixed-point type} \\
229 %\DWATbitoffsetTARG{} 
230 %&\livelinki{chap:DWATbitoffsetbasetypebitlocation}{Base type bit location}{base type bit location} \\
231 %&\livelinki{chap:DWATbitoffsetdatamemberbitlocation}{Data member bit location}{data member bit location} \\
232 \DWATbitsizeTARG{} 
233 &\livelinki{chap:DWATbitsizebasetypebitsize}
234         {Size of a base type in bits}
235         {base type bit size} \\
236 &\livelinki{chap:DWATbitsizedatamemberbitsize}
237         {Size of a data member in bits}
238         {data member bit size} \\
239 \DWATbitstrideTARG{} 
240 &\livelinki{chap:DWATbitstridearrayelementstrideofarraytype}
241            {Array element stride (of array type)}
242            {array element stride (of array type)} \\
243 &\livelinki{chap:DWATbitstridesubrangestridedimensionofarraytype}
244            {Subrange stride (dimension of array type)}
245            {subrange stride (dimension of array type)} \\
246 &\livelinki{chap:DWATbitstrideenumerationstridedimensionofarraytype}
247            {Enumeration stride (dimension of array type)}
248            {enumeration stride (dimension of array type)} \\
249 \DWATbytesizeTARG{} 
250 &\livelinki{chap:DWATbytesizedataobjectordatatypesize}
251            {Size of a data object or data type in bytes}
252            {data object or data type size} \\
253 \DWATbytestrideTARG{} 
254 &\livelinki{chap:DWATbytestridearrayelementstrideofarraytype}
255            {Array element stride (of array type)}
256            {array element stride (of array type)} \\
257 &\livelinki{chap:DWATbytestridesubrangestridedimensionofarraytype}
258            {Subrange stride (dimension of array type)}
259            {subrange stride (dimension of array type)} \\
260 &\livelinki{chap:DWATbytestrideenumerationstridedimensionofarraytype}
261            {Enumeration stride (dimension of array type)}
262            {enumeration stride (dimension of array type)} \\
263 \DWATcallallcallsTARG{}
264 &\livelinki{chap:DWATcallallcallsofasubprogram}
265            {All tail and normal calls in a subprogram are described by call site entries}
266            {all tail and normal calls are described}
267            \index{call site!summary!all tail and normal calls are described} \\
268 \DWATcallallsourcecallsTARG{}
269 &\livelinki{chap:DWATcallallsourcecallsofasubprogram}
270            {All tail, normal and inlined calls in a subprogram are described by call site and inlined subprogram entries}
271            {all tail, normal and inlined calls are described}
272            \index{call site!summary!all tail, normal and inlined calls are described} \\
273 \DWATcallalltailcallsTARG{}
274 &\livelinki{chap:DWATcallalltailcallsofasubprogram}
275            {All tail calls in a subprogram are described by call site entries}
276            {all tail calls are described}
277            \index{call site!summary!all tail calls are described} \\
278 \DWATcallcolumnTARG{} 
279 &\livelinki{chap:DWATcallcolumncolumnpositionofinlinedsubroutinecall}
280            {Column position of inlined subroutine call}
281            {column position of inlined subroutine call} \\
282 \DWATcalldatalocationTARG{}
283 &\livelinki{chap:DWATcalldatalocationofcallparameter}
284            {Address of the value pointed to by an argument passed in a call}
285            {address of the value pointed to by an argument}
286            \index{call site!address of the value pointed to by an argument} \\
287 \DWATcalldatavalueTARG{}
288 &\livelinki{chap:DWATcalldatavalueofcallparameter}
289            {Value pointed to by an argument passed in a call}
290            {value pointed to by an argument}
291            \index{call site!value pointed to by an argument} \\
292 \DWATcallfileTARG
293 &\livelinki{chap:DWATcallfilefilecontaininginlinedsubroutinecall}
294            {File containing inlined subroutine call}
295            {file containing inlined subroutine call} \\
296 \DWATcalllineTARG{} 
297 &\livelinki{chap:DWATcalllinelinenumberofinlinedsubroutinecall}
298            {Line number of inlined subroutine call}
299            {line number of inlined subroutine call} \\
300 \DWATcallingconventionTARG{} 
301 &\livelinki{chap:DWATcallingconventionforsubprograms}
302            {Calling convention for subprograms}
303            {Calling convention!for subprograms} \\
304 &\livelinki{chap:DWATcallingconventionfortypes}
305            {Calling convention for types}
306            {Calling convention!for types} \\
307 \DWATcalloriginTARG{}
308 &\livelinki{chap:DWATcalloriginofcallsite}
309            {Subprogram called in a call}
310            {subprogram called}
311            \index{call site!subprogram called} \\
312 \DWATcallparameterTARG{}
313 &\livelinki{chap:DWATcallparameterofcallparameter}
314            {Parameter entry in a call}
315            {parameter entry}
316            \index{call site!parameter entry} \\
317 \DWATcallpcTARG{}
318 &\livelinki{chap:DWATcallpcofcallsite}
319            {Address of the call instruction in a call}
320            {address of call instruction}
321            \index{call site!address of the call instruction} \\
322 \DWATcallreturnpcTARG{}
323 &\livelinki{chap:DWATcallreturnpcofcallsite}
324            {Return address from a call}
325            {return address from a call}
326            \index{call site!return address} \\
327 \DWATcalltailcallTARG{}
328 &\livelinki{chap:DWATcalltailcallofcallsite}
329            {Call is a tail call}
330            {call is a tail call}
331            \index{call site!tail call} \\
332 \DWATcalltargetTARG{}
333 &\livelinki{chap:DWATcalltargetofcallsite}
334            {Address of called routine in a call}
335            {address of called routine}
336            \index{call site!address of called routine} \\
337 \DWATcalltargetclobberedTARG{}
338 &\livelinki{chap:DWATcalltargetclobberedofcallsite}
339            {Address of called routine, which may be clobbered, in a call}
340            {address of called routine, which may be clobbered}
341            \index{call site!address of called routine, which may be clobbered} \\
342 \DWATcallvalueTARG{}
343 &\livelinki{chap:DWATcallvalueofcallparameter}
344            {Argument value passed in a call}
345            {argument value passed}
346            \index{call site!argument value passed} \\
347 \DWATcommonreferenceTARG
348 &\livelinki{chap:commonreferencecommonblockusage}
349         {Common block usage}
350         {common block usage} \\
351 \DWATcompdirTARG
352 &\livelinki{chap:DWATcompdircompilationdirectory}
353         {Compilation directory}
354         {compilation directory} \\
355 \DWATconstexprTARG
356 &\livelinki{chap:DWATconstexprcompiletimeconstantobject}
357         {Compile-time constant object}
358         {compile-time constant object} \\
359 &\livelinki{chap:DWATconstexprcompiletimeconstantfunction}
360         {Compile-time constant function}
361         {compile-time constant function} \\
362 \DWATconstvalueTARG
363 &\livelinki{chap:DWATconstvalueconstantobject}
364         {Constant object}
365         {constant object} \\
366 &\livelinki{chap:DWATconstvalueenumerationliteralvalue}
367         {Enumeration literal value}
368         {enumeration literal value} \\
369 &\livelinki{chap:DWATconstvaluetemplatevalueparameter}
370         {Template value parameter}
371         {template value parameter} \\
372 \DWATcontainingtypeTARG
373 &\livelinki{chap:DWATcontainingtypecontainingtypeofpointertomembertype}
374         {Containing type of pointer to member type}
375         {containing type of pointer to member type} \\
376 \DWATcountTARG
377 &\livelinki{chap:DWATcountelementsofsubrangetype}
378         {Elements of subrange type}
379         {elements of breg subrange type} \\
380 \DWATdatabitoffsetTARG
381 &\livelinki{chap:DWATdatabitoffsetbasetypebitlocation}
382         {Base type bit location}
383         {base type bit location} \\
384 &\livelinki{chap:DWATdatabitoffsetdatamemberbitlocation}
385         {Data member bit location}
386         {data member bit location} \\
387 \DWATdatalocationTARG{} 
388 &\livelinki{chap:DWATdatalocationindirectiontoactualdata}
389         {Indirection to actual data}   
390         {indirection to actual data} \\
391 \DWATdatamemberlocationTARG
392 &\livelinki{chap:DWATdatamemberlocationdatamemberlocation}
393         {Data member location}
394         {data member location} \\
395 &\livelinki{chap:DWATdatamemberlocationinheritedmemberlocation}
396         {Inherited member location}
397         {inherited member location} \\
398 \DWATdecimalscaleTARG
399 &\livelinki{chap:DWATdecimalscaledecimalscalefactor}
400         {Decimal scale factor}
401         {decimal scale factor} \\
402 \DWATdecimalsignTARG
403 &\livelinki{chap:DWATdecimalsigndecimalsignrepresentation}
404         {Decimal sign representation}
405         {decimal sign representation} \\
406 \DWATdeclcolumnTARG
407 &\livelinki{chap:DWATdeclcolumncolumnpositionofsourcedeclaration}
408         {Column position of source declaration}
409         {column position of source declaration} \\
410 \DWATdeclfileTARG
411 &\livelinki{chap:DWATdeclfilefilecontainingsourcedeclaration}
412         {File containing source declaration}
413         {file containing source declaration} \\
414 \DWATdecllineTARG
415 &\livelinki{chap:DWATdecllinelinenumberofsourcedeclaration}
416         {Line number of source declaration}
417         {line number of source declaration} \\
418 \DWATdeclarationTARG
419 &\livelinki{chap:DWATdeclarationincompletenondefiningorseparateentitydeclaration}
420         {Incomplete, non-defining, or separate entity declaration}
421         {incomplete, non-defining, or separate entity declaration} \\
422 \DWATdefaultedTARG
423 &\livelinki{chap:DWATdefaulteddef}
424         {Whether a member function has been declared as default}
425         {defaulted attribute} \\
426 \DWATdefaultvalueTARG
427 &\livelinki{chap:DWATdefaultvaluedefaultvalueofparameter}
428         {Default value of parameter}
429         {default value of parameter} \\
430 \DWATdeletedTARG
431 &\livelinki{chap:DWATdeleteddef}
432         {Whether a member has been declared as deleted}
433         {Deletion of member function} \\
434 \DWATdescriptionTARG{} 
435 &\livelinki{chap:DWATdescriptionartificialnameordescription}
436         {Artificial name or description}
437         {artificial name or description} \\
438 \DWATdigitcountTARG
439 &\livelinki{chap:DWATdigitcountdigitcountforpackeddecimalornumericstringtype}
440         {Digit count for packed decimal or numeric string type}
441         {digit count for packed decimal or numeric string type} \\
442 \DWATdiscrTARG
443 &\livelinki{chap:DWATdiscrdiscriminantofvariantpart}
444         {Discriminant of variant part}
445         {discriminant of variant part} \\
446 \DWATdiscrlistTARG
447 &\livelinki{chap:DWATdiscrlistlistofdiscriminantvalues}
448         {List of discriminant values}
449         {list of discriminant values} \\
450 \DWATdiscrvalueTARG
451 &\livelinki{chap:DWATdiscrvaluediscriminantvalue}
452         {Discriminant value}
453         {discriminant value} \\
454 \DWATdwoidTARG
455 &\livelinki{chap:DWATdwoidforunit}
456         {Signature for compilation unit}
457         {split DWARF object file!unit ID} \\
458 \DWATdwonameTARG
459 &\livelinki{chap:DWATdwonameforunit}
460         {Name of split DWARF object file}
461         {split DWARF object file!object file name} \\
462 \DWATelementalTARG
463 &\livelinki{chap:DWATelementalelementalpropertyofasubroutine}
464         {Elemental property of a subroutine}
465         {elemental property of a subroutine} \\
466 \DWATencodingTARG
467 &\livelinki{chap:DWATencodingencodingofbasetype}
468         {Encoding of base type}
469         {encoding of base type} \\
470 \DWATendianityTARG
471 &\livelinki{chap:DWATendianityendianityofdata}
472         {Endianity of data}
473         {endianity of data} \\
474 \DWATentrypcTARG
475 &\livelinki{chap:entryaddressofscope}
476         {Entry address of a scope (compilation unit, \mbox{subprogram,} and so on)}
477         {entry address of a scope} \\
478 \DWATenumclassTARG
479 &\livelinki{chap:DWATenumclasstypesafeenumerationdefinition}
480         {Type safe enumeration definition}
481         {type safe enumeration definition}\\
482 \DWATexplicitTARG
483 &\livelinki{chap:DWATexplicitexplicitpropertyofmemberfunction}
484         {Explicit property of member function}
485         {explicit property of member function}\\
486 \DWATexportsymbolsTARG
487 &\livelinki{chap:DWATexportsymbolsofnamespace}
488         {Export (inline) symbols of namespace}
489         {export symbols of a namespace} \\
490 &\livelinki{chap:DWATexportsymbolsofstructunionclass}
491         {Export symbols of a structure, union or class}
492         {export symbols of a structure, union or class} \\
493 \DWATextensionTARG
494 &\livelinki{chap:DWATextensionpreviousnamespaceextensionororiginalnamespace}
495         {Previous namespace extension or original namespace}
496         {previous namespace extension or original namespace}\\
497 \DWATexternalTARG
498 &\livelinki{chap:DWATexternalexternalsubroutine}
499         {External subroutine}
500         {external subroutine} \\
501 &\livelinki{chap:DWATexternalexternalvariable}
502         {External variable}
503         {external variable} \\
504 \DWATframebaseTARG
505 &\livelinki{chap:DWATframebasesubroutineframebaseaddress}
506         {Subroutine frame base address}
507         {subroutine frame base address} \\
508 \DWATfriendTARG
509 &\livelinki{chap:DWATfriendfriendrelationship}
510         {Friend relationship}
511         {friend relationship} \\
512 \DWAThighpcTARG
513 &\livelinki{chap:DWAThighpccontiguousrangeofcodeaddresses}
514         {Contiguous range of code addresses}
515         {contiguous range of code addresses} \\
516 \DWATidentifiercaseTARG
517 &\livelinki{chap:DWATidentifiercaseidentifiercaserule}
518         {Identifier case rule}
519         {identifier case rule} \\
520 \DWATimportTARG
521 &\livelinki{chap:DWATimportimporteddeclaration}
522         {Imported declaration}
523         {imported declaration} \\
524 &\livelinki{chap:DWATimportimportedunit}
525         {Imported unit}
526         {imported unit} \\
527 &\livelinki{chap:DWATimportnamespacealias}
528         {Namespace alias}
529         {namespace alias} \\
530 &\livelinki{chap:DWATimportnamespaceusingdeclaration}
531         {Namespace using declaration}
532         {namespace using declaration} \\
533 &\livelinki{chap:DWATimportnamespaceusingdirective}
534         {Namespace using directive}
535         {namespace using directive} \\
536 \DWATinlineTARG
537 &\livelinki{chap:DWATinlineabstracttinstance}
538         {Abstract instance}
539         {abstract instance} \\
540 &\livelinki{chap:DWATinlineinlinedsubroutine}
541         {Inlined subroutine}
542         {inlined subroutine} \\
543 \DWATisoptionalTARG
544 &\livelinki{chap:DWATisoptionaloptionalparameter}
545         {Optional parameter}
546         {optional parameter} \\
547 \DWATlanguageTARG
548 &\livelinki{chap:DWATlanguageprogramminglanguage}
549         {Programming language}
550         {programming language} \\
551 \DWATlinkagenameTARG
552 &\livelinki{chap:DWATlinkagenameobjectfilelinkagenameofanentity}
553         {Object file linkage name of an entity}
554         {object file linkage name of an entity}\\
555 \DWATlocationTARG
556 &\livelinki{chap:DWATlocationdataobjectlocation}
557         {Data object location}
558         {data object location}\\
559 \DWATlowpcTARG
560 &\livelinki{chap:DWATlowpccodeaddressorrangeofaddresses}
561         {Code address or range of addresses}
562         {code address or range of addresses}\\
563 \DWATlowerboundTARG
564 &\livelinki{chap:DWATlowerboundlowerboundofsubrange}
565         {Lower bound of subrange}
566         {lower bound of subrange} \\
567 \DWATmacroinfoTARG
568 &\livelinki{chap:DWATmacroinfomacroinformation}
569            {Macro preprocessor information (legacy)} 
570            {macro preprocessor information (legacy)} \\
571 &          \textit{(reserved for coexistence with \DWARFVersionIV{} and earlier)} \\
572 \DWATmacrosTARG
573 &\livelinki{chap:DWATmacrosmacroinformation}
574            {Macro preprocessor information} 
575            {macro preprocessor information} \\
576 &          \textit{(\texttt{\#define}, \texttt{\#undef}, and so on in \addtoindex{C}, 
577                 \addtoindex{C++} and similar languages)} \\
578 \DWATmainsubprogramTARG
579 &\livelinki{chap:DWATmainsubprogrammainorstartingsubprogram}
580         {Main or starting subprogram}
581         {main or starting subprogram} \\
582 &\livelinki{chap:DWATmainsubprogramunitcontainingmainorstartingsubprogram}
583         {Unit containing main or starting subprogram}
584         {unit containing main or starting subprogram}\\
585 \DWATmutableTARG
586 &\livelinki{chap:DWATmutablemutablepropertyofmemberdata}
587         {Mutable property of member data}
588         {mutable property of member data} \\
589 \DWATnameTARG
590 &\livelinki{chap:DWATnamenameofdeclaration}
591         {Name of declaration}
592         {name of declaration}\\
593 &\livelinki{chap:DWATnamepathnameofcompilationsource}
594         {Path name of compilation source}
595         {path name of compilation source} \\
596 \DWATnamelistitemTARG
597 &\livelinki{chap:DWATnamelistitemnamelistitem}
598         {Namelist item}
599         {namelist item}\\
600 \DWATnoreturnTARG
601 &\livelinki{chap:DWATnoreturnofsubprogram}
602         {\doublequote{no return} property of a subprogram}
603         {noreturn attribute} \\
604 \DWATobjectpointerTARG
605 &\livelinki{chap:DWATobjectpointerobjectthisselfpointerofmemberfunction}
606         {Object (\texttt{this}, \texttt{self}) pointer of member function}
607         {object (\texttt{this}, \texttt{self}) pointer of member function}\\
608 \DWATorderingTARG
609 &\livelinki{chap:DWATorderingarrayrowcolumnordering}
610         {Array row/column ordering}
611         {array row/column ordering}\\
612 \DWATpicturestringTARG
613 &\livelinki{chap:DWATpicturestringpicturestringfornumericstringtype}
614         {Picture string for numeric string type}
615         {picture string for numeric string type} \\
616 \DWATpriorityTARG
617 &\livelinki{chap:DWATprioritymodulepriority}
618         {Module priority}
619         {module priority}\\
620 \DWATproducerTARG
621 &\livelinki{chap:DWATproducercompileridentification}
622         {Compiler identification}
623         {compiler identification}\\
624 \DWATprototypedTARG
625 &\livelinki{chap:DWATprototypedsubroutineprototype}
626         {Subroutine prototype}
627         {subroutine prototype}\\
628 \DWATpureTARG
629 &\livelinki{chap:DWATpurepurepropertyofasubroutine}
630         {Pure property of a subroutine}
631         {pure property of a subroutine} \\
632 \DWATrangesTARG
633 &\livelinki{chap:DWATrangesnoncontiguousrangeofcodeaddresses}
634         {Non-contiguous range of code addresses}
635         {non-contiguous range of code addresses} \\
636 \DWATrangesbaseTARG
637 &\livelinki{chap:DWATrangesbaseforrangelists}
638         {Base offset for range lists}
639         {ranges lists} \\
640 \DWATrankTARG
641 &\livelinki{chap:DWATrankofdynamicarray}
642         {Dynamic number of array dimensions}
643         {dynamic number of array dimensions} \\
644 \DWATrecursiveTARG
645 &\livelinki{chap:DWATrecursiverecursivepropertyofasubroutine}
646         {Recursive property of a subroutine}
647         {recursive property of a subroutine} \\
648 \DWATreferenceTARG
649 &\livelink{chap:DWATreferenceofnonstaticmember}
650           {\&-qualified non-static member function} \textit{(\addtoindex{C++})} \\
651 \DWATreturnaddrTARG
652 &\livelinki{chap:DWATreturnaddrsubroutinereturnaddresssavelocation}
653            {Subroutine return address save location}
654            {subroutine return address save location} \\
655 \DWATrvaluereferenceTARG
656 &\livelink{chap:DWATrvaluereferenceofnonstaticmember}
657           {\&\&-qualified non-static member function} \textit{(\addtoindex{C++})} \\
658
659 \DWATsegmentTARG
660 &\livelinki{chap:DWATsegmentaddressinginformation}
661         {Addressing information}
662         {addressing information} \\
663 \DWATsiblingTARG
664 &\livelinki{chap:DWATsiblingdebugginginformationentryrelationship}
665            {Debugging information entry relationship}
666            {debugging information entry relationship} \\
667 \DWATsmallTARG
668 &\livelinki{chap:DWATsmallscalefactorforfixedpointtype}
669            {Scale factor for fixed-point type}
670            {scale factor for fixed-point type} \\
671 \DWATsignatureTARG
672 &\livelinki{chap:DWATsignaturetypesignature}
673            {Type signature}
674            {type signature}\\
675 \DWATspecificationTARG
676 &\livelinki{chap:DWATspecificationincompletenondefiningorseparatedeclaration}
677            {Incomplete, non-defining, or separate declaration corresponding to a declaration}
678            {incomplete, non-defining, or separate declaration corresponding to a declaration} \\
679 \DWATstartscopeTARG
680 &\livelinki{chap:DWATstartscopeobjectdeclaration}
681         {Object declaration}
682         {object declaration}\\*
683 &\livelinki{chap:DWATstartscopetypedeclaration}
684         {Type declaration}
685         {type declaration}\\
686 \DWATstaticlinkTARG
687 &\livelinki{chap:DWATstaticlinklocationofuplevelframe}
688         {Location of uplevel frame}
689         {location of uplevel frame} \\
690 \DWATstmtlistTARG
691 &\livelinki{chap:DWATstmtlistlinenumberinformationforunit}
692            {Line number information for unit}
693            {line number information for unit}\\
694 \DWATstringlengthTARG
695 &\livelinki{chap:DWATstringlengthstringlengthofstringtype}
696            {String length of string type}
697            {string length of string type} \\
698 \DWATstringlengthbitsizeTARG
699 &\livelinki{chap:DWATstringlengthstringlengthofstringtype}
700            {Size of string length of string type}
701            {string length of string type!size of} \\
702 \DWATstringlengthbytesizeTARG
703 &\livelinki{chap:DWATstringlengthstringlengthofstringtype}
704            {Size of string length of string type}
705            {string length of string type!size of} \\
706 \DWATstroffsetsbaseTARG
707 &\livelinki{chap:DWATstroffsetbaseforindirectstringtable}
708         {Base of string offsets table}
709         {string offsets table} \\
710 \DWATthreadsscaledTARG
711 &\livelink{chap:DWATthreadsscaledupcarrayboundthreadsscalfactor}
712         {UPC array bound THREADS scale factor}\\
713 \DWATtrampolineTARG
714 &\livelinki{chap:DWATtrampolinetargetsubroutine}
715         {Target subroutine}
716         {target subroutine of trampoline} \\
717 \DWATtypeTARG
718 &\livelinki{chap:DWATtypeofcallsite}
719         {Type of call site}
720         {type!of call site} \\
721 &\livelinki{char:DWAATtypeofstringtype}
722         {Type of string type components}
723         {type!of string type components} \\
724 &\livelinki{chap:DWATtypetypeofsubroutinereturn}
725         {Type of subroutine return}
726         {type!of subroutine return} \\
727 &\livelinki{chap:DWATtypetypeofdeclaration}
728         {Type of declaration}
729         {type!of declaration} \\
730 \DWATupperboundTARG
731 &\livelinki{chap:DWATupperboundupperboundofsubrange}
732         {Upper bound of subrange}
733         {upper bound of subrange} \\
734 \DWATuselocationTARG
735 &\livelinki{chap:DWATuselocationmemberlocationforpointertomembertype}
736         {Member location for pointer to member type}
737         {member location for pointer to member type} \\
738 \DWATuseUTFeightTARG\addtoindexx{use UTF8 attribute}\addtoindexx{UTF-8}
739 &\livelinki{chap:DWATuseUTF8compilationunitusesutf8strings}
740         {Compilation unit uses UTF-8 strings}
741         {compilation unit uses UTF-8 strings} \\
742 \DWATvariableparameterTARG
743 &\livelinki{chap:DWATvariableparameternonconstantparameterflag}
744         {Non-constant parameter flag}
745         {non-constant parameter flag}  \\
746 \DWATvirtualityTARG
747 &\livelinki{chap:DWATvirtualityvirtualityindication}
748         {Virtuality indication}
749         {virtuality indication} \\
750 &\livelinki{chap:DWATvirtualityvirtualityofbaseclass}
751         {Virtuality of base class}
752         {virtuality of base class} \\
753 &\livelinki{chap:DWATvirtualityvirtualityoffunction}
754         {Virtuality of function}
755         {virtuality of function} \\
756 \DWATvisibilityTARG
757 &\livelinki{chap:DWATvisibilityvisibilityofdeclaration}
758         {Visibility of declaration}
759         {visibility of declaration} \\
760 \DWATvtableelemlocationTARG
761 &\livelinki{chap:DWATvtableelemlocationvirtualfunctiontablevtableslot}
762         {Virtual function vtable slot}
763         {virtual function vtable slot}\\
764 \end{longtable}
765
766 \addtoindexx{address|see {\textit{also} address class}}
767 \addtoindexx{addrptr|see {\textit{also} addrptr class}}
768 \addtoindexx{block|see {\textit{also} block class}}
769 \addtoindexx{constant|see {\textit{also} constant class}}
770 \addtoindexx{exprloc|see {\textit{also} exprloc class}}
771 \addtoindexx{flag|see {\textit{also} flag class}}
772 \addtoindexx{lineptr|see {\textit{also} lineptr class}}
773 \addtoindexx{loclistptr|see {\textit{also} loclistptr class}}
774 \addtoindexx{macptr|see {\textit{also} macptr class}}
775 \addtoindexx{rangelistptr|see {\textit{also} rangelistptr class}}
776 \addtoindexx{reference|see {\textit{also} reference class}}
777 \addtoindexx{string|see {\textit{also} string class}}
778 \addtoindexx{stroffsetsptr|see {\textit{also} stroffsetsptr class}}
779
780 \addtoindexx{class of attribute value!address|see {address class}}
781 \addtoindexx{class of attribute value!addrptr|see {addrptr class}}
782 \addtoindexx{class of attribute value!block|see {block class}}
783 \addtoindexx{class of attribute value!constant|see {constant class}}
784 \addtoindexx{class of attribute value!exprloc|see {exprloc class}}
785 \addtoindexx{class of attribute value!flag|see {flag class}}
786 \addtoindexx{class of attribute value!lineptr|see {lineptr class}}
787 \addtoindexx{class of attribute value!loclistptr|see {loclistptr class}}
788 \addtoindexx{class of attribute value!macptr|see {macptr class}}
789 \addtoindexx{class of attribute value!rangelistptr|see {rangelistptr class}}
790 \addtoindexx{class of attribute value!reference|see {reference class}}
791 \addtoindexx{class of attribute value!string|see {string class}}
792 \addtoindexx{class of attribute value!stroffsetsptr|see {stroffsetsptr class}}
793
794 The permissible values
795 \addtoindexx{attribute value classes}
796 for an attribute belong to one or more classes of attribute
797 value forms.  
798 Each form class may be represented in one or more ways. 
799 For example, some attribute values consist
800 of a single piece of constant data. 
801 \doublequote{Constant data}
802 is the class of attribute value that those attributes may have. 
803 There are several representations of constant data,
804 however (one, two, four, or eight bytes, and variable length
805 data). 
806 The particular representation for any given instance
807 of an attribute is encoded along with the attribute name as
808 part of the information that guides the interpretation of a
809 debugging information entry.  
810
811 \needlines{4}
812 Attribute value forms belong
813 \addtoindexx{tag names!list of}
814 to one of the classes shown in Table \referfol{tab:classesofattributevalue}.
815
816 \begin{longtable}{l|P{11cm}}
817 \caption{Classes of attribute value}
818 \label{tab:classesofattributevalue} \\
819 \hline \bfseries Attribute Class & \bfseries General Use and Encoding \\ \hline
820 \endfirsthead
821   \bfseries Attribute Class & \bfseries General Use and Encoding \\ \hline
822 \endhead
823   \hline \emph{Continued on next page}
824 \endfoot
825   \hline
826 \endlastfoot
827
828 \hypertarget{chap:classaddress}{}
829 \livelinki{datarep:classaddress}{address}{address class}
830 &Refers to some location in the address space of the \mbox{described} program.
831 \\
832
833 \hypertarget{chap:classaddrptr}{}
834 \livelinki{datarep:classaddrptr}{addrptr}{addrptr class}
835 &Refers to a base location in the DWARF section that holds
836 a series of machine address values. Certain attributes \mbox{refer}
837 one of these addresses by indexing relative to this base
838 location.
839 \\
840
841 \hypertarget{chap:classblock}{}
842 \livelinki{datarep:classblock}{block}{block class}
843 & An arbitrary number of uninterpreted bytes of data.
844 \\
845  
846 \hypertarget{chap:classconstant}{}
847 \livelinki{datarep:classconstant}{constant}{constant class}
848 &One, two, four or eight bytes of uninterpreted data, or data
849 encoded in the variable length format known as LEB128 
850 (see Section \refersec{datarep:variablelengthdata}).
851
852 \textit{Most constant values are integers of one kind or
853 another (codes, offsets, counts, and so on); these are
854 sometimes called \doublequote{integer constants} for emphasis.}
855 \addtoindexx{integer constant}
856 \addtoindexx{constant class!integer}
857 \\
858
859 \hypertarget{chap:classexprloc}{}
860 \livelinki{datarep:classexprloc}{exprloc}{exprloc class}
861 &A DWARF expression for a value or a location in the \mbox{address} space of the described program.
862 \\
863
864 \hypertarget{chap:classflag}{}
865 \livelinki{datarep:classflag}{flag}{flag class}
866 &A small constant that indicates the presence or absence of an attribute.
867 \\
868
869 \hypertarget{chap:classlineptr}{}
870 \livelinki{datarep:classlineptr}{lineptr}{lineptr class}
871 &Refers to a location in the DWARF section that holds line number information.
872 \\
873
874 \hypertarget{chap:classloclistptr}{}
875 \livelinki{datarep:classloclistptr}{loclistptr}{loclistptr class}
876 &Refers to a location in the DWARF section that holds \mbox{location} lists, which
877 describe objects whose location can change during their lifetime.
878 \\
879
880 \hypertarget{chap:classmacptr}{}
881 \livelinki{datarep:classmacptr}{macptr}{macptr class}
882 & Refers to a location in the DWARF section that holds macro definition
883  information.
884 \\
885
886 \hypertarget{chap:classrangelistptr}{}
887 \livelinki{datarep:classrangelistptr}{rangelistptr}{rangelistptr class}
888 & Refers to a location in the DWARF section that holds non\dash contiguous address ranges.
889 \\
890
891 \hypertarget{chap:classreference}{}
892 \livelinki{datarep:classreference}{reference}{reference class}
893 & Refers to one of the debugging information
894 entries that \mbox{describe} the program.  There are four types of
895 \mbox{reference}. The first is an offset relative to the beginning
896 of the \mbox{compilation} unit in which the reference occurs and must
897 refer to an entry within that same compilation unit. The second
898 type of reference is the offset of a debugging \mbox{information}
899 entry in any compilation unit, including one different from
900 the unit containing the reference. The third type of reference
901 is an indirect reference to a 
902 \addtoindexx{type signature}
903 type definition using a 8-byte \mbox{signature} 
904 for that type. The fourth type of reference is a reference from within the 
905 \dotdebuginfo{} section of the executable or shared object file to
906 a debugging information entry in the \dotdebuginfo{} section of 
907 a \addtoindex{supplementary object file}.
908 \\
909
910 \hypertarget{chap:classstring}{}
911 \livelinki{datarep:classstring}{string}{string class}
912 & A null\dash terminated sequence of zero or more
913 (non\dash null) bytes. Data in this class are generally
914 printable strings. Strings may be represented directly in
915 the debugging \mbox{information} entry or as an offset in a separate
916 string table.
917 \\
918
919 \hypertarget{chap:classstroffsetsptr}{}
920 \livelinki{datarep:classstroffsetsptr}{stroffsetsptr}{stroffsetsptr class}
921 &Refers to a base location in the DWARF section that holds
922 a series of offsets in the DWARF section that holds strings.
923 Certain attributes refer to one of these offsets by indexing 
924 \mbox{relative} to this base location. The resulting offset is then 
925 used to index into the DWARF string section.
926 \\
927
928 \hline
929 \end{longtable}
930
931
932 \section{Relationship of Debugging Information Entries}
933 \label{chap:relationshipofdebugginginformationentries}
934 \textit{%
935 A variety of needs can be met by permitting a single
936 \addtoindexx{debugging information entry!ownership relation}
937 debugging information entry to \doublequote{own} an arbitrary number
938 of other debugging entries and by permitting the same debugging
939 information entry to be one of many owned by another debugging
940 information entry. 
941 This makes it possible, for example, to
942 describe the static \livelink{chap:lexicalblock}{block} structure 
943 within a source file,
944 to show the members of a structure, union, or class, and to
945 associate declarations with source files or source files
946 with shared object files.  
947 }
948
949
950 The ownership relation 
951 \addtoindexx{debugging information entry!ownership relation}
952 of debugging
953 information entries is achieved naturally because the debugging
954 information is represented as a tree. 
955 The nodes of the tree
956 are the debugging information entries themselves. 
957 The child
958 entries of any node are exactly those debugging information
959 entries owned by that node.  
960
961 \needlines{4}
962 \textit{%
963 While the ownership relation
964 of the debugging information entries is represented as a
965 tree, other relations among the entries exist, for example,
966 a reference from an entry representing a variable to another
967 entry representing the type of that variable. 
968 If all such
969 relations are taken into account, the debugging entries
970 form a graph, not a tree.  
971 }
972
973 \needlines{4}
974 The tree itself is represented
975 by flattening it in prefix order. 
976 Each debugging information
977 entry is defined either to have child entries or not to have
978 child entries (see Section \refersec{datarep:abbreviationstables}). 
979 If an entry is defined not
980 to have children, the next physically succeeding entry is a
981 sibling. 
982 If an entry is defined to have children, the next
983 physically succeeding entry is its first child. 
984 Additional
985 children are represented as siblings of the first child. 
986 A chain of sibling entries is terminated by a null entry.
987
988 In cases where a producer of debugging information feels that
989 \hypertarget{chap:DWATsiblingdebugginginformationentryrelationship}{}
990 it will be important for consumers of that information to
991 quickly scan chains of sibling entries, while ignoring the
992 children of individual siblings, that producer may attach a
993 \addtoindexx{sibling attribute}
994 \DWATsiblingDEFN{} attribute 
995 to any debugging information entry. 
996 The value of this attribute is a reference to the sibling entry
997 of the entry to which the attribute is attached.
998
999
1000 \section{Target Addressable Units and Addresses}
1001 \label{chap:targetaddressableunitsandaddresses}
1002 The standard assumes that the smallest directly 
1003 \addtoindex{addressable unit} of memory on the
1004 target architecture is a byte consisting of eight bits.
1005
1006 \label{chap:targetaddresses}
1007 Many places in this document refer to the size of an
1008 \addtoindexx{size of an address|see{\textit{also} \texttt{address\_size}}}
1009 \addtoindexi{address}{size of an address}
1010 \addtoindexx{address size|see{size of an address}}
1011 \addtoindexx{address size|see{\textit{also} \texttt{address\_size}}}
1012 on the target architecture (or equivalently, target machine)
1013 to which a DWARF description applies. For processors which
1014 can be configured to have different address sizes or different
1015 instruction sets, the intent is to refer to the configuration
1016 which is either the default for that processor or which is
1017 specified by the object file or executable file which contains
1018 the DWARF information.
1019
1020 \textit{%
1021 For example, if a particular target architecture supports
1022 both 32-bit and 64-bit addresses, the compiler will generate
1023 an object file which specifies that it contains executable
1024 code generated for one or the other of these 
1025 \addtoindexx{size of an address}
1026 address sizes. In
1027 that case, the DWARF debugging information contained in this
1028 object file will use the same address size.
1029 }
1030
1031 \textit{%
1032 Architectures which have multiple instruction sets are
1033 supported by the \texttt{isa} entry in the line number information
1034 (see Section \refersec{chap:statemachineregisters}).
1035 }
1036
1037 \needlines{4}
1038 \section{DWARF Expressions}
1039 \label{chap:dwarfexpressions}
1040 DWARF expressions describe how to compute a value or name a
1041 location during debugging of a program. 
1042 They are expressed in
1043 terms of DWARF operations that operate on a stack of values.
1044
1045 All DWARF operations are encoded as a stream of opcodes that
1046 are each followed by zero or more literal operands. 
1047 The number
1048 of operands is determined by the opcode.  
1049
1050 In addition to the
1051 general operations that are defined here, operations that are
1052 specific to location descriptions are defined in 
1053 Section \refersec{chap:locationdescriptions}.
1054
1055 \subsection{General Operations}
1056 \label{chap:generaloperations}
1057 Each general operation represents a postfix operation on
1058 a simple stack machine. 
1059 Each element of the stack has a type and a value, and can represent
1060 a value of any supported base type of the target machine.  Instead of
1061 a base type, elements can have a 
1062 \livetarg{chap:specialaddresstype}{special address type},
1063 which is an integral type that has the 
1064 \addtoindex{size of an address} on the target machine and 
1065 unspecified signedness. The value on the top of the stack after 
1066 \doublequote{executing} the 
1067 \addtoindex{DWARF expression}
1068 is 
1069 \addtoindexx{DWARF expression|see{\textit{also} location description}}
1070 taken to be the result (the address of the object, the
1071 value of the array bound, the length of a dynamic string,
1072 the desired value itself, and so on).
1073
1074 \needlines{4}
1075 \textit{While the abstract definition of the stack calls for variable-size entries
1076 able to hold any supported base type, in practice it is expected that each
1077 element of the stack can be represented as a fixed-size element large enough
1078 to hold a value of any type supported by the DWARF consumer for that target,
1079 plus a small identifier sufficient to encode the type of that element.
1080 Support for base types other than what is required to do address arithmetic
1081 is intended only for debugging of optimized code, and the completeness of the
1082 DWARF consumer's support for the full set of base types is a
1083 quality-of-implementation issue. If a consumer encounters a DWARF expression
1084 that uses a type it does not support, it should ignore the entire expression
1085 and report its inability to provide the requested information.}
1086
1087 \textit{It should also be noted that floating-point arithmetic is highly dependent
1088 on the computational environment. It is not the intention of this expression
1089 evaluation facility to produce identical results to those produced by the
1090 program being debugged while executing on the target machine. Floating-point
1091 computations in this stack machine will be done with precision control and
1092 rounding modes as defined by the implementation.}
1093
1094 \needlines{4}
1095 \subsubsection{Literal Encodings}
1096 \label{chap:literalencodings}
1097 The 
1098 \addtoindexx{DWARF expression!literal encodings}
1099 following operations all push a value onto the DWARF
1100 stack. 
1101 \addtoindexx{DWARF expression!stack operations}
1102 Operations other than \DWOPconsttype{} push a value with the 
1103 \specialaddresstype, and if the value of a constant in one of these 
1104 operations is larger than can be stored in a single stack element, 
1105 the value is truncated to the element size and the low-order bits
1106 are pushed on the stack.
1107 \begin{enumerate}[1. ]
1108 \itembfnl{\DWOPlitzeroTARG, \DWOPlitoneTARG, \dots, \DWOPlitthirtyoneTARG}
1109 The \DWOPlitnTARG{} operations encode the unsigned literal values
1110 from 0 through 31, inclusive.
1111
1112 \itembfnl{\DWOPaddrTARG}
1113 The \DWOPaddrNAME{} operation has a single operand that encodes
1114 a machine address and whose size is the \addtoindex{size of an address}
1115 on the target machine.
1116
1117 \itembfnl{\DWOPconstoneuTARG, \DWOPconsttwouTARG, \DWOPconstfouruTARG, \DWOPconsteightuTARG}
1118 \DWOPconstnxMARK{}
1119 The single operand of a \DWOPconstnuNAME{} operation provides a 1,
1120 2, 4, or 8-byte unsigned integer constant, respectively.
1121
1122 \itembfnl{\DWOPconstonesTARG, \DWOPconsttwosTARG, \DWOPconstfoursTARG, \DWOPconsteightsTARG}
1123 The single operand of a \DWOPconstnsNAME{} operation provides a 1,
1124 2, 4, or 8-byte signed integer constant, respectively.
1125
1126 \itembfnl{\DWOPconstuTARG}
1127 The single operand of the \DWOPconstuNAME{} operation provides
1128 an unsigned LEB128\addtoindexx{LEB128!unsigned} integer constant.
1129
1130 \itembfnl{\DWOPconstsTARG}
1131 The single operand of the \DWOPconstsNAME{} operation provides
1132 a signed LEB128\addtoindexx{LEB128!unsigned} integer constant.
1133
1134 \needlines{4}
1135 \itembfnl{\DWOPaddrxTARG}
1136 The \DWOPaddrxNAME{} operation has a single operand that
1137 encodes an unsigned LEB128\addtoindexx{LEB128!unsigned} value, 
1138 which is a zero-based index into the \dotdebugaddr{} section, 
1139 where a machine address is stored.
1140 This index is relative to the value of the 
1141 \DWATaddrbase{} attribute of the associated compilation unit.
1142
1143 \itembfnl{\DWOPconstxTARG}
1144 The \DWOPconstxNAME{} operation has a single operand that
1145 encodes an unsigned LEB128\addtoindexx{LEB128!unsigned} value, 
1146 which is a zero-based
1147 index into the \dotdebugaddr{} section, where a constant, the
1148 size of a machine address, is stored.
1149 This index is relative to the value of the 
1150 \DWATaddrbase{} attribute of the associated compilation unit.
1151
1152 \needlines{3}
1153 \textit{The \DWOPconstxNAME{} operation is provided for constants that
1154 require link-time relocation but should not be
1155 interpreted by the consumer as a relocatable address
1156 (for example, offsets to thread-local storage).}
1157
1158 \needlines{12}
1159 \itembfnl{\DWOPconsttypeTARG}
1160 The \DWOPconsttypeNAME{} operation takes three operands. The first operand 
1161 is an unsigned LEB128 integer that represents the offset of a debugging
1162 information entry in the current compilation unit, which must be a
1163 \DWTAGbasetype{} entry that provides the type of the constant provided. The
1164 second operand is 1-byte unsigned integer that specifies the size of the
1165 constant value, which is the same as the size of the base type referenced
1166 by the first operand. The third operand is a block of specified 
1167 size that is to be interpreted as a value of the referenced type.
1168
1169 \textit{While the size of the constant can be inferred from the base type
1170 definition, it is encoded explicitly into the operation so that the
1171 operation can be parsed easily without reference to the \dotdebuginfo{}
1172 section.}
1173
1174 \end{enumerate}
1175
1176 \needlines{10}
1177 \subsubsection{Register Values}
1178 \label{chap:registervalues}
1179 The following operations push a value onto the stack that is either the
1180 contents of a register or the result of adding the contents of a register
1181 to a given signed offset. 
1182 \addtoindexx{DWARF expression!register based addressing}
1183 \DWOPregvaltype{} pushes the contents
1184 of the register together with the given base type, while the other operations
1185 push the result of adding the contents of a register to a given
1186 signed offset together with the \specialaddresstype.
1187
1188 \needlines{8}
1189 \begin{enumerate}[1. ]
1190 \itembfnl{\DWOPfbregTARG}
1191 The \DWOPfbregNAME{} operation provides a 
1192 signed LEB128\addtoindexx{LEB128!signed} offset
1193 from the address specified by the location description in the
1194 \DWATframebase{} attribute of the current function. (This
1195 is typically a \doublequote{stack pointer} register plus or minus
1196 some offset. On more sophisticated systems it might be a
1197 location list that adjusts the offset according to changes
1198 in the stack pointer as the PC changes.)
1199
1200 \itembfnl{\DWOPbregzeroTARG, \DWOPbregoneTARG, \dots, \DWOPbregthirtyoneTARG}
1201 The single operand of the \DWOPbregnTARG{} 
1202 operations provides
1203 a signed LEB128\addtoindexx{LEB128!signed} offset from
1204 the specified register.
1205
1206 \itembfnl{\DWOPbregxTARG}
1207 The \DWOPbregxNAME{} operation provides the sum of two values specified
1208 by its two operands. The first operand is a register number
1209 which is specified by an unsigned LEB128\addtoindexx{LEB128!unsigned}
1210 number. The second operand is a signed LEB128\addtoindexx{LEB128!signed} offset.
1211
1212 \needlines{8}
1213 \itembfnl{\DWOPregvaltypeTARG}
1214 The \DWOPregvaltypeNAME{} operation provides the contents of
1215 a given register interpreted as a value of a given type. The first 
1216 operand is an unsigned LEB128\addtoindexx{LEB128!unsigned} number, 
1217 which identifies a register whose contents is to
1218 be pushed onto the stack. The second operand is an 
1219 unsigned LEB128\addtoindexx{LEB128!unsigned} number
1220 that represents the offset of a debugging information entry in the current
1221 compilation unit, which must be a \DWTAGbasetype{} entry that provides the
1222 type of the value contained in the specified register.
1223
1224 \end{enumerate}
1225
1226 \needlines{6}
1227 \subsubsection{Stack Operations}
1228 \label{chap:stackoperations}
1229 The following 
1230 \addtoindexx{DWARF expression!stack operations}
1231 operations manipulate the DWARF stack. Operations
1232 that index the stack assume that the top of the stack (most
1233 recently added entry) has index 0.
1234
1235 The \DWOPdup{}, \DWOPdrop{}, \DWOPpick{}, \DWOPover{}, \DWOPswap{}
1236 and \DWOProt{} operations manipulate the elements of the stack as pairs
1237 consisting of the value together with its type identifier. 
1238 The \DWOPderef{}, \DWOPderefsize{}, \DWOPxderef{}, \DWOPxderefsize{} 
1239 and \DWOPformtlsaddress{}
1240 operations require the popped values to have an integral type, either the
1241 \specialaddresstype{} or some other integral base type, and push a 
1242 value with the \specialaddresstype.  
1243 \DWOPdereftype{} and \DWOPxdereftype{} operations have the
1244 same requirement on the popped values, but push a value together 
1245 with the same type as the popped values.
1246 All other operations push a value together with the \specialaddresstype.
1247
1248 \needlines{4}
1249 \begin{enumerate}[1. ]
1250 \itembfnl{\DWOPdupTARG}
1251 The \DWOPdupNAME{} operation duplicates the value (including its 
1252 type identifier) at the top of the stack.
1253
1254 \itembfnl{\DWOPdropTARG}
1255 The \DWOPdropNAME{} operation pops the value (including its type 
1256 identifier) at the top of the stack.
1257
1258 \itembfnl{\DWOPpickTARG}
1259 The single operand of the \DWOPpickNAME{} operation provides a
1260 1-byte index. A copy of the stack entry (including its 
1261 type identifier) with the specified
1262 index (0 through 255, inclusive) is pushed onto the stack.
1263
1264 \itembfnl{\DWOPoverTARG}
1265 The \DWOPoverNAME{} operation duplicates the entry currently second
1266 in the stack at the top of the stack. 
1267 This is equivalent to a
1268 \DWOPpick{} operation, with index 1.  
1269
1270 \needlines{4}
1271 \itembfnl{\DWOPswapTARG}
1272 The \DWOPswapNAME{} operation swaps the top two stack entries. 
1273 The entry at the top of the stack (including its type identifier)
1274 becomes the second stack entry, and the second entry (including 
1275 its type identifier) becomes the top of the stack.
1276
1277 \itembfnl{\DWOProtTARG}
1278 The \DWOProtNAME{} operation rotates the first three stack
1279 entries. The entry at the top of the stack (including its 
1280 type identifier) becomes the third stack entry, the second 
1281 entry (including its type identifier) becomes the top of 
1282 the stack, and the third entry (including its type identifier)
1283 becomes the second entry.
1284
1285 \itembfnl{\DWOPderefTARG}
1286 The \DWOPderefNAME{} operation pops the top stack entry and 
1287 treats it as an address. The popped value must have an integral type.
1288 The value retrieved from that address is pushed, together with the
1289 \specialaddresstype{} identifier. 
1290 The size of the data retrieved from the 
1291 \addtoindexi{dereferenced}{address!dereference operator}
1292 address is the \addtoindex{size of an address} on the target machine.
1293
1294 \needlines{4}
1295 \itembfnl{\DWOPderefsizeTARG}
1296 The \DWOPderefsizeNAME{} operation behaves like the 
1297 \DWOPderef{}
1298 operation: it pops the top stack entry and treats it as an
1299 address. The popped value must have an integral type.
1300 The value retrieved from that address is pushed, together with the
1301 \specialaddresstype{} identifier. In
1302 the \DWOPderefsizeNAME{} operation, however, the size in bytes
1303 of the data retrieved from the dereferenced address is
1304 specified by the single operand. This operand is a 1-byte
1305 unsigned integral constant whose value may not be larger
1306 than the size of the \specialaddresstype. The data
1307 retrieved is zero extended to the size of an address on the
1308 target machine before being pushed onto the expression stack.
1309
1310 \itembfnl{\DWOPdereftypeTARG}
1311 The \DWOPdereftypeNAME{} operation behaves like the \DWOPderefsize{} operation:
1312 it pops the top stack entry and treats it as an address. 
1313 The popped value must have an integral type.
1314 The value retrieved from that address is pushed together with a type identifier. 
1315 In the \DWOPdereftypeNAME{} operation, the size in
1316 bytes of the data retrieved from the dereferenced address is specified by
1317 the first operand. This operand is a 1-byte unsigned integral constant whose
1318 value which is the same as the size of the base type referenced
1319 by the second operand.
1320 The second operand is an unsigned LEB128 integer that
1321 represents the offset of a debugging information entry in the current
1322 compilation unit, which must be a \DWTAGbasetype{} entry that provides the
1323 type of the data pushed.
1324
1325 \textit{While the size of the pushed value could be inferred from the base 
1326 type definition, it is encoded explicitly into the operation so that the
1327 operation can be parsed easily without reference to the \dotdebuginfo{}
1328 section.}
1329
1330 \needlines{7}
1331 \itembfnl{\DWOPxderefTARG}
1332 The \DWOPxderefNAME{} operation provides an extended dereference
1333 mechanism. The entry at the top of the stack is treated as an
1334 address. The second stack entry is treated as an \doublequote{address
1335 space identifier} for those architectures that support
1336 \addtoindexi{multiple}{address space!multiple}
1337 address spaces. 
1338 Both of these entries must have integral type identifiers.
1339 The top two stack elements are popped,
1340 and a data item is retrieved through an implementation-defined
1341 address calculation and pushed as the new stack top together with the
1342 \specialaddresstype{} identifier.
1343 The size of the data retrieved from the 
1344 \addtoindexi{dereferenced}{address!dereference operator}
1345 address is the size of the \specialaddresstype.
1346
1347 \itembfnl{\DWOPxderefsizeTARG}
1348 The \DWOPxderefsizeNAME{} operation behaves like the
1349 \DWOPxderef{} operation. The entry at the top of the stack is
1350 treated as an address. The second stack entry is treated as
1351 an \doublequote{address space identifier} for those architectures
1352 that support 
1353 \addtoindexi{multiple}{address space!multiple}
1354 address spaces. 
1355 Both of these entries must have integral type identifiers.
1356 The top two stack
1357 elements are popped, and a data item is retrieved through an
1358 implementation\dash defined address calculation and pushed as the
1359 new stack top. In the \DWOPxderefsizeNAME{} operation, however,
1360 the size in bytes of the data retrieved from the 
1361 \addtoindexi{dereferenced}{address!dereference operator}
1362 address is specified by the single operand. This operand is a
1363 1-byte unsigned integral constant whose value may not be larger
1364 than the \addtoindex{size of an address} on the target machine. The data
1365 retrieved is zero extended to the \addtoindex{size of an address} on the
1366 target machine before being pushed onto the expression stack together
1367 with the \specialaddresstype{} identifier.
1368
1369 \itembfnl{\DWOPxdereftypeTARG}
1370 The \DWOPxdereftypeNAME{} operation behaves like the \DWOPxderefsize{}
1371 operation: it pops the top two stack entries, treats them as an address and
1372 an address space identifier, and pushes the value retrieved. In the
1373 \DWOPxdereftypeNAME{} operation, the size in bytes of the data retrieved from
1374 the dereferenced address is specified by the first operand. This operand is
1375 a 1-byte unsigned integral constant whose value 
1376 value which is the same as the size of the base type referenced
1377 by the second operand. The second
1378 operand is an unsigned LEB128 integer that represents the offset of a
1379 debugging information entry in the current compilation unit, which must be a
1380 \DWTAGbasetype{} entry that provides the type of the data pushed.
1381
1382 \needlines{6}
1383 \itembfnl{\DWOPpushobjectaddressTARG}
1384 The \DWOPpushobjectaddressNAME{}
1385 operation pushes the address
1386 of the object currently being evaluated as part of evaluation
1387 of a user presented expression. This object may correspond
1388 to an independent variable described by its own debugging
1389 information entry or it may be a component of an array,
1390 structure, or class whose address has been dynamically
1391 determined by an earlier step during user expression
1392 evaluation.
1393
1394 \textit{This operator provides explicit functionality
1395 (especially for arrays involving descriptors) that is analogous
1396 to the implicit push of the base 
1397 \addtoindexi{address}{address!implicit push of base}
1398 of a structure prior to evaluation of a 
1399 \DWATdatamemberlocation{} 
1400 to access a data member of a structure. For an example, see 
1401 Appendix \refersec{app:aggregateexamples}.}
1402
1403 \needlines{4}
1404 \itembfnl{\DWOPformtlsaddressTARG}
1405 The \DWOPformtlsaddressNAME{} 
1406 operation pops a value from the stack, which must have an 
1407 integral type identifier, translates this
1408 value into an address in the 
1409 \addtoindex{thread-local storage}
1410 for a thread, and pushes the address 
1411 onto the stack together with the \specialaddresstype{} identifier. 
1412 The meaning of the value on the top of the stack prior to this 
1413 operation is defined by the run-time environment.  If the run-time 
1414 environment supports multiple thread-local storage 
1415 \nolink{blocks} for a single thread, then the \nolink{block} 
1416 corresponding to the executable or shared 
1417 library containing this DWARF expression is used.
1418    
1419 \textit{Some implementations of 
1420 \addtoindex{C}, \addtoindex{C++}, \addtoindex{Fortran}, and other 
1421 languages, support a 
1422 thread-local storage class. Variables with this storage class
1423 have distinct values and addresses in distinct threads, much
1424 as automatic variables have distinct values and addresses in
1425 each function invocation. Typically, there is a single \nolink{block}
1426 of storage containing all thread\dash local variables declared in
1427 the main executable, and a separate \nolink{block} for the variables
1428 declared in each shared library. Each 
1429 thread\dash local variable can then be accessed in its block using an
1430 identifier. This identifier is typically an offset into the block and 
1431 pushed onto the DWARF stack by one of the 
1432 \DWOPconstnx{} operations prior to the
1433 \DWOPformtlsaddress{} operation. 
1434 Computing the address of
1435 the appropriate \nolink{block} can be complex (in some cases, the
1436 compiler emits a function call to do it), and difficult
1437 to describe using ordinary DWARF location descriptions.
1438 Instead of    forcing complex thread-local storage calculations into 
1439 the DWARF expressions, the \DWOPformtlsaddress{} allows the consumer 
1440 to perform the computation based on the run-time environment.}
1441
1442 \needlines{4}
1443 \itembfnl{\DWOPcallframecfaTARG}
1444 The \DWOPcallframecfaNAME{} 
1445 operation pushes the value of the
1446 CFA, obtained from the Call Frame Information 
1447 (see Section \refersec{chap:callframeinformation}).
1448
1449 \textit{Although the value of \DWATframebase{}
1450 can be computed using other DWARF expression operators,
1451 in some cases this would require an extensive location list
1452 because the values of the registers used in computing the
1453 CFA change during a subroutine. If the 
1454 Call Frame Information 
1455 is present, then it already encodes such changes, and it is
1456 space efficient to reference that.}
1457 \end{enumerate}
1458
1459 \textit{Examples illustrating many of these stack operations are
1460 found in Appendix \refersec{app:dwarfstackoperationexamples}.}
1461
1462 \subsubsection{Arithmetic and Logical Operations} 
1463 \addtoindexx{DWARF expression!arithmetic operations}
1464 \addtoindexx{DWARF expression!logical operations}
1465 The following provide arithmetic and logical operations.  If an operation
1466 pops two values from the stack, both values must have the same type,
1467 either the same base type or both the \specialaddresstype.
1468 The result of the operation which is pushed back has the same type
1469 as the type of the operands.  
1470
1471 If the type of the operands is the \specialaddresstype, 
1472 except as otherwise specified, the arithmetic operations
1473 perform addressing arithmetic, that is, unsigned arithmetic that is performed
1474 modulo one plus the largest representable address (for example, 0x100000000
1475 when the \addtoindex{size of an address} is 32 bits). 
1476
1477 Operations other than \DWOPabs{},
1478 \DWOPdiv{}, \DWOPminus{}, \DWOPmul{}, \DWOPneg{} and \DWOPplus{} 
1479 require integral types of the operand (either integral base type 
1480 or the \specialaddresstype).  Operations do not cause an exception 
1481 on overflow.
1482
1483 \needlines{4}
1484 \begin{enumerate}[1. ]
1485 \itembfnl{\DWOPabsTARG}
1486 The \DWOPabsNAME{} operation pops the top stack entry, interprets
1487 it as a signed value and pushes its absolute value. If the
1488 absolute value cannot be represented, the result is undefined.
1489
1490 \needlines{4}
1491 \itembfnl{\DWOPandTARG}
1492 The \DWOPandNAME{} operation pops the top two stack values, performs
1493 a bitwise and operation on the two, and pushes the result.
1494
1495 \itembfnl{\DWOPdivTARG}
1496 The \DWOPdivNAME{} operation pops the top two stack values, divides the former second entry by
1497 the former top of the stack using signed division, and pushes the result.
1498
1499 \itembfnl{\DWOPminusTARG}
1500 The \DWOPminusNAME{} operation pops the top two stack values, subtracts the former top of the
1501 stack from the former second entry, and pushes the result.
1502
1503 \itembfnl{\DWOPmodTARG}
1504 The \DWOPmodNAME{} operation pops the top two stack values and pushes the result of the
1505 calculation: former second stack entry modulo the former top of the stack.
1506
1507 \needlines{4}
1508 \itembfnl{\DWOPmulTARG}
1509 The \DWOPmulNAME{} operation pops the top two stack entries, multiplies them together, and
1510 pushes the result.
1511
1512 \itembfnl{\DWOPnegTARG}
1513 The \DWOPnegNAME{} operation pops the top stack entry, interprets
1514 it as a signed value and pushes its negation. If the negation
1515 cannot be represented, the result is undefined.
1516
1517 \itembfnl{\DWOPnotTARG}
1518 The \DWOPnotNAME{} operation pops the top stack entry, and pushes
1519 its bitwise complement.
1520
1521 \itembfnl{\DWOPorTARG}
1522 The \DWOPorNAME{} operation pops the top two stack entries, performs
1523 a bitwise or operation on the two, and pushes the result.
1524
1525 \itembfnl{\DWOPplusTARG}
1526 The \DWOPplusNAME{} operation pops the top two stack entries,
1527 adds them together, and pushes the result.
1528
1529 \needlines{6}
1530 \itembfnl{\DWOPplusuconstTARG}
1531 The \DWOPplusuconstNAME{} operation pops the top stack entry,
1532 adds it to the unsigned LEB128\addtoindexx{LEB128!unsigned}
1533 constant operand and pushes the result.
1534
1535 \textit{This operation is supplied specifically to be
1536 able to encode more field offsets in two bytes than can be
1537 done with
1538 \doublequote{\DWOPlitn~\DWOPplus.}}
1539
1540 \needlines{3}
1541 \itembfnl{\DWOPshlTARG}
1542 The \DWOPshlNAME{} operation pops the top two stack entries,
1543 shifts the former second entry left (filling with zero bits)
1544 by the number of bits specified by the former top of the stack,
1545 and pushes the result.
1546
1547 \itembfnl{\DWOPshrTARG}
1548 The \DWOPshrNAME{} operation pops the top two stack entries,
1549 shifts the former second entry right logically (filling with
1550 zero bits) by the number of bits specified by the former top
1551 of the stack, and pushes the result.
1552
1553 \needlines{3}
1554 \itembfnl{\DWOPshraTARG}
1555 The \DWOPshraNAME{} operation pops the top two stack entries,
1556 shifts the former second entry right arithmetically (divide
1557 the magnitude by 2, keep the same sign for the result) by
1558 the number of bits specified by the former top of the stack,
1559 and pushes the result.
1560
1561 \itembfnl{\DWOPxorTARG}
1562 The \DWOPxorNAME{} operation pops the top two stack entries,
1563 performs a bitwise exclusive\dash or operation on the two, and
1564 pushes the result.
1565
1566 \end{enumerate}
1567
1568 \subsubsection{Control Flow Operations}
1569 \label{chap:controlflowoperations}
1570 The 
1571 \addtoindexx{DWARF expression!control flow operations}
1572 following operations provide simple control of the flow of a DWARF expression.
1573 \begin{enumerate}[1. ]
1574 \itembfnl{\DWOPleTARG, \DWOPgeTARG, \DWOPeqTARG, \DWOPltTARG, \DWOPgtTARG, \DWOPneTARG}
1575 The six relational operators each:
1576 \begin{itemize}
1577 \item pop the top two stack values, which should both have the same type,
1578 either the same base type or both the \specialaddresstype, 
1579
1580 \item compare the operands:
1581 \linebreak
1582 \textless~former second entry~\textgreater  \textless~relational operator~\textgreater \textless~former top entry~\textgreater
1583
1584 \item push the constant value 1 onto the stack 
1585 if the result of the operation is true or the
1586 constant value 0 if the result of the operation is false.
1587 The pushed value has the \specialaddresstype.
1588 \end{itemize}
1589
1590 If the operands have the \specialaddresstype, the comparisons  
1591 are performed as signed operations.
1592 The six operators are \DWOPleNAME{} (less than or equal to), \DWOPgeNAME{}
1593 (greater than or equal to), \DWOPeqNAME{} (equal to), \DWOPltNAME{} (less
1594 than), \DWOPgtNAME{} (greater than) and \DWOPneNAME{} (not equal to).
1595
1596 \needlines{6}
1597 \itembfnl{\DWOPskipTARG}
1598 \DWOPskipNAME{} is an unconditional branch. Its single operand
1599 is a 2-byte signed integer constant. The 2-byte constant is
1600 the number of bytes of the DWARF expression to skip forward
1601 or backward from the current operation, beginning after the
1602 2-byte constant.
1603
1604 \itembfnl{\DWOPbraTARG}
1605 \DWOPbraNAME{} is a conditional branch. Its single operand is a
1606 2-byte signed integer constant.  This operation pops the
1607 top of stack. If the value popped is not the constant 0,
1608 the 2-byte constant operand is the number of bytes of the
1609 DWARF expression to skip forward or backward from the current
1610 operation, beginning after the 2-byte constant.
1611
1612 % The following item does not correctly hyphenate leading
1613 % to an overfull hbox and a visible artifact. 
1614 % So we use \- to suggest hyphenation in this rare situation.
1615 \itembfnl{\DWOPcalltwoTARG, \DWOPcallfourTARG, \DWOPcallrefTARG}
1616 \DWOPcalltwoNAME, 
1617 \DWOPcallfourNAME, 
1618 and \DWOPcallrefNAME{} perform
1619 DWARF procedure calls during evaluation of a DWARF expression or
1620 location description. 
1621 For \DWOPcalltwoNAME{} and \DWOPcallfourNAME{}, 
1622 the operand is the 2\dash~ or 4-byte unsigned offset, respectively,
1623 of a debugging information entry in the current compilation
1624 unit. The \DWOPcallrefNAME{} operator has a single operand. In the
1625 \thirtytwobitdwarfformat,
1626 the operand is a 4-byte unsigned value;
1627 in the \sixtyfourbitdwarfformat, it is an 8-byte unsigned value
1628 (see Section \referfol{datarep:32bitand64bitdwarfformats}). 
1629 The operand is used as the offset of a
1630 debugging information entry in a 
1631 \dotdebuginfo{}
1632 section which may be contained in an executable or shared object file
1633 other than that containing the operator. For references from
1634 one executable or shared object file to another, the relocation
1635 must be performed by the consumer.  
1636
1637 \textit{Operand interpretation of
1638 \DWOPcalltwo, \DWOPcallfour{} and \DWOPcallref{} is exactly like
1639 that for \DWFORMreftwo, \DWFORMreffour{} and \DWFORMrefaddr,
1640 respectively  
1641 (see Section  \refersec{datarep:attributeencodings}).  
1642 }
1643
1644 These operations transfer
1645 control of DWARF expression evaluation to 
1646 \addtoindexx{location attribute}
1647 the 
1648 \DWATlocation{}
1649 attribute of the referenced debugging information entry. If
1650 there is no such attribute, then there is no effect. Execution
1651 of the DWARF expression of 
1652 \addtoindexx{location attribute}
1653
1654 \DWATlocation{} attribute may add
1655 to and/or remove from values on the stack. Execution returns
1656 to the point following the call when the end of the attribute
1657 is reached. Values on the stack at the time of the call may be
1658 used as parameters by the called expression and values left on
1659 the stack by the called expression may be used as return values
1660 by prior agreement between the calling and called expressions.
1661 \end{enumerate}
1662
1663 \subsubsection{Type Conversions}
1664 \label{chap:typeconversions}
1665 The following operations provides for explicit type conversion.
1666
1667 \begin{enumerate}[1. ]
1668 \itembfnl{\DWOPconvertTARG}
1669 The \DWOPconvertNAME{} operation pops the top stack entry, converts it to a
1670 different type, then pushes the result. It takes one operand, which is an
1671 unsigned LEB128 integer that represents the offset of a debugging
1672 information entry in the current compilation unit, or value 0 which
1673 represents the \specialaddresstype. If the operand is non-zero, the
1674 referenced entry must be a \DWTAGbasetype{} entry that provides the type
1675 to which the value is converted.
1676
1677 \itembfnl{\DWOPreinterpretTARG}
1678 The \DWOPreinterpretNAME{} operation pops the top stack entry, reinterprets
1679 the bits in its value as a value of a different type, then pushes the
1680 result. It takes one operand, which is an unsigned LEB128 integer that
1681 represents the offset of a debugging information entry in the current
1682 compilation unit, or value 0 which represents the \specialaddresstype.
1683 If the operand is non-zero, the referenced entry must be a
1684 \DWTAGbasetype{} entry that provides the type to which the value is converted.
1685 The type of the operand and result type should have the same size in bits.
1686
1687 \end{enumerate}
1688
1689 \needlines{7}
1690 \subsubsection{Special Operations}
1691 \label{chap:specialoperations}
1692 There 
1693 \addtoindexx{DWARF expression!special operations}
1694 are these special operations currently defined:
1695 \begin{enumerate}[1. ]
1696 \itembfnl{\DWOPnopNAME}
1697 The \DWOPnopTARG{} operation is a place holder. It has no effect
1698 on the location stack or any of its values.
1699
1700 \itembfnl{\DWOPentryvalueNAME}
1701 The \DWOPentryvalueTARG{} operation pushes a value that had a known location
1702 upon entering the current subprogram.  It has two operands: an 
1703 unsigned LEB128\addtoindexx{LEB128!unsigned} length, followed by 
1704 a block containing a DWARF expression or a register location description 
1705 (see Section \refersec{chap:registerlocationdescriptions}).  
1706 The length operand specifies the length
1707 in bytes of the block.  If the block contains a register location
1708 description, \DWOPentryvalueNAME{} pushes the value that register had upon
1709 entering the current subprogram.  If the block contains a DWARF expression,
1710 the DWARF expression is evaluated as if it has been evaluated upon entering
1711 the current subprogram.  The DWARF expression should not assume any values
1712 being present on the DWARF stack initially and should result in exactly one
1713 value being pushed on the DWARF stack when completed.  That value is the value
1714 being pushed by the \DWOPentryvalueNAME{} operation.  
1715
1716 \DWOPpushobjectaddress{} is not meaningful inside of this DWARF operation.
1717
1718 \textit{The \DWOPentryvalueNAME{} operation can be used by consumers if they are able
1719 to find the call site in the caller function, can unwind to it, and the corresponding
1720 \DWTAGcallsiteparameter{} entry has \DWATcallvalue{} or
1721 \DWATcalldatavalue{} attributes that can be evaluated to find the
1722 value a function parameter had on the first instruction in the function.
1723 Non-interactive consumers which know what variables will need to be
1724 inspected in advance of running the debugged program could put breakpoints
1725 on the first instruction in functions where there is no way to find
1726 some variable's value other than by evaluating the \DWOPentryvalueNAME{} 
1727 operation.  The consumer can collect the value of registers or 
1728 memory referenced in
1729 \DWOPentryvalueNAME{} operations, then continue to breakpoints where the values
1730 of variables or parameters need to be inspected and use the remembered
1731 register or memory values during \DWOPentryvalueNAME{} evaluation.}
1732
1733 \end{enumerate}
1734
1735 \needlines{5}
1736 \section{Location Descriptions}
1737 \label{chap:locationdescriptions}
1738 \textit{Debugging information 
1739 \addtoindexx{location description}
1740 must 
1741 \addtoindexx{location description|see{\textit{also} DWARF expression}}
1742 provide consumers a way to find
1743 the location of program variables, determine the bounds
1744 of dynamic arrays and strings, and possibly to find the
1745 base address of a subroutine\textquoteright s stack frame or the return
1746 address of a subroutine. Furthermore, to meet the needs of
1747 recent computer architectures and optimization techniques,
1748 debugging information must be able to describe the location of
1749 an object whose location changes over the object\textquoteright s lifetime.}
1750
1751 Information about the location of program objects is provided
1752 by location descriptions. Location descriptions can be either
1753 of two forms:
1754 \begin{enumerate}[1. ]
1755 \item \textit{Single location descriptions}, 
1756 which 
1757 \addtoindexx{location description!single}
1758 are 
1759 \addtoindexx{single location description}
1760 a language independent representation of
1761 addressing rules of arbitrary complexity built from 
1762 DWARF expressions (See Section \refersec{chap:dwarfexpressions}) 
1763 and/or other
1764 DWARF operations specific to describing locations. They are
1765 sufficient for describing the location of any object as long
1766 as its lifetime is either static or the same as the 
1767 \livelink{chap:lexicalblock}{lexical block} that owns it, 
1768 and it does not move during its lifetime.
1769
1770 Single location descriptions are of two kinds:
1771 \begin{enumerate}[a) ]
1772 \item Simple location descriptions, which describe the location
1773 \addtoindexx{location description!simple}
1774 of one contiguous piece (usually all) of an object. A simple
1775 location description may describe a location in addressable
1776 memory, or in a register, or the lack of a location (with or
1777 without a known value).
1778
1779 \item  Composite location descriptions, which describe an
1780 \addtoindexx{location description!composite}
1781 object in terms of pieces each of which may be contained in
1782 part of a register or stored in a memory location unrelated
1783 to other pieces.
1784
1785 \end{enumerate}
1786
1787 \needlines{4}
1788 \item \textit{Location lists}, which are used to 
1789 \addtoindexx{location list}
1790 describe
1791 \addtoindexx{location description!use in location list}
1792 objects that have a limited lifetime or change their location
1793 during their lifetime. Location lists are described in
1794 Section \refersec{chap:locationlists} below.
1795
1796 \end{enumerate}
1797
1798 Location descriptions are distinguished in a context sensitive
1799 manner. As the value of an attribute, a location description
1800 is encoded using 
1801 \addtoindexx{exprloc class}
1802 class \livelink{chap:classexprloc}{exprloc}  
1803 and a location list is encoded
1804 using class \livelink{chap:classloclistptr}{loclistptr}
1805 (which 
1806 \addtoindex{loclistptr}
1807 serves as an offset into a
1808 separate 
1809 \addtoindexx{location list}
1810 location list table).
1811
1812 \needlines{8}
1813 \subsection{Single Location Descriptions}
1814 A single location description is either:
1815 \begin{enumerate}[1. ]
1816 \item A simple location description, representing an object
1817 \addtoindexx{location description!simple}
1818 which 
1819 \addtoindexx{simple location description}
1820 exists in one contiguous piece at the given location, or 
1821 \item A composite location description consisting of one or more
1822 \addtoindexx{location description!composite}
1823 simple location descriptions, each of which is followed by
1824 one composition operation. Each simple location description
1825 describes the location of one piece of the object; each
1826 composition operation describes which part of the object is
1827 located there. Each simple location description that is a
1828 DWARF expression is evaluated independently of any others
1829 (as though on its own separate stack, if any). 
1830 \end{enumerate}
1831
1832
1833
1834 \subsubsection{Simple Location Descriptions}
1835
1836 \addtoindexx{location description!simple}
1837 simple location description consists of one 
1838 contiguous piece or all of an object or value.
1839
1840
1841 \subsubsubsection{Memory Location Descriptions}
1842
1843 \addtoindexx{location description!memory}
1844 memory location description 
1845 \addtoindexx{memory location description}
1846 consists of a non\dash empty DWARF
1847 expression (see 
1848 Section \refersec{chap:dwarfexpressions}
1849 ), whose value is the address of
1850 a piece or all of an object or other entity in memory.
1851
1852 \subsubsubsection{Register Location Descriptions}
1853 \label{chap:registerlocationdescriptions}
1854 A register location description consists of a register name
1855 operation, which represents a piece or all of an object
1856 located in a given register.
1857
1858 \textit{Register location descriptions describe an object
1859 (or a piece of an object) that resides in a register, while
1860 the opcodes listed in 
1861 Section \refersec{chap:registervalues}
1862 are used to describe an object (or a piece of
1863 an object) that is located in memory at an address that is
1864 contained in a register (possibly offset by some constant). A
1865 register location description must stand alone as the entire
1866 description of an object or a piece of an object.
1867 }
1868
1869 The following DWARF operations can be used to name a register.
1870
1871
1872 \textit{Note that the register number represents a DWARF specific
1873 mapping of numbers onto the actual registers of a given
1874 architecture. The mapping should be chosen to gain optimal
1875 density and should be shared by all users of a given
1876 architecture. It is recommended that this mapping be defined
1877 by the ABI authoring committee for each architecture.
1878 }
1879 \begin{enumerate}[1. ]
1880 \itembfnl{\DWOPregzeroTARG, \DWOPregoneTARG, ..., \DWOPregthirtyoneTARG}
1881 The \DWOPregnTARG{} operations encode the names of up to 32
1882 registers, numbered from 0 through 31, inclusive. The object
1883 addressed is in register \textit{n}.
1884
1885 \needlines{4}
1886 \itembfnl{\DWOPregxTARG}
1887 The \DWOPregxNAME{} operation has a single 
1888 unsigned LEB128\addtoindexx{LEB128!unsigned} literal
1889 operand that encodes the name of a register.  
1890
1891 \end{enumerate}
1892
1893 \textit{These operations name a register location. To
1894 fetch the contents of a register, it is necessary to use
1895 one of the register based addressing operations, such as
1896 \DWOPbregx{} 
1897 (Section \refersec{chap:registervalues})}.
1898
1899 \subsubsubsection{Implicit Location Descriptions}
1900 An \addtoindex{implicit location description}
1901 represents a piece or all
1902 \addtoindexx{location description!implicit}
1903 of an object which has no actual location but whose contents
1904 are nonetheless either known or known to be undefined.
1905
1906 The following DWARF operations may be used to specify a value
1907 that has no location in the program but is a known constant
1908 or is computed from other locations and values in the program.
1909 \begin{enumerate}[1. ]
1910 \itembfnl{\DWOPimplicitvalueTARG}
1911 The \DWOPimplicitvalueNAME{} 
1912 operation specifies an immediate value
1913 using two operands: an unsigned LEB128\addtoindexx{LEB128!unsigned}
1914 length, followed by
1915 %FIXME: should this block be a reference? To what?
1916 a \nolink{block} representing the value in the memory representation
1917 of the target machine. The length operand gives the length
1918 in bytes of the \nolink{block}.
1919
1920 \itembfnl{\DWOPstackvalueTARG}
1921 The \DWOPstackvalueNAME{} 
1922 operation specifies that the object
1923 does not exist in memory but its value is nonetheless known
1924 and is at the top of the DWARF expression stack. In this form
1925 of location description, the DWARF expression represents the
1926 actual value of the object, rather than its location. The
1927 \DWOPstackvalueNAME{} operation terminates the expression.
1928
1929 \needlines{4}
1930 \itembfnl{\DWOPimplicitpointerTARG}
1931 The \DWOPimplicitpointerNAME{} operation specifies that the object
1932 is a pointer that cannot be represented as a real pointer,
1933 even though the value it would point to can be described. In
1934 this form of location description, the DWARF expression refers
1935 to a debugging information entry that represents the actual
1936 value of the object to which the pointer would point. Thus, a
1937 consumer of the debug information would be able to show the
1938 value of the dereferenced pointer, even when it cannot show
1939 the value of the pointer itself.
1940
1941 \needlines{5}
1942 The \DWOPimplicitpointerNAME{} operation has two operands: a 
1943 reference to a debugging information entry that describes 
1944 the dereferenced object's value, and a signed number that 
1945 is treated as a byte offset from the start of that value. 
1946 The first operand is a 4-byte unsigned value in the 32-bit 
1947 DWARF format, or an 8-byte unsigned value in the 64-bit 
1948 DWARF format (see Section 
1949 \refersec{datarep:32bitand64bitdwarfformats}).
1950 The second operand is a 
1951 signed LEB128\addtoindexx{LEB128!signed} number.
1952
1953 The first operand is used as the offset of a debugging
1954 information entry in a \dotdebuginfo{} section, which may be
1955 contained in an executable or shared object file other than that
1956 containing the operator. For references from one executable or
1957 shared object file to another, the relocation must be performed 
1958 by the consumer.
1959
1960 \textit{The debugging information entry referenced by a 
1961 \DWOPimplicitpointerNAME{} operation is typically a
1962 \DWTAGvariable{} or \DWTAGformalparameter{} entry whose
1963 \DWATlocation{} attribute gives a second DWARF expression or a
1964 location list that describes the value of the object, but the
1965 referenced entry may be any entry that contains a \DWATlocation{}
1966 or \DWATconstvalue{} attribute (for example, \DWTAGdwarfprocedure).
1967 By using the second DWARF expression, a consumer can
1968 reconstruct the value of the object when asked to dereference
1969 the pointer described by the original DWARF expression
1970 containing the \DWOPimplicitpointer{} operation.}
1971
1972 \end{enumerate}
1973
1974 \textit{DWARF location expressions are intended to yield the \textbf{location}
1975 of a value rather than the value itself. An optimizing compiler
1976 may perform a number of code transformations where it becomes
1977 impossible to give a location for a value, but it remains possible
1978 to describe the value itself. 
1979 Section \refersec{chap:registerlocationdescriptions}
1980 describes operators that can be used to
1981 describe the location of a value when that value exists in a
1982 register but not in memory. The operations in this section are
1983 used to describe values that exist neither in memory nor in a
1984 single register.}
1985
1986 \needlines{4}
1987 \subsubsubsection{Empty Location Descriptions}
1988 An \addtoindex{empty location description}
1989 consists of a DWARF expression
1990 \addtoindexx{location description!empty}
1991 containing no operations. It represents a piece or all of an
1992 object that is present in the source but not in the object code
1993 (perhaps due to optimization).
1994
1995 \needlines{6}
1996 \subsubsection{Composite Location Descriptions}
1997 A composite location description describes an object or
1998 value which may be contained in part of a register or stored
1999 in more than one location. Each piece is described by a
2000 composition operation, which does not compute a value nor
2001 store any result on the DWARF stack. There may be one or
2002 more composition operations in a single composite location
2003 description. A series of such operations describes the parts
2004 of a value in memory address order.
2005
2006 Each composition operation is immediately preceded by a simple
2007 location description which describes the location where part
2008 of the resultant value is contained.
2009 \begin{enumerate}[1. ]
2010 \itembfnl{\DWOPpieceTARG}
2011 The \DWOPpieceNAME{} operation takes a 
2012 single operand, which is an
2013 unsigned LEB128\addtoindexx{LEB128!unsigned} number.  
2014 The number describes the size in bytes
2015 of the piece of the object referenced by the preceding simple
2016 location description. If the piece is located in a register,
2017 but does not occupy the entire register, the placement of
2018 the piece within that register is defined by the ABI.
2019
2020 \textit{Many compilers store a single variable in sets of registers,
2021 or store a variable partially in memory and partially in
2022 registers. \DWOPpieceNAME{} provides a way of describing how large
2023 a part of a variable a particular DWARF location description
2024 refers to. }
2025
2026 \itembfnl{\DWOPbitpieceTARG}
2027 The \DWOPbitpieceNAME{} 
2028 operation takes two operands. The first
2029 is an unsigned LEB128\addtoindexx{LEB128!unsigned} 
2030 number that gives the size in bits
2031 of the piece. The second is an 
2032 unsigned LEB128\addtoindexx{LEB128!unsigned} number that
2033 gives the offset in bits from the location defined by the
2034 preceding DWARF location description.  
2035
2036 Interpretation of the
2037 offset depends on the kind of location description. If the
2038 location description is empty, the offset doesn\textquoteright t matter and
2039 the \DWOPbitpieceNAME{} operation describes a piece consisting
2040 of the given number of bits whose values are undefined. If
2041 the location is a register, the offset is from the least
2042 significant bit end of the register. If the location is a
2043 memory address, the \DWOPbitpieceNAME{} operation describes a
2044 sequence of bits relative to the location whose address is
2045 on the top of the DWARF stack using the bit numbering and
2046 direction conventions that are appropriate to the current
2047 language on the target system. If the location is any implicit
2048 value or stack value, the \DWOPbitpieceNAME{} operation describes
2049 a sequence of bits using the least significant bits of that
2050 value.  
2051 \end{enumerate}
2052
2053 \textit{\DWOPbitpieceNAME{} is 
2054 used instead of \DWOPpieceNAME{} when
2055 the piece to be assembled into a value or assigned to is not
2056 byte-sized or is not at the start of a register or addressable
2057 unit of memory.}
2058
2059 \needlines{6}
2060 \subsection{Location Lists}
2061 \label{chap:locationlists}
2062 There are two forms of location lists. The first form 
2063 is intended for use in other than a \splitDWARFobjectfile,
2064 while the second is intended for use in a \splitDWARFobjectfile{} 
2065 (see Section \refersec{datarep:splitdwarfobjectfiles}). The two
2066 forms are otherwise equivalent.
2067
2068 \textit{The form for \splitDWARFobjectfile{s} is new in \DWARFVersionV.}
2069
2070 \subsubsection{Location Lists in Non-split Objects}
2071 \label{chap:locationlistsinnonsplitobjects}
2072 Location lists 
2073 \addtoindexx{location list}
2074 are used in place of location expressions
2075 whenever the object whose location is being described
2076 can change location during its lifetime. 
2077 Location lists
2078 \addtoindexx{location list}
2079 are contained in a separate object file section called
2080 \dotdebugloc{}. A location list is indicated by a location
2081 attribute whose value is an offset from the beginning of
2082 the \dotdebugloc{} section to the first byte of the list for the
2083 object in question.
2084
2085 The \addtoindex{applicable base address} of a normal
2086 location list entry (see following) is
2087 \addtoindexx{location list!base address selection entry}
2088 determined by the closest preceding base address selection
2089 entry in the same location list. If there is
2090 no such selection entry, then the applicable base address
2091 defaults to the base address of the compilation unit (see
2092 Section \refersec{chap:fullandpartialcompilationunitentries}).  
2093
2094 \textit{In the case of a compilation unit where all of
2095 the machine code is contained in a single contiguous section,
2096 no base address selection entry is needed.}
2097
2098 Each entry in a location list is either a location 
2099 \addtoindexi{list}{address selection|see{base address selection}} 
2100 entry,
2101
2102 \addtoindexi{base}{base address selection entry!in location list} 
2103 address selection entry, 
2104 \addtoindexx{location list!base address selection entry}
2105 or an 
2106 \addtoindexx{end-of-list entry!in location list}
2107 end-of-list entry.
2108
2109 \subsubsubsection{Location List Entry}
2110 A location list entry has two forms:
2111 a normal location list entry and a default location list entry.
2112
2113 \needlines{4}
2114 \subsubsubsubsection{Normal Location List Entry}
2115 A\addtoindexx{location list!normal entry}
2116 \addtoindex{normal location list entry} consists of:
2117 \begin{enumerate}[1. ]
2118 \item A beginning address offset. 
2119 This address offset has the \addtoindex{size of an address} and is
2120 relative to the applicable base address of the compilation
2121 unit referencing this location list. It marks the beginning
2122 of the address 
2123 \addtoindexi{range}{address range!in location list} 
2124 over which the location is valid.
2125
2126 \item An ending address offset.  This address offset again
2127 has the \addtoindex{size of an address} and is relative to the applicable
2128 base address of the compilation unit referencing this location
2129 list. It marks the first address past the end of the address
2130 range over which the location is valid. The ending address
2131 must be greater than or equal to the beginning address.
2132
2133 \textit{A location list entry (but not a base address selection or 
2134 end-of-list entry) whose beginning
2135 and ending addresses are equal has no effect 
2136 because the size of the range covered by such
2137 an entry is zero.}
2138
2139 \item An unsigned 2-byte length describing the length of the location 
2140 description that follows.
2141
2142 \item A \addtoindex{single location description} 
2143 describing the location of the object over the range specified by
2144 the beginning and end addresses.
2145 \end{enumerate}
2146
2147 Address ranges defined by normal location list entries
2148 may overlap. When they do, they describe a
2149 situation in which an object exists simultaneously in more than
2150 one place. If all of the address ranges in a given location
2151 list do not collectively cover the entire range over which the
2152 object in question is defined, it is assumed that the object is
2153 not available for the portion of the range that is not covered.
2154
2155 \needlines{4}
2156 \subsubsubsubsection{Default Location List Entry}
2157 A \addtoindex{default location list entry} consists of:
2158 \addtoindexx{location list!default entry}
2159 \begin{enumerate}[1. ]
2160 \item The value 0.
2161 \item The value of the largest representable address offset (for
2162       example, \wffffffff when the size of an address is 32 bits).
2163 \item A simple location description describing the location of the
2164       object when there is no prior normal location list entry
2165       that applies in the same location list.
2166 \end{enumerate}
2167
2168 A default location list entry is independent of any applicable
2169 base address (except to the extent to which base addresses
2170 affect prior normal location list entries).
2171
2172 A default location list entry must be the last location list
2173 entry of a location list except for the terminating end-of-list
2174 entry.
2175
2176 A \addtoindex{default location list entry} describes a simple 
2177 location which applies to all addresses which are not included 
2178 in any range defined earlier in the same location list.
2179
2180 \needlines{5}
2181 \subsubsubsection{Base Address Selection Entry}
2182 A base 
2183 \addtoindexi{address}{address selection|see{base address selection}}
2184 \addtoindexx{location list!base address selection entry}
2185 selection 
2186 \addtoindexi{entry}{base address selection entry!in location list}
2187 consists of:
2188 \begin{enumerate}[1. ]
2189 \item The value of the largest representable 
2190 address offset (for example, \wffffffff when the size of
2191 an address is 32 bits).
2192 \item An address, which defines the 
2193 appropriate base address for use in interpreting the beginning
2194 and ending address offsets of subsequent entries of the location list.
2195 \end{enumerate}
2196
2197 \textit{A base address selection entry 
2198 affects only the remainder of the list in which it is contained.}
2199
2200 \needlines{5}
2201 \subsubsubsection{End-of-List Entry}
2202 The end of any given location list is marked by an 
2203 \addtoindexx{location list!end-of-list entry}
2204 end-of-list entry, which consists of a 0 for the beginning address
2205 offset and a 0 for the ending address offset. A location list
2206 containing only an 
2207 \addtoindexx{end-of-list entry!in location list}
2208 end-of-list entry describes an object that
2209 exists in the source code but not in the executable program.
2210
2211 Neither a base address selection entry nor an end-of-list
2212 entry includes a location description.
2213
2214 \needlines{4}
2215 \textit{When a DWARF consumer is parsing and decoding a location
2216 list, it must recognize the beginning and ending address
2217 offsets of (0, 0) for an end-of-list entry and 
2218 \mbox{(0, \texttt{maximum-address})} for
2219 a default location list entry prior to applying any base
2220 address. Any other pair of offsets beginning with 0 is a
2221 valid normal location list entry. Next, it must recognize the
2222 beginning address offset of \texttt{maximum-address} for a base address selection
2223 entry prior to applying any base address. The current base
2224 address is not applied to the subsequent value (although there
2225 may be an underlying object language relocation that affects
2226 that value).}
2227
2228 \textit{A base address selection entry and an end-of-list
2229 entry for a location list are identical to a base address
2230 selection entry and end-of-list entry, respectively, for a
2231 \addtoindex{range list}
2232 (see Section \refersec{chap:noncontiguousaddressranges}) 
2233 in interpretation and representation.}
2234
2235 \needlines{5}
2236 \subsubsection{Location Lists in Split Object Files}
2237 \label{chap:locationlistsinsplitobjectfiles}
2238 In a \splitDWARFobjectfile{} (see 
2239 Section \refersec{datarep:splitdwarfobjectfiles}), 
2240 location lists are contained in the \dotdebuglocdwo{} section.
2241
2242 The \addtoindex{applicable base address} of a split
2243 location list entry (see following) is
2244 \addtoindexx{location list!base address selection entry}
2245 determined by the closest preceding base address selection
2246 entry (\DWLLEbaseaddressselectionentry) in the same location list. If there is
2247 no such selection entry, then the applicable base address
2248 defaults to the base address of the compilation unit (see
2249 Section \refersec{chap:normalandpartialcompilationunitentries}).
2250
2251 Each entry in the split location list
2252 begins with a type code, which is a single unsigned byte that
2253 identifies the type of entry. There are five types of entries:
2254 \begin{enumerate}
2255 \itembfnl{\DWLLEendoflistentryTARG}
2256 This entry indicates the end of a location list, and
2257 contains no further data.
2258
2259 \needlines{6}
2260 \itembfnl{\DWLLEbaseaddressselectionentryTARG}
2261 This entry contains an 
2262 unsigned LEB128\addtoindexx{LEB128!unsigned} value immediately
2263 following the type code. This value is the index of an
2264 address in the \dotdebugaddr{} section, which is then used as
2265 the base address when interpreting offsets in subsequent
2266 location list entries of type \DWLLEoffsetpairentry.
2267 This index is relative to the value of the 
2268 \DWATaddrbase{} attribute of the associated compilation unit.
2269
2270 \itembfnl{\DWLLEstartendentryTARG}
2271 This entry contains two unsigned LEB128\addtoindexx{LEB128!unsigned}
2272 values immediately following the type code. These values are the
2273 indices of two addresses in the \dotdebugaddr{} section.
2274 These indices are relative to the value of the 
2275 \DWATaddrbase{} attribute of the associated compilation unit
2276 (see Section \refersec{chap:unitentries}).
2277 These indicate the starting and ending addresses,
2278 respectively, that define the address range for which
2279 this location is valid. The starting and ending addresses
2280 given by this type of entry are not relative to the
2281 compilation unit base address. A single location
2282 description follows the fields that define the address range.
2283
2284 \itembfnl{\DWLLEstartlengthentryTARG}
2285 This entry contains one unsigned LEB128\addtoindexx{LEB128!unsigned}
2286 value and a 4-byte
2287 unsigned value immediately following the type code. The
2288 first value is the index of an address in the \dotdebugaddr{}
2289 section, which marks the beginning of the address range
2290 over which the location is valid.
2291 This index is relative to the value of the 
2292 \DWATaddrbase{} attribute of the associated compilation unit.
2293 The starting address given by this
2294 type of entry is not relative to the compilation unit
2295 base address. The second value is the
2296 length of the range. A single location
2297 description follows the fields that define the address range.
2298
2299 \itembfnl{\DWLLEoffsetpairentryTARG}
2300 This entry contains two 4-byte unsigned values
2301 immediately following the type code. These values are the
2302 starting and ending offsets, respectively, relative to
2303 the applicable base address, that define the address
2304 range for which this location is valid. A single location
2305 description follows the fields that define the address range.
2306 \end{enumerate}
2307
2308 \textit{The \DWLLEbaseaddressselectionentry, \DWLLEstartendentry{}
2309 and \DWLLEstartlengthentry entries obtain addresses within the 
2310 target program indirectly using an index (not an offset) into an 
2311 array of addresses. The base of that array is obtained using the 
2312 \DWATaddrbase{} attribute of the containing compilation unit. 
2313 The value of that attribute is the offset of the base of the array 
2314 in the \dotdebugaddr{} section of the unit.}
2315
2316 \needlines{10}
2317 \section{Types of Program Entities}
2318 \label{chap:typesofprogramentities}
2319 \hypertarget{chap:DWATtypetypeofdeclaration}{}
2320 Any debugging information entry describing a declaration that
2321 has a type has 
2322 \addtoindexx{type attribute}
2323 a \DWATtypeDEFN{} attribute, whose value is a
2324 reference to another debugging information entry. The entry
2325 referenced may describe a base type, that is, a type that is
2326 not defined in terms of other data types, or it may describe a
2327 user-defined type, such as an array, structure or enumeration.
2328 Alternatively, the entry referenced may describe a type
2329 modifier, such as constant, packed, pointer, reference or
2330 volatile, which in turn will reference another entry describing
2331 a type or type modifier (using 
2332 \addtoindexx{type attribute}
2333 a \DWATtypeNAME{} attribute of its
2334 own). See 
2335 Section  \referfol{chap:typeentries} 
2336 for descriptions of the entries describing
2337 base types, user-defined types and type modifiers.
2338
2339
2340 \needlines{6}
2341 \section{Accessibility of Declarations}
2342 \label{chap:accessibilityofdeclarations}
2343 \textit{Some languages, notably \addtoindex{C++} and 
2344 \addtoindex{Ada}, have the concept of
2345 the accessibility of an object or of some other program
2346 entity. The accessibility specifies which classes of other
2347 program objects are permitted access to the object in question.}
2348
2349 The accessibility of a declaration is 
2350 \hypertarget{chap:DWATaccessibilitycandadadeclarations}{}
2351 represented by a 
2352 \DWATaccessibilityDEFN{} 
2353 attribute, whose
2354 \addtoindexx{accessibility attribute}
2355 value is a constant drawn from the set of codes listed in Table 
2356 \refersec{tab:accessibilitycodes}.
2357
2358 \begin{simplenametable}[1.9in]{Accessibility codes}{tab:accessibilitycodes}
2359 \DWACCESSpublicTARG{}          \\
2360 \DWACCESSprivateTARG{}        \\
2361 \DWACCESSprotectedTARG{}    \\
2362 \end{simplenametable}
2363
2364 \needlines{5}
2365 \section{Visibility of Declarations}
2366 \label{chap:visibilityofdeclarations}
2367
2368 \textit{Several languages (such as \addtoindex{Modula-2}) 
2369 have the concept of the visibility of a declaration. The
2370 visibility specifies which declarations are to be 
2371 visible outside of the entity in which they are
2372 declared.}
2373
2374 The 
2375 \hypertarget{chap:DWATvisibilityvisibilityofdeclaration}{}
2376 visibility of a declaration is represented 
2377 by a \DWATvisibilityDEFN{}
2378 attribute\addtoindexx{visibility attribute}, whose value is a
2379 constant drawn from the set of codes listed in 
2380 Table \refersec{tab:visibilitycodes}.
2381
2382 \begin{simplenametable}[1.5in]{Visibility codes}{tab:visibilitycodes}
2383 \DWVISlocalTARG{}          \\
2384 \DWVISexportedTARG{}    \\
2385 \DWVISqualifiedTARG{}  \\
2386 \end{simplenametable}
2387
2388 \needlines{8}
2389 \section{Virtuality of Declarations}
2390 \label{chap:virtualityofdeclarations}
2391 \textit{\addtoindex{C++} provides for virtual and pure virtual structure or class
2392 member functions and for virtual base classes.}
2393
2394 The 
2395 \hypertarget{chap:DWATvirtualityvirtualityindication}{}
2396 virtuality of a declaration is represented by a
2397 \DWATvirtualityDEFN{}
2398 attribute\addtoindexx{virtuality attribute}, whose value is a constant drawn
2399 from the set of codes listed in 
2400 Table \refersec{tab:virtualitycodes}.
2401
2402 \begin{simplenametable}[2.5in]{Virtuality codes}{tab:virtualitycodes}
2403 \DWVIRTUALITYnoneTARG{}                      \\
2404 \DWVIRTUALITYvirtualTARG{}                \\
2405 \DWVIRTUALITYpurevirtualTARG{}    \\
2406 \end{simplenametable}
2407
2408 \needlines{8}
2409 \section{Artificial Entries}
2410 \label{chap:artificialentries}
2411 \textit{A compiler may wish to generate debugging information entries
2412 for objects or types that were not actually declared in the
2413 source of the application. An example is a formal parameter
2414 %FIXME: The word 'this' should be rendered like a variant italic,
2415 %FIXME: not as a quoted name. Changed to tt font--RB
2416 entry to represent the hidden 
2417 \texttt{this} parameter\index{this parameter@\texttt{this} parameter}
2418 that most \addtoindex{C++} implementations pass as the first argument 
2419 to non-static member functions.}  
2420
2421 Any debugging information entry representing the
2422 \addtoindexx{artificial attribute}
2423 declaration of an object or type artificially generated by
2424 a compiler and not explicitly declared by the source program
2425 \hypertarget{chap:DWATartificialobjectsortypesthat}{}
2426 may have a 
2427 \DWATartificialDEFN{} attribute, 
2428 which is a \livelink{chap:classflag}{flag}.
2429
2430 \needlines{6}
2431 \section{Segmented Addresses}
2432 \label{chap:segmentedaddresses}
2433 \textit{In some systems, addresses are specified as offsets within a
2434 given 
2435 \addtoindexx{address space!segmented}
2436 segment 
2437 \addtoindexx{segmented addressing|see{address space}}
2438 rather than as locations within a single flat
2439 \addtoindexx{address space!flat}
2440 address space.}
2441
2442 Any debugging information entry that contains a description
2443 \hypertarget{chap:DWATsegmentaddressinginformation}{}
2444 of the location of an object or subroutine may have a 
2445 \DWATsegmentDEFN{} attribute, 
2446 \addtoindexx{segment attribute}
2447 whose value is a location
2448 description. The description evaluates to the segment selector
2449 of the item being described. If the entry containing the
2450 \DWATsegmentNAME{} attribute has a 
2451 \DWATlowpc, 
2452 \DWAThighpc,
2453 \DWATranges{} or 
2454 \DWATentrypc{} attribute, 
2455 \addtoindexx{entry PC attribute}
2456 or 
2457 a location
2458 description that evaluates to an address, then those address
2459 values represent the offset portion of the address within
2460 the segment specified 
2461 \addtoindexx{segment attribute}
2462 by \DWATsegmentNAME.
2463
2464 If an entry has no 
2465 \DWATsegmentNAME{} attribute, it inherits
2466 \addtoindexx{segment attribute}
2467 the segment value from its parent entry.  If none of the
2468 entries in the chain of parents for this entry back to
2469 its containing compilation unit entry have 
2470 \DWATsegmentNAME{} attributes, 
2471 then the entry is assumed to exist within a flat
2472 address space. 
2473 Similarly, if the entry has a 
2474 \DWATsegmentNAME{} attribute 
2475 \addtoindexx{segment attribute}
2476 containing an empty location description, that
2477 entry is assumed to exist within a 
2478 \addtoindexi{flat}{address space!flat}
2479 address space.
2480
2481 \textit{Some systems support different 
2482 classes of addresses\addtoindexx{address class}. 
2483 The address class may affect the way a pointer is dereferenced
2484 or the way a subroutine is called.}
2485
2486
2487 Any debugging information entry representing a pointer or
2488 reference type or a subroutine or subroutine type may 
2489 have a 
2490 \DWATaddressclass{}
2491 attribute, whose value is an integer
2492 constant.  The set of permissible values is specific to
2493 each target architecture. The value \DWADDRnoneTARG, 
2494 however,
2495 is common to all encodings, and means that no address class
2496 has been specified.
2497
2498 \needlines{4}
2499 \textit {For example, the Intel386 \texttrademark\  processor might use the following values:}
2500
2501 \begin{table}[h]
2502 \caption{Example address class codes}
2503 \label{tab:inteladdressclasstable}
2504 \centering
2505 \begin{tabular}{l|c|l}
2506 \hline
2507 Name&Value&Meaning  \\
2508 \hline
2509 \textit{DW\_ADDR\_none}&   0 & \textit{no class specified} \\
2510 \textit{DW\_ADDR\_near16}& 1 & \textit{16-bit offset, no segment} \\
2511 \textit{DW\_ADDR\_far16}&  2 & \textit{16-bit offset, 16-bit segment} \\
2512 \textit{DW\_ADDR\_huge16}& 3 & \textit{16-bit offset, 16-bit segment} \\
2513 \textit{DW\_ADDR\_near32}& 4 & \textit{32-bit offset, no segment} \\
2514 \textit{DW\_ADDR\_far32}&  5 & \textit{32-bit offset, 16-bit segment} \\
2515 \hline
2516 \end{tabular}
2517 \end{table}
2518
2519 \needlines{6}
2520 \section{Non-Defining Declarations and Completions}
2521 \label{nondefiningdeclarationsandcompletions}
2522 A debugging information entry representing a program entity
2523 typically represents the defining declaration of that
2524 entity. In certain contexts, however, a debugger might need
2525 information about a declaration of an entity that is not
2526 \addtoindexx{incomplete declaration}
2527 also a definition, or is otherwise incomplete, to evaluate
2528 \hypertarget{chap:DWATdeclarationincompletenondefiningorseparateentitydeclaration}{}
2529 an expression correctly.
2530
2531 \needlines{10}
2532 \textit{As an example, consider the following fragment of \addtoindex{C} code:}
2533
2534 \begin{lstlisting}
2535 void myfunc()
2536 {
2537   int x;
2538   {
2539     extern float x;
2540     g(x);
2541   }
2542 }
2543 \end{lstlisting}
2544
2545
2546 \textit{\addtoindex{C} scoping rules require that the 
2547 value of the variable \texttt{x} passed to the function 
2548 \texttt{g} is the value of the global \texttt{float} 
2549 variable \texttt{x} rather than of the local \texttt{int} 
2550 variable \texttt{x}.}
2551
2552 \subsection{Non-Defining Declarations}
2553 A debugging information entry that 
2554 represents a non-defining 
2555 \addtoindexx{non-defining declaration}
2556 or otherwise 
2557 \addtoindex{incomplete declaration}
2558 of a program entity has a
2559 \addtoindexx{declaration attribute}
2560 \DWATdeclarationDEFN{} attribute, which is a 
2561 \livelink{chap:classflag}{flag}.
2562
2563 \subsection{Declarations Completing Non-Defining Declarations}
2564 A debugging information entry that represents a 
2565 declaration\hypertarget{chap:DWATspecificationincompletenondefiningorseparatedeclaration}{}
2566 that completes another (earlier) non-defining declaration may have a 
2567 \DWATspecificationDEFN{}
2568 attribute whose value is a \livelink{chap:classreference}{reference} to
2569 the debugging information entry representing the non-defining declaration. 
2570 A debugging information entry with a 
2571 \DWATspecificationNAME{} 
2572 attribute does not need to duplicate information provided by the 
2573 debugging information entry referenced by that specification attribute.
2574
2575 When the non-defining declaration is contained within a type that has
2576 been placed in a separate type unit (see Section \refersec{chap:typeunitentries}), 
2577 the \DWATspecification{} attribute cannot refer directly to the entry in
2578 the type unit. Instead, the current compilation unit may contain a
2579 \doublequote{skeleton} declaration of the type, which contains only the relevant
2580 declaration and its ancestors as necessary to provide the context
2581 (including containing types and namespaces). The \DWATspecification{}
2582 attribute would then be a reference to the declaration entry within
2583 the skeleton declaration tree. The debugging information entry for the
2584 top-level type in the skeleton tree may contain a \DWATsignature{}
2585 attribute whose value is the type signature 
2586 (see Section \refersec{datarep:typesignaturecomputation}).
2587
2588
2589 Not all attributes of the debugging information entry referenced by a
2590 \DWATspecification{} attribute 
2591 apply to the referring debugging information entry.
2592 For\addtoindexx{declaration attribute}
2593 example,
2594 \DWATsibling{} and 
2595 \DWATdeclaration{} 
2596 \addtoindexx{declaration attribute}
2597 cannot apply to a 
2598 \addtoindexx{declaration attribute}
2599 referring
2600 \addtoindexx{sibling attribute}
2601 entry.
2602
2603
2604 \section{Declaration Coordinates}
2605 \label{chap:declarationcoordinates}
2606 \livetargi{chap:declarationcoordinates}{}{declaration coordinates}
2607 \textit{It is sometimes useful in a debugger to be able to associate
2608 a declaration with its occurrence in the program source.}
2609
2610 Any debugging information 
2611 \hypertarget{chap:DWATdeclfilefilecontainingsourcedeclaration}{}
2612 entry 
2613 \hypertarget{chap:DWATdecllinelinenumberofsourcedeclaration}{}
2614 representing 
2615 \hypertarget{chap:DWATdeclcolumncolumnpositionofsourcedeclaration}{}
2616 the
2617 \addtoindexx{line number of declaration}
2618 declaration of an object, module, subprogram or
2619 \addtoindex{declaration column attribute}
2620 type 
2621 \addtoindex{declaration file attribute}
2622 may 
2623 \addtoindex{declaration line attribute}
2624 have
2625 \DWATdeclfileDEFN, 
2626 \DWATdecllineDEFN{} and 
2627 \DWATdeclcolumnDEFN{}
2628 attributes each of whose value is an unsigned
2629 \livelink{chap:classconstant}{integer constant}.
2630
2631 The value of 
2632 \addtoindexx{declaration file attribute}
2633 the 
2634 \DWATdeclfile{}
2635 attribute 
2636 \addtoindexx{file containing declaration}
2637 corresponds to
2638 a file number from the line number information table for the
2639 compilation unit containing the debugging information entry and
2640 represents the source file in which the declaration appeared
2641 (see Section \refersec{chap:linenumberinformation}). 
2642 The value 0 indicates that no source file
2643 has been specified.
2644
2645 The value of 
2646 \addtoindexx{declaration line attribute}
2647 the \DWATdeclline{} attribute represents
2648 the source line number at which the first character of
2649 the identifier of the declared object appears. The value 0
2650 indicates that no source line has been specified.
2651
2652 The value of 
2653 \addtoindexx{declaration column attribute}
2654 the \DWATdeclcolumn{} attribute represents
2655 the source column number at which the first character of
2656 the identifier of the declared object appears. The value 0
2657 indicates that no column has been specified.
2658
2659 \section{Identifier Names}
2660 \label{chap:identifiernames}
2661 Any\hypertarget{chap:DWATnamenameofdeclaration}{}
2662 debugging information entry 
2663 \addtoindexx{identifier names}
2664 representing 
2665 \addtoindexx{names!identifier}
2666 a program entity that has been given a name may have a 
2667 \DWATnameDEFN{} 
2668 attribute\addtoindexx{name attribute}, whose value of 
2669 \CLASSstring{} represents the name as it appears in
2670 the source program. A debugging information entry containing
2671 no name attribute, or containing a name attribute whose value
2672 consists of a name containing a single null byte, represents
2673 a program entity for which no name was given in the source.
2674
2675 \textit{Because the names of program objects described by DWARF are 
2676 the names as they appear in the source program, implementations
2677 of language translators that use some form of mangled name
2678 \addtoindexx{mangled names}
2679 (as do many implementations of \addtoindex{C++}) should use the 
2680 unmangled form of the name in the 
2681 \DWATname{} attribute,
2682 \addtoindexx{name attribute}
2683 including the keyword operator (in names such as \doublequote{operator +}),
2684 if present. See also 
2685 Section \referfol{chap:linkagenames} regarding the use of 
2686 \DWATlinkagename{} for 
2687 \addtoindex{mangled names}.
2688 Sequences of multiple whitespace characters may be compressed.}
2689
2690 \section{Data Locations and DWARF Procedures}
2691 Any debugging information entry describing a data object (which
2692 \hypertarget{chap:DWATlocationdataobjectlocation}{}
2693 includes variables and parameters) or 
2694 \livelink{chap:commonblockentry}{common blocks}
2695 may have 
2696 \addtoindexx{location attribute}
2697 a
2698 \DWATlocationDEFN{} attribute,
2699 \addtoindexx{location attribute}
2700 whose value is a location description
2701 (see Section \refersec{chap:locationdescriptions}).
2702
2703 \needlines{4}
2704
2705 \addtoindex{DWARF procedure}
2706 is represented by any
2707 kind of debugging information entry that has a
2708 \addtoindexx{location attribute}
2709 \DWATlocationNAME{}
2710 attribute. 
2711 \addtoindexx{location attribute}
2712 If a suitable entry is not otherwise available,
2713 a DWARF procedure can be represented using a debugging
2714 \addtoindexx{DWARF procedure entry}
2715 information entry with the 
2716 tag \DWTAGdwarfprocedureTARG{}
2717 together with 
2718 \addtoindexx{location attribute}
2719 a \DWATlocationNAME{} attribute.  
2720
2721 A DWARF procedure
2722 is called by a \DWOPcalltwo, 
2723 \DWOPcallfour{} or 
2724 \DWOPcallref{}
2725 DWARF expression operator 
2726 (see Section \refersec{chap:controlflowoperations}).
2727
2728 \needlines{5}
2729 \section{Code Addresses and Ranges}
2730 \label{chap:codeaddressesandranges}
2731 Any debugging information entry describing an entity that has
2732 a machine code address or range of machine code addresses,
2733 which includes compilation units, module initialization,
2734 subroutines, ordinary \nolink{blocks}, 
2735 try/catch \nolink{blocks} (see Section\refersec{chap:tryandcatchblockentries}), 
2736 labels and the like, may have
2737 \begin{itemize}
2738 \item A \DWATlowpcDEFN{} attribute for
2739 \hypertarget{chap:DWATlowpccodeaddressorrangeofaddresses}{}
2740 a single address,
2741
2742 \item A \DWATlowpcDEFN{}
2743 \addtoindexx{low PC attribute}
2744 and 
2745 \DWAThighpcDEFN{}
2746 \addtoindexx{high PC attribute}
2747 \hypertarget{chap:DWAThighpccontiguousrangeofcodeaddresses}{}
2748 pair of attributes for 
2749 a single contiguous range of
2750 addresses, or
2751
2752 \item A \DWATrangesDEFN{} attribute 
2753 \addtoindexx{ranges attribute}
2754 \hypertarget{chap:DWATrangesnoncontiguousrangeofcodeaddresses}{}
2755 for a non-contiguous range of addresses.
2756 \end{itemize}
2757
2758 In addition, a non-contiguous range of 
2759 addresses may also be specified for the
2760 \DWATstartscope{} attribute.
2761 \addtoindexx{start scope attribute}
2762
2763 If an entity has no associated machine code, 
2764 none of these attributes are specified.
2765
2766 \subsection{Single Address} 
2767 When there is a single address associated with an entity,
2768 such as a label or alternate entry point of a subprogram,
2769 the entry has a \DWATlowpc{} attribute whose value is the
2770 relocated address for the entity.
2771
2772 \textit{While the \DWATentrypc{}
2773 attribute might also seem appropriate for this purpose,
2774 historically the \DWATlowpc{} attribute was used before
2775 \DWATentrypc{} was introduced 
2776 (in \addtoindex{DWARF Version 3}). There is
2777 insufficient reason to change this;
2778 \DWATlowpc{} serves as a default entry PC address as described
2779 in Section \refersec{chap:entryaddress}.}
2780
2781 \needlines{8}
2782 \subsection{Continuous Address Range}
2783 \label{chap:contiguousaddressranges}
2784 When the set of addresses of a debugging information entry can
2785 be described as a single contiguous range, the entry 
2786 \addtoindexx{high PC attribute}
2787 may 
2788 \addtoindexx{low PC attribute}
2789 have
2790 a \DWATlowpc{} and 
2791 \DWAThighpc{} pair of attributes. 
2792 The value
2793 of the 
2794 \DWATlowpc{} attribute 
2795 is the relocated address of the
2796 first instruction associated with the entity. If the value of
2797 the \DWAThighpc{} is of class address, it is the relocated
2798 address of the first location past the last instruction
2799 associated with the entity; if it is of class constant, the
2800 value is an unsigned integer offset which when added to the
2801 low PC gives the address of the first location past the last
2802 instruction associated with the entity.
2803
2804 \textit{The high PC value
2805 may be beyond the last valid instruction in the executable.}
2806
2807 \needlines{5}
2808 The presence of low and high PC attributes for an entity
2809 implies that the code generated for the entity is contiguous
2810 and exists totally within the boundaries specified by those
2811 two attributes. If that is not the case, no low and high PC
2812 attributes should be produced.
2813
2814 \subsection{Non-Contiguous Address Ranges}
2815 \label{chap:noncontiguousaddressranges}
2816 When the set of addresses of a debugging information entry
2817 \addtoindexx{non-contiguous address ranges}
2818 cannot be described as a single contiguous range, the entry has
2819 a \DWATranges{} attribute 
2820 \addtoindexx{ranges attribute}
2821 whose value is of class \livelink{chap:classrangelistptr}{rangelistptr}
2822 and indicates the beginning of a \addtoindex{range list}.
2823 Similarly,
2824 a \DWATstartscope{} attribute 
2825 \addtoindexx{start scope attribute}
2826 may have a value of class
2827 \livelink{chap:classrangelistptr}{rangelistptr} for the same reason.  
2828
2829 Range lists are contained in a separate object file section called 
2830 \dotdebugranges{}. A
2831 \addtoindex{range list} is indicated by a 
2832 \DWATranges{} attribute whose
2833 \addtoindexx{ranges attribute}
2834 value is represented as an offset from the beginning of the
2835 \dotdebugranges{} section to the beginning of the 
2836 \addtoindex{range list}.
2837
2838 \needlines{4}
2839 If the current compilation unit contains a \DWATrangesbase{}
2840 attribute, the value of that attribute establishes a base
2841 offset within the \dotdebugranges{} section for the compilation
2842 unit. The offset given by the \DWATranges{} attribute is
2843 relative to that base.
2844
2845 \textit{The \DWATrangesbase{} attribute is new in \DWARFVersionV.
2846 The advantage of this attribute is that it reduces the number of
2847 object language relocations needed for references to the \dotdebugranges{}
2848 section from one for each range entry to a single relocation that
2849 applies for the entire compilation unit.}
2850
2851 The \addtoindex{applicable base address} of a \addtoindex{range list} 
2852 entry is determined
2853 by the closest preceding base address selection entry (see
2854 below) in the same range list. If there is no such selection
2855 entry, then the applicable base address defaults to the base
2856 address of the compilation unit 
2857 (see Section \refersec{chap:normalandpartialcompilationunitentries}).
2858
2859 \textit{In the case of a compilation unit where all of the machine
2860 code is contained in a single contiguous section, no base
2861 address selection entry is needed.}
2862
2863 Address range entries in a \addtoindex{range list} may not overlap.
2864 There is no requirement that the entries be ordered in any particular way.
2865
2866 Each entry in a \addtoindex{range list} is either a 
2867 \addtoindex{range list entry},
2868 \addtoindexx{base address selection entry!in range list}
2869 a base address selection entry, or an 
2870 \addtoindexx{end-of-list entry!in range list}
2871 end-of-list entry.
2872
2873 \needlines{5}
2874 \subsubsection{Range List Entry}
2875 A \addtoindex{range list entry} consists of:
2876 \begin{enumerate}[1. ]
2877 \item A beginning address offset. This address offset has the 
2878 \addtoindex{size of an address} and is relative to
2879 the \addtoindex{applicable base address} of the compilation unit referencing this 
2880 \addtoindex{range list}. 
2881 It marks the beginning of an 
2882 \addtoindexi{address range}{address range!in range list}. 
2883
2884 \item An ending address offset. This address offset again has the 
2885 \addtoindex{size of an address} and is relative
2886 to the \addtoindex{applicable base address} of the compilation unit referencing 
2887 this \addtoindex{range list}.
2888 It marks the first address past the end of the address range.
2889 The ending address must be greater than or
2890 equal to the beginning address.
2891
2892 \needlines{4}
2893 \textit{A \addtoindex{range list} entry (but not a base address 
2894 selection or end-of-list entry) whose beginning and
2895 ending addresses are equal has no effect because the size of the 
2896 range covered by such an entry is zero.}
2897 \end{enumerate}
2898
2899 \needlines{5}
2900 \subsubsection{Base Address Selection Entry}
2901 A \addtoindex{base address selection entry} consists of:
2902 \begin{enumerate}[1. ]
2903 \item The value of the largest representable address offset 
2904 (for example, \wffffffff when the size of an address is 32 bits).
2905
2906 \item An address, which defines the appropriate base address 
2907 for use in interpreting the beginning and ending address offsets 
2908 of subsequent entries of the location list.
2909 \end{enumerate}
2910
2911 \textit{A base address selection entry affects only the 
2912 remainder of list in which it is contained.}
2913
2914 \subsubsection{End-of-List Entry}
2915 The end of any given \addtoindex{range list} is marked by an 
2916 \addtoindexx{end-of-list entry!in range list}
2917 end-of-list entry, 
2918 which consists of a 0 for the beginning address
2919 offset and a 0 for the ending address offset. 
2920 A \addtoindex{range list}
2921 containing only an end-of-list entry describes an empty scope
2922 (which contains no instructions).
2923
2924 \textit{A base address selection entry and an 
2925 \addtoindexx{end-of-list entry!in range list}
2926 end-of-list entry for
2927 a \addtoindex{range list} 
2928 are identical to a base address selection entry
2929 and end-of-list entry, respectively, for a location list
2930 (see Section \refersec{chap:locationlists}) 
2931 in interpretation and representation.}
2932
2933
2934 \section{Entry Address}
2935 \label{chap:entryaddress}
2936 \textit{The entry or first executable instruction generated
2937 for an entity, if applicable, is often the lowest addressed
2938 instruction of a contiguous range of instructions. In other
2939 cases, the entry address needs to be specified explicitly.}
2940
2941 Any debugging information entry describing an entity that has
2942 a range of code addresses, which includes compilation units,
2943 module initialization, subroutines, 
2944 \livelink{chap:lexicalblock}{lexical \nolink{blocks}},
2945 \livelink{chap:tryandcatchblockentries}{try/catch \nolink{blocks}},
2946 and the like, may have a \DWATentrypcDEFN{} attribute 
2947 \addtoindexx{entry PC address}
2948 to indicate the first executable instruction within that 
2949 range\hypertarget{chap:entryaddressofscope}{}
2950 of addresses. The value of the \DWATentrypcNAME{} attribute is a
2951 relocated address if the
2952 value of \DWATentrypcNAME{} is of class \CLASSaddress; or if it is of class
2953 \CLASSconstant, the value is an unsigned integer offset which, when
2954 added to the base address of the function, gives the entry
2955 address. 
2956
2957 The base address of the containing scope is given by either the
2958 \DWATlowpc{} attribute, or the first range entry in the list of
2959 ranges given by the \DWATranges{} attribute. 
2960 If no \DWATentrypcNAME{} attribute is present,
2961 then the entry address is assumed to be the same as the
2962 base address.
2963
2964
2965 \section{Static and Dynamic Values of Attributes}
2966 \label{chap:staticanddynamicvaluesofattributes}
2967
2968 Some attributes that apply to types specify a property (such
2969 as the lower bound of an array) that is an integer value,
2970 where the value may be known during compilation or may be
2971 computed dynamically during execution.
2972
2973 \needlines{5}
2974 The value of these
2975 attributes is determined based on the class as follows:
2976 \begin{itemize}
2977 \item For a \livelink{chap:classconstant}{constant}, the value of the constant is the value of
2978 the attribute.
2979
2980 \item For a \livelink{chap:classreference}{reference}, the
2981 value is a reference to another DIE.  This DIE may:
2982 \begin{itemize}
2983 \renewcommand{\itemsep}{0cm}
2984 \item describe a constant which is the attribute value,
2985 \item describe a variable which contains the attribute value, or
2986 \item contain a DWARF expression which computes the attribute value
2987       (for example, be a \DWTAGdwarfprocedure{} entry).
2988 \end{itemize}
2989
2990 \item For an \livelink{chap:classexprloc}{exprloc}, the value is interpreted as a 
2991 DWARF expression; 
2992 evaluation of the expression yields the value of
2993 the attribute.
2994 \end{itemize}
2995
2996 \textit{Whether an attribute value can be dynamic depends on the
2997 rules of the applicable programming language.
2998 }
2999
3000 \needlines{4}
3001 \section{Entity Descriptions}
3002 \textit{Some debugging information entries may describe entities
3003 in the program that are artificial, or which otherwise have a 
3004 \doublequote{name} that is not a valid identifier in the
3005 programming language. For example, several languages may
3006 capture or freeze the value of a variable at a particular
3007 point in the program and hold that value in an artificial variable. 
3008 \addtoindex{Ada} 95 has package elaboration routines,
3009 type descriptions of the form \texttt{typename\textquoteright Class}, and 
3010 \doublequote{\texttt{access} typename} parameters.}
3011
3012 Generally, any debugging information entry that 
3013 \hypertarget{chap:DWATdescriptionartificialnameordescription}{}
3014 has, or may have, a \DWATname{} attribute, may
3015 also have a
3016 \addtoindexx{description attribute}
3017 \DWATdescriptionDEFN{} attribute whose value is a
3018 null-terminated string providing a description of the entity.
3019
3020 \textit{It is expected that a debugger will only display these
3021 descriptions as part of the description of other entities.}
3022
3023 \needlines{4}
3024 \section{Byte and Bit Sizes}
3025 \label{chap:byteandbitsizes}
3026 % Some trouble here with hbox full, so we try optional word breaks.
3027 Many debugging information entries allow either a
3028 \DWATbytesizeNAME{} attribute or a 
3029 \DWATbitsizeNAME{} attribute,
3030 whose \livelink{chap:classconstant}{integer constant} value 
3031 (see Section \ref{chap:staticanddynamicvaluesofattributes}) 
3032 specifies an
3033 amount of storage. The value of the 
3034 \DWATbytesizeDEFN{} attribute
3035 is interpreted in bytes and the value of the 
3036 \DWATbitsizeDEFN{}
3037 attribute is interpreted in bits. The
3038 \DWATstringlengthbytesize{} and 
3039 \DWATstringlengthbitsize{} 
3040 attributes are similar.
3041
3042 In addition, the \livelink{chap:classconstant}{integer constant}
3043 value of a \DWATbytestride{} attribute is interpreted
3044 in bytes and the \livelink{chap:classconstant}{integer constant} value of a 
3045 \DWATbitstride{}
3046 attribute is interpreted in bits.
3047
3048 \section{Linkage Names}
3049 \label{chap:linkagenames}
3050 \textit{Some language implementations, notably 
3051 \addtoindex{C++} and similar
3052 languages, make use of implementation-defined names within
3053 object files that are different from the \addtoindex{identifier names}
3054 (see Section \refersec{chap:identifiernames}) of entities as they 
3055 appear in the source. Such names, sometimes known as 
3056 \addtoindex{mangled names}\addtoindexx{names!mangled},
3057 are used in various ways, such as: to encode additional
3058 information about an entity, to distinguish multiple entities
3059 that have the same name, and so on. When an entity has an
3060 associated distinct linkage name it may sometimes be useful
3061 for a producer to include this name in the DWARF description
3062 of the program to facilitate consumer access to and use of
3063 object file information about an entity and/or information
3064 \hypertarget{chap:DWATlinkagenameobjectfilelinkagenameofanentity}{}
3065 that is encoded in the linkage name itself.  
3066 }
3067
3068 % Some trouble maybe with hbox full, so we try optional word breaks.
3069 A debugging information entry may have a
3070 \addtoindexx{linkage name attribute}
3071 \DWATlinkagenameDEFN{}
3072 attribute whose value is a null-terminated string containing the 
3073 object file linkage name associated with the corresponding entity.
3074
3075
3076 \section{Template Parameters}
3077 \label{chap:templateparameters}
3078 \textit{In \addtoindex{C++}, a template is a generic definition 
3079 of a class, function, member function, or typedef (alias).  
3080 A template has formal parameters that
3081 can be types or constant values; the class, function,
3082 member function, or typedef is instantiated differently for each
3083 distinct combination of type or value actual parameters.  DWARF does
3084 not represent the generic template definition, but does represent each
3085 instantiation.}
3086
3087 A debugging information entry that represents a 
3088 \addtoindex{template instantiation}
3089 will contain child entries describing the actual template parameters.
3090 The containing entry and each of its child entries reference a template
3091 parameter entry in any circumstance where the template definition
3092 referenced a formal template parameter.
3093
3094 A template type parameter is represented by a debugging information
3095 entry with the tag
3096 \addtoindexx{template type parameter entry}
3097 \DWTAGtemplatetypeparameterTARG. 
3098 A template value parameter is represented by a debugging information
3099 entry with the tag
3100 \addtoindexx{template value parameter entry}
3101 \DWTAGtemplatevalueparameterTARG.
3102 The actual template parameter entries appear in the same order as the 
3103 corresponding template formal parameter declarations in the 
3104 source program.
3105
3106 \needlines{4}
3107 A type or value parameter entry may have a \DWATname{} attribute, 
3108 \addtoindexx{name attribute}
3109 whose value is a
3110 null\dash terminated string containing the name of the corresponding 
3111 formal parameter as it appears in the source program.
3112 The entry may also have a 
3113 \DWATdefaultvalue{} attribute, which is a flag indicating 
3114 that the value corresponds to the default argument for the 
3115 template parameter.
3116
3117 A
3118 \addtoindexx{formal type parameter|see{template type parameter entry}}
3119 template type parameter entry has a
3120 \addtoindexx{type attribute}
3121 \DWATtype{} attribute
3122 describing the actual type by which the formal is replaced.
3123
3124 A template value parameter entry has a \DWATtype{} attribute 
3125 describing the type of the parameterized value.
3126 The entry also has an attribute giving the 
3127 actual compile-time or run-time constant value 
3128 of the value parameter for this instantiation.
3129 This can be a 
3130 \DWATconstvalueDEFN{} attribute, 
3131 \addtoindexx{constant value attribute}
3132 \livetarg{chap:DWATconstvaluetemplatevalueparameter}{} 
3133 whose value is the compile-time constant value 
3134 as represented on the target architecture, or a 
3135 \DWATlocation{} attribute, whose value is a 
3136 single location description for the run-time constant address.
3137
3138 \section{Alignment}
3139 \label{chap:alignment}
3140 \livetarg{chap:DWATalignmentnondefault}{}
3141 A debugging information entry may have a 
3142 \DWATalignmentDEFN{} attribute\addtoindexx{alignment attribute}
3143 that describes the (non-default) alignment requirements of the entry.
3144 \DWATalignment{} has a positive, non-zero, integer constant value
3145 describing the strictest specified (non-default) alignment of the entity. 
3146 This constant describes the actual alignment used by the compiler.
3147 (If there are multiple alignments specified by the user, or if the 
3148 user specified an alignment the compiler could not satisfy, then 
3149 only the strictest alignment is added using this attribute.)
3150
3151 \textit{For example, an alignment attribute whose value is 8 indicates
3152 that the entity to which it applies occurs at an address that is a
3153 multiple of eight (not a multiple of $2^8$ or 256).}