9eb3aa938c530ac3a1d57bb2c53b1d3248deff53
[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 
450 \hypertarget{chap:DWATorderingarrayrowcolumnordering}
451 array type entry describing a multidimensional array may
452 have a \livelink{chap:DWATordering}{DW\-\_AT\-\_ordering} attribute whose integer constant value is
453 interpreted to mean either row-major or column-major ordering
454 of array elements. The set of values and their meanings
455 for the ordering attribute are listed in 
456 Figure \refersec{fig:arrayordering}. 
457 If no
458 ordering attribute is present, the default ordering for the
459 source language (which is indicated by the \livelink{chap:DWATlanguage}{DW\-\_AT\-\_language}
460 attribute of the enclosing compilation unit entry) is assumed.
461
462 \begin{figure}[here]
463 \autorows[0pt]{c}{1}{l}{
464 \livetarg{chap:DWORDcolmajor}{DW\-\_ORD\-\_col\-\_major},
465 \livetarg{chap:DWORDrowmajor}{DW\-\_ORD\-\_row\-\_major}
466 }
467 \caption{Array ordering}\label{fig:arrayordering}
468 \end{figure}
469
470 The ordering attribute may optionally appear on one-dimensional
471 arrays; it will be ignored.
472
473 An array type entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute describing
474 the type of each element of the array.
475
476 If the amount of storage allocated to hold each element of an
477 object of the given array type is different from the amount
478 of storage that is normally allocated to hold an individual
479 \hypertarget{chap:DWATbitstridearrayelementstrideofarraytype}
480 object of the 
481 \hypertarget{chap:DWATbytestridearrayelementstrideofarraytype}
482 indicated element type, then the array type
483 entry has either a \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride} or a \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride}
484 attribute, whose value 
485 (see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
486 is the size of each
487 element of the array.
488
489 The array type entry may have either a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} or a
490 \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute 
491 (see Section \refersec{chap:byteandbitsizes}), 
492 whose value is the
493 amount of storage needed to hold an instance of the array type.
494
495 \textit{If the size of the array can be determined statically at
496 compile time, this value can usually be computed by multiplying
497 the number of array elements by the size of each element.}
498
499
500 Each array dimension is described by a debugging information
501 entry with either the tag \livelink{chap:DWTAGsubrangetype}{DW\-\_TAG\-\_subrange\-\_type} or the tag
502 \livelink{chap:DWTAGenumerationtype}{DW\-\_TAG\-\_enumeration\-\_type}. These entries are children of the
503 array type entry and are ordered to reflect the appearance of
504 the dimensions in the source program (i.e., leftmost dimension
505 first, next to leftmost second, and so on).
506
507 In languages, such as C, in which there is no concept of
508 a “multidimensional array”, an array of arrays may
509 be represented by a debugging information entry for a
510 multidimensional array.
511
512 Other attributes especially applicable to arrays are
513 \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated}, 
514 \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated} and 
515 \livelink{chap:DWATdatalocation}{DW\-\_AT\-\_data\-\_location},
516 which are described in 
517 Section \refersec{chap:dynamictypeproperties}. 
518 For relevant examples,
519 see also 
520 Appendix \refersec{app:fortran90example}.
521
522 \section{ Structure, Union, Class and Interface Type Entries}
523 \label{chap:structureunionclassandinterfacetypeentries}
524
525 \textit{The languages C, C++, and Pascal, among others, allow the
526 programmer to define types that are collections of related
527 components. In C and C++, these collections are called
528 “structures.” In Pascal, they are called “records.”
529 The components may be of different types. The components are
530 called “members” in C and C++, and “fields” in Pascal.}
531
532 \textit{The components of these collections each exist in their
533 own space in computer memory. The components of a C or C++
534 “union” all coexist in the same memory.}
535
536 \textit{Pascal and other languages have a “discriminated union,”
537 also called a “variant record.” Here, selection of a
538 number of alternative substructures (“variants”) is based
539 on the value of a component that is not part of any of those
540 substructures (the “discriminant”).}
541
542 \textit{C++ and Java have the notion of "class”, which is in some
543 ways similar to a structure. A class may have “member
544 functions” which are subroutines that are within the scope
545 of a class or structure.}
546
547 \textit{The C++ notion of structure is more general than in C, being
548 equivalent to a class with minor differences. Accordingly,
549 in the following discussion statements about C++ classes may
550 be understood to apply to C++ structures as well.}
551
552 \subsection{Structure, Union and Class Type Entries}
553 \label{chap:structureunionandclasstypeentries}
554
555
556 Structure, union, and class types are represented by debugging
557 information entries with 
558 the tags \livetarg{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type},
559 \livetarg{chap:DWTAGuniontype}{DW\-\_TAG\-\_union\-\_type}, 
560 and \livetarg{chap:DWTAGclasstype}{DW\-\_TAG\-\_class\-\_type},
561 respectively. If a name has been given to the structure,
562 union, or class in the source program, then the corresponding
563 structure type, union type, or class type entry has a
564 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated string
565 containing the type name as it appears in the source program.
566
567 The members of a structure, union, or class are represented
568 by debugging information entries that are owned by the
569 corresponding structure type, union type, or class type entry
570 and appear in the same order as the corresponding declarations
571 in the source program.
572
573 A structure type, union type or class type entry may have
574 either a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} or a \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute 
575 \hypertarget{chap:DWATbitsizedatamemberbitsize}
576 (see Section \refersec{chap:byteandbitsizes}), 
577 whose value is the amount of storage needed
578 to hold an instance of the structure, union or class type,
579 including any padding.  An incomplete structure, union or
580 class type is represented by a structure, union or class
581 entry that does not have a byte size attribute and that has
582 a \livelink{chap:DWATdeclaration}{DW\-\_AT\-\_declaration} attribute.
583
584 If the complete declaration of a type has been placed in
585 a separate type unit 
586 (see Section \refersec{chap:separatetypeunitentries}), 
587 an incomplete
588 declaration of that type in the compilation unit may provide
589 the unique 64\dash bit signature of the type using a \livelink{chap:DWATsignature}{DW\-\_AT\-\_signature}
590 attribute.
591
592 If a structure, union or class entry represents the definition
593 of a structure, class or union member corresponding to a prior
594 incomplete structure, class or union, the entry may have a
595 \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification} attribute whose value is a reference to
596 the debugging information entry representing that incomplete
597 declaration.
598
599 Structure, union and class entries containing the
600 \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification} attribute do not need to duplicate
601 information provided by the declaration entry referenced by the
602 specification attribute.  In particular, such entries do not
603 need to contain an attribute for the name of the structure,
604 class or union they represent if such information is already
605 provided in the declaration.
606
607 \textit{For C and C++, data member declarations occurring within
608 the declaration of a structure, union or class type are
609 considered to be “definitions” of those members, with
610 the exception of “static” data members, whose definitions
611 appear outside of the declaration of the enclosing structure,
612 union or class type. Function member declarations appearing
613 within a structure, union or class type declaration are
614 definitions only if the body of the function also appears
615 within the type declaration.}
616
617 If the definition for a given member of the structure, union
618 or class does not appear within the body of the declaration,
619 that member also has a debugging information entry describing
620 its definition. That latter entry has a \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification}
621 attribute referencing the debugging information entry
622 owned by the body of the structure, union or class entry and
623 representing a non\dash defining declaration of the data, function
624 or type member. The referenced entry will not have information
625 about the location of that member (low and high pc attributes
626 for function members, location descriptions for data members)
627 and will have a \livelink{chap:DWATdeclaration}{DW\-\_AT\-\_declaration} attribute.
628
629 \textit{Consider a nested class whose 
630 definition occurs outside of the containing class definition, as in:}
631
632 \begin{lstlisting}
633 struct A {
634     struct B;
635 };
636 struct A::B { ... };
637 \end{lstlisting}
638
639 \textit{The two different structs can be described in 
640 different compilation units to 
641 facilitate DWARF space compression 
642 (see Appendix \refersec{app:usingcompilationunits}).}
643
644 \subsection{Interface Type Entries}
645 \label{chap:interfacetypeentries}
646
647 \textit{The Java language defines "interface" types. An interface
648 in Java is similar to a C++ or Java class with only abstract
649 methods and constant data members.}
650
651 Interface types are represented by debugging information
652 entries with the 
653 tag \livetarg{chap:DWTAGinterfacetype}{DW\-\_TAG\-\_interface\-\_type}.
654
655 An interface type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose
656 value is a null-terminated string containing the type name
657 as it appears in the source program.
658
659 The members of an interface are represented by debugging
660 information entries that are owned by the interface type
661 entry and that appear in the same order as the corresponding
662 declarations in the source program.
663
664 \subsection{Derived or Extended Structs, Classes and Interfaces}
665 \label{chap:derivedorextendedstructsclasesandinterfaces}
666
667 \textit{In C++, a class (or struct) may be ``derived from'' or be a
668 ``subclass of'' another class. In Java, an interface may ``extend''
669 one or more other interfaces, and a class may "extend" another
670 class and/or "implement" one or more interfaces. All of these
671 relationships may be described using the following. Note that
672 in Java, the distinction between extends and implements is
673 implied by the entities at the two ends of the relationship.}
674
675 A class type or interface type entry that describes a
676 derived, extended or implementing class or interface owns
677 debugging information entries describing each of the classes
678 or interfaces it is derived from, extending or implementing,
679 respectively, ordered as they were in the source program. Each
680 such entry has the 
681 tag \livetarg{chap:DWTAGinheritance}{DW\-\_TAG\-\_inheritance}.
682
683 An inheritance entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute whose value is
684 a reference to the debugging information entry describing the
685 class or interface from which the parent class or structure
686 of the inheritance entry is derived, extended or implementing.
687
688 An inheritance entry for a class that derives from or extends
689 \hypertarget{chap:DWATdatamemberlocationinheritedmemberlocation}
690 another class or struct also has a 
691 \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location}
692 attribute, whose value describes the location of the beginning
693 of the inherited type relative to the beginning address of the
694 derived class. If that value is a constant, it is the offset
695 in bytes from the beginning of the class to the beginning of
696 the inherited type. Otherwise, the value must be a location
697 description. In this latter case, the beginning address of
698 the derived class is pushed on the expression stack before
699 the location description is evaluated and the result of the
700 evaluation is the location of the inherited type.
701
702 \textit{The interpretation of the value of this attribute for
703 inherited types is the same as the interpretation for data
704 members 
705 (see Section \refersec{chap:datamemberentries}).  }
706
707 An inheritance entry 
708 \hypertarget{chap:DWATaccessibilitycppinheritedmembers}
709 may have a
710 \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility}
711 attribute. If no accessibility attribute
712 is present, private access is assumed for an entry of a class
713 and public access is assumed for an entry of an interface,
714 struct or union.
715
716 If the class referenced by the inheritance entry serves
717 as a C++ virtual base class, the inheritance entry has a
718 \livelink{chap:DWATvirtuality}{DW\-\_AT\-\_virtuality} attribute.
719
720 \textit{For a C++ virtual base, the data member location attribute
721 will usually consist of a non-trivial location description.}
722
723 \subsection{Access Declarations}
724 \label{chap:accessdeclarations}
725
726 \textit{In C++, a derived class may contain access declarations that
727 change the accessibility of individual class members from the
728 overall accessibility specified by the inheritance declaration.
729 A single access declaration may refer to a set of overloaded
730 names.}
731
732 If a derived class or structure contains access declarations,
733 each such declaration may be represented by a debugging
734 information entry with the tag 
735 \livetarg{chap:DWTAGaccessdeclaration}{DW\-\_TAG\-\_access\-\_declaration}. 
736 Each
737 such entry is a child of the class or structure type entry.
738
739 An access declaration entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose
740 value is a null-terminated string representing the name used
741 in the declaration in the source program, including any class
742 or structure qualifiers.
743
744 An access declaration entry 
745 \hypertarget{chap:DWATaccessibilitycppbaseclasses}
746 also has a 
747 \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility}
748 attribute describing the declared accessibility of the named
749 entities.
750
751
752 \subsection{Friends}
753 \label{chap:friends}
754
755 Each ``friend'' declared by a structure, union or class
756 type may be represented by a debugging information entry
757 that is a child of the structure, union or class type entry;
758 the friend entry has the 
759 tag \livetarg{chap:DWTAGfriend}{DW\-\_TAG\-\_friend}.
760
761 A friend entry has a \livelink{chap:DWATfriend}{DW\-\_AT\-\_friend} attribute, whose value is
762 a reference to the debugging information entry describing
763 the declaration of the friend.
764
765
766 \subsection{Data Member Entries}
767 \label{chap:datamemberentries}
768
769 A data member (as opposed to a member function) is
770 represented by a debugging information entry with the 
771 tag \livetarg{chap:DWTAGmember}{DW\-\_TAG\-\_member}. 
772 The member entry for a named member has
773 a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null-terminated
774 string containing the member name as it appears in the source
775 program. If the member entry describes an anonymous union, the
776 name attribute is omitted or consists of a single zero byte.
777
778 The data member entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to denote
779 the type of that member.
780
781 A data member entry may have a \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility}
782 attribute. If no accessibility attribute is present, private
783 access is assumed for an entry of a class and public access
784 is assumed for an entry of a structure, union, or interface.
785
786 A data member 
787 \hypertarget{chap:DWATmutablemutablepropertyofmemberdata}
788 entry may have a \livelink{chap:DWATmutable}{DW\-\_AT\-\_mutable} attribute,
789 which is a \livelink{chap:flag}{flag}. 
790 This attribute indicates whether the data
791 member was declared with the mutable storage class specifier.
792
793 The beginning of a data member is described relative to
794 the beginning of the object in which it is immediately
795 contained. In general, the beginning is characterized by
796 both an address and a bit offset within the byte at that
797 address. When the storage for an entity includes all of
798 the bits in the beginning byte, the beginning bit offset is
799 defined to be zero.
800
801 Bit offsets in DWARF use the bit numbering and direction
802 conventions that are appropriate to the current language on
803 the target system.
804
805 The member entry corresponding to a data member that is
806 \hypertarget{chap:DWATdatabitoffsetdatamemberbitlocation}
807 defined 
808 \hypertarget{chap:DWATdatamemberlocationdatamemberlocation}
809 in a structure, union or class may have either a
810 \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} attribute or a \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset}
811 attribute. If the beginning of the data member is the same as
812 the beginning of the containing entity then neither attribute
813 is required.
814
815 For a \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} attribute there are two cases:
816
817 \begin{enumerate}[1.]
818
819 \item If the value is an integer constant, it is the offset
820 in bytes from the beginning of the containing entity. If
821 the beginning of the containing entity has a non-zero bit
822 offset then the beginning of the member entry has that same
823 bit offset as well.
824
825 \item Otherwise, the value must be a location description. In
826 this case, the beginning of the containing entity must be byte
827 aligned. The beginning address is pushed on the DWARF stack
828 before the location description is evaluated; the result of
829 the evaluation is the base address of the member entry.
830
831 \textit{The push on the DWARF expression stack of the base address of
832 the containing construct is equivalent to execution of the
833 \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address} operation 
834 (see Section \refersec{chap:stackoperations});
835 \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address} therefore is not needed at the
836 beginning of a location description for a data member. The
837 result of the evaluation is a location--either an address or
838 the name of a register, not an offset to the member.}
839
840 \textit{A \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} attribute that has the form of a
841 location description is not valid for a data member contained
842 in an entity that is not byte aligned because DWARF operations
843 do not allow for manipulating or computing bit offsets.}
844
845 \end{enumerate}
846
847 For a \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} attribute, the value is an integer
848 constant 
849 (see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
850 that specifies the number of bits
851 from the beginning of the containing entity to the beginning
852 of the data member. This value must be greater than or equal
853 to zero, but is not limited to less than the number of bits
854 per byte.
855
856 If the size of a data member is not the same as the size
857 of the type given for the data member, the data member has
858 either a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} or a \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute whose
859 integer constant value 
860 (see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
861 is the amount
862 of storage needed to hold the value of the data member.
863
864 \textit{C and C++ bit fields typically require the use of the
865 \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} and \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attributes.}
866
867 \textit{This Standard uses the following bit numbering and direction
868 conventions in examples. These conventions are for illustrative
869 purposes and other conventions may apply on particular
870 architectures.}
871
872
873 \begin{itemize}
874 \item \textit{For big\dash endian architectures, bit offsets are
875 counted from high-order to low\dash order bits within a byte (or
876 larger storage unit); in this case, the bit offset identifies
877 the high\dash order bit of the object.}
878
879 \item \textit{For little\dash endian architectures, bit offsets are
880 counted from low\dash order to high\dash order bits within a byte (or
881 larger storage unit); in this case, the bit offset identifies
882 the low\dash order bit of the object.}
883 \end{itemize}
884
885
886 \textit{In either case, the bit so identified is defined as the beginning of the object.}
887
888 \textit{For example, take one possible representation of the following C structure definition in both big\dash and little\dash endian byte orders:}
889
890 \begin{lstlisting}
891 struct S {
892     int j:5;
893     int k:6;
894     int m:5;
895     int n:8;
896 };
897 \end{lstlisting}
898
899 \textit{The following diagrams show the structure layout
900 and data bit offsets for example big\dash\   and little\dash endian
901 architectures, respectively. Both diagrams show a structure
902 that begins at address A and whose size is four bytes. Also,
903 high order bits are to the left and low order bits are to
904 the right.}
905
906 \textit{Big\dash Endian Data Bit Offsets:}
907
908 \begin{verbatim}
909     j:0
910     k:5
911     m:11
912     n:16
913
914     Addresses increase ->
915     |       A       |     A + 1     |    A + 2      |    A + 3      | 
916
917     Data bit offsets increase ->
918     +---------------+---------------+---------------+---------------+
919     |0     4|5         10|11      15|16           23|24           31|
920     |   j   |     k      | m        |        n      |       <pad>   |
921     |       |            |          |               |               | 
922     +---------------------------------------------------------------+ 
923 \end{verbatim}
924
925 \textit{Little\dash  Endian Data Bit Offsets:}
926 \begin{verbatim}
927     j:0
928     k:5
929     m:11
930     n:16
931                                                <- Addresses increase
932     |       A       |     A + 1     |    A + 2      |    A + 3      | 
933
934                                         <-  Data bit offsets increase 
935
936     +---------------+---------------+---------------+---------------+
937     |31           24|23           16|15     11|10       5|4        0|
938     |     <pad>     |        n      |    m    |    k     |     j    |
939     |               |               |         |          |          |
940     +---------------------------------------------------------------+
941
942 \end{verbatim}
943
944 \textit{Note that data member bit offsets in this example are the
945 same for both big\dash\ and little\dash endian architectures even
946 though the fields are allocated in different directions
947 (high\dash order to low-order versus low\dash order to high\dash order);
948 the bit naming conventions for memory and/or registers of
949 the target architecture may or may not make this seem natural.}
950
951 \textit{For a more extensive example showing nested and packed records
952 and arrays, see 
953 Appendix \refersec{app:pascalexample}.}
954
955 \textit{Attribute \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} is new in DWARF Version 4 and
956 is also used for base types 
957 (see Section \refersec{chap:basetypeentries}). 
958 It replaces the
959 \livetarg{chap:DWATbitoffsetdatamemberbitlocation}
960 attributes \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} and \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} when used to
961 identify the beginning of bit field data members as defined
962 in DWARF V3 and earlier. The earlier attributes are defined
963 in a manner suitable for bit field members on big-endian
964 architectures but which is either awkward or incomplete for
965 use on little-endian architectures.  (\livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} also
966 has other uses that are not affected by this change.)}
967
968 \textit{The \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} and 
969 \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset}
970 attribute combination is deprecated for data members in DWARF
971 Version 4, but implementations may continue to support this
972 use for compatibility.}
973
974 \textit{The DWARF Version 3 definitions of these attributes are
975 as follows.}
976
977 \begin{myindentpara}{1cm}
978 \textit{If the data member entry describes a bit field, then that
979 entry has the following attributes:}
980
981 \begin{itemize}
982 \item \textit{A \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute whose value (see Section
983 2.19) is the number of bytes that contain an instance of the
984 bit field and any padding bits.}
985
986 \textit{The byte size attribute may be omitted if the size of the
987 object containing the bit field can be inferred from the type
988 attribute of the data member containing the bit field.}
989
990 \item \textit{A \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} attribute whose value (see Section
991 2.19) is the number of bits to the left of the leftmost
992 (most significant) bit of the bit field value.}
993
994 \item \textit{A \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute whose value (see Section
995 2.19) is the number of bits occupied by the bit field value.}
996
997 \end{itemize}
998
999 \textit{The location description for a bit field calculates the address
1000 of an anonymous object containing the bit field. The address
1001 is relative to the structure, union, or class that most closely
1002 encloses the bit field declaration. The number of bytes in this
1003 anonymous object is the value of the byte size attribute of
1004 the bit field. The offset (in bits) from the most significant
1005 bit of the anonymous object to the most significant bit of
1006 the bit field is the value of the bit offset attribute.}
1007 \end{myindentpara}
1008
1009
1010 \textit{Diagrams similar to the above that show the use of the
1011 \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} and \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset} attribute
1012 combination may be found in the DWARF Version 3 Standard.}
1013
1014 \textit{In comparing DWARF Versions 3 and 4, note that DWARF V4
1015 defines the following combinations of attributes:}
1016
1017 \begin{itemize}
1018 \item \textit{either \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} or
1019 \livelink{chap:DWATdatabitoffset}{DW\-\_AT\-\_data\-\_bit\-\_offset} (to specify the beginning of the
1020 data member)}
1021
1022 % FIXME: the indentation of the following line is suspect.
1023 \textit{optionally together with}
1024
1025 \item  \textit{either \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} (to
1026 specify the size of the data member)}
1027
1028 \end{itemize}
1029
1030 \textit{DWARF V3 defines the following combinations}
1031
1032 \begin{itemize}
1033 \item \textit{\livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} (to specify the beginning
1034 of the data member, except this specification is only partial
1035 in the case of a bit field) }
1036
1037 % FIXME: the indentation of the following line is suspect.
1038 \textit{optionally together with}
1039
1040 \item \textit{\livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}, \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} and \livelink{chap:DWATbitoffset}{DW\-\_AT\-\_bit\-\_offset}
1041 (to further specify the beginning of a bit field data member
1042 as well as specify the size of the data member) }
1043 \end{itemize}
1044
1045 \subsection{Member Function Entries}
1046 \label{chap:memberfunctionentries}
1047
1048 A member function is represented by a debugging information
1049 entry with the tag \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram}. The member function entry
1050 may contain the same attributes and follows the same rules
1051 as non\dash member global subroutine entries 
1052 (see Section \refersec{chap:subroutineandentrypointentries}).
1053
1054 A member function entry may have a \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility}
1055 attribute. If no accessibility attribute is present, private
1056 access is assumed for an entry of a class and public access
1057 is assumed for an entry of a structure, union or interface.
1058
1059 If the member function entry describes a virtual function,
1060 then that entry has a \livelink{chap:DWATvirtuality}{DW\-\_AT\-\_virtuality} attribute.
1061
1062 If 
1063 \hypertarget{chap:DWATexplicitexplicitpropertyofmemberfunction}
1064 the member function entry describes an explicit member
1065 function, then that entry has a 
1066 \livelink{chap:DWATexplicit}{DW\-\_AT\-\_explicit} attribute.
1067
1068 An entry for a virtual function also has a
1069 \livelink{chap:DWATvtableelemlocation}{DW\-\_AT\-\_vtable\-\_elem\-\_location} attribute whose value contains
1070 a location description yielding the address of the slot
1071 for the function within the virtual function table for the
1072 enclosing class. The address of an object of the enclosing
1073 type is pushed onto the expression stack before the location
1074 description is evaluated.
1075
1076 If 
1077 \hypertarget{chap:DWATobjectpointerobjectthisselfpointerofmemberfunction}
1078 the member function entry describes a non\dash static member
1079 function, then that entry has a \livelink{chap:DWATobjectpointer}{DW\-\_AT\-\_object\-\_pointer} attribute
1080 whose value is a reference to the formal parameter entry
1081 that corresponds to the object for which the function is
1082 called. The name attribute of that formal parameter is defined
1083 by the current language (for example, this for C++ or self
1084 for Objective C and some other languages). That parameter
1085 also has a \livelink{chap:DWATartificial}{DW\-\_AT\-\_artificial} attribute whose value is true.
1086
1087 Conversely, if the member function entry describes a static
1088 member function, the entry does not have a \livelink{chap:DWATobjectpointer}{DW\-\_AT\-\_object\-\_pointer}
1089 attribute.
1090
1091 If the member function entry describes a non\dash static member
1092 function that has a const\dash volatile qualification, then
1093 the entry describes a non\dash static member function whose
1094 object formal parameter has a type that has an equivalent
1095 const\dash volatile qualification.
1096
1097 If a subroutine entry represents the defining declaration
1098 of a member function and that definition appears outside of
1099 the body of the enclosing class declaration, the subroutine
1100 entry has a \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification} attribute, whose value is
1101 a reference to the debugging information entry representing
1102 the declaration of this function member. The referenced entry
1103 will be a child of some class (or structure) type entry.
1104
1105 Subroutine entries containing the \livelink{chap:DWATspecification}{DW\-\_AT\-\_specification}
1106 attribute do not need to duplicate information provided
1107 by the declaration entry referenced by the specification
1108 attribute. In particular, such entries do not need to contain
1109 attributes for the name or return type of the function member
1110 whose definition they represent.
1111
1112 \subsection{Class Template Instantiations}
1113 \label{chap:classtemplateinstantiations}
1114
1115 \textit{In C++ a class template is a generic definition of a class
1116 type that may be instantiated when an instance of the class
1117 is declared or defined. The generic description of the
1118 class may include both parameterized types and parameterized
1119 constant values. DWARF does not represent the generic template
1120 definition, but does represent each instantiation.}
1121
1122 A class template instantiation is represented by a
1123 debugging information entry with the tag \livelink{chap:DWTAGclasstype}{DW\-\_TAG\-\_class\-\_type},
1124 \livelink{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type} or \livelink{chap:DWTAGuniontype}{DW\-\_TAG\-\_union\-\_type}. With five
1125 exceptions, such an entry will contain the same attributes
1126 and have the same types of child entries as would an entry
1127 for a class type defined explicitly using the instantiation
1128 types and values. The exceptions are:
1129
1130 \begin{enumerate}[1.]
1131 \item Each formal parameterized type declaration appearing in the
1132 template definition is represented by a debugging information
1133 entry with the tag \livelink{chap:DWTAGtemplatetypeparameter}{DW\-\_TAG\-\_template\-\_type\-\_parameter}. Each
1134 such entry may have a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is
1135 a null\dash terminated string containing the name of the formal
1136 type parameter as it appears in the source program. The
1137 template type parameter entry also has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute
1138 describing the actual type by which the formal is replaced
1139 for this instantiation.
1140
1141 \item Each formal parameterized value declaration appearing in the
1142 template definition is represented by a debugging information
1143 entry with the 
1144 tag \livetarg{chap:DWTAGtemplatevalueparameter}{DW\-\_TAG\-\_template\-\_value\-\_parameter}. 
1145 Each
1146 such entry may have a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is
1147 a null\dash terminated string containing the name of the formal
1148 value parameter as it appears in the source program. 
1149 The
1150 \hypertarget{chap:DWATconstvaluetemplatevalueparameter}
1151 template value parameter entry also has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute
1152 describing the type of the parameterized value. Finally,
1153 the template value parameter entry has a \livelink{chap:DWATconstvalue}{DW\-\_AT\-\_const\-\_value}
1154 attribute, whose value is the actual constant value of the
1155 value parameter for this instantiation as represented on the
1156 target architecture.
1157
1158 \item The class type entry and each of its child entries references
1159 a template type parameter entry in any circumstance where the
1160 source template definition references a formal parameterized
1161 type. Similarly, the class type entry and each of its child
1162 entries references a template value parameter entry in any
1163 circumstance where the source template definition references
1164 a formal parameterized value.
1165
1166 \item If the compiler has generated a special compilation unit to
1167 hold the template instantiation and that special compilation
1168 unit has a different name from the compilation unit containing
1169 the template definition, the name attribute for the debugging
1170 information entry representing the special compilation unit
1171 should be empty or omitted.
1172
1173 \item If the class type entry representing the template
1174 instantiation or any of its child entries contains declaration
1175 coordinate attributes, those attributes should refer to
1176 the source for the template definition, not to any source
1177 generated artificially by the compiler.
1178 \end{enumerate}
1179
1180
1181 \subsection{Variant Entries}
1182 \label{chap:variantentries}
1183
1184 A variant part of a structure is represented by a debugging
1185 information entry with the 
1186 tag \livetarg{chap:DWTAGvariantpart}{DW\-\_TAG\-\_variant\-\_part} and is
1187 owned by the corresponding structure type entry.
1188
1189 If the variant part has a discriminant, the discriminant is
1190 \hypertarget{chap:DWATdiscrdiscriminantofvariantpart}
1191 represented by a separate debugging information entry which
1192 is a child of the variant part entry. This entry has the form
1193 of a structure data member entry. The variant part entry will
1194 have a 
1195 \livelink{chap:DWATdiscr}{DW\-\_AT\-\_discr} attribute whose value is a reference to
1196 the member entry for the discriminant.
1197
1198 If the variant part does not have a discriminant (tag field),
1199 the variant part entry has a 
1200 \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to represent
1201 the tag type.
1202
1203 Each variant of a particular variant part is represented by
1204 \hypertarget{chap:DWATdiscrvaluediscriminantvalue}
1205 a debugging information entry with the 
1206 tag \livetarg{chap:DWTAGvariant}{DW\-\_TAG\-\_variant}
1207 and is a child of the variant part entry. The value that
1208 selects a given variant may be represented in one of three
1209 ways. The variant entry may have a 
1210 \livelink{chap:DWATdiscrvalue}{DW\-\_AT\-\_discr\-\_value} attribute
1211 whose value represents a single case label. The value of this
1212 attribute is encoded as an LEB128 number. The number is signed
1213 if the tag type for the variant part containing this variant
1214 is a signed type. The number is unsigned if the tag type is
1215 an unsigned type.
1216
1217 Alternatively, 
1218 \hypertarget{chap:DWATdiscrlistlistofdiscriminantvalues}
1219 the variant entry may contain a 
1220 \livelink{chap:DWATdiscrlist}{DW\-\_AT\-\_discr\-\_list}
1221 attribute, whose value represents a list of discriminant
1222 values. This list is represented by any of the 
1223 \livelink{chap:block}{block} forms and
1224 may contain a mixture of case labels and label ranges. Each
1225 item on the list is prefixed with a discriminant value
1226 descriptor that determines whether the list item represents
1227 a single label or a label range. A single case label is
1228 represented as an LEB128 number as defined above for the
1229 \livelink{chap:DWATdiscrvalue}{DW\-\_AT\-\_discr\-\_value} attribute. A label range is represented by
1230 two LEB128 numbers, the low value of the range followed by the
1231 high value. Both values follow the rules for signedness just
1232 described. The discriminant value descriptor is an integer
1233 constant that may have one of the values given in 
1234 Figure \refersec{fig:discriminantdescriptorvalues}.
1235
1236 \begin{figure}[here]
1237 \autorows[0pt]{c}{1}{l}{
1238 \addtoindex{DW\-\_DSC\-\_label},
1239 \addtoindex{DW\-\_DSC\-\_range}
1240 }
1241 \caption{Discriminant descriptor values}\label{fig:discriminantdescriptorvalues}
1242 \end{figure}
1243
1244 If a variant entry has neither a \livelink{chap:DWATdiscrvalue}{DW\-\_AT\-\_discr\-\_value}
1245 attribute nor a \livelink{chap:DWATdiscrlist}{DW\-\_AT\-\_discr\-\_list} attribute, or if it has
1246 a \livelink{chap:DWATdiscrlist}{DW\-\_AT\-\_discr\-\_list} attribute with 0 size, the variant is a
1247 default variant.
1248
1249 The components selected by a particular variant are represented
1250 by debugging information entries owned by the corresponding
1251 variant entry and appear in the same order as the corresponding
1252 declarations in the source program.
1253
1254 \section{Condition Entries}
1255 \label{chap:conditionentries}
1256
1257 \textit{COBOL has the notion of a ``level\dash 88 condition'' that
1258 associates a data item, called the conditional variable, with
1259 a set of one or more constant values and/or value ranges.
1260 Semantically, the condition is ‛true’ if the conditional
1261 variable's value matches any of the described constants,
1262 and the condition is ‛false’ otherwise.}
1263
1264 The \livetarg{chap:DWTAGcondition}{DW\-\_TAG\-\_condition} debugging information entry
1265 describes a
1266 logical condition that tests whether a given data item’s
1267 value matches one of a set of constant values. If a name
1268 has been given to the condition, the condition entry has a
1269 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated string
1270 giving the condition name as it appears in the source program.
1271
1272 The condition entry's parent entry describes the conditional
1273 variable; normally this will be a \livelink{chap:DWTAGvariable}{DW\-\_TAG\-\_variable},
1274 \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member} or \livelink{chap:DWTAGformalparameter}{DW\-\_TAG\-\_formal\-\_parameter} entry. If the parent
1275 entry has an array type, the condition can test any individual
1276 element, but not the array as a whole. The condition entry
1277 implicitly specifies a “comparison type” that is the
1278 type of an array element if the parent has an array type;
1279 otherwise it is the type of the parent entry.
1280
1281 The condition entry owns \livelink{chap:DWTAGconstant}{DW\-\_TAG\-\_constant} and/or
1282 \livelink{chap:DWTAGsubrangetype}{DW\-\_TAG\-\_subrange\-\_type} entries that describe the constant
1283 values associated with the condition. If any child entry has
1284 a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute, that attribute should describe a type
1285 compatible with the comparison type (according to the source
1286 language); otherwise the child’s type is the same as the
1287 comparison type.
1288
1289 \textit{For conditional variables with alphanumeric types, COBOL
1290 permits a source program to provide ranges of alphanumeric
1291 constants in the condition. Normally a subrange type entry
1292 does not describe ranges of strings; however, this can be
1293 represented using bounds attributes that are references to
1294 constant entries describing strings. A subrange type entry may
1295 refer to constant entries that are siblings of the subrange
1296 type entry.}
1297
1298
1299 \section{Enumeration Type Entries}
1300 \label{chap:enumerationtypeentries}
1301
1302 \textit{An “enumeration type” is a scalar that can assume one of
1303 a fixed number of symbolic values.}
1304
1305 An enumeration type is represented by a debugging information
1306 entry with the tag 
1307 \livetarg{chap:DWTAGenumerationtype}{DW\-\_TAG\-\_enumeration\-\_type}.
1308
1309 If a name has been given to the enumeration type in the source
1310 program, then the corresponding enumeration type entry has
1311 a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated
1312 string containing the enumeration type name as it appears
1313 in the source program. This entry also has a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}
1314 attribute whose integer constant value is the number of bytes
1315 required to hold an instance of the enumeration.
1316
1317 The enumeration type entry may have a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute
1318 which refers to the underlying data type used to implement
1319 the enumeration.
1320
1321 If an enumeration type has type safe semantics such that
1322
1323 \begin{enumerate}[1.]
1324 \item Enumerators are contained in the scope of the enumeration type, and/or
1325
1326 \item Enumerators are not implicitly converted to another type
1327 \end{enumerate}
1328
1329 then the enumeration type entry may have a \livelink{chap:DWATenumclass}{DW\-\_AT\-\_enum\-\_class}
1330 attribute, which is a \livelink{chap:flag}{flag}. 
1331 In a language that offers only
1332 one kind of enumeration declaration, this attribute is not
1333 required.
1334
1335 \textit{In C or C++, the underlying type will be the appropriate
1336 integral type determined by the compiler from the properties of
1337 \hypertarget{chap:DWATenumclasstypesafeenumerationdefinition}
1338 the enumeration literal values. A C++ type declaration written
1339 using enum class declares a strongly typed enumeration and
1340 is represented using \livelink{chap:DWTAGenumerationtype}{DW\-\_TAG\-\_enumeration\-\_type} in combination
1341 with \livelink{chap:DWATenumclass}{DW\-\_AT\-\_enum\-\_class}.}
1342
1343 Each enumeration literal is represented by a debugging
1344 information entry with the 
1345 tag \livetarg{chap:DWTAGenumerator}{DW\-\_TAG\-\_enumerator}. 
1346 Each
1347 such entry is a child of the enumeration type entry, and the
1348 enumerator entries appear in the same order as the declarations
1349 of the enumeration literals in the source program.
1350
1351 Each enumerator entry has a 
1352 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose
1353 value is a null\dash terminated string containing the name of the
1354 \hypertarget{chap:DWATconstvalueenumerationliteralvalue}
1355 enumeration literal as it appears in the source program. 
1356 Each enumerator entry also has a 
1357 \livelink{chap:DWATconstvalue}{DW\-\_AT\-\_const\-\_value} attribute,
1358 whose value is the actual numeric value of the enumerator as
1359 represented on the target system.
1360
1361
1362 If the enumeration type occurs as the description of a
1363 dimension of an array type, and the stride for that dimension
1364 \hypertarget{chap:DWATbytestrideenumerationstridedimensionofarraytype}
1365 is different than what would otherwise be determined, then
1366 \hypertarget{chap:DWATbitstrideenumerationstridedimensionofarraytype}
1367 the enumeration type entry has either a \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride}
1368 or \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride} attribute which specifies the separation
1369 between successive elements along the dimension as described
1370 in 
1371 Section \refersec{chap:visibilityofdeclarations}. 
1372 The value of the \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride} attribute
1373 is interpreted as bits and the value of the \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride}
1374 attribute is interpreted as bytes.
1375
1376
1377 \section{Subroutine Type Entries}
1378 \label{chap:subroutinetypeentries}
1379
1380 It is possible in C to declare pointers to subroutines
1381 that return a value of a specific type. In both C and C++,
1382 it is possible to declare pointers to subroutines that not
1383 only return a value of a specific type, but accept only
1384 arguments of specific types. The type of such pointers would
1385 be described with a ``pointer to'' modifier applied to a
1386 user\dash defined type.
1387
1388 A subroutine type is represented by a debugging information
1389 entry with the 
1390 tag \livetarg{chap:DWTAGsubroutinetype}{DW\-\_TAG\-\_subroutine\-\_type}. 
1391 If a name has
1392 been given to the subroutine type in the source program,
1393 then the corresponding subroutine type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name}
1394 attribute whose value is a null\dash terminated string containing
1395 the subroutine type name as it appears in the source program.
1396
1397 If the subroutine type describes a function that returns
1398 a value, then the subroutine type entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type}
1399 attribute to denote the type returned by the subroutine. If
1400 the types of the arguments are necessary to describe the
1401 subroutine type, then the corresponding subroutine type
1402 entry owns debugging information entries that describe the
1403 arguments. These debugging information entries appear in the
1404 order that the corresponding argument types appear in the
1405 source program.
1406
1407 In C there is a difference between the types of functions
1408 declared using function prototype style declarations and
1409 those declared using non\dash prototype declarations.
1410
1411 A subroutine entry declared with a function prototype style
1412 declaration may have a \livelink{chap:DWATprototyped}{DW\-\_AT\-\_prototyped} attribute, which is
1413 a \livelink{chap:flag}{flag}.
1414
1415 Each debugging information entry owned by a subroutine
1416 type entry has a tag whose value has one of two possible
1417 interpretations:
1418
1419 \begin{enumerate}[1.]
1420 \item The formal parameters of a parameter list (that have a
1421 specific type) are represented by a debugging information entry
1422 with the tag \livelink{chap:DWTAGformalparameter}{DW\-\_TAG\-\_formal\-\_parameter}. Each formal parameter
1423 entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute that refers to the type of
1424 the formal parameter.
1425
1426 \item The unspecified parameters of a variable parameter list
1427 are represented by a debugging information entry with the
1428 tag \livelink{chap:DWTAGunspecifiedparameters}{DW\-\_TAG\-\_unspecified\-\_parameters}.
1429 \end{enumerate}
1430
1431
1432
1433 \section{String Type Entries}
1434 \label{chap:stringtypeentries}
1435
1436
1437 A ``string'' is a sequence of characters that have specific
1438 semantics and operations that separate them from arrays of
1439 characters. Fortran is one of the languages that has a string
1440 type. Note that ``string'' in this context refers to a target
1441 machine concept, not the class string as used in this document
1442 (except for the name attribute).
1443
1444 A string type is represented by a debugging information entry
1445 with the tag \livetarg{chap:DWTAGstringtype}{DW\-\_TAG\-\_string\-\_type}. 
1446 If a name has been given to
1447 the string type in the source program, then the corresponding
1448 string type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is
1449 a null\dash terminated string containing the string type name as
1450 it appears in the source program.
1451
1452 The string type entry may have a \livelink{chap:DWATstringlength}{DW\-\_AT\-\_string\-\_length} attribute
1453 whose value is a location description yielding the location
1454 where the length of the string is stored in the program. The
1455 string type entry may also have a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute
1456 or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute, whose value 
1457 (see Section \refersec{chap:byteandbitsizes}) 
1458 is the size of the data to be retrieved from the location
1459 referenced by the string length attribute. If no (byte or bit)
1460 size attribute is present, the size of the data to be retrieved
1461 is the same as the size of an address on the target machine.
1462
1463 If no string length attribute is present, the string type
1464 entry may have a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size}
1465 attribute, whose value 
1466 (see Section \refersec{chap:byteandbitsizes}) 
1467 is the amount of
1468 storage needed to hold a value of the string type.
1469
1470
1471 \section{Set Type Entries}
1472 \label{chap:settypeentries}
1473
1474 \textit{Pascal provides the concept of a “set,” which represents
1475 a group of values of ordinal type.}
1476
1477 A set is represented by a debugging information entry with
1478 the tag \livetarg{chap:DWTAGsettype}{DW\-\_TAG\-\_set\-\_type}. 
1479 If a name has been given to the
1480 set type, then the set type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute
1481 whose value is a null\dash terminated string containing the
1482 set type name as it appears in the source program.
1483
1484 The set type entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to denote the
1485 type of an element of the set.
1486
1487 If the amount of storage allocated to hold each element of an
1488 object of the given set type is different from the amount of
1489 storage that is normally allocated to hold an individual object
1490 of the indicated element type, then the set type entry has
1491 either a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute, or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute
1492 whose value (see Section \refersec{chap:byteandbitsizes}) is
1493 the amount of storage needed to hold a value of the set type.
1494
1495
1496 \section{Subrange Type Entries}
1497 \label{chap:subrangetypeentries}
1498
1499 \textit{Several languages support the concept of a ``subrange''
1500 type object. These objects can represent a subset of the
1501 values that an object of the basis type for the subrange can
1502 represent. Subrange type entries may also be used to represent
1503 the bounds of array dimensions.}
1504
1505 A subrange type is represented by a debugging information
1506 entry with the 
1507 tag \livetarg{chap:DWTAGsubrangetype}{DW\-\_TAG\-\_subrange\-\_type}. 
1508 If a name has been
1509 given to the subrange type, then the subrange type entry
1510 has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated
1511 string containing the subrange type name as it appears in
1512 the source program.
1513
1514 The subrange entry may have a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to describe
1515 the type of object, called the basis type, of whose values
1516 this subrange is a subset.
1517
1518 If the amount of storage allocated to hold each element of an
1519 object of the given subrange type is different from the amount
1520 of storage that is normally allocated to hold an individual
1521 object of the indicated element type, then the subrange
1522 type entry has a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} attribute or \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size}
1523 attribute, whose value 
1524 (see Section \refersec{chap:staticanddynamicvaluesofattributes})
1525 is the amount of
1526 storage needed to hold a value of the subrange type.
1527
1528 The subrange entry may have a \livelink{chap:DWATthreadsscaled}{DW\-\_AT\-\_threads\-\_scaled} attribute,
1529 which is a \livelink{chap:flag}{flag}. 
1530 If present, this attribute indicates whether
1531 this subrange represents a UPC array bound which is scaled
1532 by the runtime THREADS value (the number of UPC threads in
1533 this execution of the program).
1534
1535 \textit{This allows the representation of a UPC shared array such as}
1536
1537 \begin{lstlisting}
1538 int shared foo[34*THREADS][10][20];
1539 \end{lstlisting}
1540
1541 The subrange entry may have the attributes \livelink{chap:DWATlowerbound}{DW\-\_AT\-\_lower\-\_bound}
1542 and \livelink{chap:DWATupperbound}{DW\-\_AT\-\_upper\-\_bound} to specify, respectively, the lower
1543 and upper bound values of the subrange. The \livelink{chap:DWATupperbound}{DW\-\_AT\-\_upper\-\_bound}
1544 attribute 
1545 \hypertarget{chap:DWATcountelementsofsubrangetype}
1546 may be replaced by a 
1547 \livelink{chap:DWATcount}{DW\-\_AT\-\_count} attribute, whose
1548 value describes the number of elements in the subrange rather
1549 than the value of the last element. The value of each of
1550 these attributes is determined as described in 
1551 Section \refersec{chap:staticanddynamicvaluesofattributes}.
1552
1553 If the lower bound value is missing, the value is assumed to
1554 be a language\dash dependent default constant. The default lower
1555 bound is 0 for C, C++, D, Java, Objective C, Objective C++,
1556 Python, and UPC. The default lower bound is 1 for Ada, COBOL,
1557 Fortran, Modula\dash 2, Pascal and PL/I.
1558
1559 \textit{No other default lower bound values are currently defined.}
1560
1561 If the upper bound and count are missing, then the upper bound value is 
1562 \textit{unknown}.
1563
1564 If the subrange entry has no type attribute describing the
1565 basis type, the basis type is assumed to be the same as
1566 the object described by the lower bound attribute (if it
1567 references an object). If there is no lower bound attribute,
1568 or that attribute does not reference an object, the basis type
1569 is the type of the upper bound or count attribute (if either
1570 of them references an object). If there is no upper bound or
1571 count attribute, or neither references an object, the type is
1572 assumed to be the same type, in the source language of the
1573 compilation unit containing the subrange entry, as a signed
1574 integer with the same size as an address on the target machine.
1575
1576 If the subrange type occurs as the description of a dimension
1577 of an array type, and the stride for that dimension is
1578 \hypertarget{chap:DWATbytestridesubrangestridedimensionofarraytype}
1579 different than what would otherwise be determined, then
1580 \hypertarget{chap:DWATbitstridesubrangestridedimensionofarraytype}
1581 the subrange type entry has either a \livelink{chap:DWATbytestride}{DW\-\_AT\-\_byte\-\_stride} or
1582 \livelink{chap:DWATbitstride}{DW\-\_AT\-\_bit\-\_stride} attribute which specifies the separation
1583 between successive elements along the dimension as described
1584 in 
1585 Section \refersec{chap:byteandbitsizes}.
1586
1587 \textit{Note that the stride can be negative.}
1588
1589 \section{Pointer to Member Type Entries}
1590 \label{chap:pointertomembertypeentries}
1591
1592 \textit{In C++, a pointer to a data or function member of a class or
1593 structure is a unique type.}
1594
1595 A debugging information entry representing the type of an
1596 object that is a pointer to a structure or class member has
1597 the tag \livetarg{chap:DWTAGptrtomembertype}{DW\-\_TAG\-\_ptr\-\_to\-\_member\-\_type}.
1598
1599 If the pointer to member type has a name, the pointer to
1600 member entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is a
1601 null\dash terminated string containing the type name as it appears
1602 in the source program.
1603
1604 The pointer to member entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute to
1605 describe the type of the class or structure member to which
1606 objects of this type may point.
1607
1608 The pointer to member entry also 
1609 \hypertarget{chap:DWATcontainingtypecontainingtypeofpointertomembertype}
1610 has a 
1611 \livelink{chap:DWATcontainingtype}{DW\-\_AT\-\_containing\-\_type}
1612 attribute, whose value is a reference to a debugging
1613 information entry for the class or structure to whose members
1614 objects of this type may point.
1615
1616 The pointer to member entry has a \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} attribute
1617 whose value is a location description that computes the
1618 address of the member of the class to which the pointer to
1619 member entry points.
1620
1621 \textit{The method used to find the address of a given member of a
1622 class or structure is common to any instance of that class
1623 or structure and to any instance of the pointer or member
1624 type. The method is thus associated with the type entry,
1625 rather than with each instance of the type.}
1626
1627 The \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} description is used in conjunction
1628 with the location descriptions for a particular object of the
1629 given pointer to member type and for a particular structure or
1630 class instance. The \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} attribute expects two
1631 values to be pushed onto the DWARF expression stack before
1632 the \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} description is evaluated. The first
1633 value pushed is the value of the pointer to member object
1634 itself. The second value pushed is the base address of the
1635 entire structure or union instance containing the member
1636 whose address is being calculated.
1637
1638 \textit{For an expression such as}
1639
1640 \begin{lstlisting}
1641     object.*mbr_ptr
1642 \end{lstlisting}
1643 % FIXME: object and mbr\_ptr should be distinguished from italic. See DW4.
1644 \textit{where mbr\_ptr has some pointer to member type, a debugger should:}
1645
1646 \textit{1. Push the value of mbr\_ptr onto the DWARF expression stack.}
1647
1648 \textit{2. Push the base address of object onto the DWARF expression stack.}
1649
1650 \textit{3. Evaluate the \livelink{chap:DWATuselocation}{DW\-\_AT\-\_use\-\_location} description 
1651 given in the type of mbr\_ptr.}
1652
1653 \section{File Type Entries}
1654 \label{chap:filetypeentries}
1655
1656 \textit{Some languages, such as Pascal, provide a data type to represent 
1657 files.}
1658
1659 A file type is represented by a debugging information entry
1660 with the 
1661 \livetarg{chap:DWTAGfiletype}{DW\-\_TAG\-\_file\-\_type}. 
1662 If the file type has a name,
1663 the file type entry has a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value
1664 is a null\dash terminated string containing the type name as it
1665 appears in the source program.
1666
1667 The file type entry has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute describing
1668 the type of the objects contained in the file.
1669
1670 The file type entry also has a \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} or
1671 \livelink{chap:DWATbitsize}{DW\-\_AT\-\_bit\-\_size} attribute, whose value 
1672 (see Section \refersec{chap:staticanddynamicvaluesofattributes})
1673 is the amount of storage need to hold a value of the file type.
1674
1675 \section{Dynamic Type Properties}
1676 \label{chap:dynamictypeproperties}
1677 \subsection{Data Location}
1678 \label{chap:datalocation}
1679
1680 \textit{Some languages may represent objects using descriptors to hold
1681 information, including a location and/or run\dash time parameters,
1682 about the data that represents the value for that object.}
1683
1684 \hypertarget{chap:DWATdatalocationindirectiontoactualdata}
1685 The \livelink{chap:DWATdatalocation}{DW\-\_AT\-\_data\-\_location} 
1686 attribute may be used with any
1687 type that provides one or more levels of hidden indirection
1688 and/or run\dash time parameters in its representation. Its value
1689 is a location description. The result of evaluating this
1690 description yields the location of the data for an object.
1691 When this attribute is omitted, the address of the data is
1692 the same as the address of the object.
1693
1694 \textit{This location description will typically begin with
1695 \livelink{chap:DWOPpushobjectaddress}{DW\-\_OP\-\_push\-\_object\-\_address} 
1696 which loads the address of the
1697 object which can then serve as a descriptor in subsequent
1698 calculation. For an example using 
1699 \livelink{chap:DWATdatalocation}{DW\-\_AT\-\_data\-\_location} 
1700 for a Fortran 90 array, see 
1701 Appendix \refersec{app:fortran90example}.}
1702
1703 \subsection{Allocation and Association Status}
1704 \label{chap:allocationandassociationstatus}
1705
1706 \textit{Some languages, such as Fortran 90, provide types whose values
1707 may be dynamically allocated or associated with a variable
1708 under explicit program control.}
1709
1710 \hypertarget{chap:DWATallocatedallocationstatusoftypes}
1711 The 
1712 \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated} 
1713 attribute may optionally be used with any
1714 type for which objects of the type can be explicitly allocated
1715 and deallocated. The presence of the attribute indicates that
1716 objects of the type are allocatable and deallocatable. The
1717 integer value of the attribute (see below) specifies whether
1718 an object of the type is 
1719 currently allocated or not.
1720
1721 \hypertarget{chap:DWATassociatedassociationstatusoftypes}
1722 The 
1723 \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated} attribute 
1724 may optionally be used with
1725 any type for which objects of the type can be dynamically
1726 associated with other objects. The presence of the attribute
1727 indicates that objects of the type can be associated. The
1728 integer value of the attribute (see below) indicates whether
1729 an object of the type is currently associated or not.
1730
1731 While these attributes are defined specifically with Fortran
1732 90 ALLOCATABLE and POINTER types in mind, usage is not limited
1733 to just that language.
1734
1735 The value of these attributes is determined as described in
1736 Section \refersec{chap:staticanddynamicvaluesofattributes}.
1737
1738 A non\dash zero value is interpreted as allocated or associated,
1739 and zero is interpreted as not allocated or not associated.
1740
1741 \textit{For Fortran 90, if the \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated} attribute is present,
1742 the type has the POINTER property where either the parent
1743 variable is never associated with a dynamic object or the
1744 implementation does not track whether the associated object
1745 is static or dynamic. If the \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated} attribute is
1746 present and the \livelink{chap:DWATassociated}{DW\-\_AT\-\_associated} attribute is not, the type
1747 has the ALLOCATABLE property. If both attributes are present,
1748 then the type should be assumed to have the POINTER property
1749 (and not ALLOCATABLE); the \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated} attribute may then
1750 be used to indicate that the association status of the object
1751 resulted from execution of an ALLOCATE statement rather than
1752 pointer assignment.}
1753
1754 \textit{For examples using \livelink{chap:DWATallocated}{DW\-\_AT\-\_allocated} for Ada and Fortran 90
1755 arrays, 
1756 see Appendix \refersec{app:aggregateexamples}.}
1757
1758
1759
1760 \section{Template Alias Entries}
1761 \label{chap:templatealiasentries}
1762
1763 A type named using a template alias is represented
1764 by a debugging information entry with the tag
1765 \livetarg{chap:DWTAGtemplatealias}{DW\-\_TAG\-\_template\-\_alias}. 
1766 The template alias entry has a
1767 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute whose value is a null\dash terminated string
1768 containing the name of the template alias as it appears in
1769 the source program. The template alias entry also contains a
1770 \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute whose value is a reference to the type
1771 named by the template alias. The template alias entry has
1772 the following child entries:
1773
1774 \begin{enumerate}[1.]
1775 \item Each formal parameterized type declaration appearing
1776 in the template alias declaration is represented
1777 by a debugging information entry with the tag
1778 \livelink{chap:DWTAGtemplatetypeparameter}{DW\-\_TAG\-\_template\-\_type\-\_parameter}. Each such entry may have
1779 a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is a null\dash terminated
1780 string containing the name of the formal type parameter as it
1781 appears in the source program. The template type parameter
1782 entry also has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute describing the actual
1783 type by which the formal is replaced for this instantiation.
1784
1785 \item Each formal parameterized value declaration
1786 appearing in the template alias declaration is
1787 represented by a debugging information entry with the tag
1788 \livelink{chap:DWTAGtemplatevalueparameter}{DW\-\_TAG\-\_template\-\_value\-\_parameter}. Each such entry may have
1789 a \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, whose value is a null\dash terminated
1790 string containing the name of the formal value parameter
1791 as it appears in the source program. The template value
1792 parameter entry also has a \livelink{chap:DWATtype}{DW\-\_AT\-\_type} attribute describing
1793 the type of the parameterized value. Finally, the template
1794 value parameter entry has a \livelink{chap:DWATconstvalue}{DW\-\_AT\-\_const\-\_value} attribute, whose
1795 value is the actual constant value of the value parameter for
1796 this instantiation as represented on the target architecture.
1797 \end{enumerate}
1798