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