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