d6cb3f3a9d90a6065ebfe4c6195183912661e88e
[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 \hypertarget{chap:DWATfriendfriendrelationship}
767 type may be represented by a debugging information entry
768 that is a child of the structure, union or class type entry;
769 the friend entry has the 
770 tag \livetarg{chap:DWTAGfriend}{DW\-\_TAG\-\_friend}.
771
772 A friend entry has a \livelink{chap:DWATfriend}{DW\-\_AT\-\_friend} attribute, whose value is
773 a reference to the debugging information entry describing
774 the declaration of the friend.
775
776
777 \subsection{Data Member Entries}
778 \label{chap:datamemberentries}
779
780 A data member (as opposed to a member function) is
781 represented by a debugging information entry with the 
782 tag \livetarg{chap:DWTAGmember}{DW\-\_TAG\-\_member}. 
783 The member entry for a named member has
784 a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null-terminated
785 string containing the member name as it appears in the source
786 program. If the member entry describes an anonymous union, the
787 name attribute is omitted or consists of a single zero byte.
788
789 The data member entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to denote
790 the type of that member.
791
792 A data member entry may have a \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility}
793 attribute. If no accessibility attribute is present, private
794 access is assumed for an entry of a class and public access
795 is assumed for an entry of a structure, union, or interface.
796
797 A data member 
798 \hypertarget{chap:DWATmutablemutablepropertyofmemberdata}
799 entry may have a \livelink{chap:DWATmutable}{DW\-\_AT\-\_mutable} attribute,
800 which is a \livelink{chap:flag}{flag}. 
801 This attribute indicates whether the data
802 member was declared with the mutable storage class specifier.
803
804 The beginning of a data member is described relative to
805 the beginning of the object in which it is immediately
806 contained. In general, the beginning is characterized by
807 both an address and a bit offset within the byte at that
808 address. When the storage for an entity includes all of
809 the bits in the beginning byte, the beginning bit offset is
810 defined to be zero.
811
812 Bit offsets in DWARF use the bit numbering and direction
813 conventions that are appropriate to the current language on
814 the target system.
815
816 The member entry corresponding to a data member that is
817 \hypertarget{chap:DWATdatabitoffsetdatamemberbitlocation}
818 defined 
819 \hypertarget{chap:DWATdatamemberlocationdatamemberlocation}
820 in a structure, union or class may have either a
821 \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} attribute or a \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset}
822 attribute. If the beginning of the data member is the same as
823 the beginning of the containing entity then neither attribute
824 is required.
825
826 For a \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} attribute there are two cases:
827
828 \begin{enumerate}[1.]
829
830 \item If the value is an integer constant, it is the offset
831 in bytes from the beginning of the containing entity. If
832 the beginning of the containing entity has a non-zero bit
833 offset then the beginning of the member entry has that same
834 bit offset as well.
835
836 \item Otherwise, the value must be a location description. In
837 this case, the beginning of the containing entity must be byte
838 aligned. The beginning address is pushed on the DWARF stack
839 before the location description is evaluated; the result of
840 the evaluation is the base address of the member entry.
841
842 \textit{The push on the DWARF expression stack of the base address of
843 the containing construct is equivalent to execution of the
844 \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address} operation 
845 (see Section \refersec{chap:stackoperations});
846 \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address} therefore is not needed at the
847 beginning of a location description for a data member. The
848 result of the evaluation is a location--either an address or
849 the name of a register, not an offset to the member.}
850
851 \textit{A \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} attribute that has the form of a
852 location description is not valid for a data member contained
853 in an entity that is not byte aligned because DWARF operations
854 do not allow for manipulating or computing bit offsets.}
855
856 \end{enumerate}
857
858 For a \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} attribute, the value is an integer
859 constant 
860 (see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
861 that specifies the number of bits
862 from the beginning of the containing entity to the beginning
863 of the data member. This value must be greater than or equal
864 to zero, but is not limited to less than the number of bits
865 per byte.
866
867 If the size of a data member is not the same as the size
868 of the type given for the data member, the data member has
869 either a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} or a \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute whose
870 integer constant value 
871 (see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
872 is the amount
873 of storage needed to hold the value of the data member.
874
875 \textit{C and C++ bit fields typically require the use of the
876 \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} and \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attributes.}
877
878 \textit{This Standard uses the following bit numbering and direction
879 conventions in examples. These conventions are for illustrative
880 purposes and other conventions may apply on particular
881 architectures.}
882
883
884 \begin{itemize}
885 \item \textit{For big\dash endian architectures, bit offsets are
886 counted from high-order to low\dash order bits within a byte (or
887 larger storage unit); in this case, the bit offset identifies
888 the high\dash order bit of the object.}
889
890 \item \textit{For little\dash endian architectures, bit offsets are
891 counted from low\dash order to high\dash order bits within a byte (or
892 larger storage unit); in this case, the bit offset identifies
893 the low\dash order bit of the object.}
894 \end{itemize}
895
896
897 \textit{In either case, the bit so identified is defined as the beginning of the object.}
898
899 \textit{For example, take one possible representation of the following C structure definition in both big\dash and little\dash endian byte orders:}
900
901 \begin{lstlisting}
902 struct S {
903     int j:5;
904     int k:6;
905     int m:5;
906     int n:8;
907 };
908 \end{lstlisting}
909
910 \textit{The following diagrams show the structure layout
911 and data bit offsets for example big\dash\   and little\dash endian
912 architectures, respectively. Both diagrams show a structure
913 that begins at address A and whose size is four bytes. Also,
914 high order bits are to the left and low order bits are to
915 the right.}
916
917 \textit{Big\dash Endian Data Bit Offsets:}
918
919 \begin{verbatim}
920     j:0
921     k:5
922     m:11
923     n:16
924
925     Addresses increase ->
926     |       A       |     A + 1     |    A + 2      |    A + 3      | 
927
928     Data bit offsets increase ->
929     +---------------+---------------+---------------+---------------+
930     |0     4|5         10|11      15|16           23|24           31|
931     |   j   |     k      | m        |        n      |       <pad>   |
932     |       |            |          |               |               | 
933     +---------------------------------------------------------------+ 
934 \end{verbatim}
935
936 \textit{Little\dash  Endian Data Bit Offsets:}
937 \begin{verbatim}
938     j:0
939     k:5
940     m:11
941     n:16
942                                                <- Addresses increase
943     |       A       |     A + 1     |    A + 2      |    A + 3      | 
944
945                                         <-  Data bit offsets increase 
946
947     +---------------+---------------+---------------+---------------+
948     |31           24|23           16|15     11|10       5|4        0|
949     |     <pad>     |        n      |    m    |    k     |     j    |
950     |               |               |         |          |          |
951     +---------------------------------------------------------------+
952
953 \end{verbatim}
954
955 \textit{Note that data member bit offsets in this example are the
956 same for both big\dash\ and little\dash endian architectures even
957 though the fields are allocated in different directions
958 (high\dash order to low-order versus low\dash order to high\dash order);
959 the bit naming conventions for memory and/or registers of
960 the target architecture may or may not make this seem natural.}
961
962 \textit{For a more extensive example showing nested and packed records
963 and arrays, see 
964 Appendix \refersec{app:pascalexample}.}
965
966 \textit{Attribute \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} is new in DWARF Version 4 and
967 is also used for base types 
968 (see Section \refersec{chap:basetypeentries}). 
969 It replaces the
970 \livetarg{chap:DWATbitoffsetdatamemberbitlocation}
971 attributes \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} and \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} when used to
972 identify the beginning of bit field data members as defined
973 in DWARF V3 and earlier. The earlier attributes are defined
974 in a manner suitable for bit field members on big-endian
975 architectures but which is either awkward or incomplete for
976 use on little-endian architectures.  (\livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} also
977 has other uses that are not affected by this change.)}
978
979 \textit{The \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} and 
980 \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset}
981 attribute combination is deprecated for data members in DWARF
982 Version 4, but implementations may continue to support this
983 use for compatibility.}
984
985 \textit{The DWARF Version 3 definitions of these attributes are
986 as follows.}
987
988 \begin{myindentpara}{1cm}
989 \textit{If the data member entry describes a bit field, then that
990 entry has the following attributes:}
991
992 \begin{itemize}
993 \item \textit{A \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute whose value (see Section
994 2.19) is the number of bytes that contain an instance of the
995 bit field and any padding bits.}
996
997 \textit{The byte size attribute may be omitted if the size of the
998 object containing the bit field can be inferred from the type
999 attribute of the data member containing the bit field.}
1000
1001 \item \textit{A \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} attribute whose value (see Section
1002 2.19) is the number of bits to the left of the leftmost
1003 (most significant) bit of the bit field value.}
1004
1005 \item \textit{A \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute whose value (see Section
1006 2.19) is the number of bits occupied by the bit field value.}
1007
1008 \end{itemize}
1009
1010 \textit{The location description for a bit field calculates the address
1011 of an anonymous object containing the bit field. The address
1012 is relative to the structure, union, or class that most closely
1013 encloses the bit field declaration. The number of bytes in this
1014 anonymous object is the value of the byte size attribute of
1015 the bit field. The offset (in bits) from the most significant
1016 bit of the anonymous object to the most significant bit of
1017 the bit field is the value of the bit offset attribute.}
1018 \end{myindentpara}
1019
1020
1021 \textit{Diagrams similar to the above that show the use of the
1022 \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} and \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} attribute
1023 combination may be found in the DWARF Version 3 Standard.}
1024
1025 \textit{In comparing DWARF Versions 3 and 4, note that DWARF V4
1026 defines the following combinations of attributes:}
1027
1028 \begin{itemize}
1029 \item \textit{either \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} or
1030 \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} (to specify the beginning of the
1031 data member)}
1032
1033 % FIXME: the indentation of the following line is suspect.
1034 \textit{optionally together with}
1035
1036 \item  \textit{either \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} (to
1037 specify the size of the data member)}
1038
1039 \end{itemize}
1040
1041 \textit{DWARF V3 defines the following combinations}
1042
1043 \begin{itemize}
1044 \item \textit{\livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} (to specify the beginning
1045 of the data member, except this specification is only partial
1046 in the case of a bit field) }
1047
1048 % FIXME: the indentation of the following line is suspect.
1049 \textit{optionally together with}
1050
1051 \item \textit{\livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} and \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset}
1052 (to further specify the beginning of a bit field data member
1053 as well as specify the size of the data member) }
1054 \end{itemize}
1055
1056 \subsection{Member Function Entries}
1057 \label{chap:memberfunctionentries}
1058
1059 A member function is represented by a debugging information
1060 entry with the tag \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram}. The member function entry
1061 may contain the same attributes and follows the same rules
1062 as non\dash member global subroutine entries 
1063 (see Section \refersec{chap:subroutineandentrypointentries}).
1064
1065 A member function entry may have a \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility}
1066 attribute. If no accessibility attribute is present, private
1067 access is assumed for an entry of a class and public access
1068 is assumed for an entry of a structure, union or interface.
1069
1070 If the member function entry describes a virtual function,
1071 then that entry has a \livelink{chap:DWATvirtuality}{DW\-\_AT\-\_virtuality} attribute.
1072
1073 If 
1074 \hypertarget{chap:DWATexplicitexplicitpropertyofmemberfunction}
1075 the member function entry describes an explicit member
1076 function, then that entry has a 
1077 \livelink{chap:DWATexplicit}{DW\-\_AT\-\_explicit} attribute.
1078
1079 An entry for a virtual function also has a
1080 \livelink{chap:DWATvtableelemlocation}{DW\-\_AT\-\_vtable\-\_elem\-\_location} attribute whose value contains
1081 a location description yielding the address of the slot
1082 for the function within the virtual function table for the
1083 enclosing class. The address of an object of the enclosing
1084 type is pushed onto the expression stack before the location
1085 description is evaluated.
1086
1087 If 
1088 \hypertarget{chap:DWATobjectpointerobjectthisselfpointerofmemberfunction}
1089 the member function entry describes a non\dash static member
1090 function, then that entry has a \livelink{chap:DWATobjectpointer}{DW\-\_AT\-\_object\-\_pointer} attribute
1091 whose value is a reference to the formal parameter entry
1092 that corresponds to the object for which the function is
1093 called. The name attribute of that formal parameter is defined
1094 by the current language (for example, this for C++ or self
1095 for Objective C and some other languages). That parameter
1096 also has a \livelink{chap:DWATartificial}{DW\-\_AT\-\_artificial} attribute whose value is true.
1097
1098 Conversely, if the member function entry describes a static
1099 member function, the entry does not have a \livelink{chap:DWATobjectpointer}{DW\-\_AT\-\_object\-\_pointer}
1100 attribute.
1101
1102 If the member function entry describes a non\dash static member
1103 function that has a const\dash volatile qualification, then
1104 the entry describes a non\dash static member function whose
1105 object formal parameter has a type that has an equivalent
1106 const\dash volatile qualification.
1107
1108 If a subroutine entry represents the defining declaration
1109 of a member function and that definition appears outside of
1110 the body of the enclosing class declaration, the subroutine
1111 entry has a \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification} attribute, whose value is
1112 a reference to the debugging information entry representing
1113 the declaration of this function member. The referenced entry
1114 will be a child of some class (or structure) type entry.
1115
1116 Subroutine entries containing the \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification}
1117 attribute do not need to duplicate information provided
1118 by the declaration entry referenced by the specification
1119 attribute. In particular, such entries do not need to contain
1120 attributes for the name or return type of the function member
1121 whose definition they represent.
1122
1123 \subsection{Class Template Instantiations}
1124 \label{chap:classtemplateinstantiations}
1125
1126 \textit{In C++ a class template is a generic definition of a class
1127 type that may be instantiated when an instance of the class
1128 is declared or defined. The generic description of the
1129 class may include both parameterized types and parameterized
1130 constant values. DWARF does not represent the generic template
1131 definition, but does represent each instantiation.}
1132
1133 A class template instantiation is represented by a
1134 debugging information entry with the tag \livelink{chap:DWTAGclasstype}{DW\-\_TAG\-\_class\-\_type},
1135 \livelink{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type} or \livelink{chap:DWTAGuniontype}{DW\-\_TAG\-\_union\-\_type}. With five
1136 exceptions, such an entry will contain the same attributes
1137 and have the same types of child entries as would an entry
1138 for a class type defined explicitly using the instantiation
1139 types and values. The exceptions are:
1140
1141 \begin{enumerate}[1.]
1142 \item Each formal parameterized type declaration appearing in the
1143 template definition is represented by a debugging information
1144 entry with the tag \livelink{chap:DWTAGtemplatetypeparameter}{DW\-\_TAG\-\_template\-\_type\-\_parameter}. Each
1145 such entry may have a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is
1146 a null\dash terminated string containing the name of the formal
1147 type parameter as it appears in the source program. The
1148 template type parameter entry also has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute
1149 describing the actual type by which the formal is replaced
1150 for this instantiation.
1151
1152 \item Each formal parameterized value declaration appearing in the
1153 template definition is represented by a debugging information
1154 entry with the 
1155 tag \livetarg{chap:DWTAGtemplatevalueparameter}{DW\-\_TAG\-\_template\-\_value\-\_parameter}. 
1156 Each
1157 such entry may have a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is
1158 a null\dash terminated string containing the name of the formal
1159 value parameter as it appears in the source program. 
1160 The
1161 \hypertarget{chap:DWATconstvaluetemplatevalueparameter}
1162 template value parameter entry also has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute
1163 describing the type of the parameterized value. Finally,
1164 the template value parameter entry has a \livelink{chap:DWATconstvalue}{DW\-\_AT\-\_const\-\_value}
1165 attribute, whose value is the actual constant value of the
1166 value parameter for this instantiation as represented on the
1167 target architecture.
1168
1169 \item The class type entry and each of its child entries references
1170 a template type parameter entry in any circumstance where the
1171 source template definition references a formal parameterized
1172 type. Similarly, the class type entry and each of its child
1173 entries references a template value parameter entry in any
1174 circumstance where the source template definition references
1175 a formal parameterized value.
1176
1177 \item If the compiler has generated a special compilation unit to
1178 hold the template instantiation and that special compilation
1179 unit has a different name from the compilation unit containing
1180 the template definition, the name attribute for the debugging
1181 information entry representing the special compilation unit
1182 should be empty or omitted.
1183
1184 \item If the class type entry representing the template
1185 instantiation or any of its child entries contains declaration
1186 coordinate attributes, those attributes should refer to
1187 the source for the template definition, not to any source
1188 generated artificially by the compiler.
1189 \end{enumerate}
1190
1191
1192 \subsection{Variant Entries}
1193 \label{chap:variantentries}
1194
1195 A variant part of a structure is represented by a debugging
1196 information entry with the 
1197 tag \livetarg{chap:DWTAGvariantpart}{DW\-\_TAG\-\_variant\-\_part} and is
1198 owned by the corresponding structure type entry.
1199
1200 If the variant part has a discriminant, the discriminant is
1201 \hypertarget{chap:DWATdiscrdiscriminantofvariantpart}
1202 represented by a separate debugging information entry which
1203 is a child of the variant part entry. This entry has the form
1204 of a structure data member entry. The variant part entry will
1205 have a 
1206 \livelink{chap:DWATdiscr}{DW\-\_AT\-\_discr} attribute whose value is a reference to
1207 the member entry for the discriminant.
1208
1209 If the variant part does not have a discriminant (tag field),
1210 the variant part entry has a 
1211 \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to represent
1212 the tag type.
1213
1214 Each variant of a particular variant part is represented by
1215 \hypertarget{chap:DWATdiscrvaluediscriminantvalue}
1216 a debugging information entry with the 
1217 tag \livetarg{chap:DWTAGvariant}{DW\-\_TAG\-\_variant}
1218 and is a child of the variant part entry. The value that
1219 selects a given variant may be represented in one of three
1220 ways. The variant entry may have a 
1221 \livelink{chap:DWATdiscrvalue}{DW\-\_AT\-\_discr\-\_value} attribute
1222 whose value represents a single case label. The value of this
1223 attribute is encoded as an LEB128 number. The number is signed
1224 if the tag type for the variant part containing this variant
1225 is a signed type. The number is unsigned if the tag type is
1226 an unsigned type.
1227
1228 Alternatively, 
1229 \hypertarget{chap:DWATdiscrlistlistofdiscriminantvalues}
1230 the variant entry may contain a 
1231 \livelink{chap:DWATdiscrlist}{DW\-\_AT\-\_discr\-\_list}
1232 attribute, whose value represents a list of discriminant
1233 values. This list is represented by any of the 
1234 \livelink{chap:block}{block} forms and
1235 may contain a mixture of case labels and label ranges. Each
1236 item on the list is prefixed with a discriminant value
1237 descriptor that determines whether the list item represents
1238 a single label or a label range. A single case label is
1239 represented as an LEB128 number as defined above for the
1240 \livelink{chap:DWATdiscrvalue}{DW\-\_AT\-\_discr\-\_value} attribute. A label range is represented by
1241 two LEB128 numbers, the low value of the range followed by the
1242 high value. Both values follow the rules for signedness just
1243 described. The discriminant value descriptor is an integer
1244 constant that may have one of the values given in 
1245 Figure \refersec{fig:discriminantdescriptorvalues}.
1246
1247 \begin{figure}[here]
1248 \autorows[0pt]{c}{1}{l}{
1249 \addtoindex{DW\-\_DSC\-\_label},
1250 \addtoindex{DW\-\_DSC\-\_range}
1251 }
1252 \caption{Discriminant descriptor values}\label{fig:discriminantdescriptorvalues}
1253 \end{figure}
1254
1255 If a variant entry has neither a \livelink{chap:DWATdiscrvalue}{DW\-\_AT\-\_discr\-\_value}
1256 attribute nor a \livelink{chap:DWATdiscrlist}{DW\-\_AT\-\_discr\-\_list} attribute, or if it has
1257 a \livelink{chap:DWATdiscrlist}{DW\-\_AT\-\_discr\-\_list} attribute with 0 size, the variant is a
1258 default variant.
1259
1260 The components selected by a particular variant are represented
1261 by debugging information entries owned by the corresponding
1262 variant entry and appear in the same order as the corresponding
1263 declarations in the source program.
1264
1265 \section{Condition Entries}
1266 \label{chap:conditionentries}
1267
1268 \textit{COBOL has the notion of a ``level\dash 88 condition'' that
1269 associates a data item, called the conditional variable, with
1270 a set of one or more constant values and/or value ranges.
1271 Semantically, the condition is ‛true’ if the conditional
1272 variable's value matches any of the described constants,
1273 and the condition is ‛false’ otherwise.}
1274
1275 The \livetarg{chap:DWTAGcondition}{DW\-\_TAG\-\_condition} debugging information entry
1276 describes a
1277 logical condition that tests whether a given data item’s
1278 value matches one of a set of constant values. If a name
1279 has been given to the condition, the condition entry has a
1280 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated string
1281 giving the condition name as it appears in the source program.
1282
1283 The condition entry's parent entry describes the conditional
1284 variable; normally this will be a \livelink{chap:DWTAGvariable}{DW\-\_TAG\-\_variable},
1285 \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member} or \livelink{chap:DWTAGformalparameter}{DW\-\_TAG\-\_formal\-\_parameter} entry. If the parent
1286 entry has an array type, the condition can test any individual
1287 element, but not the array as a whole. The condition entry
1288 implicitly specifies a “comparison type” that is the
1289 type of an array element if the parent has an array type;
1290 otherwise it is the type of the parent entry.
1291
1292 The condition entry owns \livelink{chap:DWTAGconstant}{DW\-\_TAG\-\_constant} and/or
1293 \livelink{chap:DWTAGsubrangetype}{DW\-\_TAG\-\_subrange\-\_type} entries that describe the constant
1294 values associated with the condition. If any child entry has
1295 a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute, that attribute should describe a type
1296 compatible with the comparison type (according to the source
1297 language); otherwise the child’s type is the same as the
1298 comparison type.
1299
1300 \textit{For conditional variables with alphanumeric types, COBOL
1301 permits a source program to provide ranges of alphanumeric
1302 constants in the condition. Normally a subrange type entry
1303 does not describe ranges of strings; however, this can be
1304 represented using bounds attributes that are references to
1305 constant entries describing strings. A subrange type entry may
1306 refer to constant entries that are siblings of the subrange
1307 type entry.}
1308
1309
1310 \section{Enumeration Type Entries}
1311 \label{chap:enumerationtypeentries}
1312
1313 \textit{An “enumeration type” is a scalar that can assume one of
1314 a fixed number of symbolic values.}
1315
1316 An enumeration type is represented by a debugging information
1317 entry with the tag 
1318 \livetarg{chap:DWTAGenumerationtype}{DW\-\_TAG\-\_enumeration\-\_type}.
1319
1320 If a name has been given to the enumeration type in the source
1321 program, then the corresponding enumeration type entry has
1322 a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated
1323 string containing the enumeration type name as it appears
1324 in the source program. This entry also has a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}
1325 attribute whose integer constant value is the number of bytes
1326 required to hold an instance of the enumeration.
1327
1328 The enumeration type entry may have a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute
1329 which refers to the underlying data type used to implement
1330 the enumeration.
1331
1332 If an enumeration type has type safe semantics such that
1333
1334 \begin{enumerate}[1.]
1335 \item Enumerators are contained in the scope of the enumeration type, and/or
1336
1337 \item Enumerators are not implicitly converted to another type
1338 \end{enumerate}
1339
1340 then the enumeration type entry may have a \livelink{chap:DWATenumclass}{DW\-\_AT\-\_enum\-\_class}
1341 attribute, which is a \livelink{chap:flag}{flag}. 
1342 In a language that offers only
1343 one kind of enumeration declaration, this attribute is not
1344 required.
1345
1346 \textit{In C or C++, the underlying type will be the appropriate
1347 integral type determined by the compiler from the properties of
1348 \hypertarget{chap:DWATenumclasstypesafeenumerationdefinition}
1349 the enumeration literal values. A C++ type declaration written
1350 using enum class declares a strongly typed enumeration and
1351 is represented using \livelink{chap:DWTAGenumerationtype}{DW\-\_TAG\-\_enumeration\-\_type} in combination
1352 with \livelink{chap:DWATenumclass}{DW\-\_AT\-\_enum\-\_class}.}
1353
1354 Each enumeration literal is represented by a debugging
1355 information entry with the 
1356 tag \livetarg{chap:DWTAGenumerator}{DW\-\_TAG\-\_enumerator}. 
1357 Each
1358 such entry is a child of the enumeration type entry, and the
1359 enumerator entries appear in the same order as the declarations
1360 of the enumeration literals in the source program.
1361
1362 Each enumerator entry has a 
1363 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose
1364 value is a null\dash terminated string containing the name of the
1365 \hypertarget{chap:DWATconstvalueenumerationliteralvalue}
1366 enumeration literal as it appears in the source program. 
1367 Each enumerator entry also has a 
1368 \livelink{chap:DWATconstvalue}{DW\-\_AT\-\_const\-\_value} attribute,
1369 whose value is the actual numeric value of the enumerator as
1370 represented on the target system.
1371
1372
1373 If the enumeration type occurs as the description of a
1374 dimension of an array type, and the stride for that dimension
1375 \hypertarget{chap:DWATbytestrideenumerationstridedimensionofarraytype}
1376 is different than what would otherwise be determined, then
1377 \hypertarget{chap:DWATbitstrideenumerationstridedimensionofarraytype}
1378 the enumeration type entry has either a \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride}
1379 or \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride} attribute which specifies the separation
1380 between successive elements along the dimension as described
1381 in 
1382 Section \refersec{chap:visibilityofdeclarations}. 
1383 The value of the \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride} attribute
1384 is interpreted as bits and the value of the \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride}
1385 attribute is interpreted as bytes.
1386
1387
1388 \section{Subroutine Type Entries}
1389 \label{chap:subroutinetypeentries}
1390
1391 It is possible in C to declare pointers to subroutines
1392 that return a value of a specific type. In both C and C++,
1393 it is possible to declare pointers to subroutines that not
1394 only return a value of a specific type, but accept only
1395 arguments of specific types. The type of such pointers would
1396 be described with a ``pointer to'' modifier applied to a
1397 user\dash defined type.
1398
1399 A subroutine type is represented by a debugging information
1400 entry with the 
1401 tag \livetarg{chap:DWTAGsubroutinetype}{DW\-\_TAG\-\_subroutine\-\_type}. 
1402 If a name has
1403 been given to the subroutine type in the source program,
1404 then the corresponding subroutine type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name}
1405 attribute whose value is a null\dash terminated string containing
1406 the subroutine type name as it appears in the source program.
1407
1408 If the subroutine type describes a function that returns
1409 a value, then the subroutine type entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type}
1410 attribute to denote the type returned by the subroutine. If
1411 the types of the arguments are necessary to describe the
1412 subroutine type, then the corresponding subroutine type
1413 entry owns debugging information entries that describe the
1414 arguments. These debugging information entries appear in the
1415 order that the corresponding argument types appear in the
1416 source program.
1417
1418 In C there is a difference between the types of functions
1419 declared using function prototype style declarations and
1420 those declared using non\dash prototype declarations.
1421
1422
1423 \hypertarget{chap:DWATprototypedsubroutineprototype}
1424 subroutine entry declared with a function prototype style
1425 declaration may have a 
1426 \livelink{chap:DWATprototyped}{DW\-\_AT\-\_prototyped} attribute, which is
1427 a \livelink{chap:flag}{flag}.
1428
1429 Each debugging information entry owned by a subroutine
1430 type entry has a tag whose value has one of two possible
1431 interpretations:
1432
1433 \begin{enumerate}[1.]
1434 \item The formal parameters of a parameter list (that have a
1435 specific type) are represented by a debugging information entry
1436 with the tag \livelink{chap:DWTAGformalparameter}{DW\-\_TAG\-\_formal\-\_parameter}. Each formal parameter
1437 entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute that refers to the type of
1438 the formal parameter.
1439
1440 \item The unspecified parameters of a variable parameter list
1441 are represented by a debugging information entry with the
1442 tag \livelink{chap:DWTAGunspecifiedparameters}{DW\-\_TAG\-\_unspecified\-\_parameters}.
1443 \end{enumerate}
1444
1445
1446
1447 \section{String Type Entries}
1448 \label{chap:stringtypeentries}
1449
1450
1451 A ``string'' is a sequence of characters that have specific
1452 semantics and operations that separate them from arrays of
1453 characters. Fortran is one of the languages that has a string
1454 type. Note that ``string'' in this context refers to a target
1455 machine concept, not the class string as used in this document
1456 (except for the name attribute).
1457
1458 A string type is represented by a debugging information entry
1459 with the tag \livetarg{chap:DWTAGstringtype}{DW\-\_TAG\-\_string\-\_type}. 
1460 If a name has been given to
1461 the string type in the source program, then the corresponding
1462 string type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is
1463 a null\dash terminated string containing the string type name as
1464 it appears in the source program.
1465
1466 The 
1467 \hypertarget{chap:DWATstringlengthstringlengthofstringtype}
1468 string type entry may have a 
1469 \livelink{chap:DWATstringlength}{DW\-\_AT\-\_string\-\_length} attribute
1470 whose value is a location description yielding the location
1471 where the length of the string is stored in the program. The
1472 string type entry may also have a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute
1473 or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute, whose value 
1474 (see Section \refersec{chap:byteandbitsizes}) 
1475 is the size of the data to be retrieved from the location
1476 referenced by the string length attribute. If no (byte or bit)
1477 size attribute is present, the size of the data to be retrieved
1478 is the same as the size of an address on the target machine.
1479
1480 If no string length attribute is present, the string type
1481 entry may have a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size}
1482 attribute, whose value 
1483 (see Section \refersec{chap:byteandbitsizes}) 
1484 is the amount of
1485 storage needed to hold a value of the string type.
1486
1487
1488 \section{Set Type Entries}
1489 \label{chap:settypeentries}
1490
1491 \textit{Pascal provides the concept of a “set,” which represents
1492 a group of values of ordinal type.}
1493
1494 A set is represented by a debugging information entry with
1495 the tag \livetarg{chap:DWTAGsettype}{DW\-\_TAG\-\_set\-\_type}. 
1496 If a name has been given to the
1497 set type, then the set type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute
1498 whose value is a null\dash terminated string containing the
1499 set type name as it appears in the source program.
1500
1501 The set type entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to denote the
1502 type of an element of the set.
1503
1504 If the amount of storage allocated to hold each element of an
1505 object of the given set type is different from the amount of
1506 storage that is normally allocated to hold an individual object
1507 of the indicated element type, then the set type entry has
1508 either a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute, or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute
1509 whose value (see Section \refersec{chap:byteandbitsizes}) is
1510 the amount of storage needed to hold a value of the set type.
1511
1512
1513 \section{Subrange Type Entries}
1514 \label{chap:subrangetypeentries}
1515
1516 \textit{Several languages support the concept of a ``subrange''
1517 type object. These objects can represent a subset of the
1518 values that an object of the basis type for the subrange can
1519 represent. Subrange type entries may also be used to represent
1520 the bounds of array dimensions.}
1521
1522 A subrange type is represented by a debugging information
1523 entry with the 
1524 tag \livetarg{chap:DWTAGsubrangetype}{DW\-\_TAG\-\_subrange\-\_type}. 
1525 If a name has been
1526 given to the subrange type, then the subrange type entry
1527 has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated
1528 string containing the subrange type name as it appears in
1529 the source program.
1530
1531 The subrange entry may have a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to describe
1532 the type of object, called the basis type, of whose values
1533 this subrange is a subset.
1534
1535 If the amount of storage allocated to hold each element of an
1536 object of the given subrange type is different from the amount
1537 of storage that is normally allocated to hold an individual
1538 object of the indicated element type, then the subrange
1539 type entry has a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size}
1540 attribute, whose value 
1541 (see Section \refersec{chap:staticanddynamicvaluesofattributes})
1542 is the amount of
1543 storage needed to hold a value of the subrange type.
1544
1545 The subrange entry may have a \livelink{chap:DWATthreadsscaled}{DW\-\_AT\-\_threads\-\_scaled} attribute,
1546 which is a \livelink{chap:flag}{flag}. 
1547 If present, this attribute indicates whether
1548 this subrange represents a UPC array bound which is scaled
1549 by the runtime THREADS value (the number of UPC threads in
1550 this execution of the program).
1551
1552 \textit{This allows the representation of a UPC shared array such as}
1553
1554 \begin{lstlisting}
1555 int shared foo[34*THREADS][10][20];
1556 \end{lstlisting}
1557
1558 The 
1559 \hypertarget{chap:DWATlowerboundlowerboundofsubrange}
1560 subrange entry may have the attributes 
1561 \livelink{chap:DWATlowerbound}{DW\-\_AT\-\_lower\-\_bound}
1562 and \livelink{chap:DWATupperbound}{DW\-\_AT\-\_upper\-\_bound} to specify, respectively, the lower
1563 and upper bound values of the subrange. The \livelink{chap:DWATupperbound}{DW\-\_AT\-\_upper\-\_bound}
1564 attribute 
1565 \hypertarget{chap:DWATcountelementsofsubrangetype}
1566 may be replaced by a 
1567 \livelink{chap:DWATcount}{DW\-\_AT\-\_count} attribute, whose
1568 value describes the number of elements in the subrange rather
1569 than the value of the last element. The value of each of
1570 these attributes is determined as described in 
1571 Section \refersec{chap:staticanddynamicvaluesofattributes}.
1572
1573 If the lower bound value is missing, the value is assumed to
1574 be a language\dash dependent default constant. The default lower
1575 bound is 0 for C, C++, D, Java, Objective C, Objective C++,
1576 Python, and UPC. The default lower bound is 1 for Ada, COBOL,
1577 Fortran, Modula\dash 2, Pascal and PL/I.
1578
1579 \textit{No other default lower bound values are currently defined.}
1580
1581 If the upper bound and count are missing, then the upper bound value is 
1582 \textit{unknown}.
1583
1584 If the subrange entry has no type attribute describing the
1585 basis type, the basis type is assumed to be the same as
1586 the object described by the lower bound attribute (if it
1587 references an object). If there is no lower bound attribute,
1588 or that attribute does not reference an object, the basis type
1589 is the type of the upper bound or count attribute (if either
1590 of them references an object). If there is no upper bound or
1591 count attribute, or neither references an object, the type is
1592 assumed to be the same type, in the source language of the
1593 compilation unit containing the subrange entry, as a signed
1594 integer with the same size as an address on the target machine.
1595
1596 If the subrange type occurs as the description of a dimension
1597 of an array type, and the stride for that dimension is
1598 \hypertarget{chap:DWATbytestridesubrangestridedimensionofarraytype}
1599 different than what would otherwise be determined, then
1600 \hypertarget{chap:DWATbitstridesubrangestridedimensionofarraytype}
1601 the subrange type entry has either a \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride} or
1602 \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride} attribute which specifies the separation
1603 between successive elements along the dimension as described
1604 in 
1605 Section \refersec{chap:byteandbitsizes}.
1606
1607 \textit{Note that the stride can be negative.}
1608
1609 \section{Pointer to Member Type Entries}
1610 \label{chap:pointertomembertypeentries}
1611
1612 \textit{In C++, a pointer to a data or function member of a class or
1613 structure is a unique type.}
1614
1615 A debugging information entry representing the type of an
1616 object that is a pointer to a structure or class member has
1617 the tag \livetarg{chap:DWTAGptrtomembertype}{DW\-\_TAG\-\_ptr\-\_to\-\_member\-\_type}.
1618
1619 If the pointer to member type has a name, the pointer to
1620 member entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is a
1621 null\dash terminated string containing the type name as it appears
1622 in the source program.
1623
1624 The pointer to member entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to
1625 describe the type of the class or structure member to which
1626 objects of this type may point.
1627
1628 The pointer to member entry also 
1629 \hypertarget{chap:DWATcontainingtypecontainingtypeofpointertomembertype}
1630 has a 
1631 \livelink{chap:DWATcontainingtype}{DW\-\_AT\-\_containing\-\_type}
1632 attribute, whose value is a reference to a debugging
1633 information entry for the class or structure to whose members
1634 objects of this type may point.
1635
1636 The pointer to member entry has a \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} attribute
1637 whose value is a location description that computes the
1638 address of the member of the class to which the pointer to
1639 member entry points.
1640
1641 \textit{The method used to find the address of a given member of a
1642 class or structure is common to any instance of that class
1643 or structure and to any instance of the pointer or member
1644 type. The method is thus associated with the type entry,
1645 rather than with each instance of the type.}
1646
1647 The \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} description is used in conjunction
1648 with the location descriptions for a particular object of the
1649 given pointer to member type and for a particular structure or
1650 class instance. The \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} attribute expects two
1651 values to be pushed onto the DWARF expression stack before
1652 the \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} description is evaluated. The first
1653 value pushed is the value of the pointer to member object
1654 itself. The second value pushed is the base address of the
1655 entire structure or union instance containing the member
1656 whose address is being calculated.
1657
1658 \textit{For an expression such as}
1659
1660 \begin{lstlisting}
1661     object.*mbr_ptr
1662 \end{lstlisting}
1663 % FIXME: object and mbr\_ptr should be distinguished from italic. See DW4.
1664 \textit{where mbr\_ptr has some pointer to member type, a debugger should:}
1665
1666 \textit{1. Push the value of mbr\_ptr onto the DWARF expression stack.}
1667
1668 \textit{2. Push the base address of object onto the DWARF expression stack.}
1669
1670 \textit{3. Evaluate the \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} description 
1671 given in the type of mbr\_ptr.}
1672
1673 \section{File Type Entries}
1674 \label{chap:filetypeentries}
1675
1676 \textit{Some languages, such as Pascal, provide a data type to represent 
1677 files.}
1678
1679 A file type is represented by a debugging information entry
1680 with the 
1681 \livetarg{chap:DWTAGfiletype}{DW\-\_TAG\-\_file\-\_type}. 
1682 If the file type has a name,
1683 the file type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value
1684 is a null\dash terminated string containing the type name as it
1685 appears in the source program.
1686
1687 The file type entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute describing
1688 the type of the objects contained in the file.
1689
1690 The file type entry also has a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} or
1691 \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute, whose value 
1692 (see Section \refersec{chap:staticanddynamicvaluesofattributes})
1693 is the amount of storage need to hold a value of the file type.
1694
1695 \section{Dynamic Type Properties}
1696 \label{chap:dynamictypeproperties}
1697 \subsection{Data Location}
1698 \label{chap:datalocation}
1699
1700 \textit{Some languages may represent objects using descriptors to hold
1701 information, including a location and/or run\dash time parameters,
1702 about the data that represents the value for that object.}
1703
1704 \hypertarget{chap:DWATdatalocationindirectiontoactualdata}
1705 The \livelink{chap:DWATdatalocation}{DW\-\_AT\-\_data\-\_location} 
1706 attribute may be used with any
1707 type that provides one or more levels of hidden indirection
1708 and/or run\dash time parameters in its representation. Its value
1709 is a location description. The result of evaluating this
1710 description yields the location of the data for an object.
1711 When this attribute is omitted, the address of the data is
1712 the same as the address of the object.
1713
1714 \textit{This location description will typically begin with
1715 \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address} 
1716 which loads the address of the
1717 object which can then serve as a descriptor in subsequent
1718 calculation. For an example using 
1719 \livelink{chap:DWATdatalocation}{DW\-\_AT\-\_data\-\_location} 
1720 for a Fortran 90 array, see 
1721 Appendix \refersec{app:fortran90example}.}
1722
1723 \subsection{Allocation and Association Status}
1724 \label{chap:allocationandassociationstatus}
1725
1726 \textit{Some languages, such as Fortran 90, provide types whose values
1727 may be dynamically allocated or associated with a variable
1728 under explicit program control.}
1729
1730 \hypertarget{chap:DWATallocatedallocationstatusoftypes}
1731 The 
1732 \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated} 
1733 attribute may optionally be used with any
1734 type for which objects of the type can be explicitly allocated
1735 and deallocated. The presence of the attribute indicates that
1736 objects of the type are allocatable and deallocatable. The
1737 integer value of the attribute (see below) specifies whether
1738 an object of the type is 
1739 currently allocated or not.
1740
1741 \hypertarget{chap:DWATassociatedassociationstatusoftypes}
1742 The 
1743 \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated} attribute 
1744 may optionally be used with
1745 any type for which objects of the type can be dynamically
1746 associated with other objects. The presence of the attribute
1747 indicates that objects of the type can be associated. The
1748 integer value of the attribute (see below) indicates whether
1749 an object of the type is currently associated or not.
1750
1751 While these attributes are defined specifically with Fortran
1752 90 ALLOCATABLE and POINTER types in mind, usage is not limited
1753 to just that language.
1754
1755 The value of these attributes is determined as described in
1756 Section \refersec{chap:staticanddynamicvaluesofattributes}.
1757
1758 A non\dash zero value is interpreted as allocated or associated,
1759 and zero is interpreted as not allocated or not associated.
1760
1761 \textit{For Fortran 90, if the \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated} attribute is present,
1762 the type has the POINTER property where either the parent
1763 variable is never associated with a dynamic object or the
1764 implementation does not track whether the associated object
1765 is static or dynamic. If the \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated} attribute is
1766 present and the \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated} attribute is not, the type
1767 has the ALLOCATABLE property. If both attributes are present,
1768 then the type should be assumed to have the POINTER property
1769 (and not ALLOCATABLE); the \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated} attribute may then
1770 be used to indicate that the association status of the object
1771 resulted from execution of an ALLOCATE statement rather than
1772 pointer assignment.}
1773
1774 \textit{For examples using \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated} for Ada and Fortran 90
1775 arrays, 
1776 see Appendix \refersec{app:aggregateexamples}.}
1777
1778
1779
1780 \section{Template Alias Entries}
1781 \label{chap:templatealiasentries}
1782
1783 A type named using a template alias is represented
1784 by a debugging information entry with the tag
1785 \livetarg{chap:DWTAGtemplatealias}{DW\-\_TAG\-\_template\-\_alias}. 
1786 The template alias entry has a
1787 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated string
1788 containing the name of the template alias as it appears in
1789 the source program. The template alias entry also contains a
1790 \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute whose value is a reference to the type
1791 named by the template alias. The template alias entry has
1792 the following child entries:
1793
1794 \begin{enumerate}[1.]
1795 \item Each formal parameterized type declaration appearing
1796 in the template alias declaration is represented
1797 by a debugging information entry with the tag
1798 \livelink{chap:DWTAGtemplatetypeparameter}{DW\-\_TAG\-\_template\-\_type\-\_parameter}. Each such entry may have
1799 a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is a null\dash terminated
1800 string containing the name of the formal type parameter as it
1801 appears in the source program. The template type parameter
1802 entry also has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute describing the actual
1803 type by which the formal is replaced for this instantiation.
1804
1805 \item Each formal parameterized value declaration
1806 appearing in the template alias declaration is
1807 represented by a debugging information entry with the tag
1808 \livelink{chap:DWTAGtemplatevalueparameter}{DW\-\_TAG\-\_template\-\_value\-\_parameter}. Each such entry may have
1809 a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is a null\dash terminated
1810 string containing the name of the formal value parameter
1811 as it appears in the source program. The template value
1812 parameter entry also has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute describing
1813 the type of the parameterized value. Finally, the template
1814 value parameter entry has a \livelink{chap:DWATconstvalue}{DW\-\_AT\-\_const\-\_value} attribute, whose
1815 value is the actual constant value of the value parameter for
1816 this instantiation as represented on the target architecture.
1817 \end{enumerate}
1818