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