Complete work on live links, cleanup some indexing and redo pagination.

[dwarf-doc.git] / dwarf5 / latexdoc / typeentries.tex

\chapter{Type Entries}
\label{chap:typeentries}
This section presents the debugging information entries
that describe program types: base types, modified types and
user\dash defined types.

If the scope of the declaration of a named type begins after
\hypertarget{chap:DWATstartscopetypedeclaration}
the low pc value for the scope most closely enclosing the
declaration, the declaration may have a 
\livelink{chap:DWATstartscope}{DW\_AT\_start\_scope}
attribute as described for objects in 
Section \refersec{chap:dataobjectentries}.

\section{Base Type Entries}
\label{chap:basetypeentries}

\textit{A base type is a data type that is not defined in terms of
other data types. 
\addtoindexx{fundamental type|see{base type entry}}
Each programming language has a set of base
types that are considered to be built into that language.}

A base type is represented by a debugging information entry
with the tag 
\livetarg{chap:DWTAGbasetype}{DW\_TAG\_base\_type}.

A \addtoindex{base type entry}
has a \livelink{chap:DWATname}{DW\_AT\_name} attribute
whose
\addtoindexx{name attribute}
value is
a null\dash terminated string containing the name of the base type
as recognized by the programming language of the compilation
unit containing the base type entry.

A base type entry has 
\addtoindexx{encoding attribute}
a \livelink{chap:DWATencoding}{DW\_AT\_encoding} attribute describing
how the base type is encoded and is to be interpreted. The
value of this attribute is an 
\livelink{chap:classconstant}{integer constant}. The set of
values and their meanings for the
\livelink{chap:DWATencoding}{DW\_AT\_encoding} attribute
is given in 
Table \refersec{tab:encodingattributevalues}
and following text.  

A base type entry
may have a \livelink{chap:DWATendianity}{DW\_AT\_endianity} attribute
\addtoindexx{endianity attribute}
as described in 
Section \refersec{chap:dataobjectentries}. 
If omitted, the encoding assumes the representation that
is the default for the target architecture.

A base type entry has 
\hypertarget{chap:DWATbytesizedataobjectordatatypesize}
either a \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} attribute
\hypertarget{chap:DWATbitsizebasetypebitsize}
or a \livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} attribute 
\addtoindex{bit size attribute}
whose \livelink{chap:classconstant}{integer constant} value
(see Section \refersec{chap:byteandbitsizes}) 
is the amount of storage needed to hold
a value of the type.

\needlines{5}
\textit{For example, the 
\addtoindex{C} type int on a machine that uses 32\dash bit
integers is represented by a base type entry with a name
attribute whose value is \doublequote{int}, an encoding attribute
whose value is \livelink{chap:DWATEsigned}{DW\_ATE\_signed}
and a byte size attribute whose value is 4.}

If the value of an object of the given type does not fully
occupy the storage described by a byte size attribute,
\hypertarget{chap:DWATdatabitoffsetbasetypebitlocation}
the base type entry may also have 
\addtoindexx{bit size attribute}
a 
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} and a
\livelink{chap:DWATdatabitoffset}{DW\_AT\_data\_bit\_offset} attribute, 
both 
\addtoindexx{data bit offset attribute}
of whose values are
\livelink{chap:classconstant}{integer constant} values
(see Section \refersec{chap:staticanddynamicvaluesofattributes}). 
The bit size
attribute describes the actual size in bits used to represent
values of the given type. The data bit offset attribute is the
offset in bits from the beginning of the containing storage to
the beginning of the value. Bits that are part of the offset
are padding. The data bit offset uses the bit numbering and
direction conventions that are appropriate to the current
language on the
target system to locate the beginning of the storage and
value. If this attribute is omitted a default data bit offset
of zero is assumed.

\textit{Attribute 
\livelink{chap:DWATdatabitoffset}{DW\_AT\_data\_bit\_offset} 
is 
\addtoindexx{bit offset attribute}
new 
\addtoindexx{data bit offset attribute}
in 
\addtoindex{DWARF Version 4} and
is also used for bit field members 
(see Section \refersec{chap:datamemberentries}). 
It
\hypertarget{chap:DWATbitoffsetbasetypebitlocation}
replaces the attribute 
\livelink{chap:DWATbitoffset}{DW\_AT\_bit\_offset} 
when used for base
\addtoindexx{bit offset attribute (V3)}
types as defined in DWARF V3 and earlier. The earlier attribute
is defined in a manner suitable for bit field members on
big\dash endian architectures but which is wasteful for use on
little\dash endian architectures.}

\textit{The attribute \livelink{chap:DWATbitoffset}{DW\_AT\_bit\_offset} is 
deprecated in 
\addtoindex{DWARF Version 4}
for use in base types, but implementations may continue to
support its use for compatibility.}

\textit{The 
\addtoindex{DWARF Version 3}
definition of these attributes is as follows.}
\begin{myindentpara}{1cm}
\textit{A base type entry has a \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size}
attribute, whose value
(see Section \refersec{chap:staticanddynamicvaluesofattributes})
is the size in bytes of the storage unit
used to represent an object of the given type.}

\textit{If the value of an object of the given type does not fully
occupy the storage unit described by the byte size attribute,
the base type entry may have a 
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} attribute 
\addtoindexx{bit size attribute (V3)}
and a
\livelink{chap:DWATbitoffset}{DW\_AT\_bit\_offset} attribute, both of whose values 
(see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
are integers. The bit size attribute describes the actual
size in bits used to represent a value of the given type.
The bit offset attribute describes the offset in bits of the
high order bit of a value of the given type from the high
order bit of the storage unit used to contain that value.}
\end{myindentpara}

\needlines{5}
\textit{In comparing 
DWARF Versions 3 
\addtoindexx{DWARF Version 3}
and 
\addtoindexx{DWARF Version 4} and 4, note that DWARF V4
defines the following combinations of attributes:}

\begin{itemize}
\item \textit{\livelink{chap:DWATbytesize}{DW\_AT\_byte\_size}}
\item \textit{\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size}}
\item \textit{\livelink{chap:DWATbytesize}{DW\_AT\_byte\_size},
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} 
and optionally \livelink{chap:DWATdatabitoffset}{DW\_AT\_data\_bit\_offset}}
\end{itemize}
\textit{DWARF V3 defines the following combinations:}
\addtoindexx{DWARF Version 3}
% FIXME: the figure below interferes with the following
% bullet list, which looks horrible as a result.
\begin{itemize}
\item \textit{\livelink{chap:DWATbytesize}{DW\_AT\_byte\_size}}
\item \textit{\livelink{chap:DWATbytesize}{DW\_AT\_byte\_size}, 
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} and 
\livelink{chap:DWATbitoffset}{DW\_AT\_bit\_offset}}
\end{itemize}

\begin{table}[!here]
\caption{Encoding attribute values}
\label{tab:encodingattributevalues}
\centering
\begin{tabular}{l|p{8cm}}
\hline
Name&Meaning\\ \hline
\livetarg{chap:DWATEaddress}{DW\_ATE\_address} & linear machine address (for segmented\break
  addresses see
  Section \refersec{chap:segmentedaddresses}) \\
\livetarg{chap:DWATEboolean}{DW\_ATE\_boolean}& true or false \\

\livetarg{chap:DWATEcomplexfloat}{DW\_ATE\_complex\_float}& complex binary
floating\dash point number \\
\livetarg{chap:DWATEfloat}{DW\_ATE\_float} & binary floating\dash point number \\
\livetarg{chap:DWATEimaginaryfloat}{DW\_ATE\_imaginary\_float}& imaginary binary
floating\dash point number \\
\livetarg{chap:DWATEsigned}{DW\_ATE\_signed}& signed binary integer \\
\livetarg{chap:DWATEsignedchar}{DW\_ATE\_signed\_char}& signed character \\
\livetarg{chap:DWATEunsigned}{DW\_ATE\_unsigned} & unsigned binary integer \\
\livetarg{chap:DWATEunsignedchar}{DW\_ATE\_unsigned\_char} & unsigned character \\
\livetarg{chap:DWATEpackeddecimal}{DW\_ATE\_packed\_decimal}  & packed decimal \\
\livetarg{chap:DWATEnumericstring}{DW\_ATE\_numeric\_string}& numeric string \\
\livetarg{chap:DWATEedited}{DW\_ATE\_edited} & edited string \\
\livetarg{chap:DWATEsignedfixed}{DW\_ATE\_signed\_fixed} & signed fixed\dash point scaled integer \\
\livetarg{chap:DWATEunsignedfixed}{DW\_ATE\_unsigned\_fixed}& unsigned fixed\dash point scaled integer \\
\livetarg{chap:DWATEdecimalfloat}{DW\_ATE\_decimal\_float} & decimal floating\dash point number \\ 
\livetarg{chap:DWATEUTF}{DW\_ATE\_UTF} & \addtoindex{Unicode} character \\
\hline
\end{tabular}
\end{table}

\textit{The \livelink{chap:DWATEdecimalfloat}{DW\_ATE\_decimal\_float} encoding is intended for
floating\dash point representations that have a power\dash of\dash ten
exponent, such as that specified in IEEE 754R.}

\textit{The \livelink{chap:DWATEUTF}{DW\_ATE\_UTF} encoding is intended for \addtoindex{Unicode}
string encodings (see the Universal Character Set standard,
ISO/IEC 10646\dash 1:1993). For example, the 
\addtoindex{C++} type char16\_t is
represented by a base type entry with a name attribute whose
value is \doublequote{char16\_t}, an encoding attribute whose value
is \livelink{chap:DWATEUTF}{DW\_ATE\_UTF} and a byte size attribute whose value is 2.}

The 
\livelink{chap:DWATEpackeddecimal}{DW\_ATE\_packed\_decimal} 
and 
\livelink{chap:DWATEnumericstring}{DW\_ATE\_numeric\_string} 
base types
represent packed and unpacked decimal string numeric data
types, respectively, either of which may be 
either 
\addtoindexx{decimal scale attribute}
signed
\addtoindexx{decimal sign attribute}
or 
\addtoindexx{digit count attribute}
unsigned. 
\hypertarget{chap:DWATdecimalsigndecimalsignrepresentation}
These 
\hypertarget{chap:DWATdigitcountdigitcountforpackeddecimalornumericstringtype}
base types are used in combination with
\livelink{chap:DWATdecimalsign}{DW\_AT\_decimal\_sign}, 
\livelink{chap:DWATdigitcount}{DW\_AT\_digit\_count} and 
\livelink{chap:DWATdecimalscale}{DW\_AT\_decimal\_scale}
attributes.

A \livelink{chap:DWATdecimalsign}{DW\_AT\_decimal\_sign} attribute 
\addtoindexx{decimal sign attribute}
is an \livelink{chap:classconstant}{integer constant} that
conveys the representation of the sign of the decimal type
(see Figure \refersec{tab:decimalsignattributevalues}). 
Its \livelink{chap:classconstant}{integer constant} value is interpreted to
mean that the type has a leading overpunch, trailing overpunch,
leading separate or trailing separate sign representation or,
alternatively, no sign at all.

\begin{table}[here]
\caption{Decimal sign attribute values}
\label{tab:decimalsignattributevalues}
\centering
\begin{tabular}{l|p{9cm}}
\hline
 Name & Meaning \\
\hline
\livetarg{chap:DWDSunsigned}{DW\_DS\_unsigned} &  Unsigned \\
\livetarg{chap:DWDSleadingoverpunch}{DW\_DS\_leading\_overpunch} & Sign
is encoded in the most significant digit in a target\dash dependent  manner \\
\livetarg{chap:DWDStrailingoverpunch}{DW\_DS\_trailing\_overpunch} & Sign
is encoded in the least significant digit in a target\dash dependent manner \\
\livetarg{chap:DWDSleadingseparate}{DW\_DS\_leading\_separate} 
& Decimal type: Sign is a ``+'' or ``-'' character 
to the left of the most significant digit. \\
\livetarg{chap:DWDStrailingseparate}{DW\_DS\_trailing\_separate} 
& Decimal type: Sign is a ``+'' or ``-'' character 
to the right of the least significant digit. \\
&Packed decimal type: Least significant nibble contains
a target\dash dependent value
indicating positive or negative. \\
\hline
\end{tabular}
\end{table}

The 
\livelink{chap:DWATdigitcount}{DW\_AT\_digit\_count}
attribute 
\addtoindexx{digit count attribute}
is an \livelink{chap:classconstant}{integer constant}
value that represents the number of digits in an instance of
the type.

\hypertarget{chap:DWATdecimalscaledecimalscalefactor}
The \livelink{chap:DWATdecimalscale}{DW\_AT\_decimal\_scale}
attribute 
\addtoindexx{decimal scale attribute}
is an integer constant value
that represents the exponent of the base ten scale factor to
be applied to an instance of the type. A scale of zero puts the
decimal point immediately to the right of the least significant
digit. Positive scale moves the decimal point to the right
and implies that additional zero digits on the right are not
stored in an instance of the type. Negative scale moves the
decimal point to the left; if the absolute value of the scale
is larger than the digit count, this implies additional zero
digits on the left are not stored in an instance of the type.

The \livelink{chap:DWATEedited}{DW\_ATE\_edited}
base 
\hypertarget{chap:DWATpicturestringpicturestringfornumericstringtype}
type is used to represent an edited
numeric or alphanumeric data type. It is used in combination
with an \livelink{chap:DWATpicturestring}{DW\_AT\_picture\_string} attribute whose value is a 
null\dash terminated string containing the target\dash dependent picture
string associated with the type.

If the edited base type entry describes an edited numeric
data type, the edited type entry has a \livelink{chap:DWATdigitcount}{DW\_AT\_digit\_count} and a
\livelink{chap:DWATdecimalscale}{DW\_AT\_decimal\_scale} attribute. 
\addtoindexx{decimal scale attribute}
These attributes have the same
interpretation as described for the 
\livelink{chap:DWATEpackeddecimal}{DW\_ATE\_packed\_decimal} and
\livelink{chap:DWATEnumericstring}{DW\_ATE\_numeric\_string} base 
types. If the edited type entry
describes an edited alphanumeric data type, the edited type
entry does not have these attributes.


\textit{The presence or absence of the \livelink{chap:DWATdigitcount}{DW\_AT\_digit\_count} and
\livelink{chap:DWATdecimalscale}{DW\_AT\_decimal\_scale} attributes 
\addtoindexx{decimal scale attribute}
allows a debugger to easily
distinguish edited numeric from edited alphanumeric, although
in principle the digit count and scale are derivable by
interpreting the picture string.}

The \livelink{chap:DWATEsignedfixed}{DW\_ATE\_signed\_fixed} and \livelink{chap:DWATEunsignedfixed}{DW\_ATE\_unsigned\_fixed} entries
describe signed and unsigned fixed\dash point binary data types,
respectively.

The fixed binary type entries have 
\addtoindexx{digit count attribute}
a 
\livelink{chap:DWATdigitcount}{DW\_AT\_digit\_count}
attribute with the same interpretation as described for the
\livelink{chap:DWATEpackeddecimal}{DW\_ATE\_packed\_decimal} and \livelink{chap:DWATEnumericstring}{DW\_ATE\_numeric\_string} base types.

For a data type with a decimal scale factor, the fixed binary
type entry has a 
\livelink{chap:DWATdecimalscale}{DW\_AT\_decimal\_scale} attribute 
\addtoindexx{decimal scale attribute}
with the same
interpretation as described for the 
\livelink{chap:DWATEpackeddecimal}{DW\_ATE\_packed\_decimal}
and \livelink{chap:DWATEnumericstring}{DW\_ATE\_numeric\_string} base types.

\hypertarget{chap:DWATbinaryscalebinaryscalefactorforfixedpointtype}
For a data type with a binary scale factor, the fixed
\addtoindexx{binary scale attribute}
binary type entry has a 
\livelink{chap:DWATbinaryscale}{DW\_AT\_binary\_scale} attribute. 
The
\livelink{chap:DWATbinaryscale}{DW\_AT\_binary\_scale} attribute 
is an \livelink{chap:classconstant}{integer constant} value
that represents the exponent of the base two scale factor to
be applied to an instance of the type.  Zero scale puts the
binary point immediately to the right of the least significant
bit. Positive scale moves the binary point to the right and
implies that additional zero bits on the right are not stored
in an instance of the type. Negative scale moves the binary
point to the left; if the absolute value of the scale is
larger than the number of bits, this implies additional zero
bits on the left are not stored in an instance of the type.

For 
\hypertarget{chap:DWATsmallscalefactorforfixedpointtype}
a data type with a non\dash decimal and non\dash binary scale factor,
the fixed binary type entry has a 
\livelink{chap:DWATsmall}{DW\_AT\_small} attribute which
\addtoindexx{small attribute}
references a 
\livelink{chap:DWTAGconstant}{DW\_TAG\_constant} entry. The scale factor value
is interpreted in accordance with the value defined by the
\livelink{chap:DWTAGconstant}{DW\_TAG\_constant} entry. The value represented is the product
of the integer value in memory and the associated constant
entry for the type.

\textit{The \livelink{chap:DWATsmall}{DW\_AT\_small} attribute 
is defined with the \addtoindex{Ada} small
attribute in mind.}

\section{Unspecified Type Entries}
\label{chap:unspecifiedtypeentries}
\addtoindexx{unspecified type entry}
\addtoindexx{void type|see{unspecified type entry}}
Some languages have constructs in which a type 
may be left unspecified or the absence of a type
may be explicitly indicated.

An unspecified (implicit, unknown, ambiguous or nonexistent)
type is represented by a debugging information entry with
the tag \livetarg{chap:DWTAGunspecifiedtype}{DW\_TAG\_unspecified\_type}. 
If a name has been given
to the type, then the corresponding unspecified type entry
has a \livelink{chap:DWATname}{DW\_AT\_name} attribute 
\addtoindexx{name attribute}
whose value is
a null\dash terminated
string containing the name as it appears in the source program.

The interpretation of this debugging information entry is
intentionally left flexible to allow it to be interpreted
appropriately in different languages. For example, in 
\addtoindex{C} and \addtoindex{C++}
the language implementation can provide an unspecified type
entry with the name \doublequote{void} which can be referenced by the
type attribute of pointer types and typedef declarations for
'void' (see 
% FIXME: the following reference was wrong in DW4 so DavidA guessed
% the intent.
Sections \refersec{chap:unspecifiedtypeentries} and 
%The following reference was valid, so the following is probably correct.
Section \refersec{chap:typedefentries}, 
respectively). As another
example, in \addtoindex{Ada} such an unspecified type entry can be referred
to by the type attribute of an access type where the denoted
\addtoindexx{incomplete type (Ada)}
type is incomplete (the name is declared as a type but the
definition is deferred to a separate compilation unit).

\section{Type Modifier Entries}
\label{chap:typemodifierentries}
\addtoindexx{type modifier entry}

A base or user\dash defined type may be modified in different ways
in different languages. A type modifier is represented in
DWARF by a debugging information entry with one of the tags
given in Table \refersec{tab:typemodifiertags}.
\addtoindexx{type modifier|see{constant type entry}}
\addtoindexx{type modifier|see{reference type entry}}
\addtoindexx{type modifier|see{restricted type entry}}
\addtoindexx{type modifier|see{packed type entry}}
\addtoindexx{type modifier|see{pointer type entry}}
\addtoindexx{type modifier|see{shared type entry}}
\addtoindexx{type modifier|see{volatile type entry}}

If a name has been given to the modified type in the source
program, then the corresponding modified type entry has
a \livelink{chap:DWATname}{DW\_AT\_name} attribute 
\addtoindexx{name attribute}
whose value is a null\dash terminated
string containing the modified type name as it appears in
the source program.

Each of the type modifier entries has 
\addtoindexx{type attribute}
a 
\livelink{chap:DWATtype}{DW\_AT\_type} attribute,
whose value is a \livelink{chap:classreference}{reference} 
to a debugging information entry
describing a base type, a user-defined type or another type
modifier.

A modified type entry describing a 
\addtoindexx{pointer type entry}
pointer or \addtoindex{reference type}
(using \livelink{chap:DWTAGpointertype}{DW\_TAG\_pointer\_type},
\livelink{chap:DWTAGreferencetype}{DW\_TAG\_reference\_type} or
\livelink{chap:DWTAGrvaluereferencetype}{DW\_TAG\_rvalue\_reference\_type}) 
% Another instance of no-good-place-to-put-index entry.
may
\addtoindexx{address class!attribute} 
have 
\hypertarget{chap:DWATadressclasspointerorreferencetypes}
a 
\livelink{chap:DWATaddressclass}{DW\_AT\_address\_class}
attribute to describe how objects having the given pointer
or reference type ought to be dereferenced.

A modified type entry describing a shared qualified type
(using \livelink{chap:DWTAGsharedtype}{DW\_TAG\_shared\_type}) may have a
\livelink{chap:DWATcount}{DW\_AT\_count} attribute
\addtoindexx{count attribute}
whose value is a constant expressing the (explicit or implied) blocksize specified for the
type in the source. If no count attribute is present, then the \doublequote{infinite}
blocksize is assumed.

When multiple type modifiers are chained together to modify
a base or user-defined type, the tree ordering reflects the
semantics of the 
\addtoindexx{reference type entry, lvalue|see{reference type entry}}
applicable language 
\addtoindexx{reference type entry, rvalue|see{rvalue reference type entry}}
rather 
\addtoindexx{parameter|see{macro formal parameter list}}
than 
\addtoindexx{parameter|see{\textit{this} parameter}}
the 
\addtoindexx{parameter|see{variable parameter attribute}}
textual
\addtoindexx{parameter|see{optional parameter attribute}}
order 
\addtoindexx{parameter|see{unspecified parameters entry}}
in 
\addtoindexx{parameter|see{template value parameter entry}}
the 
\addtoindexx{parameter|see{template type parameter entry}}
source 
\addtoindexx{parameter|see{formal parameter entry}}
presentation.

\begin{table}[here]
\caption{Type modifier tags}
\label{tab:typemodifiertags}
\centering
\begin{tabular}{l|p{9cm}}
\hline
Name&Meaning\\ \hline
\livetarg{chap:DWTAGconsttype}{DW\_TAG\_const\_type} &  C or C++ const qualified type
\addtoindexx{const qualified type entry} \addtoindexx{C} \addtoindexx{C++} \\
\livetarg{chap:DWTAGpackedtype}{DW\_TAG\_packed\_type}& \addtoindex{Pascal} or Ada packed type\addtoindexx{packed type entry}
\addtoindexx{packed qualified type entry} \addtoindexx{Ada} \addtoindexx{Pascal} \\
\livetarg{chap:DWTAGpointertype}{DW\_TAG\_pointer\_type} & Pointer to an object of
the type being modified \addtoindexx{pointer qualified type entry} \\
\livetarg{chap:DWTAGreferencetype}{DW\_TAG\_reference\_type}& C++ (lvalue) reference 
to an object of the type 
\addtoindexx{reference type entry}
being modified
\addtoindexx{reference qualified type entry} \\
\livetarg{chap:DWTAGrestricttype}{DW\_TAG\_restrict\_type}& \addtoindex{C} 
restrict 
\addtoindexx{restricted type entry}
qualified type
\addtoindexx{restrict qualified type} \\
\livetarg{chap:DWTAGrvaluereferencetype}{DW\_TAG\_rvalue\_reference\_type} & C++
\addtoindexx{rvalue reference type entry}
rvalue 
\addtoindexx{restricted type entry}
reference to an object of the type being modified 
\addtoindexx{rvalue reference qualified type entry} \\
\livetarg{chap:DWTAGsharedtype}{DW\_TAG\_shared\_type}&\addtoindex{UPC} shared qualified type 
\addtoindexx{shared qualified type entry} \\
\livetarg{chap:DWTAGvolatiletype}{DW\_TAG\_volatile\_type}&C or C++ volatile qualified type 
\addtoindex{volatile qualified type entry} \\
\hline
\end{tabular}
\end{table}

%The following clearpage prevents splitting the example across pages.
\textit{As examples of how type modifiers are ordered, consider the following
\addtoindex{C} declarations:}
\begin{lstlisting}[numbers=none]
   const unsigned char * volatile p;
\end{lstlisting}
\textit{which represents a volatile pointer to a constant
character. This is encoded in DWARF as:}

\begin{dwflisting}
\begin{alltt}
        \livelink{chap:DWTAGvariable}{DW\_TAG\_variable}(p) -->
            \livelink{chap:DWTAGvolatiletype}{DW\_TAG\_volatile\_type} -->
                \livelink{chap:DWTAGpointertype}{DW\_TAG\_pointer\_type} -->
                    \livelink{chap:DWTAGconsttype}{DW\_TAG\_const\_type} -->
                        \livelink{chap:DWTAGbasetype}{DW\_TAG\_base\_type}(unsigned char)
\end{alltt}
\end{dwflisting}

\needlines{3}
\textit{On the other hand}
\begin{lstlisting}[numbers=none]                        
   volatile unsigned char * const restrict p;
\end{lstlisting}
\textit{represents a restricted constant
pointer to a volatile character. This is encoded as:}

\begin{dwflisting}
\begin{alltt}
        \livelink{chap:DWTAGvariable}{DW\_TAG\_variable}(p) -->
            \livelink{chap:DWTAGrestricttype}{DW\_TAG\_restrict\_type} -->
                \livelink{chap:DWTAGconsttype}{DW\_TAG\_const\_type} -->
                    \livelink{chap:DWTAGpointertype}{DW\_TAG\_pointer\_type} -->
                        \livelink{chap:DWTAGvolatiletype}{DW\_TAG\_volatile\_type} -->
                            \livelink{chap:DWTAGbasetype}{DW\_TAG\_base\_type}(unsigned char)
\end{alltt}
\end{dwflisting}

\section{Typedef Entries}
\label{chap:typedefentries}
A named type that is defined in terms of another type
definition is represented by a debugging information entry with
\addtoindexx{typedef entry}
the tag \livetarg{chap:DWTAGtypedef}{DW\_TAG\_typedef}. 
The typedef entry has a \livelink{chap:DWATname}{DW\_AT\_name} attribute 
\addtoindexx{name attribute}
whose value is a null\dash terminated string containing
the name of the typedef as it appears in the source program.

The typedef entry may also contain 
\addtoindexx{type attribute}
a 
\livelink{chap:DWATtype}{DW\_AT\_type} attribute whose
value is a \livelink{chap:classreference}{reference} 
to the type named by the typedef. If
the debugging information entry for a typedef represents
a declaration of the type that is not also a definition,
it does not contain a type attribute.

\textit{Depending on the language, a named type that is defined in
terms of another type may be called a type alias, a subtype,
a constrained type and other terms. A type name declared with
no defining details may be termed an 
\addtoindexx{incomplete type}
incomplete, forward or hidden type. 
While the DWARF \livelink{chap:DWTAGtypedef}{DW\_TAG\_typedef} entry was
originally inspired by the like named construct in 
\addtoindex{C} and \addtoindex{C++},
it is broadly suitable for similar constructs (by whatever
source syntax) in other languages.}

\section{Array Type Entries}
\label{chap:arraytypeentries}

\textit{Many languages share the concept of an ``array,'' which is
\addtoindexx{array type entry}
a table of components of identical type.}

An array type is represented by a debugging information entry
with the tag \livetarg{chap:DWTAGarraytype}{DW\_TAG\_array\_type}. 
If a name has been given to
\addtoindexx{array!declaration of type}
the array type in the source program, then the corresponding
array type entry has a \livelink{chap:DWATname}{DW\_AT\_name} attribute 
\addtoindexx{name attribute}
whose value is a
null\dash terminated string containing the array type name as it
appears in the source program.

The 
\hypertarget{chap:DWATorderingarrayrowcolumnordering}
array type entry describing a multidimensional array may
\addtoindexx{array!element ordering}
have a \livelink{chap:DWATordering}{DW\_AT\_ordering} attribute whose 
\livelink{chap:classconstant}{integer constant} value is
interpreted to mean either row-major or column-major ordering
of array elements. The set of values and their meanings
for the ordering attribute are listed in 
Table \refersec{tab:arrayordering}. 
If no
ordering attribute is present, the default ordering for the
source language (which is indicated by the 
\livelink{chap:DWATlanguage}{DW\_AT\_language}
attribute 
\addtoindexx{language attribute}
of the enclosing compilation unit entry) is assumed.

\begin{simplenametable}[1.6in]{Array ordering}{tab:arrayordering}
\livetarg{chap:DWORDcolmajor}{DW\_ORD\_col\_major} \\
\livetarg{chap:DWORDrowmajor}{DW\_ORD\_row\_major} \\
\end{simplenametable}

The ordering attribute may optionally appear on one-dimensional
arrays; it will be ignored.

An array type entry has 
\addtoindexx{type attribute}
a \livelink{chap:DWATtype}{DW\_AT\_type} attribute
describing
\addtoindexx{array!element type}
the type of each element of the array.

If the amount of storage allocated to hold each element of an
object of the given array type is different from the amount
\addtoindexx{stride attribute|see{bit stride attribute or byte stride attribute}}
of storage that is normally allocated to hold an individual
\hypertarget{chap:DWATbitstridearrayelementstrideofarraytype}
object of the 
\hypertarget{chap:DWATbytestridearrayelementstrideofarraytype}
indicated element type, then the array type
\addtoindexx{bit stride attribute}
entry has either a 
\livelink{chap:DWATbytestride}{DW\_AT\_byte\_stride} 
or 
\addtoindexx{byte stride attribute}
a \livelink{chap:DWATbitstride}{DW\_AT\_bit\_stride}
attribute, 
\addtoindexx{bit stride attribute}
whose value 
(see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
is the size of each
element of the array.

The array type entry may have either a \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} or a
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} attribute 
(see Section \refersec{chap:byteandbitsizes}), 
whose value is the
amount of storage needed to hold an instance of the array type.

\textit{If the size of the array can be determined statically at
compile time, this value can usually be computed by multiplying
the number of array elements by the size of each element.}


Each array dimension is described by a debugging information
entry with either the 
\addtoindexx{subrange type entry!as array dimension}
tag \livelink{chap:DWTAGsubrangetype}{DW\_TAG\_subrange\_type} or the 
\addtoindexx{enumeration type entry!as array dimension}
tag
\livelink{chap:DWTAGenumerationtype}{DW\_TAG\_enumeration\_type}. These entries are
children of the
array type entry and are ordered to reflect the appearance of
the dimensions in the source program (i.e., leftmost dimension
first, next to leftmost second, and so on).

\textit{In languages, such as C, in which there is no concept of
a \doublequote{multidimensional array}, an array of arrays may
be represented by a debugging information entry for a
multidimensional array.}

\needlines{5}
Other attributes especially applicable to arrays are
\livelink{chap:DWATallocated}{DW\_AT\_allocated}, 
\livelink{chap:DWATassociated}{DW\_AT\_associated} and 
\livelink{chap:DWATdatalocation}{DW\_AT\_data\_location},
which are described in 
Section \refersec{chap:dynamictypeproperties}. 
For relevant examples, see also Appendix \refersec{app:fortran90example}.

\section{ Structure, Union, Class and Interface Type Entries}
\label{chap:structureunionclassandinterfacetypeentries}

\textit{The languages 
\addtoindex{C}, 
\addtoindex{C++}, and 
\addtoindex{Pascal}, among others, allow the
programmer to define types that are collections of related
\addtoindexx{structure type entry}
components. 
In \addtoindex{C} and \addtoindex{C++}, these collections are called
\doublequote{structures.} 
In \addtoindex{Pascal}, they are called \doublequote{records.}
The components may be of different types. The components are
called \doublequote{members} in \addtoindex{C} and 
\addtoindex{C++}, and \doublequote{fields} in \addtoindex{Pascal}.}

\textit{The components of these collections each exist in their
own space in computer memory. The components of a C or C++
\doublequote{union} all coexist in the same memory.}

\textit{\addtoindex{Pascal} and 
other languages have a \doublequote{discriminated union,}
\addtoindex{discriminated union|see {variant entry}}
also called a \doublequote{variant record.} Here, selection of a
number of alternative substructures (\doublequote{variants}) is based
on the value of a component that is not part of any of those
substructures (the \doublequote{discriminant}).}

\textit{\addtoindex{C++} and 
\addtoindex{Java} have the notion of ``class'', which is in some
ways similar to a structure. A class may have \doublequote{member
functions} which are subroutines that are within the scope
of a class or structure.}

\textit{The \addtoindex{C++} notion of 
structure is more general than in \addtoindex{C}, being
equivalent to a class with minor differences. Accordingly,
in the following discussion statements about 
\addtoindex{C++} classes may
be understood to apply to \addtoindex{C++} structures as well.}

\subsection{Structure, Union and Class Type Entries}
\label{chap:structureunionandclasstypeentries}


Structure, union, and class types are represented by debugging
\addtoindexx{structure type entry}
information entries 
\addtoindexx{union type entry}
with 
\addtoindexx{class type entry}
the tags 
\livetarg{chap:DWTAGstructuretype}{DW\_TAG\_structure\_type},
\livetarg{chap:DWTAGuniontype}{DW\_TAG\_union\_type}, 
and \livetarg{chap:DWTAGclasstype}{DW\_TAG\_class\_type},
respectively. If a name has been given to the structure,
union, or class in the source program, then the corresponding
structure type, union type, or class type entry has a
\livelink{chap:DWATname}{DW\_AT\_name} attribute 
\addtoindexx{name attribute}
whose value is a null\dash terminated string
containing the type name as it appears in the source program.

The members of a structure, union, or class are represented
by debugging information entries that are owned by the
corresponding structure type, union type, or class type entry
and appear in the same order as the corresponding declarations
in the source program.

A structure type, union type or class type entry may have
either a \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} or a
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} attribute 
\hypertarget{chap:DWATbitsizedatamemberbitsize}
(see Section \refersec{chap:byteandbitsizes}), 
whose value is the amount of storage needed
to hold an instance of the structure, union or class type,
including any padding.
  
An incomplete structure, union or class type 
\addtoindexx{incomplete structure/union/class}
is 
\addtoindexx{incomplete type}
represented by a structure, union or class
entry that does not have a byte size attribute and that has
\addtoindexx{declaration attribute}
a \livelink{chap:DWATdeclaration}{DW\_AT\_declaration} attribute.

If the complete declaration of a type has been placed in
\hypertarget{chap:DWATsignaturetypesignature}
a separate \addtoindex{type unit}
(see Section \refersec{chap:separatetypeunitentries}), 
an incomplete declaration 
\addtoindexx{incomplete type}
of that type in the compilation unit may provide
the unique 64\dash bit signature of the type using 
\addtoindexx{type signature}
a \livelink{chap:DWATsignature}{DW\_AT\_signature}
attribute.

If a structure, union or class entry represents the definition
of a structure, class or union member corresponding to a prior
incomplete structure, class or union, the entry may have a
\livelink{chap:DWATspecification}{DW\_AT\_specification} attribute 
\addtoindexx{specification attribute}
whose value is a \livelink{chap:classreference}{reference} to
the debugging information entry representing that incomplete
declaration.

Structure, union and class entries containing the
\livelink{chap:DWATspecification}{DW\_AT\_specification} attribute 
\addtoindexx{specification attribute}
do not need to duplicate
information provided by the declaration entry referenced by the
specification attribute.  In particular, such entries do not
need to contain an attribute for the name of the structure,
class or union they represent if such information is already
provided in the declaration.

\textit{For \addtoindex{C} and \addtoindex{C++}, 
data 
\addtoindexx{data member|see {member entry (data)}}
member declarations occurring within
the declaration of a structure, union or class type are
considered to be \doublequote{definitions} of those members, with
the exception of \doublequote{static} data members, whose definitions
appear outside of the declaration of the enclosing structure,
union or class type. Function member declarations appearing
within a structure, union or class type declaration are
definitions only if the body of the function also appears
within the type declaration.}

If the definition for a given member of the structure, union
or class does not appear within the body of the declaration,
that member also has a debugging information entry describing
its definition. That latter entry has a 
\livelink{chap:DWATspecification}{DW\_AT\_specification} attribute 
\addtoindexx{specification attribute}
referencing the debugging information entry
owned by the body of the structure, union or class entry and
representing a non\dash defining declaration of the data, function
or type member. The referenced entry will not have information
about the location of that member (low and high pc attributes
for function members, location descriptions for data members)
and will have a \livelink{chap:DWATdeclaration}{DW\_AT\_declaration} attribute.

\needlines{5}
\textit{Consider a nested class whose 
definition occurs outside of the containing class definition, as in:}

\begin{lstlisting}[numbers=none]
struct A {
    struct B;
};
struct A::B { ... };
\end{lstlisting}

\textit{The two different structs can be described in 
different compilation units to 
facilitate DWARF space compression 
(see Appendix \refersec{app:usingcompilationunits}).}

\subsection{Interface Type Entries}
\label{chap:interfacetypeentries}

\textit{The \addtoindex{Java} language defines ``interface'' types. 
An interface
\addtoindex{interface type entry}
in \addtoindex{Java} is similar to a \addtoindex{C++} or 
\addtoindex{Java} class with only abstract
methods and constant data members.}

Interface types 
\addtoindexx{interface type entry}
are represented by debugging information
entries with the 
tag \livetarg{chap:DWTAGinterfacetype}{DW\_TAG\_interface\_type}.

An interface type entry has 
a \livelink{chap:DWATname}{DW\_AT\_name} attribute,
\addtoindexx{name attribute}
whose
value is a null\dash terminated string containing the type name
as it appears in the source program.

The members of an interface are represented by debugging
information entries that are owned by the interface type
entry and that appear in the same order as the corresponding
declarations in the source program.

\subsection{Derived or Extended Structs, Classes and Interfaces}
\label{chap:derivedorextendedstructsclasesandinterfaces}

\textit{In \addtoindex{C++}, a class (or struct) 
may 
\addtoindexx{derived type (C++)|see{inheritance entry}}
be ``derived from'' or be a
``subclass of'' another class. 
In \addtoindex{Java}, an interface may ``extend''
\addtoindexx{extended type (Java)|see{inheritance entry}}
one 
\addtoindexx{implementing type (Java)|see{inheritance entry}}
or more other interfaces, and a class may ``extend'' another
class and/or ``implement'' one or more interfaces. All of these
relationships may be described using the following. Note that
in \addtoindex{Java}, 
the distinction between extends and implements is
implied by the entities at the two ends of the relationship.}

A class type or interface type entry that describes a
derived, extended or implementing class or interface owns
\addtoindexx{implementing type (Java)|see{inheritance entry}}
debugging information entries describing each of the classes
or interfaces it is derived from, extending or implementing,
respectively, ordered as they were in the source program. Each
such entry has 
\addtoindexx{inheritance entry}
the 
tag \livetarg{chap:DWTAGinheritance}{DW\_TAG\_inheritance}.

An inheritance entry 
\addtoindexx{type attribute}
has 
\addtoindexx{inheritance entry}
a 
\livelink{chap:DWATtype}{DW\_AT\_type} attribute whose value is
a reference to the debugging information entry describing the
class or interface from which the parent class or structure
of the inheritance entry is derived, extended or implementing.

An inheritance entry 
\addtoindexx{inheritance entry}
for a class that derives from or extends
\hypertarget{chap:DWATdatamemberlocationinheritedmemberlocation}
another class or struct also has 
\addtoindexx{data member location attribute}
a 
\livelink{chap:DWATdatamemberlocation}{DW\_AT\_data\_member\_location}
attribute, whose value describes the location of the beginning
of the inherited type relative to the beginning address of the
derived class. If that value is a constant, it is the offset
in bytes from the beginning of the class to the beginning of
the inherited type. Otherwise, the value must be a location
description. In this latter case, the beginning address of
the derived class is pushed on the expression stack before
the \addtoindex{location description}
is evaluated and the result of the
evaluation is the location of the inherited type.

\textit{The interpretation of the value of this attribute for
inherited types is the same as the interpretation for data
members 
(see Section \referfol{chap:datamemberentries}).  }

An 
\addtoindexx{inheritance entry}
inheritance entry 
\hypertarget{chap:DWATaccessibilitycppinheritedmembers}
may 
\addtoindexx{accessibility attribute}
have a
\livelink{chap:DWATaccessibility}{DW\_AT\_accessibility}
attribute. 
If no accessibility attribute
is present, private access is assumed for an entry of a class
and public access is assumed for an entry of an interface,
struct or union.

If 
\hypertarget{chap:DWATvirtualityvirtualityofbaseclass}
the class referenced by the 
\addtoindexx{inheritance entry}
inheritance entry serves
as a \addtoindex{C++} virtual base class, the inheritance entry has a
\livelink{chap:DWATvirtuality}{DW\_AT\_virtuality} attribute.

\textit{For a \addtoindex{C++} virtual base, the 
\addtoindex{data member location attribute}
will usually consist of a non-trivial 
\addtoindex{location description}.}

\subsection{Access Declarations}
\label{chap:accessdeclarations}

\textit{In \addtoindex{C++}, a derived class may contain access declarations that
\addtoindexx{access declaration entry}
change the accessibility of individual class members from the
overall accessibility specified by the inheritance declaration.
A single access declaration may refer to a set of overloaded
names.}

If a derived class or structure contains access declarations,
each such declaration may be represented by a debugging
information entry with the tag 
\livetarg{chap:DWTAGaccessdeclaration}{DW\_TAG\_access\_declaration}. 
Each
such entry is a child of the class or structure type entry.

An access declaration entry has 
a \livelink{chap:DWATname}{DW\_AT\_name} attribute, 
\addtoindexx{name attribute}
whose
value is a null\dash terminated string representing the name used
in the declaration in the source program, including any class
or structure qualifiers.

An access declaration entry 
\hypertarget{chap:DWATaccessibilitycppbaseclasses}
also 
has a 
\livelink{chap:DWATaccessibility}{DW\_AT\_accessibility}
attribute describing the declared accessibility of the named
entities.


\needlines{6}
\subsection{Friends}
\label{chap:friends}

Each ``friend'' 
\addtoindexx{friend entry}
declared by a structure, union or class
\hypertarget{chap:DWATfriendfriendrelationship}
type may be represented by a debugging information entry
that is a child of the structure, union or class type entry;
the friend entry has the 
tag \livetarg{chap:DWTAGfriend}{DW\_TAG\_friend}.

A friend entry has 
\addtoindexx{friend attribute}
a \livelink{chap:DWATfriend}{DW\_AT\_friend} attribute, whose value is
a reference to the debugging information entry describing
the declaration of the friend.


\subsection{Data Member Entries}
\label{chap:datamemberentries}

A data member (as opposed to a member function) is
represented by a debugging information entry with the 
tag \livetarg{chap:DWTAGmember}{DW\_TAG\_member}. 
The 
\addtoindexx{member entry (data)}
member entry for a named member has
a \livelink{chap:DWATname}{DW\_AT\_name} attribute 
\addtoindexx{name attribute}
whose value is a null\dash terminated
string containing the member name as it appears in the source
program. If the member entry describes an 
\addtoindex{anonymous union},
the name attribute is omitted or the value of the attribute
consists of a single zero byte.

The data member entry has 
\addtoindexx{type attribute}
a 
\livelink{chap:DWATtype}{DW\_AT\_type} attribute to denote
\addtoindexx{member entry (data)}
the type of that member.

A data member entry may 
\addtoindexx{accessibility attribute}
have a 
\livelink{chap:DWATaccessibility}{DW\_AT\_accessibility}
attribute. If no accessibility attribute is present, private
access is assumed for an entry of a class and public access
is assumed for an entry of a structure, union, or interface.

A data member 
\hypertarget{chap:DWATmutablemutablepropertyofmemberdata}
entry 
\addtoindexx{member entry (data)}
may 
\addtoindexx{mutable attribute}
have a \livelink{chap:DWATmutable}{DW\_AT\_mutable} attribute,
which is a \livelink{chap:classflag}{flag}. 
This attribute indicates whether the data
member was declared with the mutable storage class specifier.

The beginning of a data member 
\addtoindexx{beginning of a data member} 
is described relative to
\addtoindexx{beginning of an object}
the beginning of the object in which it is immediately
contained. In general, the beginning is characterized by
both an address and a bit offset within the byte at that
address. When the storage for an entity includes all of
the bits in the beginning byte, the beginning bit offset is
defined to be zero.

Bit offsets in DWARF use the bit numbering and direction
conventions that are appropriate to the current language on
the target system.

The member entry 
\addtoindexx{member entry (data)}
corresponding to a data member that is
\hypertarget{chap:DWATdatabitoffsetdatamemberbitlocation}
defined 
\hypertarget{chap:DWATdatamemberlocationdatamemberlocation}
in a structure, union or class may have either
\addtoindexx{data member location attribute}
a
\livelink{chap:DWATdatamemberlocation}{DW\_AT\_data\_member\_location} attribute or a
\livelink{chap:DWATdatabitoffset}{DW\_AT\_data\_bit\_offset}
attribute. If the beginning of the data member is the same as
the beginning of the containing entity then neither attribute
is required.

\needlines{4}
For a \livelink{chap:DWATdatamemberlocation}{DW\_AT\_data\_member\_location} attribute
\addtoindexx{data member location attribute}
there are two cases:
\begin{enumerate}[1. ]
\item If the value is an \livelink{chap:classconstant}{integer constant}, 
it is the offset
in bytes from the beginning of the containing entity. If
the beginning of the containing entity has a non-zero bit
offset then the beginning of the member entry has that same
bit offset as well.

\item Otherwise, the value must be a \addtoindex{location description}.
In
this case, the beginning of the containing entity must be byte
aligned. The beginning address is pushed on the DWARF stack
before the \addtoindex{location} description is evaluated; the result of
the evaluation is the base address of the member entry.

\textit{The push on the DWARF expression stack of the base address of
the containing construct is equivalent to execution of the
\livelink{chap:DWOPpushobjectaddress}{DW\_OP\_push\_object\_address} operation 
(see Section \refersec{chap:stackoperations});
\livelink{chap:DWOPpushobjectaddress}{DW\_OP\_push\_object\_address} therefore 
is not needed at the
beginning of a \addtoindex{location description} for a data member. 
The
result of the evaluation is a location--either an address or
the name of a register, not an offset to the member.}

\textit{A \livelink{chap:DWATdatamemberlocation}{DW\_AT\_data\_member\_location} 
attribute 
\addtoindexx{data member location attribute}
that has the form of a
\addtoindex{location description} is not valid for a data member contained
in an entity that is not byte aligned because DWARF operations
do not allow for manipulating or computing bit offsets.}

\end{enumerate}

For a \livelink{chap:DWATdatabitoffset}{DW\_AT\_data\_bit\_offset} attribute, 
the value is an \livelink{chap:classconstant}{integer constant} 
(see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
that specifies the number of bits
from the beginning of the containing entity to the beginning
of the data member. This value must be greater than or equal
to zero, but is not limited to less than the number of bits
per byte.

If the size of a data member is not the same as the size
of the type given for the data member, the data member has
\addtoindexx{bit size attribute}
either a \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} 
or a \livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} attribute whose
\livelink{chap:classconstant}{integer constant} value 
(see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
is the amount
of storage needed to hold the value of the data member.

\textit{Bit fields in \addtoindex{C} and \addtoindex{C++} 
typically 
\addtoindexx{bit fields} 
require the use 
\addtoindexx{data bit offset}
of 
\addtoindexx{data bit size}
the
\livelink{chap:DWATdatabitoffset}{DW\_AT\_data\_bit\_offset} and 
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} attributes.}

\needlines{6}
\textit{This Standard uses the following bit numbering and direction
conventions in examples. These conventions are for illustrative
purposes and other conventions may apply on particular
architectures.}
\begin{itemize}
\item \textit{For big\dash endian architectures, bit offsets are
counted from high-order to low\dash order bits within a byte (or
larger storage unit); in this case, the bit offset identifies
the high\dash order bit of the object.}

\item \textit{For little\dash endian architectures, bit offsets are
counted from low\dash order to high\dash order bits within a byte (or
larger storage unit); in this case, the bit offset identifies
the low\dash order bit of the object.}
\end{itemize}


\textit{In either case, the bit so identified is defined as the 
\addtoindexx{beginning of an object}
beginning of the object.}

\textit{For example, take one possible representation of the following 
\addtoindex{C} structure definition 
in both big\dash and little\dash endian byte orders:}

\begin{lstlisting}
struct S {
    int j:5;
    int k:6;
    int m:5;
    int n:8;
};
\end{lstlisting}

\textit{Figures \referfol{fig:bigendiandatabitoffsets} and
\refersec{fig:littleendiandatabitoffsets}
show the structure layout
and data bit offsets for example big\dash\   and little\dash endian
architectures, respectively. Both diagrams show a structure
that begins at address A and whose size is four bytes. Also,
high order bits are to the left and low order bits are to
the right.}

\begin{figure}[h]
\begin{verbatim}
    j:0
    k:5
    m:11
    n:16

    Addresses increase ->
    |       A       |     A + 1     |    A + 2      |    A + 3      | 

    Data bit offsets increase ->
    +---------------+---------------+---------------+---------------+
    |0     4|5         10|11      15|16           23|24           31|
    |   j   |     k      | m        |        n      |       <pad>   |
    |       |            |          |               |               | 
    +---------------------------------------------------------------+ 
\end{verbatim}
\caption{Big-endian data bit offsets}
\label{fig:bigendiandatabitoffsets}
\end{figure}

\begin{figure}[h]
\begin{verbatim}
    j:0
    k:5
    m:11
    n:16
                                               <- Addresses increase
    |       A       |     A + 1     |    A + 2      |    A + 3      | 

                                        <-  Data bit offsets increase 
    +---------------+---------------+---------------+---------------+
    |31           24|23           16|15     11|10       5|4        0|
    |     <pad>     |        n      |    m    |    k     |     j    |
    |               |               |         |          |          |
    +---------------------------------------------------------------+
\end{verbatim}
\caption{Little-endian data bit offsets}
\label{fig:littleendiandatabitoffsets}
\end{figure}

\textit{Note that data member bit offsets in this example are the
same for both big\dash\ and little\dash endian architectures even
though the fields are allocated in different directions
(high\dash order to low-order versus low\dash order to high\dash order);
the bit naming conventions for memory and/or registers of
the target architecture may or may not make this seem natural.}

\textit{For a more extensive example showing nested and packed records
and arrays, see 
Appendix \refersec{app:pascalexample}.}

\textit{Attribute \livelink{chap:DWATdatabitoffset}{DW\_AT\_data\_bit\_offset} 
is new in 
\addtoindex{DWARF Version 4}
and is also used for base types 
(see Section 
\refersec{chap:basetypeentries}). 
It replaces the
\livetarg{chap:DWATbitoffsetdatamemberbitlocation}{}
attributes \livelink{chap:DWATbitoffset}{DW\_AT\_bit\_offset} and
\livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} when used to
identify the beginning of bit field data members as defined
in DWARF V3 and earlier. The earlier attributes are defined
in a manner suitable for bit field members on big-endian
architectures but which is either awkward or incomplete for
use on little-endian architectures.  
(\livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} also
has other uses that are not affected by this change.)}

\textit{The \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size}, 
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} and 
\livelink{chap:DWATbitoffset}{DW\_AT\_bit\_offset}
attribute combination is deprecated for data members in DWARF
Version 4, but implementations may continue to support this
use for compatibility.}

\textit{The 
\addtoindex{DWARF Version 3} 
definitions of these attributes are
as follows.}
\begin{myindentpara}{1cm}
\textit{If the data member entry describes a bit field, then that
entry has the following attributes:}

\begin{itemize}
\item \textit{A \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} 
attribute whose value 
(see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
is the number of bytes that contain an instance of the
bit field and any padding bits.}

\textit{The byte size attribute may be omitted if the size of the
object containing the bit field can be inferred from the type
attribute of the data member containing the bit field.}

\item \textit{A \livelink{chap:DWATbitoffset}{DW\_AT\_bit\_offset} 
attribute 
\addtoindexx{bit offset attribute (V3)}
whose value 
(see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
is the number of bits to the left of the leftmost
(most significant) bit of the bit field value.}

\item \textit{A \livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} 
attribute 
\addtoindexx{bit size attribute (V3)}
whose value 
(see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
is the number of bits occupied by the bit field value.}

\end{itemize}

\textit{The 
\addtoindex{location description} for a bit field calculates the address
of an anonymous object containing the bit field. The address
is relative to the structure, union, or class that most closely
encloses the bit field declaration. The number of bytes in this
anonymous object is the value of the byte size attribute of
the bit field. The offset (in bits) from the most significant
bit of the anonymous object to the most significant bit of
the bit field is the value of the bit offset attribute.}
\end{myindentpara}


\textit{Diagrams similar to the above that show the use of the
\livelink{chap:DWATbytesize}{DW\_AT\_byte\_size}, 
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} and 
\livelink{chap:DWATbitoffset}{DW\_AT\_bit\_offset} attribute
combination may be found in the 
\addtoindex{DWARF Version 3} Standard.}

\textit{In comparing 
DWARF Versions 3 
\addtoindexx{DWARF Version 3}
and 
\addtoindexx{DWARF Version 4}
4, note that DWARF V4
defines the following combinations of attributes:}

\begin{itemize}
\item \textit{either \livelink{chap:DWATdatamemberlocation}{DW\_AT\_data\_member\_location} 
or
\livelink{chap:DWATdatabitoffset}{DW\_AT\_data\_bit\_offset} 
(to specify the beginning of the data member)}

% FIXME: the indentation of the following line is suspect.
\textit{optionally together with}

\item  \textit{either \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} or 
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} (to
specify the size of the data member)}

\end{itemize}

\textit{DWARF V3 defines the following combinations}

\begin{itemize}
\item \textit{\livelink{chap:DWATdatamemberlocation}{DW\_AT\_data\_member\_location} 
(to specify the beginning
of the data member, except this specification is only partial
in the case of a bit field) }

% FIXME: the indentation of the following line is suspect.
\textit{optionally together with}

\item \textit{\livelink{chap:DWATbytesize}{DW\_AT\_byte\_size}, 
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} and 
\livelink{chap:DWATbitoffset}{DW\_AT\_bit\_offset}
(to further specify the beginning of a bit field data member
as well as specify the size of the data member) }
\end{itemize}

\subsection{Member Function Entries}
\label{chap:memberfunctionentries}

A member function is represented by a 
\addtoindexx{member function entry}
debugging information entry 
with the 
\addtoindexx{subprogram entry!as member function}
tag \livelink{chap:DWTAGsubprogram}{DW\_TAG\_subprogram}.
The member function entry
may contain the same attributes and follows the same rules
as non\dash member global subroutine entries 
(see Section \refersec{chap:subroutineandentrypointentries}).

A 
\addtoindexx{accessibility attribute}
member function entry may have a 
\livelink{chap:DWATaccessibility}{DW\_AT\_accessibility}
attribute. If no accessibility attribute is present, private
access is assumed for an entry of a class and public access
is assumed for an entry of a structure, union or interface.

If 
\hypertarget{chap:DWATvirtualityvirtualityoffunction}
the member function entry describes a virtual function,
then that entry has a 
\livelink{chap:DWATvirtuality}{DW\_AT\_virtuality} attribute.

If 
\hypertarget{chap:DWATexplicitexplicitpropertyofmemberfunction}
the member function entry describes an explicit member
function, then that entry has 
\addtoindexx{explicit attribute}
a 
\livelink{chap:DWATexplicit}{DW\_AT\_explicit} attribute.

An 
\hypertarget{chap:DWATvtableelemlocationvirtualfunctiontablevtableslot}
entry for a virtual function also has a
\livelink{chap:DWATvtableelemlocation}{DW\_AT\_vtable\_elem\_location}
\addtoindexi{attribute}{vtable element location attribute} whose value contains
a \addtoindex{location description} 
yielding the address of the slot
for the function within the virtual function table for the
enclosing class. The address of an object of the enclosing
type is pushed onto the expression stack before the location
description is evaluated.

If 
\hypertarget{chap:DWATobjectpointerobjectthisselfpointerofmemberfunction}
the member function entry describes a non\dash static member
\addtoindexx{this pointer attribute|see{object pointer attribute}}
function, then that entry 
\addtoindexx{self pointer attribute|see{object pointer attribute}}
has 
\addtoindexx{object pointer attribute}
a \livelink{chap:DWATobjectpointer}{DW\_AT\_object\_pointer} 
attribute
whose value is a \livelink{chap:classreference}{reference} 
to the formal parameter entry
that corresponds to the object for which the function is
called. The name attribute of that formal parameter is defined
by the current language (for example, 
this for \addtoindex{C++} or self
for \addtoindex{Objective C} 
and some other languages). That parameter
also has a \livelink{chap:DWATartificial}{DW\_AT\_artificial} attribute whose value is true.

Conversely, if the member function entry describes a static
member function, the entry does not have 
\addtoindexx{object pointer attribute}
a 
\livelink{chap:DWATobjectpointer}{DW\_AT\_object\_pointer}
attribute.

If the member function entry describes a non\dash static member
function that has a const\dash volatile qualification, then
the entry describes a non\dash static member function whose
object formal parameter has a type that has an equivalent
const\dash volatile qualification.

If a subroutine entry represents the defining declaration
of a member function and that definition appears outside of
the body of the enclosing class declaration, the subroutine
entry has a 
\livelink{chap:DWATspecification}{DW\_AT\_specification} attribute, 
\addtoindexx{specification attribute}
whose value is
a reference to the debugging information entry representing
the declaration of this function member. The referenced entry
will be a child of some class (or structure) type entry.

Subroutine entries containing the
\livelink{chap:DWATspecification}{DW\_AT\_specification} attribute 
\addtoindexx{specification attribute}
do not need to duplicate information provided
by the declaration entry referenced by the specification
attribute. In particular, such entries do not need to contain
attributes for the name or return type of the function member
whose definition they represent.

\subsection{Class Template Instantiations}
\label{chap:classtemplateinstantiations}

\textit{In \addtoindex{C++} a class template is a generic definition of a class
type that may be instantiated when an instance of the class
is declared or defined. The generic description of the
class may include both parameterized types and parameterized
constant values. DWARF does not represent the generic template
definition, but does represent each instantiation.}

A class template instantiation is represented by a
debugging information entry with the tag \livelink{chap:DWTAGclasstype}{DW\_TAG\_class\_type},
\livelink{chap:DWTAGstructuretype}{DW\_TAG\_structure\_type} or 
\livelink{chap:DWTAGuniontype}{DW\_TAG\_union\_type}. With five
exceptions, such an entry will contain the same attributes
and have the same types of child entries as would an entry
for a class type defined explicitly using the instantiation
types and values. The exceptions are:

\begin{enumerate}[1. ]
\item Each formal parameterized type declaration appearing in the
template definition is represented by a debugging information
entry with the tag 
\livelink{chap:DWTAGtemplatetypeparameter}{DW\_TAG\_template\_type\_parameter}. Each
such entry may have a \livelink{chap:DWATname}{DW\_AT\_name} attribute,
\addtoindexx{name attribute}
whose value is
a null\dash terminated string containing the name of the formal
type parameter as it appears in the source program. The
template type parameter entry also has 
\addtoindexx{type attribute}
a 
\livelink{chap:DWATtype}{DW\_AT\_type} attribute
describing the actual type by which the formal is replaced
for this instantiation.

\item Each formal parameterized value declaration appearing in the
template definition is represented by a 
debugging information entry with the 
\addtoindexx{template value parameter entry}
tag \livetarg{chap:DWTAGtemplatevalueparameter}{DW\_TAG\_template\_value\_parameter}. 
Each
such entry may have a 
\livelink{chap:DWATname}{DW\_AT\_name} attribute,
\addtoindexx{name attribute}
whose value is
a null\dash terminated string containing the name of the formal
value parameter as it appears in the source program. 
The
\hypertarget{chap:DWATconstvaluetemplatevalueparameter}
template value parameter entry 
\addtoindexx{template value parameter entry}
also has 
\addtoindexx{type attribute}
a 
\livelink{chap:DWATtype}{DW\_AT\_type} attribute
describing the type of the parameterized value. Finally,
the template value parameter entry has a 
\livelink{chap:DWATconstvalue}{DW\_AT\_const\_value}
attribute, whose value is the actual constant value of the
value parameter for this instantiation as represented on the
target architecture.

\needlines{5}
\item The class type entry and each of its child entries references
a \addtoindex{template type parameter entry} in any circumstance where the
source template definition references a formal parameterized
type. 
Similarly, the class type entry and each of its child
entries references a template value parameter entry in any
circumstance where the source template definition references
a formal parameterized value.

\item If the compiler has generated a special compilation unit to
hold the 
\addtoindexx{template instantiation!and special compilation unit}
template instantiation and that special compilation
unit has a different name from the compilation unit containing
the template definition, the name attribute for the debugging
information entry representing the special compilation unit
should be empty or omitted.

\needlines{5}
\item If the class type entry representing the template
instantiation or any of its child entries contains declaration
coordinate attributes, those attributes should refer to
the source for the template definition, not to any source
generated artificially by the compiler.
\end{enumerate}


\subsection{Variant Entries}
\label{chap:variantentries}

A variant part of a structure is represented by a debugging
information entry\addtoindexx{variant part entry} with the 
tag \livetarg{chap:DWTAGvariantpart}{DW\_TAG\_variant\_part} and is
owned by the corresponding structure type entry.

If the variant part has a discriminant, the discriminant is
\hypertarget{chap:DWATdiscrdiscriminantofvariantpart}
represented by a 
\addtoindexx{discriminant (entry)}
separate debugging information entry which
is a child of the variant part entry. This entry has the form
of a 
\addtoindexx{member entry (data)!as discriminant}
structure data member entry. The variant part entry will
\addtoindexx{discriminant attribute}
have a 
\livelink{chap:DWATdiscr}{DW\_AT\_discr} attribute 
whose value is a \livelink{chap:classreference}{reference} to
the member entry for the discriminant.

If the variant part does not have a discriminant (tag field),
the variant part entry has 
\addtoindexx{type attribute}
a 
\livelink{chap:DWATtype}{DW\_AT\_type} attribute to represent
the tag type.

Each variant of a particular variant part is represented by
\hypertarget{chap:DWATdiscrvaluediscriminantvalue}
a debugging information entry\addtoindexx{variant entry} with the 
tag \livetarg{chap:DWTAGvariant}{DW\_TAG\_variant}
and is a child of the variant part entry. The value that
selects a given variant may be represented in one of three
ways. The variant entry may have a 
\livelink{chap:DWATdiscrvalue}{DW\_AT\_discr\_value} attribute
whose value represents a single case label. The value of this
attribute is encoded as an LEB128 number. The number is signed
if the tag type for the variant part containing this variant
is a signed type. The number is unsigned if the tag type is
an unsigned type.

\needlines{5}
Alternatively, 
\hypertarget{chap:DWATdiscrlistlistofdiscriminantvalues}
the variant entry may contain 
\addtoindexx{discriminant list attribute}
a 
\livelink{chap:DWATdiscrlist}{DW\_AT\_discr\_list}
attribute, whose value represents a list of discriminant
values. This list is represented by any of the 
\livelink{chap:classblock}{block} forms and
may contain a mixture of case labels and label ranges. Each
item on the list is prefixed with a discriminant value
descriptor that determines whether the list item represents
a single label or a label range. A single case label is
represented as an LEB128 number as defined above for 
\addtoindexx{discriminant value attribute}
the
\livelink{chap:DWATdiscrvalue}{DW\_AT\_discr\_value} 
attribute. A label range is represented by
two LEB128 numbers, the low value of the range followed by the
high value. Both values follow the rules for signedness just
described. The discriminant value descriptor is an integer
constant that may have one of the values given in 
Table \refersec{tab:discriminantdescriptorvalues}.

\begin{simplenametable}[1.4in]{Discriminant descriptor values}{tab:discriminantdescriptorvalues}
\livetarg{chap:DWDSClabel}{DW\_DSC\_label} \\
\livetarg{chap:DWDSCrange}{DW\_DSC\_range} \\
\end{simplenametable}

If a variant entry has neither a \livelink{chap:DWATdiscrvalue}{DW\_AT\_discr\_value}
attribute nor a \livelink{chap:DWATdiscrlist}{DW\_AT\_discr\_list} attribute, or if it has
a \livelink{chap:DWATdiscrlist}{DW\_AT\_discr\_list} attribute with 0 size, the variant is a
default variant.

The components selected by a particular variant are represented
by debugging information entries owned by the corresponding
variant entry and appear in the same order as the corresponding
declarations in the source program.

\section{Condition Entries}
\label{chap:conditionentries}

\textit{COBOL has the notion of 
\addtoindexx{level-88 condition, COBOL}
a ``level\dash 88 condition'' that
associates a data item, called the conditional variable, with
a set of one or more constant values and/or value ranges.
Semantically, the condition is \textquoteleft true\textquoteright if the conditional
variable's value matches any of the described constants,
and the condition is \textquoteleft false\textquoteright otherwise.}

The \livetarg{chap:DWTAGcondition}{DW\_TAG\_condition}
debugging information entry\addtoindexx{condition entry}
describes a
logical condition that tests whether a given data item\textquoteright s
value matches one of a set of constant values. If a name
has been given to the condition, the condition entry has a
\livelink{chap:DWATname}{DW\_AT\_name} attribute
\addtoindexx{name attribute}
whose value is a null\dash terminated string
giving the condition name as it appears in the source program.

The condition entry's parent entry describes the conditional
variable; normally this will be a \livelink{chap:DWTAGvariable}{DW\_TAG\_variable},
\livelink{chap:DWTAGmember}{DW\_TAG\_member} or 
\livelink{chap:DWTAGformalparameter}{DW\_TAG\_formal\_parameter} entry.
If 
\addtoindexx{formal parameter entry}
the parent
entry has an array type, the condition can test any individual
element, but not the array as a whole. The condition entry
implicitly specifies a \doublequote{comparison type} that is the
type of an array element if the parent has an array type;
otherwise it is the type of the parent entry.

The condition entry owns \livelink{chap:DWTAGconstant}{DW\_TAG\_constant} and/or
\livelink{chap:DWTAGsubrangetype}{DW\_TAG\_subrange\_type} entries that describe the constant
values associated with the condition. If any child entry 
\addtoindexx{type attribute}
has
a \livelink{chap:DWATtype}{DW\_AT\_type} attribute,
that attribute should describe a type
compatible with the comparison type (according to the source
language); otherwise the child\textquoteright s type is the same as the
comparison type.

\textit{For conditional variables with alphanumeric types, COBOL
permits a source program to provide ranges of alphanumeric
constants in the condition. Normally a subrange type entry
does not describe ranges of strings; however, this can be
represented using bounds attributes that are references to
constant entries describing strings. A subrange type entry may
refer to constant entries that are siblings of the subrange
type entry.}


\section{Enumeration Type Entries}
\label{chap:enumerationtypeentries}

\textit{An \doublequote{enumeration type} is a scalar that can assume one of
a fixed number of symbolic values.}

An enumeration type is represented by a debugging information
entry with the tag 
\livetarg{chap:DWTAGenumerationtype}{DW\_TAG\_enumeration\_type}.

If a name has been given to the enumeration type in the source
program, then the corresponding enumeration type entry has
a \livelink{chap:DWATname}{DW\_AT\_name} attribute
\addtoindexx{name attribute}
whose value is a null\dash terminated
string containing the enumeration type name as it appears
in the source program. This entry also has a 
\livelink{chap:DWATbytesize}{DW\_AT\_byte\_size}
attribute whose \livelink{chap:classconstant}{integer constant} 
value is the number of bytes
required to hold an instance of the enumeration.

The \addtoindex{enumeration type entry}
may have 
\addtoindexx{type attribute}
a \livelink{chap:DWATtype}{DW\_AT\_type} attribute
which refers to the underlying data type used to implement
the enumeration.

If an enumeration type has type safe 
\addtoindexx{type safe enumeration types}
semantics such that

\begin{enumerate}[1. ]
\item Enumerators are contained in the scope of the enumeration type, and/or

\item Enumerators are not implicitly converted to another type
\end{enumerate}

then the \addtoindex{enumeration type entry} may 
\addtoindexx{enum class|see{type-safe enumeration}}
have a \livelink{chap:DWATenumclass}{DW\_AT\_enum\_class}
attribute, which is a \livelink{chap:classflag}{flag}. 
In a language that offers only
one kind of enumeration declaration, this attribute is not
required.

\textit{In \addtoindex{C} or \addtoindex{C++}, 
the underlying type will be the appropriate
integral type determined by the compiler from the properties of
\hypertarget{chap:DWATenumclasstypesafeenumerationdefinition}
the enumeration literal values. 
A \addtoindex{C++} type declaration written
using enum class declares a strongly typed enumeration and
is represented using \livelink{chap:DWTAGenumerationtype}{DW\_TAG\_enumeration\_type} 
in combination with \livelink{chap:DWATenumclass}{DW\_AT\_enum\_class}.}

Each enumeration literal is represented by a debugging
\addtoindexx{enumeration literal|see{enumeration entry}}
information entry with the 
tag \livetarg{chap:DWTAGenumerator}{DW\_TAG\_enumerator}. 
Each
such entry is a child of the 
\addtoindex{enumeration type entry}, and the
enumerator entries appear in the same order as the declarations
of the enumeration literals in the source program.

Each \addtoindex{enumerator entry} has a 
\livelink{chap:DWATname}{DW\_AT\_name} attribute, whose
\addtoindexx{name attribute}
value is a null\dash terminated string containing the name of the
\hypertarget{chap:DWATconstvalueenumerationliteralvalue}
enumeration literal as it appears in the source program. 
Each enumerator entry also has a 
\livelink{chap:DWATconstvalue}{DW\_AT\_const\_value} attribute,
whose value is the actual numeric value of the enumerator as
represented on the target system.


If the enumeration type occurs as the description of a
\addtoindexx{enumeration type endry!as array dimension}
dimension of an array type, and the stride for that dimension
\hypertarget{chap:DWATbytestrideenumerationstridedimensionofarraytype}
is different than what would otherwise be determined, then
\hypertarget{chap:DWATbitstrideenumerationstridedimensionofarraytype}
the enumeration type entry has either a 
\livelink{chap:DWATbytestride}{DW\_AT\_byte\_stride}
or \livelink{chap:DWATbitstride}{DW\_AT\_bit\_stride} attribute 
\addtoindexx{bit stride attribute}
which specifies the separation
between successive elements along the dimension as described
in 
Section \refersec{chap:visibilityofdeclarations}. 
The value of the 
\livelink{chap:DWATbitstride}{DW\_AT\_bit\_stride} attribute
\addtoindexx{bit stride attribute}
is interpreted as bits and the value of 
\addtoindexx{byte stride attribute}
the 
\livelink{chap:DWATbytestride}{DW\_AT\_byte\_stride}
attribute is interpreted as bytes.


\section{Subroutine Type Entries}
\label{chap:subroutinetypeentries}

\textit{It is possible in \addtoindex{C}
to declare pointers to subroutines
that return a value of a specific type. In both 
\addtoindex{C} and \addtoindex{C++},
it is possible to declare pointers to subroutines that not
only return a value of a specific type, but accept only
arguments of specific types. The type of such pointers would
be described with a ``pointer to'' modifier applied to a
user\dash defined type.}

A subroutine type is represented by a debugging information
entry with the 
\addtoindexx{subroutine type entry}
tag \livetarg{chap:DWTAGsubroutinetype}{DW\_TAG\_subroutine\_type}. 
If a name has
been given to the subroutine type in the source program,
then the corresponding subroutine type entry has 
a \livelink{chap:DWATname}{DW\_AT\_name} attribute 
\addtoindexx{name attribute}
whose value is a null\dash terminated string containing
the subroutine type name as it appears in the source program.

If the subroutine type describes a function that returns
a value, then the subroutine type entry has 
\addtoindexx{type attribute}
a \livelink{chap:DWATtype}{DW\_AT\_type}
attribute to denote the type returned by the subroutine. If
the types of the arguments are necessary to describe the
subroutine type, then the corresponding subroutine type
entry owns debugging information entries that describe the
arguments. These debugging information entries appear in the
order that the corresponding argument types appear in the
source program.

\textit{In \addtoindex{C} there 
is a difference between the types of functions
declared using function prototype style declarations and
those declared using non\dash prototype declarations.}

A 
\hypertarget{chap:DWATprototypedsubroutineprototype}
subroutine entry declared with a function prototype style
declaration may have 
\addtoindexx{prototyped attribute}
a 
\livelink{chap:DWATprototyped}{DW\_AT\_prototyped} attribute, which is
a \livelink{chap:classflag}{flag}.

Each debugging information entry owned by a subroutine
type entry correspond to either a formal parameter or the sequence of
unspecified parameters of the subprogram type:

\begin{enumerate}[1. ]
\item A formal parameter of a parameter list (that has a
specific type) is represented by a debugging information entry
with the tag \livelink{chap:DWTAGformalparameter}{DW\_TAG\_formal\_parameter}. 
Each formal parameter
entry has 
\addtoindexx{type attribute}
a \livelink{chap:DWATtype}{DW\_AT\_type} attribute that refers to the type of
the formal parameter.

\item The unspecified parameters of a variable parameter list
\addtoindexx{unspecified parameters entry}
are 
\addtoindexx{\texttt{...} parameters|see{unspecified parameters entry}}
represented by a debugging information entry with the
tag \livelink{chap:DWTAGunspecifiedparameters}{DW\_TAG\_unspecified\_parameters}.
\end{enumerate}



\section{String Type Entries}
\label{chap:classstringtypeentries}

\textit{A ``string'' is a sequence of characters that have specific
\addtoindexx{string type entry}
semantics and operations that separate them from arrays of
characters. 
\addtoindex{Fortran} is one of the languages that has a string
type. Note that ``string'' in this context refers to a target
machine concept, not the class string as used in this document
(except for the name attribute).}

A string type is represented by a debugging information entry
with the tag \livetarg{chap:DWTAGstringtype}{DW\_TAG\_string\_type}. 
If a name has been given to
the string type in the source program, then the corresponding
string type entry has a \livelink{chap:DWATname}{DW\_AT\_name} attribute
\addtoindexx{name attribute}
whose value is
a null\dash terminated string containing the string type name as
it appears in the source program.

The 
\hypertarget{chap:DWATstringlengthstringlengthofstringtype}
string type entry may have a 
\livelink{chap:DWATstringlength}{DW\_AT\_string\_length} attribute
whose 
\addtoindexx{string length attribute}
value is a 
\addtoindex{location description} yielding the location
where the length of the string is stored in the program. The
string type entry may also have a \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} attribute
or \livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} attribute, whose value 
(see Section \refersec{chap:byteandbitsizes}) 
is the size of the data to be retrieved from the location
referenced by the string length attribute. If no (byte or bit)
size attribute is present, the size of the data to be retrieved
is the same as the 
\addtoindex{size of an address} on the target machine.

\needlines{5}
If no string length attribute is present, the string type
entry may have a \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} attribute or 
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size}
attribute, whose value 
(see Section \refersec{chap:byteandbitsizes}) 
is the amount of
storage needed to hold a value of the string type.


\section{Set Type Entries}
\label{chap:settypeentries}

\textit{\addtoindex{Pascal} provides the concept of a \doublequote{set,} which represents
a group of values of ordinal type.}

A set is represented by a debugging information entry with
the tag \livetarg{chap:DWTAGsettype}{DW\_TAG\_set\_type}. 
\addtoindexx{set type entry}
If a name has been given to the
set type, then the set type entry has 
a \livelink{chap:DWATname}{DW\_AT\_name} attribute
\addtoindexx{name attribute}
whose value is a null\dash terminated string containing the
set type name as it appears in the source program.

The set type entry has 
\addtoindexx{type attribute}
a \livelink{chap:DWATtype}{DW\_AT\_type} attribute to denote the
type of an element of the set.

If the amount of storage allocated to hold each element of an
object of the given set type is different from the amount of
storage that is normally allocated to hold an individual object
of the indicated element type, then the set type entry has
either a \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} attribute, or 
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} attribute
whose value (see Section \refersec{chap:byteandbitsizes}) is
the amount of storage needed to hold a value of the set type.


\section{Subrange Type Entries}
\label{chap:subrangetypeentries}

\textit{Several languages support the concept of a ``subrange''
type object. These objects can represent a subset of the
values that an object of the basis type for the subrange can
represent. 
Subrange type entries may also be used to represent
the bounds of array dimensions.}

A subrange type is represented by a debugging information
entry with the 
\addtoindexx{subrange type entry}
tag \livetarg{chap:DWTAGsubrangetype}{DW\_TAG\_subrange\_type}. 
If a name has been
given to the subrange type, then the subrange type entry
has a \livelink{chap:DWATname}{DW\_AT\_name} attribute
\addtoindexx{name attribute}
whose value is a null\dash terminated
string containing the subrange type name as it appears in
the source program.

The subrange entry may have 
\addtoindexx{type attribute}
a \livelink{chap:DWATtype}{DW\_AT\_type} attribute to describe
the type of object, called the basis type, of whose values
this subrange is a subset.

If the amount of storage allocated to hold each element of an
object of the given subrange type is different from the amount
of storage that is normally allocated to hold an individual
object of the indicated element type, then the subrange
type entry has a 
\livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} attribute or 
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size}
attribute, whose value 
(see Section \refersec{chap:staticanddynamicvaluesofattributes})
is the amount of
storage needed to hold a value of the subrange type.

The 
\hypertarget{chap:DWATthreadsscaledupcarrayboundthreadsscalfactor}
subrange entry may have 
\addtoindexx{threads scaled attribute}
a 
\livelink{chap:DWATthreadsscaled}{DW\_AT\_threads\_scaled} attribute,
which is a \livelink{chap:classflag}{flag}. 
If present, this attribute indicates whether
this subrange represents a \addtoindex{UPC} array bound which is scaled
by the runtime THREADS value (the number of UPC threads in
this execution of the program).

\textit{This allows the representation of a \addtoindex{UPC} shared array such as}

\begin{lstlisting}[numbers=none]
int shared foo[34*THREADS][10][20];
\end{lstlisting}

The 
\hypertarget{chap:DWATlowerboundlowerboundofsubrange}
subrange 
\hypertarget{chap:DWATupperboundupperboundofsubrange}
entry may have the attributes 
\livelink{chap:DWATlowerbound}{DW\_AT\_lower\_bound}
\addtoindexx{lower bound attribute}
and \livelink{chap:DWATupperbound}{DW\_AT\_upper\_bound}
\addtoindexx{upper bound attribute} to specify, respectively, the lower
and upper bound values of the subrange. The 
\livelink{chap:DWATupperbound}{DW\_AT\_upper\_bound}
attribute 
\hypertarget{chap:DWATcountelementsofsubrangetype}
may 
% FIXME: The following matches DWARF4: odd as there is no default count.
\addtoindexx{count attribute!default}
be 
\addtoindexx{count attribute}
replaced by a 
\livelink{chap:DWATcount}{DW\_AT\_count} attribute, 
whose
value describes the number of elements in the subrange rather
than the value of the last element. The value of each of
these attributes is determined as described in 
Section \refersec{chap:staticanddynamicvaluesofattributes}.

If the lower bound value is missing, the value is assumed to
be a language\dash dependent default constant. 
\addtoindexx{lower bound attribute!default}
The default lower bound is 0 for 
\addtoindex{C}, \addtoindex{C++}, 
\addtoindex{D}, 
\addtoindex{Java}, 
\addtoindex{Objective C}, 
\addtoindex{Objective C++},
\addtoindex{Python}, and 
\addtoindex{UPC}. 
The default lower bound is 1 for 
\addtoindex{Ada}, \addtoindex{COBOL},
\addtoindex{Fortran}, 
\addtoindex{Modula-2},
\addtoindex{Pascal} and 
\addtoindex{PL/I}.

\textit{No other default lower bound values are currently defined.}

If the upper bound and count are missing, then the upper bound value is 
\textit{unknown}.\addtoindexx{upper bound attribute!default unknown}

If the subrange entry has no type attribute describing the
basis type, the basis type is determined as follows:
\begin{enumerate}[1. ]
\item
If there is a lower bound attribute that references an object,
the basis type is assumed to be the same as the type of that object.
\item
Otherwise, if there is an upper bound or count attribute that references
an object, the basis type is assumed to be the same as the type of that object.
\item
Otherwise, the type is
assumed to be the same type, in the source language of the
compilation unit containing the subrange entry, as a signed
integer with the same size as an address on the target machine.
\end{enumerate}

If the subrange type occurs as the description of a dimension
of an array type, and the stride for that dimension is
\hypertarget{chap:DWATbytestridesubrangestridedimensionofarraytype}
different than what would otherwise be determined, then
\hypertarget{chap:DWATbitstridesubrangestridedimensionofarraytype}
the subrange type entry has either 
\addtoindexx{byte stride attribute}
a 
\livelink{chap:DWATbytestride}{DW\_AT\_byte\_stride} or
\livelink{chap:DWATbitstride}{DW\_AT\_bit\_stride} attribute 
\addtoindexx{bit stride attribute}
which specifies the separation
between successive elements along the dimension as described
in 
Section \refersec{chap:byteandbitsizes}.

\textit{Note that the stride can be negative.}

\section{Pointer to Member Type Entries}
\label{chap:pointertomembertypeentries}

\textit{In \addtoindex{C++}, a 
pointer to a data or function member of a class or
structure is a unique type.}

A debugging information entry representing the type of an
object that is a pointer to a structure or class member has
the tag \livetarg{chap:DWTAGptrtomembertype}{DW\_TAG\_ptr\_to\_member\_type}.

If the \addtoindex{pointer to member type} has a name, the 
\addtoindexx{pointer to member type entry}
pointer to member entry has a
\livelink{chap:DWATname}{DW\_AT\_name} attribute, 
\addtoindexx{name attribute}
whose value is a
null\dash terminated string containing the type name as it appears
in the source program.

The \addtoindex{pointer to member} entry 
has 
\addtoindexx{type attribute}
a \livelink{chap:DWATtype}{DW\_AT\_type} attribute to
describe the type of the class or structure member to which
objects of this type may point.

The \addtoindex{pointer to member} entry also 
\hypertarget{chap:DWATcontainingtypecontainingtypeofpointertomembertype}
has a 
\livelink{chap:DWATcontainingtype}{DW\_AT\_containing\_type}
attribute, whose value is a \livelink{chap:classreference}{reference} to a debugging
information entry for the class or structure to whose members
objects of this type may point.

The \addtoindex{pointer to member entry} 
\hypertarget{chap:DWATuselocationmemberlocationforpointertomembertype}
has a 
\livelink{chap:DWATuselocation}{DW\_AT\_use\_location} attribute
\addtoindexx{use location attribute}
whose value is a 
\addtoindex{location description} that computes the
address of the member of the class to which the pointer to
member entry points.

\textit{The method used to find the address of a given member of a
class or structure is common to any instance of that class
or structure and to any instance of the pointer or member
type. The method is thus associated with the type entry,
rather than with each instance of the type.}

The \livelink{chap:DWATuselocation}{DW\_AT\_use\_location} description is used in conjunction
with the location descriptions for a particular object of the
given \addtoindex{pointer to member type} and for a particular structure or
class instance. The \livelink{chap:DWATuselocation}{DW\_AT\_use\_location} 
attribute expects two values to be 
\addtoindexi{pushed}{address!implicit push for member operator}
onto the DWARF expression stack before
the \livelink{chap:DWATuselocation}{DW\_AT\_use\_location} description is evaluated.
The first value 
\addtoindexi{pushed}{address!implicit push for member operator}
is the value of the \addtoindex{pointer to member} object
itself. The second value 
\addtoindexi{pushed}{address!implicit push for member operator} 
is the base address of the
entire structure or union instance containing the member
whose address is being calculated.

\needlines{6}
\textit{For an expression such as}

\begin{lstlisting}[numbers=none]
    object.*mbr_ptr
\end{lstlisting}
% FIXME: object and mbr\_ptr should be distinguished from italic. See DW4.
\textit{where mbr\_ptr has some \addtoindex{pointer to member type}, a debugger should:}

\textit{1. Push the value of mbr\_ptr onto the DWARF expression stack.}

\textit{2. Push the base address of object onto the DWARF expression stack.}

\textit{3. Evaluate the \livelink{chap:DWATuselocation}{DW\_AT\_use\_location} description 
given in the type of mbr\_ptr.}

\section{File Type Entries}
\label{chap:filetypeentries}

\textit{Some languages, such as \addtoindex{Pascal}, 
provide a data type to represent 
files.}

A file type is represented by a debugging information entry
with 
\addtoindexx{file type entry}
the 
\livetarg{chap:DWTAGfiletype}{DW\_TAG\_file\_type}. 
If the file type has a name,
the file type entry has a \livelink{chap:DWATname}{DW\_AT\_name} attribute,
\addtoindexx{name attribute}
whose value
is a null\dash terminated string containing the type name as it
appears in the source program.

The file type entry has 
\addtoindexx{type attribute}
a \livelink{chap:DWATtype}{DW\_AT\_type} attribute describing
the type of the objects contained in the file.

The file type entry also 
\addtoindexx{byte size}
has 
\addtoindexx{bit size}
a 
\livelink{chap:DWATbytesize}{DW\_AT\_byte\_size} or
\livelink{chap:DWATbitsize}{DW\_AT\_bit\_size} attribute, whose value 
(see Section \refersec{chap:staticanddynamicvaluesofattributes})
is the amount of storage need to hold a value of the file type.

\section{Dynamic Type Properties}
\label{chap:dynamictypeproperties}
\subsection{Data Location}
\label{chap:datalocation}

\textit{Some languages may represent objects using descriptors to hold
information, including a location and/or run\dash time parameters,
about the data that represents the value for that object.}

\hypertarget{chap:DWATdatalocationindirectiontoactualdata}
The \livelink{chap:DWATdatalocation}{DW\_AT\_data\_location} 
attribute may be used with any
\addtoindexx{data location attribute}
type that provides one or more levels of 
\addtoindexx{hidden indirection|see{data location attribute}}
hidden indirection
and/or run\dash time parameters in its representation. Its value
is a \addtoindex{location description}. 
The result of evaluating this
description yields the location of the data for an object.
When this attribute is omitted, the address of the data is
the same as the address of the object.

\needlines{5}
\textit{This location description will typically begin with
\livelink{chap:DWOPpushobjectaddress}{DW\_OP\_push\_object\_address} 
which loads the address of the
object which can then serve as a descriptor in subsequent
calculation. For an example using 
\livelink{chap:DWATdatalocation}{DW\_AT\_data\_location} 
for a \addtoindex{Fortran 90 array}, see 
Appendix \refersec{app:fortran90example}.}

\subsection{Allocation and Association Status}
\label{chap:allocationandassociationstatus}

\textit{Some languages, such as \addtoindex{Fortran 90},
provide types whose values
may be dynamically allocated or associated with a variable
under explicit program control.}

\hypertarget{chap:DWATallocatedallocationstatusoftypes}
The 
\livelink{chap:DWATallocated}{DW\_AT\_allocated} 
attribute 
\addtoindexx{allocated attribute}
may optionally be used with any
type for which objects of the type can be explicitly allocated
and deallocated. The presence of the attribute indicates that
objects of the type are allocatable and deallocatable. The
integer value of the attribute (see below) specifies whether
an object of the type is 
currently allocated or not.

\hypertarget{chap:DWATassociatedassociationstatusoftypes}
The 
\livelink{chap:DWATassociated}{DW\_AT\_associated} attribute 
may 
\addtoindexx{associated attribute}
optionally be used with
any type for which objects of the type can be dynamically
associated with other objects. The presence of the attribute
indicates that objects of the type can be associated. The
integer value of the attribute (see below) indicates whether
an object of the type is currently associated or not.

\textit{While these attributes are defined specifically with 
\addtoindex{Fortran 90} ALLOCATABLE and POINTER types
in mind, usage is not limited
to just that language.}

The value of these attributes is determined as described in
Section \refersec{chap:staticanddynamicvaluesofattributes}.

A non\dash zero value is interpreted as allocated or associated,
and zero is interpreted as not allocated or not associated.

\textit{For \addtoindex{Fortran 90}, 
if the \livelink{chap:DWATassociated}{DW\_AT\_associated} 
attribute is present,
the type has the POINTER property where either the parent
variable is never associated with a dynamic object or the
implementation does not track whether the associated object
is static or dynamic. If the \livelink{chap:DWATallocated}{DW\_AT\_allocated} attribute is
present and the \livelink{chap:DWATassociated}{DW\_AT\_associated} attribute is not, the type
has the ALLOCATABLE property. If both attributes are present,
then the type should be assumed to have the POINTER property
(and not ALLOCATABLE); the \livelink{chap:DWATallocated}{DW\_AT\_allocated} attribute may then
be used to indicate that the association status of the object
resulted from execution of an ALLOCATE statement rather than
pointer assignment.}

\textit{For examples using 
\livelink{chap:DWATallocated}{DW\_AT\_allocated} for \addtoindex{Ada} and 
\addtoindex{Fortran 90}
arrays, 
see Appendix \refersec{app:aggregateexamples}.}



\section{Template Alias Entries}
\label{chap:templatealiasentries}

A type named using a template alias is represented
by a debugging information entry 
\addtoindexx{template alias entry}
with the tag
\livetarg{chap:DWTAGtemplatealias}{DW\_TAG\_template\_alias}. 
The template alias entry has a
\livelink{chap:DWATname}{DW\_AT\_name} attribute 
\addtoindexx{name attribute}
whose value is a null\dash terminated string
containing the name of the template alias as it appears in
the source program. The template alias entry also contains 
\addtoindexx{type attribute}
a
\livelink{chap:DWATtype}{DW\_AT\_type} attribute 
whose value is a \livelink{chap:classreference}{reference}
to the type named by the template alias. 

\needlines{4}
The template alias entry has the following child entries:
\begin{enumerate}[1. ]
\item Each formal parameterized type declaration appearing
in the template alias declaration is represented
by a debugging information entry with the tag
\livelink{chap:DWTAGtemplatetypeparameter}{DW\_TAG\_template\_type\_parameter}. 
Each such entry may have
a \livelink{chap:DWATname}{DW\_AT\_name} attribute,
\addtoindexx{name attribute}
whose value is a null\dash terminated
string containing the name of the formal type parameter as it
appears in the source program. The template type parameter
entry also has 
\addtoindexx{type attribute}
a \livelink{chap:DWATtype}{DW\_AT\_type} attribute
describing the actual
type by which the formal is replaced for this instantiation.

\item Each formal parameterized value declaration
appearing in the template alias declaration is
represented by a debugging information entry with the tag
\livelink{chap:DWTAGtemplatevalueparameter}{DW\_TAG\_template\_value\_parameter}. 
Each such entry may have
a \livelink{chap:DWATname}{DW\_AT\_name} attribute,
\addtoindexx{name attribute}
whose value is a null\dash terminated
string containing the name of the formal value parameter
as it appears in the source program. The template value
parameter entry also has 
\addtoindexx{type attribute}
a \livelink{chap:DWATtype}{DW\_AT\_type} attribute describing
the type of the parameterized value. Finally, the template
value parameter entry has a \livelink{chap:DWATconstvalue}{DW\_AT\_const\_value} 
attribute, whose value is the actual constant value of the value parameter for
this instantiation as represented on the target architecture.
\end{enumerate}