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