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