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