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