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