Indexing m and n complete.
[dwarf-doc.git] / dwarf5 / latexdoc / generaldescription.tex
index 1b2d8d7..8c057d1 100644 (file)
@@ -360,7 +360,7 @@ actually declared in the source}{objects or types that are not actually declared
 \livetarg{chap:DWATuseUTF8}{DW\-\_AT\-\_use\-\_UTF8}
 &\livelinki{chap:DWATuseUTF8compilationunitusesutf8strings}{Compilation unit uses UTF-8 strings}{compilation unit uses UTF-8 strings} \\
 \livetarg{chap:DWATvariableparameter}{DW\-\_AT\-\_variable\-\_parameter}
-&\livelink{chap:DWATvariableparameternonconstantparameterflag}{Non-constant parameter flag}{non-constant parameter flag}  \\
+&\livelinki{chap:DWATvariableparameternonconstantparameterflag}{Non-constant parameter flag}{non-constant parameter flag}  \\
 \livetarg{chap:DWATvirtuality}{DW\-\_AT\-\_virtuality}
 &\livelinki{chap:DWATvirtualityvirtualityindication}{Virtuality indication}{virtuality indication} \\
 &\livelinki{chap:DWATvirtualityvirtualityofbaseclass}{Virtuality of base class} {virtuality of base class} \\
@@ -507,7 +507,6 @@ Many places in this document
 refer
 \addtoindexx{address size|see{size of an address}}
 to the size 
-\addtoindexx{address!size of an|see{size of an address}}
 of an
 \addtoindexi{address}{size of an address}
 on the target architecture (or equivalently, target machine)
@@ -948,11 +947,16 @@ respectively
 }
 
 These operations transfer
-control of DWARF expression evaluation to the 
+control of DWARF expression evaluation to 
+\addtoindexx{location attribute}
+the 
 \livelink{chap:DWATlocation}{DW\-\_AT\-\_location}
 attribute of the referenced debugging information entry. If
 there is no such attribute, then there is no effect. Execution
-of the DWARF expression of a \livelink{chap:DWATlocation}{DW\-\_AT\-\_location} attribute may add
+of the DWARF expression of 
+\addtoindexx{location attribute}
+a 
+\livelink{chap:DWATlocation}{DW\-\_AT\-\_location} attribute may add
 to and/or remove from values on the stack. Execution returns
 to the point following the call when the end of the attribute
 is reached. Values on the stack at the time of the call may be
@@ -1018,7 +1022,13 @@ examples illustrate their behavior graphically.
 
 \section{Location Descriptions}
 \label{chap:locationdescriptions}
-\textit{Debugging information must provide consumers a way to find
+\textit{Debugging information 
+\addtoindexx{location description}
+\addtoindexx{location description}
+must 
+%FIXME: should be 'see also' somehow.
+\addtoindexx{location description|see{DWARF expression}}
+provide consumers a way to find
 the location of program variables, determine the bounds
 of dynamic arrays and strings, and possibly to find the
 base address of a subroutine’s stack frame or the return
@@ -1031,7 +1041,10 @@ Information about the location of program objects is provided
 by location descriptions. Location descriptions can be either
 of two forms:
 \begin{enumerate}[1]
-\item \textit{Single location descriptions}, which are a language independent representation of
+\item \textit{Single location descriptions}, 
+which 
+\addtoindexx{location description!single}
+are a language independent representation of
 addressing rules of arbitrary complexity built from 
 DWARF expressions (See Section \refersec{chap:dwarfexpressions}) 
 and/or other
@@ -1044,18 +1057,23 @@ and it does not move during its lifetime.
 Single location descriptions are of two kinds:
 \begin{enumerate}[a]
 \item Simple location descriptions, which describe the location
+\addtoindexx{location description!simple}
 of one contiguous piece (usually all) of an object. A simple
 location description may describe a location in addressable
 memory, or in a register, or the lack of a location (with or
 without a known value).
 
 \item  Composite location descriptions, which describe an
+\addtoindexx{location description!composite}
 object in terms of pieces each of which may be contained in
 part of a register or stored in a memory location unrelated
 to other pieces.
 
 \end{enumerate}
-\item \textit{Location lists}, which are used to describe
+\item \textit{Location lists}, which are used to 
+\addtoindexx{location list}
+describe
+\addtoindexx{location description!use in location list}
 objects that have a limited lifetime or change their location
 during their lifetime. Location lists are more completely
 described below.
@@ -1068,8 +1086,13 @@ is encoded using
 \addtoindexx{exprloc class}
 class \livelink{chap:exprloc}{exprloc}  
 and a location list is encoded
-using class \livelink{chap:loclistptr}{loclistptr} (which serves as an offset into a
-separate location list table).
+using class \livelink{chap:loclistptr}{loclistptr}
+(which 
+\addtoindex{loclistptr}
+serves as an offset into a
+separate 
+\addtoindexx{location list}
+location list table).
 
 
 \subsection{Single Location Descriptions}
@@ -1077,8 +1100,10 @@ A single location description is either:
 
 \begin{enumerate}[1]
 \item A simple location description, representing an object
+\addtoindexx{location description!simple}
 which exists in one contiguous piece at the given location, or 
 \item A composite location description consisting of one or more
+\addtoindexx{location description!composite}
 simple location descriptions, each of which is followed by
 one composition operation. Each simple location description
 describes the location of one piece of the object; each
@@ -1092,13 +1117,19 @@ DWARF expression is evaluated independently of any others
 
 \subsubsection{Simple Location Descriptions}
 
-A simple location description consists of one 
+A 
+\addtoindexx{location description!simple}
+simple location description consists of one 
 contiguous piece or all of an object or value.
 
 
 \paragraph{Memory Location Descriptions}
 
-A memory location description consists of a non\dash empty DWARF
+A 
+\addtoindexx{location description!memory}
+memory location description 
+\addtoindexx{memory location description}
+consists of a non\dash empty DWARF
 expression (see 
 Section \refersec{chap:dwarfexpressions}
 ), whose value is the address of
@@ -1151,7 +1182,9 @@ one of the register based addressing operations, such as
 
 \paragraph{Implicit Location Descriptions}
 
-An implicit location description represents a piece or all
+An \addtoindex{implicit location description}
+represents a piece or all
+\addtoindexx{location description!implicit}
 of an object which has no actual location but whose contents
 are nonetheless either known or known to be undefined.
 
@@ -1186,6 +1219,7 @@ actual value of the object, rather than its location. The
 
 An \addtoindex{empty location description}
 consists of a DWARF expression
+\addtoindexx{location description!empty}
 containing no operations. It represents a piece or all of an
 object that is present in the source but not in the object code
 (perhaps due to optimization).
@@ -1328,9 +1362,13 @@ contents of r3 and r4.
 
 \subsection{Location Lists}
 \label{chap:locationlists}
-Location lists are used in place of location expressions
+Location lists 
+\addtoindexx{location list}
+are used in place of location expressions
 whenever the object whose location is being described
-can change location during its lifetime. Location lists
+can change location during its lifetime. 
+Location lists
+\addtoindexx{location list}
 are contained in a separate object file section called
 \addtoindex{.debug\_loc}. A location list is indicated by a location
 attribute whose value is an offset from the beginning of
@@ -1342,11 +1380,15 @@ Each entry in a location list is either a location
 entry,
 a 
 \addtoindexi{base}{base address selection entry!in location list} 
-address selection entry, or an 
+address selection entry, 
+\addtoindexx{location list!base address selection entry}
+or an 
 \addtoindexx{end of list entry!in location list}
 end of list entry.
 
-A location list entry consists of:
+A 
+\addtoindexx{location list!entry}
+location list entry consists of:
 
 \begin{enumerate}[1]
 \item A beginning address offset. 
@@ -1375,7 +1417,9 @@ describing the location of the object over the range specified by
 the beginning and end addresses.
 \end{enumerate}
 
-The applicable base address of a location list entry is
+The applicable base address of a 
+location list entry is
+\addtoindexx{location list!base address selection entry}
 determined by the closest preceding base address selection
 entry (see below) in the same location list. If there is
 no such selection entry, then the applicable base address
@@ -1409,8 +1453,9 @@ and ending address offsets of subsequent entries of the location list.
 \textit{A base address selection entry 
 affects only the list in which it is contained.}
 
-The end of any given location list is marked by an end of
-list entry, which consists of a 0 for the beginning address
+The end of any given location list is marked by an 
+\addtoindexx{location list!enf of list entry}
+end of list entry, which consists of a 0 for the beginning address
 offset and a 0 for the ending address offset. A location list
 containing only an 
 \addtoindexx{end of list entry!in location list}
@@ -1485,7 +1530,7 @@ value is a constant drawn from the set of codes listed in Figure
 \section{Visibility of Declarations}
 \label{chap:visibilityofdeclarations}
 
-\textit{Several languages (such as Modula-2
+\textit{Several languages (such as \addtoindex{Modula-2}
 have the concept of the visibility of a declaration. The
 visibility specifies which declarations are to be 
 visible outside of the entity in which they are
@@ -1635,6 +1680,7 @@ A debugging information entry representing a program entity
 typically represents the defining declaration of that
 entity. In certain contexts, however, a debugger might need
 information about a declaration of an entity that is not
+\addtoindexx{incomplete declaration}
 also a definition, or is otherwise incomplete, to evaluate
 \hypertarget{chap:DWATdeclarationincompletenondefiningorseparateentitydeclaration}
 an expression correctly.
@@ -1659,8 +1705,11 @@ global variable x rather than of the local version.}
 
 \subsection{Non-Defining Declarations}
 A debugging information entry that 
-represents a non-defining or otherwise incomplete
-declaration of a program entity has 
+represents a non-defining or 
+\addtoindex{non-defining declaration}
+otherwise 
+\addtoindex{incomplete declaration}
+of a program entity has 
 \addtoindexx{declaration attribute}
 a 
 \livelink{chap:DWATdeclaration}{DW\-\_AT\-\_declaration} 
@@ -1710,6 +1759,7 @@ entry
 representing 
 \hypertarget{chap:DWATdeclcolumncolumnpositionofsourcedeclaration}
 the
+\addtoindexx{line number of declaration}
 declaration of an object, module, subprogram or
 \addtoindex{declaration column attribute}
 type 
@@ -1726,7 +1776,9 @@ The value of
 \addtoindex{declaration file attribute}
 the 
 \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file}
-attribute corresponds to
+attribute 
+\addtoindexx{file containing declaration}
+corresponds to
 a file number from the line number information table for the
 compilation unit containing the debugging information entry and
 represents the source file in which the declaration appeared
@@ -1752,10 +1804,16 @@ indicates that no column has been specified.
 \label{chap:identifiernames}
 Any 
 \hypertarget{chap:DWATnamenameofdeclaration}
-debugging information entry representing a program entity
+debugging information entry 
+\addtoindexx{identifier names}
+representing 
+\addtoindexx{names!identifier}
+a program entity
 that has been given a name may have a 
 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute,
-whose value is a string representing the name as it appears in
+whose 
+\addtoindexx{name attribute}
+value is a string representing the name as it appears in
 the source program. A debugging information entry containing
 no name attribute, or containing a name attribute whose value
 consists of a name containing a single null byte, represents
@@ -1764,12 +1822,18 @@ a program entity for which no name was given in the source.
 \textit{Because the names of program objects described by DWARF are the
 names as they appear in the source program, implementations
 of language translators that use some form of mangled name
+\addtoindex{mangled names}
 (as do many implementations of C++) should use the unmangled
-form of the name in the DWARF \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute,
+form of the name in the 
+DWARF \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute,
+\addtoindexx{name attribute}
 including the keyword operator (in names such as “operator
 +”), if present. See also 
 Section \refersec{chap:linkagenames} regarding the use
-of \livelink{chap:DWATlinkagename}{DW\-\_AT\-\_linkage\-\_name} for mangled names. Sequences of
+of \livelink{chap:DWATlinkagename}{DW\-\_AT\-\_linkage\-\_name} for 
+\addtoindex{mangled names}
+mangled names. 
+Sequences of
 multiple whitespace characters may be compressed.}
 
 \section{Data Locations and DWARF Procedures}
@@ -1777,22 +1841,31 @@ Any debugging information entry describing a data object (which
 \hypertarget{chap:DWATlocationdataobjectlocation}
 includes variables and parameters) or 
 common \livelink{chap:commonblockentry}{block}
-may have a
-\livelink{chap:DWATlocation}{DW\-\_AT\-\_location} attribute, whose value is a location description
+may have 
+\addtoindexx{location attribute}
+a
+\livelink{chap:DWATlocation}{DW\-\_AT\-\_location} attribute
+\addtoindexx{location attribute}
+, whose value is a location description
 (see Section \refersec{chap:locationdescriptions}).
 
 A 
 \addtoindex{DWARF procedure}
 is represented by any
-kind of debugging information entry that has a 
+kind of debugging information entry that has 
+\addtoindexx{location attribute}
+a 
 \livelink{chap:DWATlocation}{DW\-\_AT\-\_location}
 attribute. 
+\addtoindexx{location attribute}
 If a suitable entry is not otherwise available,
 a DWARF procedure can be represented using a debugging
 \addtoindexx{DWARF procedure entry}
 information entry with the 
 tag \livetarg{chap:DWTAGdwarfprocedure}{DW\-\_TAG\-\_dwarf\-\_procedure}
-together with a \livelink{chap:DWATlocation}{DW\-\_AT\-\_location} attribute.  
+together with 
+\addtoindexx{location attribute}
+a \livelink{chap:DWATlocation}{DW\-\_AT\-\_location} attribute.  
 
 A DWARF procedure
 is called by a \livelink{chap:DWOPcall2}{DW\-\_OP\-\_call2}, 
@@ -1816,11 +1889,18 @@ and
 the like, may have
 
 \begin{itemize}
-\item A \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} and \livelink{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc} pair of 
-attributes for a single contiguous range of
+\item A \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} and 
+\livelink{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc} pair of 
+attributes 
+\addtoindexx{high PC attribute}
+for 
+\addtoindexx{low PC attribute}
+a single contiguous range of
 addresses, or
 
-\item A \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} attribute for a non-contiguous range of addresses.
+\item A \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} attribute 
+\addtoindexx{ranges attribute}
+for a non-contiguous range of addresses.
 \end{itemize}
 
 In addition, a non-contiguous range of 
@@ -1843,9 +1923,17 @@ insufficient reason to change this.
 \subsection{Continuous Address Range}
 \label{chap:contiguousaddressranges}
 When the set of addresses of a debugging information entry can
-be described as a single continguous range, the entry may have
-a \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} and \livelink{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc} pair of attributes. The value
-of the \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} attribute is the relocated address of the
+be described as a single continguous range, the entry 
+\addtoindexx{high PC attribute}
+may 
+\addtoindexx{low PC attribute}
+have
+a \livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} and 
+\livelink{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc} pair of attributes. 
+The value
+of the 
+\livelink{chap:DWATlowpc}{DW\-\_AT\-\_low\-\_pc} attribute 
+is the relocated address of the
 first instruction associated with the entity. If the value of
 the \livelink{chap:DWAThighpc}{DW\-\_AT\-\_high\-\_pc} is of class address, it is the relocated
 address of the first location past the last instruction
@@ -1863,8 +1951,11 @@ attributes should be produced.
 \subsection{Non\dash Contiguous Address Ranges}
 \label{chap:noncontiguousaddressranges}
 When the set of addresses of a debugging information entry
+\addtoindexx{non-contiguous address ranges}
 cannot be described as a single contiguous range, the entry has
-a \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} attribute whose value is of class \livelink{chap:rangelistptr}{rangelistptr}
+a \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} attribute 
+\addtoindexx{ranges attribute}
+whose value is of class \livelink{chap:rangelistptr}{rangelistptr}
 and indicates the beginning of a range list. Similarly,
 a \livelink{chap:DWATstartscope}{DW\-\_AT\-\_start\-\_scope} attribute may have a value of class
 \livelink{chap:rangelistptr}{rangelistptr} for the same reason.  
@@ -1874,6 +1965,7 @@ in a separate object file section called
 \addtoindex{.debug\_ranges}. A
 range list is indicated by a 
 \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} attribute whose
+\addtoindexx{ranges attribute}
 value is represented as an offset from the beginning of the
 \addtoindex{.debug\_ranges} section to the beginning of the range list.
 
@@ -2026,7 +2118,9 @@ type descriptions of the form typename’Class, and
 Generally, any debugging information
 entry that 
 \hypertarget{chap:DWATdescriptionartificialnameordescription}
-has, or may have, a 
+has, or may have, 
+\addtoindexx{name attribute}
+a 
 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, may
 also have 
 \addtoindexx{description attribute}
@@ -2061,10 +2155,15 @@ attribute is interpreted in bits.
 \label{chap:linkagenames}
 \textit{Some language implementations, notably 
 \addtoindex{C++} and similar
-languages, make use of implementation defined names within
+languages, 
+make use of implementation defined names within
 object files that are different from the identifier names
 (see Section \refersec{chap:identifiernames}) of entities as they appear in the
-source. Such names, sometimes known as mangled names,
+source. Such names, sometimes known 
+\addtoindex{names!mangled}
+as 
+\addtoindexx{mangled names}
+mangled names,
 are used in various ways, such as: to encode additional
 information about an entity, to distinguish multiple entities
 that have the same name, and so on. When an entity has an
@@ -2078,7 +2177,9 @@ that is encoded in the linkage name itself.
 
 % Some trouble maybe with hbox full, so we try optional word breaks.
 A debugging
-information entry may have a 
+information entry may have 
+\addtoindexx{linkage name attribute}
+a 
 \livelink{chap:DWATlinkagename}{DW\-\_AT\-\_linkage\-\_name}
 attribute
 whose value is a null-terminated string describing the object