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