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