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