Attributes table links from AT_p* r* s* attributes now added
[dwarf-doc.git] / dwarf5 / latexdoc / typeentries.tex
1 \chapter{Type Entries}
2 \label{chap:typeentries}
3 This section presents the debugging information entries
4 that describe program types: base types, modified types and
5 user\dash defined types.
6
7 If the scope of the declaration of a named type begins after
8 \hypertarget{chap:DWATstartscopetypedeclaration}
9 the low pc value for the scope most closely enclosing the
10 declaration, the declaration may have a 
11 \livelink{chap:DWATstartscope}{DW\-\_AT\-\_start\-\_scope}
12 attribute as described for objects in 
13 Section \refersec{chap:dataobjectentries}.
14
15 \section{Base Type Entries}
16 \label{chap:basetypeentries}
17
18 \textit{A base type is a data type that is not defined in terms of
19 other data types. Each programming language has a set of base
20 types that are considered to be built into that language.}
21
22 A base type is represented by a debugging information entry
23 with the tag 
24 \livetarg{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type}.
25
26 A base type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is
27 a null\dash terminated string containing the name of the base type
28 as recognized by the programming language of the compilation
29 unit containing the base type entry.
30
31 A base type entry has a \livelink{chap:DWATencoding}{DW\-\_AT\-\_encoding} attribute describing
32 how the base type is encoded and is to be interpreted. The
33 value of this attribute is an integer constant. The set of
34 values and their meanings for the \livelink{chap:DWATencoding}{DW\-\_AT\-\_encoding} attribute
35 is given in 
36 Figure \refersec{fig:encodingattributevalues}
37 and following text.  
38
39 A base type entry
40 may have a \livelink{chap:DWATendianity}{DW\-\_AT\-\_endianity} attribute as described in 
41 Section \refersec{chap:dataobjectentries}. 
42 If omitted, the encoding assumes the representation that
43 is the default for the target architecture.
44
45 A base type entry has 
46 \hypertarget{chap:DWATbytesizedataobjectordatatypesize}
47 either a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute
48 \hypertarget{chap:DWATbitsizebasetypebitsize}
49 or a \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute whose integer constant value
50 (see Section \refersec{chap:byteandbitsizes}) 
51 is the amount of storage needed to hold
52 a value of the type.
53
54 \textit{For example, the C type int on a machine that uses 32\dash bit
55 integers is represented by a base type entry with a name
56 attribute whose value is “int”, an encoding attribute
57 whose value is \livelink{chap:DWATEsigned}{DW\-\_ATE\-\_signed} and a byte size attribute whose
58 value is 4.}
59
60 If the value of an object of the given type does not fully
61 occupy the storage described by a byte size attribute,
62 \hypertarget{chap:DWATdatabitoffsetbasetypebitlocation}
63 the base type entry may also have a 
64 \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} and a
65 \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} attribute, both of whose values are
66 integer constant values (
67 see Section \refersec{chap:staticanddynamicvaluesofattributes}). 
68 The bit size
69 attribute describes the actual size in bits used to represent
70 values of the given type. The data bit offset attribute is the
71 offset in bits from the beginning of the containing storage to
72 the beginning of the value. Bits that are part of the offset
73 are padding. The data bit offset uses the bit numbering and
74 direction conventions that are appropriate to the current
75 language on the
76 target system to locate the beginning of the storage and
77 value. If this attribute is omitted a default data bit offset
78 of zero is assumed.
79
80 \textit{Attribute \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} is new in DWARF Version 4 and
81 is also used for bit field members 
82 (see Section \refersec{chap:datamemberentries}). 
83 It
84 \hypertarget{chap:DWATbitoffsetbasetypebitlocation}
85 replaces the attribute \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} when used for base
86 types as defined in DWARF V3 and earlier. The earlier attribute
87 is defined in a manner suitable for bit field members on
88 big\dash endian architectures but which is wasteful for use on
89 little\dash endian architectures.}
90
91 \textit{The attribute \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} is 
92 deprecated in DWARF Version
93 4 for use in base types, but implementations may continue to
94 support its use for compatibility.}
95
96 \textit{The DWARF Version 3 definition of these attributes is as follows.}
97
98 \begin{myindentpara}{1cm}
99 \textit{A base type entry has a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute, whose value
100 (see Section 2.19) is the size in bytes of the storage unit
101 used to represent an object of the given type.}
102
103 \textit{If the value of an object of the given type does not fully
104 occupy the storage unit described by the byte size attribute,
105 the base type entry may have a \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute and a
106 \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} attribute, both of whose values (see Section
107 2.19) are integers. The bit size attribute describes the actual
108 size in bits used to represent a value of the given type.
109 The bit offset attribute describes the offset in bits of the
110 high order bit of a value of the given type from the high
111 order bit of the storage unit used to contain that value.}
112 \end{myindentpara}
113
114 \textit{In comparing DWARF Versions 3 and 4, note that DWARF V4
115 defines the following combinations of attributes:}
116
117 \begin{itemize}
118 \item \textit{DW\-\_AT\-\_byte\-\_size}
119 \item \textit{DW\-\_AT\-\_bit\-\_size}
120 \item \textit{\livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} 
121 and optionally \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset}}
122 \end{itemize}
123 DWARF V3 defines the following combinations:
124 % FIXME: the figure below interferes with the following
125 % bullet list, which looks horrible as a result.
126 \begin{itemize}
127 \item \textit{DW\-\_AT\-\_byte\-\_size}
128 \item \textit{\livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} and \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset}}
129 \end{itemize}
130
131 \begin{figure}[!here]
132 \centering
133 \begin{tabular}{lp{9cm}}
134 Name&Meaning\\ \hline
135 \livetarg{chap:DWATEaddress}{DW\-\_ATE\-\_address} &  linear machine address (for
136   segmented addresses see
137   Section \refersec{chap:segmentedaddresses}) \\
138 \livetarg{chap:DWATEboolean}{DW\-\_ATE\-\_boolean}& true or false \\
139
140 \livetarg{chap:DWATEcomplexfloat}{DW\-\_ATE\-\_complex\-\_float}& complex binary floating\dash point number \\
141 \livetarg{chap:DWATEfloat}{DW\-\_ATE\-\_float} & binary floating\dash point number \\
142 \livetarg{chap:DWATEimaginaryfloat}{DW\-\_ATE\-\_imaginary\-\_float}& imaginary binary floating\dash point number \\
143 \livetarg{chap:DWATEsigned}{DW\-\_ATE\-\_signed}& signed binary integer \\
144 \livetarg{chap:DWATEsignedchar}{DW\-\_ATE\-\_signed\-\_char}& signed character \\
145 \livetarg{chap:DWATEunsigned}{DW\-\_ATE\-\_unsigned} & unsigned binary integer \\
146 \livetarg{chap:DWATEunsignedchar}{DW\-\_ATE\-\_unsigned\-\_char} & unsigned character \\
147 \livetarg{chap:DWATEpackeddecimal}{DW\-\_ATE\-\_packed\-\_decimal}  & packed decimal \\
148 \livetarg{chap:DWATEnumericstring}{DW\-\_ATE\-\_numeric\-\_string}& numeric string \\
149 \livetarg{chap:DWATEedited}{DW\-\_ATE\-\_edited} & edited string \\
150 \livetarg{chap:DWATEsignedfixed}{DW\-\_ATE\-\_signed\-\_fixed} & signed fixed\dash point scaled integer \\
151 \livetarg{chap:DWATEunsignedfixed}{DW\-\_ATE\-\_unsigned\-\_fixed}& unsigned fixed\dash point scaled integer \\
152 \livetarg{chap:DWATEdecimalfloat}{DW\-\_ATE\-\_decimal\-\_float} & decimal floating\dash point number \\ 
153 \livetarg{chap:DWATEUTF}{DW\-\_ATE\-\_UTF} & Unicode character \\
154 \end{tabular}
155 \caption{Encoding attribute values}
156 \label{fig:encodingattributevalues}
157 \end{figure}
158
159 \textit{The \livelink{chap:DWATEdecimalfloat}{DW\-\_ATE\-\_decimal\-\_float} encoding is intended for
160 floating\dash point representations that have a power\dash of\dash ten
161 exponent, such as that specified in IEEE 754R.}
162
163 \textit{The \livelink{chap:DWATEUTF}{DW\-\_ATE\-\_UTF} encoding is intended for Unicode string
164 encodings (see the Universal Character Set standard,
165 ISO/IEC 10646\dash 1:1993). For example, the C++ type char16\_t is
166 represented by a base type entry with a name attribute whose
167 value is “char16\_t”, an encoding attribute whose value
168 is \livelink{chap:DWATEUTF}{DW\-\_ATE\-\_UTF} and a byte size attribute whose value is 2.}
169
170 The 
171 \livelink{chap:DWATEpackeddecimal}{DW\-\_ATE\-\_packed\-\_decimal} 
172 and 
173 \livelink{chap:DWATEnumericstring}{DW\-\_ATE\-\_numeric\-\_string} 
174 base types
175 represent packed and unpacked decimal string numeric data
176 types, respectively, either of which may be either signed
177 or unsigned. 
178 \hypertarget{chap:DWATdecimalsigndecimalsignrepresentation}
179 These 
180 \hypertarget{chap:DWATdigitcountdigitcountforpackeddecimalornumericstringtype}
181 base types are used in combination with
182 \livelink{chap:DWATdecimalsign}{DW\-\_AT\-\_decimal\-\_sign}, 
183 \livelink{chap:DWATdigitcount}{DW\-\_AT\-\_digit\-\_count} and 
184 \livelink{chap:DWATdecimalscale}{DW\-\_AT\-\_decimal\-\_scale}
185 attributes.
186
187 A \livelink{chap:DWATdecimalsign}{DW\-\_AT\-\_decimal\-\_sign} attribute is an integer constant that
188 conveys the representation of the sign of the decimal type
189 (see Figure \refersec{fig:decimalsignattributevalues}). 
190 Its integer constant value is interpreted to
191 mean that the type has a leading overpunch, trailing overpunch,
192 leading separate or trailing separate sign representation or,
193 alternatively, no sign at all.
194
195 The 
196 \livelink{chap:DWATdigitcount}{DW\-\_AT\-\_digit\-\_count}
197 attribute is an integer constant
198 value that represents the number of digits in an instance of
199 the type.
200
201 \hypertarget{chap:DWATdecimalscaledecimalscalefactor}
202 The \livelink{chap:DWATdecimalscale}{DW\-\_AT\-\_decimal\-\_scale} attribute is an integer constant value
203 that represents the exponent of the base ten scale factor to
204 be applied to an instance of the type. A scale of zero puts the
205 decimal point immediately to the right of the least significant
206 digit. Positive scale moves the decimal point to the right
207 and implies that additional zero digits on the right are not
208 stored in an instance of the type. Negative scale moves the
209 decimal point to the left; if the absolute value of the scale
210 is larger than the digit count, this implies additional zero
211 digits on the left are not stored in an instance of the type.
212
213 The \livelink{chap:DWATEedited}{DW\-\_ATE\-\_edited}
214 base 
215 \hypertarget{chap:DWATpicturestringpicturestringfornumericstringtype}
216 type is used to represent an edited
217 numeric or alphanumeric data type. It is used in combination
218 with an \livelink{chap:DWATpicturestring}{DW\-\_AT\-\_picture\-\_string} attribute whose value is a 
219 null\dash terminated string containing the target\dash dependent picture
220 string associated with the type.
221
222 If the edited base type entry describes an edited numeric
223 data type, the edited type entry has a \livelink{chap:DWATdigitcount}{DW\-\_AT\-\_digit\-\_count} and a
224 \livelink{chap:DWATdecimalscale}{DW\-\_AT\-\_decimal\-\_scale} attribute. These attributes have the same
225 interpretation as described for the \livelink{chap:DWATEpackeddecimal}{DW\-\_ATE\-\_packed\-\_decimal} and
226 \livelink{chap:DWATEnumericstring}{DW\-\_ATE\-\_numeric\-\_string} base types. If the edited type entry
227 describes an edited alphanumeric data type, the edited type
228 entry does not have these attributes.
229
230
231 \textit{The presence or absence of the \livelink{chap:DWATdigitcount}{DW\-\_AT\-\_digit\-\_count} and
232 \livelink{chap:DWATdecimalscale}{DW\-\_AT\-\_decimal\-\_scale} attributes allows a debugger to easily
233 distinguish edited numeric from edited alphanumeric, although
234 in principle the digit count and scale are derivable by
235 interpreting the picture string.}
236
237 The \livelink{chap:DWATEsignedfixed}{DW\-\_ATE\-\_signed\-\_fixed} and \livelink{chap:DWATEunsignedfixed}{DW\-\_ATE\-\_unsigned\-\_fixed} entries
238 describe signed and unsigned fixed\dash point binary data types,
239 respectively.
240
241 The fixed binary type entries have a \livelink{chap:DWATdigitcount}{DW\-\_AT\-\_digit\-\_count}
242 attribute with the same interpretation as described for the
243 \livelink{chap:DWATEpackeddecimal}{DW\-\_ATE\-\_packed\-\_decimal} and \livelink{chap:DWATEnumericstring}{DW\-\_ATE\-\_numeric\-\_string} base types.
244
245 For a data type with a decimal scale factor, the fixed binary
246 type entry has a \livelink{chap:DWATdecimalscale}{DW\-\_AT\-\_decimal\-\_scale} attribute with the same
247 interpretation as described for the \livelink{chap:DWATEpackeddecimal}{DW\-\_ATE\-\_packed\-\_decimal}
248 and \livelink{chap:DWATEnumericstring}{DW\-\_ATE\-\_numeric\-\_string} base types.
249
250 \hypertarget{chap:DWATbinaryscalebinaryscalefactorforfixedpointtype}
251 For a data type with a binary scale factor, the fixed
252 binary type entry has a \livelink{chap:DWATbinaryscale}{DW\-\_AT\-\_binary\-\_scale} attribute. The
253 \livelink{chap:DWATbinaryscale}{DW\-\_AT\-\_binary\-\_scale} attribute is an integer constant value
254 that represents the exponent of the base two scale factor to
255 be applied to an instance of the type.  Zero scale puts the
256 binary point immediately to the right of the least significant
257 bit. Positive scale moves the binary point to the right and
258 implies that additional zero bits on the right are not stored
259 in an instance of the type. Negative scale moves the binary
260 point to the left; if the absolute value of the scale is
261 larger than the number of bits, this implies additional zero
262 bits on the left are not stored in an instance of the type.
263
264 For 
265 \hypertarget{chap:DWATsmallscalefactorforfixedpointtype}
266 a data type with a non\dash decimal and non\dash binary scale factor,
267 the fixed binary type entry has a 
268 \livelink{chap:DWATsmall}{DW\-\_AT\-\_small} attribute which
269 references a 
270 \livelink{chap:DWTAGconstant}{DW\-\_TAG\-\_constant} entry. The scale factor value
271 is interpreted in accordance with the value defined by the
272 \livelink{chap:DWTAGconstant}{DW\-\_TAG\-\_constant} entry. The value represented is the product
273 of the integer value in memory and the associated constant
274 entry for the type.
275
276 \textit{The \livelink{chap:DWATsmall}{DW\-\_AT\-\_small} attribute is defined with the Ada small
277 attribute in mind.}
278
279 \begin{figure}[here]
280 \centering
281 \begin{tabular}{lp{9cm}}
282 Name&Meaning\\ \hline
283 \livetarg{chap:DWDSunsigned}{DW\-\_DS\-\_unsigned} &  unsigned \\
284 \livetarg{chap:DWDSleadingoverpunch}{DW\-\_DS\-\_leading\-\_overpunch} & Sign is encoded in the most significant digit in a target\dash dependent  manner \\
285 \livetarg{chap:DWDStrailingoverpunch}{DW\-\_DS\-\_trailing\-\_overpunch} & Sign is encoded in the least significant digit in a target\dash dependent manner \\
286 \livetarg{chap:DWDSleadingseparate}{DW\-\_DS\-\_leading\-\_separate} 
287 & Decimal type: Sign is a ``+'' or ``-'' character 
288 to the left of the most significant digit. \\
289 \livetarg{chap:DWDStrailingseparate}{DW\-\_DS\-\_trailing\-\_separate} 
290 & Decimal type: Sign is a ``+'' or ``-'' character 
291 to the right of the least significant digit. \\
292 &Packed decimal type: Least significant nibble contains
293 a target\dash dependent value
294 indicating positive or negative. \\
295 \end{tabular}
296 \caption{Decimal sign attribute values}
297 \label{fig:decimalsignattributevalues}
298 \end{figure}
299
300 \section{Unspecified Type Entries}
301 \label{chap:unspecifiedtypeentries}
302 Some languages have constructs in which a type may be left unspecified or the absence of a type
303 may be explicitly indicated.
304
305 An unspecified (implicit, unknown, ambiguous or nonexistent)
306 type is represented by a debugging information entry with
307 the tag \livetarg{chap:DWTAGunspecifiedtype}{DW\-\_TAG\-\_unspecified\-\_type}. 
308 If a name has been given
309 to the type, then the corresponding unspecified type entry
310 has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated
311 string containing the name as it appears in the source program.
312
313 The interpretation of this debugging information entry is
314 intentionally left flexible to allow it to be interpreted
315 appropriately in different languages. For example, in C and C++
316 the language implementation can provide an unspecified type
317 entry with the name “void” which can be referenced by the
318 type attribute of pointer types and typedef declarations for
319 'void' (see 
320 % FIXME: the following reference was wrong in DW4 so DavidA guessed
321 % the intent.
322 Sections \refersec{chap:unspecifiedtypeentries} and 
323 %The following reference was valid, so the following is probably correct.
324 Section \refersec{chap:typedefentries}, 
325 respectively). As another
326 example, in Ada such an unspecified type entry can be referred
327 to by the type attribute of an access type where the denoted
328 type is incomplete (the name is declared as a type but the
329 definition is deferred to a separate compilation unit). Type
330 Modifier Entries
331
332 A base or user\dash defined type may be modified in different ways
333 in different languages. A type modifier is represented in
334 DWARF by a debugging information entry with one of the tags
335 given in 
336 Figure \refersec{fig:typemodifiertags}.
337
338
339 If a name has been given to the modified type in the source
340 program, then the corresponding modified type entry has
341 a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null-terminated
342 string containing the modified type name as it appears in
343 the source program.
344
345 Each of the type modifier entries has a 
346 \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute,
347 whose value is a reference to a debugging information entry
348 describing a base type, a user-defined type or another type
349 modifier.
350
351 A modified type entry describing a pointer or reference
352 type (using \livelink{chap:DWTAGpointertype}{DW\-\_TAG\-\_pointer\-\_type}, \livelink{chap:DWTAGreferencetype}{DW\-\_TAG\-\_reference\-\_type} or
353 \livelink{chap:DWTAGrvaluereferencetype}{DW\-\_TAG\-\_rvalue\-\_reference\-\_type}) 
354 may have 
355 \hypertarget{chap:DWATadressclasspointerorreferencetypes}
356
357 \livelink{chap:DWATaddressclass}{DW\-\_AT\-\_address\-\_class}
358 attribute to describe how objects having the given pointer
359 or reference type ought to be dereferenced.
360
361 A modified type entry describing a shared qualified type
362 (using \livelink{chap:DWTAGsharedtype}{DW\-\_TAG\-\_shared\-\_type}) may have a \livelink{chap:DWATcount}{DW\-\_AT\-\_count} attribute
363 whose value is a constant expressing the blocksize of the
364 type. If no count attribute is present, then the “infinite”
365 blocksize is assumed.
366
367 When multiple type modifiers are chained together to modify
368 a base or user-defined type, the tree ordering reflects the
369 semantics of the applicable lanuage rather than the textual
370 order in the source presentation.
371
372 \begin{figure}[here]
373 \centering
374 \begin{tabular}{lp{9cm}}
375 Name&Meaning\\ \hline
376 \livetarg{chap:DWTAGconsttype}{DW\-\_TAG\-\_const\-\_type} &  C or C++ const qualified type \\
377 \livetarg{chap:DWTAGpackedtype}{DW\-\_TAG\-\_packed\-\_type}& Pascal or Ada packed type \\
378 \livetarg{chap:DWTAGpointertype}{DW\-\_TAG\-\_pointer\-\_type} & Pointer to an object of the type being modified \\
379 \livetarg{chap:DWTAGreferencetype}{DW\-\_TAG\-\_reference\-\_type}& C++ (lvalue) reference to an object of the type 
380 being modified \\
381 \livetarg{chap:DWTAGrestricttype}{DW\-\_TAG\-\_restrict\-\_type}&C restrict qualified type \\
382 \livetarg{chap:DWTAGrvaluereferencetype}{DW\-\_TAG\-\_rvalue\-\_reference\-\_type} & C++ rvalue reference to an object of the type
383 being modified \\
384 \livetarg{chap:DWTAGsharedtype}{DW\-\_TAG\-\_shared\-\_type}&UPC shared qualified type \\
385 \livetarg{chap:DWTAGvolatiletype}{DW\-\_TAG\-\_volatile\-\_type}&C or C++ volatile qualified type \\
386 \end{tabular}
387 \caption{Type modifier tags}
388 \label{fig:typemodifiertags}
389 \end{figure}
390
391 % The following prevents splitting the examples up.
392 % FIXME perhaps there is a better way. We could box the verbatim, 
393 % see memman.pdf on verbatims.
394 \clearpage
395 \textit{As examples of how tye modifiers are ordered, take the following C
396 declarations:}
397
398 \begin{verbatim}
399 const unsigned char * volatile p;
400     which represents a volatile pointer to a constant
401     character. This is encoded in DWARF as:
402         \livelink{chap:DWTAGvariable}{DW\-\_TAG\-\_variable}(p) -->
403             \livelink{chap:DWTAGvolatiletype}{DW\-\_TAG\-\_volatile\-\_type} -->
404                 \livelink{chap:DWTAGpointertype}{DW\-\_TAG\-\_pointer\-\_type} -->
405                     \livelink{chap:DWTAGconsttype}{DW\-\_TAG\-\_const\-\_type} -->
406                         \livelink{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type}(unsigned char)
407
408 volatile unsigned char * const restrict p;
409     on the other hand, represents a restricted constant
410     pointer to a volatile character. This is encoded as:
411         \livelink{chap:DWTAGvariable}{DW\-\_TAG\-\_variable}(p) -->
412             \livelink{chap:DWTAGrestricttype}{DW\-\_TAG\-\_restrict\-\_type} -->
413                 \livelink{chap:DWTAGconsttype}{DW\-\_TAG\-\_const\-\_type} -->
414                     \livelink{chap:DWTAGpointertype}{DW\-\_TAG\-\_pointer\-\_type} -->
415                         \livelink{chap:DWTAGvolatiletype}{DW\-\_TAG\-\_volatile\-\_type} -->
416                             \livelink{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type}(unsigned char)
417
418 \end{verbatim}
419
420 \section{Typedef Entries}
421 \label{chap:typedefentries}
422 A named type that is defined in terms of another type
423 definition is represented by a debugging information entry with
424 the tag \livetarg{chap:DWTAGtypedef}{DW\-\_TAG\-\_typedef}. 
425 The typedef entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name}
426 attribute whose value is a null-terminated string containing
427 the name of the typedef as it appears in the source program.
428
429 The typedef entry may also contain a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute whose
430 value is a reference to the type named by the typedef. If
431 the debugging information entry for a typedef represents
432 a declaration of the type that is not also a definition,
433 it does not contain a type attribute.
434
435 \textit{Depending on the language, a named type that is defined in
436 terms of another type may be called a type alias, a subtype,
437 a constrained type and other terms. A type name declared with
438 no defining details may be termed an incomplete, forward
439 or hidden type. While the DWARF \livelink{chap:DWTAGtypedef}{DW\-\_TAG\-\_typedef} entry was
440 originally inspired by the like named construct in C and C++,
441 it is broadly suitable for similar constructs (by whatever
442 source syntax) in other languages.}
443
444 \section{Array Type Entries}
445 \label{chap:arraytypeentries}
446
447 Many languages share the concept of an ``array,'' which is
448 a table of components of identical type.
449
450 An array type is represented by a debugging information entry
451 with the tag \livetarg{chap:DWTAGarraytype}{DW\-\_TAG\-\_array\-\_type}. 
452 If a name has been given to
453 the array type in the source program, then the corresponding
454 array type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a
455 null-terminated string containing the array type name as it
456 appears in the source program.
457
458 The 
459 \hypertarget{chap:DWATorderingarrayrowcolumnordering}
460 array type entry describing a multidimensional array may
461 have a \livelink{chap:DWATordering}{DW\-\_AT\-\_ordering} attribute whose integer constant value is
462 interpreted to mean either row-major or column-major ordering
463 of array elements. The set of values and their meanings
464 for the ordering attribute are listed in 
465 Figure \refersec{fig:arrayordering}. 
466 If no
467 ordering attribute is present, the default ordering for the
468 source language (which is indicated by the \livelink{chap:DWATlanguage}{DW\-\_AT\-\_language}
469 attribute of the enclosing compilation unit entry) is assumed.
470
471 \begin{figure}[here]
472 \autorows[0pt]{c}{1}{l}{
473 \livetarg{chap:DWORDcolmajor}{DW\-\_ORD\-\_col\-\_major},
474 \livetarg{chap:DWORDrowmajor}{DW\-\_ORD\-\_row\-\_major}
475 }
476 \caption{Array ordering}\label{fig:arrayordering}
477 \end{figure}
478
479 The ordering attribute may optionally appear on one-dimensional
480 arrays; it will be ignored.
481
482 An array type entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute describing
483 the type of each element of the array.
484
485 If the amount of storage allocated to hold each element of an
486 object of the given array type is different from the amount
487 of storage that is normally allocated to hold an individual
488 \hypertarget{chap:DWATbitstridearrayelementstrideofarraytype}
489 object of the 
490 \hypertarget{chap:DWATbytestridearrayelementstrideofarraytype}
491 indicated element type, then the array type
492 entry has either a \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride} or a \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride}
493 attribute, whose value 
494 (see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
495 is the size of each
496 element of the array.
497
498 The array type entry may have either a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} or a
499 \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute 
500 (see Section \refersec{chap:byteandbitsizes}), 
501 whose value is the
502 amount of storage needed to hold an instance of the array type.
503
504 \textit{If the size of the array can be determined statically at
505 compile time, this value can usually be computed by multiplying
506 the number of array elements by the size of each element.}
507
508
509 Each array dimension is described by a debugging information
510 entry with either the tag \livelink{chap:DWTAGsubrangetype}{DW\-\_TAG\-\_subrange\-\_type} or the tag
511 \livelink{chap:DWTAGenumerationtype}{DW\-\_TAG\-\_enumeration\-\_type}. These entries are children of the
512 array type entry and are ordered to reflect the appearance of
513 the dimensions in the source program (i.e., leftmost dimension
514 first, next to leftmost second, and so on).
515
516 In languages, such as C, in which there is no concept of
517 a “multidimensional array”, an array of arrays may
518 be represented by a debugging information entry for a
519 multidimensional array.
520
521 Other attributes especially applicable to arrays are
522 \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated}, 
523 \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated} and 
524 \livelink{chap:DWATdatalocation}{DW\-\_AT\-\_data\-\_location},
525 which are described in 
526 Section \refersec{chap:dynamictypeproperties}. 
527 For relevant examples,
528 see also 
529 Appendix \refersec{app:fortran90example}.
530
531 \section{ Structure, Union, Class and Interface Type Entries}
532 \label{chap:structureunionclassandinterfacetypeentries}
533
534 \textit{The languages C, C++, and Pascal, among others, allow the
535 programmer to define types that are collections of related
536 components. In C and C++, these collections are called
537 “structures.” In Pascal, they are called “records.”
538 The components may be of different types. The components are
539 called “members” in C and C++, and “fields” in Pascal.}
540
541 \textit{The components of these collections each exist in their
542 own space in computer memory. The components of a C or C++
543 “union” all coexist in the same memory.}
544
545 \textit{Pascal and other languages have a “discriminated union,”
546 also called a “variant record.” Here, selection of a
547 number of alternative substructures (“variants”) is based
548 on the value of a component that is not part of any of those
549 substructures (the “discriminant”).}
550
551 \textit{C++ and Java have the notion of "class”, which is in some
552 ways similar to a structure. A class may have “member
553 functions” which are subroutines that are within the scope
554 of a class or structure.}
555
556 \textit{The C++ notion of structure is more general than in C, being
557 equivalent to a class with minor differences. Accordingly,
558 in the following discussion statements about C++ classes may
559 be understood to apply to C++ structures as well.}
560
561 \subsection{Structure, Union and Class Type Entries}
562 \label{chap:structureunionandclasstypeentries}
563
564
565 Structure, union, and class types are represented by debugging
566 information entries with 
567 the tags \livetarg{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type},
568 \livetarg{chap:DWTAGuniontype}{DW\-\_TAG\-\_union\-\_type}, 
569 and \livetarg{chap:DWTAGclasstype}{DW\-\_TAG\-\_class\-\_type},
570 respectively. If a name has been given to the structure,
571 union, or class in the source program, then the corresponding
572 structure type, union type, or class type entry has a
573 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated string
574 containing the type name as it appears in the source program.
575
576 The members of a structure, union, or class are represented
577 by debugging information entries that are owned by the
578 corresponding structure type, union type, or class type entry
579 and appear in the same order as the corresponding declarations
580 in the source program.
581
582 A structure type, union type or class type entry may have
583 either a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} or a \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute 
584 \hypertarget{chap:DWATbitsizedatamemberbitsize}
585 (see Section \refersec{chap:byteandbitsizes}), 
586 whose value is the amount of storage needed
587 to hold an instance of the structure, union or class type,
588 including any padding.  An incomplete structure, union or
589 class type is represented by a structure, union or class
590 entry that does not have a byte size attribute and that has
591 a \livelink{chap:DWATdeclaration}{DW\-\_AT\-\_declaration} attribute.
592
593 If the complete declaration of a type has been placed in
594 \hypertarget{chap:DWATsignaturetypesignature}
595 a separate type unit 
596 (see Section \refersec{chap:separatetypeunitentries}), 
597 an incomplete
598 declaration of that type in the compilation unit may provide
599 the unique 64\dash bit signature of the type using a \livelink{chap:DWATsignature}{DW\-\_AT\-\_signature}
600 attribute.
601
602 If a structure, union or class entry represents the definition
603 of a structure, class or union member corresponding to a prior
604 incomplete structure, class or union, the entry may have a
605 \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification} attribute whose value is a reference to
606 the debugging information entry representing that incomplete
607 declaration.
608
609 Structure, union and class entries containing the
610 \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification} attribute do not need to duplicate
611 information provided by the declaration entry referenced by the
612 specification attribute.  In particular, such entries do not
613 need to contain an attribute for the name of the structure,
614 class or union they represent if such information is already
615 provided in the declaration.
616
617 \textit{For C and C++, data member declarations occurring within
618 the declaration of a structure, union or class type are
619 considered to be “definitions” of those members, with
620 the exception of “static” data members, whose definitions
621 appear outside of the declaration of the enclosing structure,
622 union or class type. Function member declarations appearing
623 within a structure, union or class type declaration are
624 definitions only if the body of the function also appears
625 within the type declaration.}
626
627 If the definition for a given member of the structure, union
628 or class does not appear within the body of the declaration,
629 that member also has a debugging information entry describing
630 its definition. That latter entry has a \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification}
631 attribute referencing the debugging information entry
632 owned by the body of the structure, union or class entry and
633 representing a non\dash defining declaration of the data, function
634 or type member. The referenced entry will not have information
635 about the location of that member (low and high pc attributes
636 for function members, location descriptions for data members)
637 and will have a \livelink{chap:DWATdeclaration}{DW\-\_AT\-\_declaration} attribute.
638
639 \textit{Consider a nested class whose 
640 definition occurs outside of the containing class definition, as in:}
641
642 \begin{lstlisting}
643 struct A {
644     struct B;
645 };
646 struct A::B { ... };
647 \end{lstlisting}
648
649 \textit{The two different structs can be described in 
650 different compilation units to 
651 facilitate DWARF space compression 
652 (see Appendix \refersec{app:usingcompilationunits}).}
653
654 \subsection{Interface Type Entries}
655 \label{chap:interfacetypeentries}
656
657 \textit{The Java language defines "interface" types. An interface
658 in Java is similar to a C++ or Java class with only abstract
659 methods and constant data members.}
660
661 Interface types are represented by debugging information
662 entries with the 
663 tag \livetarg{chap:DWTAGinterfacetype}{DW\-\_TAG\-\_interface\-\_type}.
664
665 An interface type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose
666 value is a null-terminated string containing the type name
667 as it appears in the source program.
668
669 The members of an interface are represented by debugging
670 information entries that are owned by the interface type
671 entry and that appear in the same order as the corresponding
672 declarations in the source program.
673
674 \subsection{Derived or Extended Structs, Classes and Interfaces}
675 \label{chap:derivedorextendedstructsclasesandinterfaces}
676
677 \textit{In C++, a class (or struct) may be ``derived from'' or be a
678 ``subclass of'' another class. In Java, an interface may ``extend''
679 one or more other interfaces, and a class may "extend" another
680 class and/or "implement" one or more interfaces. All of these
681 relationships may be described using the following. Note that
682 in Java, the distinction between extends and implements is
683 implied by the entities at the two ends of the relationship.}
684
685 A class type or interface type entry that describes a
686 derived, extended or implementing class or interface owns
687 debugging information entries describing each of the classes
688 or interfaces it is derived from, extending or implementing,
689 respectively, ordered as they were in the source program. Each
690 such entry has the 
691 tag \livetarg{chap:DWTAGinheritance}{DW\-\_TAG\-\_inheritance}.
692
693 An inheritance entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute whose value is
694 a reference to the debugging information entry describing the
695 class or interface from which the parent class or structure
696 of the inheritance entry is derived, extended or implementing.
697
698 An inheritance entry for a class that derives from or extends
699 \hypertarget{chap:DWATdatamemberlocationinheritedmemberlocation}
700 another class or struct also has a 
701 \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location}
702 attribute, whose value describes the location of the beginning
703 of the inherited type relative to the beginning address of the
704 derived class. If that value is a constant, it is the offset
705 in bytes from the beginning of the class to the beginning of
706 the inherited type. Otherwise, the value must be a location
707 description. In this latter case, the beginning address of
708 the derived class is pushed on the expression stack before
709 the location description is evaluated and the result of the
710 evaluation is the location of the inherited type.
711
712 \textit{The interpretation of the value of this attribute for
713 inherited types is the same as the interpretation for data
714 members 
715 (see Section \refersec{chap:datamemberentries}).  }
716
717 An inheritance entry 
718 \hypertarget{chap:DWATaccessibilitycppinheritedmembers}
719 may have a
720 \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility}
721 attribute. If no accessibility attribute
722 is present, private access is assumed for an entry of a class
723 and public access is assumed for an entry of an interface,
724 struct or union.
725
726 If the class referenced by the inheritance entry serves
727 as a C++ virtual base class, the inheritance entry has a
728 \livelink{chap:DWATvirtuality}{DW\-\_AT\-\_virtuality} attribute.
729
730 \textit{For a C++ virtual base, the data member location attribute
731 will usually consist of a non-trivial location description.}
732
733 \subsection{Access Declarations}
734 \label{chap:accessdeclarations}
735
736 \textit{In C++, a derived class may contain access declarations that
737 change the accessibility of individual class members from the
738 overall accessibility specified by the inheritance declaration.
739 A single access declaration may refer to a set of overloaded
740 names.}
741
742 If a derived class or structure contains access declarations,
743 each such declaration may be represented by a debugging
744 information entry with the tag 
745 \livetarg{chap:DWTAGaccessdeclaration}{DW\-\_TAG\-\_access\-\_declaration}. 
746 Each
747 such entry is a child of the class or structure type entry.
748
749 An access declaration entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose
750 value is a null-terminated string representing the name used
751 in the declaration in the source program, including any class
752 or structure qualifiers.
753
754 An access declaration entry 
755 \hypertarget{chap:DWATaccessibilitycppbaseclasses}
756 also has a 
757 \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility}
758 attribute describing the declared accessibility of the named
759 entities.
760
761
762 \subsection{Friends}
763 \label{chap:friends}
764
765 Each ``friend'' declared by a structure, union or class
766 type may be represented by a debugging information entry
767 that is a child of the structure, union or class type entry;
768 the friend entry has the 
769 tag \livetarg{chap:DWTAGfriend}{DW\-\_TAG\-\_friend}.
770
771 A friend entry has a \livelink{chap:DWATfriend}{DW\-\_AT\-\_friend} attribute, whose value is
772 a reference to the debugging information entry describing
773 the declaration of the friend.
774
775
776 \subsection{Data Member Entries}
777 \label{chap:datamemberentries}
778
779 A data member (as opposed to a member function) is
780 represented by a debugging information entry with the 
781 tag \livetarg{chap:DWTAGmember}{DW\-\_TAG\-\_member}. 
782 The member entry for a named member has
783 a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null-terminated
784 string containing the member name as it appears in the source
785 program. If the member entry describes an anonymous union, the
786 name attribute is omitted or consists of a single zero byte.
787
788 The data member entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to denote
789 the type of that member.
790
791 A data member entry may have a \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility}
792 attribute. If no accessibility attribute is present, private
793 access is assumed for an entry of a class and public access
794 is assumed for an entry of a structure, union, or interface.
795
796 A data member 
797 \hypertarget{chap:DWATmutablemutablepropertyofmemberdata}
798 entry may have a \livelink{chap:DWATmutable}{DW\-\_AT\-\_mutable} attribute,
799 which is a \livelink{chap:flag}{flag}. 
800 This attribute indicates whether the data
801 member was declared with the mutable storage class specifier.
802
803 The beginning of a data member is described relative to
804 the beginning of the object in which it is immediately
805 contained. In general, the beginning is characterized by
806 both an address and a bit offset within the byte at that
807 address. When the storage for an entity includes all of
808 the bits in the beginning byte, the beginning bit offset is
809 defined to be zero.
810
811 Bit offsets in DWARF use the bit numbering and direction
812 conventions that are appropriate to the current language on
813 the target system.
814
815 The member entry corresponding to a data member that is
816 \hypertarget{chap:DWATdatabitoffsetdatamemberbitlocation}
817 defined 
818 \hypertarget{chap:DWATdatamemberlocationdatamemberlocation}
819 in a structure, union or class may have either a
820 \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} attribute or a \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset}
821 attribute. If the beginning of the data member is the same as
822 the beginning of the containing entity then neither attribute
823 is required.
824
825 For a \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} attribute there are two cases:
826
827 \begin{enumerate}[1.]
828
829 \item If the value is an integer constant, it is the offset
830 in bytes from the beginning of the containing entity. If
831 the beginning of the containing entity has a non-zero bit
832 offset then the beginning of the member entry has that same
833 bit offset as well.
834
835 \item Otherwise, the value must be a location description. In
836 this case, the beginning of the containing entity must be byte
837 aligned. The beginning address is pushed on the DWARF stack
838 before the location description is evaluated; the result of
839 the evaluation is the base address of the member entry.
840
841 \textit{The push on the DWARF expression stack of the base address of
842 the containing construct is equivalent to execution of the
843 \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address} operation 
844 (see Section \refersec{chap:stackoperations});
845 \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address} therefore is not needed at the
846 beginning of a location description for a data member. The
847 result of the evaluation is a location--either an address or
848 the name of a register, not an offset to the member.}
849
850 \textit{A \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} attribute that has the form of a
851 location description is not valid for a data member contained
852 in an entity that is not byte aligned because DWARF operations
853 do not allow for manipulating or computing bit offsets.}
854
855 \end{enumerate}
856
857 For a \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} attribute, the value is an integer
858 constant 
859 (see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
860 that specifies the number of bits
861 from the beginning of the containing entity to the beginning
862 of the data member. This value must be greater than or equal
863 to zero, but is not limited to less than the number of bits
864 per byte.
865
866 If the size of a data member is not the same as the size
867 of the type given for the data member, the data member has
868 either a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} or a \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute whose
869 integer constant value 
870 (see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
871 is the amount
872 of storage needed to hold the value of the data member.
873
874 \textit{C and C++ bit fields typically require the use of the
875 \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} and \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attributes.}
876
877 \textit{This Standard uses the following bit numbering and direction
878 conventions in examples. These conventions are for illustrative
879 purposes and other conventions may apply on particular
880 architectures.}
881
882
883 \begin{itemize}
884 \item \textit{For big\dash endian architectures, bit offsets are
885 counted from high-order to low\dash order bits within a byte (or
886 larger storage unit); in this case, the bit offset identifies
887 the high\dash order bit of the object.}
888
889 \item \textit{For little\dash endian architectures, bit offsets are
890 counted from low\dash order to high\dash order bits within a byte (or
891 larger storage unit); in this case, the bit offset identifies
892 the low\dash order bit of the object.}
893 \end{itemize}
894
895
896 \textit{In either case, the bit so identified is defined as the beginning of the object.}
897
898 \textit{For example, take one possible representation of the following C structure definition in both big\dash and little\dash endian byte orders:}
899
900 \begin{lstlisting}
901 struct S {
902     int j:5;
903     int k:6;
904     int m:5;
905     int n:8;
906 };
907 \end{lstlisting}
908
909 \textit{The following diagrams show the structure layout
910 and data bit offsets for example big\dash\   and little\dash endian
911 architectures, respectively. Both diagrams show a structure
912 that begins at address A and whose size is four bytes. Also,
913 high order bits are to the left and low order bits are to
914 the right.}
915
916 \textit{Big\dash Endian Data Bit Offsets:}
917
918 \begin{verbatim}
919     j:0
920     k:5
921     m:11
922     n:16
923
924     Addresses increase ->
925     |       A       |     A + 1     |    A + 2      |    A + 3      | 
926
927     Data bit offsets increase ->
928     +---------------+---------------+---------------+---------------+
929     |0     4|5         10|11      15|16           23|24           31|
930     |   j   |     k      | m        |        n      |       <pad>   |
931     |       |            |          |               |               | 
932     +---------------------------------------------------------------+ 
933 \end{verbatim}
934
935 \textit{Little\dash  Endian Data Bit Offsets:}
936 \begin{verbatim}
937     j:0
938     k:5
939     m:11
940     n:16
941                                                <- Addresses increase
942     |       A       |     A + 1     |    A + 2      |    A + 3      | 
943
944                                         <-  Data bit offsets increase 
945
946     +---------------+---------------+---------------+---------------+
947     |31           24|23           16|15     11|10       5|4        0|
948     |     <pad>     |        n      |    m    |    k     |     j    |
949     |               |               |         |          |          |
950     +---------------------------------------------------------------+
951
952 \end{verbatim}
953
954 \textit{Note that data member bit offsets in this example are the
955 same for both big\dash\ and little\dash endian architectures even
956 though the fields are allocated in different directions
957 (high\dash order to low-order versus low\dash order to high\dash order);
958 the bit naming conventions for memory and/or registers of
959 the target architecture may or may not make this seem natural.}
960
961 \textit{For a more extensive example showing nested and packed records
962 and arrays, see 
963 Appendix \refersec{app:pascalexample}.}
964
965 \textit{Attribute \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} is new in DWARF Version 4 and
966 is also used for base types 
967 (see Section \refersec{chap:basetypeentries}). 
968 It replaces the
969 \livetarg{chap:DWATbitoffsetdatamemberbitlocation}
970 attributes \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} and \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} when used to
971 identify the beginning of bit field data members as defined
972 in DWARF V3 and earlier. The earlier attributes are defined
973 in a manner suitable for bit field members on big-endian
974 architectures but which is either awkward or incomplete for
975 use on little-endian architectures.  (\livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} also
976 has other uses that are not affected by this change.)}
977
978 \textit{The \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} and 
979 \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset}
980 attribute combination is deprecated for data members in DWARF
981 Version 4, but implementations may continue to support this
982 use for compatibility.}
983
984 \textit{The DWARF Version 3 definitions of these attributes are
985 as follows.}
986
987 \begin{myindentpara}{1cm}
988 \textit{If the data member entry describes a bit field, then that
989 entry has the following attributes:}
990
991 \begin{itemize}
992 \item \textit{A \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute whose value (see Section
993 2.19) is the number of bytes that contain an instance of the
994 bit field and any padding bits.}
995
996 \textit{The byte size attribute may be omitted if the size of the
997 object containing the bit field can be inferred from the type
998 attribute of the data member containing the bit field.}
999
1000 \item \textit{A \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} attribute whose value (see Section
1001 2.19) is the number of bits to the left of the leftmost
1002 (most significant) bit of the bit field value.}
1003
1004 \item \textit{A \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute whose value (see Section
1005 2.19) is the number of bits occupied by the bit field value.}
1006
1007 \end{itemize}
1008
1009 \textit{The location description for a bit field calculates the address
1010 of an anonymous object containing the bit field. The address
1011 is relative to the structure, union, or class that most closely
1012 encloses the bit field declaration. The number of bytes in this
1013 anonymous object is the value of the byte size attribute of
1014 the bit field. The offset (in bits) from the most significant
1015 bit of the anonymous object to the most significant bit of
1016 the bit field is the value of the bit offset attribute.}
1017 \end{myindentpara}
1018
1019
1020 \textit{Diagrams similar to the above that show the use of the
1021 \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} and \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} attribute
1022 combination may be found in the DWARF Version 3 Standard.}
1023
1024 \textit{In comparing DWARF Versions 3 and 4, note that DWARF V4
1025 defines the following combinations of attributes:}
1026
1027 \begin{itemize}
1028 \item \textit{either \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} or
1029 \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} (to specify the beginning of the
1030 data member)}
1031
1032 % FIXME: the indentation of the following line is suspect.
1033 \textit{optionally together with}
1034
1035 \item  \textit{either \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} (to
1036 specify the size of the data member)}
1037
1038 \end{itemize}
1039
1040 \textit{DWARF V3 defines the following combinations}
1041
1042 \begin{itemize}
1043 \item \textit{\livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} (to specify the beginning
1044 of the data member, except this specification is only partial
1045 in the case of a bit field) }
1046
1047 % FIXME: the indentation of the following line is suspect.
1048 \textit{optionally together with}
1049
1050 \item \textit{\livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} and \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset}
1051 (to further specify the beginning of a bit field data member
1052 as well as specify the size of the data member) }
1053 \end{itemize}
1054
1055 \subsection{Member Function Entries}
1056 \label{chap:memberfunctionentries}
1057
1058 A member function is represented by a debugging information
1059 entry with the tag \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram}. The member function entry
1060 may contain the same attributes and follows the same rules
1061 as non\dash member global subroutine entries 
1062 (see Section \refersec{chap:subroutineandentrypointentries}).
1063
1064 A member function entry may have a \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility}
1065 attribute. If no accessibility attribute is present, private
1066 access is assumed for an entry of a class and public access
1067 is assumed for an entry of a structure, union or interface.
1068
1069 If the member function entry describes a virtual function,
1070 then that entry has a \livelink{chap:DWATvirtuality}{DW\-\_AT\-\_virtuality} attribute.
1071
1072 If 
1073 \hypertarget{chap:DWATexplicitexplicitpropertyofmemberfunction}
1074 the member function entry describes an explicit member
1075 function, then that entry has a 
1076 \livelink{chap:DWATexplicit}{DW\-\_AT\-\_explicit} attribute.
1077
1078 An entry for a virtual function also has a
1079 \livelink{chap:DWATvtableelemlocation}{DW\-\_AT\-\_vtable\-\_elem\-\_location} attribute whose value contains
1080 a location description yielding the address of the slot
1081 for the function within the virtual function table for the
1082 enclosing class. The address of an object of the enclosing
1083 type is pushed onto the expression stack before the location
1084 description is evaluated.
1085
1086 If 
1087 \hypertarget{chap:DWATobjectpointerobjectthisselfpointerofmemberfunction}
1088 the member function entry describes a non\dash static member
1089 function, then that entry has a \livelink{chap:DWATobjectpointer}{DW\-\_AT\-\_object\-\_pointer} attribute
1090 whose value is a reference to the formal parameter entry
1091 that corresponds to the object for which the function is
1092 called. The name attribute of that formal parameter is defined
1093 by the current language (for example, this for C++ or self
1094 for Objective C and some other languages). That parameter
1095 also has a \livelink{chap:DWATartificial}{DW\-\_AT\-\_artificial} attribute whose value is true.
1096
1097 Conversely, if the member function entry describes a static
1098 member function, the entry does not have a \livelink{chap:DWATobjectpointer}{DW\-\_AT\-\_object\-\_pointer}
1099 attribute.
1100
1101 If the member function entry describes a non\dash static member
1102 function that has a const\dash volatile qualification, then
1103 the entry describes a non\dash static member function whose
1104 object formal parameter has a type that has an equivalent
1105 const\dash volatile qualification.
1106
1107 If a subroutine entry represents the defining declaration
1108 of a member function and that definition appears outside of
1109 the body of the enclosing class declaration, the subroutine
1110 entry has a \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification} attribute, whose value is
1111 a reference to the debugging information entry representing
1112 the declaration of this function member. The referenced entry
1113 will be a child of some class (or structure) type entry.
1114
1115 Subroutine entries containing the \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification}
1116 attribute do not need to duplicate information provided
1117 by the declaration entry referenced by the specification
1118 attribute. In particular, such entries do not need to contain
1119 attributes for the name or return type of the function member
1120 whose definition they represent.
1121
1122 \subsection{Class Template Instantiations}
1123 \label{chap:classtemplateinstantiations}
1124
1125 \textit{In C++ a class template is a generic definition of a class
1126 type that may be instantiated when an instance of the class
1127 is declared or defined. The generic description of the
1128 class may include both parameterized types and parameterized
1129 constant values. DWARF does not represent the generic template
1130 definition, but does represent each instantiation.}
1131
1132 A class template instantiation is represented by a
1133 debugging information entry with the tag \livelink{chap:DWTAGclasstype}{DW\-\_TAG\-\_class\-\_type},
1134 \livelink{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type} or \livelink{chap:DWTAGuniontype}{DW\-\_TAG\-\_union\-\_type}. With five
1135 exceptions, such an entry will contain the same attributes
1136 and have the same types of child entries as would an entry
1137 for a class type defined explicitly using the instantiation
1138 types and values. The exceptions are:
1139
1140 \begin{enumerate}[1.]
1141 \item Each formal parameterized type declaration appearing in the
1142 template definition is represented by a debugging information
1143 entry with the tag \livelink{chap:DWTAGtemplatetypeparameter}{DW\-\_TAG\-\_template\-\_type\-\_parameter}. Each
1144 such entry may have a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is
1145 a null\dash terminated string containing the name of the formal
1146 type parameter as it appears in the source program. The
1147 template type parameter entry also has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute
1148 describing the actual type by which the formal is replaced
1149 for this instantiation.
1150
1151 \item Each formal parameterized value declaration appearing in the
1152 template definition is represented by a debugging information
1153 entry with the 
1154 tag \livetarg{chap:DWTAGtemplatevalueparameter}{DW\-\_TAG\-\_template\-\_value\-\_parameter}. 
1155 Each
1156 such entry may have a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is
1157 a null\dash terminated string containing the name of the formal
1158 value parameter as it appears in the source program. 
1159 The
1160 \hypertarget{chap:DWATconstvaluetemplatevalueparameter}
1161 template value parameter entry also has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute
1162 describing the type of the parameterized value. Finally,
1163 the template value parameter entry has a \livelink{chap:DWATconstvalue}{DW\-\_AT\-\_const\-\_value}
1164 attribute, whose value is the actual constant value of the
1165 value parameter for this instantiation as represented on the
1166 target architecture.
1167
1168 \item The class type entry and each of its child entries references
1169 a template type parameter entry in any circumstance where the
1170 source template definition references a formal parameterized
1171 type. Similarly, the class type entry and each of its child
1172 entries references a template value parameter entry in any
1173 circumstance where the source template definition references
1174 a formal parameterized value.
1175
1176 \item If the compiler has generated a special compilation unit to
1177 hold the template instantiation and that special compilation
1178 unit has a different name from the compilation unit containing
1179 the template definition, the name attribute for the debugging
1180 information entry representing the special compilation unit
1181 should be empty or omitted.
1182
1183 \item If the class type entry representing the template
1184 instantiation or any of its child entries contains declaration
1185 coordinate attributes, those attributes should refer to
1186 the source for the template definition, not to any source
1187 generated artificially by the compiler.
1188 \end{enumerate}
1189
1190
1191 \subsection{Variant Entries}
1192 \label{chap:variantentries}
1193
1194 A variant part of a structure is represented by a debugging
1195 information entry with the 
1196 tag \livetarg{chap:DWTAGvariantpart}{DW\-\_TAG\-\_variant\-\_part} and is
1197 owned by the corresponding structure type entry.
1198
1199 If the variant part has a discriminant, the discriminant is
1200 \hypertarget{chap:DWATdiscrdiscriminantofvariantpart}
1201 represented by a separate debugging information entry which
1202 is a child of the variant part entry. This entry has the form
1203 of a structure data member entry. The variant part entry will
1204 have a 
1205 \livelink{chap:DWATdiscr}{DW\-\_AT\-\_discr} attribute whose value is a reference to
1206 the member entry for the discriminant.
1207
1208 If the variant part does not have a discriminant (tag field),
1209 the variant part entry has a 
1210 \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to represent
1211 the tag type.
1212
1213 Each variant of a particular variant part is represented by
1214 \hypertarget{chap:DWATdiscrvaluediscriminantvalue}
1215 a debugging information entry with the 
1216 tag \livetarg{chap:DWTAGvariant}{DW\-\_TAG\-\_variant}
1217 and is a child of the variant part entry. The value that
1218 selects a given variant may be represented in one of three
1219 ways. The variant entry may have a 
1220 \livelink{chap:DWATdiscrvalue}{DW\-\_AT\-\_discr\-\_value} attribute
1221 whose value represents a single case label. The value of this
1222 attribute is encoded as an LEB128 number. The number is signed
1223 if the tag type for the variant part containing this variant
1224 is a signed type. The number is unsigned if the tag type is
1225 an unsigned type.
1226
1227 Alternatively, 
1228 \hypertarget{chap:DWATdiscrlistlistofdiscriminantvalues}
1229 the variant entry may contain a 
1230 \livelink{chap:DWATdiscrlist}{DW\-\_AT\-\_discr\-\_list}
1231 attribute, whose value represents a list of discriminant
1232 values. This list is represented by any of the 
1233 \livelink{chap:block}{block} forms and
1234 may contain a mixture of case labels and label ranges. Each
1235 item on the list is prefixed with a discriminant value
1236 descriptor that determines whether the list item represents
1237 a single label or a label range. A single case label is
1238 represented as an LEB128 number as defined above for the
1239 \livelink{chap:DWATdiscrvalue}{DW\-\_AT\-\_discr\-\_value} attribute. A label range is represented by
1240 two LEB128 numbers, the low value of the range followed by the
1241 high value. Both values follow the rules for signedness just
1242 described. The discriminant value descriptor is an integer
1243 constant that may have one of the values given in 
1244 Figure \refersec{fig:discriminantdescriptorvalues}.
1245
1246 \begin{figure}[here]
1247 \autorows[0pt]{c}{1}{l}{
1248 \addtoindex{DW\-\_DSC\-\_label},
1249 \addtoindex{DW\-\_DSC\-\_range}
1250 }
1251 \caption{Discriminant descriptor values}\label{fig:discriminantdescriptorvalues}
1252 \end{figure}
1253
1254 If a variant entry has neither a \livelink{chap:DWATdiscrvalue}{DW\-\_AT\-\_discr\-\_value}
1255 attribute nor a \livelink{chap:DWATdiscrlist}{DW\-\_AT\-\_discr\-\_list} attribute, or if it has
1256 a \livelink{chap:DWATdiscrlist}{DW\-\_AT\-\_discr\-\_list} attribute with 0 size, the variant is a
1257 default variant.
1258
1259 The components selected by a particular variant are represented
1260 by debugging information entries owned by the corresponding
1261 variant entry and appear in the same order as the corresponding
1262 declarations in the source program.
1263
1264 \section{Condition Entries}
1265 \label{chap:conditionentries}
1266
1267 \textit{COBOL has the notion of a ``level\dash 88 condition'' that
1268 associates a data item, called the conditional variable, with
1269 a set of one or more constant values and/or value ranges.
1270 Semantically, the condition is ‛true’ if the conditional
1271 variable's value matches any of the described constants,
1272 and the condition is ‛false’ otherwise.}
1273
1274 The \livetarg{chap:DWTAGcondition}{DW\-\_TAG\-\_condition} debugging information entry
1275 describes a
1276 logical condition that tests whether a given data item’s
1277 value matches one of a set of constant values. If a name
1278 has been given to the condition, the condition entry has a
1279 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated string
1280 giving the condition name as it appears in the source program.
1281
1282 The condition entry's parent entry describes the conditional
1283 variable; normally this will be a \livelink{chap:DWTAGvariable}{DW\-\_TAG\-\_variable},
1284 \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member} or \livelink{chap:DWTAGformalparameter}{DW\-\_TAG\-\_formal\-\_parameter} entry. If the parent
1285 entry has an array type, the condition can test any individual
1286 element, but not the array as a whole. The condition entry
1287 implicitly specifies a “comparison type” that is the
1288 type of an array element if the parent has an array type;
1289 otherwise it is the type of the parent entry.
1290
1291 The condition entry owns \livelink{chap:DWTAGconstant}{DW\-\_TAG\-\_constant} and/or
1292 \livelink{chap:DWTAGsubrangetype}{DW\-\_TAG\-\_subrange\-\_type} entries that describe the constant
1293 values associated with the condition. If any child entry has
1294 a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute, that attribute should describe a type
1295 compatible with the comparison type (according to the source
1296 language); otherwise the child’s type is the same as the
1297 comparison type.
1298
1299 \textit{For conditional variables with alphanumeric types, COBOL
1300 permits a source program to provide ranges of alphanumeric
1301 constants in the condition. Normally a subrange type entry
1302 does not describe ranges of strings; however, this can be
1303 represented using bounds attributes that are references to
1304 constant entries describing strings. A subrange type entry may
1305 refer to constant entries that are siblings of the subrange
1306 type entry.}
1307
1308
1309 \section{Enumeration Type Entries}
1310 \label{chap:enumerationtypeentries}
1311
1312 \textit{An “enumeration type” is a scalar that can assume one of
1313 a fixed number of symbolic values.}
1314
1315 An enumeration type is represented by a debugging information
1316 entry with the tag 
1317 \livetarg{chap:DWTAGenumerationtype}{DW\-\_TAG\-\_enumeration\-\_type}.
1318
1319 If a name has been given to the enumeration type in the source
1320 program, then the corresponding enumeration type entry has
1321 a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated
1322 string containing the enumeration type name as it appears
1323 in the source program. This entry also has a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}
1324 attribute whose integer constant value is the number of bytes
1325 required to hold an instance of the enumeration.
1326
1327 The enumeration type entry may have a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute
1328 which refers to the underlying data type used to implement
1329 the enumeration.
1330
1331 If an enumeration type has type safe semantics such that
1332
1333 \begin{enumerate}[1.]
1334 \item Enumerators are contained in the scope of the enumeration type, and/or
1335
1336 \item Enumerators are not implicitly converted to another type
1337 \end{enumerate}
1338
1339 then the enumeration type entry may have a \livelink{chap:DWATenumclass}{DW\-\_AT\-\_enum\-\_class}
1340 attribute, which is a \livelink{chap:flag}{flag}. 
1341 In a language that offers only
1342 one kind of enumeration declaration, this attribute is not
1343 required.
1344
1345 \textit{In C or C++, the underlying type will be the appropriate
1346 integral type determined by the compiler from the properties of
1347 \hypertarget{chap:DWATenumclasstypesafeenumerationdefinition}
1348 the enumeration literal values. A C++ type declaration written
1349 using enum class declares a strongly typed enumeration and
1350 is represented using \livelink{chap:DWTAGenumerationtype}{DW\-\_TAG\-\_enumeration\-\_type} in combination
1351 with \livelink{chap:DWATenumclass}{DW\-\_AT\-\_enum\-\_class}.}
1352
1353 Each enumeration literal is represented by a debugging
1354 information entry with the 
1355 tag \livetarg{chap:DWTAGenumerator}{DW\-\_TAG\-\_enumerator}. 
1356 Each
1357 such entry is a child of the enumeration type entry, and the
1358 enumerator entries appear in the same order as the declarations
1359 of the enumeration literals in the source program.
1360
1361 Each enumerator entry has a 
1362 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose
1363 value is a null\dash terminated string containing the name of the
1364 \hypertarget{chap:DWATconstvalueenumerationliteralvalue}
1365 enumeration literal as it appears in the source program. 
1366 Each enumerator entry also has a 
1367 \livelink{chap:DWATconstvalue}{DW\-\_AT\-\_const\-\_value} attribute,
1368 whose value is the actual numeric value of the enumerator as
1369 represented on the target system.
1370
1371
1372 If the enumeration type occurs as the description of a
1373 dimension of an array type, and the stride for that dimension
1374 \hypertarget{chap:DWATbytestrideenumerationstridedimensionofarraytype}
1375 is different than what would otherwise be determined, then
1376 \hypertarget{chap:DWATbitstrideenumerationstridedimensionofarraytype}
1377 the enumeration type entry has either a \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride}
1378 or \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride} attribute which specifies the separation
1379 between successive elements along the dimension as described
1380 in 
1381 Section \refersec{chap:visibilityofdeclarations}. 
1382 The value of the \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride} attribute
1383 is interpreted as bits and the value of the \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride}
1384 attribute is interpreted as bytes.
1385
1386
1387 \section{Subroutine Type Entries}
1388 \label{chap:subroutinetypeentries}
1389
1390 It is possible in C to declare pointers to subroutines
1391 that return a value of a specific type. In both C and C++,
1392 it is possible to declare pointers to subroutines that not
1393 only return a value of a specific type, but accept only
1394 arguments of specific types. The type of such pointers would
1395 be described with a ``pointer to'' modifier applied to a
1396 user\dash defined type.
1397
1398 A subroutine type is represented by a debugging information
1399 entry with the 
1400 tag \livetarg{chap:DWTAGsubroutinetype}{DW\-\_TAG\-\_subroutine\-\_type}. 
1401 If a name has
1402 been given to the subroutine type in the source program,
1403 then the corresponding subroutine type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name}
1404 attribute whose value is a null\dash terminated string containing
1405 the subroutine type name as it appears in the source program.
1406
1407 If the subroutine type describes a function that returns
1408 a value, then the subroutine type entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type}
1409 attribute to denote the type returned by the subroutine. If
1410 the types of the arguments are necessary to describe the
1411 subroutine type, then the corresponding subroutine type
1412 entry owns debugging information entries that describe the
1413 arguments. These debugging information entries appear in the
1414 order that the corresponding argument types appear in the
1415 source program.
1416
1417 In C there is a difference between the types of functions
1418 declared using function prototype style declarations and
1419 those declared using non\dash prototype declarations.
1420
1421
1422 \hypertarget{chap:DWATprototypedsubroutineprototype}
1423 subroutine entry declared with a function prototype style
1424 declaration may have a 
1425 \livelink{chap:DWATprototyped}{DW\-\_AT\-\_prototyped} attribute, which is
1426 a \livelink{chap:flag}{flag}.
1427
1428 Each debugging information entry owned by a subroutine
1429 type entry has a tag whose value has one of two possible
1430 interpretations:
1431
1432 \begin{enumerate}[1.]
1433 \item The formal parameters of a parameter list (that have a
1434 specific type) are represented by a debugging information entry
1435 with the tag \livelink{chap:DWTAGformalparameter}{DW\-\_TAG\-\_formal\-\_parameter}. Each formal parameter
1436 entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute that refers to the type of
1437 the formal parameter.
1438
1439 \item The unspecified parameters of a variable parameter list
1440 are represented by a debugging information entry with the
1441 tag \livelink{chap:DWTAGunspecifiedparameters}{DW\-\_TAG\-\_unspecified\-\_parameters}.
1442 \end{enumerate}
1443
1444
1445
1446 \section{String Type Entries}
1447 \label{chap:stringtypeentries}
1448
1449
1450 A ``string'' is a sequence of characters that have specific
1451 semantics and operations that separate them from arrays of
1452 characters. Fortran is one of the languages that has a string
1453 type. Note that ``string'' in this context refers to a target
1454 machine concept, not the class string as used in this document
1455 (except for the name attribute).
1456
1457 A string type is represented by a debugging information entry
1458 with the tag \livetarg{chap:DWTAGstringtype}{DW\-\_TAG\-\_string\-\_type}. 
1459 If a name has been given to
1460 the string type in the source program, then the corresponding
1461 string type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is
1462 a null\dash terminated string containing the string type name as
1463 it appears in the source program.
1464
1465 The 
1466 \hypertarget{chap:DWATstringlengthstringlengthofstringtype}
1467 string type entry may have a 
1468 \livelink{chap:DWATstringlength}{DW\-\_AT\-\_string\-\_length} attribute
1469 whose value is a location description yielding the location
1470 where the length of the string is stored in the program. The
1471 string type entry may also have a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute
1472 or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute, whose value 
1473 (see Section \refersec{chap:byteandbitsizes}) 
1474 is the size of the data to be retrieved from the location
1475 referenced by the string length attribute. If no (byte or bit)
1476 size attribute is present, the size of the data to be retrieved
1477 is the same as the size of an address on the target machine.
1478
1479 If no string length attribute is present, the string type
1480 entry may have a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size}
1481 attribute, whose value 
1482 (see Section \refersec{chap:byteandbitsizes}) 
1483 is the amount of
1484 storage needed to hold a value of the string type.
1485
1486
1487 \section{Set Type Entries}
1488 \label{chap:settypeentries}
1489
1490 \textit{Pascal provides the concept of a “set,” which represents
1491 a group of values of ordinal type.}
1492
1493 A set is represented by a debugging information entry with
1494 the tag \livetarg{chap:DWTAGsettype}{DW\-\_TAG\-\_set\-\_type}. 
1495 If a name has been given to the
1496 set type, then the set type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute
1497 whose value is a null\dash terminated string containing the
1498 set type name as it appears in the source program.
1499
1500 The set type entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to denote the
1501 type of an element of the set.
1502
1503 If the amount of storage allocated to hold each element of an
1504 object of the given set type is different from the amount of
1505 storage that is normally allocated to hold an individual object
1506 of the indicated element type, then the set type entry has
1507 either a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute, or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute
1508 whose value (see Section \refersec{chap:byteandbitsizes}) is
1509 the amount of storage needed to hold a value of the set type.
1510
1511
1512 \section{Subrange Type Entries}
1513 \label{chap:subrangetypeentries}
1514
1515 \textit{Several languages support the concept of a ``subrange''
1516 type object. These objects can represent a subset of the
1517 values that an object of the basis type for the subrange can
1518 represent. Subrange type entries may also be used to represent
1519 the bounds of array dimensions.}
1520
1521 A subrange type is represented by a debugging information
1522 entry with the 
1523 tag \livetarg{chap:DWTAGsubrangetype}{DW\-\_TAG\-\_subrange\-\_type}. 
1524 If a name has been
1525 given to the subrange type, then the subrange type entry
1526 has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated
1527 string containing the subrange type name as it appears in
1528 the source program.
1529
1530 The subrange entry may have a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to describe
1531 the type of object, called the basis type, of whose values
1532 this subrange is a subset.
1533
1534 If the amount of storage allocated to hold each element of an
1535 object of the given subrange type is different from the amount
1536 of storage that is normally allocated to hold an individual
1537 object of the indicated element type, then the subrange
1538 type entry has a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size}
1539 attribute, whose value 
1540 (see Section \refersec{chap:staticanddynamicvaluesofattributes})
1541 is the amount of
1542 storage needed to hold a value of the subrange type.
1543
1544 The subrange entry may have a \livelink{chap:DWATthreadsscaled}{DW\-\_AT\-\_threads\-\_scaled} attribute,
1545 which is a \livelink{chap:flag}{flag}. 
1546 If present, this attribute indicates whether
1547 this subrange represents a UPC array bound which is scaled
1548 by the runtime THREADS value (the number of UPC threads in
1549 this execution of the program).
1550
1551 \textit{This allows the representation of a UPC shared array such as}
1552
1553 \begin{lstlisting}
1554 int shared foo[34*THREADS][10][20];
1555 \end{lstlisting}
1556
1557 The subrange entry may have the attributes \livelink{chap:DWATlowerbound}{DW\-\_AT\-\_lower\-\_bound}
1558 and \livelink{chap:DWATupperbound}{DW\-\_AT\-\_upper\-\_bound} to specify, respectively, the lower
1559 and upper bound values of the subrange. The \livelink{chap:DWATupperbound}{DW\-\_AT\-\_upper\-\_bound}
1560 attribute 
1561 \hypertarget{chap:DWATcountelementsofsubrangetype}
1562 may be replaced by a 
1563 \livelink{chap:DWATcount}{DW\-\_AT\-\_count} attribute, whose
1564 value describes the number of elements in the subrange rather
1565 than the value of the last element. The value of each of
1566 these attributes is determined as described in 
1567 Section \refersec{chap:staticanddynamicvaluesofattributes}.
1568
1569 If the lower bound value is missing, the value is assumed to
1570 be a language\dash dependent default constant. The default lower
1571 bound is 0 for C, C++, D, Java, Objective C, Objective C++,
1572 Python, and UPC. The default lower bound is 1 for Ada, COBOL,
1573 Fortran, Modula\dash 2, Pascal and PL/I.
1574
1575 \textit{No other default lower bound values are currently defined.}
1576
1577 If the upper bound and count are missing, then the upper bound value is 
1578 \textit{unknown}.
1579
1580 If the subrange entry has no type attribute describing the
1581 basis type, the basis type is assumed to be the same as
1582 the object described by the lower bound attribute (if it
1583 references an object). If there is no lower bound attribute,
1584 or that attribute does not reference an object, the basis type
1585 is the type of the upper bound or count attribute (if either
1586 of them references an object). If there is no upper bound or
1587 count attribute, or neither references an object, the type is
1588 assumed to be the same type, in the source language of the
1589 compilation unit containing the subrange entry, as a signed
1590 integer with the same size as an address on the target machine.
1591
1592 If the subrange type occurs as the description of a dimension
1593 of an array type, and the stride for that dimension is
1594 \hypertarget{chap:DWATbytestridesubrangestridedimensionofarraytype}
1595 different than what would otherwise be determined, then
1596 \hypertarget{chap:DWATbitstridesubrangestridedimensionofarraytype}
1597 the subrange type entry has either a \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride} or
1598 \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride} attribute which specifies the separation
1599 between successive elements along the dimension as described
1600 in 
1601 Section \refersec{chap:byteandbitsizes}.
1602
1603 \textit{Note that the stride can be negative.}
1604
1605 \section{Pointer to Member Type Entries}
1606 \label{chap:pointertomembertypeentries}
1607
1608 \textit{In C++, a pointer to a data or function member of a class or
1609 structure is a unique type.}
1610
1611 A debugging information entry representing the type of an
1612 object that is a pointer to a structure or class member has
1613 the tag \livetarg{chap:DWTAGptrtomembertype}{DW\-\_TAG\-\_ptr\-\_to\-\_member\-\_type}.
1614
1615 If the pointer to member type has a name, the pointer to
1616 member entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is a
1617 null\dash terminated string containing the type name as it appears
1618 in the source program.
1619
1620 The pointer to member entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to
1621 describe the type of the class or structure member to which
1622 objects of this type may point.
1623
1624 The pointer to member entry also 
1625 \hypertarget{chap:DWATcontainingtypecontainingtypeofpointertomembertype}
1626 has a 
1627 \livelink{chap:DWATcontainingtype}{DW\-\_AT\-\_containing\-\_type}
1628 attribute, whose value is a reference to a debugging
1629 information entry for the class or structure to whose members
1630 objects of this type may point.
1631
1632 The pointer to member entry has a \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} attribute
1633 whose value is a location description that computes the
1634 address of the member of the class to which the pointer to
1635 member entry points.
1636
1637 \textit{The method used to find the address of a given member of a
1638 class or structure is common to any instance of that class
1639 or structure and to any instance of the pointer or member
1640 type. The method is thus associated with the type entry,
1641 rather than with each instance of the type.}
1642
1643 The \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} description is used in conjunction
1644 with the location descriptions for a particular object of the
1645 given pointer to member type and for a particular structure or
1646 class instance. The \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} attribute expects two
1647 values to be pushed onto the DWARF expression stack before
1648 the \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} description is evaluated. The first
1649 value pushed is the value of the pointer to member object
1650 itself. The second value pushed is the base address of the
1651 entire structure or union instance containing the member
1652 whose address is being calculated.
1653
1654 \textit{For an expression such as}
1655
1656 \begin{lstlisting}
1657     object.*mbr_ptr
1658 \end{lstlisting}
1659 % FIXME: object and mbr\_ptr should be distinguished from italic. See DW4.
1660 \textit{where mbr\_ptr has some pointer to member type, a debugger should:}
1661
1662 \textit{1. Push the value of mbr\_ptr onto the DWARF expression stack.}
1663
1664 \textit{2. Push the base address of object onto the DWARF expression stack.}
1665
1666 \textit{3. Evaluate the \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} description 
1667 given in the type of mbr\_ptr.}
1668
1669 \section{File Type Entries}
1670 \label{chap:filetypeentries}
1671
1672 \textit{Some languages, such as Pascal, provide a data type to represent 
1673 files.}
1674
1675 A file type is represented by a debugging information entry
1676 with the 
1677 \livetarg{chap:DWTAGfiletype}{DW\-\_TAG\-\_file\-\_type}. 
1678 If the file type has a name,
1679 the file type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value
1680 is a null\dash terminated string containing the type name as it
1681 appears in the source program.
1682
1683 The file type entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute describing
1684 the type of the objects contained in the file.
1685
1686 The file type entry also has a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} or
1687 \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute, whose value 
1688 (see Section \refersec{chap:staticanddynamicvaluesofattributes})
1689 is the amount of storage need to hold a value of the file type.
1690
1691 \section{Dynamic Type Properties}
1692 \label{chap:dynamictypeproperties}
1693 \subsection{Data Location}
1694 \label{chap:datalocation}
1695
1696 \textit{Some languages may represent objects using descriptors to hold
1697 information, including a location and/or run\dash time parameters,
1698 about the data that represents the value for that object.}
1699
1700 \hypertarget{chap:DWATdatalocationindirectiontoactualdata}
1701 The \livelink{chap:DWATdatalocation}{DW\-\_AT\-\_data\-\_location} 
1702 attribute may be used with any
1703 type that provides one or more levels of hidden indirection
1704 and/or run\dash time parameters in its representation. Its value
1705 is a location description. The result of evaluating this
1706 description yields the location of the data for an object.
1707 When this attribute is omitted, the address of the data is
1708 the same as the address of the object.
1709
1710 \textit{This location description will typically begin with
1711 \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address} 
1712 which loads the address of the
1713 object which can then serve as a descriptor in subsequent
1714 calculation. For an example using 
1715 \livelink{chap:DWATdatalocation}{DW\-\_AT\-\_data\-\_location} 
1716 for a Fortran 90 array, see 
1717 Appendix \refersec{app:fortran90example}.}
1718
1719 \subsection{Allocation and Association Status}
1720 \label{chap:allocationandassociationstatus}
1721
1722 \textit{Some languages, such as Fortran 90, provide types whose values
1723 may be dynamically allocated or associated with a variable
1724 under explicit program control.}
1725
1726 \hypertarget{chap:DWATallocatedallocationstatusoftypes}
1727 The 
1728 \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated} 
1729 attribute may optionally be used with any
1730 type for which objects of the type can be explicitly allocated
1731 and deallocated. The presence of the attribute indicates that
1732 objects of the type are allocatable and deallocatable. The
1733 integer value of the attribute (see below) specifies whether
1734 an object of the type is 
1735 currently allocated or not.
1736
1737 \hypertarget{chap:DWATassociatedassociationstatusoftypes}
1738 The 
1739 \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated} attribute 
1740 may optionally be used with
1741 any type for which objects of the type can be dynamically
1742 associated with other objects. The presence of the attribute
1743 indicates that objects of the type can be associated. The
1744 integer value of the attribute (see below) indicates whether
1745 an object of the type is currently associated or not.
1746
1747 While these attributes are defined specifically with Fortran
1748 90 ALLOCATABLE and POINTER types in mind, usage is not limited
1749 to just that language.
1750
1751 The value of these attributes is determined as described in
1752 Section \refersec{chap:staticanddynamicvaluesofattributes}.
1753
1754 A non\dash zero value is interpreted as allocated or associated,
1755 and zero is interpreted as not allocated or not associated.
1756
1757 \textit{For Fortran 90, if the \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated} attribute is present,
1758 the type has the POINTER property where either the parent
1759 variable is never associated with a dynamic object or the
1760 implementation does not track whether the associated object
1761 is static or dynamic. If the \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated} attribute is
1762 present and the \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated} attribute is not, the type
1763 has the ALLOCATABLE property. If both attributes are present,
1764 then the type should be assumed to have the POINTER property
1765 (and not ALLOCATABLE); the \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated} attribute may then
1766 be used to indicate that the association status of the object
1767 resulted from execution of an ALLOCATE statement rather than
1768 pointer assignment.}
1769
1770 \textit{For examples using \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated} for Ada and Fortran 90
1771 arrays, 
1772 see Appendix \refersec{app:aggregateexamples}.}
1773
1774
1775
1776 \section{Template Alias Entries}
1777 \label{chap:templatealiasentries}
1778
1779 A type named using a template alias is represented
1780 by a debugging information entry with the tag
1781 \livetarg{chap:DWTAGtemplatealias}{DW\-\_TAG\-\_template\-\_alias}. 
1782 The template alias entry has a
1783 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated string
1784 containing the name of the template alias as it appears in
1785 the source program. The template alias entry also contains a
1786 \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute whose value is a reference to the type
1787 named by the template alias. The template alias entry has
1788 the following child entries:
1789
1790 \begin{enumerate}[1.]
1791 \item Each formal parameterized type declaration appearing
1792 in the template alias declaration is represented
1793 by a debugging information entry with the tag
1794 \livelink{chap:DWTAGtemplatetypeparameter}{DW\-\_TAG\-\_template\-\_type\-\_parameter}. Each such entry may have
1795 a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is a null\dash terminated
1796 string containing the name of the formal type parameter as it
1797 appears in the source program. The template type parameter
1798 entry also has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute describing the actual
1799 type by which the formal is replaced for this instantiation.
1800
1801 \item Each formal parameterized value declaration
1802 appearing in the template alias declaration is
1803 represented by a debugging information entry with the tag
1804 \livelink{chap:DWTAGtemplatevalueparameter}{DW\-\_TAG\-\_template\-\_value\-\_parameter}. Each such entry may have
1805 a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is a null\dash terminated
1806 string containing the name of the formal value parameter
1807 as it appears in the source program. The template value
1808 parameter entry also has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute describing
1809 the type of the parameterized value. Finally, the template
1810 value parameter entry has a \livelink{chap:DWATconstvalue}{DW\-\_AT\-\_const\-\_value} attribute, whose
1811 value is the actual constant value of the value parameter for
1812 this instantiation as represented on the target architecture.
1813 \end{enumerate}
1814