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