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