cc087e35a3b80f68d35f1d6547f72951d376ff56
[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 The number of data bytes may be implicit from context
840 or explicitly specified by an initial unsigned LEB128 value
841 (see Section \refersec{datarep:variablelengthdata}) 
842 that precedes that number of data bytes.
843 \\
844  
845 \hypertarget{chap:classconstant}{}
846 \livelinki{datarep:classconstant}{constant}{constant class}
847 &One, two, four, eight or sixteen 
848 bytes of uninterpreted data, or data
849 encoded in the variable length format known as LEB128 
850 (see Section \refersec{datarep:variablelengthdata}).
851 \\
852
853 \hypertarget{chap:classexprloc}{}
854 \livelinki{datarep:classexprloc}{exprloc}{exprloc class}
855 &A DWARF expression for a value or a location in the 
856 address space of the described program.
857 A leading unsigned LEB128 value 
858 (see Section \refersec{datarep:variablelengthdata})
859 specifies the number of bytes in the expression.
860 \\
861
862 \hypertarget{chap:classflag}{}
863 \livelinki{datarep:classflag}{flag}{flag class}
864 &A small constant that indicates the presence or absence 
865 of an attribute.
866 \\
867
868 \hypertarget{chap:classlineptr}{}
869 \livelinki{datarep:classlineptr}{lineptr}{lineptr class}
870 &Specifies a location in the DWARF section that holds line 
871 number information.
872 \\
873
874 \hypertarget{chap:classloclistptr}{}
875 \livelinki{datarep:classloclistptr}{loclistptr}{loclistptr class}
876 &Specifies a location in the DWARF section that holds location 
877 lists, which describe objects whose location can change during 
878 their lifetime.
879 \\
880
881 \hypertarget{chap:classmacptr}{}
882 \livelinki{datarep:classmacptr}{macptr}{macptr class}
883 &Specifies 
884 a location in the DWARF section that holds macro definition
885 information.
886 \\
887
888 \hypertarget{chap:classrangelistptr}{}
889 \livelinki{datarep:classrangelistptr}{rangelistptr}{rangelistptr class}
890 &Specifies a location in the DWARF section that holds 
891 non-contiguous address ranges.
892 \\
893
894 \hypertarget{chap:classreference}{}
895 \livelinki{datarep:classreference}{reference}{reference class}
896 &Refers to one of the debugging information
897 entries that \mbox{describe} the program.  There are four types of
898 \mbox{reference}. The first is an offset relative to the beginning
899 of the \mbox{compilation} unit in which the reference occurs and must
900 refer to an entry within that same compilation unit. The second
901 type of reference is the offset of a debugging \mbox{information}
902 entry in any compilation unit, including one different from
903 the unit containing the reference. The third type of reference
904 is an indirect reference to a 
905 \addtoindexx{type signature}
906 type definition using an 8-byte signature 
907 for that type. The fourth type of reference is a reference from within the 
908 \dotdebuginfo{} section of the executable or shared object file to
909 a debugging information entry in the \dotdebuginfo{} section of 
910 a \addtoindex{supplementary object file}.
911 \\
912
913 \hypertarget{chap:classstring}{}
914 \livelinki{datarep:classstring}{string}{string class}
915 & A null-terminated sequence of zero or more
916 (non-null) bytes. Data in this class are generally
917 printable strings. Strings may be represented directly in
918 the debugging \mbox{information} entry or as an offset in a separate
919 string table.
920 \\
921
922 \hypertarget{chap:classstroffsetsptr}{}
923 \livelinki{datarep:classstroffsetsptr}{stroffsetsptr}{stroffsetsptr class}
924 &Specifies a location in the DWARF section that holds
925 a series of offsets into the DWARF section that holds strings.
926 Certain attributes use one of these offsets by indexing 
927 relative to this location. The resulting offset is then 
928 used to index into the DWARF string section.
929 \\
930
931 \hline
932 \end{longtable}
933
934
935 \section{Relationship of Debugging Information Entries}
936 \label{chap:relationshipofdebugginginformationentries}
937 \textit{%
938 A variety of needs can be met by permitting a single
939 \addtoindexx{debugging information entry!ownership relation}
940 debugging information entry to \doublequote{own} an arbitrary number
941 of other debugging entries and by permitting the same debugging
942 information entry to be one of many owned by another debugging
943 information entry. 
944 This makes it possible, for example, to
945 describe the static \livelink{chap:lexicalblock}{block} structure 
946 within a source file,
947 to show the members of a structure, union, or class, and to
948 associate declarations with source files or source files
949 with shared object files.  
950 }
951
952 \needlines{4}
953 The ownership relationship 
954 \addtoindexx{debugging information entry!ownership relation}
955 of debugging
956 information entries is achieved naturally because the debugging
957 information is represented as a tree. The nodes of the tree
958 are the debugging information entries themselves. 
959 The child entries of any node are exactly those debugging information
960 entries owned by that node.  
961
962 \textit{%
963 While the ownership relation
964 of the debugging information entries is represented as a
965 tree, other relations among the entries exist, for example,
966 a reference from an entry representing a variable to another
967 entry representing the type of that variable. 
968 If all such
969 relations are taken into account, the debugging entries
970 form a graph, not a tree.  
971 }
972
973 \needlines{4}
974 The tree itself is represented
975 by flattening it in prefix order. 
976 Each debugging information
977 entry is defined either to have child entries or not to have
978 child entries (see Section \refersec{datarep:abbreviationstables}). 
979 If an entry is defined not
980 to have children, the next physically succeeding entry is a
981 sibling. 
982 If an entry is defined to have children, the next
983 physically succeeding entry is its first child. 
984 Additional
985 children are represented as siblings of the first child. 
986 A chain of sibling entries is terminated by a null entry.
987
988 In cases where a producer of debugging information feels that
989 it\hypertarget{chap:DWATsiblingdebugginginformationentryrelationship}{}
990 will be important for consumers of that information to
991 quickly scan chains of sibling entries, while ignoring the
992 children of individual siblings, that producer may attach a
993 \addtoindexx{sibling attribute}
994 \DWATsiblingDEFN{} attribute 
995 to any debugging information entry. 
996 The value of this attribute is a reference to the sibling entry
997 of the entry to which the attribute is attached.
998
999 \section{Target Addresses}
1000 \label{chap:targetaddressableunitsandaddresses}
1001 \label{chap:targetaddresses}
1002 \addtoindexx{size of an address}
1003 \addtoindexx{size of an address|see{\textit{also} \texttt{address\_size}}}
1004 \addtoindexx{address size|see{size of an address}}
1005 \addtoindexx{address size|see{\textit{also} \texttt{address\_size}}}
1006
1007 Addresses, bytes and bits in DWARF use the numbering and direction
1008 conventions that are appropriate to the current language on
1009 the target system.
1010
1011 Many places in this document refer to the size of an address
1012 on the target architecture (or equivalently, target machine)
1013 to which a DWARF description applies. For processors which
1014 can be configured to have different address sizes or different
1015 instruction sets, the intent is to refer to the configuration
1016 which is either the default for that processor or which is
1017 specified by the object file or executable file which contains
1018 the DWARF information.
1019
1020 \textit{%
1021 For example, if a particular target architecture supports
1022 both 32-bit and 64-bit addresses, the compiler will generate
1023 an object file which specifies that it contains executable
1024 code generated for one or the other of these 
1025 \addtoindexx{size of an address}
1026 address sizes. In
1027 that case, the DWARF debugging information contained in this
1028 object file will use the same address size.}
1029
1030 \needlines{6}
1031 \section{DWARF Expressions}
1032 \label{chap:dwarfexpressions}
1033 DWARF expressions describe how to compute a value or 
1034 specify a location. They are expressed in
1035 terms of DWARF operations that operate on a stack of values.
1036
1037 A DWARF expression is encoded as a stream of operations, 
1038 each consisting of an opcode followed by zero or more literal 
1039 operands. The number of operands is implied by the opcode.  
1040
1041 In addition to the
1042 general operations that are defined here, operations that are
1043 specific to location descriptions are defined in 
1044 Section \refersec{chap:locationdescriptions}.
1045
1046 \subsection{General Operations}
1047 \label{chap:generaloperations}
1048 Each general operation represents a postfix operation on
1049 a simple stack machine. 
1050 Each element of the stack has a type and a value, and can represent
1051 a value of any supported base type of the target machine.  Instead of
1052 a base type, elements can have a 
1053 \definitionx{special address type}\livetarg{chap:specialaddresstype}{},
1054 which is an integral type that has the 
1055 \addtoindex{size of an address} on the target machine and 
1056 unspecified signedness. The value on the top of the stack after 
1057 \doublequote{executing} the 
1058 \addtoindex{DWARF expression}
1059 is 
1060 \addtoindexx{DWARF expression|see{\textit{also} location description}}
1061 taken to be the result (the address of the object, the
1062 value of the array bound, the length of a dynamic string,
1063 the desired value itself, and so on).
1064
1065
1066 \needlines{4}
1067 \subsubsection{Literal Encodings}
1068 \label{chap:literalencodings}
1069 The 
1070 \addtoindexx{DWARF expression!literal encodings}
1071 following operations all push a value onto the DWARF
1072 stack. 
1073 \addtoindexx{DWARF expression!stack operations}
1074 Operations other than \DWOPconsttype{} push a value with the 
1075 \specialaddresstype, and if the value of a constant in one of these 
1076 operations is larger than can be stored in a single stack element, 
1077 the value is truncated to the element size and the low-order bits
1078 are pushed on the stack.
1079 \begin{enumerate}[1. ]
1080 \itembfnl{\DWOPlitzeroTARG, \DWOPlitoneTARG, \dots, \DWOPlitthirtyoneTARG}
1081 The \DWOPlitnTARG{} operations encode the unsigned literal values
1082 from 0 through 31, inclusive.
1083
1084 \itembfnl{\DWOPaddrTARG}
1085 The \DWOPaddrNAME{} operation has a single operand that encodes
1086 a machine address and whose size is the \addtoindex{size of an address}
1087 on the target machine.
1088
1089 \itembfnl{\DWOPconstoneuTARG, \DWOPconsttwouTARG, \DWOPconstfouruTARG, \DWOPconsteightuTARG}
1090 \DWOPconstnxMARK{}
1091 The single operand of a \DWOPconstnuNAME{} operation provides a 1,
1092 2, 4, or 8-byte unsigned integer constant, respectively.
1093
1094 \itembfnl{\DWOPconstonesTARG, \DWOPconsttwosTARG, \DWOPconstfoursTARG, \DWOPconsteightsTARG}
1095 The single operand of a \DWOPconstnsNAME{} operation provides a 1,
1096 2, 4, or 8-byte signed integer constant, respectively.
1097
1098 \needlines{4}
1099 \itembfnl{\DWOPconstuTARG}
1100 The single operand of the \DWOPconstuNAME{} operation provides
1101 an unsigned LEB128\addtoindexx{LEB128!unsigned} integer constant.
1102
1103 \itembfnl{\DWOPconstsTARG}
1104 The single operand of the \DWOPconstsNAME{} operation provides
1105 a signed LEB128\addtoindexx{LEB128!unsigned} integer constant.
1106
1107 \needlines{4}
1108 \itembfnl{\DWOPaddrxTARG}
1109 The \DWOPaddrxNAME{} operation has a single operand that
1110 encodes an unsigned LEB128\addtoindexx{LEB128!unsigned} value, 
1111 which is a zero-based index into the \dotdebugaddr{} section, 
1112 where a machine address is stored.
1113 This index is relative to the value of the 
1114 \DWATaddrbase{} attribute of the associated compilation unit.
1115
1116 \itembfnl{\DWOPconstxTARG}
1117 The \DWOPconstxNAME{} operation has a single operand that
1118 encodes an unsigned LEB128\addtoindexx{LEB128!unsigned} value, 
1119 which is a zero-based
1120 index into the \dotdebugaddr{} section, where a constant, the
1121 size of a machine address, is stored.
1122 This index is relative to the value of the 
1123 \DWATaddrbase{} attribute of the associated compilation unit.
1124
1125 \needlines{3}
1126 \textit{The \DWOPconstxNAME{} operation is provided for constants that
1127 require link-time relocation but should not be
1128 interpreted by the consumer as a relocatable address
1129 (for example, offsets to thread-local storage).}
1130
1131 \needlines{12}
1132 \itembfnl{\DWOPconsttypeTARG}
1133 The \DWOPconsttypeNAME{} operation takes three operands. The first operand 
1134 is an unsigned LEB128 integer that represents the offset of a debugging
1135 information entry in the current compilation unit, which must be a
1136 \DWTAGbasetype{} entry that provides the type of the constant provided. The
1137 second operand is 1-byte unsigned integer that specifies the size of the
1138 constant value, which is the same as the size of the base type referenced
1139 by the first operand. The third operand is a 
1140 sequence of bytes of the given size that is 
1141 interpreted as a value of the referenced type.
1142
1143 \textit{While the size of the constant can be inferred from the base type
1144 definition, it is encoded explicitly into the operation so that the
1145 operation can be parsed easily without reference to the \dotdebuginfo{}
1146 section.}
1147
1148 \end{enumerate}
1149
1150 \needlines{10}
1151 \subsubsection{Register Values}
1152 \label{chap:registervalues}
1153 The following operations push a value onto the stack that is either the
1154 contents of a register or the result of adding the contents of a register
1155 to a given signed offset. 
1156 \addtoindexx{DWARF expression!register based addressing}
1157 \DWOPregvaltype{} pushes the contents
1158 of the register together with the given base type, while the other operations
1159 push the result of adding the contents of a register to a given
1160 signed offset together with the \specialaddresstype.
1161
1162 \needlines{8}
1163 \begin{enumerate}[1. ]
1164 \itembfnl{\DWOPfbregTARG}
1165 The \DWOPfbregNAME{} operation provides a 
1166 signed LEB128\addtoindexx{LEB128!signed} offset
1167 from the address specified by the location description in the
1168 \DWATframebase{} attribute of the current function.
1169  
1170 \textit{This is typically a stack pointer register plus or minus some offset.}
1171
1172 \itembfnl{\DWOPbregzeroTARG, \DWOPbregoneTARG, \dots, \DWOPbregthirtyoneTARG}
1173 The single operand of the \DWOPbregnTARG{} 
1174 operations provides
1175 a signed LEB128\addtoindexx{LEB128!signed} offset from
1176 the contents of the specified register.
1177
1178 \itembfnl{\DWOPbregxTARG}
1179 The \DWOPbregxNAME{} operation provides the sum of two values specified
1180 by its two operands. The first operand is a register number
1181 which is specified by an unsigned LEB128\addtoindexx{LEB128!unsigned}
1182 number. The second operand is a signed LEB128\addtoindexx{LEB128!signed} offset.
1183
1184 \needlines{8}
1185 \itembfnl{\DWOPregvaltypeTARG}
1186 The \DWOPregvaltypeNAME{} operation provides the contents of
1187 a given register interpreted as a value of a given type. The first 
1188 operand is an unsigned LEB128\addtoindexx{LEB128!unsigned} number, 
1189 which identifies a register whose contents is to
1190 be pushed onto the stack. The second operand is an 
1191 unsigned LEB128\addtoindexx{LEB128!unsigned} number
1192 that represents the offset of a debugging information entry in the current
1193 compilation unit, which must be a \DWTAGbasetype{} entry that provides the
1194 type of the value contained in the specified register.
1195
1196 \end{enumerate}
1197
1198 \needlines{6}
1199 \subsubsection{Stack Operations}
1200 \label{chap:stackoperations}
1201 The following 
1202 \addtoindexx{DWARF expression!stack operations}
1203 operations manipulate the DWARF stack. Operations
1204 that index the stack assume that the top of the stack (most
1205 recently added entry) has index 0.
1206
1207 Each entry on the stack has an associated type. 
1208
1209 \needlines{4}
1210 \begin{enumerate}[1. ]
1211 \itembfnl{\DWOPdupTARG}
1212 The \DWOPdupNAME{} operation duplicates the value (including its 
1213 type identifier) at the top of the stack.
1214
1215 \itembfnl{\DWOPdropTARG}
1216 The \DWOPdropNAME{} operation pops the value (including its type 
1217 identifier) at the top of the stack.
1218
1219 \itembfnl{\DWOPpickTARG}
1220 The single operand of the \DWOPpickNAME{} operation provides a
1221 1-byte index. A copy of the stack entry (including its 
1222 type identifier) with the specified
1223 index (0 through 255, inclusive) is pushed onto the stack.
1224
1225 \itembfnl{\DWOPoverTARG}
1226 The \DWOPoverNAME{} operation duplicates the entry currently second
1227 in the stack at the top of the stack. 
1228 This is equivalent to a
1229 \DWOPpick{} operation, with index 1.  
1230
1231 \needlines{4}
1232 \itembfnl{\DWOPswapTARG}
1233 The \DWOPswapNAME{} operation swaps the top two stack entries. 
1234 The entry at the top of the stack (including its type identifier)
1235 becomes the second stack entry, and the second entry (including 
1236 its type identifier) becomes the top of the stack.
1237
1238 \itembfnl{\DWOProtTARG}
1239 The \DWOProtNAME{} operation rotates the first three stack
1240 entries. The entry at the top of the stack (including its 
1241 type identifier) becomes the third stack entry, the second 
1242 entry (including its type identifier) becomes the top of 
1243 the stack, and the third entry (including its type identifier)
1244 becomes the second entry.
1245
1246 \itembfnl{\DWOPderefTARG}
1247 The \DWOPderefNAME{} operation pops the top stack entry and 
1248 treats it as an address. The popped value must have an integral type.
1249 The value retrieved from that address is pushed, 
1250 and has the \specialaddresstype{}.
1251 The size of the data retrieved from the 
1252 \addtoindexi{dereferenced}{address!dereference operator}
1253 address is the \addtoindex{size of an address} on the target machine.
1254
1255 \needlines{6}
1256 \itembfnl{\DWOPderefsizeTARG}
1257 The \DWOPderefsizeNAME{} operation behaves like the 
1258 \DWOPderef{}
1259 operation: it pops the top stack entry and treats it as an
1260 address. The popped value must have an integral type.
1261 The value retrieved from that address is pushed,
1262 and has the \specialaddresstype{}.
1263 In the \DWOPderefsizeNAME{} operation, however, the size in bytes
1264 of the data retrieved from the dereferenced address is
1265 specified by the single operand. This operand is a 1-byte
1266 unsigned integral constant whose value may not be larger
1267 than the size of the \specialaddresstype. The data
1268 retrieved is zero extended to the size of an address on the
1269 target machine before being pushed onto the expression stack.
1270
1271 \itembfnl{\DWOPdereftypeTARG}
1272 The \DWOPdereftypeNAME{} operation behaves like the \DWOPderefsize{} operation:
1273 it pops the top stack entry and treats it as an address. 
1274 The popped value must have an integral type.
1275 The value retrieved from that address is pushed together with a type identifier. 
1276 In the \DWOPdereftypeNAME{} operation, the size in
1277 bytes of the data retrieved from the dereferenced address is specified by
1278 the first operand. This operand is a 1-byte unsigned integral constant whose
1279 value which is the same as the size of the base type referenced
1280 by the second operand.
1281 The second operand is an unsigned LEB128 integer that
1282 represents the offset of a debugging information entry in the current
1283 compilation unit, which must be a \DWTAGbasetype{} entry that provides the
1284 type of the data pushed.
1285
1286 \textit{While the size of the pushed value could be inferred from the base 
1287 type definition, it is encoded explicitly into the operation so that the
1288 operation can be parsed easily without reference to the \dotdebuginfo{}
1289 section.}
1290
1291 \needlines{7}
1292 \itembfnl{\DWOPxderefTARG}
1293 The \DWOPxderefNAME{} operation provides an extended dereference
1294 mechanism. The entry at the top of the stack is treated as an
1295 address. The second stack entry is treated as an \doublequote{address
1296 space identifier} for those architectures that support
1297 \addtoindexi{multiple}{address space!multiple}
1298 address spaces. 
1299 Both of these entries must have integral type identifiers.
1300 The top two stack elements are popped,
1301 and a data item is retrieved through an implementation-defined
1302 address calculation and pushed as the new stack top together with the
1303 \specialaddresstype{} identifier.
1304 The size of the data retrieved from the 
1305 \addtoindexi{dereferenced}{address!dereference operator}
1306 address is the size of the \specialaddresstype.
1307
1308 \needlines{4}
1309 \itembfnl{\DWOPxderefsizeTARG}
1310 The \DWOPxderefsizeNAME{} operation behaves like the
1311 \DWOPxderef{} operation. The entry at the top of the stack is
1312 treated as an address. The second stack entry is treated as
1313 an \doublequote{address space identifier} for those architectures
1314 that support 
1315 \addtoindexi{multiple}{address space!multiple}
1316 address spaces. 
1317 Both of these entries must have integral type identifiers.
1318 The top two stack
1319 elements are popped, and a data item is retrieved through an
1320 implementation\dash defined address calculation and pushed as the
1321 new stack top. In the \DWOPxderefsizeNAME{} operation, however,
1322 the size in bytes of the data retrieved from the 
1323 \addtoindexi{dereferenced}{address!dereference operator}
1324 address is specified by the single operand. This operand is a
1325 1-byte unsigned integral constant whose value may not be larger
1326 than the \addtoindex{size of an address} on the target machine. The data
1327 retrieved is zero extended to the \addtoindex{size of an address} on the
1328 target machine before being pushed onto the expression stack together
1329 with the \specialaddresstype{} identifier.
1330
1331 \itembfnl{\DWOPxdereftypeTARG}
1332 The \DWOPxdereftypeNAME{} operation behaves like the \DWOPxderefsize{}
1333 operation: it pops the top two stack entries, treats them as an address and
1334 an address space identifier, and pushes the value retrieved. In the
1335 \DWOPxdereftypeNAME{} operation, the size in bytes of the data retrieved from
1336 the dereferenced address is specified by the first operand. This operand is
1337 a 1-byte unsigned integral constant whose value 
1338 value which is the same as the size of the base type referenced
1339 by the second operand. The second
1340 operand is an unsigned LEB128 integer that represents the offset of a
1341 debugging information entry in the current compilation unit, which must be a
1342 \DWTAGbasetype{} entry that provides the type of the data pushed.
1343
1344 \needlines{6}
1345 \itembfnl{\DWOPpushobjectaddressTARG}
1346 The \DWOPpushobjectaddressNAME{}
1347 operation pushes the address
1348 of the object currently being evaluated as part of evaluation
1349 of a user presented expression. This object may correspond
1350 to an independent variable described by its own debugging
1351 information entry or it may be a component of an array,
1352 structure, or class whose address has been dynamically
1353 determined by an earlier step during user expression
1354 evaluation.
1355
1356 \textit{This operator provides explicit functionality
1357 (especially for arrays involving descriptors) that is analogous
1358 to the implicit push of the base 
1359 \addtoindexi{address}{address!implicit push of base}
1360 of a structure prior to evaluation of a 
1361 \DWATdatamemberlocation{} 
1362 to access a data member of a structure. For an example, see 
1363 Appendix \refersec{app:aggregateexamples}.}
1364
1365 \needlines{4}
1366 \itembfnl{\DWOPformtlsaddressTARG}
1367 The \DWOPformtlsaddressNAME{} 
1368 operation pops a value from the stack, which must have an 
1369 integral type identifier, translates this
1370 value into an address in the 
1371 \addtoindex{thread-local storage}
1372 for a thread, and pushes the address 
1373 onto the stack together with the \specialaddresstype{} identifier. 
1374 The meaning of the value on the top of the stack prior to this 
1375 operation is defined by the run-time environment.  If the run-time 
1376 environment supports multiple thread-local storage 
1377 \nolink{blocks} for a single thread, then the \nolink{block} 
1378 corresponding to the executable or shared 
1379 library containing this DWARF expression is used.
1380    
1381 \textit{Some implementations of 
1382 \addtoindex{C}, \addtoindex{C++}, \addtoindex{Fortran}, and other 
1383 languages, support a 
1384 thread-local storage class. Variables with this storage class
1385 have distinct values and addresses in distinct threads, much
1386 as automatic variables have distinct values and addresses in
1387 each function invocation. Typically, there is a single \nolink{block}
1388 of storage containing all thread\dash local variables declared in
1389 the main executable, and a separate \nolink{block} for the variables
1390 declared in each shared library. Each 
1391 thread\dash local variable can then be accessed in its block using an
1392 identifier. This identifier is typically an offset into the block and 
1393 pushed onto the DWARF stack by one of the 
1394 \DWOPconstnx{} operations prior to the
1395 \DWOPformtlsaddress{} operation. 
1396 Computing the address of
1397 the appropriate \nolink{block} can be complex (in some cases, the
1398 compiler emits a function call to do it), and difficult
1399 to describe using ordinary DWARF location descriptions.
1400 Instead of    forcing complex thread-local storage calculations into 
1401 the DWARF expressions, the \DWOPformtlsaddress{} allows the consumer 
1402 to perform the computation based on the run-time environment.}
1403
1404 \needlines{4}
1405 \itembfnl{\DWOPcallframecfaTARG}
1406 The \DWOPcallframecfaNAME{} 
1407 operation pushes the value of the
1408 CFA, obtained from the Call Frame Information 
1409 (see Section \refersec{chap:callframeinformation}).
1410
1411 \textit{Although the value of \DWATframebase{}
1412 can be computed using other DWARF expression operators,
1413 in some cases this would require an extensive location list
1414 because the values of the registers used in computing the
1415 CFA change during a subroutine. If the 
1416 Call Frame Information 
1417 is present, then it already encodes such changes, and it is
1418 space efficient to reference that.}
1419 \end{enumerate}
1420
1421 \textit{Examples illustrating many of these stack operations are
1422 found in Appendix \refersec{app:dwarfstackoperationexamples}.}
1423
1424 \needlines{4}
1425 \subsubsection{Arithmetic and Logical Operations} 
1426 \addtoindexx{DWARF expression!arithmetic operations}
1427 \addtoindexx{DWARF expression!logical operations}
1428 The following provide arithmetic and logical operations. 
1429 Operands of an operation with two operands
1430 must have the same type,
1431 either the same base type or both the \specialaddresstype.
1432 The result of the operation which is pushed back has the same type
1433 as the type of the operand(s).  
1434
1435 If the type of the operands is the \specialaddresstype, 
1436 except as otherwise specified, the arithmetic operations
1437 perform addressing arithmetic, that is, unsigned arithmetic that is performed
1438 modulo one plus the largest representable address (for example, 0x100000000
1439 when the \addtoindex{size of an address} is 32 bits). 
1440
1441 Operations other than \DWOPabs{},
1442 \DWOPdiv{}, \DWOPminus{}, \DWOPmul{}, \DWOPneg{} and \DWOPplus{} 
1443 require integral types of the operand (either integral base type 
1444 or the \specialaddresstype).  Operations do not cause an exception 
1445 on overflow.
1446
1447 \needlines{4}
1448 \begin{enumerate}[1. ]
1449 \itembfnl{\DWOPabsTARG}
1450 The \DWOPabsNAME{} operation pops the top stack entry, interprets
1451 it as a signed value and pushes its absolute value. If the
1452 absolute value cannot be represented, the result is undefined.
1453
1454 \needlines{4}
1455 \itembfnl{\DWOPandTARG}
1456 The \DWOPandNAME{} operation pops the top two stack values, performs
1457 a bitwise and operation on the two, and pushes the result.
1458
1459 \itembfnl{\DWOPdivTARG}
1460 The \DWOPdivNAME{} operation pops the top two stack values, divides the former second entry by
1461 the former top of the stack using signed division, and pushes the result.
1462
1463 \itembfnl{\DWOPminusTARG}
1464 The \DWOPminusNAME{} operation pops the top two stack values, subtracts the former top of the
1465 stack from the former second entry, and pushes the result.
1466
1467 \itembfnl{\DWOPmodTARG}
1468 The \DWOPmodNAME{} operation pops the top two stack values and pushes the result of the
1469 calculation: former second stack entry modulo the former top of the stack.
1470
1471 \needlines{4}
1472 \itembfnl{\DWOPmulTARG}
1473 The \DWOPmulNAME{} operation pops the top two stack entries, multiplies them together, and
1474 pushes the result.
1475
1476 \needlines{4}
1477 \itembfnl{\DWOPnegTARG}
1478 The \DWOPnegNAME{} operation pops the top stack entry, interprets
1479 it as a signed value and pushes its negation. If the negation
1480 cannot be represented, the result is undefined.
1481
1482 \itembfnl{\DWOPnotTARG}
1483 The \DWOPnotNAME{} operation pops the top stack entry, and pushes
1484 its bitwise complement.
1485
1486 \itembfnl{\DWOPorTARG}
1487 The \DWOPorNAME{} operation pops the top two stack entries, performs
1488 a bitwise or operation on the two, and pushes the result.
1489
1490 \itembfnl{\DWOPplusTARG}
1491 The \DWOPplusNAME{} operation pops the top two stack entries,
1492 adds them together, and pushes the result.
1493
1494 \needlines{6}
1495 \itembfnl{\DWOPplusuconstTARG}
1496 The \DWOPplusuconstNAME{} operation pops the top stack entry,
1497 adds it to the unsigned LEB128\addtoindexx{LEB128!unsigned}
1498 constant operand 
1499 interpreted as the same type as the operand popped from the 
1500 top of the stack and pushes the result.
1501
1502 \textit{This operation is supplied specifically to be
1503 able to encode more field offsets in two bytes than can be
1504 done with
1505 \doublequote{\DWOPlitn~\DWOPplus.}}
1506
1507 \needlines{3}
1508 \itembfnl{\DWOPshlTARG}
1509 The \DWOPshlNAME{} operation pops the top two stack entries,
1510 shifts the former second entry left (filling with zero bits)
1511 by the number of bits specified by the former top of the stack,
1512 and pushes the result.
1513
1514 \itembfnl{\DWOPshrTARG}
1515 The \DWOPshrNAME{} operation pops the top two stack entries,
1516 shifts the former second entry right logically (filling with
1517 zero bits) by the number of bits specified by the former top
1518 of the stack, and pushes the result.
1519
1520 \needlines{3}
1521 \itembfnl{\DWOPshraTARG}
1522 The \DWOPshraNAME{} operation pops the top two stack entries,
1523 shifts the former second entry right arithmetically (divide
1524 the magnitude by 2, keep the same sign for the result) by
1525 the number of bits specified by the former top of the stack,
1526 and pushes the result.
1527
1528 \itembfnl{\DWOPxorTARG}
1529 The \DWOPxorNAME{} operation pops the top two stack entries,
1530 performs a bitwise exclusive\dash or operation on the two, and
1531 pushes the result.
1532
1533 \end{enumerate}
1534
1535 \subsubsection{Control Flow Operations}
1536 \label{chap:controlflowoperations}
1537 The 
1538 \addtoindexx{DWARF expression!control flow operations}
1539 following operations provide simple control of the flow of a DWARF expression.
1540 \begin{enumerate}[1. ]
1541 \itembfnl{\DWOPleTARG, \DWOPgeTARG, \DWOPeqTARG, \DWOPltTARG, \DWOPgtTARG, \DWOPneTARG}
1542 The six relational operators each:
1543 \begin{itemize}
1544 \item pop the top two stack values, which have the same type,
1545 either the same base type or both the \specialaddresstype, 
1546
1547 \item compare the operands:
1548 \linebreak
1549 \textless~former second entry~\textgreater  \textless~relational operator~\textgreater \textless~former top entry~\textgreater
1550
1551 \item push the constant value 1 onto the stack 
1552 if the result of the operation is true or the
1553 constant value 0 if the result of the operation is false.
1554 The pushed value has the \specialaddresstype.
1555 \end{itemize}
1556
1557 If the operands have the \specialaddresstype, the comparisons  
1558 are performed as signed operations.
1559
1560 \needlines{6}
1561 \itembfnl{\DWOPskipTARG}
1562 \DWOPskipNAME{} is an unconditional branch. Its single operand
1563 is a 2-byte signed integer constant. The 2-byte constant is
1564 the number of bytes of the DWARF expression to skip forward
1565 or backward from the current operation, beginning after the
1566 2-byte constant.
1567
1568 \itembfnl{\DWOPbraTARG}
1569 \DWOPbraNAME{} is a conditional branch. Its single operand is a
1570 2-byte signed integer constant.  This operation pops the
1571 top of stack. If the value popped is not the constant 0,
1572 the 2-byte constant operand is the number of bytes of the
1573 DWARF expression to skip forward or backward from the current
1574 operation, beginning after the 2-byte constant.
1575
1576 % The following item does not correctly hyphenate leading
1577 % to an overfull hbox and a visible artifact. 
1578 % So we use \- to suggest hyphenation in this rare situation.
1579 \itembfnl{\DWOPcalltwoTARG, \DWOPcallfourTARG, \DWOPcallrefTARG}
1580 \DWOPcalltwoNAME, 
1581 \DWOPcallfourNAME, 
1582 and \DWOPcallrefNAME{} perform
1583 DWARF procedure calls during evaluation of a DWARF expression or
1584 location description. 
1585 For \DWOPcalltwoNAME{} and \DWOPcallfourNAME{}, 
1586 the operand is the 2\dash~ or 4-byte unsigned offset, respectively,
1587 of a debugging information entry in the current compilation
1588 unit. The \DWOPcallrefNAME{} operator has a single operand. In the
1589 \thirtytwobitdwarfformat,
1590 the operand is a 4-byte unsigned value;
1591 in the \sixtyfourbitdwarfformat, it is an 8-byte unsigned value
1592 (see Section \referfol{datarep:32bitand64bitdwarfformats}). 
1593 The operand is used as the offset of a
1594 debugging information entry in a 
1595 \dotdebuginfo{}
1596 section which may be contained in an executable or shared object file
1597 other than that containing the operator. For references from
1598 one executable or shared object file to another, the relocation
1599 must be performed by the consumer.  
1600
1601 \textit{Operand interpretation of
1602 \DWOPcalltwo, \DWOPcallfour{} and \DWOPcallref{} is exactly like
1603 that for \DWFORMreftwo, \DWFORMreffour{} and \DWFORMrefaddr,
1604 respectively  
1605 (see Section  \refersec{datarep:attributeencodings}).}
1606
1607 These operations transfer control of DWARF expression evaluation to 
1608 \addtoindexx{location attribute}
1609 the 
1610 \DWATlocation{}
1611 attribute of the referenced debugging information entry. If
1612 there is no such attribute, then there is no effect. Execution
1613 of the DWARF expression of 
1614 \addtoindexx{location attribute}
1615
1616 \DWATlocation{} attribute may add
1617 to and/or remove from values on the stack. Execution returns
1618 to the point following the call when the end of the attribute
1619 is reached. Values on the stack at the time of the call may be
1620 used as parameters by the called expression and values left on
1621 the stack by the called expression may be used as return values
1622 by prior agreement between the calling and called expressions.
1623 \end{enumerate}
1624
1625 \subsubsection{Type Conversions}
1626 \label{chap:typeconversions}
1627 The following operations provides for explicit type conversion.
1628
1629 \begin{enumerate}[1. ]
1630 \itembfnl{\DWOPconvertTARG}
1631 The \DWOPconvertNAME{} operation pops the top stack entry, converts it to a
1632 different type, then pushes the result. It takes one operand, which is an
1633 unsigned LEB128 integer that represents the offset of a debugging
1634 information entry in the current compilation unit, or value 0 which
1635 represents the \specialaddresstype. If the operand is non-zero, the
1636 referenced entry must be a \DWTAGbasetype{} entry that provides the type
1637 to which the value is converted.
1638
1639 \itembfnl{\DWOPreinterpretTARG}
1640 The \DWOPreinterpretNAME{} operation pops the top stack entry, reinterprets
1641 the bits in its value as a value of a different type, then pushes the
1642 result. It takes one operand, which is an unsigned LEB128 integer that
1643 represents the offset of a debugging information entry in the current
1644 compilation unit, or value 0 which represents the \specialaddresstype.
1645 If the operand is non-zero, the referenced entry must be a
1646 \DWTAGbasetype{} entry that provides the type to which the value is converted.
1647 The type of the operand and result type should have the same size in bits.
1648
1649 \end{enumerate}
1650
1651 \needlines{7}
1652 \subsubsection{Special Operations}
1653 \label{chap:specialoperations}
1654 There 
1655 \addtoindexx{DWARF expression!special operations}
1656 are these special operations currently defined:
1657 \begin{enumerate}[1. ]
1658 \itembfnl{\DWOPnopNAME}
1659 The \DWOPnopTARG{} operation is a place holder. It has no effect
1660 on the location stack or any of its values.
1661
1662 \itembfnl{\DWOPentryvalueNAME}
1663 The \DWOPentryvalueTARG{} operation pushes 
1664 \bb
1665 the value that the described location held
1666 \eb
1667 upon entering the current subprogram.  It has two operands: an 
1668 unsigned LEB128\addtoindexx{LEB128!unsigned} length, followed by 
1669 a block containing a DWARF expression or a register location description 
1670 (see Section \refersec{chap:registerlocationdescriptions}).  
1671 The length operand specifies the length
1672 in bytes of the block.  If the block contains a register location
1673 description, \DWOPentryvalueNAME{} pushes the value that register had upon
1674 entering the current subprogram.  If the block contains a DWARF expression,
1675 the DWARF expression is evaluated as if it has been evaluated upon entering
1676 the current subprogram.  The DWARF expression 
1677 assumes no values are present on the DWARF stack initially and results
1678 in exactly one value being pushed on the DWARF stack when completed.
1679
1680 \DWOPpushobjectaddress{} is not meaningful inside of this DWARF operation.
1681
1682 \textit{
1683 The values needed to evaluate \DWOPentryvalueNAME{} could be obtained in
1684 several ways. The consumer could suspend execution on entry to the
1685 subprogram, record values needed by \DWOPentryvalueNAME{} expressions within
1686 the subprogram, and then continue; when evaluating \DWOPentryvalueNAME{},
1687 the consumer would use these recorded values rather than the current
1688 values.  Or, when evaluating \DWOPentryvalueNAME{}, the consumer could
1689 "virtually unwind" using the Call Frame Information 
1690 (see Section \refersec{chap:callframeinformation}) 
1691 to recover register values that might have been clobbered since the
1692 subprogram entry point.}
1693
1694 \end{enumerate}
1695
1696 \needlines{8}
1697 \section{Location Descriptions}
1698 \label{chap:locationdescriptions}
1699 \textit{Debugging information 
1700 \addtoindexx{location description}
1701 must 
1702 \addtoindexx{location description|see{\textit{also} DWARF expression}}
1703 provide consumers a way to find
1704 the location of program variables, determine the bounds
1705 of dynamic arrays and strings, and possibly to find the
1706 base address of a subroutine\textquoteright s stack frame or the return
1707 address of a subroutine. Furthermore, to meet the needs of
1708 recent computer architectures and optimization techniques,
1709 debugging information must be able to describe the location of
1710 an object whose location changes over the object\textquoteright s lifetime.}
1711
1712 Information about the location of program objects is provided
1713 by location descriptions. Location descriptions can be either
1714 of two forms:
1715 \begin{enumerate}[1. ]
1716 \item \textit{Single location descriptions}, 
1717 which 
1718 \addtoindexx{location description!single}
1719 are 
1720 \addtoindexx{single location description}
1721 a language independent representation of
1722 addressing rules of arbitrary complexity built from 
1723 DWARF expressions (See Section \refersec{chap:dwarfexpressions}) 
1724 and/or other
1725 DWARF operations specific to describing locations. They are
1726 sufficient for describing the location of any object as long
1727 as its lifetime is either static or the same as the 
1728 \livelink{chap:lexicalblock}{lexical block} that owns it, 
1729 and it does not move during its lifetime.
1730
1731
1732 \needlines{4}
1733 \item \textit{Location lists}, which are used to 
1734 \addtoindexx{location list}
1735 describe
1736 \addtoindexx{location description!use in location list}
1737 objects that have a limited lifetime or change their location
1738 during their lifetime. Location lists are described in
1739 Section \refersec{chap:locationlists} below.
1740
1741 \end{enumerate}
1742
1743 Location descriptions are distinguished in a context sensitive
1744 manner. As the value of an attribute, a location description
1745 is encoded using 
1746 \addtoindexx{exprloc class}
1747 class \livelink{chap:classexprloc}{exprloc}  
1748 and a location list is encoded
1749 using class \livelink{chap:classloclistptr}{loclistptr}
1750 (which 
1751 \addtoindex{loclistptr}
1752 serves as an offset into a
1753 separate 
1754 \addtoindexx{location list}
1755 location list table).
1756
1757 \needlines{4}
1758 \subsection{Single Location Descriptions}
1759 A single location description is either:
1760 \begin{enumerate}[1. ]
1761 \item A simple location description, representing an object
1762 \addtoindexx{location description!simple}
1763 which 
1764 \addtoindexx{simple location description}
1765 exists in one contiguous piece at the given location, or 
1766 \item A composite location description consisting of one or more
1767 \addtoindexx{location description!composite}
1768 simple location descriptions, each of which is followed by
1769 one composition operation. Each simple location description
1770 describes the location of one piece of the object; each
1771 composition operation describes which part of the object is
1772 located there. Each simple location description that is a
1773 DWARF expression is evaluated independently of any others.
1774 \end{enumerate}
1775
1776
1777
1778 \subsubsection{Simple Location Descriptions}
1779
1780 \addtoindexx{location description!simple}
1781 simple location description consists of one 
1782 contiguous piece or all of an object or value.
1783
1784 \needlines{4}
1785 \subsubsubsection{Empty Location Descriptions}
1786 An \addtoindex{empty location description}
1787 consists of a DWARF expression
1788 \addtoindexx{location description!empty}
1789 containing no operations. It represents a piece or all of an
1790 object that is present in the source but not in the object code
1791 (perhaps due to optimization).
1792
1793 \subsubsubsection{Memory Location Descriptions}
1794
1795 \addtoindexx{location description!memory}
1796 memory location description 
1797 \addtoindexx{memory location description}
1798 consists of a non-empty DWARF
1799 expression (see 
1800 Section \refersec{chap:dwarfexpressions}), 
1801 whose value is the address of
1802 a piece or all of an object or other entity in memory.
1803
1804 \subsubsubsection{Register Location Descriptions}
1805 \label{chap:registerlocationdescriptions}
1806 A register location description consists of a register name
1807 operation, which represents a piece or all of an object
1808 located in a given register.
1809
1810 \textit{Register location descriptions describe an object
1811 (or a piece of an object) that resides in a register, while
1812 the opcodes listed in 
1813 Section \refersec{chap:registervalues}
1814 are used to describe an object (or a piece of
1815 an object) that is located in memory at an address that is
1816 contained in a register (possibly offset by some constant). A
1817 register location description must stand alone as the entire
1818 description of an object or a piece of an object.
1819 }
1820
1821 The following DWARF operations can be used to 
1822 specify a register location.
1823
1824 \textit{Note that the register number represents a DWARF specific
1825 mapping of numbers onto the actual registers of a given
1826 architecture. The mapping should be chosen to gain optimal
1827 density and should be shared by all users of a given
1828 architecture. It is recommended that this mapping be defined
1829 by the ABI authoring committee for each architecture.
1830 }
1831 \begin{enumerate}[1. ]
1832 \itembfnl{\DWOPregzeroTARG, \DWOPregoneTARG, ..., \DWOPregthirtyoneTARG}
1833 The \DWOPregnTARG{} operations encode the names of up to 32
1834 registers, numbered from 0 through 31, inclusive. The object
1835 addressed is in register \textit{n}.
1836
1837 \needlines{4}
1838 \itembfnl{\DWOPregxTARG}
1839 The \DWOPregxNAME{} operation has a single 
1840 unsigned LEB128\addtoindexx{LEB128!unsigned} literal
1841 operand that encodes the name of a register.  
1842
1843 \end{enumerate}
1844
1845 \textit{These operations name a register location. To
1846 fetch the contents of a register, it is necessary to use
1847 one of the register based addressing operations, such as
1848 \DWOPbregx{} 
1849 (Section \refersec{chap:registervalues})}.
1850
1851 \subsubsubsection{Implicit Location Descriptions}
1852 An \addtoindex{implicit location description}
1853 represents a piece or all
1854 \addtoindexx{location description!implicit}
1855 of an object which has no actual location but whose contents
1856 are nonetheless either known or known to be undefined.
1857
1858 The following DWARF operations may be used to specify a value
1859 that has no location in the program but is a known constant
1860 or is computed from other locations and values in the program.
1861 \begin{enumerate}[1. ]
1862 \itembfnl{\DWOPimplicitvalueTARG}
1863 The \DWOPimplicitvalueNAME{} operation specifies an immediate value
1864 using two operands: an unsigned LEB128\addtoindexx{LEB128!unsigned}
1865 length, followed by a 
1866 sequence of bytes of the given length that contain the value.
1867
1868 \itembfnl{\DWOPstackvalueTARG}
1869 The \DWOPstackvalueNAME{} 
1870 operation specifies that the object
1871 does not exist in memory but its value is nonetheless known
1872 and is at the top of the DWARF expression stack. In this form
1873 of location description, the DWARF expression represents the
1874 actual value of the object, rather than its location. The
1875 \DWOPstackvalueNAME{} operation terminates the expression.
1876
1877 \needlines{4}
1878 \itembfnl{\DWOPimplicitpointerTARG}
1879 \textit{An optimizing compiler may eliminate a pointer, while
1880 still retaining the value that the pointer addressed.  
1881 \DWOPimplicitpointerNAME{} allows a producer to describe this value.}
1882
1883 The \DWOPimplicitpointerNAME{} operation specifies that the object
1884 is a pointer that cannot be represented as a real pointer,
1885 even though the value it would point to can be described. In
1886 this form of location description, the DWARF expression refers
1887 to a debugging information entry that represents the actual
1888 value of the object to which the pointer would point. Thus, a
1889 consumer of the debug information would be able to show the
1890 value of the dereferenced pointer, even when it cannot show
1891 the value of the pointer itself.
1892
1893 \needlines{5}
1894 The \DWOPimplicitpointerNAME{} operation has two operands: a 
1895 reference to a debugging information entry that describes 
1896 the dereferenced object's value, and a signed number that 
1897 is treated as a byte offset from the start of that value. 
1898 The first operand is a 4-byte unsigned value in the 32-bit 
1899 DWARF format, or an 8-byte unsigned value in the 64-bit 
1900 DWARF format (see Section 
1901 \refersec{datarep:32bitand64bitdwarfformats}).
1902 The second operand is a 
1903 signed LEB128\addtoindexx{LEB128!signed} number.
1904
1905 The first operand is used as the offset of a debugging
1906 information entry in a \dotdebuginfo{} section, which may be
1907 contained in an executable or shared object file other than that
1908 containing the operator. For references from one executable or
1909 shared object file to another, the relocation must be performed 
1910 by the consumer.
1911
1912 \textit{The debugging information entry referenced by a 
1913 \DWOPimplicitpointerNAME{} operation is typically a
1914 \DWTAGvariable{} or \DWTAGformalparameter{} entry whose
1915 \DWATlocation{} attribute gives a second DWARF expression or a
1916 location list that describes the value of the object, but the
1917 referenced entry may be any entry that contains a \DWATlocation{}
1918 or \DWATconstvalue{} attribute (for example, \DWTAGdwarfprocedure).
1919 By using the second DWARF expression, a consumer can
1920 reconstruct the value of the object when asked to dereference
1921 the pointer described by the original DWARF expression
1922 containing the \DWOPimplicitpointer{} operation.}
1923
1924 \end{enumerate}
1925
1926 \textit{DWARF location descriptions 
1927 are intended to yield the \textbf{location}
1928 of a value rather than the value itself. An optimizing compiler
1929 may perform a number of code transformations where it becomes
1930 impossible to give a location for a value, but it remains possible
1931 to describe the value itself. 
1932 Section \refersec{chap:registerlocationdescriptions}
1933 describes operators that can be used to
1934 describe the location of a value when that value exists in a
1935 register but not in memory. The operations in this section are
1936 used to describe values that exist neither in memory nor in a
1937 single register.}
1938  
1939
1940 \needlines{6}
1941 \subsubsection{Composite Location Descriptions}
1942 A composite location description describes an object or
1943 value which may be contained in part of a register or stored
1944 in more than one location. Each piece is described by a
1945 composition operation, which does not compute a value nor
1946 store any result on the DWARF stack. There may be one or
1947 more composition operations in a single composite location
1948 description. A series of such operations describes the parts
1949 of a value in memory address order.
1950
1951 Each composition operation is immediately preceded by a simple
1952 location description which describes the location where part
1953 of the resultant value is contained.
1954 \begin{enumerate}[1. ]
1955 \itembfnl{\DWOPpieceTARG}
1956 The \DWOPpieceNAME{} operation takes a 
1957 single operand, which is an
1958 unsigned LEB128\addtoindexx{LEB128!unsigned} number.  
1959 The number describes the size in bytes
1960 of the piece of the object referenced by the preceding simple
1961 location description. If the piece is located in a register,
1962 but does not occupy the entire register, the placement of
1963 the piece within that register is defined by the ABI.
1964
1965 \textit{Many compilers store a single variable in sets of registers,
1966 or store a variable partially in memory and partially in
1967 registers. \DWOPpieceNAME{} provides a way of describing how large
1968 a part of a variable a particular DWARF location description
1969 refers to.}
1970
1971 \needlines{4}
1972 \itembfnl{\DWOPbitpieceTARG}
1973 The \DWOPbitpieceNAME{} 
1974 operation takes two operands. The first
1975 is an unsigned LEB128\addtoindexx{LEB128!unsigned} 
1976 number that gives the size in bits
1977 of the piece. The second is an 
1978 unsigned LEB128\addtoindexx{LEB128!unsigned} number that
1979 gives the offset in bits from the location defined by the
1980 preceding DWARF location description.  
1981
1982 Interpretation of the offset depends on the location description. 
1983 If the location description is empty, the offset 
1984 doesn\textquoteright{}t matter and
1985 the \DWOPbitpieceNAME{} operation describes a piece consisting
1986 of the given number of bits whose values are undefined. If
1987 the location is a register, the offset is from the least
1988 significant bit end of the register. If the location is a
1989 memory address, the \DWOPbitpieceNAME{} operation describes a
1990 sequence of bits relative to the location whose address is
1991 on the top of the DWARF stack using the bit numbering and
1992 direction conventions that are appropriate to the current
1993 language on the target system. If the location is any implicit
1994 value or stack value, the \DWOPbitpieceNAME{} operation describes
1995 a sequence of bits using the least significant bits of that
1996 value.  
1997 \end{enumerate}
1998
1999 \textit{\DWOPbitpieceNAME{} is 
2000 used instead of \DWOPpieceNAME{} when
2001 the piece to be assembled into a value or assigned to is not
2002 byte-sized or is not at the start of a register or addressable
2003 unit of memory.}
2004
2005 \needlines{6}
2006 \subsection{Location Lists}
2007 \label{chap:locationlists}
2008 There are two forms of location lists. The first form 
2009 is intended for use in other than a \splitDWARFobjectfile,
2010 while the second is intended for use in a \splitDWARFobjectfile{} 
2011 (see Section \refersec{datarep:splitdwarfobjectfiles}). The two
2012 forms are otherwise equivalent.
2013
2014
2015 \needlines{4}
2016 \subsubsection{Location Lists in Non-split Objects}
2017 \label{chap:locationlistsinnonsplitobjects}
2018 Location lists 
2019 \addtoindexx{location list}
2020 are used in place of location descriptions
2021 whenever the object whose location is being described
2022 can change location during its lifetime. 
2023 Location lists
2024 \addtoindexx{location list}
2025 are contained in a separate object file section called
2026 \dotdebugloc{}. A location list is indicated by a location
2027 attribute whose value is an offset from the beginning of
2028 the \dotdebugloc{} section to the first byte of the list for the
2029 object in question.
2030
2031 The \definitionx{applicable base address} of a normal
2032 location list entry (see following) is
2033 \addtoindexx{location list!base address selection entry}
2034 determined by the closest preceding base address selection
2035 entry in the same location list. If there is
2036 no such selection entry, then the applicable base address
2037 defaults to the base address of the compilation unit (see
2038 Section \refersec{chap:fullandpartialcompilationunitentries}).  
2039
2040 \textit{In the case of a compilation unit where all of
2041 the machine code is contained in a single contiguous section,
2042 no base address selection entry is needed.}
2043
2044 Each entry in a location list is either a location 
2045 \addtoindexi{list}{address selection|see{base address selection}} 
2046 entry,
2047
2048 \addtoindexi{base}{base address selection entry!in location list} 
2049 address selection entry, 
2050 \addtoindexx{location list!base address selection entry}
2051 or an 
2052 \addtoindexx{end-of-list entry!in location list}
2053 end-of-list entry.
2054
2055 \subsubsubsection{Location List Entry}
2056 A location list entry has two forms:
2057 a normal location list entry and a default location list entry.
2058
2059 \needlines{4}
2060 \subsubsubsubsection{Normal Location List Entry}
2061 A\addtoindexx{location list!normal entry}
2062 \addtoindex{normal location list entry} consists of:
2063 \begin{enumerate}[1. ]
2064 \item A beginning address offset. 
2065 This address offset has the \addtoindex{size of an address} and is
2066 relative to the applicable base address of the compilation
2067 unit referencing this location list. It marks the beginning
2068 of the address 
2069 \addtoindexi{range}{address range!in location list} 
2070 over which the location is valid.
2071
2072 \item An ending address offset.  This address offset again
2073 has the \addtoindex{size of an address} and is relative to the applicable
2074 base address of the compilation unit referencing this location
2075 list. It marks the first address past the end of the address
2076 range over which the location is valid. The ending address
2077 must be greater than or equal to the beginning address.
2078
2079 \textit{A location list entry (but not a base address selection or 
2080 end-of-list entry) whose beginning
2081 and ending addresses are equal has no effect 
2082 because the size of the range covered by such
2083 an entry is zero.}
2084
2085 \item An unsigned 2-byte length describing the length of the location 
2086 description that follows.
2087
2088 \item A \addtoindex{single location description} 
2089 describing the location of the object over the range specified by
2090 the beginning and end addresses.
2091 \end{enumerate}
2092
2093 Address ranges defined by normal location list entries
2094 may overlap. When they do, they describe a
2095 situation in which an object exists simultaneously in more than
2096 one place. If all of the address ranges in a given location
2097 list do not collectively cover the entire range over which the
2098 object in question is defined, it is assumed that the object is
2099 not available for the portion of the range that is not covered.
2100
2101 \needlines{4}
2102 \subsubsubsubsection{Default Location List Entry}
2103 A \addtoindex{default location list entry} consists of:
2104 \addtoindexx{location list!default entry}
2105 \begin{enumerate}[1. ]
2106 \item The value 0.
2107 \item The value of the largest representable address offset (for
2108       example, \wffffffff when the size of an address is 32 bits).
2109 \item An unsigned 2-byte length describing the length of the location 
2110       description that follows.
2111 \item A single location description describing the location of the
2112       object when there is no prior normal location list entry
2113       that applies in the same location list.
2114 \end{enumerate}
2115
2116 A default location list entry is independent of any applicable
2117 base address (except to the extent to which base addresses
2118 affect prior normal location list entries).
2119
2120 A default location list entry must be the last location list
2121 entry of a location list except for the terminating end-of-list
2122 entry.
2123
2124 A \addtoindex{default location list entry} describes a single 
2125 location which applies to all addresses which are not included 
2126 in any range defined earlier in the same location list.
2127
2128 \needlines{5}
2129 \subsubsubsection{Base Address Selection Entry}
2130 A base 
2131 \addtoindexi{address}{address selection|see{base address selection}}
2132 \addtoindexx{location list!base address selection entry}
2133 selection 
2134 \addtoindexi{entry}{base address selection entry!in location list}
2135 consists of:
2136 \begin{enumerate}[1. ]
2137 \item The value of the largest representable 
2138 address offset (for example, \wffffffff when the size of
2139 an address is 32 bits).
2140 \item An address, which defines the 
2141 appropriate base address for use in interpreting the beginning
2142 and ending address offsets of subsequent entries of the location list.
2143 \end{enumerate}
2144
2145 \textit{A base address selection entry 
2146 affects only the remainder of the list in which it is contained.}
2147
2148 \needlines{5}
2149 \subsubsubsection{End-of-List Entry}
2150 The end of any given location list is marked by an 
2151 \addtoindexx{location list!end-of-list entry}
2152 end-of-list entry, which consists of a 0 for the beginning address
2153 offset and a 0 for the ending address offset. A location list
2154 containing only an 
2155 \addtoindexx{end-of-list entry!in location list}
2156 end-of-list entry describes an object that
2157 exists in the source code but not in the executable program.
2158
2159 Neither a base address selection entry nor an end-of-list
2160 entry includes a location description.
2161
2162 \needlines{4}
2163 \textit{When a DWARF consumer is parsing and decoding a location
2164 list, it must recognize the beginning and ending address
2165 offsets of (0, 0) for an end-of-list entry and 
2166 \mbox{(0, \texttt{maximum-address})} for
2167 a default location list entry prior to applying any base
2168 address. Any other pair of offsets beginning with 0 is a
2169 valid normal location list entry. Next, it must recognize the
2170 beginning address offset of \texttt{maximum-address} for a base address selection
2171 entry prior to applying any base address. The current base
2172 address is not applied to the subsequent value (although there
2173 may be an underlying object language relocation that affects
2174 that value).}
2175
2176 \textit{A base address selection entry and an end-of-list
2177 entry for a location list are identical to a base address
2178 selection entry and end-of-list entry, respectively, for a
2179 \addtoindex{range list}
2180 (see Section \refersec{chap:noncontiguousaddressranges}) 
2181 in interpretation and representation.}
2182
2183 \needlines{5}
2184 \subsubsection{Location Lists in Split Object Files}
2185 \label{chap:locationlistsinsplitobjectfiles}
2186 In a \splitDWARFobjectfile{} (see 
2187 Section \refersec{datarep:splitdwarfobjectfiles}), 
2188 location lists are contained in the \dotdebuglocdwo{} section.
2189
2190 The \addtoindex{applicable base address} of a split
2191 location list entry (see following) is
2192 \addtoindexx{location list!base address selection entry}
2193 determined by the closest preceding base address selection
2194 entry (\DWLLEbaseaddressselectionentry) in the same location list. If there is
2195 no such selection entry, then the applicable base address
2196 defaults to the base address of the compilation unit (see
2197 Section \refersec{chap:fullandpartialcompilationunitentries}).
2198
2199 Each entry in the split location list
2200 begins with a type code, which is a single unsigned byte that
2201 identifies the type of entry. There are five types of entries:
2202 \begin{enumerate}
2203 \itembfnl{\DWLLEendoflistentryTARG}
2204 This entry indicates the end of a location list, and
2205 contains no further data.
2206
2207 \needlines{6}
2208 \itembfnl{\DWLLEbaseaddressselectionentryTARG}
2209 This entry contains an 
2210 unsigned LEB128\addtoindexx{LEB128!unsigned} value immediately
2211 following the type code. This value is the index of an
2212 address in the \dotdebugaddr{} section, which is then used as
2213 the base address when interpreting offsets in subsequent
2214 location list entries of type \DWLLEoffsetpairentry.
2215 This index is relative to the value of the 
2216 \DWATaddrbase{} attribute of the associated compilation unit.
2217
2218 \itembfnl{\DWLLEstartendentryTARG}
2219 This entry contains two unsigned LEB128\addtoindexx{LEB128!unsigned}
2220 values immediately following the type code. These values are the
2221 indices of two addresses in the \dotdebugaddr{} section.
2222 These indices are relative to the value of the 
2223 \DWATaddrbase{} attribute of the associated compilation unit
2224 (see Section \refersec{chap:unitentries}).
2225 These indicate the starting and ending addresses,
2226 respectively, that define the address range for which
2227 this location is valid. The starting and ending addresses
2228 given by this type of entry are not relative to the
2229 compilation unit base address. A single location
2230 description follows the fields that define the address range.
2231
2232 \needlines{5}
2233 \itembfnl{\DWLLEstartlengthentryTARG}
2234 This entry contains one unsigned LEB128\addtoindexx{LEB128!unsigned}
2235 value and a 4-byte
2236 unsigned value immediately following the type code. The
2237 first value is the index of an address in the \dotdebugaddr{}
2238 section, which marks the beginning of the address range
2239 over which the location is valid.
2240 This index is relative to the value of the 
2241 \DWATaddrbase{} attribute of the associated compilation unit.
2242 The starting address given by this
2243 type of entry is not relative to the compilation unit
2244 base address. The second value is the
2245 length of the range in bytes. A single location
2246 description follows the fields that define the address range.
2247
2248 \itembfnl{\DWLLEoffsetpairentryTARG}
2249 This entry contains two 4-byte unsigned values
2250 immediately following the type code. These values are the
2251 starting and ending offsets, respectively, relative to
2252 the applicable base address, that define the address
2253 range for which this location is valid. A single location
2254 description follows the fields that define the address range.
2255 \end{enumerate}
2256
2257 \needlines{4}
2258 \textit{The \DWLLEbaseaddressselectionentry, \DWLLEstartendentry{}
2259 and \DWLLEstartlengthentry{} entries obtain addresses within the 
2260 target program indirectly using an index (not an offset) into an 
2261 array of addresses. The base of that array is obtained using the 
2262 \DWATaddrbase{} attribute of the containing compilation unit. 
2263 The value of that attribute is the offset of the base of the array 
2264 in the \dotdebugaddr{} section of the unit.}
2265
2266 \needlines{10}
2267 \section{Types of Program Entities}
2268 \label{chap:typesofprogramentities}
2269 \hypertarget{chap:DWATtypetypeofdeclaration}{}
2270 Any debugging information entry describing a declaration that
2271 has a type has 
2272 \addtoindexx{type attribute}
2273 a \DWATtypeDEFN{} attribute, whose value is a
2274 reference to another debugging information entry. The entry
2275 referenced may describe a base type, that is, a type that is
2276 not defined in terms of other data types, or it may describe a
2277 user-defined type, such as an array, structure or enumeration.
2278 Alternatively, the entry referenced may describe a type
2279 modifier, such as constant, packed, pointer, reference or
2280 volatile, which in turn will reference another entry describing
2281 a type or type modifier (using a
2282 \DWATtypeNAME{} attribute\addtoindexx{type attribute} of its
2283 own). See Chapter \referfol{chap:typeentries} 
2284 for descriptions of the entries describing
2285 base types, user-defined types and type modifiers.
2286
2287
2288 \needlines{6}
2289 \section{Accessibility of Declarations}
2290 \label{chap:accessibilityofdeclarations}
2291 \textit{Some languages, notably \addtoindex{C++} and 
2292 \addtoindex{Ada}, have the concept of
2293 the accessibility of an object or of some other program
2294 entity. The accessibility specifies which classes of other
2295 program objects are permitted access to the object in question.}
2296
2297 The accessibility of a declaration 
2298 is\hypertarget{chap:DWATaccessibilityattribute}{}
2299 represented by a 
2300 \DWATaccessibilityDEFN{}\addtoindexx{accessibility attribute} 
2301 attribute, whose value is a constant drawn from the set of codes 
2302 listed in Table \refersec{tab:accessibilitycodes}.
2303
2304 \begin{simplenametable}[1.9in]{Accessibility codes}{tab:accessibilitycodes}
2305 \DWACCESSpublicTARG{}          \\
2306 \DWACCESSprivateTARG{}        \\
2307 \DWACCESSprotectedTARG{}    \\
2308 \end{simplenametable}
2309
2310 \needlines{5}
2311 \section{Visibility of Declarations}
2312 \label{chap:visibilityofdeclarations}
2313
2314 \textit{Several languages (such as \addtoindex{Modula-2}) 
2315 have the concept of the visibility of a declaration. The
2316 visibility specifies which declarations are to be 
2317 visible outside of the entity in which they are
2318 declared.}
2319
2320 The\hypertarget{chap:DWATvisibilityvisibilityofdeclaration}{}
2321 visibility of a declaration is represented 
2322 by a \DWATvisibilityDEFN{}
2323 attribute\addtoindexx{visibility attribute}, whose value is a
2324 constant drawn from the set of codes listed in 
2325 Table \refersec{tab:visibilitycodes}.
2326
2327 \begin{simplenametable}[1.5in]{Visibility codes}{tab:visibilitycodes}
2328 \DWVISlocalTARG{}          \\
2329 \DWVISexportedTARG{}    \\
2330 \DWVISqualifiedTARG{}  \\
2331 \end{simplenametable}
2332
2333 \needlines{8}
2334 \section{Virtuality of Declarations}
2335 \label{chap:virtualityofdeclarations}
2336 \textit{\addtoindex{C++} provides for virtual and pure virtual structure or class
2337 member functions and for virtual base classes.}
2338
2339 The\hypertarget{chap:DWATvirtualityvirtualityindication}{}
2340 virtuality of a declaration is represented by a
2341 \DWATvirtualityDEFN{}
2342 attribute\addtoindexx{virtuality attribute}, whose value is a constant drawn
2343 from the set of codes listed in 
2344 Table \refersec{tab:virtualitycodes}.
2345
2346 \begin{simplenametable}[2.5in]{Virtuality codes}{tab:virtualitycodes}
2347 \DWVIRTUALITYnoneTARG{}                      \\
2348 \DWVIRTUALITYvirtualTARG{}                \\
2349 \DWVIRTUALITYpurevirtualTARG{}    \\
2350 \end{simplenametable}
2351
2352 \needlines{8}
2353 \section{Artificial Entries}
2354 \label{chap:artificialentries}
2355 \textit{A compiler may wish to generate debugging information entries
2356 for objects or types that were not actually declared in the
2357 source of the application. An example is a formal parameter
2358 entry to represent the hidden 
2359 \texttt{this} parameter\index{this parameter@\texttt{this} parameter}
2360 that most \addtoindex{C++} implementations pass as the first argument 
2361 to non-static member functions.}  
2362
2363 Any debugging information entry representing the
2364 \addtoindexx{artificial attribute}
2365 declaration of an object or type artificially generated by
2366 a compiler and not explicitly declared by the source 
2367 program\hypertarget{chap:DWATartificialobjectsortypesthat}{}
2368 may have a 
2369 \DWATartificialDEFN{} attribute, 
2370 which is a \livelink{chap:classflag}{flag}.
2371
2372 \needlines{6}
2373 \section{Segmented Addresses}
2374 \label{chap:segmentedaddresses}
2375 \textit{In some systems, addresses are specified as offsets within a
2376 given 
2377 \addtoindexx{address space!segmented}
2378 segment 
2379 \addtoindexx{segmented addressing|see{address space}}
2380 rather than as locations within a single flat
2381 \addtoindexx{address space!flat}
2382 address space.}
2383
2384 Any debugging information entry that contains a description
2385 of\hypertarget{chap:DWATsegmentaddressinginformation}{}
2386 the location of an object or subroutine may have a 
2387 \DWATsegmentDEFN{} attribute, 
2388 \addtoindexx{segment attribute}
2389 whose value is a location
2390 description. The description evaluates to the segment selector
2391 of the item being described. If the entry containing the
2392 \DWATsegmentNAME{} attribute has a 
2393 \DWATlowpc, 
2394 \DWAThighpc,
2395 \DWATranges{} or 
2396 \DWATentrypc{} attribute, 
2397 \addtoindexx{entry PC attribute}
2398 or 
2399 a location
2400 description that evaluates to an address, then those address
2401 values represent the offset portion of the address within
2402 the segment specified 
2403 \addtoindexx{segment attribute}
2404 by \DWATsegmentNAME.
2405
2406 If an entry has no 
2407 \DWATsegmentNAME{} attribute, it inherits
2408 \addtoindexx{segment attribute}
2409 the segment value from its parent entry.  If none of the
2410 entries in the chain of parents for this entry back to
2411 its containing compilation unit entry have 
2412 \DWATsegmentNAME{} attributes, 
2413 then the entry is assumed to exist within a flat
2414 address space. 
2415 Similarly, if the entry has a 
2416 \DWATsegmentNAME{} attribute 
2417 \addtoindexx{segment attribute}
2418 containing an empty location description, that
2419 entry is assumed to exist within a 
2420 \addtoindexi{flat}{address space!flat}
2421 address space.
2422
2423 \textit{Some systems support different 
2424 classes of addresses\addtoindexx{address class}. 
2425 The address class may affect the way a pointer is dereferenced
2426 or the way a subroutine is called.}
2427
2428
2429 Any debugging information entry representing a pointer or
2430 reference type or a subroutine or subroutine type may 
2431 have a 
2432 \DWATaddressclass{}
2433 attribute, whose value is an integer
2434 constant.  The set of permissible values is specific to
2435 each target architecture. The value \DWADDRnoneTARG, 
2436 however,
2437 is common to all encodings, and means that no address class
2438 has been specified.
2439
2440 \needlines{4}
2441 \textit {For example, the Intel386 \texttrademark\  processor might use the following values:}
2442
2443 \begin{table}[ht]
2444 \caption{Example address class codes}
2445 \label{tab:inteladdressclasstable}
2446 \centering
2447 \begin{tabular}{l|c|l}
2448 \hline
2449 Name&Value&Meaning  \\
2450 \hline
2451 \textit{DW\_ADDR\_none}&   0 & \textit{no class specified} \\
2452 \textit{DW\_ADDR\_near16}& 1 & \textit{16-bit offset, no segment} \\
2453 \textit{DW\_ADDR\_far16}&  2 & \textit{16-bit offset, 16-bit segment} \\
2454 \textit{DW\_ADDR\_huge16}& 3 & \textit{16-bit offset, 16-bit segment} \\
2455 \textit{DW\_ADDR\_near32}& 4 & \textit{32-bit offset, no segment} \\
2456 \textit{DW\_ADDR\_far32}&  5 & \textit{32-bit offset, 16-bit segment} \\
2457 \hline
2458 \end{tabular}
2459 \end{table}
2460
2461 \needlines{6}
2462 \section{Non-Defining Declarations and Completions}
2463 \label{chap:nondefiningdeclarationsandcompletions}
2464 A debugging information entry representing a program entity
2465 typically represents the defining declaration of that
2466 entity. In certain contexts, however, a debugger might need
2467 information about a declaration of an entity that is not
2468 \addtoindexx{incomplete declaration}
2469 also a definition, or is otherwise incomplete, to evaluate
2470 an\hypertarget{chap:DWATdeclarationincompletenondefiningorseparateentitydeclaration}{}
2471 expression correctly.
2472
2473 \needlines{10}
2474 \textit{As an example, consider the following fragment of \addtoindex{C} code:}
2475
2476 \begin{lstlisting}
2477 void myfunc()
2478 {
2479   int x;
2480   {
2481     extern float x;
2482     g(x);
2483   }
2484 }
2485 \end{lstlisting}
2486
2487
2488 \textit{\addtoindex{C} scoping rules require that the 
2489 value of the variable \texttt{x} passed to the function 
2490 \texttt{g} is the value of the global \texttt{float} 
2491 variable \texttt{x} rather than of the local \texttt{int} 
2492 variable \texttt{x}.}
2493
2494 \subsection{Non-Defining Declarations}
2495 A debugging information entry that 
2496 represents a non-defining 
2497 \addtoindexx{non-defining declaration}
2498 or otherwise 
2499 \addtoindex{incomplete declaration}
2500 of a program entity has a
2501 \addtoindexx{declaration attribute}
2502 \DWATdeclarationDEFN{} attribute, which is a 
2503 \livelink{chap:classflag}{flag}.
2504
2505 \textit{A non-defining type declaration may nonetheless have 
2506 children as illustrated in Section
2507 \refersec{app:declarationscompletingnondefiningdeclarations}.}
2508
2509
2510 \subsection{Declarations Completing Non-Defining Declarations}
2511 \hypertarget{chap:DWATspecificationincompletenondefiningorseparatedeclaration}{}
2512 A debugging information entry that represents a declaration
2513 that completes another (earlier) non-defining declaration may have a 
2514 \DWATspecificationDEFN{}
2515 attribute whose value is a \livelink{chap:classreference}{reference} to
2516 the debugging information entry representing the non-defining declaration. 
2517 A debugging information entry with a 
2518 \DWATspecificationNAME{} 
2519 attribute does not need to duplicate information provided by the 
2520 debugging information entry referenced by that specification attribute.
2521
2522 When the non-defining declaration is contained within a type that has
2523 been placed in a separate type unit (see Section \refersec{chap:typeunitentries}), 
2524 the \DWATspecification{} attribute cannot refer directly to the entry in
2525 the type unit. Instead, the current compilation unit may contain a
2526 \doublequote{skeleton} declaration of the type, which contains only the relevant
2527 declaration and its ancestors as necessary to provide the context
2528 (including containing types and namespaces). The \DWATspecification{}
2529 attribute would then be a reference to the declaration entry within
2530 the skeleton declaration tree. The debugging information entry for the
2531 top-level type in the skeleton tree may contain a \DWATsignature{}
2532 attribute whose value is the type signature 
2533 (see Section \refersec{datarep:typesignaturecomputation}).
2534
2535
2536 Not all attributes of the debugging information entry referenced by a
2537 \DWATspecification{} attribute 
2538 apply to the referring debugging information entry.
2539 For\addtoindexx{declaration attribute}
2540 example,
2541 \DWATsibling{} and 
2542 \DWATdeclaration{} 
2543 \addtoindexx{declaration attribute}
2544 cannot apply to a 
2545 \addtoindexx{declaration attribute}
2546 referring
2547 \addtoindexx{sibling attribute}
2548 entry.
2549
2550
2551 \section{Declaration Coordinates}
2552 \label{chap:declarationcoordinates}
2553 \livetargi{chap:declarationcoordinates}{}{declaration coordinates}
2554 \textit{It is sometimes useful in a debugger to be able to associate
2555 a declaration with its occurrence in the program source.}
2556
2557 Any debugging information entry representing 
2558 the declaration of an object, module, subprogram or type may have
2559 \DWATdeclfileDEFN,\hypertarget{chap:DWATdeclfilefilecontainingsourcedeclaration}{}
2560 \addtoindexx{declaration file attribute} 
2561 \DWATdecllineDEFN\hypertarget{chap:DWATdecllinelinenumberofsourcedeclaration}{}
2562 \addtoindexx{declaration line attribute} and 
2563 \DWATdeclcolumnDEFN\hypertarget{chap:DWATdeclcolumncolumnpositionofsourcedeclaration}{}
2564 \addtoindexx{declaration column attribute}
2565 attributes, each of whose value is an unsigned
2566 \livelink{chap:classconstant}{integer constant}.
2567
2568 The value of 
2569 \addtoindexx{declaration file attribute}
2570 the 
2571 \DWATdeclfile{}
2572 attribute 
2573 \addtoindexx{file containing declaration}
2574 corresponds to
2575 a file number from the line number information table for the
2576 compilation unit containing the debugging information entry and
2577 represents the source file in which the declaration appeared
2578 (see Section \refersec{chap:linenumberinformation}). 
2579 The value 0 indicates that no source file
2580 has been specified.
2581
2582 The value of 
2583 \addtoindexx{declaration line attribute}
2584 the \DWATdeclline{} attribute represents
2585 the source line number at which the first character of
2586 the identifier of the declared object appears. The value 0
2587 indicates that no source line has been specified.
2588
2589 The value of 
2590 \addtoindexx{declaration column attribute}
2591 the \DWATdeclcolumn{} attribute represents
2592 the source column number at which the first character of
2593 the identifier of the declared object appears. The value 0
2594 indicates that no column has been specified.
2595
2596 \section{Identifier Names}
2597 \label{chap:identifiernames}
2598 Any\hypertarget{chap:DWATnamenameofdeclaration}{}
2599 debugging information entry 
2600 \addtoindexx{identifier names}
2601 representing 
2602 \addtoindexx{names!identifier}
2603 a program entity that has been given a name may have a 
2604 \DWATnameDEFN{} 
2605 attribute\addtoindexx{name attribute}, whose value of 
2606 class \CLASSstring{} represents the name.
2607 A debugging information entry containing
2608 no name attribute, or containing a name attribute whose value
2609 consists of a name containing a single null byte, represents
2610 a program entity for which no name was given in the source.
2611
2612 \textit{Because the names of program objects described by DWARF are 
2613 the names as they appear in the source program, implementations
2614 of language translators that use some form of mangled name
2615 \addtoindexx{mangled names}
2616 (as do many implementations of \addtoindex{C++}) should use the 
2617 unmangled form of the name in the 
2618 \DWATname{} attribute,
2619 \addtoindexx{name attribute}
2620 including the keyword operator (in names such as \doublequote{operator +}),
2621 if present. See also 
2622 Section \referfol{chap:linkagenames} regarding the use of 
2623 \DWATlinkagename{} for 
2624 \addtoindex{mangled names}.
2625 Sequences of multiple whitespace characters may be compressed.}
2626
2627 \textit{For additional discussion, see the Best Practices section 
2628 of the DWARF Wiki 
2629 (\url{http://wiki.dwarfstd.org/index.php?title=Best_Practices}.)}
2630
2631 \section{Data Locations and DWARF Procedures}
2632 \hypertarget{chap:DWATlocationdataobjectlocation}{}
2633 Any debugging information entry describing a data object (which
2634 includes variables and parameters) or 
2635 \livelink{chap:commonblockentry}{common blocks}
2636 may have a \DWATlocationDEFN{} attribute,
2637 \addtoindexx{location attribute}
2638 whose value is a location description
2639 (see Section \refersec{chap:locationdescriptions}).
2640
2641 \needlines{4}
2642 A \addtoindex{DWARF procedure} is represented by any
2643 debugging information entry that has a
2644 \DWATlocationNAME{} attribute.\addtoindexx{location attribute}
2645 If a suitable entry is not otherwise available,
2646 a DWARF procedure can be represented using a debugging
2647 information entry \addtoindexx{DWARF procedure entry}
2648 with the tag \DWTAGdwarfprocedureTARG{} together with a 
2649 \DWATlocationNAME{} attribute.\addtoindexx{location attribute}  
2650
2651 A DWARF procedure is called by a \DWOPcalltwo, \DWOPcallfour{} 
2652 or \DWOPcallref{} DWARF expression operator 
2653 (see Section \refersec{chap:controlflowoperations}).
2654
2655 \needlines{5}
2656 \section{Code Addresses, Ranges and Base Addresses}
2657 \label{chap:codeaddressesandranges}
2658 Any debugging information entry describing an entity that has
2659 a machine code address or range of machine code addresses,
2660 which includes compilation units, module initialization,
2661 subroutines, lexical \nolink{blocks}, 
2662 try/catch \nolink{blocks} (see Section \refersec{chap:tryandcatchblockentries}), 
2663 labels and the like, may have
2664 \begin{itemize}
2665 \item \hypertarget{chap:DWATlowpccodeaddressorrangeofaddresses}{}
2666 A \DWATlowpcDEFN{} attribute for a single address,
2667
2668 \item \hypertarget{chap:DWAThighpccontiguousrangeofcodeaddresses}{}
2669 A \DWATlowpcDEFN{}\addtoindexx{low PC attribute}
2670 and \DWAThighpcDEFN{}\addtoindexx{high PC attribute}
2671 pair of attributes for a single contiguous range of
2672 addresses, or
2673
2674 \item \hypertarget{chap:DWATrangesnoncontiguousrangeofcodeaddresses}{}
2675 A \DWATrangesDEFN{} attribute\addtoindexx{ranges attribute}
2676 for a non-contiguous range of addresses.
2677 \end{itemize}
2678
2679 If an entity has no associated machine code, 
2680 none of these attributes are specified.
2681
2682 \needlines{4}
2683 The \definitionx{base address} of the scope for any of the
2684 debugging information entries listed above is given by either the 
2685 \DWATlowpcNAME{}\livetargi{chap:DWATlowpcbaseaddressofscope}{}{base address of scope} 
2686 attribute or the first address in the first range entry 
2687 in the list of ranges given by the \DWATrangesNAME{} attribute.
2688 If there is no such attribute, the base address is undefined.
2689
2690 \subsection{Single Address}
2691 \label{chap:singleaddress} 
2692 When there is a single address associated with an entity,
2693 such as a label or alternate entry point of a subprogram,
2694 the entry has a \DWATlowpc{} attribute whose value is the
2695 address for the entity.
2696
2697 \needlines{8}
2698 \subsection{Contiguous Address Range}
2699 \label{chap:contiguousaddressranges}
2700 When the set of addresses of a debugging information entry can
2701 be described as a single contiguous range, the entry may
2702 \addtoindexx{high PC attribute}
2703 \addtoindexx{low PC attribute}
2704 have a \DWATlowpc{} and \DWAThighpc{} pair of attributes. 
2705 The value of the \DWATlowpc{} attribute is the address of the
2706 first instruction associated with the entity. If the value of
2707 the \DWAThighpc{} is of class address, it is the 
2708 address of the first location past the last instruction
2709 associated with the entity; if it is of class constant, the
2710 value is an unsigned integer offset which when added to the
2711 low PC gives the address of the first location past the last
2712 instruction associated with the entity.
2713
2714 \textit{The high PC value
2715 may be beyond the last valid instruction in the executable.}
2716
2717 \subsection{Non-Contiguous Address Ranges}
2718 \label{chap:noncontiguousaddressranges}
2719 When the set of addresses of a debugging information entry
2720 \addtoindexx{non-contiguous address ranges}
2721 cannot be described as a single contiguous range, the entry 
2722 may have a \DWATranges{} attribute\addtoindexx{ranges attribute}
2723 whose value is of class \livelink{chap:classrangelistptr}{rangelistptr}
2724 and indicates the beginning of a \addtoindex{range list}.
2725 Similarly,
2726 a \DWATstartscope{} attribute\addtoindexx{start scope attribute}
2727 (see Section \refersec{chap:dataobjectentries}).
2728 may have a value of class
2729 \livelink{chap:classrangelistptr}{rangelistptr} for the same reason.  
2730
2731 Range lists are contained in the \dotdebugranges{} section. 
2732 A \addtoindex{range list} is indicated by a 
2733 \DWATranges{} attribute\addtoindexx{ranges attribute}
2734 whose value is an offset from the beginning of the
2735 \dotdebugranges{} section to the beginning of the 
2736 \addtoindex{range list}.
2737
2738 \needlines{4}
2739 If the current compilation unit contains a \DWATrangesbase{}
2740 attribute, the value of that attribute establishes a base
2741 offset within the \dotdebugranges{} section for the compilation
2742 unit. The offset given by the \DWATranges{} attribute is
2743 relative to that base.
2744
2745 The \definitionx{applicable base address} of a \addtoindex{range list} 
2746 entry is determined by the closest preceding base address 
2747 selection entry in the same range list (see
2748 Section \ref{chap:baseaddressselectionentry}). 
2749 If there is no such selection
2750 entry, then the applicable base address defaults to the base
2751 address of the compilation unit 
2752 (see Section \refersec{chap:fullandpartialcompilationunitentries}).
2753
2754 \textit{In the case of a compilation unit where all of the machine
2755 code is contained in a single contiguous section, no base
2756 address selection entry is needed.}
2757
2758 Address range entries in a \addtoindex{range list} may not overlap.
2759 There is no requirement that the entries be ordered in any particular way.
2760
2761 Each entry in a \addtoindex{range list} is either a 
2762 \addtoindex{range list entry},
2763 \addtoindexx{base address selection entry!in range list}
2764 a base address selection entry, or an 
2765 \addtoindexx{end-of-list entry!in range list}
2766 end-of-list entry.
2767
2768 \needlines{5}
2769 \subsubsection{Range List Entry}
2770 A \addtoindex{range list entry} consists of:
2771 \begin{enumerate}[1. ]
2772 \item A beginning address offset. This address offset has the 
2773 \addtoindex{size of an address} and is relative to
2774 the \addtoindex{applicable base address} of the compilation unit referencing this 
2775 \addtoindex{range list}. 
2776 It marks the beginning of an 
2777 \addtoindexi{address range}{address range!in range list}. 
2778
2779 \item An ending address offset. This address offset again has the 
2780 \addtoindex{size of an address} and is relative
2781 to the \addtoindex{applicable base address} of the compilation unit referencing 
2782 this \addtoindex{range list}.
2783 It marks the first address past the end of the address range.
2784 The ending address must be greater than or
2785 equal to the beginning address.
2786
2787 \needlines{4}
2788 \textit{A \addtoindex{range list} entry (but not a base address 
2789 selection or end-of-list entry) whose beginning and
2790 ending addresses are equal has no effect because the size of the 
2791 range covered by such an entry is zero.}
2792 \end{enumerate}
2793
2794 \needlines{5}
2795 \subsubsection{Base Address Selection Entry}
2796 \label{chap:baseaddressselectionentry}
2797 A \addtoindex{base address selection entry} consists of:
2798 \begin{enumerate}[1. ]
2799 \item The value of the largest representable address offset 
2800 (for example, \wffffffff when the size of an address is 32 bits).
2801
2802 \item An address, which defines the appropriate base address 
2803 for use in interpreting the beginning and ending address offsets 
2804 of subsequent entries of the location list.
2805 \end{enumerate}
2806
2807 \textit{A base address selection entry affects only the 
2808 remainder of the list in which it is contained.}
2809
2810 \subsubsection{End-of-List Entry}
2811 The end of any given \addtoindex{range list} is marked by an 
2812 \addtoindexx{end-of-list entry!in range list}
2813 end-of-list entry, 
2814 which consists of a 0 for the beginning address
2815 offset and a 0 for the ending address offset. 
2816 A \addtoindex{range list}
2817 containing only an end-of-list entry describes an empty scope
2818 (which contains no instructions).
2819
2820 \textit{A base address selection entry and an 
2821 \addtoindexx{end-of-list entry!in range list}
2822 end-of-list entry for
2823 a \addtoindex{range list} 
2824 are identical to a base address selection entry
2825 and end-of-list entry, respectively, for a location list
2826 (see Section \refersec{chap:locationlists}) 
2827 in interpretation and representation.}
2828
2829
2830 \section{Entry Address}
2831 \label{chap:entryaddress}
2832 \textit{The entry or first executable instruction generated
2833 for an entity, if applicable, is often the lowest addressed
2834 instruction of a contiguous range of instructions. In other
2835 cases, the entry address needs to be specified explicitly.}
2836
2837 Any debugging information entry describing an entity that has
2838 a range of code addresses, which includes compilation units,
2839 module initialization, subroutines, 
2840 \livelink{chap:lexicalblock}{lexical \nolink{blocks}},
2841 \livelink{chap:tryandcatchblockentries}{try/catch \nolink{blocks}},
2842 and the like, may have a \DWATentrypcDEFN{} attribute 
2843 \addtoindexx{entry PC address} to indicate the 
2844 \definitionx{entry address} which is the address of the 
2845 instruction where execution should begin
2846 within that range\hypertarget{chap:entryaddressofscope}{}
2847 of addresses. 
2848 If the value of the \DWATentrypcNAME{} attribute is of
2849 class \CLASSaddress{} that address is the entry address;
2850 or, if it is of class
2851 \CLASSconstant, the value is an unsigned integer offset which, 
2852 when added to the base address of the function, gives the entry
2853 address. 
2854
2855
2856 If no \DWATentrypcNAME{} attribute is present,
2857 then the entry address is assumed to be the same as the
2858 base address of the containing scope.
2859
2860
2861 \section{Static and Dynamic Values of Attributes}
2862 \label{chap:staticanddynamicvaluesofattributes}
2863
2864 Some attributes that apply to types specify a property (such
2865 as the lower bound of an array) that is an integer value,
2866 where the value may be known during compilation or may be
2867 computed dynamically during execution.
2868
2869 \needlines{5}
2870 The value of these
2871 attributes is determined based on the class as follows:
2872 \begin{itemize}
2873 \item For a \livelink{chap:classconstant}{constant}, the value 
2874 of the constant is the value of the attribute.
2875
2876 \item For a \livelink{chap:classreference}{reference}, the
2877 value is a reference to another debugging information entry.  
2878 This entry may:
2879 \begin{itemize}
2880 \renewcommand{\itemsep}{0cm}
2881 \item describe a constant which is the attribute value,
2882 \item describe a variable which contains the attribute value, or
2883 \item contain a \DWATlocation{} attribute whose value is a
2884       DWARF expression which computes the attribute value
2885       (for example, a \DWTAGdwarfprocedure{} entry).
2886 \end{itemize}
2887
2888 \item For an \livelink{chap:classexprloc}{exprloc}, the value 
2889 is interpreted as a DWARF expression; evaluation of the expression 
2890 yields the value of the attribute.
2891 \end{itemize}
2892
2893
2894 \needlines{4}
2895 \section{Entity Descriptions}
2896 \textit{Some debugging information entries may describe entities
2897 in the program that are artificial, or which otherwise have a 
2898 \doublequote{name} that is not a valid identifier in the
2899 programming language. 
2900 This attribute provides a means for the producer to indicate
2901 the purpose or usage of the containing debugging infor}
2902
2903 Generally, any debugging information entry that 
2904 has,\hypertarget{chap:DWATdescriptionartificialnameordescription}{}
2905 or may have, a \DWATname{} attribute, may also have a
2906 \addtoindexx{description attribute}
2907 \DWATdescriptionDEFN{} attribute whose value is a
2908 null-terminated string providing a description of the entity.
2909
2910 \textit{It is expected that a debugger will 
2911 display these descriptions as part of 
2912 displaying other properties of an entity.}
2913
2914 \needlines{4}
2915 \section{Byte and Bit Sizes}
2916 \label{chap:byteandbitsizes}
2917 % Some trouble here with hbox full, so we try optional word breaks.
2918 Many debugging information entries allow either a
2919 \DWATbytesizeNAME{} attribute or a 
2920 \DWATbitsizeNAME{} attribute,
2921 whose \livelink{chap:classconstant}{integer constant} value 
2922 (see Section \ref{chap:staticanddynamicvaluesofattributes}) 
2923 specifies an
2924 amount of storage. The value of the 
2925 \DWATbytesizeDEFN{} attribute
2926 is interpreted in bytes and the value of the 
2927 \DWATbitsizeDEFN{}
2928 attribute is interpreted in bits. The
2929 \DWATstringlengthbytesize{} and 
2930 \DWATstringlengthbitsize{} 
2931 attributes are similar.
2932
2933 In addition, the \livelink{chap:classconstant}{integer constant}
2934 value of a \DWATbytestride{} attribute is interpreted
2935 in bytes and the \livelink{chap:classconstant}{integer constant} value of a 
2936 \DWATbitstride{}
2937 attribute is interpreted in bits.
2938
2939 \section{Linkage Names}
2940 \label{chap:linkagenames}
2941 \textit{Some language implementations, notably 
2942 \addtoindex{C++} and similar
2943 languages, make use of implementation-defined names within
2944 object files that are different from the \addtoindex{identifier names}
2945 (see Section \refersec{chap:identifiernames}) of entities as they 
2946 appear in the source. Such names, sometimes known as 
2947 \addtoindex{mangled names}\addtoindexx{names!mangled},
2948 are used in various ways, such as: to encode additional
2949 information about an entity, to distinguish multiple entities
2950 that have the same name, and so on. When an entity has an
2951 associated distinct linkage name it may sometimes be useful
2952 for a producer to include this name in the DWARF description
2953 of the program to facilitate consumer access to and use of
2954 object file information about an entity and/or information
2955 that is encoded in the linkage name itself.  
2956 }
2957
2958 % Some trouble maybe with hbox full, so we try optional word breaks.
2959 A debugging information entry may have a
2960 \DWATlinkagenameDEFN{}\hypertarget{chap:DWATlinkagenameobjectfilelinkagenameofanentity}{}
2961 attribute\addtoindexx{linkage name attribute}
2962 whose value is a null-terminated string containing the 
2963 object file linkage name associated with the corresponding entity.
2964
2965
2966 \section{Template Parameters}
2967 \label{chap:templateparameters}
2968 \textit{In \addtoindex{C++}, a template is a generic definition 
2969 of a class, function, member function, or typedef (alias).  
2970 A template has formal parameters that
2971 can be types or constant values; the class, function,
2972 member function, or typedef is instantiated differently for each
2973 distinct combination of type or value actual parameters.  DWARF does
2974 not represent the generic template definition, but does represent each
2975 instantiation.}
2976
2977 A debugging information entry that represents a 
2978 \addtoindex{template instantiation}
2979 will contain child entries describing the actual template parameters.
2980 The containing entry and each of its child entries reference a template
2981 parameter entry in any circumstance where the template definition
2982 referenced a formal template parameter.
2983
2984 A template type parameter is represented by a debugging information
2985 entry with the tag
2986 \addtoindexx{template type parameter entry}
2987 \DWTAGtemplatetypeparameterTARG. 
2988 A template value parameter is represented by a debugging information
2989 entry with the tag
2990 \addtoindexx{template value parameter entry}
2991 \DWTAGtemplatevalueparameterTARG.
2992 The actual template parameter entries appear in the same order as the 
2993 corresponding template formal parameter declarations in the 
2994 source program.
2995
2996 \needlines{4}
2997 A type or value parameter entry may have a \DWATname{} attribute, 
2998 \addtoindexx{name attribute}
2999 whose value is a
3000 null-terminated string containing the name of the corresponding 
3001 formal parameter. The entry may also have a 
3002 \DWATdefaultvalue{} attribute, which is a flag indicating 
3003 that the value corresponds to the default argument for the 
3004 template parameter.
3005
3006 A\addtoindexx{formal type parameter|see{template type parameter entry}}
3007 template type parameter entry has a
3008 \DWATtype{} attribute\addtoindexx{type attribute}
3009 describing the actual type by which the formal is replaced.
3010
3011 A template value parameter entry has a \DWATtype{} attribute 
3012 describing the type of the parameterized value.
3013 The entry also has an attribute giving the 
3014 actual compile-time or run-time constant value 
3015 of the value parameter for this instantiation.
3016 This can be a 
3017 \DWATconstvalueDEFN{} attribute, 
3018 \addtoindexx{constant value attribute}
3019 \livetarg{chap:DWATconstvaluetemplatevalueparameter}{} 
3020 whose value is the compile-time constant value 
3021 as represented on the target architecture, or a 
3022 \DWATlocation{} attribute, whose value is a 
3023 single location description for the run-time constant address.
3024
3025 \section{Alignment}
3026 \label{chap:alignment}
3027 \livetarg{chap:DWATalignmentnondefault}{}
3028 A debugging information entry may have a 
3029 \DWATalignmentDEFN{} attribute\addtoindexx{alignment attribute}
3030 whose value of class \CLASSconstant{} is
3031 a positive, non-zero, integer describing the 
3032 alignment of the entity. 
3033
3034 \textit{For example, an alignment attribute whose value is 8 indicates
3035 that the entity to which it applies occurs at an address that is a
3036 multiple of eight (not a multiple of $2^8$ or 256).}
3037