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