Indexing letter 's'.
[dwarf-doc.git] / dwarf5 / latexdoc / otherdebugginginformation.tex
index bc880e4..c0172b7 100644 (file)
@@ -9,18 +9,26 @@ is not contained within a \addtoindex{.debug\_info} or
 In the descriptions that follow, these terms are used to
 specify the representation of DWARF sections:
 
-Initial length, section offset and section length, which are
+Initial length, section offset and 
+\addtoindex{section length}, which are
 defined in 
 Sections \refersec{datarep:locationdescriptions} and 
 \refersec{datarep:32bitand64bitdwarfformats}.
 
-Sbyte, ubyte, uhalf, and uword, which are defined in 
+Sbyte, 
+\addtoindex{ubyte}, 
+\addtoindex{uhalf}, and 
+\addtoindex{uword}, 
+which 
+\addtoindexx{sbyte}
+are defined in 
 Section \refersec{datarep:integerrepresentationnames}.
 
 \section{Accelerated Access}
 \label{chap:acceleratedaccess}
 
 \textit{A debugger frequently needs to find the debugging information
+\addtoindexx{accelerated access}
 for a program entity defined outside of the compilation unit
 where the debugged program is currently stopped. Sometimes the
 debugger will know only the name of the entity; sometimes only
@@ -59,7 +67,10 @@ more condensed format.
 
 \subsection{Lookup by Name}
 
-For lookup by name, two tables are maintained in separate
+For lookup by name, 
+\addtoindexx{lookup!by name}
+two tables are maintained in separate
+\addtoindex{accelerated access!by name}
 object file sections named 
 \addtoindex{.debug\_pubnames} for objects and
 functions, and 
@@ -86,19 +97,28 @@ not including the length field itself
 (see Section \refersec{datarep:locationdescriptions}).
 
 \item  version (uhalf) \\
-A version number 
+A version number
+\addtoindexx{version number!name lookup table}
+\addtoindexx{version number!type lookup table} 
 (see Section \refersec{datarep:namelookuptables}). 
 This number is specific
 to the name lookup table and is independent of the DWARF
 version number.
 
 \item debug\_info\_offset (section offset) \\
-The offset from the beginning of the 
+The 
+\addtoindexx{section offset!in .debug\_pubtypes header}
+offset 
+\addtoindexx{section offset!in .debug\_pubtypes header}
+from the beginning of the 
 \addtoindex{.debug\_info} section of
 the compilation unit header referenced by the set.
 
 \item debug\_info\_length (section length) \\
-The size in bytes of the contents of the 
+\addtoindexx{section length!in .debug\_pubnames header}
+The 
+\addtoindexx{section length!in .debug\_pubtypes header}
+size in bytes of the contents of the 
 \addtoindex{.debug\_info} section
 generated to represent that compilation unit.
 \end{enumerate}
@@ -125,7 +145,10 @@ the data or function member.
 
 \subsection{Lookup by Address}
 
-For lookup by address, a table is maintained in a separate
+For 
+\addtoindexx{lookup!by address}
+lookup by address, a table is maintained in a separate
+\addtoindex{accelerated access!by address}
 object file section called 
 \addtoindex{.debug\_aranges}. The table consists
 of sets of variable length entries, each set describing the
@@ -142,20 +165,23 @@ entries for that set, not including the length field itself
 (see Section \refersec{datarep:initiallengthvalues}).
 
 \item version (uhalf) \\
-A version number 
+A version number\addtoindexx{version number!address lookup table} 
 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
-This
-number is specific to the address lookup table and is
+This number is specific to the address lookup table and is
 independent of the DWARF version number.
 
 \item debug\_info\_offset (section offset) \\
 The offset from the
+\addtoindexx{section offset!in .debug\_pubnames header}
 beginning of the \addtoindex{.debug\_info} or 
 \addtoindex{.debug\_types} section of the
 compilation unit header referenced by the set.
 
 \item address\_size (ubyte) \\
-The size of an address in bytes on
+The \addtoindex{size of an address}
+in 
+\addtoindexx{ubyte}
+bytes on
 \addtoindexx{address\_size}
 the target architecture. For 
 \addtoindexx{address space!segmented}
@@ -163,7 +189,10 @@ segmented addressing, this is
 the size of the offset portion of the address.
 
 \item segment\_size (ubyte) \\
-The size of a segment selector in
+The size of a segment selector 
+\addtoindexx{ubyte}
+in
+\addtoindexx{segment\_size}
 bytes on the target architecture. If the target system uses
 a flat address space, this value is 0.
 
@@ -176,7 +205,9 @@ segment selector, the beginning address within that segment
 of a range of text or data covered by some entry owned by
 the corresponding compilation unit, followed by the non\dash zero
 length of that range. A particular set is terminated by an
-entry consisting of three zeroes. When the segment\_size value
+entry consisting of three zeroes. 
+When the 
+\addtoindex{segment\_size} value
 is zero in the header, the segment selector is omitted so that
 each descriptor is just a pair, including the terminating
 entry. By scanning the table, a debugger can quickly decide
@@ -193,6 +224,8 @@ multiple address range descriptors for that compilation unit.}
 \section{Line Number Information}
 \label{chap:linenumberinformation}
 \textit{A source\dash level debugger will need to know how to
+%FIXME: the see here is not 'see also'. Fix?
+\addtoindexx{line number information|see{statement list attribute}}
 associate locations in the source files with the corresponding
 machine instruction addresses in the executable object or
 the shared objects used by that executable object. Such an
@@ -214,7 +247,11 @@ in the \addtoindex{.debug\_info}
 section.
 
 \textit{Some computer architectures employ more than one instruction
-set (for example, the ARM and MIPS architectures support
+set (for example, the ARM 
+\addtoindexx{ARM instruction set architecture}
+and 
+MIPS architectures support
+\addtoindexx{MIPS instruction set architecture}
 a 32\dash bit as well as a 16\dash bit instruction set). Because the
 instruction set is a function of the program counter, it is
 convenient to encode the applicable instruction set in the
@@ -230,14 +267,15 @@ object code. The matrix would have columns for:}
 \item \textit{the source file name}
 \item \textit{the source line number}
 \item \textit{the source column number}
-\item \textit{whether this insruction is the beginning of a basic block}
+\item \textit{whether this insruction is the beginning of a \addtoindex{basic block}}
 \item \textit{and so on}
 \end{itemize}
 
 \textit{Such a matrix, however, would be impractically large. We
 shrink it with two techniques. First, we delete from
 the matrix each row whose file, line, source column and
-discriminator information is identical with that of its
+\addtoindex{discriminator} information 
+is identical with that of its
 predecessors. Any deleted row would never be the beginning of
 a source statement. Second, we design a byte\dash coded language
 for a state machine and store a stream of bytes in the object
@@ -272,12 +310,14 @@ A series of byte\dash coded
 line number information instructions representing
 one compilation unit. \\
 
-basic block &
+\addtoindex{basic block} &
  A sequence of instructions where only the first instruction may be a
 branch target and only the last instruction may transfer control. A
-procedure invocation is defined to be an exit from a basic block.
+procedure invocation is defined to be an exit from a 
+\addtoindex{basic block}.
 
-\textit{A basic block does not necessarily correspond to a specific source code
+\textit{A \addtoindex{basic block} does not 
+necessarily correspond to a specific source code
 construct.} \\
 
 sequence &
@@ -305,57 +345,59 @@ registers:
 The program\dash counter value corresponding to a machine instruction
 generated by the compiler. \\
 
-op\_index &
+\addtoindex{op\_index} &
 An unsigned integer representing the index of an operation within a VLIW
 instruction. The index of the first operation is 0. For non\dash VLIW
 architectures, this register will always be 0.
 
-The address and op\_index registers, taken together, form an operation
+The address and \addtoindex{op\_index} registers,
+taken together, form an operation
 pointer that can reference any individual operation with the instruction
 stream. \\
 
 
-file &
+\addtoindex{file} &
 An unsigned integer indicating the identity of the source file
 corresponding to a machine instruction. \\
 
-line &
+\addtoindex{line} &
 An unsigned integer indicating a source line number. Lines are numbered
 beginning at 1. The compiler may emit the value 0 in cases where an
 instruction cannot be attributed to any source line. \\
 
-column &
+\addtoindex{column} &
 An unsigned integer indicating a column number within a source line.
 Columns are numbered beginning at 1. The value 0 is reserved to indicate
 that a statement begins at the ``left edge'' of the line. \\
 
-is\_stmt &
+\addtoindex{is\_stmt} &
 A boolean indicating that the current instruction is a recommended
 breakpoint location. A recommended breakpoint location 
 is intended to ``represent'' a line, a 
 statement and/or a semantically distinct subpart of a
 statement. \\
 
-basic\_block  &
-A boolean indicating that the current instruction is the beginning of a basic 
-\nolink{block}. \\
+\addtoindex{basic\_block}  &
+A boolean indicating that the current instruction is the beginning of a
+\addtoindex{basic block}. \\
 
-end\_sequence &
+\addtoindex{end\_sequence} &
 A boolean indicating that the current address is that of the first byte after
-the end of a sequence of target machine instructions. end\_sequence
+the end of a sequence of target machine instructions. 
+\addtoindex{end\_sequence}
 terminates a sequence of lines; therefore other information in the same
 row is not meaningful. \\
 
-prologue\_end &
+\addtoindex{prologue\_end} &
 A boolean indicating that the current address is one (of possibly many)
 where execution should be suspended for an entry breakpoint of a
 function. \\
 
-epilogue\_begin &
+\addtoindex{epilogue\_begin} &
 A boolean indicating that the current address is one (of possibly many)
 where execution should be suspended for an exit breakpoint of a function. \\
 
-isa &
+\addtoindex{isa} &
 An unsigned integer whose value encodes the applicable
 instruction set architecture for the current instruction.
 The encoding of instruction sets should be shared by all
@@ -363,7 +405,7 @@ users of a given architecture. It is recommended that this
 encoding be defined by the ABI authoring committee for each
 architecture. \\
 
-discriminator &
+\addtoindex{discriminator} &
 An unsigned integer identifying the block to which the
 current instruction belongs. Discriminator values are assigned
 arbitrarily by the DWARF producer and serve to distinguish
@@ -378,20 +420,21 @@ program, the state of the registers is:
 
 \begin{tabular}{lp{8cm}}
 address & 0 \\
-op\_index & 0 \\
+\addtoindex{op\_index} & 0 \\
 file & 1 \\
 line & 1 \\
 column & 0 \\
-is\_stmt & determined by default\_is\_stmt in the line number program header \\
-basic\_block & ``false'' \\
-end\_sequence & ``false'' \\
-prologue\_end & ``false'' \\
-epilogue\_begin & ``false'' \\
-isa & 0 \\
+\addtoindex{is\_stmt} & determined by \addtoindex{default\_is\_stmt} in the line number program header \\
+\addtoindex{basic\_block} & ``false'' \addtoindexx{basic block} \\
+\addtoindex{end\_sequence} & ``false'' \\
+\addtoindex{prologue\_end} & ``false'' \\
+\addtoindex{epilogue\_begin} & ``false'' \\
+\addtoindex{isa} & 0 \\
 discriminator & 0 \\
 \end{tabular}
 
-\textit{The isa value 0 specifies that the instruction set is the
+\textit{The 
+\addtoindex{isa} value 0 specifies that the instruction set is the
 architecturally determined default instruction set. This may
 be fixed by the ABI, or it may be specified by other means,
 for example, by the object file description.}
@@ -443,14 +486,14 @@ compilation unit, not including the unit\_length field itself
 (see Section \refersec{datarep:initiallengthvalues}). 
 
 \item version (uhalf) 
-A version number 
+A version number\addtoindexx{version number!line number information} 
 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
 This number is specific to
 the line number information and is independent of the DWARF
 version number. 
 
 \item header\_length  \\
-The number of bytes following the header\_length field to the
+The number of bytes following the \addtoindex{header\_length} field to the
 beginning of the first byte of the line number program itself.
 In the 32\dash bit DWARF format, this is a 4\dash byte unsigned
 length; in the 64\dash bit DWARF format, this field is an
@@ -458,27 +501,37 @@ length; in the 64\dash bit DWARF format, this field is an
 (see Section \refersec{datarep:32bitand64bitdwarfformats}). 
 
 \item minimum\_instruction\_length (ubyte)  \\
+\addtoindexx{minimum\_instruction\_length}
 The size in bytes of the smallest target machine
 instruction. Line number program opcodes that alter
-the address and op\_index registers use this and
+the address and \addtoindex{op\_index} registers use this and
+\addtoindexx{maximum\_operations\_per\_instruction}
 maximum\-\_operations\-\_per\-\_instruction in their calculations. 
 
 \item maximum\_operations\_per\_instruction (ubyte) \\
-The maximum number of individual operations that may be
+The 
+\addtoindexx{maximum\_operations\_per\_instruction}
+maximum number of individual operations that may be
 encoded in an instruction. Line number program opcodes
-that alter the address and op\_index registers use this and
-minimum\_instruction\_length in their calculations.  For non-VLIW
-architectures, this field is 1, the op\_index register is always
+that alter the address and 
+\addtoindex{op\_index} registers use this and
+\addtoindex{minimum\_instruction\_length}
+in their calculations.
+For non-VLIW
+architectures, this field is 1, the \addtoindex{op\_index register} is always
 0, and the operation pointer is simply the address register.
 
 \item default\_is\_stmt (ubyte) \\
-The initial value of the is\_stmt register.  
+\addtoindexx{default\_is\_stmt}
+The initial value of the \addtoindex{is\_stmt} register.  
 
 \textit{A simple approach
 to building line number information when machine instructions
 are emitted in an order corresponding to the source program
-is to set default\_is\_stmt to ``true'' and to not change the
-value of the is\_stmt register within the line number program.
+is to set \addtoindex{default\_is\_stmt} 
+to ``true'' and to not change the
+value of the \addtoindex{is\_stmt} register 
+within the line number program.
 One matrix entry is produced for each line that has code
 generated for it. The effect is that every entry in the
 matrix recommends the beginning of each represented line as
@@ -490,23 +543,39 @@ the matrix for a line number; in this case, at least one entry
 (often but not necessarily only one) specifies a recommended
 breakpoint location for the line number. \livelink{chap:DWLNSnegatestmt}{DW\-\_LNS\-\_negate\-\_stmt}
 opcodes in the line number program control which matrix entries
-constitute such a recommendation and default\_is\_stmt might
+constitute such a recommendation and 
+\addtoindex{default\_is\_stmt} might
 be either ``true'' or ``false''. This approach might be
 used as part of support for debugging optimized code.}
 
-\item line\_base (sbyte) \\
+\item line\_base (\addtoindex{sbyte}) \\
+\addtoindexx{line\_base}
 This parameter affects the meaning of the special opcodes. See below.
 
 \item line\_range (ubyte) \\
-This parameter affects the meaning of the special opcodes. See below.
+\addtoindexx{line\_range}
+This 
+\addtoindexx{ubyte}
+parameter affects the meaning of the special opcodes. See below.
 
 \item opcode\_base (ubyte) \\
-The number assigned to the first special opcode.
+The 
+\addtoindex{opcode\_base}
+number
+\addtoindexx{ubyte}
+ assigned to the first special opcode.
 
 \textit{Opcode base is typically one greater than the highest-numbered
+\addtoindex{opcode\_base}
 standard opcode defined for the specified version of the line
-number information (12 in DWARF Version 3 and Version 4, 9 in
-Version 2).  If opcode\_base is less than the typical value,
+number information (12 in 
+\addtoindex{DWARF Version 3} and 
+\addtoindexx{DWARF Version 4}
+Version 4, 9 in
+\addtoindexx{DWARF Version 2}
+Version 2).  
+If opcode\_base is less than the typical value,
+\addtoindex{opcode\_base}
 then standard opcode numbers greater than or equal to the
 opcode base are not used in the line number table of this unit
 (and the codes are treated as special opcodes). If opcode\_base
@@ -515,6 +584,7 @@ that of the highest standard opcode and the first special
 opcode (not inclusive) are used for vendor specific extensions.}
 
 \item standard\_opcode\_lengths (array of ubyte) \\
+\addtoindexx{standard\_opcode\_lengths}
 This array specifies the number of LEB128 operands for each
 of the standard opcodes. The first element of the array
 corresponds to the opcode whose value is 1, and the last
@@ -522,6 +592,7 @@ element corresponds to the opcode whose value
 is opcode\_base - 1.
 
 By increasing opcode\_base, and adding elements to this array,
+\addtoindex{opcode\_base}
 new standard opcodes can be added, while allowing consumers who
 do not know about these new opcodes to be able to skip them.
 
@@ -529,7 +600,9 @@ Codes for vendor specific extensions, if any, are described
 just like standard opcodes.
 
 \item include\_directories (sequence of path names) \\
-Entries in this sequence describe each path that was searched
+Entries 
+\addtoindexx{include\_directories}
+in this sequence describe each path that was searched
 for included source files in this compilation. (The paths
 include those directories specified explicitly by the user for
 the compiler to search and those the compiler searches without
@@ -544,7 +617,11 @@ the compilation is understood to be the zeroth entry and is
 not explicitly represented.
 
 \item  file\_names (sequence of file entries) \\
-Entries in this sequence describe source files that contribute
+Entries 
+\addtoindexx{file names}
+in 
+\addtoindexx{file\_names}
+this sequence describe source files that contribute
 to the line number information for this compilation unit or is
 used in other contexts, such as in a declaration coordinate or
 a macro file inclusion. Each entry consists of the following
@@ -557,10 +634,12 @@ path name of a source file. If the entry contains a file
 name or relative path name, the file is located relative
 to either the compilation directory (as specified by the
 \livelink{chap:DWATcompdir}{DW\-\_AT\-\_comp\-\_dir} attribute given in the compilation unit) or one
-of the directories listed in the include\_directories section.
+of the directories listed in the 
+\addtoindex{include\_directories} section.
 
 \item An unsigned LEB128 number representing the directory
-index of a directory in the include\_directories section.
+index of a directory in the 
+\addtoindex{include\_directories} section.
 
 
 \item An unsigned LEB128 number representing the
@@ -575,9 +654,11 @@ bytes of the file, or 0 if not available.
 The last entry is followed by a single null byte.
 
 The directory index represents an entry in the
-include\_directories section. The index is 0 if the file was
+\addtoindex{include\_directories} section. 
+The index is 0 if the file was
 found in the current directory of the compilation, 1 if it
-was found in the first directory in the include\_directories
+was found in the first directory in the 
+\addtoindex{include\_directories}
 section, and so on. The directory index is ignored for file
 names that represent full path names.
 
@@ -602,7 +683,9 @@ names field and define file names using the extended opcode
 As stated before, the goal of a line number program is to build
 a matrix representing one compilation unit, which may have
 produced multiple sequences of target machine instructions.
-Within a sequence, addresses (operation pointers) may only
+Within a sequence, addresses 
+\addtoindexx{operation pointer}
+(operation pointers) may only
 increase. (Line numbers may decrease in cases of pipeline
 scheduling or other optimization.)
 
@@ -614,22 +697,22 @@ Each ubyte special opcode has the following effect on the state machine:
 
 \item  Add a signed integer to the line register.
 
-\item  Modify the operation pointer by incrementing the
-address and op\_index registers as described below.
+\item  Modify the \addtoindex{operation pointer} by incrementing the
+address and \addtoindex{op\_index} registers as described below.
 
 \item  Append a row to the matrix using the current values
 of the state machine registers.
 
-\item  Set the basic\_block register to ``false.''
-\item  Set the prologue\_end register to ``false.''
-\item  Set the epilogue\_begin register to ``false.''
-\item  Set the discriminator register to 0.
+\item  Set the \addtoindex{basic\_block} register to ``false.'' \addtoindexx{basic block}
+\item  Set the \addtoindex{prologue\_end} register to ``false.''
+\item  Set the \addtoindex{epilogue\_begin} register to ``false.''
+\item  Set the \addtoindex{discriminator} register to 0.
 
 \end{enumerate}
 
 All of the special opcodes do those same seven things; they
 differ from one another only in what values they add to the
-line, address and op\_index registers.
+line, address and \addtoindex{op\_index} registers.
 
 
 \textit{Instead of assigning a fixed meaning to each special opcode,
@@ -652,40 +735,46 @@ the line register (a standard opcode provides an alternate
 way to decrease the line number) in return for the ability
 to add larger positive values to the address register. To
 permit this variety of strategies, the line number program
-header defines a line\_base field that specifies the minimum
+header defines a 
+\addtoindexx{line\_base}
+field that specifies the minimum
 value which a special opcode can add to the line register
 and a line\_range field that defines the range of values it
 can add to the line register.}
 
 
 A special opcode value is chosen based on the amount that needs
-to be added to the line, address and op\_index registers. The
+to be added to the line, address and \addtoindex{op\_index} registers.
+The
 maximum line increment for a special opcode is the value
-of the line\_base field in the header, plus the value of
+of the 
+\addtoindexx{line\_base}
+field in the header, plus the value of
 the line\_range field, minus 1 (line base + 
 line range - 1). 
 If the desired line increment is greater than the maximum
 line increment, a standard opcode must be used instead of a
-special opcode. The operation advance represents the number
-of operations to skip when advancing the operation pointer.
+special opcode. The \addtoindex{operation advance} represents the number
+of operations to skip when advancing the \addtoindex{operation pointer}.
 
 The special opcode is then calculated using the following formula:
 
-  opcode = ( \textit{desired line increment} - line\_base) +
-(line\_range * \textit{operation advance} ) + opcode\_base
+  opcode = ( \textit{desired line increment} - \addtoindex{line\_base}) +
+(\addtoindex{line\_range} * \textit{operation advance} ) + \addtoindex{opcode\_base}
 
 If the resulting opcode is greater than 255, a standard opcode
 must be used instead.
 
-When maximum\_operations\_per\_instruction is 1, the operation
+When \addtoindex{maximum\_operations\_per\_instruction} is 1, the operation
 advance is simply the address increment divided by the
-minimum\_instruction\_length.
+\addtoindex{minimum\_instruction\_length}.
 
 To decode a special opcode, subtract the opcode\_base from
 the opcode itself to give the \textit{adjusted opcode}. 
 The \textit{operation advance} 
 is the result of the adjusted opcode divided by the
-line\_range. The new address and op\_index values are given by
+line\_range. The new address and \addtoindex{op\_index} values
+are given by
 \begin{myindentpara}{1cm}
 
 \textit{adjusted opcode} = opcode – opcode\_base
@@ -697,39 +786,48 @@ new address =
 
 address +
 
-minimum\_instruction\_length *
-((op\_index + operation advance) / 
-maximum\_operations\_per\_instruction)
+\addtoindex{minimum\_instruction\_length} *
+((\addtoindex{op\_index} + \addtoindex{operation advance}) / 
+\addtoindex{maximum\_operations\_per\_instruction})
 \end{myindentpara}
 new op\_index =
 
 \begin{myindentpara}{1cm}
-(op\_index + operation advance) \% maximum\_operations\_per\_instruction
+(\addtoindex{op\_index} + \addtoindex{operation advance}) \% 
+\addtoindex{maximum\_operations\_per\_instruction}
 \end{myindentpara}
 
 \end{myindentpara}
 
-\textit{When the maximum\_operations\_per\_instruction field is 1,
+\textit{When the \addtoindex{maximum\_operations\_per\_instruction} field is 1,
 op\_index is always 0 and these calculations simplify to those
-given for addresses in DWARF Version 3.}
-
-The amount to increment the line register is the line\_base plus
-the result of the adjusted opcode modulo the line\_range. That
+given for addresses in 
+\addtoindex{DWARF Version 3}.}
+
+The amount to increment the line register is the 
+\addtoindex{line\_base} plus
+the result of the 
+\addtoindex{adjusted opcode} modulo the 
+\addtoindex{line\_range}. That
 is,
 
 \begin{myindentpara}{1cm}
-line increment = line\_base + (adjusted opcode \% line\_range)
+line increment = \addtoindex{line\_base} + (adjusted opcode \% \addtoindex{line\_range})
 \end{myindentpara}
 
-\textit{As an example, suppose that the opcode\_base is 13, line\_base
-is -3, line\_range is 12, minimum\_instruction\_length is 1
-and maximum\_operations\_per\_instruction is 1. This means that
+\textit{As an example, suppose that the opcode\_base is 13, 
+\addtoindex{line\_base}
+is -3, \addtoindex{line\_range} is 12, 
+\addtoindex{minimum\_instruction\_length} is 1
+and 
+\addtoindex{maximum\_operations\_per\_instruction} is 1. 
+This means that
 we can use a special opcode whenever two successive rows in
 the matrix have source line numbers differing by any value
 within the range [-3, 8] and (because of the limited number
 of opcodes available) when the difference between addresses
 is within the range [0, 20], but not all line advances are
-available for the maximum operation advance (see below).}
+available for the maximum \addtoindex{operation advance} (see below).}
 
 \textit{The opcode mapping would be:}
 % FIXME: This should be a tabular or the like, not a verbatim
@@ -763,8 +861,8 @@ available for the maximum operation advance (see below).}
 
 
 \textit{There is no requirement that the expression 
-255 - line\_base + 1 be an integral multiple of
-line\_range. }
+255 - \addtoindex{line\_base} + 1 be an integral multiple of
+\addtoindex{line\_range}. }
 
 \subsubsection{Standard Opcodes}
 \label{chap:standardopcodes}
@@ -778,14 +876,16 @@ actions performed by these opcodes are as follows:
 \item \textbf{DW\-\_LNS\-\_copy} \\
 The \livetarg{chap:DWLNScopy}{DW\-\_LNS\-\_copy} opcode takes no operands. It appends a row
 to the matrix using the current values of the state machine
-registers. Then it sets the discriminator register to 0,
-and sets the basic\_block, prologue\_end and epilogue\_begin
+registers. Then it sets the \addtoindex{discriminator} register to 0,
+and sets the \addtoindex{basic\_block}, 
+\addtoindex{prologue\_end} and 
+\addtoindex{epilogue\_begin}
 registers to ``false.''
 
 \item \textbf{DW\-\_LNS\-\_advance\-\_pc} \\
 The \livetarg{chap:DWLNSadvancepc}{DW\-\_LNS\-\_advance\-\_pc} opcode takes a single unsigned LEB128
-operand as the operation advance and modifies the address
-and op\_index registers as specified in 
+operand as the \addtoindex{operation advance} and modifies the address
+and \addtoindex{op\_index} registers as specified in 
 Section \refersec{chap:specialopcodes}.
 
 \item \textbf{DW\-\_LNS\-\_advance\-\_line} \\
@@ -805,12 +905,15 @@ register of the state machine.
 
 \item \textbf{DW\-\_LNS\-\_negate\-\_stmt} \\
 The \livetarg{chap:DWLNSnegatestmt}{DW\-\_LNS\-\_negate\-\_stmt} opcode takes no
-operands. It sets the is\_stmt register of the state machine
+operands. It sets the \addtoindex{is\_stmt} register of the state machine
 to the logical negation of its current value.
 
 \item \textbf{DW\-\_LNS\-\_set\-\_basic\-\_block} \\
-The \livetarg{chap:DWLNSsetbasicblock}{DW\-\_LNS\-\_set\-\_basic\-\_block} opcode
-takes no operands. It sets the basic\_block register of the
+The \livetarg{chap:DWLNSsetbasicblock}{DW\-\_LNS\-\_set\-\_basic\-\_block}
+opcode
+\addtoindexx{basic block}
+takes no operands. 
+It sets the basic\_block register of the
 state machine to ``true.''
 
 
@@ -837,7 +940,7 @@ address register of the state machine and sets the op\_index
 register to 0. This is the only standard opcode whose operand
 is \textbf{not} a variable length number. It also does 
 \textbf{not} multiply the
-operand by the minimum\_instruction\_length field of the header.
+operand by the \addtoindex{minimum\_instruction\_length} field of the header.
 
 \textit{Existing assemblers cannot emit \livelink{chap:DWLNSadvancepc}{DW\-\_LNS\-\_advance\-\_pc} or special
 opcodes because they cannot encode LEB128 numbers or judge when
@@ -847,7 +950,8 @@ use \livelink{chap:DWLNSfixedadvancepc}{DW\-\_LNS\-\_fixed\-\_advance\-\_pc} ins
 
 \item \textbf{DW\-\_LNS\-\_set\-\_prologue\-\_end} \\
 The \livetarg{chap:DWLNSsetprologueend}{DW\-\_LNS\-\_set\-\_prologue\-\_end}
-opcode takes no operands. It sets the prologue\_end register
+opcode takes no operands. It sets the 
+\addtoindex{prologue\_end} register
 to ``true''.
 
 \textit{When a breakpoint is set on entry to a function, it is
@@ -864,7 +968,8 @@ the location(s) to use.}
 location; for example, the code might test for a special case
 and make a fast exit prior to setting up the frame.}
 
-\textit{Note that the function to which the prologue end applies cannot
+\textit{Note that the function to which the 
+\addtoindex{prologue end} applies cannot
 be directly determined from the line number information alone;
 it must be determined in combination with the subroutine
 information entries of the compilation (including inlined
@@ -873,7 +978,7 @@ subroutines).}
 
 \item \textbf{DW\-\_LNS\-\_set\-\_epilogue\-\_begin} \\
 The \livetarg{chap:DWLNSsetepiloguebegin}{DW\-\_LNS\-\_set\-\_epilogue\-\_begin} opcode takes no operands. It
-sets the epilogue\_begin register to ``true''.
+sets the \addtoindex{epilogue\_begin} register to ``true''.
 
 \textit{When a breakpoint is set on the exit of a function or execution
 steps over the last executable statement of a function, it is
@@ -883,18 +988,21 @@ local variables can still be examined). Debuggers generally
 cannot properly determine where this point is. This command
 allows a compiler to communicate the location(s) to use.}
 
-\textit{Note that the function to which the epilogue end applies cannot
+\textit{Note that the function to which the 
+\addtoindex{epilogue end} applies cannot
 be directly determined from the line number information alone;
 it must be determined in combination with the subroutine
 information entries of the compilation (including inlined
 subroutines).}
 
-\textit{In the case of a trivial function, both prologue end and
-epilogue begin may occur at the same address.}
+\textit{In the case of a trivial function, both 
+\addtoindex{prologue end} and
+\addtoindex{epilogue begin} may occur at the same address.}
 
 \item \textbf{DW\-\_LNS\-\_set\-\_isa} \\
 The \livetarg{chap:DWLNSsetisa}{DW\-\_LNS\-\_set\-\_isa} opcode takes a single
-unsigned LEB128 operand and stores that value in the isa
+unsigned LEB128 operand and stores that value in the 
+\addtoindex{isa}
 register of the state machine.
 \end{enumerate}
 
@@ -907,7 +1015,8 @@ The extended opcodes are as follows:
 
 \item \textbf{DW\-\_LNE\-\_end\-\_sequence} \\
 The \livetarg{chap:DWLNEendsequence}{DW\-\_LNE\-\_end\-\_sequence} opcode takes no operands. It sets the
-end\_sequence register of the state machine to “true” and
+\addtoindex{end\_sequence}
+register of the state machine to “true” and
 appends a row to the matrix using the current values of the
 state-machine registers. Then it resets the registers to the
 initial values specified above 
@@ -940,7 +1049,8 @@ path name of a source file. If the entry contains a file
 name or a relative path name, the file is located relative
 to either the compilation directory (as specified by the
 \livelink{chap:DWATcompdir}{DW\-\_AT\-\_comp\-\_dir} attribute given in the compilation unit)
-or one of the directories in the include\_directories section.
+or one of the directories in the 
+\addtoindex{include\_directories} section.
 
 \item An unsigned LEB128 number representing the directory index
 of the directory in which the file was found.  
@@ -955,10 +1065,11 @@ not available.
 \end{enumerate}
 
 The directory index represents an entry in the
-include\_directories section of the line number program
+\addtoindex{include\_directories} section of the line number program
 header. The index is 0 if the file was found in the current
 directory of the compilation, 1 if it was found in the first
-directory in the include\_directories section, and so on. The
+directory in the \addtoindex{include\_directories} section,
+and so on. The
 directory index is ignored for file names that represent full
 path names.
 
@@ -974,7 +1085,7 @@ in the file register of the state machine.
 The \livetarg{chap:DWLNEsetdiscriminator}{DW\-\_LNE\-\_set\-\_discriminator}
 opcode takes a single
 parameter, an unsigned LEB128 integer. It sets the
-discriminator register to the new value.
+\addtoindex{discriminator} register to the new value.
 
 
 
@@ -985,7 +1096,10 @@ gives some sample line number programs.}
 
 \section{Macro Information}
 \label{chap:macroinformation}
-\textit{Some languages, such as C and C++, provide a way to replace
+\textit{Some languages, such as 
+\addtoindex{C} and 
+addtoindex{C++}, provide a way to replace
+\addtoindex{macro information}
 text in the source program with macros defined either in the
 source file itself, or in another file included by the source
 file.  Because these macros are not themselves defined in the
@@ -996,7 +1110,9 @@ the macro definition has been expanded, rather than as the
 programmer wrote it. The macro information table provides a way
 of preserving the original source in the debugging information.}
 
-As described in Section 3.1.1, the macro information for a
+As described in 
+Section \refersec{chap:normalandpartialcompilationunitentries},
+the macro information for a
 given compilation unit is represented in the 
 \addtoindex{.debug\_macinfo}
 section of an object file. The macro information for each
@@ -1009,7 +1125,7 @@ code of 0.
 \subsection{Macinfo Types}
 \label{chap:macinfotypes}
 
-The valid macinfo types are as follows:
+The valid \addtoindex{macinfo types} are as follows:
 
 \begin{tabular}{ll}
 \livelink{chap:DWMACINFOdefine}{DW\-\_MACINFO\-\_define} 
@@ -1042,8 +1158,9 @@ symbol that was undefined at the indicated source line.
 
 In the case of a \livelink{chap:DWMACINFOdefine}{DW\-\_MACINFO\-\_define} entry, the value of this
 string will be the name of the macro symbol that was defined
-at the indicated source line, followed immediately by the macro
-formal parameter list including the surrounding parentheses (in
+at the indicated source line, followed immediately by the 
+\addtoindex{macro formal parameter list}
+including the surrounding parentheses (in
 the case of a function-like macro) followed by the definition
 string for the macro. If there is no formal parameter list,
 then the name of the defined macro is followed directly by
@@ -1153,6 +1270,7 @@ user on the command line.
 
 
 \textit{Debuggers often need to be able to view and modify the state of any subroutine activation that is
+\addtoindexx{activation!call frame}
 on the call stack. An activation consists of:}
 
 \begin{itemize}
@@ -1180,10 +1298,12 @@ across a call. If a callee wishes to use such a register, it
 saves the value that the register had at entry time in its call
 frame and restores it on exit. The code that allocates space
 on the call frame stack and performs the save operation is
-called the subroutine’s prologue, and the code that performs
+called the subroutine’s \addtoindex{prologue}, and the code that performs
 the restore operation and deallocates the frame is called its
-epilogue. Typically, the prologue code is physically at the
-beginning of a subroutine and the epilogue code is at the end.}
+\addtoindex{epilogue}. Typically, the 
+\addtoindex{prologue} code is physically at the
+beginning of a subroutine and the 
+\addtoindex{epilogue} code is at the end.}
 
 \textit{To be able to view or modify an activation that is not
 on the top of the call frame stack, the debugger must
@@ -1206,10 +1326,14 @@ special things.}
 
 \begin{itemize} % bullet list
 
-\item \textit{Prologue and epilogue code is not always in 
+\item \textit{Prologue 
+\addtoindexx{prologue}
+and 
+\addtoindex{epilogue} code is not always in 
 distinct block
 at the beginning and end of a subroutine. It is common
-to duplicate the epilogue code at the site of each return
+to duplicate the \addtoindex{epilogue} code 
+at the site of each return
 from the code. Sometimes a compiler breaks up the register
 save/unsave operations and moves them into the body of the
 subroutine to just where they are needed.}
@@ -1220,7 +1344,9 @@ frame. Sometimes they use a frame pointer register, sometimes
 not.}
 
 \item \textit{The algorithm to compute CFA changes as you progress through
-the prologue and epilogue code. (By definition, the CFA value
+the \addtoindex{prologue} 
+and \addtoindex{epilogue code}. 
+(By definition, the CFA value
 does not change.)}
 
 \item \textit{Some subroutines have no call frame.}
@@ -1337,7 +1463,10 @@ section called
 \addtoindex{.debug\_frame} section
 are aligned on a multiple of the address size relative to
 the start of the section and come in two forms: a Common
-Information Entry (CIE) and a Frame Description Entry (FDE).
+\addtoindexx{common information entry}
+Information Entry (CIE) and a 
+\addtoindexx{frame description entry}
+Frame Description Entry (FDE).
 
 \textit{If the range of code addresses for a function is not
 contiguous, there may be multiple CIEs and FDEs corresponding
@@ -1362,7 +1491,7 @@ integral multiple of the address size.
 A constant that is used to distinguish CIEs from FDEs.
 
 \item  version (ubyte) \\
-A version number 
+A version number\addtoindexx{version number!call frame information} 
 (see Section \refersec{datarep:callframeinformation}). 
 This number is specific to the call frame information
 and is independent of the DWARF version number.
@@ -1398,21 +1527,32 @@ UTF\dash 8 encoding.}
 The size of a target address
 \addtoindexx{address\_size}
 in this CIE and any FDEs that
+\addtoindexx{ubyte}
 use it, in bytes. If a compilation unit exists for this frame,
 its address size must match the address size here.
 
 \item  segment\_size (ubyte) \\
-The size of a segment selector in this CIE and any FDEs that
+The 
+\addtoindexx{segment\_size}
+size 
+\addtoindexx{ubyte}
+of a segment selector in this CIE and any FDEs that
 use it, in bytes.
 
-\item  code\_alignment\_factor (unsigned LEB128) \\
-A constant that is factored out of all advance location
+\item  \addtoindex{code\_alignment\_factor} (unsigned LEB128) \\
+\addtoindex{code alignment factor}
+A 
+\addtoindexx{\textless caf\textgreater|see{code alignment factor}}
+constant that is factored out of all advance location
 instructions (see 
 Section \refersec{chap:rowcreationinstructions}).
 
 
-\item  data\_alignment\_factor (signed LEB128) \\
-A constant that is factored out of certain offset instructions
+\item  \addtoindex{data\_alignment\_factor} (signed LEB128) \\
+\addtoindexx{data alignment factor}
+A 
+\addtoindexx{\textless daf\textgreater|see{data alignment factor}}
+constant that is factored out of certain offset instructions
 (see below). The resulting value is  \textit{(operand *
 data\_alignment\_factor)}.
 
@@ -1449,24 +1589,37 @@ plus the value of length must be an integral multiple of the
 address size.
 
 \item   CIE\_pointer (4 or 8 bytes, see Section \refersec{datarep:32bitand64bitdwarfformats}) \\
-A constant offset into the \addtoindex{.debug\_frame}
+A constant 
+\addtoindexx{section offset!in FDE header}
+offset into the \addtoindex{.debug\_frame}
 section that denotes
 the CIE that is associated with this FDE.
 
 \item  initial\_location (segment selector and target address) \\
-The address of the first location associated with this table
-entry. If the segment\_size field of this FDE's CIE is non-zero,
+The 
+\addtoindexx{initial\_location}
+address of the first location associated with this table
+entry. 
+If the \addtoindex{segment\_size} field of this FDE's CIE is non-zero,
 the initial location is preceded by a segment selector of
 the given length.
 
 \item  address\_range (target address) \\
-The number of bytes of program instructions described by this entry.
+The 
+\addtoindexx{address\_range}
+number 
+\addtoindexx{target address}
+of bytes of program instructions described by this entry.
 
 \item instructions (array of ubyte) \\
-A sequence of table defining instructions that are described below.
+A 
+\addtoindexx{ubyte}
+sequence of table defining instructions that are described below.
 
 \item 6. padding (array of ubyte) \\
-Enough \livelink{chap:DWCFAnop}{DW\-\_CFA\-\_nop} instructions to make the size of this
+Enough \livelink{chap:DWCFAnop}{DW\-\_CFA\-\_nop} instructions 
+to make the size of this
+\addtoindexx{ubyte}
 entry match the length value above.
 \end{enumerate}
 
@@ -1513,12 +1666,15 @@ and \livelink{chap:DWCFAvalexpression}{DW\-\_CFA\-\_val\-\_expression}.}
 \begin{enumerate}[1.]
 
 \item \textbf{DW\-\_CFA\-\_set\-\_loc} \\
-The \livetarg{chap:DWCFAsetloc}{DW\-\_CFA\-\_set\-\_loc} instruction takes a single operand that
+The \livetarg{chap:DWCFAsetloc}{DW\-\_CFA\-\_set\-\_loc} instruction 
+takes a single operand that
 represents a target address. The required action is to create a
 new table row using the specified address as the location. All
 other values in the new row are initially identical to the
 current row. The new location value is always greater than
-the current one. If the segment\_size field of this FDE's CIE
+the current one. 
+If the \addtoindex{segment\_size} field of this FDE's 
+\addtoindex{CIE}
 is non- zero, the initial location is preceded by a segment
 selector of the given length.
 
@@ -1529,7 +1685,8 @@ with the opcode) that represents a constant delta. The required
 action is to create a new table row with a location value that
 is computed by taking the current entry’s location value
 and adding the value of 
-\textit{delta * code\_alignment\_factor}. All
+\textit{delta * \addtoindex{code\_alignment\_factor}}. 
+All
 other values in the new row are initially identical to the
 current row
 
@@ -1569,7 +1726,7 @@ an unsigned LEB128 value representing a register number and a
 signed LEB128 factored offset. This instruction is identical
 to \livelink{chap:DWCFAdefcfa}{DW\-\_CFA\-\_def\-\_cfa} except that the second operand is signed
 and factored. The resulting offset is factored\_offset *
-data\_alignment\_factor.
+\addtoindex{data\_alignment\_factor}.
 
 
 \item \textbf{DW\-\_CFA\-\_def\-\_cfa\-\_register} \\
@@ -1596,12 +1753,15 @@ The \livetarg{chap:DWCFAdefcfaoffsetsf}{DW\-\_CFA\-\_def\-\_cfa\-\_offset\-\_sf}
 LEB128 operand representing a factored offset. This instruction
 is identical to \livelink{chap:DWCFAdefcfaoffset}{DW\-\_CFA\-\_def\-\_cfa\-\_offset} except that the
 operand is signed and factored. The resulting offset is
-factored\_offset * data\_alignment\_factor. This operation
+factored\_offset * \addtoindex{data\_alignment\_factor}.
+This operation
 is valid only if the current CFA rule is defined to use a
 register and offset.
 
 \item \textbf{DW\-\_CFA\-\_def\-\_cfa\-\_expression} \\
-The \livetarg{chap:DWCFAdefcfaexpression}{DW\-\_CFA\-\_def\-\_cfa\-\_expression} instruction takes a single
+The \livetarg{chap:DWCFAdefcfaexpression}{DW\-\_CFA\-\_def\-\_cfa\-\_expression} instruction takes a 
+\addtoindexx{exprloc class}
+single
 operand encoded as a \livelink{chap:DWFORMexprloc}{DW\-\_FORM\-\_exprloc} value representing a
 DWARF expression. The required action is to establish that
 expression as the means by which the current CFA is computed.
@@ -1635,7 +1795,7 @@ constant representing a factored offset. The required action
 is to change the rule for the register indicated by the
 register number to be an offset(N) rule where the value of
 N is 
-\textit{factored offset * data\_alignment\_factor.}
+\textit{factored offset * \addtoindex{data\_alignment\_factor}}.
 
 \item \textbf{DW\-\_CFA\-\_offset\-\_extended} \\
 The \livetarg{chap:DWCFAoffsetextended}{DW\-\_CFA\-\_offset\-\_extended} instruction takes two unsigned
@@ -1649,7 +1809,7 @@ an unsigned LEB128 value representing a register number and a
 signed LEB128 factored offset. This instruction is identical
 to \livelink{chap:DWCFAoffsetextended}{DW\-\_CFA\-\_offset\-\_extended} except that the second operand is
 signed and factored. The resulting offset is 
-\textit{factored\_offset * data\_alignment\_factor}.
+\textit{factored\_offset * \addtoindex{data\_alignment\_factor}}.
 
 \item \textbf{DW\-\_CFA\-\_val\-\_offset} \\
 The \livetarg{chap:DWCFAvaloffset}{DW\-\_CFA\-\_val\-\_offset} instruction takes two unsigned
@@ -1657,7 +1817,7 @@ LEB128 operands representing a register number and a
 factored offset. The required action is to change the rule
 for the register indicated by the register number to be a
 val\_offset(N) rule where the value of N is 
-\textit{factored\_offset * data\_alignment\_factor}.
+\textit{factored\_offset * \addtoindex{data\_alignment\_factor}}.
 
 \item \textbf{DW\-\_CFA\-\_val\-\_offset\-\_sf} \\
 The \livetarg{chap:DWCFAvaloffsetsf}{DW\-\_CFA\-\_val\-\_offset\-\_sf} instruction takes two operands: an
@@ -1665,7 +1825,7 @@ unsigned LEB128 value representing a register number and a
 signed LEB128 factored offset. This instruction is identical
 to \livelink{chap:DWCFAvaloffset}{DW\-\_CFA\-\_val\-\_offset} except that the second operand is signed
 and factored. The resulting offset is 
-\textit{factored\_offset * data\_alignment\_factor}.
+\textit{factored\_offset * \addtoindex{data\_alignment\_factor}}.
 
 \item \textbf{DW\-\_CFA\-\_register} \\
 The \livetarg{chap:DWCFAregister}{DW\-\_CFA\-\_register} instruction takes two unsigned LEB128
@@ -1727,7 +1887,8 @@ encoding and size of the register operand.
 
 \textit{The next two instructions provide the ability to stack and
 retrieve complete register states. They may be useful, for
-example, for a compiler that moves epilogue code into the
+example, for a compiler that moves \addtoindex{epilogue} code 
+into the
 body of a function.}