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