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