Draft document for Committee review.
[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}[!h]
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}[h]
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}[h]
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 \needlines{4}
1542 If a variant entry has neither a \DWATdiscrvalue{}
1543 attribute nor a \DWATdiscrlist{} attribute, or if it has
1544 a \DWATdiscrlist{} attribute with 0 size, the variant is a
1545 default variant.
1546
1547 The components selected by a particular variant are represented
1548 by debugging information entries owned by the corresponding
1549 variant entry and appear in the same order as the corresponding
1550 declarations in the source program.
1551
1552 \needlines{6}
1553 \section{Condition Entries}
1554 \label{chap:conditionentries}
1555
1556 \textit{COBOL has the notion of 
1557 \addtoindexx{level-88 condition, COBOL}
1558 a \doublequote{level\dash 88 condition} that
1559 associates a data item, called the conditional variable, with
1560 a set of one or more constant values and/or value ranges.
1561 % Note: the {} after \textquoteright (twice) is necessary to assure a following space separator
1562 Semantically, the condition is \textquoteleft true\textquoteright{}
1563 if the conditional
1564 variable's value matches any of the described constants,
1565 and the condition is \textquoteleft false\textquoteright{} otherwise.}
1566
1567 The \DWTAGconditionTARG{}
1568 debugging information entry\addtoindexx{condition entry}
1569 describes a
1570 logical condition that tests whether a given data item\textquoteright s
1571 value matches one of a set of constant values. If a name
1572 has been given to the condition, the condition entry has a
1573 \DWATname{} attribute
1574 \addtoindexx{name attribute}
1575 whose value is a null\dash terminated string
1576 giving the condition name as it appears in the source program.
1577
1578 \needlines{4}
1579 The condition entry's parent entry describes the conditional
1580 variable; normally this will be a \DWTAGvariable,
1581 \DWTAGmember{} or 
1582 \DWTAGformalparameter{} entry.
1583 If 
1584 \addtoindexx{formal parameter entry}
1585 the parent
1586 entry has an array type, the condition can test any individual
1587 element, but not the array as a whole. The condition entry
1588 implicitly specifies a \doublequote{comparison type} that is the
1589 type of an array element if the parent has an array type;
1590 otherwise it is the type of the parent entry.
1591
1592 %\needlines{4}
1593 The condition entry owns \DWTAGconstant{} and/or
1594 \DWTAGsubrangetype{} entries that describe the constant
1595 values associated with the condition. If any child entry 
1596 \addtoindexx{type attribute}
1597 has
1598 a \DWATtype{} attribute,
1599 that attribute should describe a type
1600 compatible with the comparison type (according to the source
1601 language); otherwise the child\textquoteright s type is the same as the
1602 comparison type.
1603
1604 \textit{For conditional variables with alphanumeric types, COBOL
1605 permits a source program to provide ranges of alphanumeric
1606 constants in the condition. Normally a subrange type entry
1607 does not describe ranges of strings; however, this can be
1608 represented using bounds attributes that are references to
1609 constant entries describing strings. A subrange type entry may
1610 refer to constant entries that are siblings of the subrange
1611 type entry.}
1612
1613
1614 \section{Enumeration Type Entries}
1615 \label{chap:enumerationtypeentries}
1616
1617 \textit{An \doublequote{enumeration type} is a scalar that can assume one of
1618 a fixed number of symbolic values.}
1619
1620 An enumeration type is represented by a debugging information
1621 entry with the tag 
1622 \DWTAGenumerationtypeTARG.
1623
1624 If a name has been given to the enumeration type in the source
1625 program, then the corresponding enumeration type entry has
1626 a \DWATname{} attribute
1627 \addtoindexx{name attribute}
1628 whose value is a null\dash terminated
1629 string containing the enumeration type name as it appears
1630 in the source program. 
1631
1632 The \addtoindex{enumeration type entry}
1633 may have 
1634 \addtoindexx{type attribute}
1635 a \DWATtype{} attribute
1636 which refers to the underlying data type used to implement
1637 the enumeration. The entry also may have a 
1638 \DWATbytesize{} attribute whose 
1639 \livelink{chap:classconstant}{integer constant} value is the number of bytes 
1640 required to hold an instance of the enumeration. If no \DWATbytesize{} attribute 
1641 is present, the size for holding an instance of the enumeration is given by the size 
1642 of the underlying data type.
1643
1644 \needlines{4}
1645 If an enumeration type has type safe 
1646 \addtoindexx{type safe enumeration types}
1647 semantics such that
1648
1649 \begin{enumerate}[1. ]
1650 \item Enumerators are contained in the scope of the enumeration type, and/or
1651
1652 \item Enumerators are not implicitly converted to another type
1653 \end{enumerate}
1654
1655 then the \addtoindex{enumeration type entry} may 
1656 \addtoindexx{enum class|see{type-safe enumeration}}
1657 have a \DWATenumclassDEFN{}
1658 attribute, which is a \livelink{chap:classflag}{flag}. 
1659 In a language that offers only
1660 one kind of enumeration declaration, this attribute is not
1661 required.
1662
1663 \textit{In \addtoindex{C} or \addtoindex{C++}, 
1664 the underlying type will be the appropriate
1665 integral type determined by the compiler from the properties of
1666 \hypertarget{chap:DWATenumclasstypesafeenumerationdefinition}{}
1667 the enumeration literal values. 
1668 A \addtoindex{C++} type declaration written
1669 using enum class declares a strongly typed enumeration and
1670 is represented using \DWTAGenumerationtype{} 
1671 in combination with \DWATenumclass.}
1672
1673 Each enumeration literal is represented by a debugging
1674 \addtoindexx{enumeration literal|see{enumeration entry}}
1675 information entry with the 
1676 tag \DWTAGenumeratorTARG. 
1677 Each
1678 such entry is a child of the 
1679 \addtoindex{enumeration type entry}, and the
1680 enumerator entries appear in the same order as the declarations
1681 of the enumeration literals in the source program.
1682
1683 \needlines{4}
1684 Each \addtoindex{enumerator entry} has a \DWATname{} attribute, whose
1685 \addtoindexx{name attribute}
1686 value is a null-terminated string containing the name of the
1687 \hypertarget{chap:DWATconstvalueenumerationliteralvalue}{}
1688 enumeration literal as it appears in the source program. 
1689 Each enumerator entry also has a 
1690 \DWATconstvalueDEFN{} attribute,
1691 \addtoindexx{constant value attribute}
1692 whose value is the actual numeric value of the enumerator as
1693 represented on the target system.
1694
1695 If the enumeration type occurs as the description of a
1696 \addtoindexx{enumeration type entry!as array dimension}
1697 dimension of an array type, and the stride for that dimension
1698 \hypertarget{chap:DWATbytestrideenumerationstridedimensionofarraytype}{}
1699 is different than what would otherwise be determined, then
1700 \hypertarget{chap:DWATbitstrideenumerationstridedimensionofarraytype}{}
1701 the enumeration type entry has either a 
1702 \DWATbytestrideDEFN{}
1703 or \DWATbitstrideDEFN{} attribute 
1704 \addtoindexx{bit stride attribute}
1705 which specifies the separation
1706 between successive elements along the dimension as described
1707 in 
1708 Section \refersec{chap:staticanddynamicvaluesofattributes}. 
1709 The value of the 
1710 \DWATbitstride{} attribute
1711 \addtoindexx{bit stride attribute}
1712 is interpreted as bits and the value of 
1713 \addtoindexx{byte stride attribute}
1714 the 
1715 \DWATbytestride{}
1716 attribute is interpreted as bytes.
1717
1718
1719 \section{Subroutine Type Entries}
1720 \label{chap:subroutinetypeentries}
1721
1722 \textit{It is possible in \addtoindex{C}
1723 to declare pointers to subroutines
1724 that return a value of a specific type. In both 
1725 \addtoindex{C} and \addtoindex{C++},
1726 it is possible to declare pointers to subroutines that not
1727 only return a value of a specific type, but accept only
1728 arguments of specific types. The type of such pointers would
1729 be described with a \doublequote{pointer to} modifier applied to a
1730 user\dash defined type.}
1731
1732 \needlines{4}
1733 A subroutine type is represented by a debugging information
1734 entry with the 
1735 \addtoindexx{subroutine type entry}
1736 tag \DWTAGsubroutinetypeTARG. 
1737 If a name has
1738 been given to the subroutine type in the source program,
1739 then the corresponding subroutine type entry has 
1740 a \DWATname{} attribute 
1741 \addtoindexx{name attribute}
1742 whose value is a null\dash terminated string containing
1743 the subroutine type name as it appears in the source program.
1744
1745 If the subroutine type describes a function that returns
1746 a value, then the subroutine type entry has 
1747 \addtoindexx{type attribute}
1748 a \DWATtype{}
1749 attribute to denote the type returned by the subroutine. If
1750 the types of the arguments are necessary to describe the
1751 subroutine type, then the corresponding subroutine type
1752 entry owns debugging information entries that describe the
1753 arguments. These debugging information entries appear in the
1754 order that the corresponding argument types appear in the
1755 source program.
1756
1757 \textit{In \addtoindex{C} there 
1758 is a difference between the types of functions
1759 declared using function prototype style declarations and
1760 those declared using non\dash prototype declarations.}
1761
1762
1763 \hypertarget{chap:DWATprototypedsubroutineprototype}{}
1764 subroutine entry declared with a function prototype style
1765 declaration may have 
1766 \addtoindexx{prototyped attribute}
1767
1768 \DWATprototypedDEFN{} attribute, which is
1769 a \livelink{chap:classflag}{flag}.
1770
1771 \needlines{4}
1772 Each debugging information entry owned by a subroutine
1773 type entry corresponds to either a formal parameter or the sequence of
1774 unspecified parameters of the subprogram type:
1775
1776 \begin{enumerate}[1. ]
1777 \item A formal parameter of a parameter list (that has a
1778 specific type) is represented by a debugging information entry
1779 with the tag \DWTAGformalparameter. 
1780 Each formal parameter
1781 entry has 
1782 \addtoindexx{type attribute}
1783 a \DWATtype{} attribute that refers to the type of
1784 the formal parameter.
1785
1786 \item The unspecified parameters of a variable parameter list
1787 \addtoindexx{unspecified parameters entry}
1788 are 
1789 \addtoindexx{\texttt{...} parameters|see{unspecified parameters entry}}
1790 represented by a debugging information entry with the
1791 tag \DWTAGunspecifiedparameters.
1792 \end{enumerate}
1793
1794 \textit{\addtoindex{C++} const-volatile qualifiers are encoded as 
1795 part of the type of the
1796 \doublequote{\texttt{this}}-pointer. 
1797 \addtoindex{C++:2011 (ISO)} reference and rvalue-reference qualifiers are encoded using
1798 the \DWATreference{} and \DWATrvaluereference{} attributes, respectively. 
1799 See also Section \refersec{chap:memberfunctionentries}.}
1800
1801 \needlines{4}
1802 A subroutine type entry may have the \DWATreference{} or
1803 \DWATrvaluereference{} attribute to indicate that it describes the
1804 type of a member function with reference or rvalue-reference 
1805 semantics, respectively.
1806
1807 \needlines{6}
1808 \section{String Type Entries}
1809 \label{chap:stringtypeentries}
1810
1811 \textit{A \doublequote{string} is a sequence of characters that have specific
1812 \addtoindexx{string type entry}
1813 semantics and operations that distinguish them from arrays of
1814 characters. 
1815 \addtoindex{Fortran} is one of the languages that has a string
1816 type. Note that \doublequote{string} in this context refers to a target
1817 machine concept, not the class string as used in this document
1818 (except for the name attribute).}
1819
1820 A string type is represented by a debugging information entry
1821 with the tag \DWTAGstringtypeTARG. 
1822 If a name has been given to
1823 the string type in the source program, then the corresponding
1824 string type entry has a 
1825 \DWATname{} attribute
1826 \addtoindexx{name attribute}
1827 whose value is
1828 a null\dash terminated string containing the string type name as
1829 it appears in the source program.
1830
1831 A string type entry may have a \DWATtypeDEFN{} 
1832 \livetargi{char:DWAATtypeofstringtype}{attribute}{type attribute!of string type entry}
1833 describing how each character is encoded and is to be interpreted.  
1834 The value of this attribute is a \CLASSreference{} to a 
1835 \DWTAGbasetype{} base type entry.  If the attribute is absent, 
1836 then the character is encoded using the system default.
1837
1838 \textit{The 
1839 \addtoindex{Fortran 2003} language standard allows string 
1840 types that are composed of different types of (same sized) characters. 
1841 While there is no standard list of character kinds, the kinds
1842 \texttt{ASCII}\index{ASCII@\texttt{ASCII} (Fortran string kind)} (see \DWATEASCII), 
1843 \texttt{ISO\_10646}\index{ISO\_10646@\texttt{ISO\_10646} (Fortran string kind)}
1844 \addtoindexx{ISO 10646 character set standard}
1845 (see \DWATEUCS) and 
1846 \texttt{DEFAULT}\index{DEFAULT@\texttt{DEFAULT} (Fortran string kind)}
1847 are defined.}
1848
1849 \needlines{4}
1850 The string type entry may have a 
1851 \DWATbytesize{} attribute or 
1852 \DWATbitsize{}
1853 attribute, whose value 
1854 (see Section \refersec{chap:byteandbitsizes}) 
1855 is the amount of
1856 storage needed to hold a value of the string type.
1857
1858 The 
1859 \hypertarget{chap:DWATstringlengthstringlengthofstringtype}{}
1860 string type entry may also have a 
1861 \DWATstringlengthDEFN{} attribute
1862 whose 
1863 \addtoindexx{string length attribute}
1864 value is a 
1865 \addtoindex{location description} yielding the location
1866 where the length of the string is stored in the program.
1867 If the \DWATstringlengthNAME{} attribute is not present, the size
1868 of the string is assumed to be the amount of storage that is
1869 allocated for the string (as specified by the \DWATbytesize{}
1870 or \DWATbitsize{} attribute).
1871
1872 The string type entry may also have a 
1873 \DWATstringlengthbytesizeDEFN{} or
1874 \DWATstringlengthbitsizeDEFN{} attribute,
1875 \addtoindexx{string length size attribute}
1876 \addtoindexx{string length attribute!size of length data}
1877 whose value (see Section \refersec{chap:byteandbitsizes}) 
1878 is the size of the data to be retrieved from the location
1879 referenced by the \DWATstringlength{} attribute. If no byte or bit
1880 size attribute is present, the size of the data to be retrieved
1881 is the same as the 
1882 \addtoindex{size of an address} on the target machine.
1883
1884 \needlines{8}
1885 \addtoindexx{DWARF Version 5}   % Avoid italics
1886 \textit{Prior to DWARF Version 5, the meaning of a 
1887 \DWATbytesize{} attribute depended on the presence of the
1888 \DWATstringlength{} attribute:
1889 \begin{itemize}
1890 \item If \DWATstringlength{} was present, \DWATbytesize{} 
1891         specified the size of the length data to be retrieved 
1892         from the location specified by the \DWATstringlength{} attribute.
1893 \item If \DWATstringlength{} was not present, \DWATbytesize{}
1894         specified the amount of storage allocated for objects
1895         of the string type.
1896 \end{itemize}
1897 In \DWARFVersionV{}, \DWATbytesize{} always specifies the amount of storage 
1898 allocated for objects of the string type.}
1899
1900 \needlines{6}
1901 \section{Set Type Entries}
1902 \label{chap:settypeentries}
1903
1904 \textit{\addtoindex{Pascal} provides the concept of a \doublequote{set,} which represents
1905 a group of values of ordinal type.}
1906
1907 A set is represented by a debugging information entry with
1908 the tag \DWTAGsettypeTARG. 
1909 \addtoindexx{set type entry}
1910 If a name has been given to the
1911 set type, then the set type entry has 
1912 a \DWATname{} attribute
1913 \addtoindexx{name attribute}
1914 whose value is a null\dash terminated string containing the
1915 set type name as it appears in the source program.
1916
1917 The set type entry has 
1918 \addtoindexx{type attribute}
1919 a \DWATtype{} attribute to denote the
1920 type of an element of the set.
1921
1922 \needlines{4}
1923 If the amount of storage allocated to hold each element of an
1924 object of the given set type is different from the amount of
1925 storage that is normally allocated to hold an individual object
1926 of the indicated element type, then the set type entry has
1927 either a \DWATbytesize{} attribute, or 
1928 \DWATbitsize{} attribute
1929 whose value (see Section \refersec{chap:byteandbitsizes}) is
1930 the amount of storage needed to hold a value of the set type.
1931
1932 \needlines{5}
1933 \section{Subrange Type Entries}
1934 \label{chap:subrangetypeentries}
1935
1936 \textit{Several languages support the concept of a \doublequote{subrange}
1937 type. Objects of the subrange type can represent only a contiguous 
1938 subset (range) of values from the type on which the subrange is defined.
1939 Subrange types may also be used to represent the bounds of array dimensions.}
1940
1941 A subrange type is represented by a debugging information
1942 entry with the tag 
1943 \DWTAGsubrangetypeTARG.\addtoindexx{subrange type entry} 
1944 If a name has been given to the subrange type, then the 
1945 subrange type entry has a 
1946 \DWATname{} attribute\addtoindexx{name attribute}
1947 whose value is a null-terminated
1948 string containing the subrange type name as it appears in
1949 the source program.
1950
1951 The tag \DWTAGgenericsubrange{}
1952 is used to describe arrays with a dynamic rank. See Section
1953 \refersec{chap:DWTAGgenericsubrange}.
1954
1955 The subrange entry may have a 
1956 \DWATtype{} attribute\addtoindexx{type attribute} to describe
1957 the type of object, called the basis type, of whose values
1958 this subrange is a subset.
1959
1960 If the amount of storage allocated to hold each element of an
1961 object of the given subrange type is different from the amount
1962 of storage that is normally allocated to hold an individual
1963 object of the indicated element type, then the subrange
1964 type entry has a 
1965 \DWATbytesize{} attribute or 
1966 \DWATbitsize{}
1967 attribute, whose value 
1968 (see Section \refersec{chap:staticanddynamicvaluesofattributes})
1969 is the amount of storage needed to hold a value of the subrange type.
1970
1971 The 
1972 \hypertarget{chap:DWATthreadsscaledupcarrayboundthreadsscalfactor}{}
1973 subrange entry may have a 
1974 \DWATthreadsscaledDEFN{} attribute\addtoindexx{threads scaled attribute},
1975 which is a \livelink{chap:classflag}{flag}. 
1976 If present, this attribute indicates whether
1977 this subrange represents a \addtoindex{UPC} array bound which is scaled
1978 by the runtime \texttt{THREADS} value (the number of \addtoindex{UPC} threads in
1979 this execution of the program).
1980
1981 \textit{This allows the representation of a \addtoindex{UPC} shared array such as}
1982
1983 \begin{lstlisting}[numbers=none]
1984 int shared foo[34*THREADS][10][20];
1985 \end{lstlisting}
1986
1987 \needlines{4}
1988 The 
1989 \hypertarget{chap:DWATlowerboundlowerboundofsubrange}{}
1990 subrange 
1991 \hypertarget{chap:DWATupperboundupperboundofsubrange}{}
1992 entry may have the attributes 
1993 \DWATlowerboundDEFN{}
1994 \addtoindexx{lower bound attribute}
1995 and \DWATupperboundDEFN{}
1996 \addtoindexx{upper bound attribute} to specify, respectively, the lower
1997 and upper bound values of the subrange. The 
1998 \DWATupperboundNAME{} attribute 
1999 \hypertarget{chap:DWATcountelementsofsubrangetype}{}
2000 may be replaced by a
2001 \addtoindexx{count attribute!default}
2002 \addtoindexx{count attribute}
2003 \DWATcountDEFN{} attribute, 
2004 whose value describes the number of elements in the subrange 
2005 rather than the value of the last element. The value of each 
2006 of these attributes is determined as described in 
2007 Section \refersec{chap:staticanddynamicvaluesofattributes}.
2008
2009 If the lower bound value is missing, the value is assumed to
2010 be a language-dependent default constant as defined in
2011 Table \refersec{tab:languageencodings}.
2012 \addtoindexx{lower bound attribute!default}
2013
2014 If the upper bound and count are missing, then the upper bound value is 
2015 \textit{unknown}.\addtoindexx{upper bound attribute!default unknown}
2016
2017 If the subrange entry has no type attribute describing the
2018 basis type, the basis type is determined as follows:
2019 \begin{enumerate}[1. ]
2020 \item
2021 If there is a lower bound attribute that references an object,
2022 the basis type is assumed to be the same as the type of that object.
2023 \item
2024 Otherwise, if there is an upper bound or count attribute that references
2025 an object, the basis type is assumed to be the same as the type of that object.
2026 \item
2027 Otherwise, the type is
2028 assumed to be the same type, in the source language of the
2029 compilation unit containing the subrange entry, as a signed
2030 integer with the same size as an address on the target machine.
2031 \end{enumerate}
2032
2033 If the subrange type occurs as the description of a dimension
2034 of an array type, and the stride for that dimension is
2035 \hypertarget{chap:DWATbytestridesubrangestridedimensionofarraytype}{}
2036 different than what would otherwise be determined, then
2037 \hypertarget{chap:DWATbitstridesubrangestridedimensionofarraytype}{}
2038 the subrange type entry has either 
2039 \addtoindexx{byte stride attribute}
2040
2041 \DWATbytestrideDEFN{} or
2042 \DWATbitstrideDEFN{} attribute 
2043 \addtoindexx{bit stride attribute}
2044 which specifies the separation
2045 between successive elements along the dimension as described in 
2046 Section \refersec{chap:byteandbitsizes}.
2047
2048 \textit{Note that the stride can be negative.}
2049
2050 \needlines{4}
2051 \section{Pointer to Member Type Entries}
2052 \label{chap:pointertomembertypeentries}
2053
2054 \textit{In \addtoindex{C++}, a 
2055 pointer to a data or function member of a class or
2056 structure is a unique type.}
2057
2058 A debugging information entry representing the type of an
2059 object that is a pointer to a structure or class member has
2060 the tag \DWTAGptrtomembertypeTARG.
2061
2062 If the \addtoindex{pointer to member type} has a name, the 
2063 \addtoindexx{pointer to member type entry}
2064 pointer to member entry has a
2065 \DWATname{} attribute, 
2066 \addtoindexx{name attribute}
2067 whose value is a
2068 null\dash terminated string containing the type name as it appears
2069 in the source program.
2070
2071 The \addtoindex{pointer to member} entry 
2072 has 
2073 \addtoindexx{type attribute}
2074 a \DWATtype{} attribute to
2075 describe the type of the class or structure member to which
2076 objects of this type may point.
2077
2078 The \addtoindexx{pointer to member} entry also 
2079 \hypertarget{chap:DWATcontainingtypecontainingtypeofpointertomembertype}{}
2080 has a \DWATcontainingtypeDEFN{} attribute, 
2081 \addtoindexx{containing type (of pointer) attribute}
2082 whose value is a \livelink{chap:classreference}{reference} to a debugging
2083 information entry for the class or structure to whose members
2084 objects of this type may point.
2085
2086 The \addtoindex{pointer to member entry} 
2087 \hypertarget{chap:DWATuselocationmemberlocationforpointertomembertype}{}
2088 has a 
2089 \DWATuselocationDEFN{} attribute
2090 \addtoindexx{use location attribute}
2091 whose value is a 
2092 \addtoindex{location description} that computes the
2093 address of the member of the class to which the pointer to
2094 member entry points.
2095
2096 \textit{The method used to find the address of a given member of a
2097 class or structure is common to any instance of that class
2098 or structure and to any instance of the pointer or member
2099 type. The method is thus associated with the type entry,
2100 rather than with each instance of the type.}
2101
2102 The \DWATuselocation{} description is used in conjunction
2103 with the location descriptions for a particular object of the
2104 given \addtoindex{pointer to member type} and for a particular structure or
2105 class instance. The \DWATuselocation{} 
2106 attribute expects two values to be 
2107 \addtoindexi{pushed}{address!implicit push for member operator}
2108 onto the DWARF expression stack before
2109 the \DWATuselocation{} description is evaluated.
2110 The first value 
2111 \addtoindexi{pushed}{address!implicit push for member operator}
2112 is the value of the \addtoindex{pointer to member} object
2113 itself. The second value 
2114 \addtoindexi{pushed}{address!implicit push for member operator} 
2115 is the base address of the
2116 entire structure or union instance containing the member
2117 whose address is being calculated.
2118
2119 \needlines{6}
2120 \textit{For an expression such as}
2121
2122 \begin{lstlisting}[numbers=none]
2123     object.*mbr_ptr
2124 \end{lstlisting}
2125 \textit{where \texttt{mbr\_ptr} has some \addtoindex{pointer to member type}, a debugger should:}
2126 \begin{enumerate}[1. ]
2127 \item \textit{Push the value of \texttt{mbr\_ptr} onto the DWARF expression stack.}
2128 \item \textit{Push the base address of \texttt{object} onto the DWARF expression stack.}
2129 \item \textit{Evaluate the \DWATuselocation{} description 
2130 given in the type of \texttt{mbr\_ptr}.}
2131 \end{enumerate}
2132
2133
2134 \section{File Type Entries}
2135 \label{chap:filetypeentries}
2136
2137 \textit{Some languages, such as \addtoindex{Pascal}, 
2138 provide a data type to represent 
2139 files.}
2140
2141 A file type is represented by a debugging information entry
2142 with 
2143 \addtoindexx{file type entry}
2144 the tag
2145 \DWTAGfiletypeTARG. 
2146 If the file type has a name,
2147 the file type entry has a \DWATname{} attribute,
2148 \addtoindexx{name attribute}
2149 whose value
2150 is a null\dash terminated string containing the type name as it
2151 appears in the source program.
2152
2153 The file type entry has 
2154 \addtoindexx{type attribute}
2155 a \DWATtype{} attribute describing
2156 the type of the objects contained in the file.
2157
2158 The file type entry also has a 
2159 \DWATbytesize{}\addtoindexx{byte size attribute} or
2160 \DWATbitsize{}\addtoindexx{bit size attribute} attribute, whose value 
2161 (see Section \refersec{chap:staticanddynamicvaluesofattributes})
2162 is the amount of storage need to hold a value of the file type.
2163
2164 \section{Dynamic Type Entries}
2165 \label{chap:dynamictypeentries}
2166 \textit{Some languages such as 
2167 \addtoindex{Fortran 90}, provide types whose values
2168 may be dynamically allocated or associated with a variable
2169 under explicit program control. However, unlike the
2170 pointer type in \addtoindex{C} or 
2171 \addtoindex{C++}, the indirection involved in accessing
2172 the value of the variable is generally implicit, that is, not
2173 indicated as part of the program source.}
2174
2175 A dynamic type entry is used to declare a dynamic type that is 
2176 \doublequote{just like} another non-dynamic type without needing to
2177 replicate the full description of that other type.
2178
2179 A dynamic type is represented by a debugging information entry
2180 with the tag \DWTAGdynamictypeTARG. If a name has been given to the
2181 dynamic type, then the dynamic type has a \DWATname{} attribute 
2182 whose value is a null-terminated string containing the dynamic
2183 type name as it appears in the source.
2184         
2185 A dynamic type entry has a \DWATtype{} attribute whose value is a
2186 reference to the type of the entities that are dynamically allocated.
2187         
2188 A dynamic type entry also has a \DWATdatalocation, and may also
2189 have \DWATallocated{} and/or \DWATassociated{} attributes as 
2190 described in Section \refersec{chap:dynamicpropertiesoftypes}. 
2191 A \DWATdatalocation, \DWATallocated{} or \DWATassociated{} attribute 
2192 may not occur on a dynamic type entry if the same kind of attribute 
2193 already occurs on the type referenced by the \DWATtype{} attribute.
2194
2195
2196 \needlines{6}
2197 \section{Template Alias Entries}
2198 \label{chap:templatealiasentries}
2199
2200 \textit{In \addtoindex{C++}, a template alias is a form of typedef that has template
2201 parameters.  DWARF does not represent the template alias definition
2202 but does represent instantiations of the alias.}
2203
2204 A type named using a template alias is represented
2205 by a debugging information entry 
2206 \addtoindexx{template alias entry}
2207 with the tag
2208 \DWTAGtemplatealiasTARG. 
2209 The template alias entry has a
2210 \DWATname{} attribute 
2211 \addtoindexx{name attribute}
2212 whose value is a null\dash terminated string
2213 containing the name of the template alias as it appears in
2214 the source program.
2215 The template alias entry has child entries describing the template
2216 actual parameters (see Section \refersec{chap:templateparameters}).
2217
2218
2219 \section{Dynamic Properties of Types}
2220 \label{chap:dynamicpropertiesoftypes}
2221 \textit{The \DWATdatalocation, \DWATallocated{} and \DWATassociated{}
2222 attributes described in this section are motivated for use with
2223 \DWTAGdynamictype{} entries but can be used for any other type as well.}
2224
2225 \needlines{6}
2226 \subsection{Data Location}
2227 \label{chap:datalocation}
2228
2229 \textit{Some languages may represent objects using descriptors to hold
2230 information, including a location and/or run\dash time parameters,
2231 about the data that represents the value for that object.}
2232
2233 \hypertarget{chap:DWATdatalocationindirectiontoactualdata}{}
2234 The \DWATdatalocationDEFN{} attribute 
2235 \addtoindexx{data (indirect) location attribute}
2236 may be used with any type that provides one or more levels of 
2237 \addtoindexx{hidden indirection|see{data location attribute}}
2238 hidden indirection
2239 and/or run-time parameters in its representation. Its value
2240 is a \addtoindex{location description}. 
2241 The result of evaluating this
2242 description yields the location of the data for an object.
2243 When this attribute is omitted, the address of the data is
2244 the same as the address of the object.
2245
2246 \needlines{5}
2247 \textit{This location description will typically begin with
2248 \DWOPpushobjectaddress{} 
2249 which loads the address of the
2250 object which can then serve as a descriptor in subsequent
2251 calculation. For an example using 
2252 \DWATdatalocation{} 
2253 for a \addtoindex{Fortran 90 array}, see 
2254 Appendix \refersec{app:fortranarrayexample}.}
2255
2256 \subsection{Allocation and Association Status}
2257 \label{chap:allocationandassociationstatus}
2258
2259 \textit{Some languages, such as \addtoindex{Fortran 90},
2260 provide types whose values
2261 may be dynamically allocated or associated with a variable
2262 under explicit program control.}
2263
2264 \hypertarget{chap:DWATallocatedallocationstatusoftypes}{}
2265 The \DWATallocatedDEFN{} attribute\addtoindexx{allocated attribute}
2266 may be used with any
2267 type for which objects of the type can be explicitly allocated
2268 and deallocated. The presence of the attribute indicates that
2269 objects of the type are allocatable and deallocatable. The
2270 integer value of the attribute (see below) specifies whether
2271 an object of the type is 
2272 currently allocated or not.
2273
2274 \needlines{4}
2275 \hypertarget{chap:DWATassociatedassociationstatusoftypes}{}
2276 The 
2277 \DWATassociatedDEFN{} attribute 
2278 may 
2279 \addtoindexx{associated attribute}
2280 optionally be used with
2281 any type for which objects of the type can be dynamically
2282 associated with other objects. The presence of the attribute
2283 indicates that objects of the type can be associated. The
2284 integer value of the attribute (see below) indicates whether
2285 an object of the type is currently associated or not.
2286
2287 The value of these attributes is determined as described in
2288 Section \refersec{chap:staticanddynamicvaluesofattributes}.
2289
2290 A non\dash zero value is interpreted as allocated or associated,
2291 and zero is interpreted as not allocated or not associated.
2292
2293 \textit{For \addtoindex{Fortran 90}, 
2294 if the \DWATassociated{} 
2295 attribute is present,
2296 the type has the POINTER property where either the parent
2297 variable is never associated with a dynamic object or the
2298 implementation does not track whether the associated object
2299 is static or dynamic. If the \DWATallocated{} attribute is
2300 present and the \DWATassociated{} attribute is not, the type
2301 has the ALLOCATABLE property. If both attributes are present,
2302 then the type should be assumed to have the POINTER property
2303 (and not ALLOCATABLE); the \DWATallocated{} attribute may then
2304 be used to indicate that the association status of the object
2305 resulted from execution of an ALLOCATE statement rather than
2306 pointer assignment.}
2307
2308 \textit{For examples using 
2309 \DWATallocated{} for \addtoindex{Ada} and 
2310 \addtoindex{Fortran 90}
2311 arrays, 
2312 see Appendix \refersec{app:aggregateexamples}.}
2313
2314 \subsection{Array Rank}
2315 \label{chap:DWATrank}
2316 \addtoindexx{array!assumed-rank}
2317 \addtoindexx{assumed-rank array|see{array, assumed-rank}}
2318 \textit{The Fortran language supports \doublequote{assumed-rank arrays}. The
2319   rank (the number of dimensions) of an assumed-rank array is unknown
2320   at compile time. The Fortran runtime stores the rank in an array
2321   descriptor.}
2322
2323 The presence of the
2324 \hypertarget{chap:DWATrankofdynamicarray}{\DWATrankINDX}
2325 attribute indicates that an array's rank
2326 (number of dimensions) is dynamic, and therefore unknown at compile
2327 time. The value of the \DWATrankDEFN{} attribute is either an integer constant
2328 or a DWARF expression whose evaluation yields the dynamic rank.
2329
2330 The bounds of an array with dynamic rank are described using a
2331 \DWTAGgenericsubrange{} entry, which  
2332 is the dynamic rank array equivalent of
2333 \DWTAGsubrangetype. The
2334 difference is that a \DWTAGgenericsubrange{} entry contains generic
2335 lower/upper bound and stride expressions that need to be evaluated for
2336 each dimension. Before any expression contained in a
2337 \DWTAGgenericsubrange{} can be evaluated, the dimension for which the
2338 expression is to be evaluated needs to be pushed onto the stack. The
2339 expression will use it to find the offset of the respective field in
2340 the array descriptor metadata.
2341
2342 \textit{A producer is free to choose any layout for the
2343   array descriptor. In particular, the upper and lower bounds and
2344   stride values do not need to be bundled into a structure or record,
2345   but could be laid end to end in the containing descriptor, pointed
2346   to by the descriptor, or even allocated independently of the
2347   descriptor.}
2348
2349 Dimensions are enumerated $0$ to $\mathit{rank}-1$ in source program
2350 order.
2351
2352 \textit{For an example in Fortran 2008, see
2353   Section~\refersec{app:assumedrankexample}.}
2354