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