Review copy for general distribution to Committee. Includes changes
[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:DWATstartscopeofdeclaration}
701         {Reduced scope of declaration}
702         {reduced scope of declaration} \\*
703 \DWATstaticlinkTARG
704 &\livelinki{chap:DWATstaticlinklocationofuplevelframe}
705         {Location of uplevel frame}
706         {location of uplevel frame} \\
707 \DWATstmtlistTARG
708 &\livelinki{chap:DWATstmtlistlinenumberinformationforunit}
709            {Line number information for unit}
710            {line number information for unit}\\
711 \DWATstringlengthTARG
712 &\livelinki{chap:DWATstringlengthstringlengthofstringtype}
713            {String length of string type}
714            {string length of string type} \\
715 \DWATstringlengthbitsizeTARG
716 &\livelinki{chap:DWATstringlengthstringlengthofstringtype}
717            {Size of string length of string type}
718            {string length of string type!size of} \\
719 \DWATstringlengthbytesizeTARG
720 &\livelinki{chap:DWATstringlengthstringlengthofstringtype}
721            {Size of string length of string type}
722            {string length of string type!size of} \\
723 \DWATstroffsetsbaseTARG
724 &\livelinki{chap:DWATstroffsetbaseforindirectstringtable}
725         {Base of string offsets table}
726         {string offsets table} \\
727 \DWATthreadsscaledTARG
728 &\livelink{chap:DWATthreadsscaledupcarrayboundthreadsscalfactor}
729         {UPC array bound THREADS scale factor}\\
730 \DWATtrampolineTARG
731 &\livelinki{chap:DWATtrampolinetargetsubroutine}
732         {Target subroutine}
733         {target subroutine of trampoline} \\
734 \DWATtypeTARG
735 &\livelinki{chap:DWATtypeofcallsite}
736         {Type of call site}
737         {type!of call site} \\
738 &\livelinki{chap:DWAATtypeofstringtype}
739         {Type of string type components}
740         {type!of string type components} \\
741 &\livelinki{chap:DWATtypetypeofsubroutinereturn}
742         {Type of subroutine return}
743         {type!of subroutine return} \\
744 &\livelinki{chap:DWATtypetypeofdeclaration}
745         {Type of declaration}
746         {type!of declaration} \\
747 \DWATupperboundTARG
748 &\livelinki{chap:DWATupperboundupperboundofsubrange}
749         {Upper bound of subrange}
750         {upper bound of subrange} \\
751 \DWATuselocationTARG
752 &\livelinki{chap:DWATuselocationmemberlocationforpointertomembertype}
753         {Member location for pointer to member type}
754         {member location for pointer to member type} \\
755 \DWATuseUTFeightTARG\addtoindexx{use UTF8 attribute}\addtoindexx{UTF-8}
756 &\livelinki{chap:DWATuseUTF8compilationunitusesutf8strings}
757         {Compilation unit uses UTF-8 strings}
758         {compilation unit uses UTF-8 strings} \\
759 \DWATvariableparameterTARG
760 &\livelinki{chap:DWATvariableparameternonconstantparameterflag}
761         {Non-constant parameter flag}
762         {non-constant parameter flag}  \\
763 \DWATvirtualityTARG
764 \bb
765 &\livelinki{chap:DWATvirtualityvirtualityindication}
766         {virtuality attribute} 
767         {Virtuality of member function or base class}
768 \eb
769         \\
770 \DWATvisibilityTARG
771 &\livelinki{chap:DWATvisibilityvisibilityofdeclaration}
772         {Visibility of declaration}
773         {visibility of declaration} \\
774 \DWATvtableelemlocationTARG
775 &\livelinki{chap:DWATvtableelemlocationvirtualfunctiontablevtableslot}
776         {Virtual function vtable slot}
777         {virtual function vtable slot}\\
778 \end{longtable}
779
780 \addtoindexx{address|see {\textit{also} address class}}
781 \addtoindexx{addrptr|see {\textit{also} addrptr class}}
782 \addtoindexx{block|see {\textit{also} block class}}
783 \addtoindexx{constant|see {\textit{also} constant class}}
784 \addtoindexx{exprloc|see {\textit{also} exprloc class}}
785 \addtoindexx{flag|see {\textit{also} flag class}}
786 \addtoindexx{lineptr|see {\textit{also} lineptr class}}
787 \addtoindexx{loclistptr|see {\textit{also} loclistptr class}}
788 \addtoindexx{macptr|see {\textit{also} macptr class}}
789 \addtoindexx{rangelistptr|see {\textit{also} rangelistptr class}}
790 \addtoindexx{reference|see {\textit{also} reference class}}
791 \addtoindexx{string|see {\textit{also} string class}}
792 \addtoindexx{stroffsetsptr|see {\textit{also} stroffsetsptr class}}
793
794 \addtoindexx{class of attribute value!address|see {address class}}
795 \addtoindexx{class of attribute value!addrptr|see {addrptr class}}
796 \addtoindexx{class of attribute value!block|see {block class}}
797 \addtoindexx{class of attribute value!constant|see {constant class}}
798 \addtoindexx{class of attribute value!exprloc|see {exprloc class}}
799 \addtoindexx{class of attribute value!flag|see {flag class}}
800 \addtoindexx{class of attribute value!lineptr|see {lineptr class}}
801 \addtoindexx{class of attribute value!loclistptr|see {loclistptr class}}
802 \addtoindexx{class of attribute value!macptr|see {macptr class}}
803 \addtoindexx{class of attribute value!rangelistptr|see {rangelistptr class}}
804 \addtoindexx{class of attribute value!reference|see {reference class}}
805 \addtoindexx{class of attribute value!string|see {string class}}
806 \addtoindexx{class of attribute value!stroffsetsptr|see {stroffsetsptr class}}
807
808 \needlines{6}
809 The permissible values
810 \addtoindexx{attribute value classes}
811 for an attribute belong to one or more classes of attribute
812 value forms.  
813 Each form class may be represented in one or more ways. 
814 For example, some attribute values consist
815 of a single piece of constant data. 
816 \doublequote{Constant data}
817 is the class of attribute value that those attributes may have. 
818 There are several representations of constant data,
819 \bb
820 including fixed length data of one, two, four, eight or 16 bytes 
821 in size, 
822 \eb
823 and variable length data). 
824 The particular representation for any given instance
825 of an attribute is encoded along with the attribute name as
826 part of the information that guides the interpretation of a
827 debugging information entry.  
828
829 \needlines{4}
830 Attribute value forms belong
831 \addtoindexx{tag names!list of}
832 to one of the classes shown in Table \referfol{tab:classesofattributevalue}.
833
834 \begin{longtable}{l|P{11cm}}
835 \caption{Classes of attribute value}
836 \label{tab:classesofattributevalue} \\
837 \hline \bfseries Attribute Class & \bfseries General Use and Encoding \\ \hline
838 \endfirsthead
839   \bfseries Attribute Class & \bfseries General Use and Encoding \\ \hline
840 \endhead
841   \hline \emph{Continued on next page}
842 \endfoot
843   \hline
844 \endlastfoot
845
846 \hypertarget{chap:classaddress}{}
847 \livelinki{datarep:classaddress}{address}{address class}
848 &Refers to some location in the address space of the \mbox{described} program.
849 \\
850
851 \hypertarget{chap:classaddrptr}{}
852 \livelinki{datarep:classaddrptr}{addrptr}{addrptr class}
853 &
854 \bb
855 Specifies a location in the DWARF section that holds
856 a series of machine address values. Certain attributes use
857 one of these addresses by indexing relative to this location.
858 \eb
859 \\
860
861 \hypertarget{chap:classblock}{}
862 \livelinki{datarep:classblock}{block}{block class}
863 & An arbitrary number of uninterpreted bytes of data.
864 \\
865  
866 \hypertarget{chap:classconstant}{}
867 \livelinki{datarep:classconstant}{constant}{constant class}
868 &One, two, four, eight 
869 \bb
870 or sixteen 
871 \eb
872 bytes of uninterpreted data, or data
873 encoded in the variable length format known as LEB128 
874 (see Section \refersec{datarep:variablelengthdata}).
875 \\
876
877 \hypertarget{chap:classexprloc}{}
878 \livelinki{datarep:classexprloc}{exprloc}{exprloc class}
879 &A DWARF expression for a value or a location in the \mbox{address} space of the described program.
880 \\
881
882 \hypertarget{chap:classflag}{}
883 \livelinki{datarep:classflag}{flag}{flag class}
884 &A small constant that indicates the presence or absence of an attribute.
885 \\
886
887 \hypertarget{chap:classlineptr}{}
888 \livelinki{datarep:classlineptr}{lineptr}{lineptr class}
889 &
890 \bb
891 Specifies
892 \eb
893 a location in the DWARF section that holds line number information.
894 \\
895
896 \hypertarget{chap:classloclistptr}{}
897 \livelinki{datarep:classloclistptr}{loclistptr}{loclistptr class}
898 &
899 \bb
900 Specifies
901 \eb
902 a location in the DWARF section that holds \mbox{location} lists, which
903 describe objects whose location can change during their lifetime.
904 \\
905
906 \hypertarget{chap:classmacptr}{}
907 \livelinki{datarep:classmacptr}{macptr}{macptr class}
908 &
909 \bb
910 Specifies 
911 \eb
912 a location in the DWARF section that holds macro definition
913 information.
914 \\
915
916 \hypertarget{chap:classrangelistptr}{}
917 \livelinki{datarep:classrangelistptr}{rangelistptr}{rangelistptr class}
918 &
919 \bb
920 Specifies 
921 \eb
922 a location in the DWARF section that holds non-contiguous address ranges.
923 \\
924
925 \hypertarget{chap:classreference}{}
926 \livelinki{datarep:classreference}{reference}{reference class}
927 &Refers to one of the debugging information
928 entries that \mbox{describe} the program.  There are four types of
929 \mbox{reference}. The first is an offset relative to the beginning
930 of the \mbox{compilation} unit in which the reference occurs and must
931 refer to an entry within that same compilation unit. The second
932 type of reference is the offset of a debugging \mbox{information}
933 entry in any compilation unit, including one different from
934 the unit containing the reference. The third type of reference
935 is an indirect reference to a 
936 \addtoindexx{type signature}
937 type definition using 
938 \bb
939 an 
940 \eb
941 8-byte \mbox{signature} 
942 for that type. The fourth type of reference is a reference from within the 
943 \dotdebuginfo{} section of the executable or shared object file to
944 a debugging information entry in the \dotdebuginfo{} section of 
945 a \addtoindex{supplementary object file}.
946 \\
947
948 \hypertarget{chap:classstring}{}
949 \livelinki{datarep:classstring}{string}{string class}
950 & A null-terminated sequence of zero or more
951 (non-null) bytes. Data in this class are generally
952 printable strings. Strings may be represented directly in
953 the debugging \mbox{information} entry or as an offset in a separate
954 string table.
955 \\
956
957 \hypertarget{chap:classstroffsetsptr}{}
958 \livelinki{datarep:classstroffsetsptr}{stroffsetsptr}{stroffsetsptr class}
959 &
960 \bb
961 Specifies a
962 \eb
963 location in the DWARF section that holds
964 a series of offsets 
965 \bb
966 into 
967 \eb
968 the DWARF section that holds strings.
969 Certain attributes 
970 \bb
971 use 
972 \eb
973 one of these offsets by indexing 
974 \mbox{relative} to this location. The resulting offset is then 
975 used to index into the DWARF string section.
976 \\
977
978 \hline
979 \end{longtable}
980
981
982 \section{Relationship of Debugging Information Entries}
983 \label{chap:relationshipofdebugginginformationentries}
984 \textit{%
985 A variety of needs can be met by permitting a single
986 \addtoindexx{debugging information entry!ownership relation}
987 debugging information entry to \doublequote{own} an arbitrary number
988 of other debugging entries and by permitting the same debugging
989 information entry to be one of many owned by another debugging
990 information entry. 
991 This makes it possible, for example, to
992 describe the static \livelink{chap:lexicalblock}{block} structure 
993 within a source file,
994 to show the members of a structure, union, or class, and to
995 associate declarations with source files or source files
996 with shared object files.  
997 }
998
999
1000 The ownership relation 
1001 \addtoindexx{debugging information entry!ownership relation}
1002 of debugging
1003 information entries is achieved naturally because the debugging
1004 information is represented as a tree. The nodes of the tree
1005 are the debugging information entries themselves. 
1006 The child entries of any node are exactly those debugging information
1007 entries owned by that node.  
1008
1009 \needlines{4}
1010 \textit{%
1011 While the ownership relation
1012 of the debugging information entries is represented as a
1013 tree, other relations among the entries exist, for example,
1014 a reference from an entry representing a variable to another
1015 entry representing the type of that variable. 
1016 If all such
1017 relations are taken into account, the debugging entries
1018 form a graph, not a tree.  
1019 }
1020
1021 \needlines{4}
1022 The tree itself is represented
1023 by flattening it in prefix order. 
1024 Each debugging information
1025 entry is defined either to have child entries or not to have
1026 child entries (see Section \refersec{datarep:abbreviationstables}). 
1027 If an entry is defined not
1028 to have children, the next physically succeeding entry is a
1029 sibling. 
1030 If an entry is defined to have children, the next
1031 physically succeeding entry is its first child. 
1032 Additional
1033 children are represented as siblings of the first child. 
1034 A chain of sibling entries is terminated by a null entry.
1035
1036 In cases where a producer of debugging information feels that
1037 it\hypertarget{chap:DWATsiblingdebugginginformationentryrelationship}{}
1038 will be important for consumers of that information to
1039 quickly scan chains of sibling entries, while ignoring the
1040 children of individual siblings, that producer may attach a
1041 \addtoindexx{sibling attribute}
1042 \DWATsiblingDEFN{} attribute 
1043 to any debugging information entry. 
1044 The value of this attribute is a reference to the sibling entry
1045 of the entry to which the attribute is attached.
1046
1047 \bb
1048 \section{Target Addresses}
1049 \label{chap:targetaddressableunitsandaddresses}
1050 \label{chap:targetaddresses}
1051 \eb
1052 \addtoindexx{size of an address}
1053 \addtoindexx{size of an address|see{\textit{also} \texttt{address\_size}}}
1054 \addtoindexx{address size|see{size of an address}}
1055 \addtoindexx{address size|see{\textit{also} \texttt{address\_size}}}
1056
1057 \bb
1058 Addresses, bytes and bits in DWARF use the numbering and direction
1059 conventions that are appropriate to the current language on
1060 the target system.
1061 \eb
1062
1063 Many places in this document refer to the size of an address
1064 on the target architecture (or equivalently, target machine)
1065 to which a DWARF description applies. For processors which
1066 can be configured to have different address sizes or different
1067 instruction sets, the intent is to refer to the configuration
1068 which is either the default for that processor or which is
1069 specified by the object file or executable file which contains
1070 the DWARF information.
1071
1072 \textit{%
1073 For example, if a particular target architecture supports
1074 both 32-bit and 64-bit addresses, the compiler will generate
1075 an object file which specifies that it contains executable
1076 code generated for one or the other of these 
1077 \addtoindexx{size of an address}
1078 address sizes. In
1079 that case, the DWARF debugging information contained in this
1080 object file will use the same address size.}
1081
1082 \bbpareb
1083
1084 \needlines{6}
1085 \section{DWARF Expressions}
1086 \label{chap:dwarfexpressions}
1087 DWARF expressions describe how to compute a value or 
1088 \bb
1089 specify a location.
1090 \eb
1091 They are expressed in
1092 terms of DWARF operations that operate on a stack of values.
1093
1094 \bb
1095 A DWARF expression is encoded as a stream of operations, 
1096 each consisting of an opcode
1097 \eb
1098 followed by zero or more literal operands. 
1099 The number of operands is 
1100 \bb
1101 implied 
1102 \eb
1103 by the opcode.  
1104
1105 In addition to the
1106 general operations that are defined here, operations that are
1107 specific to location descriptions are defined in 
1108 Section \refersec{chap:locationdescriptions}.
1109
1110 \subsection{General Operations}
1111 \label{chap:generaloperations}
1112 Each general operation represents a postfix operation on
1113 a simple stack machine. 
1114 Each element of the stack has a type and a value, and can represent
1115 a value of any supported base type of the target machine.  Instead of
1116 a base type, elements can have a 
1117 \definitionx{special address type}\livetarg{chap:specialaddresstype}{},
1118 which is an integral type that has the 
1119 \addtoindex{size of an address} on the target machine and 
1120 unspecified signedness. The value on the top of the stack after 
1121 \doublequote{executing} the 
1122 \addtoindex{DWARF expression}
1123 is 
1124 \addtoindexx{DWARF expression|see{\textit{also} location description}}
1125 taken to be the result (the address of the object, the
1126 value of the array bound, the length of a dynamic string,
1127 the desired value itself, and so on).
1128
1129 \bbpareb
1130
1131 \needlines{4}
1132 \subsubsection{Literal Encodings}
1133 \label{chap:literalencodings}
1134 The 
1135 \addtoindexx{DWARF expression!literal encodings}
1136 following operations all push a value onto the DWARF
1137 stack. 
1138 \addtoindexx{DWARF expression!stack operations}
1139 Operations other than \DWOPconsttype{} push a value with the 
1140 \specialaddresstype, and if the value of a constant in one of these 
1141 operations is larger than can be stored in a single stack element, 
1142 the value is truncated to the element size and the low-order bits
1143 are pushed on the stack.
1144 \begin{enumerate}[1. ]
1145 \itembfnl{\DWOPlitzeroTARG, \DWOPlitoneTARG, \dots, \DWOPlitthirtyoneTARG}
1146 The \DWOPlitnTARG{} operations encode the unsigned literal values
1147 from 0 through 31, inclusive.
1148
1149 \itembfnl{\DWOPaddrTARG}
1150 The \DWOPaddrNAME{} operation has a single operand that encodes
1151 a machine address and whose size is the \addtoindex{size of an address}
1152 on the target machine.
1153
1154 \itembfnl{\DWOPconstoneuTARG, \DWOPconsttwouTARG, \DWOPconstfouruTARG, \DWOPconsteightuTARG}
1155 \DWOPconstnxMARK{}
1156 The single operand of a \DWOPconstnuNAME{} operation provides a 1,
1157 2, 4, or 8-byte unsigned integer constant, respectively.
1158
1159 \itembfnl{\DWOPconstonesTARG, \DWOPconsttwosTARG, \DWOPconstfoursTARG, \DWOPconsteightsTARG}
1160 The single operand of a \DWOPconstnsNAME{} operation provides a 1,
1161 2, 4, or 8-byte signed integer constant, respectively.
1162
1163 \needlines{4}
1164 \itembfnl{\DWOPconstuTARG}
1165 The single operand of the \DWOPconstuNAME{} operation provides
1166 an unsigned LEB128\addtoindexx{LEB128!unsigned} integer constant.
1167
1168 \itembfnl{\DWOPconstsTARG}
1169 The single operand of the \DWOPconstsNAME{} operation provides
1170 a signed LEB128\addtoindexx{LEB128!unsigned} integer constant.
1171
1172 \needlines{4}
1173 \itembfnl{\DWOPaddrxTARG}
1174 The \DWOPaddrxNAME{} operation has a single operand that
1175 encodes an unsigned LEB128\addtoindexx{LEB128!unsigned} value, 
1176 which is a zero-based index into the \dotdebugaddr{} section, 
1177 where a machine address is stored.
1178 This index is relative to the value of the 
1179 \DWATaddrbase{} attribute of the associated compilation unit.
1180
1181 \itembfnl{\DWOPconstxTARG}
1182 The \DWOPconstxNAME{} operation has a single operand that
1183 encodes an unsigned LEB128\addtoindexx{LEB128!unsigned} value, 
1184 which is a zero-based
1185 index into the \dotdebugaddr{} section, where a constant, the
1186 size of a machine address, is stored.
1187 This index is relative to the value of the 
1188 \DWATaddrbase{} attribute of the associated compilation unit.
1189
1190 \needlines{3}
1191 \textit{The \DWOPconstxNAME{} operation is provided for constants that
1192 require link-time relocation but should not be
1193 interpreted by the consumer as a relocatable address
1194 (for example, offsets to thread-local storage).}
1195
1196 \needlines{12}
1197 \itembfnl{\DWOPconsttypeTARG}
1198 The \DWOPconsttypeNAME{} operation takes three operands. The first operand 
1199 is an unsigned LEB128 integer that represents the offset of a debugging
1200 information entry in the current compilation unit, which must be a
1201 \DWTAGbasetype{} entry that provides the type of the constant provided. The
1202 second operand is 1-byte unsigned integer that specifies the size of the
1203 constant value, which is the same as the size of the base type referenced
1204 by the first operand. The third operand is a 
1205 \bb
1206 sequence of bytes of the given size that is 
1207 \eb
1208 interpreted as a value of the referenced type.
1209
1210 \textit{While the size of the constant can be inferred from the base type
1211 definition, it is encoded explicitly into the operation so that the
1212 operation can be parsed easily without reference to the \dotdebuginfo{}
1213 section.}
1214
1215 \end{enumerate}
1216
1217 \needlines{10}
1218 \subsubsection{Register Values}
1219 \label{chap:registervalues}
1220 The following operations push a value onto the stack that is either the
1221 contents of a register or the result of adding the contents of a register
1222 to a given signed offset. 
1223 \addtoindexx{DWARF expression!register based addressing}
1224 \DWOPregvaltype{} pushes the contents
1225 of the register together with the given base type, while the other operations
1226 push the result of adding the contents of a register to a given
1227 signed offset together with the \specialaddresstype.
1228
1229 \needlines{8}
1230 \begin{enumerate}[1. ]
1231 \itembfnl{\DWOPfbregTARG}
1232 The \DWOPfbregNAME{} operation provides a 
1233 signed LEB128\addtoindexx{LEB128!signed} offset
1234 from the address specified by the location description in the
1235 \DWATframebase{} attribute of the current function.
1236  
1237 \bb
1238 \textit{This is typically a stack pointer register plus or minus some offset.}
1239 \eb
1240
1241 \itembfnl{\DWOPbregzeroTARG, \DWOPbregoneTARG, \dots, \DWOPbregthirtyoneTARG}
1242 The single operand of the \DWOPbregnTARG{} 
1243 operations provides
1244 a signed LEB128\addtoindexx{LEB128!signed} offset from
1245 \bb
1246 the contents of
1247 \eb
1248 the specified register.
1249
1250 \itembfnl{\DWOPbregxTARG}
1251 The \DWOPbregxNAME{} operation provides the sum of two values specified
1252 by its two operands. The first operand is a register number
1253 which is specified by an unsigned LEB128\addtoindexx{LEB128!unsigned}
1254 number. The second operand is a signed LEB128\addtoindexx{LEB128!signed} offset.
1255
1256 \needlines{8}
1257 \itembfnl{\DWOPregvaltypeTARG}
1258 The \DWOPregvaltypeNAME{} operation provides the contents of
1259 a given register interpreted as a value of a given type. The first 
1260 operand is an unsigned LEB128\addtoindexx{LEB128!unsigned} number, 
1261 which identifies a register whose contents is to
1262 be pushed onto the stack. The second operand is an 
1263 unsigned LEB128\addtoindexx{LEB128!unsigned} number
1264 that represents the offset of a debugging information entry in the current
1265 compilation unit, which must be a \DWTAGbasetype{} entry that provides the
1266 type of the value contained in the specified register.
1267
1268 \end{enumerate}
1269
1270 \needlines{6}
1271 \subsubsection{Stack Operations}
1272 \label{chap:stackoperations}
1273 The following 
1274 \addtoindexx{DWARF expression!stack operations}
1275 operations manipulate the DWARF stack. Operations
1276 that index the stack assume that the top of the stack (most
1277 recently added entry) has index 0.
1278
1279 \bb
1280 Each entry on the stack has an associated type.
1281 \eb
1282
1283 \needlines{4}
1284 \begin{enumerate}[1. ]
1285 \itembfnl{\DWOPdupTARG}
1286 The \DWOPdupNAME{} operation duplicates the value (including its 
1287 type identifier) at the top of the stack.
1288
1289 \itembfnl{\DWOPdropTARG}
1290 The \DWOPdropNAME{} operation pops the value (including its type 
1291 identifier) at the top of the stack.
1292
1293 \itembfnl{\DWOPpickTARG}
1294 The single operand of the \DWOPpickNAME{} operation provides a
1295 1-byte index. A copy of the stack entry (including its 
1296 type identifier) with the specified
1297 index (0 through 255, inclusive) is pushed onto the stack.
1298
1299 \itembfnl{\DWOPoverTARG}
1300 The \DWOPoverNAME{} operation duplicates the entry currently second
1301 in the stack at the top of the stack. 
1302 This is equivalent to a
1303 \DWOPpick{} operation, with index 1.  
1304
1305 \needlines{4}
1306 \itembfnl{\DWOPswapTARG}
1307 The \DWOPswapNAME{} operation swaps the top two stack entries. 
1308 The entry at the top of the stack (including its type identifier)
1309 becomes the second stack entry, and the second entry (including 
1310 its type identifier) becomes the top of the stack.
1311
1312 \itembfnl{\DWOProtTARG}
1313 The \DWOProtNAME{} operation rotates the first three stack
1314 entries. The entry at the top of the stack (including its 
1315 type identifier) becomes the third stack entry, the second 
1316 entry (including its type identifier) becomes the top of 
1317 the stack, and the third entry (including its type identifier)
1318 becomes the second entry.
1319
1320 \itembfnl{\DWOPderefTARG}
1321 The \DWOPderefNAME{} operation pops the top stack entry and 
1322 treats it as an address. The popped value must have an integral type.
1323 The value retrieved from that address is pushed, 
1324 \bb
1325 and has the \specialaddresstype{}.
1326 \eb 
1327 The size of the data retrieved from the 
1328 \addtoindexi{dereferenced}{address!dereference operator}
1329 address is the \addtoindex{size of an address} on the target machine.
1330
1331 \needlines{6}
1332 \itembfnl{\DWOPderefsizeTARG}
1333 The \DWOPderefsizeNAME{} operation behaves like the 
1334 \DWOPderef{}
1335 operation: it pops the top stack entry and treats it as an
1336 address. The popped value must have an integral type.
1337 The value retrieved from that address is pushed,
1338 \bb
1339 and has the \specialaddresstype{}.
1340 \eb 
1341 In the \DWOPderefsizeNAME{} operation, however, the size in bytes
1342 of the data retrieved from the dereferenced address is
1343 specified by the single operand. This operand is a 1-byte
1344 unsigned integral constant whose value may not be larger
1345 than the size of the \specialaddresstype. The data
1346 retrieved is zero extended to the size of an address on the
1347 target machine before being pushed onto the expression stack.
1348
1349 \itembfnl{\DWOPdereftypeTARG}
1350 The \DWOPdereftypeNAME{} operation behaves like the \DWOPderefsize{} operation:
1351 it pops the top stack entry and treats it as an address. 
1352 The popped value must have an integral type.
1353 The value retrieved from that address is pushed together with a type identifier. 
1354 In the \DWOPdereftypeNAME{} operation, the size in
1355 bytes of the data retrieved from the dereferenced address is specified by
1356 the first operand. This operand is a 1-byte unsigned integral constant whose
1357 value which is the same as the size of the base type referenced
1358 by the second operand.
1359 The second operand is an unsigned LEB128 integer that
1360 represents the offset of a debugging information entry in the current
1361 compilation unit, which must be a \DWTAGbasetype{} entry that provides the
1362 type of the data pushed.
1363
1364 \textit{While the size of the pushed value could be inferred from the base 
1365 type definition, it is encoded explicitly into the operation so that the
1366 operation can be parsed easily without reference to the \dotdebuginfo{}
1367 section.}
1368
1369 \needlines{7}
1370 \itembfnl{\DWOPxderefTARG}
1371 The \DWOPxderefNAME{} operation provides an extended dereference
1372 mechanism. The entry at the top of the stack is treated as an
1373 address. The second stack entry is treated as an \doublequote{address
1374 space identifier} for those architectures that support
1375 \addtoindexi{multiple}{address space!multiple}
1376 address spaces. 
1377 Both of these entries must have integral type identifiers.
1378 The top two stack elements are popped,
1379 and a data item is retrieved through an implementation-defined
1380 address calculation and pushed as the new stack top together with the
1381 \specialaddresstype{} identifier.
1382 The size of the data retrieved from the 
1383 \addtoindexi{dereferenced}{address!dereference operator}
1384 address is the size of the \specialaddresstype.
1385
1386 \needlines{4}
1387 \itembfnl{\DWOPxderefsizeTARG}
1388 The \DWOPxderefsizeNAME{} operation behaves like the
1389 \DWOPxderef{} operation. The entry at the top of the stack is
1390 treated as an address. The second stack entry is treated as
1391 an \doublequote{address space identifier} for those architectures
1392 that support 
1393 \addtoindexi{multiple}{address space!multiple}
1394 address spaces. 
1395 Both of these entries must have integral type identifiers.
1396 The top two stack
1397 elements are popped, and a data item is retrieved through an
1398 implementation\dash defined address calculation and pushed as the
1399 new stack top. In the \DWOPxderefsizeNAME{} operation, however,
1400 the size in bytes of the data retrieved from the 
1401 \addtoindexi{dereferenced}{address!dereference operator}
1402 address is specified by the single operand. This operand is a
1403 1-byte unsigned integral constant whose value may not be larger
1404 than the \addtoindex{size of an address} on the target machine. The data
1405 retrieved is zero extended to the \addtoindex{size of an address} on the
1406 target machine before being pushed onto the expression stack together
1407 with the \specialaddresstype{} identifier.
1408
1409 \itembfnl{\DWOPxdereftypeTARG}
1410 The \DWOPxdereftypeNAME{} operation behaves like the \DWOPxderefsize{}
1411 operation: it pops the top two stack entries, treats them as an address and
1412 an address space identifier, and pushes the value retrieved. In the
1413 \DWOPxdereftypeNAME{} operation, the size in bytes of the data retrieved from
1414 the dereferenced address is specified by the first operand. This operand is
1415 a 1-byte unsigned integral constant whose value 
1416 value which is the same as the size of the base type referenced
1417 by the second operand. The second
1418 operand is an unsigned LEB128 integer that represents the offset of a
1419 debugging information entry in the current compilation unit, which must be a
1420 \DWTAGbasetype{} entry that provides the type of the data pushed.
1421
1422 \needlines{6}
1423 \itembfnl{\DWOPpushobjectaddressTARG}
1424 The \DWOPpushobjectaddressNAME{}
1425 operation pushes the address
1426 of the object currently being evaluated as part of evaluation
1427 of a user presented expression. This object may correspond
1428 to an independent variable described by its own debugging
1429 information entry or it may be a component of an array,
1430 structure, or class whose address has been dynamically
1431 determined by an earlier step during user expression
1432 evaluation.
1433
1434 \textit{This operator provides explicit functionality
1435 (especially for arrays involving descriptors) that is analogous
1436 to the implicit push of the base 
1437 \addtoindexi{address}{address!implicit push of base}
1438 of a structure prior to evaluation of a 
1439 \DWATdatamemberlocation{} 
1440 to access a data member of a structure. For an example, see 
1441 Appendix \refersec{app:aggregateexamples}.}
1442
1443 \needlines{4}
1444 \itembfnl{\DWOPformtlsaddressTARG}
1445 The \DWOPformtlsaddressNAME{} 
1446 operation pops a value from the stack, which must have an 
1447 integral type identifier, translates this
1448 value into an address in the 
1449 \addtoindex{thread-local storage}
1450 for a thread, and pushes the address 
1451 onto the stack together with the \specialaddresstype{} identifier. 
1452 The meaning of the value on the top of the stack prior to this 
1453 operation is defined by the run-time environment.  If the run-time 
1454 environment supports multiple thread-local storage 
1455 \nolink{blocks} for a single thread, then the \nolink{block} 
1456 corresponding to the executable or shared 
1457 library containing this DWARF expression is used.
1458    
1459 \textit{Some implementations of 
1460 \addtoindex{C}, \addtoindex{C++}, \addtoindex{Fortran}, and other 
1461 languages, support a 
1462 thread-local storage class. Variables with this storage class
1463 have distinct values and addresses in distinct threads, much
1464 as automatic variables have distinct values and addresses in
1465 each function invocation. Typically, there is a single \nolink{block}
1466 of storage containing all thread\dash local variables declared in
1467 the main executable, and a separate \nolink{block} for the variables
1468 declared in each shared library. Each 
1469 thread\dash local variable can then be accessed in its block using an
1470 identifier. This identifier is typically an offset into the block and 
1471 pushed onto the DWARF stack by one of the 
1472 \DWOPconstnx{} operations prior to the
1473 \DWOPformtlsaddress{} operation. 
1474 Computing the address of
1475 the appropriate \nolink{block} can be complex (in some cases, the
1476 compiler emits a function call to do it), and difficult
1477 to describe using ordinary DWARF location descriptions.
1478 Instead of    forcing complex thread-local storage calculations into 
1479 the DWARF expressions, the \DWOPformtlsaddress{} allows the consumer 
1480 to perform the computation based on the run-time environment.}
1481
1482 \needlines{4}
1483 \itembfnl{\DWOPcallframecfaTARG}
1484 The \DWOPcallframecfaNAME{} 
1485 operation pushes the value of the
1486 CFA, obtained from the Call Frame Information 
1487 (see Section \refersec{chap:callframeinformation}).
1488
1489 \textit{Although the value of \DWATframebase{}
1490 can be computed using other DWARF expression operators,
1491 in some cases this would require an extensive location list
1492 because the values of the registers used in computing the
1493 CFA change during a subroutine. If the 
1494 Call Frame Information 
1495 is present, then it already encodes such changes, and it is
1496 space efficient to reference that.}
1497 \end{enumerate}
1498
1499 \textit{Examples illustrating many of these stack operations are
1500 found in Appendix \refersec{app:dwarfstackoperationexamples}.}
1501
1502 \needlines{4}
1503 \subsubsection{Arithmetic and Logical Operations} 
1504 \addtoindexx{DWARF expression!arithmetic operations}
1505 \addtoindexx{DWARF expression!logical operations}
1506 The following provide arithmetic and logical operations. 
1507 \bb
1508 Operands of an operation with two operands
1509 \eb
1510 must have the same type,
1511 either the same base type or both the \specialaddresstype.
1512 The result of the operation which is pushed back has the same type
1513 as the type of the operand(s).  
1514
1515 If the type of the operands is the \specialaddresstype, 
1516 except as otherwise specified, the arithmetic operations
1517 perform addressing arithmetic, that is, unsigned arithmetic that is performed
1518 modulo one plus the largest representable address (for example, 0x100000000
1519 when the \addtoindex{size of an address} is 32 bits). 
1520
1521 Operations other than \DWOPabs{},
1522 \DWOPdiv{}, \DWOPminus{}, \DWOPmul{}, \DWOPneg{} and \DWOPplus{} 
1523 require integral types of the operand (either integral base type 
1524 or the \specialaddresstype).  Operations do not cause an exception 
1525 on overflow.
1526
1527 \needlines{4}
1528 \begin{enumerate}[1. ]
1529 \itembfnl{\DWOPabsTARG}
1530 The \DWOPabsNAME{} operation pops the top stack entry, interprets
1531 it as a signed value and pushes its absolute value. If the
1532 absolute value cannot be represented, the result is undefined.
1533
1534 \needlines{4}
1535 \itembfnl{\DWOPandTARG}
1536 The \DWOPandNAME{} operation pops the top two stack values, performs
1537 a bitwise and operation on the two, and pushes the result.
1538
1539 \itembfnl{\DWOPdivTARG}
1540 The \DWOPdivNAME{} operation pops the top two stack values, divides the former second entry by
1541 the former top of the stack using signed division, and pushes the result.
1542
1543 \itembfnl{\DWOPminusTARG}
1544 The \DWOPminusNAME{} operation pops the top two stack values, subtracts the former top of the
1545 stack from the former second entry, and pushes the result.
1546
1547 \itembfnl{\DWOPmodTARG}
1548 The \DWOPmodNAME{} operation pops the top two stack values and pushes the result of the
1549 calculation: former second stack entry modulo the former top of the stack.
1550
1551 \needlines{4}
1552 \itembfnl{\DWOPmulTARG}
1553 The \DWOPmulNAME{} operation pops the top two stack entries, multiplies them together, and
1554 pushes the result.
1555
1556 \needlines{4}
1557 \itembfnl{\DWOPnegTARG}
1558 The \DWOPnegNAME{} operation pops the top stack entry, interprets
1559 it as a signed value and pushes its negation. If the negation
1560 cannot be represented, the result is undefined.
1561
1562 \itembfnl{\DWOPnotTARG}
1563 The \DWOPnotNAME{} operation pops the top stack entry, and pushes
1564 its bitwise complement.
1565
1566 \itembfnl{\DWOPorTARG}
1567 The \DWOPorNAME{} operation pops the top two stack entries, performs
1568 a bitwise or operation on the two, and pushes the result.
1569
1570 \itembfnl{\DWOPplusTARG}
1571 The \DWOPplusNAME{} operation pops the top two stack entries,
1572 adds them together, and pushes the result.
1573
1574 \needlines{6}
1575 \itembfnl{\DWOPplusuconstTARG}
1576 The \DWOPplusuconstNAME{} operation pops the top stack entry,
1577 adds it to the unsigned LEB128\addtoindexx{LEB128!unsigned}
1578 constant operand 
1579 \bb
1580 interpreted as the same type as the operand popped from the 
1581 top of the stack
1582 \eb
1583 and pushes the result.
1584
1585 \textit{This operation is supplied specifically to be
1586 able to encode more field offsets in two bytes than can be
1587 done with
1588 \doublequote{\DWOPlitn~\DWOPplus.}}
1589
1590 \needlines{3}
1591 \itembfnl{\DWOPshlTARG}
1592 The \DWOPshlNAME{} operation pops the top two stack entries,
1593 shifts the former second entry left (filling with zero bits)
1594 by the number of bits specified by the former top of the stack,
1595 and pushes the result.
1596
1597 \itembfnl{\DWOPshrTARG}
1598 The \DWOPshrNAME{} operation pops the top two stack entries,
1599 shifts the former second entry right logically (filling with
1600 zero bits) by the number of bits specified by the former top
1601 of the stack, and pushes the result.
1602
1603 \needlines{3}
1604 \itembfnl{\DWOPshraTARG}
1605 The \DWOPshraNAME{} operation pops the top two stack entries,
1606 shifts the former second entry right arithmetically (divide
1607 the magnitude by 2, keep the same sign for the result) by
1608 the number of bits specified by the former top of the stack,
1609 and pushes the result.
1610
1611 \itembfnl{\DWOPxorTARG}
1612 The \DWOPxorNAME{} operation pops the top two stack entries,
1613 performs a bitwise exclusive\dash or operation on the two, and
1614 pushes the result.
1615
1616 \end{enumerate}
1617
1618 \subsubsection{Control Flow Operations}
1619 \label{chap:controlflowoperations}
1620 The 
1621 \addtoindexx{DWARF expression!control flow operations}
1622 following operations provide simple control of the flow of a DWARF expression.
1623 \begin{enumerate}[1. ]
1624 \itembfnl{\DWOPleTARG, \DWOPgeTARG, \DWOPeqTARG, \DWOPltTARG, \DWOPgtTARG, \DWOPneTARG}
1625 The six relational operators each:
1626 \begin{itemize}
1627 \item pop the top two stack values, which \bb\eb have the same type,
1628 either the same base type or both the \specialaddresstype, 
1629
1630 \item compare the operands:
1631 \linebreak
1632 \textless~former second entry~\textgreater  \textless~relational operator~\textgreater \textless~former top entry~\textgreater
1633
1634 \item push the constant value 1 onto the stack 
1635 if the result of the operation is true or the
1636 constant value 0 if the result of the operation is false.
1637 The pushed value has the \specialaddresstype.
1638 \end{itemize}
1639
1640 If the operands have the \specialaddresstype, the comparisons  
1641 are performed as signed operations.
1642
1643 \needlines{6}
1644 \itembfnl{\DWOPskipTARG}
1645 \DWOPskipNAME{} is an unconditional branch. Its single operand
1646 is a 2-byte signed integer constant. The 2-byte constant is
1647 the number of bytes of the DWARF expression to skip forward
1648 or backward from the current operation, beginning after the
1649 2-byte constant.
1650
1651 \itembfnl{\DWOPbraTARG}
1652 \DWOPbraNAME{} is a conditional branch. Its single operand is a
1653 2-byte signed integer constant.  This operation pops the
1654 top of stack. If the value popped is not the constant 0,
1655 the 2-byte constant operand is the number of bytes of the
1656 DWARF expression to skip forward or backward from the current
1657 operation, beginning after the 2-byte constant.
1658
1659 % The following item does not correctly hyphenate leading
1660 % to an overfull hbox and a visible artifact. 
1661 % So we use \- to suggest hyphenation in this rare situation.
1662 \itembfnl{\DWOPcalltwoTARG, \DWOPcallfourTARG, \DWOPcallrefTARG}
1663 \DWOPcalltwoNAME, 
1664 \DWOPcallfourNAME, 
1665 and \DWOPcallrefNAME{} perform
1666 DWARF procedure calls during evaluation of a DWARF expression or
1667 location description. 
1668 For \DWOPcalltwoNAME{} and \DWOPcallfourNAME{}, 
1669 the operand is the 2\dash~ or 4-byte unsigned offset, respectively,
1670 of a debugging information entry in the current compilation
1671 unit. The \DWOPcallrefNAME{} operator has a single operand. In the
1672 \thirtytwobitdwarfformat,
1673 the operand is a 4-byte unsigned value;
1674 in the \sixtyfourbitdwarfformat, it is an 8-byte unsigned value
1675 (see Section \referfol{datarep:32bitand64bitdwarfformats}). 
1676 The operand is used as the offset of a
1677 debugging information entry in a 
1678 \dotdebuginfo{}
1679 section which may be contained in an executable or shared object file
1680 other than that containing the operator. For references from
1681 one executable or shared object file to another, the relocation
1682 must be performed by the consumer.  
1683
1684 \textit{Operand interpretation of
1685 \DWOPcalltwo, \DWOPcallfour{} and \DWOPcallref{} is exactly like
1686 that for \DWFORMreftwo, \DWFORMreffour{} and \DWFORMrefaddr,
1687 respectively  
1688 (see Section  \refersec{datarep:attributeencodings}).}
1689
1690 These operations transfer control of DWARF expression evaluation to 
1691 \addtoindexx{location attribute}
1692 the 
1693 \DWATlocation{}
1694 attribute of the referenced debugging information entry. If
1695 there is no such attribute, then there is no effect. Execution
1696 of the DWARF expression of 
1697 \addtoindexx{location attribute}
1698
1699 \DWATlocation{} attribute may add
1700 to and/or remove from values on the stack. Execution returns
1701 to the point following the call when the end of the attribute
1702 is reached. Values on the stack at the time of the call may be
1703 used as parameters by the called expression and values left on
1704 the stack by the called expression may be used as return values
1705 by prior agreement between the calling and called expressions.
1706 \end{enumerate}
1707
1708 \subsubsection{Type Conversions}
1709 \label{chap:typeconversions}
1710 The following operations provides for explicit type conversion.
1711
1712 \begin{enumerate}[1. ]
1713 \itembfnl{\DWOPconvertTARG}
1714 The \DWOPconvertNAME{} operation pops the top stack entry, converts it to a
1715 different type, then pushes the result. It takes one operand, which is an
1716 unsigned LEB128 integer that represents the offset of a debugging
1717 information entry in the current compilation unit, or value 0 which
1718 represents the \specialaddresstype. If the operand is non-zero, the
1719 referenced entry must be a \DWTAGbasetype{} entry that provides the type
1720 to which the value is converted.
1721
1722 \itembfnl{\DWOPreinterpretTARG}
1723 The \DWOPreinterpretNAME{} operation pops the top stack entry, reinterprets
1724 the bits in its value as a value of a different type, then pushes the
1725 result. It takes one operand, which is an unsigned LEB128 integer that
1726 represents the offset of a debugging information entry in the current
1727 compilation unit, or value 0 which represents the \specialaddresstype.
1728 If the operand is non-zero, the referenced entry must be a
1729 \DWTAGbasetype{} entry that provides the type to which the value is converted.
1730 The type of the operand and result type should have the same size in bits.
1731
1732 \end{enumerate}
1733
1734 \needlines{7}
1735 \subsubsection{Special Operations}
1736 \label{chap:specialoperations}
1737 There 
1738 \addtoindexx{DWARF expression!special operations}
1739 are these special operations currently defined:
1740 \begin{enumerate}[1. ]
1741 \itembfnl{\DWOPnopNAME}
1742 The \DWOPnopTARG{} operation is a place holder. It has no effect
1743 on the location stack or any of its values.
1744
1745 \itembfnl{\DWOPentryvalueNAME}
1746 The \DWOPentryvalueTARG{} operation pushes a value that had a known location
1747 upon entering the current subprogram.  It has two operands: an 
1748 unsigned LEB128\addtoindexx{LEB128!unsigned} length, followed by 
1749 a block containing a DWARF expression or a register location description 
1750 (see Section \refersec{chap:registerlocationdescriptions}).  
1751 The length operand specifies the length
1752 in bytes of the block.  If the block contains a register location
1753 description, \DWOPentryvalueNAME{} pushes the value that register had upon
1754 entering the current subprogram.  If the block contains a DWARF expression,
1755 the DWARF expression is evaluated as if it has been evaluated upon entering
1756 the current subprogram.  The DWARF expression 
1757 \bb
1758 assumes no values are present on the DWARF stack initially and results
1759 \eb
1760 in exactly one
1761 value being pushed on the DWARF stack when completed.
1762 \bb\eb 
1763
1764 \DWOPpushobjectaddress{} is not meaningful inside of this DWARF operation.
1765
1766 \textit{The \DWOPentryvalueNAME{} operation can be used by consumers if they are able
1767 to find the call site in the caller function, can unwind to it, and the corresponding
1768 \DWTAGcallsiteparameter{} entry has \DWATcallvalue{} or
1769 \DWATcalldatavalue{} attributes that can be evaluated to find the
1770 value a function parameter had on the first instruction in the function.
1771 Non-interactive consumers which know what variables will need to be
1772 inspected in advance of running the debugged program could put breakpoints
1773 on the first instruction in functions where there is no way to find
1774 some variable's value other than by evaluating the \DWOPentryvalueNAME{} 
1775 operation.  The consumer can collect the value of registers or 
1776 memory referenced in
1777 \DWOPentryvalueNAME{} operations, then continue to breakpoints where the values
1778 of variables or parameters need to be inspected and use the remembered
1779 register or memory values during \DWOPentryvalueNAME{} evaluation.}
1780
1781 \end{enumerate}
1782
1783 \needlines{8}
1784 \section{Location Descriptions}
1785 \label{chap:locationdescriptions}
1786 \textit{Debugging information 
1787 \addtoindexx{location description}
1788 must 
1789 \addtoindexx{location description|see{\textit{also} DWARF expression}}
1790 provide consumers a way to find
1791 the location of program variables, determine the bounds
1792 of dynamic arrays and strings, and possibly to find the
1793 base address of a subroutine\textquoteright s stack frame or the return
1794 address of a subroutine. Furthermore, to meet the needs of
1795 recent computer architectures and optimization techniques,
1796 debugging information must be able to describe the location of
1797 an object whose location changes over the object\textquoteright s lifetime.}
1798
1799 Information about the location of program objects is provided
1800 by location descriptions. Location descriptions can be either
1801 of two forms:
1802 \begin{enumerate}[1. ]
1803 \item \textit{Single location descriptions}, 
1804 which 
1805 \addtoindexx{location description!single}
1806 are 
1807 \addtoindexx{single location description}
1808 a language independent representation of
1809 addressing rules of arbitrary complexity built from 
1810 DWARF expressions (See Section \refersec{chap:dwarfexpressions}) 
1811 and/or other
1812 DWARF operations specific to describing locations. They are
1813 sufficient for describing the location of any object as long
1814 as its lifetime is either static or the same as the 
1815 \livelink{chap:lexicalblock}{lexical block} that owns it, 
1816 and it does not move during its lifetime.
1817
1818 \bbpareb
1819
1820 \needlines{4}
1821 \item \textit{Location lists}, which are used to 
1822 \addtoindexx{location list}
1823 describe
1824 \addtoindexx{location description!use in location list}
1825 objects that have a limited lifetime or change their location
1826 during their lifetime. Location lists are described in
1827 Section \refersec{chap:locationlists} below.
1828
1829 \end{enumerate}
1830
1831 Location descriptions are distinguished in a context sensitive
1832 manner. As the value of an attribute, a location description
1833 is encoded using 
1834 \addtoindexx{exprloc class}
1835 class \livelink{chap:classexprloc}{exprloc}  
1836 and a location list is encoded
1837 using class \livelink{chap:classloclistptr}{loclistptr}
1838 (which 
1839 \addtoindex{loclistptr}
1840 serves as an offset into a
1841 separate 
1842 \addtoindexx{location list}
1843 location list table).
1844
1845 \subsection{Single Location Descriptions}
1846 A single location description is either:
1847 \begin{enumerate}[1. ]
1848 \item A simple location description, representing an object
1849 \addtoindexx{location description!simple}
1850 which 
1851 \addtoindexx{simple location description}
1852 exists in one contiguous piece at the given location, or 
1853 \item A composite location description consisting of one or more
1854 \addtoindexx{location description!composite}
1855 simple location descriptions, each of which is followed by
1856 one composition operation. Each simple location description
1857 describes the location of one piece of the object; each
1858 composition operation describes which part of the object is
1859 located there. Each simple location description that is a
1860 DWARF expression is evaluated independently of any others.
1861 \bb\eb
1862 \end{enumerate}
1863
1864
1865
1866 \subsubsection{Simple Location Descriptions}
1867
1868 \addtoindexx{location description!simple}
1869 simple location description consists of one 
1870 contiguous piece or all of an object or value.
1871
1872 \bb
1873 \needlines{4}
1874 \subsubsubsection{Empty Location Descriptions}
1875 An \addtoindex{empty location description}
1876 consists of a DWARF expression
1877 \addtoindexx{location description!empty}
1878 containing no operations. It represents a piece or all of an
1879 object that is present in the source but not in the object code
1880 (perhaps due to optimization).
1881 \eb
1882
1883 \subsubsubsection{Memory Location Descriptions}
1884
1885 \addtoindexx{location description!memory}
1886 memory location description 
1887 \addtoindexx{memory location description}
1888 consists of a non-empty DWARF
1889 expression (see 
1890 Section \refersec{chap:dwarfexpressions}), 
1891 whose value is the address of
1892 a piece or all of an object or other entity in memory.
1893
1894 \subsubsubsection{Register Location Descriptions}
1895 \label{chap:registerlocationdescriptions}
1896 A register location description consists of a register name
1897 operation, which represents a piece or all of an object
1898 located in a given register.
1899
1900 \textit{Register location descriptions describe an object
1901 (or a piece of an object) that resides in a register, while
1902 the opcodes listed in 
1903 Section \refersec{chap:registervalues}
1904 are used to describe an object (or a piece of
1905 an object) that is located in memory at an address that is
1906 contained in a register (possibly offset by some constant). A
1907 register location description must stand alone as the entire
1908 description of an object or a piece of an object.
1909 }
1910
1911 The following DWARF operations can be used to 
1912 \bb
1913 specify a register location.
1914 \eb
1915
1916 \textit{Note that the register number represents a DWARF specific
1917 mapping of numbers onto the actual registers of a given
1918 architecture. The mapping should be chosen to gain optimal
1919 density and should be shared by all users of a given
1920 architecture. It is recommended that this mapping be defined
1921 by the ABI authoring committee for each architecture.
1922 }
1923 \begin{enumerate}[1. ]
1924 \itembfnl{\DWOPregzeroTARG, \DWOPregoneTARG, ..., \DWOPregthirtyoneTARG}
1925 The \DWOPregnTARG{} operations encode the names of up to 32
1926 registers, numbered from 0 through 31, inclusive. The object
1927 addressed is in register \textit{n}.
1928
1929 \needlines{4}
1930 \itembfnl{\DWOPregxTARG}
1931 The \DWOPregxNAME{} operation has a single 
1932 unsigned LEB128\addtoindexx{LEB128!unsigned} literal
1933 operand that encodes the name of a register.  
1934
1935 \end{enumerate}
1936
1937 \textit{These operations name a register location. To
1938 fetch the contents of a register, it is necessary to use
1939 one of the register based addressing operations, such as
1940 \DWOPbregx{} 
1941 (Section \refersec{chap:registervalues})}.
1942
1943 \subsubsubsection{Implicit Location Descriptions}
1944 An \addtoindex{implicit location description}
1945 represents a piece or all
1946 \addtoindexx{location description!implicit}
1947 of an object which has no actual location but whose contents
1948 are nonetheless either known or known to be undefined.
1949
1950 The following DWARF operations may be used to specify a value
1951 that has no location in the program but is a known constant
1952 or is computed from other locations and values in the program.
1953 \begin{enumerate}[1. ]
1954 \itembfnl{\DWOPimplicitvalueTARG}
1955 The \DWOPimplicitvalueNAME{} operation specifies an immediate value
1956 using two operands: an unsigned LEB128\addtoindexx{LEB128!unsigned}
1957 length, followed by a 
1958 \bb
1959 sequence of bytes of the given length that contain the value.
1960 \eb
1961
1962 \itembfnl{\DWOPstackvalueTARG}
1963 The \DWOPstackvalueNAME{} 
1964 operation specifies that the object
1965 does not exist in memory but its value is nonetheless known
1966 and is at the top of the DWARF expression stack. In this form
1967 of location description, the DWARF expression represents the
1968 actual value of the object, rather than its location. The
1969 \DWOPstackvalueNAME{} operation terminates the expression.
1970
1971 \needlines{4}
1972 \itembfnl{\DWOPimplicitpointerTARG}
1973 \bb
1974 \textit{An optimizing compiler may eliminate a pointer, while
1975 still retaining the value that the pointer addressed.  
1976 \DWOPimplicitpointerNAME{} allows a producer to describe this value.}
1977 \eb
1978
1979 The \DWOPimplicitpointerNAME{} operation specifies that the object
1980 is a pointer that cannot be represented as a real pointer,
1981 even though the value it would point to can be described. In
1982 this form of location description, the DWARF expression refers
1983 to a debugging information entry that represents the actual
1984 value of the object to which the pointer would point. Thus, a
1985 consumer of the debug information would be able to show the
1986 value of the dereferenced pointer, even when it cannot show
1987 the value of the pointer itself.
1988
1989 \needlines{5}
1990 The \DWOPimplicitpointerNAME{} operation has two operands: a 
1991 reference to a debugging information entry that describes 
1992 the dereferenced object's value, and a signed number that 
1993 is treated as a byte offset from the start of that value. 
1994 The first operand is a 4-byte unsigned value in the 32-bit 
1995 DWARF format, or an 8-byte unsigned value in the 64-bit 
1996 DWARF format (see Section 
1997 \refersec{datarep:32bitand64bitdwarfformats}).
1998 The second operand is a 
1999 signed LEB128\addtoindexx{LEB128!signed} number.
2000
2001 The first operand is used as the offset of a debugging
2002 information entry in a \dotdebuginfo{} section, which may be
2003 contained in an executable or shared object file other than that
2004 containing the operator. For references from one executable or
2005 shared object file to another, the relocation must be performed 
2006 by the consumer.
2007
2008 \textit{The debugging information entry referenced by a 
2009 \DWOPimplicitpointerNAME{} operation is typically a
2010 \DWTAGvariable{} or \DWTAGformalparameter{} entry whose
2011 \DWATlocation{} attribute gives a second DWARF expression or a
2012 location list that describes the value of the object, but the
2013 referenced entry may be any entry that contains a \DWATlocation{}
2014 or \DWATconstvalue{} attribute (for example, \DWTAGdwarfprocedure).
2015 By using the second DWARF expression, a consumer can
2016 reconstruct the value of the object when asked to dereference
2017 the pointer described by the original DWARF expression
2018 containing the \DWOPimplicitpointer{} operation.}
2019
2020 \end{enumerate}
2021
2022 \textit{DWARF location expressions are intended to yield the \textbf{location}
2023 of a value rather than the value itself. An optimizing compiler
2024 may perform a number of code transformations where it becomes
2025 impossible to give a location for a value, but it remains possible
2026 to describe the value itself. 
2027 Section \refersec{chap:registerlocationdescriptions}
2028 describes operators that can be used to
2029 describe the location of a value when that value exists in a
2030 register but not in memory. The operations in this section are
2031 used to describe values that exist neither in memory nor in a
2032 single register.}
2033
2034 \bbpareb
2035
2036 \needlines{6}
2037 \subsubsection{Composite Location Descriptions}
2038 A composite location description describes an object or
2039 value which may be contained in part of a register or stored
2040 in more than one location. Each piece is described by a
2041 composition operation, which does not compute a value nor
2042 store any result on the DWARF stack. There may be one or
2043 more composition operations in a single composite location
2044 description. A series of such operations describes the parts
2045 of a value in memory address order.
2046
2047 Each composition operation is immediately preceded by a simple
2048 location description which describes the location where part
2049 of the resultant value is contained.
2050 \begin{enumerate}[1. ]
2051 \itembfnl{\DWOPpieceTARG}
2052 The \DWOPpieceNAME{} operation takes a 
2053 single operand, which is an
2054 unsigned LEB128\addtoindexx{LEB128!unsigned} number.  
2055 The number describes the size in bytes
2056 of the piece of the object referenced by the preceding simple
2057 location description. If the piece is located in a register,
2058 but does not occupy the entire register, the placement of
2059 the piece within that register is defined by the ABI.
2060
2061 \textit{Many compilers store a single variable in sets of registers,
2062 or store a variable partially in memory and partially in
2063 registers. \DWOPpieceNAME{} provides a way of describing how large
2064 a part of a variable a particular DWARF location description
2065 refers to.}
2066
2067 \needlines{4}
2068 \itembfnl{\DWOPbitpieceTARG}
2069 The \DWOPbitpieceNAME{} 
2070 operation takes two operands. The first
2071 is an unsigned LEB128\addtoindexx{LEB128!unsigned} 
2072 number that gives the size in bits
2073 of the piece. The second is an 
2074 unsigned LEB128\addtoindexx{LEB128!unsigned} number that
2075 gives the offset in bits from the location defined by the
2076 preceding DWARF location description.  
2077
2078 Interpretation of the
2079 offset depends on the 
2080 \bb\eb
2081 location description. If the
2082 location description is empty, the offset doesn\textquoteright t matter and
2083 the \DWOPbitpieceNAME{} operation describes a piece consisting
2084 of the given number of bits whose values are undefined. If
2085 the location is a register, the offset is from the least
2086 significant bit end of the register. If the location is a
2087 memory address, the \DWOPbitpieceNAME{} operation describes a
2088 sequence of bits relative to the location whose address is
2089 on the top of the DWARF stack using the bit numbering and
2090 direction conventions that are appropriate to the current
2091 language on the target system. If the location is any implicit
2092 value or stack value, the \DWOPbitpieceNAME{} operation describes
2093 a sequence of bits using the least significant bits of that
2094 value.  
2095 \end{enumerate}
2096
2097 \textit{\DWOPbitpieceNAME{} is 
2098 used instead of \DWOPpieceNAME{} when
2099 the piece to be assembled into a value or assigned to is not
2100 byte-sized or is not at the start of a register or addressable
2101 unit of memory.}
2102
2103 \needlines{6}
2104 \subsection{Location Lists}
2105 \label{chap:locationlists}
2106 There are two forms of location lists. The first form 
2107 is intended for use in other than a \splitDWARFobjectfile,
2108 while the second is intended for use in a \splitDWARFobjectfile{} 
2109 (see Section \refersec{datarep:splitdwarfobjectfiles}). The two
2110 forms are otherwise equivalent.
2111
2112 \bbpareb
2113
2114 \needlines{4}
2115 \subsubsection{Location Lists in Non-split Objects}
2116 \label{chap:locationlistsinnonsplitobjects}
2117 Location lists 
2118 \addtoindexx{location list}
2119 are used in place of location expressions
2120 whenever the object whose location is being described
2121 can change location during its lifetime. 
2122 Location lists
2123 \addtoindexx{location list}
2124 are contained in a separate object file section called
2125 \dotdebugloc{}. A location list is indicated by a location
2126 attribute whose value is an offset from the beginning of
2127 the \dotdebugloc{} section to the first byte of the list for the
2128 object in question.
2129
2130 The \definitionx{applicable base address} of a normal
2131 location list entry (see following) is
2132 \addtoindexx{location list!base address selection entry}
2133 determined by the closest preceding base address selection
2134 entry in the same location list. If there is
2135 no such selection entry, then the applicable base address
2136 defaults to the base address of the compilation unit (see
2137 Section \refersec{chap:fullandpartialcompilationunitentries}).  
2138
2139 \textit{In the case of a compilation unit where all of
2140 the machine code is contained in a single contiguous section,
2141 no base address selection entry is needed.}
2142
2143 Each entry in a location list is either a location 
2144 \addtoindexi{list}{address selection|see{base address selection}} 
2145 entry,
2146
2147 \addtoindexi{base}{base address selection entry!in location list} 
2148 address selection entry, 
2149 \addtoindexx{location list!base address selection entry}
2150 or an 
2151 \addtoindexx{end-of-list entry!in location list}
2152 end-of-list entry.
2153
2154 \subsubsubsection{Location List Entry}
2155 A location list entry has two forms:
2156 a normal location list entry and a default location list entry.
2157
2158 \needlines{4}
2159 \subsubsubsubsection{Normal Location List Entry}
2160 A\addtoindexx{location list!normal entry}
2161 \addtoindex{normal location list entry} consists of:
2162 \begin{enumerate}[1. ]
2163 \item A beginning address offset. 
2164 This address offset has the \addtoindex{size of an address} and is
2165 relative to the applicable base address of the compilation
2166 unit referencing this location list. It marks the beginning
2167 of the address 
2168 \addtoindexi{range}{address range!in location list} 
2169 over which the location is valid.
2170
2171 \item An ending address offset.  This address offset again
2172 has the \addtoindex{size of an address} and is relative to the applicable
2173 base address of the compilation unit referencing this location
2174 list. It marks the first address past the end of the address
2175 range over which the location is valid. The ending address
2176 must be greater than or equal to the beginning address.
2177
2178 \textit{A location list entry (but not a base address selection or 
2179 end-of-list entry) whose beginning
2180 and ending addresses are equal has no effect 
2181 because the size of the range covered by such
2182 an entry is zero.}
2183
2184 \item An unsigned 2-byte length describing the length of the location 
2185 description that follows.
2186
2187 \item A \addtoindex{single location description} 
2188 describing the location of the object over the range specified by
2189 the beginning and end addresses.
2190 \end{enumerate}
2191
2192 Address ranges defined by normal location list entries
2193 may overlap. When they do, they describe a
2194 situation in which an object exists simultaneously in more than
2195 one place. If all of the address ranges in a given location
2196 list do not collectively cover the entire range over which the
2197 object in question is defined, it is assumed that the object is
2198 not available for the portion of the range that is not covered.
2199
2200 \needlines{4}
2201 \subsubsubsubsection{Default Location List Entry}
2202 A \addtoindex{default location list entry} consists of:
2203 \addtoindexx{location list!default entry}
2204 \begin{enumerate}[1. ]
2205 \item The value 0.
2206 \item The value of the largest representable address offset (for
2207       example, \wffffffff when the size of an address is 32 bits).
2208 \item 
2209 \bb
2210 An unsigned 2-byte length describing the length of the location 
2211       description that follows.
2212 \eb
2213 \item A \bb single \eb location description describing the location of the
2214       object when there is no prior normal location list entry
2215       that applies in the same location list.
2216 \end{enumerate}
2217
2218 A default location list entry is independent of any applicable
2219 base address (except to the extent to which base addresses
2220 affect prior normal location list entries).
2221
2222 A default location list entry must be the last location list
2223 entry of a location list except for the terminating end-of-list
2224 entry.
2225
2226 A \addtoindex{default location list entry} describes a \bb single \eb 
2227 location which applies to all addresses which are not included 
2228 in any range defined earlier in the same location list.
2229
2230 \needlines{5}
2231 \subsubsubsection{Base Address Selection Entry}
2232 A base 
2233 \addtoindexi{address}{address selection|see{base address selection}}
2234 \addtoindexx{location list!base address selection entry}
2235 selection 
2236 \addtoindexi{entry}{base address selection entry!in location list}
2237 consists of:
2238 \begin{enumerate}[1. ]
2239 \item The value of the largest representable 
2240 address offset (for example, \wffffffff when the size of
2241 an address is 32 bits).
2242 \item An address, which defines the 
2243 appropriate base address for use in interpreting the beginning
2244 and ending address offsets of subsequent entries of the location list.
2245 \end{enumerate}
2246
2247 \textit{A base address selection entry 
2248 affects only the remainder of the list in which it is contained.}
2249
2250 \needlines{5}
2251 \subsubsubsection{End-of-List Entry}
2252 The end of any given location list is marked by an 
2253 \addtoindexx{location list!end-of-list entry}
2254 end-of-list entry, which consists of a 0 for the beginning address
2255 offset and a 0 for the ending address offset. A location list
2256 containing only an 
2257 \addtoindexx{end-of-list entry!in location list}
2258 end-of-list entry describes an object that
2259 exists in the source code but not in the executable program.
2260
2261 Neither a base address selection entry nor an end-of-list
2262 entry includes a location description.
2263
2264 \needlines{4}
2265 \textit{When a DWARF consumer is parsing and decoding a location
2266 list, it must recognize the beginning and ending address
2267 offsets of (0, 0) for an end-of-list entry and 
2268 \mbox{(0, \texttt{maximum-address})} for
2269 a default location list entry prior to applying any base
2270 address. Any other pair of offsets beginning with 0 is a
2271 valid normal location list entry. Next, it must recognize the
2272 beginning address offset of \texttt{maximum-address} for a base address selection
2273 entry prior to applying any base address. The current base
2274 address is not applied to the subsequent value (although there
2275 may be an underlying object language relocation that affects
2276 that value).}
2277
2278 \textit{A base address selection entry and an end-of-list
2279 entry for a location list are identical to a base address
2280 selection entry and end-of-list entry, respectively, for a
2281 \addtoindex{range list}
2282 (see Section \refersec{chap:noncontiguousaddressranges}) 
2283 in interpretation and representation.}
2284
2285 \needlines{5}
2286 \subsubsection{Location Lists in Split Object Files}
2287 \label{chap:locationlistsinsplitobjectfiles}
2288 In a \splitDWARFobjectfile{} (see 
2289 Section \refersec{datarep:splitdwarfobjectfiles}), 
2290 location lists are contained in the \dotdebuglocdwo{} section.
2291
2292 The \addtoindex{applicable base address} of a split
2293 location list entry (see following) is
2294 \addtoindexx{location list!base address selection entry}
2295 determined by the closest preceding base address selection
2296 entry (\DWLLEbaseaddressselectionentry) in the same location list. If there is
2297 no such selection entry, then the applicable base address
2298 defaults to the base address of the compilation unit (see
2299 Section \refersec{chap:fullandpartialcompilationunitentries}).
2300
2301 Each entry in the split location list
2302 begins with a type code, which is a single unsigned byte that
2303 identifies the type of entry. There are five types of entries:
2304 \begin{enumerate}
2305 \itembfnl{\DWLLEendoflistentryTARG}
2306 This entry indicates the end of a location list, and
2307 contains no further data.
2308
2309 \needlines{6}
2310 \itembfnl{\DWLLEbaseaddressselectionentryTARG}
2311 This entry contains an 
2312 unsigned LEB128\addtoindexx{LEB128!unsigned} value immediately
2313 following the type code. This value is the index of an
2314 address in the \dotdebugaddr{} section, which is then used as
2315 the base address when interpreting offsets in subsequent
2316 location list entries of type \DWLLEoffsetpairentry.
2317 This index is relative to the value of the 
2318 \DWATaddrbase{} attribute of the associated compilation unit.
2319
2320 \itembfnl{\DWLLEstartendentryTARG}
2321 This entry contains two unsigned LEB128\addtoindexx{LEB128!unsigned}
2322 values immediately following the type code. These values are the
2323 indices of two addresses in the \dotdebugaddr{} section.
2324 These indices are relative to the value of the 
2325 \DWATaddrbase{} attribute of the associated compilation unit
2326 (see Section \refersec{chap:unitentries}).
2327 These indicate the starting and ending addresses,
2328 respectively, that define the address range for which
2329 this location is valid. The starting and ending addresses
2330 given by this type of entry are not relative to the
2331 compilation unit base address. A single location
2332 description follows the fields that define the address range.
2333
2334 \needlines{5}
2335 \itembfnl{\DWLLEstartlengthentryTARG}
2336 This entry contains one unsigned LEB128\addtoindexx{LEB128!unsigned}
2337 value and a 4-byte
2338 unsigned value immediately following the type code. The
2339 first value is the index of an address in the \dotdebugaddr{}
2340 section, which marks the beginning of the address range
2341 over which the location is valid.
2342 This index is relative to the value of the 
2343 \DWATaddrbase{} attribute of the associated compilation unit.
2344 The starting address given by this
2345 type of entry is not relative to the compilation unit
2346 base address. The second value is the
2347 length of the range
2348 \bb
2349 in bytes. 
2350 \eb
2351 A single location
2352 description follows the fields that define the address range.
2353
2354 \itembfnl{\DWLLEoffsetpairentryTARG}
2355 This entry contains two 4-byte unsigned values
2356 immediately following the type code. These values are the
2357 starting and ending offsets, respectively, relative to
2358 the applicable base address, that define the address
2359 range for which this location is valid. A single location
2360 description follows the fields that define the address range.
2361 \end{enumerate}
2362
2363 \needlines{4}
2364 \textit{The \DWLLEbaseaddressselectionentry, \DWLLEstartendentry{}
2365 and \DWLLEstartlengthentry{} entries obtain addresses within the 
2366 target program indirectly using an index (not an offset) into an 
2367 array of addresses. The base of that array is obtained using the 
2368 \DWATaddrbase{} attribute of the containing compilation unit. 
2369 The value of that attribute is the offset of the base of the array 
2370 in the \dotdebugaddr{} section of the unit.}
2371
2372 \needlines{10}
2373 \section{Types of Program Entities}
2374 \label{chap:typesofprogramentities}
2375 \hypertarget{chap:DWATtypetypeofdeclaration}{}
2376 Any debugging information entry describing a declaration that
2377 has a type has 
2378 \addtoindexx{type attribute}
2379 a \DWATtypeDEFN{} attribute, whose value is a
2380 reference to another debugging information entry. The entry
2381 referenced may describe a base type, that is, a type that is
2382 not defined in terms of other data types, or it may describe a
2383 user-defined type, such as an array, structure or enumeration.
2384 Alternatively, the entry referenced may describe a type
2385 modifier, such as constant, packed, pointer, reference or
2386 volatile, which in turn will reference another entry describing
2387 a type or type modifier (using a
2388 \DWATtypeNAME{} attribute\addtoindexx{type attribute} of its
2389 own). See 
2390 \bb
2391 Chapter 
2392 \eb
2393 \referfol{chap:typeentries} 
2394 for descriptions of the entries describing
2395 base types, user-defined types and type modifiers.
2396
2397
2398 \needlines{6}
2399 \section{Accessibility of Declarations}
2400 \label{chap:accessibilityofdeclarations}
2401 \textit{Some languages, notably \addtoindex{C++} and 
2402 \addtoindex{Ada}, have the concept of
2403 the accessibility of an object or of some other program
2404 entity. The accessibility specifies which classes of other
2405 program objects are permitted access to the object in question.}
2406
2407 The accessibility of a declaration 
2408 is\hypertarget{chap:DWATaccessibilityattribute}{}
2409 represented by a 
2410 \DWATaccessibilityDEFN{}\addtoindexx{accessibility attribute} 
2411 attribute, whose value is a constant drawn from the set of codes 
2412 listed in Table \refersec{tab:accessibilitycodes}.
2413
2414 \begin{simplenametable}[1.9in]{Accessibility codes}{tab:accessibilitycodes}
2415 \DWACCESSpublicTARG{}          \\
2416 \DWACCESSprivateTARG{}        \\
2417 \DWACCESSprotectedTARG{}    \\
2418 \end{simplenametable}
2419
2420 \needlines{5}
2421 \section{Visibility of Declarations}
2422 \label{chap:visibilityofdeclarations}
2423
2424 \textit{Several languages (such as \addtoindex{Modula-2}) 
2425 have the concept of the visibility of a declaration. The
2426 visibility specifies which declarations are to be 
2427 visible outside of the entity in which they are
2428 declared.}
2429
2430 The\hypertarget{chap:DWATvisibilityvisibilityofdeclaration}{}
2431 visibility of a declaration is represented 
2432 by a \DWATvisibilityDEFN{}
2433 attribute\addtoindexx{visibility attribute}, whose value is a
2434 constant drawn from the set of codes listed in 
2435 Table \refersec{tab:visibilitycodes}.
2436
2437 \begin{simplenametable}[1.5in]{Visibility codes}{tab:visibilitycodes}
2438 \DWVISlocalTARG{}          \\
2439 \DWVISexportedTARG{}    \\
2440 \DWVISqualifiedTARG{}  \\
2441 \end{simplenametable}
2442
2443 \needlines{8}
2444 \section{Virtuality of Declarations}
2445 \label{chap:virtualityofdeclarations}
2446 \textit{\addtoindex{C++} provides for virtual and pure virtual structure or class
2447 member functions and for virtual base classes.}
2448
2449 The\hypertarget{chap:DWATvirtualityvirtualityindication}{}
2450 virtuality of a declaration is represented by a
2451 \DWATvirtualityDEFN{}
2452 attribute\addtoindexx{virtuality attribute}, whose value is a constant drawn
2453 from the set of codes listed in 
2454 Table \refersec{tab:virtualitycodes}.
2455
2456 \begin{simplenametable}[2.5in]{Virtuality codes}{tab:virtualitycodes}
2457 \DWVIRTUALITYnoneTARG{}                      \\
2458 \DWVIRTUALITYvirtualTARG{}                \\
2459 \DWVIRTUALITYpurevirtualTARG{}    \\
2460 \end{simplenametable}
2461
2462 \needlines{8}
2463 \section{Artificial Entries}
2464 \label{chap:artificialentries}
2465 \textit{A compiler may wish to generate debugging information entries
2466 for objects or types that were not actually declared in the
2467 source of the application. An example is a formal parameter
2468 entry to represent the hidden 
2469 \texttt{this} parameter\index{this parameter@\texttt{this} parameter}
2470 that most \addtoindex{C++} implementations pass as the first argument 
2471 to non-static member functions.}  
2472
2473 Any debugging information entry representing the
2474 \addtoindexx{artificial attribute}
2475 declaration of an object or type artificially generated by
2476 a compiler and not explicitly declared by the source 
2477 program\hypertarget{chap:DWATartificialobjectsortypesthat}{}
2478 may have a 
2479 \DWATartificialDEFN{} attribute, 
2480 which is a \livelink{chap:classflag}{flag}.
2481
2482 \needlines{6}
2483 \section{Segmented Addresses}
2484 \label{chap:segmentedaddresses}
2485 \textit{In some systems, addresses are specified as offsets within a
2486 given 
2487 \addtoindexx{address space!segmented}
2488 segment 
2489 \addtoindexx{segmented addressing|see{address space}}
2490 rather than as locations within a single flat
2491 \addtoindexx{address space!flat}
2492 address space.}
2493
2494 Any debugging information entry that contains a description
2495 of\hypertarget{chap:DWATsegmentaddressinginformation}{}
2496 the location of an object or subroutine may have a 
2497 \DWATsegmentDEFN{} attribute, 
2498 \addtoindexx{segment attribute}
2499 whose value is a location
2500 description. The description evaluates to the segment selector
2501 of the item being described. If the entry containing the
2502 \DWATsegmentNAME{} attribute has a 
2503 \DWATlowpc, 
2504 \DWAThighpc,
2505 \DWATranges{} or 
2506 \DWATentrypc{} attribute, 
2507 \addtoindexx{entry PC attribute}
2508 or 
2509 a location
2510 description that evaluates to an address, then those address
2511 values represent the offset portion of the address within
2512 the segment specified 
2513 \addtoindexx{segment attribute}
2514 by \DWATsegmentNAME.
2515
2516 If an entry has no 
2517 \DWATsegmentNAME{} attribute, it inherits
2518 \addtoindexx{segment attribute}
2519 the segment value from its parent entry.  If none of the
2520 entries in the chain of parents for this entry back to
2521 its containing compilation unit entry have 
2522 \DWATsegmentNAME{} attributes, 
2523 then the entry is assumed to exist within a flat
2524 address space. 
2525 Similarly, if the entry has a 
2526 \DWATsegmentNAME{} attribute 
2527 \addtoindexx{segment attribute}
2528 containing an empty location description, that
2529 entry is assumed to exist within a 
2530 \addtoindexi{flat}{address space!flat}
2531 address space.
2532
2533 \textit{Some systems support different 
2534 classes of addresses\addtoindexx{address class}. 
2535 The address class may affect the way a pointer is dereferenced
2536 or the way a subroutine is called.}
2537
2538
2539 Any debugging information entry representing a pointer or
2540 reference type or a subroutine or subroutine type may 
2541 have a 
2542 \DWATaddressclass{}
2543 attribute, whose value is an integer
2544 constant.  The set of permissible values is specific to
2545 each target architecture. The value \DWADDRnoneTARG, 
2546 however,
2547 is common to all encodings, and means that no address class
2548 has been specified.
2549
2550 \needlines{4}
2551 \textit {For example, the Intel386 \texttrademark\  processor might use the following values:}
2552
2553 \begin{table}[h]
2554 \caption{Example address class codes}
2555 \label{tab:inteladdressclasstable}
2556 \centering
2557 \begin{tabular}{l|c|l}
2558 \hline
2559 Name&Value&Meaning  \\
2560 \hline
2561 \textit{DW\_ADDR\_none}&   0 & \textit{no class specified} \\
2562 \textit{DW\_ADDR\_near16}& 1 & \textit{16-bit offset, no segment} \\
2563 \textit{DW\_ADDR\_far16}&  2 & \textit{16-bit offset, 16-bit segment} \\
2564 \textit{DW\_ADDR\_huge16}& 3 & \textit{16-bit offset, 16-bit segment} \\
2565 \textit{DW\_ADDR\_near32}& 4 & \textit{32-bit offset, no segment} \\
2566 \textit{DW\_ADDR\_far32}&  5 & \textit{32-bit offset, 16-bit segment} \\
2567 \hline
2568 \end{tabular}
2569 \end{table}
2570
2571 \needlines{6}
2572 \section{Non-Defining Declarations and Completions}
2573 \label{chap:nondefiningdeclarationsandcompletions}
2574 A debugging information entry representing a program entity
2575 typically represents the defining declaration of that
2576 entity. In certain contexts, however, a debugger might need
2577 information about a declaration of an entity that is not
2578 \addtoindexx{incomplete declaration}
2579 also a definition, or is otherwise incomplete, to evaluate
2580 an\hypertarget{chap:DWATdeclarationincompletenondefiningorseparateentitydeclaration}{}
2581 expression correctly.
2582
2583 \needlines{10}
2584 \textit{As an example, consider the following fragment of \addtoindex{C} code:}
2585
2586 \begin{lstlisting}
2587 void myfunc()
2588 {
2589   int x;
2590   {
2591     extern float x;
2592     g(x);
2593   }
2594 }
2595 \end{lstlisting}
2596
2597
2598 \textit{\addtoindex{C} scoping rules require that the 
2599 value of the variable \texttt{x} passed to the function 
2600 \texttt{g} is the value of the global \texttt{float} 
2601 variable \texttt{x} rather than of the local \texttt{int} 
2602 variable \texttt{x}.}
2603
2604 \subsection{Non-Defining Declarations}
2605 A debugging information entry that 
2606 represents a non-defining 
2607 \addtoindexx{non-defining declaration}
2608 or otherwise 
2609 \addtoindex{incomplete declaration}
2610 of a program entity has a
2611 \addtoindexx{declaration attribute}
2612 \DWATdeclarationDEFN{} attribute, which is a 
2613 \livelink{chap:classflag}{flag}.
2614
2615 \textit{
2616 \bb
2617 A non-defining type declaration may nonetheless have 
2618 children as illustrated in Section
2619 \refersec{app:declarationscompletingnondefiningdeclarations}.
2620 \eb
2621 }
2622
2623 \subsection{Declarations Completing Non-Defining Declarations}
2624 \hypertarget{chap:DWATspecificationincompletenondefiningorseparatedeclaration}{}
2625 A debugging information entry that represents a declaration
2626 that completes another (earlier) non-defining declaration may have a 
2627 \DWATspecificationDEFN{}
2628 attribute whose value is a \livelink{chap:classreference}{reference} to
2629 the debugging information entry representing the non-defining declaration. 
2630 A debugging information entry with a 
2631 \DWATspecificationNAME{} 
2632 attribute does not need to duplicate information provided by the 
2633 debugging information entry referenced by that specification attribute.
2634
2635 When the non-defining declaration is contained within a type that has
2636 been placed in a separate type unit (see Section \refersec{chap:typeunitentries}), 
2637 the \DWATspecification{} attribute cannot refer directly to the entry in
2638 the type unit. Instead, the current compilation unit may contain a
2639 \doublequote{skeleton} declaration of the type, which contains only the relevant
2640 declaration and its ancestors as necessary to provide the context
2641 (including containing types and namespaces). The \DWATspecification{}
2642 attribute would then be a reference to the declaration entry within
2643 the skeleton declaration tree. The debugging information entry for the
2644 top-level type in the skeleton tree may contain a \DWATsignature{}
2645 attribute whose value is the type signature 
2646 (see Section \refersec{datarep:typesignaturecomputation}).
2647
2648
2649 Not all attributes of the debugging information entry referenced by a
2650 \DWATspecification{} attribute 
2651 apply to the referring debugging information entry.
2652 For\addtoindexx{declaration attribute}
2653 example,
2654 \DWATsibling{} and 
2655 \DWATdeclaration{} 
2656 \addtoindexx{declaration attribute}
2657 cannot apply to a 
2658 \addtoindexx{declaration attribute}
2659 referring
2660 \addtoindexx{sibling attribute}
2661 entry.
2662
2663
2664 \section{Declaration Coordinates}
2665 \label{chap:declarationcoordinates}
2666 \livetargi{chap:declarationcoordinates}{}{declaration coordinates}
2667 \textit{It is sometimes useful in a debugger to be able to associate
2668 a declaration with its occurrence in the program source.}
2669
2670 Any debugging information entry representing 
2671 the declaration of an object, module, subprogram or type may have
2672 \DWATdeclfileDEFN,\hypertarget{chap:DWATdeclfilefilecontainingsourcedeclaration}{}
2673 \addtoindexx{declaration file attribute} 
2674 \DWATdecllineDEFN\hypertarget{chap:DWATdecllinelinenumberofsourcedeclaration}{}
2675 \addtoindexx{declaration line attribute} and 
2676 \DWATdeclcolumnDEFN\hypertarget{chap:DWATdeclcolumncolumnpositionofsourcedeclaration}{}
2677 \addtoindexx{declaration column attribute}
2678 attributes, each of whose value is an unsigned
2679 \livelink{chap:classconstant}{integer constant}.
2680
2681 The value of 
2682 \addtoindexx{declaration file attribute}
2683 the 
2684 \DWATdeclfile{}
2685 attribute 
2686 \addtoindexx{file containing declaration}
2687 corresponds to
2688 a file number from the line number information table for the
2689 compilation unit containing the debugging information entry and
2690 represents the source file in which the declaration appeared
2691 (see Section \refersec{chap:linenumberinformation}). 
2692 The value 0 indicates that no source file
2693 has been specified.
2694
2695 The value of 
2696 \addtoindexx{declaration line attribute}
2697 the \DWATdeclline{} attribute represents
2698 the source line number at which the first character of
2699 the identifier of the declared object appears. The value 0
2700 indicates that no source line has been specified.
2701
2702 The value of 
2703 \addtoindexx{declaration column attribute}
2704 the \DWATdeclcolumn{} attribute represents
2705 the source column number at which the first character of
2706 the identifier of the declared object appears. The value 0
2707 indicates that no column has been specified.
2708
2709 \section{Identifier Names}
2710 \label{chap:identifiernames}
2711 Any\hypertarget{chap:DWATnamenameofdeclaration}{}
2712 debugging information entry 
2713 \addtoindexx{identifier names}
2714 representing 
2715 \addtoindexx{names!identifier}
2716 a program entity that has been given a name may have a 
2717 \DWATnameDEFN{} 
2718 attribute\addtoindexx{name attribute}, whose value of 
2719 \bb
2720 class 
2721 \eb
2722 \CLASSstring{} represents the name.
2723 \bbeb
2724 A debugging information entry containing
2725 no name attribute, or containing a name attribute whose value
2726 consists of a name containing a single null byte, represents
2727 a program entity for which no name was given in the source.
2728
2729 \textit{Because the names of program objects described by DWARF are 
2730 the names as they appear in the source program, implementations
2731 of language translators that use some form of mangled name
2732 \addtoindexx{mangled names}
2733 (as do many implementations of \addtoindex{C++}) should use the 
2734 unmangled form of the name in the 
2735 \DWATname{} attribute,
2736 \addtoindexx{name attribute}
2737 including the keyword operator (in names such as \doublequote{operator +}),
2738 if present. See also 
2739 Section \referfol{chap:linkagenames} regarding the use of 
2740 \DWATlinkagename{} for 
2741 \addtoindex{mangled names}.
2742 Sequences of multiple whitespace characters may be compressed.}
2743
2744 \section{Data Locations and DWARF Procedures}
2745 \hypertarget{chap:DWATlocationdataobjectlocation}{}
2746 Any debugging information entry describing a data object (which
2747 includes variables and parameters) or 
2748 \livelink{chap:commonblockentry}{common blocks}
2749 may have a \DWATlocationDEFN{} attribute,
2750 \addtoindexx{location attribute}
2751 whose value is a location description
2752 (see Section \refersec{chap:locationdescriptions}).
2753
2754 \needlines{4}
2755
2756 \addtoindex{DWARF procedure}
2757 is represented by any
2758 \bb\eb
2759 debugging information entry that has a
2760 \addtoindexx{location attribute}
2761 \DWATlocationNAME{}
2762 attribute. 
2763 \addtoindexx{location attribute}
2764 If a suitable entry is not otherwise available,
2765 a DWARF procedure can be represented using a debugging
2766 \addtoindexx{DWARF procedure entry}
2767 information entry with the 
2768 tag \DWTAGdwarfprocedureTARG{}
2769 together with 
2770 \addtoindexx{location attribute}
2771 a \DWATlocationNAME{} attribute.  
2772
2773 A DWARF procedure
2774 is called by a \DWOPcalltwo, 
2775 \DWOPcallfour{} or 
2776 \DWOPcallref{}
2777 DWARF expression operator 
2778 (see Section \refersec{chap:controlflowoperations}).
2779
2780 \needlines{5}
2781 \bb
2782 \section{Code Addresses, Ranges and Base Addresses}
2783 \eb
2784 \label{chap:codeaddressesandranges}
2785 Any debugging information entry describing an entity that has
2786 a machine code address or range of machine code addresses,
2787 which includes compilation units, module initialization,
2788 subroutines, 
2789 \bb
2790 lexical
2791 \eb
2792 \nolink{blocks}, 
2793 try/catch \nolink{blocks} (see Section \refersec{chap:tryandcatchblockentries}), 
2794 labels and the like, may have
2795 \begin{itemize}
2796 \item \hypertarget{chap:DWATlowpccodeaddressorrangeofaddresses}{}
2797 A \DWATlowpcDEFN{} attribute for a single address,
2798
2799 \item \hypertarget{chap:DWAThighpccontiguousrangeofcodeaddresses}{}
2800 A \DWATlowpcDEFN{}\addtoindexx{low PC attribute}
2801 and \DWAThighpcDEFN{}\addtoindexx{high PC attribute}
2802 pair of attributes for a single contiguous range of
2803 addresses, or
2804
2805 \item \hypertarget{chap:DWATrangesnoncontiguousrangeofcodeaddresses}{}
2806 A \DWATrangesDEFN{} attribute\addtoindexx{ranges attribute}
2807 for a non-contiguous range of addresses.
2808 \end{itemize}
2809
2810 \bbpareb
2811
2812 If an entity has no associated machine code, 
2813 none of these attributes are specified.
2814
2815 \bb
2816 The \definitionx{base address} of the scope for any of the
2817 debugging information entries listed above is given by either the 
2818 \DWATlowpcNAME{}\livetargi{chap:DWATlowpcbaseaddressofscope}{}{base address of scope} 
2819 attribute or the first address in the first range entry 
2820 in the list of ranges given by the \DWATrangesNAME{} attribute.
2821 If there is no such attribute, the base address is undefined.
2822 \eb
2823
2824 \subsection{Single Address} 
2825 When there is a single address associated with an entity,
2826 such as a label or alternate entry point of a subprogram,
2827 the entry has a \DWATlowpc{} attribute whose value is the
2828 \bb\eb address for the entity.
2829
2830 \bbpareb
2831
2832 \needlines{8}
2833 \bb
2834 \subsection{Contiguous Address Range}
2835 \eb
2836 \label{chap:contiguousaddressranges}
2837 When the set of addresses of a debugging information entry can
2838 be described as a single contiguous range, the entry 
2839 \addtoindexx{high PC attribute}
2840 may 
2841 \addtoindexx{low PC attribute}
2842 have a \DWATlowpc{} and \DWAThighpc{} pair of attributes. 
2843 The value of the \DWATlowpc{} attribute is the \bb\eb address of the
2844 first instruction associated with the entity. If the value of
2845 the \DWAThighpc{} is of class address, it is the \bb\eb
2846 address of the first location past the last instruction
2847 associated with the entity; if it is of class constant, the
2848 value is an unsigned integer offset which when added to the
2849 low PC gives the address of the first location past the last
2850 instruction associated with the entity.
2851
2852 \textit{The high PC value
2853 may be beyond the last valid instruction in the executable.}
2854
2855 \bbpareb
2856
2857 \subsection{Non-Contiguous Address Ranges}
2858 \label{chap:noncontiguousaddressranges}
2859 When the set of addresses of a debugging information entry
2860 \addtoindexx{non-contiguous address ranges}
2861 cannot be described as a single contiguous range, the entry 
2862 \bb
2863 may have
2864 \eb
2865 a \DWATranges{} attribute\addtoindexx{ranges attribute}
2866 whose value is of class \livelink{chap:classrangelistptr}{rangelistptr}
2867 and indicates the beginning of a \addtoindex{range list}.
2868 Similarly,
2869 a \DWATstartscope{} attribute\addtoindexx{start scope attribute}
2870 \bb
2871 (see Section \refersec{chap:dataobjectentries}).
2872 \eb
2873 may have a value of class
2874 \livelink{chap:classrangelistptr}{rangelistptr} for the same reason.  
2875
2876 Range lists are contained in 
2877 \bb
2878 the \dotdebugranges{} section. 
2879 \eb
2880 A \addtoindex{range list} is indicated by a 
2881 \DWATranges{} attribute\addtoindexx{ranges attribute}
2882 whose value is 
2883 \bb\eb
2884 an offset from the beginning of the
2885 \dotdebugranges{} section to the beginning of the 
2886 \addtoindex{range list}.
2887
2888 \needlines{4}
2889 If the current compilation unit contains a \DWATrangesbase{}
2890 attribute, the value of that attribute establishes a base
2891 offset within the \dotdebugranges{} section for the compilation
2892 unit. The offset given by the \DWATranges{} attribute is
2893 relative to that base.
2894
2895 \bbpareb
2896
2897 The \definitionx{applicable base address} of a \addtoindex{range list} 
2898 entry is determined by the closest preceding base address 
2899 selection entry in the same range list (see
2900 \bb
2901 Section \refersec{chap:baseaddressselectionentry}). 
2902 \eb
2903  If there is no such selection
2904 entry, then the applicable base address defaults to the base
2905 address of the compilation unit 
2906 (see Section \refersec{chap:fullandpartialcompilationunitentries}).
2907
2908 \textit{In the case of a compilation unit where all of the machine
2909 code is contained in a single contiguous section, no base
2910 address selection entry is needed.}
2911
2912 Address range entries in a \addtoindex{range list} may not overlap.
2913 There is no requirement that the entries be ordered in any particular way.
2914
2915 Each entry in a \addtoindex{range list} is either a 
2916 \addtoindex{range list entry},
2917 \addtoindexx{base address selection entry!in range list}
2918 a base address selection entry, or an 
2919 \addtoindexx{end-of-list entry!in range list}
2920 end-of-list entry.
2921
2922 \needlines{5}
2923 \subsubsection{Range List Entry}
2924 A \addtoindex{range list entry} consists of:
2925 \begin{enumerate}[1. ]
2926 \item A beginning address offset. This address offset has the 
2927 \addtoindex{size of an address} and is relative to
2928 the \addtoindex{applicable base address} of the compilation unit referencing this 
2929 \addtoindex{range list}. 
2930 It marks the beginning of an 
2931 \addtoindexi{address range}{address range!in range list}. 
2932
2933 \item An ending address offset. This address offset again has the 
2934 \addtoindex{size of an address} and is relative
2935 to the \addtoindex{applicable base address} of the compilation unit referencing 
2936 this \addtoindex{range list}.
2937 It marks the first address past the end of the address range.
2938 The ending address must be greater than or
2939 equal to the beginning address.
2940
2941 \needlines{4}
2942 \textit{A \addtoindex{range list} entry (but not a base address 
2943 selection or end-of-list entry) whose beginning and
2944 ending addresses are equal has no effect because the size of the 
2945 range covered by such an entry is zero.}
2946 \end{enumerate}
2947
2948 \needlines{5}
2949 \subsubsection{Base Address Selection Entry}
2950 \label{chap:baseaddressselectionentry}
2951 A \addtoindex{base address selection entry} consists of:
2952 \begin{enumerate}[1. ]
2953 \item The value of the largest representable address offset 
2954 (for example, \wffffffff when the size of an address is 32 bits).
2955
2956 \item An address, which defines the appropriate base address 
2957 for use in interpreting the beginning and ending address offsets 
2958 of subsequent entries of the location list.
2959 \end{enumerate}
2960
2961 \textit{A base address selection entry affects only the 
2962 remainder of 
2963 \bb
2964 the 
2965 \eb
2966 list in which it is contained.}
2967
2968 \subsubsection{End-of-List Entry}
2969 The end of any given \addtoindex{range list} is marked by an 
2970 \addtoindexx{end-of-list entry!in range list}
2971 end-of-list entry, 
2972 which consists of a 0 for the beginning address
2973 offset and a 0 for the ending address offset. 
2974 A \addtoindex{range list}
2975 containing only an end-of-list entry describes an empty scope
2976 (which contains no instructions).
2977
2978 \textit{A base address selection entry and an 
2979 \addtoindexx{end-of-list entry!in range list}
2980 end-of-list entry for
2981 a \addtoindex{range list} 
2982 are identical to a base address selection entry
2983 and end-of-list entry, respectively, for a location list
2984 (see Section \refersec{chap:locationlists}) 
2985 in interpretation and representation.}
2986
2987
2988 \section{Entry Address}
2989 \label{chap:entryaddress}
2990 \textit{The entry or first executable instruction generated
2991 for an entity, if applicable, is often the lowest addressed
2992 instruction of a contiguous range of instructions. In other
2993 cases, the entry address needs to be specified explicitly.}
2994
2995 Any debugging information entry describing an entity that has
2996 a range of code addresses, which includes compilation units,
2997 module initialization, subroutines, 
2998 \livelink{chap:lexicalblock}{lexical \nolink{blocks}},
2999 \livelink{chap:tryandcatchblockentries}{try/catch \nolink{blocks}},
3000 and the like, may have a \DWATentrypcDEFN{} attribute 
3001 \addtoindexx{entry PC address}
3002 to indicate the 
3003 \bb
3004 \definitionx{entry address} which is the address of the 
3005 instruction where execution should begin
3006 \eb
3007 within that range\hypertarget{chap:entryaddressofscope}{}
3008 of addresses. 
3009 \bb
3010 If the value of the \DWATentrypcNAME{} attribute is of
3011 class \CLASSaddress{} that address is the entry address;
3012 or, 
3013 \eb
3014 if it is of class
3015 \CLASSconstant, the value is an unsigned integer offset which, when
3016 added to the base address of the function, gives the entry
3017 address. 
3018
3019
3020 If \bb\eb no \DWATentrypcNAME{} attribute is present,
3021 then the entry address is assumed to be the same as the
3022 base address of the containing scope.
3023
3024
3025 \section{Static and Dynamic Values of Attributes}
3026 \label{chap:staticanddynamicvaluesofattributes}
3027
3028 Some attributes that apply to types specify a property (such
3029 as the lower bound of an array) that is an integer value,
3030 where the value may be known during compilation or may be
3031 computed dynamically during execution.
3032
3033 \needlines{5}
3034 The value of these
3035 attributes is determined based on the class as follows:
3036 \begin{itemize}
3037 \item For a \livelink{chap:classconstant}{constant}, the value 
3038 of the constant is the value of the attribute.
3039
3040 \item For a \livelink{chap:classreference}{reference}, the
3041 value is a reference to another 
3042 \bb
3043 debugging information entry.  This entry may:
3044 \eb
3045 \begin{itemize}
3046 \renewcommand{\itemsep}{0cm}
3047 \item describe a constant which is the attribute value,
3048 \item describe a variable which contains the attribute value, or
3049 \item 
3050 \bb
3051       contain a \DWATlocation{} attribute whose value is a
3052 \eb
3053       DWARF expression which computes the attribute value
3054       (for example, \bb\eb a \DWTAGdwarfprocedure{} entry).
3055 \end{itemize}
3056
3057 \item For an \livelink{chap:classexprloc}{exprloc}, the value 
3058 is interpreted as a DWARF expression; evaluation of the expression 
3059 yields the value of the attribute.
3060 \end{itemize}
3061
3062 \bbpareb
3063
3064 \needlines{4}
3065 \section{Entity Descriptions}
3066 \textit{Some debugging information entries may describe entities
3067 in the program that are artificial, or which otherwise have a 
3068 \doublequote{name} that is not a valid identifier in the
3069 programming language. For example, several languages may
3070 capture or freeze the value of a variable at a particular
3071 point in the program and hold that value in an artificial variable. 
3072 \addtoindex{Ada} 95 has package elaboration routines,
3073 type descriptions of the form \texttt{typename\textquoteright Class}, and 
3074 \doublequote{\texttt{access} typename} parameters.}
3075
3076 Generally, any debugging information entry that 
3077 has,\hypertarget{chap:DWATdescriptionartificialnameordescription}{}
3078 or may have, a \DWATname{} attribute, may also have a
3079 \addtoindexx{description attribute}
3080 \DWATdescriptionDEFN{} attribute whose value is a
3081 null-terminated string providing a description of the entity.
3082
3083 \textit{It is expected that a debugger will only display these
3084 descriptions as part of the description of other entities.}
3085
3086 \needlines{4}
3087 \section{Byte and Bit Sizes}
3088 \label{chap:byteandbitsizes}
3089 % Some trouble here with hbox full, so we try optional word breaks.
3090 Many debugging information entries allow either a
3091 \DWATbytesizeNAME{} attribute or a 
3092 \DWATbitsizeNAME{} attribute,
3093 whose \livelink{chap:classconstant}{integer constant} value 
3094 (see Section \ref{chap:staticanddynamicvaluesofattributes}) 
3095 specifies an
3096 amount of storage. The value of the 
3097 \DWATbytesizeDEFN{} attribute
3098 is interpreted in bytes and the value of the 
3099 \DWATbitsizeDEFN{}
3100 attribute is interpreted in bits. The
3101 \DWATstringlengthbytesize{} and 
3102 \DWATstringlengthbitsize{} 
3103 attributes are similar.
3104
3105 In addition, the \livelink{chap:classconstant}{integer constant}
3106 value of a \DWATbytestride{} attribute is interpreted
3107 in bytes and the \livelink{chap:classconstant}{integer constant} value of a 
3108 \DWATbitstride{}
3109 attribute is interpreted in bits.
3110
3111 \section{Linkage Names}
3112 \label{chap:linkagenames}
3113 \textit{Some language implementations, notably 
3114 \addtoindex{C++} and similar
3115 languages, make use of implementation-defined names within
3116 object files that are different from the \addtoindex{identifier names}
3117 (see Section \refersec{chap:identifiernames}) of entities as they 
3118 appear in the source. Such names, sometimes known as 
3119 \addtoindex{mangled names}\addtoindexx{names!mangled},
3120 are used in various ways, such as: to encode additional
3121 information about an entity, to distinguish multiple entities
3122 that have the same name, and so on. When an entity has an
3123 associated distinct linkage name it may sometimes be useful
3124 for a producer to include this name in the DWARF description
3125 of the program to facilitate consumer access to and use of
3126 object file information about an entity and/or information
3127 that is encoded in the linkage name itself.  
3128 }
3129
3130 % Some trouble maybe with hbox full, so we try optional word breaks.
3131 A debugging information entry may have a
3132 \DWATlinkagenameDEFN{}\hypertarget{chap:DWATlinkagenameobjectfilelinkagenameofanentity}{}
3133 attribute\addtoindexx{linkage name attribute}
3134 whose value is a null-terminated string containing the 
3135 object file linkage name associated with the corresponding entity.
3136
3137
3138 \section{Template Parameters}
3139 \label{chap:templateparameters}
3140 \textit{In \addtoindex{C++}, a template is a generic definition 
3141 of a class, function, member function, or typedef (alias).  
3142 A template has formal parameters that
3143 can be types or constant values; the class, function,
3144 member function, or typedef is instantiated differently for each
3145 distinct combination of type or value actual parameters.  DWARF does
3146 not represent the generic template definition, but does represent each
3147 instantiation.}
3148
3149 A debugging information entry that represents a 
3150 \addtoindex{template instantiation}
3151 will contain child entries describing the actual template parameters.
3152 The containing entry and each of its child entries reference a template
3153 parameter entry in any circumstance where the template definition
3154 referenced a formal template parameter.
3155
3156 A template type parameter is represented by a debugging information
3157 entry with the tag
3158 \addtoindexx{template type parameter entry}
3159 \DWTAGtemplatetypeparameterTARG. 
3160 A template value parameter is represented by a debugging information
3161 entry with the tag
3162 \addtoindexx{template value parameter entry}
3163 \DWTAGtemplatevalueparameterTARG.
3164 The actual template parameter entries appear in the same order as the 
3165 corresponding template formal parameter declarations in the 
3166 source program.
3167
3168 \needlines{4}
3169 A type or value parameter entry may have a \DWATname{} attribute, 
3170 \addtoindexx{name attribute}
3171 whose value is a
3172 null-terminated string containing the name of the corresponding 
3173 formal parameter.
3174 \bbeb
3175 The entry may also have a 
3176 \DWATdefaultvalue{} attribute, which is a flag indicating 
3177 that the value corresponds to the default argument for the 
3178 template parameter.
3179
3180 A
3181 \addtoindexx{formal type parameter|see{template type parameter entry}}
3182 template type parameter entry has a
3183 \addtoindexx{type attribute}
3184 \DWATtype{} attribute
3185 describing the actual type by which the formal is replaced.
3186
3187 A template value parameter entry has a \DWATtype{} attribute 
3188 describing the type of the parameterized value.
3189 The entry also has an attribute giving the 
3190 actual compile-time or run-time constant value 
3191 of the value parameter for this instantiation.
3192 This can be a 
3193 \DWATconstvalueDEFN{} attribute, 
3194 \addtoindexx{constant value attribute}
3195 \livetarg{chap:DWATconstvaluetemplatevalueparameter}{} 
3196 whose value is the compile-time constant value 
3197 as represented on the target architecture, or a 
3198 \DWATlocation{} attribute, whose value is a 
3199 single location description for the run-time constant address.
3200
3201 \section{Alignment}
3202 \label{chap:alignment}
3203 \livetarg{chap:DWATalignmentnondefault}{}
3204 A debugging information entry may have a 
3205 \DWATalignmentDEFN{} attribute\addtoindexx{alignment attribute}
3206 \bb
3207 whose value of class \CLASSconstant{} is
3208 a positive, non-zero, integer describing the 
3209 \eb 
3210 alignment of the entity. 
3211 \bb\eb
3212
3213 \textit{For example, an alignment attribute whose value is 8 indicates
3214 that the entity to which it applies occurs at an address that is a
3215 multiple of eight (not a multiple of $2^8$ or 256).}
3216