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