Complete work on live links, cleanup some indexing and redo pagination.
[dwarf-doc.git] / dwarf5 / latexdoc / otherdebugginginformation.tex
1 \chapter{Other Debugging Information}
2 \label{chap:otherdebugginginformation}
3 % references to chapter 7 look like  {datarep:...}
4 This section describes debugging information that is not
5 represented in the form of debugging information entries and
6 is not contained within a \dotdebuginfo{} or 
7 \dotdebugtypes{} section.
8
9 In the descriptions that follow, these terms are used to
10 specify the representation of DWARF sections:
11 \begin{itemize}
12 \item
13 Initial length, section offset and 
14 \addtoindex{section length}, which are
15 defined in 
16 Sections \refersec{datarep:locationdescriptions} and 
17 \refersec{datarep:32bitand64bitdwarfformats}.
18 \item
19 Sbyte, 
20 \addtoindex{ubyte}, 
21 \addtoindex{uhalf}, and 
22 \addtoindex{uword}, 
23 which 
24 \addtoindexx{sbyte}
25 are defined in 
26 Section \refersec{datarep:integerrepresentationnames}.
27 \end{itemize}
28
29 \section{Accelerated Access}
30 \label{chap:acceleratedaccess}
31
32 \textit{A debugger frequently needs to find the debugging information
33 \addtoindexx{accelerated access}
34 for a program entity defined outside of the compilation unit
35 where the debugged program is currently stopped. Sometimes the
36 debugger will know only the name of the entity; sometimes only
37 the address. To find the debugging information associated with
38 a global entity by name, using the DWARF debugging information
39 entries alone, a debugger would need to run through all
40 entries at the highest scope within each compilation unit.}
41
42 \textit{Similarly, in languages in which the name of a type is
43 required to always refer to the same concrete type (such as
44 C++), a compiler may choose to elide type definitions in
45 all compilation units except one. In this case a debugger
46 needs a rapid way of locating the concrete type definition
47 by name. As with the definition of global data objects, this
48 would require a search of all the top level type definitions
49 of all compilation units in a program.}
50
51 \textit{To find the debugging information associated with a subroutine,
52 given an address, a debugger can use the low and high pc
53 attributes of the compilation unit entries to quickly narrow
54 down the search, but these attributes only cover the range
55 of addresses for the text associated with a compilation unit
56 entry. To find the debugging information associated with a
57 data object, given an address, an exhaustive search would be
58 needed. Furthermore, any search through debugging information
59 entries for different compilation units within a large program
60 would potentially require the access of many memory pages,
61 probably hurting debugger performance.}
62
63 To make lookups of program entities (data objects, functions
64 and types) by name or by address faster, a producer of DWARF
65 information may provide three different types of tables
66 containing information about the debugging information
67 entries owned by a particular compilation unit entry in a
68 more condensed format.
69
70 \subsection{Lookup by Name}
71
72 For lookup by name, 
73 \addtoindexx{lookup!by name}
74 two tables are maintained in separate
75 \addtoindexx{accelerated access!by name}
76 object file sections named 
77 \dotdebugpubnames{} for objects and
78 functions, and 
79 \dotdebugpubtypes{}
80 for types. Each table consists
81 of sets of variable length entries. Each set describes the
82 names of global objects and functions, or global types,
83 respectively, whose definitions are represented by debugging
84 information entries owned by a single compilation unit.
85
86 \textit{C++ member functions with a definition in the class declaration
87 are definitions in every compilation unit containing the
88 class declaration, but if there is no concrete out\dash of\dash line
89 instance there is no need to have a 
90 \dotdebugpubnames{} entry
91 for the member function.}
92
93 Each set begins with a header containing four values:
94 \begin{enumerate}[1. ]
95
96 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length}) \\
97 \addtoindexx{unit\_length}
98 The total length of the all of the entries for that set,
99 not including the length field itself 
100 (see Section \refersec{datarep:initiallengthvalues}).
101
102 \item  version (\addtoindex{uhalf}) \\
103 A version number
104 \addtoindexx{version number!name lookup table}
105 \addtoindexx{version number!type lookup table} 
106 (see Section \refersec{datarep:namelookuptables}). 
107 This number is specific
108 to the name lookup table and is independent of the DWARF
109 version number.
110
111 \item debug\_info\_offset (section offset) \\
112 The 
113 \addtoindexx{section offset!in .debug\_pubtypes header}
114 offset 
115 \addtoindexx{section offset!in .debug\_pubtypes header}
116 from the beginning of the 
117 \dotdebuginfo{} section of
118 the compilation unit header referenced by the set.
119
120 \item debug\_info\_length (section length) \\
121 \addtoindexx{section length!in .debug\_pubnames header}
122 The 
123 \addtoindexx{section length!in .debug\_pubtypes header}
124 size in bytes of the contents of the 
125 \dotdebuginfo{} section
126 generated to represent that compilation unit.
127 \end{enumerate}
128
129 This header is followed by a variable number of offset/name
130 pairs. Each pair consists of the section offset from the
131 beginning of the compilation unit corresponding to the current
132 set to the debugging information entry for the given object,
133 followed by a null\dash terminated character string representing
134 the name of the object as given by the \livelink{chap:DWATname}{DW\_AT\_name} attribute
135 of the referenced debugging information entry. Each set of
136 names is terminated by an offset field containing zero (and
137 no following string).
138
139
140 In the case of the name of a function member or static data
141 member of a C++ structure, class or union, the name presented
142 in the 
143 \dotdebugpubnames{} 
144 section is not the simple name given
145 by the \livelink{chap:DWATname}{DW\_AT\_name} attribute of the referenced debugging
146 information entry, but rather the fully qualified name of
147 the data or function member.
148
149 \subsection{Lookup by Address}
150
151 For 
152 \addtoindexx{lookup!by address}
153 lookup by address, a table is maintained in a separate
154 \addtoindexx{accelerated access!by address}
155 object file section called 
156 \dotdebugaranges{}. The table consists
157 of sets of variable length entries, each set describing the
158 portion of the program\textquoteright s address space that is covered by
159 a single compilation unit.
160
161 Each set begins with a header containing five values:
162 \begin{enumerate}[1. ]
163 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length}) \\
164 \addttindexx{unit\_length}
165 The total length of all of the
166 entries for that set, not including the length field itself
167 (see Section \refersec{datarep:initiallengthvalues}).
168
169 \item version (\addtoindex{uhalf}) \\
170 A version number\addtoindexx{version number!address lookup table} 
171 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
172 This number is specific to the address lookup table and is
173 independent of the DWARF version number.
174
175 \item debug\_info\_offset (section offset) \\
176 The offset from the
177 \addtoindexx{section offset!in .debug\_pubnames header}
178 beginning of the \dotdebuginfo{} or 
179 \dotdebugtypes{} section of the
180 compilation unit header referenced by the set.
181
182 \item address\_size (\addtoindex{ubyte}) \\
183 The \addtoindex{size of an address}
184 in bytes on
185 \addtoindexx{address\_size}
186 the target architecture. For 
187 \addtoindexx{address space!segmented}
188 segmented addressing, this is
189 the size of the offset portion of the address.
190
191 \item segment\_size (\addtoindex{ubyte}) \\
192 The size of a segment selector in
193 \addtoindexx{segment\_size}
194 bytes on the target architecture. If the target system uses
195 a flat address space, this value is 0.
196
197 \end{enumerate}
198
199
200 This header is followed by a variable number of address range
201 descriptors. Each descriptor is a triple consisting of a
202 segment selector, the beginning address within that segment
203 of a range of text or data covered by some entry owned by
204 the corresponding compilation unit, followed by the non\dash zero
205 length of that range. A particular set is terminated by an
206 entry consisting of three zeroes. 
207 When the 
208 \addtoindex{segment\_size} value
209 is zero in the header, the segment selector is omitted so that
210 each descriptor is just a pair, including the terminating
211 entry. By scanning the table, a debugger can quickly decide
212 which compilation unit to look in to find the debugging
213 information for an object that has a given address.
214
215 \textit{If the range of addresses covered by the text and/or data
216 of a compilation unit is not contiguous, then there may be
217 multiple address range descriptors for that compilation unit.}
218
219
220
221
222 \section{Line Number Information}
223 \label{chap:linenumberinformation}
224 \textit{A source\dash level debugger will need to know how to
225 \addtoindexx{line number information|see{\textit{also} statement list attribute}}
226 associate locations in the source files with the corresponding
227 machine instruction addresses in the executable object or
228 the shared objects used by that executable object. Such an
229 association would make it possible for the debugger user
230 to specify machine instruction addresses in terms of source
231 locations. This would be done by specifying the line number
232 and the source file containing the statement. The debugger
233 can also use this information to display locations in terms
234 of the source files and to single step from line to line,
235 or statement to statement.}
236
237 Line number information generated for a compilation unit is
238 represented in the 
239 \dotdebugline{} section of an object file and
240 is referenced by a corresponding compilation unit debugging
241 information entry 
242 (see Section \refersec{chap:normalandpartialcompilationunitentries}) 
243 in the \dotdebuginfo{}
244 section.
245
246 \textit{Some computer architectures employ more than one instruction
247 set (for example, the ARM 
248 \addtoindexx{ARM instruction set architecture}
249 and 
250 MIPS architectures support
251 \addtoindexx{MIPS instruction set architecture}
252 a 32\dash bit as well as a 16\dash bit instruction set). Because the
253 instruction set is a function of the program counter, it is
254 convenient to encode the applicable instruction set in the
255 \dotdebugline{} section as well.}
256
257 \textit{If space were not a consideration, the information provided
258 in the \dotdebugline{} 
259 section could be represented as a large
260 matrix, with one row for each instruction in the emitted
261 object code. The matrix would have columns for:}
262 \begin{itemize}
263 \item \textit{the source file name}
264 \item \textit{the source line number}
265 \item \textit{the source column number}
266 \item \textit{whether this instruction is the beginning of a source statement}
267 \item \textit{whether this instruction is the beginning of a \addtoindex{basic block}}
268 \item \textit{and so on}
269 \end{itemize}
270 \textit{Such a matrix, however, would be impractically large. We
271 shrink it with two techniques. First, we delete from
272 the matrix each row whose file, line, source column and
273 \addtoindex{discriminator} information 
274 is identical with that of its
275 predecessors. Any deleted row would never be the beginning of
276 a source statement. Second, we design a byte\dash coded language
277 for a state machine and store a stream of bytes in the object
278 file instead of the matrix. This language can be much more
279 compact than the matrix. When a consumer of the line number
280 information executes, it must ``run'' the state machine
281 to generate the matrix for each compilation unit it is
282 interested in.  The concept of an encoded matrix also leaves
283 room for expansion. In the future, columns can be added to the
284 matrix to encode other things that are related to individual
285 instruction addresses.}
286
287 \textit{When the set of addresses of a compilation unit cannot be
288 described as a single contiguous range, there will be a
289 separate matrix for each contiguous subrange.}
290
291 \subsection{Definitions}
292
293 The following terms are used in the description of the line
294 number information format:
295
296
297 \begin{longtable} {lp{9cm}}
298 state machine &
299 The hypothetical machine used by a consumer of the line number
300 information to expand the byte\dash coded 
301 instruction stream into a matrix of
302 line number information. \\
303
304 line number program &
305 A series of byte\dash coded 
306 line number information instructions representing
307 one compilation unit. \\
308
309 \addtoindex{basic block} &
310  A sequence of instructions where only the first instruction may be a
311 branch target and only the last instruction may transfer control. A
312 procedure invocation is defined to be an exit from a 
313 \addtoindex{basic block}.
314
315 \textit{A \addtoindex{basic block} does not 
316 necessarily correspond to a specific source code
317 construct.} \\
318
319 sequence &
320 A series of contiguous target machine instructions. One compilation unit
321 may emit multiple sequences (that is, not all instructions within a
322 compilation unit are assumed to be contiguous). \\
323 \end{longtable}
324
325 \subsection{State Machine Registers}
326 \label{chap:statemachineregisters}
327
328 The line number information state machine has the following 
329 registers:
330 \begin{longtable}{l|p{9cm}}
331   \caption{State Machine Registers } \\
332   \hline \bfseries Register name&\bfseries Meaning\\ \hline
333 \endfirsthead
334   \bfseries Register name&\bfseries Meaning\\ \hline
335 \endhead
336   \hline \emph{Continued on next page}
337 \endfoot
338   \hline
339 \endlastfoot
340 \addtoindexi{\texttt{address}}{address register!in line number machine}&
341 The program\dash counter value corresponding to a machine instruction
342 generated by the compiler. \\
343
344 \addttindex{op\_index} &
345 An unsigned integer representing the index of an operation within a VLIW
346 instruction. The index of the first operation is 0. For non\dash VLIW
347 architectures, this register will always be 0.
348
349 The \texttt{address} and \addttindex{op\_index} registers,
350 taken together, form an operation
351 pointer that can reference any individual operation within the instruction
352 stream. \\
353
354
355 \addttindex{file} &
356 An unsigned integer indicating the identity of the source file
357 corresponding to a machine instruction. \\
358
359 \addttindex{line} &
360 An unsigned integer indicating a source line number. Lines are numbered
361 beginning at 1. The compiler may emit the value 0 in cases where an
362 instruction cannot be attributed to any source line. \\
363
364 \addttindex{column} &
365 An unsigned integer indicating a column number within a source line.
366 Columns are numbered beginning at 1. The value 0 is reserved to indicate
367 that a statement begins at the ``left edge'' of the line. \\
368
369 \addttindex{is\_stmt} &
370 A boolean indicating that the current instruction is a recommended
371 breakpoint location. A recommended breakpoint location 
372 is intended to \doublequote{represent} a line, a 
373 statement and/or a semantically distinct subpart of a
374 statement. \\
375
376 \addttindex{basic\_block}  &
377 A boolean indicating that the current instruction is the beginning of a
378 \addtoindex{basic block}. \\
379
380 \addttindex{end\_sequence} &
381 A boolean indicating that the current address is that of the first byte after
382 the end of a sequence of target machine instructions. 
383 \addttindex{end\_sequence}
384 terminates a sequence of lines; therefore other information in the same
385 row is not meaningful. \\
386
387 \addttindex{prologue\_end} &
388 A boolean indicating that the current address is one (of possibly many)
389 where execution should be suspended for an entry breakpoint of a
390 function. \\
391
392 \addttindex{epilogue\_begin} &
393 A boolean indicating that the current address is one (of possibly many)
394 where execution should be suspended for an exit breakpoint of a function. \\
395
396 \addttindex{isa} &
397 An unsigned integer whose value encodes the applicable
398 instruction set architecture for the current instruction.
399
400 \textit{The encoding of instruction sets should be shared by all
401 users of a given architecture. It is recommended that this
402 encoding be defined by the ABI authoring committee for each
403 architecture.} \\
404
405 \addttindex{discriminator} &
406 An unsigned integer identifying the block to which the
407 current instruction belongs. Discriminator values are assigned
408 arbitrarily by the DWARF producer and serve to distinguish
409 among multiple blocks that may all be associated with the
410 same source file, line, and column. Where only one block
411 exists for a given source position, the discriminator value
412 should be zero. \\
413 \end{longtable}
414
415 \clearpage      % Keep this sentence with the following table
416 At the beginning  of each sequence within a line number
417 program, the state of the registers is:
418 \begin{center}
419 \begin{tabular}{lp{9.5cm}}
420 \texttt{address} & 0 \\
421 \addttindex{op\_index} & 0 \\
422 \texttt{file} & 1 \\
423 \texttt{line} & 1 \\
424 \texttt{column} & 0 \\
425 \addttindex{is\_stmt} & determined by \addttindex{default\_is\_stmt} 
426                                                                         in the line number program header \\
427 \addttindex{basic\_block}    & \doublequote{false} \addtoindexx{basic block} \\
428 \addttindex{end\_sequence}   & \doublequote{false} \\
429 \addttindex{prologue\_end}   & \doublequote{false} \\
430 \addttindex{epilogue\_begin} & \doublequote{false} \\
431 \addttindex{isa} & 0 \\
432 \addttindex{discriminator} & 0 \\
433 \end{tabular}
434 \end{center}
435
436 \textit{The 
437 \addttindex{isa} value 0 specifies that the instruction set is the
438 architecturally determined default instruction set. This may
439 be fixed by the ABI, or it may be specified by other means,
440 for example, by the object file description.}
441 \subsection{Line Number Program Instructions}
442 The state machine instructions in a line number program belong to one of three categories:
443
444 \begin{enumerate}[1. ]
445 \item special opcodes \\
446 These have a \addtoindex{ubyte} opcode field and no operands.\vspace{1ex}
447
448 \textit{Most of the instructions in a 
449 line number program are special opcodes.}
450
451 \item standard opcodes \\
452 These have a \addtoindex{ubyte} opcode field which may be followed by zero or more
453 \addtoindex{LEB128} operands (except for 
454 \mbox{\livelink{chap:DWLNSfixedadvancepc}{DW\_LNS\_fixed\_advance\_pc},} see below).
455 The opcode implies the number of operands and their meanings, but the
456 line number program header also specifies the number of operands for
457 each standard opcode.
458
459 \needlines{6}
460 \item extended opcodes \\
461 These have a multiple byte format. The first byte is zero; the next bytes
462 are an unsigned LEB128\addtoindexx{LEB128!unsigned} integer giving the number of bytes in the
463 instruction itself (does not include the first zero byte or the size). The
464 remaining bytes are the instruction itself (which begins with a \addtoindex{ubyte}
465 extended opcode). \\
466 \end{enumerate}
467
468
469 \subsection{The Line Number Program Header}
470
471 The optimal encoding of line number information depends to a
472 certain degree upon the architecture of the target machine. The
473 line number program header provides information used by
474 consumers in decoding the line number program instructions for
475 a particular compilation unit and also provides information
476 used throughout the rest of the line number program.
477
478 The line number program for each compilation unit begins with
479 a header containing the following fields in order:
480
481 \begin{enumerate}[1. ]
482 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length})  \\
483 \addttindexx{unit\_length}
484 The size in bytes of the line number information for this
485 compilation unit, not including the length field itself
486 (see Section \refersec{datarep:initiallengthvalues}). 
487
488 \item \texttt{version} (\addtoindex{uhalf}) \\
489 A version number\addtoindexx{version number!line number information} 
490 (see Appendix \refersec{datarep:linenumberinformation}). 
491 This number is specific to
492 the line number information and is independent of the DWARF
493 version number. 
494
495 \item \texttt{header\_length}  \\
496 The number of bytes following the \addttindex{header\_length} field to the
497 beginning of the first byte of the line number program itself.
498 In the \thirtytwobitdwarfformat, this is a 4\dash byte unsigned
499 length; in the \sixtyfourbitdwarfformat, this field is an
500 8\dash byte unsigned length 
501 (see Section \refersec{datarep:32bitand64bitdwarfformats}). 
502
503 \item \texttt{minimum\_instruction\_length} (\addtoindex{ubyte})  \\
504 \addttindexx{minimum\_instruction\_length}
505 The size in bytes of the smallest target machine
506 instruction. Line number program opcodes that alter
507 the \texttt{address} and \addttindex{op\_index}
508 registers use this and
509 \addttindex{maximum\_operations\_per\_instruction}
510 (see following) in their calculations. 
511
512 \needlines{9}
513 \item \texttt{maximum\_operations\_per\_instruction} (\addtoindex{ubyte}) \\
514 The 
515 \addttindexx{maximum\_operations\_per\_instruction}
516 maximum number of individual operations that may be
517 encoded in an instruction. Line number program opcodes
518 that alter the \texttt{address} and 
519 \addttindex{op\_index} registers use this and
520 \addttindex{minimum\_instruction\_length} (see preceeding)
521 in their calculations.
522
523 For non-VLIW
524 architectures, this field is 1, the \addttindex{op\_index} register is always
525 0, and the operation pointer is simply the \texttt{address} register.
526
527 \needlines{4}
528 \item \texttt{default\_is\_stmt} (\addtoindex{ubyte}) \\
529 \addttindexx{default\_is\_stmt}
530 The initial value of the \addttindex{is\_stmt} register.  
531
532 \textit{A simple approach
533 to building line number information when machine instructions
534 are emitted in an order corresponding to the source program
535 is to set \addttindex{default\_is\_stmt}
536 to ``true'' and to not change the
537 value of the \addttindex{is\_stmt} register 
538 within the line number program.
539 One matrix entry is produced for each line that has code
540 generated for it. The effect is that every entry in the
541 matrix recommends the beginning of each represented line as
542 a breakpoint location. This is the traditional practice for
543 unoptimized code.}
544
545 \textit{A more sophisticated approach might involve multiple entries in
546 the matrix for a line number; in this case, at least one entry
547 (often but not necessarily only one) specifies a recommended
548 breakpoint location for the line number. \livelink{chap:DWLNSnegatestmt}{DW\_LNS\_negate\_stmt}
549 opcodes in the line number program control which matrix entries
550 constitute such a recommendation and 
551 \addttindex{default\_is\_stmt} might
552 be either ``true'' or ``false''. This approach might be
553 used as part of support for debugging optimized code.}
554
555 \item \texttt{line\_base} (\addtoindex{sbyte}) \\
556 \addttindexx{line\_base}
557 This parameter affects the meaning of the special opcodes. See below.
558
559 \item \texttt{line\_range} (\addtoindex{ubyte}) \\
560 \addttindexx{line\_range}
561 This parameter affects the meaning of the special opcodes. See below.
562
563 \item \texttt{opcode\_base} (\addtoindex{ubyte}) \\
564 The 
565 \addttindexx{opcode\_base}
566 number assigned to the first special opcode.
567
568 \textit{Opcode base is typically one greater than the highest-numbered
569 \addttindexx{opcode\_base}
570 standard opcode defined for the specified version of the line
571 number information (12 in 
572 \addtoindex{DWARF Version 3} and 
573 \addtoindexx{DWARF Version 4}
574 Version 4, 9 in
575 \addtoindexx{DWARF Version 2}
576 Version 2).  
577 If opcode\_base is less than the typical value,
578 \addttindexx{opcode\_base}
579 then standard opcode numbers greater than or equal to the
580 opcode base are not used in the line number table of this unit
581 (and the codes are treated as special opcodes). If \texttt{opcode\_base}
582 is greater than the typical value, then the numbers between
583 that of the highest standard opcode and the first special
584 opcode (not inclusive) are used for vendor specific extensions.}
585
586 \item \texttt{standard\_opcode\_lengths} (array of \addtoindex{ubyte}) \\
587 \addttindexx{standard\_opcode\_lengths}
588 This array specifies the number of \addtoindex{LEB128} operands for each
589 of the standard opcodes. The first element of the array
590 corresponds to the opcode whose value is 1, and the last
591 element corresponds to the opcode whose value 
592 is \texttt{opcode\_base - 1}.
593
594 \textit{By increasing \texttt{opcode\_base}, and adding elements to this array,
595 \addttindexx{opcode\_base}
596 new standard opcodes can be added, while allowing consumers who
597 do not know about these new opcodes to be able to skip them.}
598
599 \textit{Codes for vendor specific extensions, if any, are described
600 just like standard opcodes.}
601
602 \needlines{3}
603 \item \texttt{include\_directories} (sequence of path names) \\
604 Entries 
605 \addttindexx{include\_directories}
606 in this sequence describe each path that was searched
607 for included source files in this compilation. (The paths
608 include those directories specified explicitly by the user for
609 the compiler to search and those the compiler searches without
610 explicit direction.) Each path entry is either a full path name
611 or is relative to the current directory of the compilation.
612
613 The last entry is followed by a single null byte.
614
615 The line number program assigns numbers to each of the file
616 entries in order, beginning with 1. The current directory of
617 the compilation is understood to be the zeroth entry and is
618 not explicitly represented.
619
620 \item  \texttt{file\_names} (sequence of file entries) \\
621 Entries 
622 \addtoindexx{file names}
623 in 
624 \addttindexx{file\_names}
625 this sequence describe source files that contribute
626 to the line number information for this compilation unit or is
627 used in other contexts, such as in a 
628 \livelinki{chap:declarationcoordinates}{declaration coordinate}{declaration coordinates} or
629 a macro file inclusion. Each entry consists of the following
630 values:
631
632
633 \begin{itemize}
634 \item A null\dash terminated string containing the full or relative
635 path name of a source file. If the entry contains a file
636 name or relative path name, the file is located relative
637 to either the compilation directory (as specified by the
638 \livelink{chap:DWATcompdir}{DW\_AT\_comp\_dir} 
639 attribute given in the compilation unit) or one
640 of the directories listed in the 
641 \addttindex{include\_directories} section.
642
643 \item An unsigned LEB128\addtoindexx{LEB128!unsigned} 
644 number representing the directory
645 index of a directory in the 
646 \addttindex{include\_directories} section.
647
648
649 \item An unsigned LEB128\addtoindexx{LEB128!unsigned}
650 number representing the
651 (implementation\dash defined) time of last modification for
652 the file, or 0 if not available.
653
654 \item An unsigned LEB128\addtoindexx{LEB128!unsigned} 
655 number representing the length in
656 bytes of the file, or 0 if not available.  
657
658 \end{itemize}
659
660 The last entry is followed by a single null byte.
661
662 The directory index represents an entry in the
663 \addttindex{include\_directories} section. 
664 The index is 0 if the file was
665 found in the current directory of the compilation, 1 if it
666 was found in the first directory in the 
667 \addttindex{include\_directories}
668 section, and so on. The directory index is ignored for file
669 names that represent full path names.
670
671 The primary source file is described by an entry whose path
672 name exactly matches that given in the \livelink{chap:DWATname}{DW\_AT\_name} attribute
673 in the compilation unit, and whose directory is understood
674 to be given by the implicit entry with index 0.
675
676 The line number program assigns numbers to each of the file
677 entries in order, beginning with 1, and uses those numbers
678 instead of file names in the file register.
679
680 \textit{A compiler may generate a single null byte for the file
681 names field and define file names using the extended opcode
682 \livelink{chap:DWLNEdefinefile}{DW\_LNE\_define\_file}.}
683
684
685 \end{enumerate}
686
687 \subsection{The Line Number Program}
688
689 As stated before, the goal of a line number program is to build
690 a matrix representing one compilation unit, which may have
691 produced multiple sequences of target machine instructions.
692 Within a sequence, addresses 
693 \addtoindexx{operation pointer}
694 (operation pointers) may only
695 increase. (Line numbers may decrease in cases of pipeline
696 scheduling or other optimization.)
697
698 \subsubsection{Special Opcodes} 
699 \label{chap:specialopcodes}
700 Each \addtoindex{ubyte} special opcode has the following effect on the state machine:
701
702 \begin{enumerate}[1. ]
703
704 \item  Add a signed integer to the \texttt{line} register.
705
706 \item  Modify the \addtoindex{operation pointer} by incrementing the
707 \texttt{address} and \addttindex{op\_index} registers as described below.
708
709 \item  Append a row to the matrix using the current values
710 of the state machine registers.
711
712 \item  Set the \addttindex{basic\_block} register to \doublequote{false.} \addtoindexx{basic block}
713 \item  Set the \addttindex{prologue\_end} register to \doublequote{false.}
714 \item  Set the \addttindex{epilogue\_begin} register to \doublequote{false.}
715 \item  Set the \addttindex{discriminator} register to 0.
716
717 \end{enumerate}
718
719 All of the special opcodes do those same seven things; they
720 differ from one another only in what values they add to the
721 \texttt{line}, \texttt{address} and \addttindex{op\_index} registers.
722
723
724 \textit{Instead of assigning a fixed meaning to each special opcode,
725 the line number program uses several parameters in the header
726 to configure the instruction set. There are two reasons
727 for this.  First, although the opcode space available for
728 special opcodes now ranges from 13 through 255, the lower
729 bound may increase if one adds new standard opcodes. Thus, the
730 \texttt{opcode\_base} field of the line number program header gives the
731 value of the first special opcode. Second, the best choice of
732 special\dash opcode meanings depends on the target architecture. For
733 example, for a RISC machine where the compiler\dash generated code
734 interleaves instructions from different lines to schedule
735 the pipeline, it is important to be able to add a negative
736 value to the \texttt{line} register to express the fact that a later
737 instruction may have been emitted for an earlier source
738 line. For a machine where pipeline scheduling never occurs,
739 it is advantageous to trade away the ability to decrease
740 the \texttt{line} register (a standard opcode provides an alternate
741 way to decrease the line number) in return for the ability
742 to add larger positive values to the \texttt{address} register. To
743 permit this variety of strategies, the line number program
744 header defines a 
745 \addttindex{line\_base}
746 field that specifies the minimum
747 value which a special opcode can add to the line register
748 and a 
749 \addttindex{line\_range}
750 field that defines the range of values it
751 can add to the line register.}
752
753
754 A special opcode value is chosen based on the amount that needs
755 to be added to the \texttt{line}, \texttt{address} and \addttindex{op\_index} registers.
756 The maximum line increment for a special opcode is the value
757 of the 
758 \addttindex{line\_base}
759 field in the header, plus the value of the 
760 \addttindex{line\_range} field, minus 1 (line base + 
761 line range - 1). 
762 If the desired line increment is greater than the maximum
763 line increment, a standard opcode must be used instead of a
764 special opcode. The \addtoindex{operation advance} represents the number
765 of operations to skip when advancing the \addtoindex{operation pointer}.
766
767 The special opcode is then calculated using the following formula:
768 \begin{alltt}
769   opcode = 
770     (\textit{desired line increment} - \addttindex{line\_base}) +
771       (\addttindex{line\_range} * \textit{operation advance}) + \addttindex{opcode\_base}
772 \end{alltt}
773 If the resulting opcode is greater than 255, a standard opcode
774 must be used instead.
775
776 \textit{When \addttindex{maximum\_operations\_per\_instruction} is 1, 
777 the operation advance is simply the address increment divided by the
778 \addttindex{minimum\_instruction\_length}.}
779
780 \needlines{6}
781 To decode a special opcode, subtract the \addttindex{opcode\_base} from
782 the opcode itself to give the \textit{adjusted opcode}. 
783 The \textit{operation advance} 
784 is the result of the adjusted opcode divided by the
785 \texttt{line\_range}. The new \texttt{address} and 
786 \addttindex{op\_index} values are given by
787 \begin{alltt}
788   \textit{adjusted opcode} = opcode \dash opcode\_base
789   \textit{operation advance} = \textit{adjusted opcode} / line\_range
790
791   new address = address +
792     \addttindex{minimum\_instruction\_length} *
793       ((\addttindex{op\_index} + \addtoindex{operation advance}) / \addttindex{maximum\_operations\_per\_instruction})
794
795   new op\_index =
796     (\addttindex{op\_index} + \addtoindex{operation advance}) \% \addttindex{maximum\_operations\_per\_instruction}
797 \end{alltt}
798
799 \textit{When the \addttindex{maximum\_operations\_per\_instruction} field is 1,
800 \texttt{op\_index} is always 0 and these calculations simplify to those
801 given for addresses in 
802 \addtoindex{DWARF Version 3}.}
803
804 The amount to increment the line register is the 
805 \addttindex{line\_base} plus
806 the result of the 
807 \textit{\addtoindex{adjusted opcode}} modulo the 
808 \addttindex{line\_range}. That
809 is,
810
811 \begin{alltt}
812   line increment = \addttindex{line\_base} + (\textit{adjusted opcode} \% \addttindex{line\_range})
813 \end{alltt}
814
815 \textit{As an example, suppose that the opcode\_base is 13, 
816 \addttindex{line\_base} is -3, 
817 \addttindex{line\_range} is 12, 
818 \addttindex{minimum\_instruction\_length} is 1
819 and 
820 \addttindex{maximum\_operations\_per\_instruction} is 1. 
821 This means that
822 we can use a special opcode whenever two successive rows in
823 the matrix have source line numbers differing by any value
824 within the range [-3, 8] and (because of the limited number
825 of opcodes available) when the difference between addresses
826 is within the range [0, 20], but not all line advances are
827 available for the maximum \addtoindex{operation advance} (see below).}
828
829 \textit{The resulting opcode mapping is shown in
830 Figure \refersec{fig:examplelinenumberspecialopcodemapping}.}
831
832 \begin{figure}[ht]
833 \begin{alltt}\textit{
834                         Line Advance
835    Operation  
836      Advance    -3  -2  -1   0   1   2   3   4   5   6   7   8
837    ---------   -----------------------------------------------
838            0    13  14  15  16  17  18  19  20  21  22  23  24
839            1    25  26  27  28  29  30  31  32  33  34  35  36
840            2    37  38  39  40  41  42  43  44  45  46  47  48
841            3    49  50  51  52  53  54  55  56  57  58  59  60
842            4    61  62  63  64  65  66  67  68  69  70  71  72
843            5    73  74  75  76  77  78  79  80  81  82  83  84
844            6    85  86  87  88  89  90  91  92  93  94  95  96
845            7    97  98  99 100 101 102 103 104 105 106 107 108
846            8   109 110 111 112 113 114 115 116 117 118 119 120
847            9   121 122 123 124 125 126 127 128 129 130 131 132
848           10   133 134 135 136 137 138 139 140 141 142 143 144
849           11   145 146 147 148 149 150 151 152 153 154 155 156
850           12   157 158 159 160 161 162 163 164 165 166 167 168
851           13   169 170 171 172 173 174 175 176 177 178 179 180
852           14   181 182 183 184 185 186 187 188 189 190 191 192
853           15   193 194 195 196 197 198 199 200 201 202 203 204
854           16   205 206 207 208 209 210 211 212 213 214 215 216
855           17   217 218 219 220 221 222 223 224 225 226 227 228 
856           18   229 230 231 232 233 234 235 236 237 238 239 240 
857           19   241 242 243 244 245 246 247 248 249 250 251 252
858           20   253 254 255
859 }\end{alltt}
860 \caption{Example line number special opcode mapping}
861 \label{fig:examplelinenumberspecialopcodemapping}
862 \end{figure}
863
864 \textit{There is no requirement that the expression 
865 255 - \addttindex{line\_base} + 1 be an integral multiple of
866 \addttindex{line\_range}. }
867
868 \subsubsection{Standard Opcodes}
869 \label{chap:standardopcodes}
870
871
872 The standard opcodes, their applicable operands and the
873 actions performed by these opcodes are as follows:
874
875 \begin{enumerate}[1. ]
876
877 \item \textbf{DW\_LNS\_copy} \\
878 The \livetarg{chap:DWLNScopy}{DW\_LNS\_copy} 
879 opcode takes no operands. It appends a row
880 to the matrix using the current values of the state machine
881 registers. Then it sets the \addttindex{discriminator} register to 0,
882 and sets the \addttindex{basic\_block}, 
883 \addttindex{prologue\_end} and 
884 \addttindex{epilogue\_begin}
885 registers to ``false.''
886
887 \item \textbf{DW\_LNS\_advance\_pc} \\
888 The \livetarg{chap:DWLNSadvancepc}{DW\_LNS\_advance\_pc} 
889 opcode takes a single unsigned LEB128\addtoindexx{LEB128!unsigned}
890 operand as the \addtoindex{operation advance} and modifies the \texttt{address}
891 and \addttindex{op\_index} registers as specified in 
892 Section \refersec{chap:specialopcodes}.
893
894 \item \textbf{DW\_LNS\_advance\_line} \\
895 The \livetarg{chap:DWLNSadvanceline}{DW\_LNS\_advance\_line} 
896 opcode takes a single signed LEB128\addtoindexx{LEB128!signed}
897 operand and adds that value to the \texttt{line} register of the
898 state machine.
899
900 \needlines{4}
901 \item \textbf{DW\_LNS\_set\_file} \\ 
902 The \livetarg{chap:DWLNSsetfile}{DW\_LNS\_set\_file} opcode takes a single
903 unsigned LEB128\addtoindexx{LEB128!unsigned} 
904 operand and stores it in the \texttt{file} register
905 of the state machine.
906
907 \item \textbf{DW\_LNS\_set\_column} \\ 
908 The \livetarg{chap:DWLNSsetcolumn}{DW\_LNS\_set\_column} opcode takes a
909 single unsigned LEB128\addtoindexx{LEB128!unsigned} operand 
910 and stores it in the \texttt{column}
911 register of the state machine.
912
913 \needlines{4}
914 \item \textbf{DW\_LNS\_negate\_stmt} \\
915 The \livetarg{chap:DWLNSnegatestmt}{DW\_LNS\_negate\_stmt} opcode takes no
916 operands. It sets the \addttindex{is\_stmt} register of the state machine
917 to the logical negation of its current value.
918
919 \needlines{4}
920 \item \textbf{DW\_LNS\_set\_basic\_block} \\
921 The \livetarg{chap:DWLNSsetbasicblock}{DW\_LNS\_set\_basic\_block}
922 opcode
923 \addtoindexx{basic block}
924 takes no operands. 
925 It sets the \addttindex{basic\_block} register of the
926 state machine to ``true.''
927
928
929
930 \item \textbf{DW\_LNS\_const\_add\_pc} \\
931 The \livetarg{chap:DWLNSconstaddpc}{DW\_LNS\_const\_add\_pc} opcode takes
932 no operands. It advances the \texttt{address} and \addttindex{op\_index} registers
933 by the increments corresponding to special opcode 255.
934
935 \textit{When the line number program needs to advance the \texttt{address}
936 by a small amount, it can use a single special opcode,
937 which occupies a single byte. When it needs to advance the
938 \texttt{address} by up to twice the range of the last special opcode,
939 it can use \livelink{chap:DWLNSconstaddpc}{DW\_LNS\_const\_add\_pc} followed by a special opcode,
940 for a total of two bytes. Only if it needs to advance the
941 address by more than twice that range will it need to use
942 both \livelink{chap:DWLNSadvancepc}{DW\_LNS\_advance\_pc} and a special opcode, requiring three
943 or more bytes.}
944
945 \item \textbf{DW\_LNS\_fixed\_advance\_pc} \\ 
946 The \livetarg{chap:DWLNSfixedadvancepc}{DW\_LNS\_fixed\_advance\_pc} opcode
947 takes a single \addtoindex{uhalf} (unencoded) operand and adds it to the
948 \texttt{address} register of the state machine and sets the \addttindex{op\_index}
949 register to 0. This is the only standard opcode whose operand
950 is \textbf{not} a variable length number. It also does 
951 \textbf{not} multiply the
952 operand by the \addttindex{minimum\_instruction\_length} 
953 field of the header.
954
955 \textit{Existing assemblers cannot emit 
956 \livelink{chap:DWLNSadvancepc}{DW\_LNS\_advance\_pc} or special
957 opcodes because they cannot encode \addtoindex{LEB128} numbers or judge when
958 the computation of a special opcode overflows and requires
959 the use of \livelink{chap:DWLNSadvancepc}{DW\_LNS\_advance\_pc}. Such assemblers, however, can
960 use \livelink{chap:DWLNSfixedadvancepc}{DW\_LNS\_fixed\_advance\_pc} instead, sacrificing compression.}
961
962 \needlines{6}
963 \item \textbf{DW\_LNS\_set\_prologue\_end} \\
964 The \livetarg{chap:DWLNSsetprologueend}{DW\_LNS\_set\_prologue\_end}
965 opcode takes no operands. It sets the 
966 \addttindex{prologue\_end} register
967 to \doublequote{true}.
968
969 \textit{When a breakpoint is set on entry to a function, it is
970 generally desirable for execution to be suspended, not on the
971 very first instruction of the function, but rather at a point
972 after the function's frame has been set up, after any language
973 defined local declaration processing has been completed,
974 and before execution of the first statement of the function
975 begins. Debuggers generally cannot properly determine where
976 this point is. This command allows a compiler to communicate
977 the location(s) to use.}
978
979 \textit{In the case of optimized code, there may be more than one such
980 location; for example, the code might test for a special case
981 and make a fast exit prior to setting up the frame.}
982
983 \textit{Note that the function to which the 
984 \addtoindex{prologue end} applies cannot
985 be directly determined from the line number information alone;
986 it must be determined in combination with the subroutine
987 information entries of the compilation (including inlined
988 subroutines).}
989
990
991 \item \textbf{DW\_LNS\_set\_epilogue\_begin} \\
992 The \livetarg{chap:DWLNSsetepiloguebegin}{DW\_LNS\_set\_epilogue\_begin} opcode takes no operands. It
993 sets the \addttindex{epilogue\_begin} register to \doublequote{true}.
994
995 \textit{When a breakpoint is set on the exit of a function or execution
996 steps over the last executable statement of a function, it is
997 generally desirable to suspend execution after completion of
998 the last statement but prior to tearing down the frame (so that
999 local variables can still be examined). Debuggers generally
1000 cannot properly determine where this point is. This command
1001 allows a compiler to communicate the location(s) to use.}
1002
1003 \textit{Note that the function to which the 
1004 \addtoindex{epilogue end} applies cannot
1005 be directly determined from the line number information alone;
1006 it must be determined in combination with the subroutine
1007 information entries of the compilation (including inlined
1008 subroutines).}
1009
1010 \textit{In the case of a trivial function, both 
1011 \addtoindex{prologue end} and
1012 \addtoindex{epilogue begin} may occur at the same address.}
1013
1014 \item \textbf{DW\_LNS\_set\_isa} \\
1015 The \livetarg{chap:DWLNSsetisa}{DW\_LNS\_set\_isa} opcode takes a single
1016 unsigned LEB128\addtoindexx{LEB128!unsigned} operand and stores that value in the 
1017 \addttindex{isa}
1018 register of the state machine.
1019 \end{enumerate}
1020
1021 \needlines{8}
1022 \subsubsection{Extended Opcodes}
1023 \label{chap:extendedopcodes}
1024
1025 The extended opcodes are as follows:
1026
1027 \begin{enumerate}[1. ]
1028
1029 \item \textbf{DW\_LNE\_end\_sequence} \\
1030 The \livetarg{chap:DWLNEendsequence}{DW\_LNE\_end\_sequence} opcode takes no operands. It sets the
1031 \addttindex{end\_sequence}
1032 register of the state machine to \doublequote{true} and
1033 appends a row to the matrix using the current values of the
1034 state-machine registers. Then it resets the registers to the
1035 initial values specified above 
1036 (see Section \refersec{chap:statemachineregisters}). 
1037 Every line
1038 number program sequence must end with a \livelink{chap:DWLNEendsequence}{DW\_LNE\_end\_sequence}
1039 instruction which creates a row whose address is that of the
1040 byte after the last target machine instruction of the sequence.
1041
1042 \needlines{5}
1043 \item \textbf{DW\_LNE\_set\_address} \\
1044 The \livetarg{chap:DWLNEsetaddress}{DW\_LNE\_set\_address} opcode takes a single relocatable
1045 address as an operand. The size of the operand is the size
1046 of an address on the target machine. It sets the \texttt{address}
1047 register to the value given by the relocatable address and
1048 sets the \addttindex{op\_index} register to 0.
1049
1050 \textit{All of the other line number program opcodes that
1051 affect the \texttt{address} register add a delta to it. This instruction
1052 stores a relocatable value into it instead.}
1053
1054 \needlines{4}
1055 \item \textbf{DW\_LNE\_define\_file} \\
1056
1057 The \livetarg{chap:DWLNEdefinefile}{DW\_LNE\_define\_file} opcode takes four operands:
1058 \begin{enumerate}[1. ]
1059
1060 \item A null\dash terminated string containing the full or relative
1061 path name of a source file. If the entry contains a file
1062 name or a relative path name, the file is located relative
1063 to either the compilation directory (as specified by the
1064 \livelink{chap:DWATcompdir}{DW\_AT\_comp\_dir} attribute given in the compilation unit)
1065 or one of the directories in the 
1066 \addttindex{include\_directories} section.
1067
1068 \item An unsigned LEB128\addtoindexx{LEB128!unsigned} 
1069 number representing the directory index
1070 of the directory in which the file was found.  
1071
1072 \item An unsigned LEB128\addtoindexx{LEB128!unsigned} 
1073 number representing the time of last modification
1074 of the file, or 0 if not available.  
1075
1076 \item An unsigned LEB128\addtoindexx{LEB128!unsigned}
1077 number representing the length in bytes of the file, or 0 if
1078 not available.
1079 \end{enumerate}
1080
1081 The directory index represents an entry in the
1082 \addttindex{include\_directories} section of the line number program
1083 header. The index is 0 if the file was found in the current
1084 directory of the compilation, 1 if it was found in the first
1085 directory in the \addttindex{include\_directories} section,
1086 and so on. The
1087 directory index is ignored for file names that represent full
1088 path names.
1089
1090 The primary source file is described by an entry whose path
1091 name exactly matches that given in the \livelink{chap:DWATname}{DW\_AT\_name} attribute
1092 in the compilation unit, and whose directory index is 0. The
1093 files are numbered, starting at 1, in the order in which they
1094 appear; the names in the header come before names defined by
1095 the \livelink{chap:DWLNEdefinefile}{DW\_LNE\_define\_file} instruction. These numbers are used
1096 in the file register of the state machine.
1097
1098 \item \textbf{DW\_LNE\_set\_discriminator} \\
1099 The \livetarg{chap:DWLNEsetdiscriminator}{DW\_LNE\_set\_discriminator}
1100 opcode takes a single
1101 parameter, an unsigned LEB128\addtoindexx{LEB128!unsigned} 
1102 integer. It sets the
1103 \addttindex{discriminator} register to the new value.
1104
1105 \end{enumerate}
1106
1107 \textit{Appendix \refersec{app:linenumberprogramexample} 
1108 gives some sample line number programs.}
1109
1110 \section{Macro Information}
1111 \label{chap:macroinformation}
1112 \textit{Some languages, such as 
1113 \addtoindex{C} and 
1114 \addtoindex{C++}, provide a way to replace
1115 \addtoindexx{macro information}
1116 text in the source program with macros defined either in the
1117 source file itself, or in another file included by the source
1118 file.  Because these macros are not themselves defined in the
1119 target language, it is difficult to represent their definitions
1120 using the standard language constructs of DWARF. The debugging
1121 information therefore reflects the state of the source after
1122 the macro definition has been expanded, rather than as the
1123 programmer wrote it. The macro information table provides a way
1124 of preserving the original source in the debugging information.}
1125
1126 As described in 
1127 Section \refersec{chap:normalandpartialcompilationunitentries},
1128 the macro information for a
1129 given compilation unit is represented in the 
1130 \dotdebugmacinfo{}
1131 section of an object file. The macro information for each
1132 compilation unit is represented as a series of \doublequote{macinfo}
1133 entries. Each macinfo entry consists of a \doublequote{type code} and
1134 up to two additional operands. The series of entries for a
1135 given compilation unit ends with an entry containing a type
1136 code of 0.
1137
1138 \subsection{Macinfo Types}
1139 \label{chap:macinfotypes}
1140
1141 The valid \addtoindex{macinfo types} are as follows:
1142
1143 \begin{tabular}{ll}
1144 \livelink{chap:DWMACINFOdefine}{DW\_MACINFO\_define} 
1145 &A macro definition\\
1146 \livelink{chap:DWMACINFOundef}{DW\_MACINFO\_undef}
1147 &A macro undefinition\\
1148 \livelink{chap:DWMACINFOstartfile}{DW\_MACINFO\_start\_file}
1149 &The start of a new source file inclusion\\
1150 \livelink{chap:DWMACINFOendfile}{DW\_MACINFO\_end\_file}
1151 &The end of the current source file inclusion\\
1152 \livelink{chap:DWMACINFOvendorext}{DW\_MACINFO\_vendor\_ext}
1153 & Vendor specific macro information directives\\
1154 \end{tabular}
1155
1156 \subsubsection{Define and Undefine Entries}
1157 \label{chap:defineandundefineentries}
1158
1159 All 
1160 \livetarg{chap:DWMACINFOdefine}{DW\_MACINFO\_define} and 
1161 \livetarg{chap:DWMACINFOundef}{DW\_MACINFO\_undef} entries have two
1162 operands. The first operand encodes the line number of the
1163 source line on which the relevant defining or undefining
1164 macro directives appeared.
1165
1166 The second operand consists of a null-terminated character
1167 string. In the case of a 
1168 \livelink{chap:DWMACINFOundef}{DW\_MACINFO\_undef} entry, the value
1169 of this string will be simply the name of the pre- processor
1170 symbol that was undefined at the indicated source line.
1171
1172 In the case of a \livelink{chap:DWMACINFOdefine}{DW\_MACINFO\_define} entry, the value of this
1173 string will be the name of the macro symbol that was defined
1174 at the indicated source line, followed immediately by the 
1175 \addtoindex{macro formal parameter list}
1176 including the surrounding parentheses (in
1177 the case of a function-like macro) followed by the definition
1178 string for the macro. If there is no formal parameter list,
1179 then the name of the defined macro is followed directly by
1180 its definition string.
1181
1182 In the case of a function-like macro definition, no whitespace
1183 characters should appear between the name of the defined
1184 macro and the following left parenthesis. Also, no whitespace
1185 characters should appear between successive formal parameters
1186 in the formal parameter list. (Successive formal parameters
1187 are, however, separated by commas.) Also, exactly one space
1188 character should separate the right parenthesis that terminates
1189 the formal parameter list and the following definition string.
1190
1191 In the case of a ``normal'' (i.e. non-function-like) macro
1192 definition, exactly one space character should separate the
1193 name of the defined macro from the following definition text.
1194
1195
1196
1197 \subsubsection{Start File Entries}
1198 \label{chap:startfileentries}
1199 Each \livetarg{chap:DWMACINFOstartfile}{DW\_MACINFO\_start\_file} entry also has two operands. The
1200 first operand encodes the line number of the source line on
1201 which the inclusion macro directive occurred.
1202
1203 The second operand encodes a source file name index. This index
1204 corresponds to a file number in the line number information
1205 table for the relevant compilation unit. This index indicates
1206 (indirectly) the name of the file that is being included by
1207 the inclusion directive on the indicated source line.
1208
1209 \subsubsection{End File Entries}
1210 \label{chap:endfileentries}
1211 A \livetarg{chap:DWMACINFOendfile}{DW\_MACINFO\_end\_file} entry has no operands. The presence of
1212 the entry marks the end of the current source file inclusion.
1213
1214 \subsubsection{Vendor Extension Entries}
1215 \label{chap:vendorextensionentries}
1216 A \livetarg{chap:DWMACINFOvendorext}{DW\_MACINFO\_vendor\_ext} entry has two operands. The first
1217 is a constant. The second is a null-terminated character
1218 string. The meaning and/or significance of these operands is
1219 intentionally left undefined by this specification.
1220
1221 \textit{A consumer must be able to totally ignore all
1222 \livelink{chap:DWMACINFOvendorext}{DW\_MACINFO\_vendor\_ext} entries that it does not understand
1223 (see Section \refersec{datarep:vendorextensibility}).}
1224
1225
1226 \subsection{Base Source Entries} 
1227 \label{chap:basesourceentries}
1228
1229 A producer shall generate \livelink{chap:DWMACINFOstartfile}{DW\_MACINFO\_start\_file} and
1230 \livelink{chap:DWMACINFOendfile}{DW\_MACINFO\_end\_file} entries for the source file submitted to
1231 the compiler for compilation. This \livelink{chap:DWMACINFOstartfile}{DW\_MACINFO\_start\_file} entry
1232 has the value 0 in its line number operand and references
1233 the file entry in the line number information table for the
1234 primary source file.
1235
1236
1237 \subsection{Macinfo Entries For Command Line Options}
1238 \label{chap:macinfoentriesforcommandlineoptions}
1239
1240 In addition to producing \livelink{chap:DWMACINFOdefine}{DW\_MACINFO\_define} and \livelink{chap:DWMACINFOundef}{DW\_MACINFO\_undef}
1241 entries for each of the define and undefine directives
1242 processed during compilation, the DWARF producer should
1243 generate a \livelink{chap:DWMACINFOdefine}{DW\_MACINFO\_define} or \livelink{chap:DWMACINFOundef}{DW\_MACINFO\_undef} entry for
1244 each pre-processor symbol which is defined or undefined by
1245 some means other than via a define or undefine directive
1246 within the compiled source text. In particular, pre-processor
1247 symbol definitions and un- definitions which occur as a
1248 result of command line options (when invoking the compiler)
1249 should be represented by their own \livelink{chap:DWMACINFOdefine}{DW\_MACINFO\_define} and
1250 \livelink{chap:DWMACINFOundef}{DW\_MACINFO\_undef} entries.
1251
1252 All such \livelink{chap:DWMACINFOdefine}{DW\_MACINFO\_define} and \livelink{chap:DWMACINFOundef}{DW\_MACINFO\_undef} entries
1253 representing compilation options should appear before the
1254 first \livelink{chap:DWMACINFOstartfile}{DW\_MACINFO\_start\_file} entry for that compilation unit
1255 and should encode the value 0 in their line number operands.
1256
1257
1258 \subsection{General rules and restrictions}
1259 \label{chap:generalrulesandrestrictions}
1260
1261 All macinfo entries within a \dotdebugmacinfo{}
1262 section for a
1263 given compilation unit appear in the same order in which the
1264 directives were processed by the compiler.
1265
1266 All macinfo entries representing command line options appear
1267 in the same order as the relevant command line options
1268 were given to the compiler. In the case where the compiler
1269 itself implicitly supplies one or more macro definitions or
1270 un-definitions in addition to those which may be specified on
1271 the command line, macinfo entries are also produced for these
1272 implicit definitions and un-definitions, and these entries
1273 also appear in the proper order relative to each other and
1274 to any definitions or undefinitions given explicitly by the
1275 user on the command line.
1276
1277
1278 \needlines{6}
1279 \section{Call Frame Information}
1280 \label{chap:callframeinformation}
1281
1282 \textit{Debuggers often need to be able to view and modify the state of any subroutine activation that is
1283 \addtoindexx{activation!call frame}
1284 on the call stack. An activation consists of:}
1285
1286 \begin{itemize}
1287 \item \textit{A code location that is within the
1288 subroutine. This location is either the place where the program
1289 stopped when the debugger got control (e.g. a breakpoint), or
1290 is a place where a subroutine made a call or was interrupted
1291 by an asynchronous event (e.g. a signal).}
1292
1293 \item \textit{An area of memory that is allocated on a stack called a
1294 ``call frame.'' The call frame is identified by an address
1295 on the stack. We refer to this address as the Canonical
1296 Frame Address or CFA. Typically, the CFA is defined to be the
1297 value of the stack pointer at the call site in the previous
1298 frame (which may be different from its value on entry to the
1299 current frame).}
1300
1301 \item \textit{A set of registers that are in use by the subroutine
1302 at the code location.}
1303
1304 \end{itemize}
1305
1306 \textit{Typically, a set of registers are designated to be preserved
1307 across a call. If a callee wishes to use such a register, it
1308 saves the value that the register had at entry time in its call
1309 frame and restores it on exit. The code that allocates space
1310 on the call frame stack and performs the save operation is
1311 called the subroutine\textquoteright s \addtoindex{prologue}, and the code that performs
1312 the restore operation and deallocates the frame is called its
1313 \addtoindex{epilogue}. Typically, the 
1314 \addtoindex{prologue} code is physically at the
1315 beginning of a subroutine and the 
1316 \addtoindex{epilogue} code is at the end.}
1317
1318 \textit{To be able to view or modify an activation that is not
1319 on the top of the call frame stack, the debugger must
1320 ``virtually unwind'' the stack of activations until
1321 it finds the activation of interest.  A debugger unwinds
1322 a stack in steps. Starting with the current activation it
1323 virtually restores any registers that were preserved by the
1324 current activation and computes the predecessor\textquoteright s CFA and
1325 code location. This has the logical effect of returning from
1326 the current subroutine to its predecessor. We say that the
1327 debugger virtually unwinds the stack because the actual state
1328 of the target process is unchanged.}
1329
1330 \textit{The unwinding operation needs to know where registers are
1331 saved and how to compute the predecessor\textquoteright s CFA and code
1332 location. When considering an architecture-independent way
1333 of encoding this information one has to consider a number of
1334 special things.}
1335
1336
1337 \begin{itemize} % bullet list
1338
1339 \item \textit{Prologue 
1340 \addtoindexx{prologue}
1341 and 
1342 \addtoindex{epilogue} code is not always in 
1343 distinct \nolink{blocks}
1344 at the beginning and end of a subroutine. It is common
1345 to duplicate the \addtoindex{epilogue} code 
1346 at the site of each return
1347 from the code. Sometimes a compiler breaks up the register
1348 save/unsave operations and moves them into the body of the
1349 subroutine to just where they are needed.}
1350
1351
1352 \item \textit{Compilers use different ways to manage the call
1353 frame. Sometimes they use a frame pointer register, sometimes
1354 not.}
1355
1356 \item \textit{The algorithm to compute CFA changes as you progress through
1357 the \addtoindex{prologue} 
1358 and \addtoindex{epilogue code}. 
1359 (By definition, the CFA value
1360 does not change.)}
1361
1362 \item \textit{Some subroutines have no call frame.}
1363
1364 \item \textit{Sometimes a register is saved in another register that by
1365 convention does not need to be saved.}
1366
1367 \item \textit{Some architectures have special instructions that perform
1368 some or all of the register management in one instruction,
1369 leaving special information on the stack that indicates how
1370 registers are saved.}
1371
1372 \item \textit{Some architectures treat return address values specially. For
1373 example, in one architecture, the call instruction guarantees
1374 that the low order two bits will be zero and the return
1375 instruction ignores those bits. This leaves two bits of
1376 storage that are available to other uses that must be treated
1377 specially.}
1378
1379
1380 \end{itemize}
1381
1382
1383 \subsection{Structure of Call Frame Information}
1384 \label{chap:structureofcallframeinformation}
1385
1386 DWARF supports virtual unwinding by defining an architecture
1387 independent basis for recording how procedures save and restore
1388 registers during their lifetimes. This basis must be augmented
1389 on some machines with specific information that is defined by
1390 an architecture specific ABI authoring committee, a hardware
1391 vendor, or a compiler producer. The body defining a specific
1392 augmentation is referred to below as the ``augmenter.''
1393
1394 Abstractly, this mechanism describes a very large table that
1395 has the following structure:
1396
1397 \begin{verbatim}
1398         LOC CFA R0 R1 ... RN
1399         L0
1400         L1
1401         ...
1402         LN
1403 \end{verbatim}
1404
1405
1406 The first column indicates an address for every location
1407 that contains code in a program. (In shared objects, this
1408 is an object-relative offset.) The remaining columns contain
1409 virtual unwinding rules that are associated with the indicated
1410 location.
1411
1412 The CFA column defines the rule which computes the Canonical
1413 Frame Address value; it may be either a register and a signed
1414 offset that are added together, or a DWARF expression that
1415 is evaluated.
1416
1417 The remaining columns are labeled by register number. This
1418 includes some registers that have special designation on
1419 some architectures such as the PC and the stack pointer
1420 register. (The actual mapping of registers for a particular
1421 architecture is defined by the augmenter.) The register columns
1422 contain rules that describe whether a given register has been
1423 saved and the rule to find the value for the register in the
1424 previous frame.
1425
1426 \needlines{4}
1427 The register rules are:
1428
1429 \begin{longtable}{lp{8cm}}
1430 undefined 
1431 &A register that has this rule has no recoverable value in the previous frame.
1432 (By convention, it is not preserved by a callee.) \\
1433
1434 same value
1435 &This register has not been modified from the previous frame. (By convention,
1436 it is preserved by the callee, but the callee has not modified it.) \\
1437
1438 offset(N)
1439 &The previous value of this register is saved at the address CFA+N where CFA
1440 is the current CFA value and N is a signed offset.\\
1441
1442 val\_offset(N)
1443 &The previous value of this register is the value CFA+N where CFA is the
1444 current CFA value and N is a signed offset.\\
1445
1446 register(R)
1447 &The previous value of this register is stored 
1448 in another register numbered R.\\
1449
1450 expression(E)
1451 &The previous value of this register is located at the address produced by
1452 executing the DWARF expression E (see Section \refersec{chap:dwarfexpressions}).\\
1453
1454 val\_expression(E) 
1455 &The previous value of this register is the value produced by executing the
1456 DWARF expression E (see Section \refersec{chap:dwarfexpressions}).\\
1457
1458 architectural
1459 &The rule is defined externally to this specification by the augmenter.\\
1460
1461 \end{longtable}
1462
1463 \textit{This table would be extremely large if actually constructed
1464 as described. Most of the entries at any point in the table
1465 are identical to the ones above them. The whole table can be
1466 represented quite compactly by recording just the differences
1467 starting at the beginning address of each subroutine in
1468 the program.}
1469
1470 The virtual unwind information is encoded in a self-contained
1471 section called 
1472 \dotdebugframe{}.  Entries in a 
1473 \dotdebugframe{} section
1474 are aligned on a multiple of the address size relative to
1475 the start of the section and come in two forms: a Common
1476 \addtoindexx{common information entry}
1477 Information Entry (CIE) and a 
1478 \addtoindexx{frame description entry}
1479 Frame Description Entry (FDE).
1480
1481 \textit{If the range of code addresses for a function is not
1482 contiguous, there may be multiple CIEs and FDEs corresponding
1483 to the parts of that function.}
1484
1485
1486 A Common Information Entry holds information that is shared
1487 among many Frame Description Entries. There is at least one
1488 CIE in every non-empty \dotdebugframe{} section. A CIE contains
1489 the following fields, in order:
1490 \begin{enumerate}[1. ]
1491 \item \texttt{length} (\livelink{datarep:initiallengthvalues}{initial length})  \\
1492 A constant that gives the number of bytes of the CIE structure,
1493 not including the length field itself 
1494 (see Section \refersec{datarep:initiallengthvalues}). 
1495 The
1496 size of the \texttt{length} field plus the value of \texttt{length} must be an
1497 integral multiple of the address size.
1498
1499 \item  \texttt{CIE\_id} (4 or 8 bytes, see Section \refersec{datarep:32bitand64bitdwarfformats}) \\
1500 A constant that is used to distinguish CIEs from FDEs.
1501
1502 \item  \texttt{version} (\addtoindex{ubyte}) \\
1503 A version number\addtoindexx{version number!call frame information} 
1504 (see Section \refersec{datarep:callframeinformation}). 
1505 This number is specific to the call frame information
1506 and is independent of the DWARF version number.
1507
1508 \needlines{8}
1509 \item  \texttt{augmentation} (\addtoindex{UTF\dash 8} string) \\
1510 A null\dash terminated UTF\dash 8 string that identifies the augmentation
1511 to this CIE or to the FDEs that use it. If a reader encounters
1512 an augmentation string that is unexpected, then only the
1513 following fields can be read:
1514
1515
1516 \begin{itemize}
1517
1518 \item CIE: \texttt{length, CIE\_id, version, augmentation}
1519
1520 \item FDE: \texttt{length, CIE\_pointer, initial\_location, address\_range}
1521
1522 \end{itemize}
1523 If there is no augmentation, this value is a zero byte.
1524
1525 \needlines{5}
1526 \textit{The augmentation string allows users to indicate that there
1527 is additional target\dash specific information in the CIE or FDE
1528 which is needed to unwind a stack frame. For example, this
1529 might be information about dynamically allocated data which
1530 needs to be freed on exit from the routine.}
1531
1532 \textit{Because the \dotdebugframe{} section is useful independently of
1533 any \dotdebuginfo{} section, the augmentation string always uses
1534 UTF\dash 8 encoding.}
1535
1536 \item  \texttt{address\_size} (\addtoindex{ubyte}) \\
1537 The size of a target address
1538 \addttindexx{address\_size}
1539 in this CIE and any FDEs that
1540 use it, in bytes. If a compilation unit exists for this frame,
1541 its address size must match the address size here.
1542
1543 \item  \texttt{segment\_size} (\addtoindex{ubyte}) \\
1544 The \addttindexx{segment\_size}
1545 size of a segment selector in this CIE and any FDEs that
1546 use it, in bytes.
1547
1548 \item  \addttindex{code\_alignment\_factor} (unsigned LEB128) 
1549 \addtoindexx{LEB128!unsigned}\addtoindexx{unsigned LEB128|see{LEB128, unsigned}}
1550 \addtoindexx{code alignment factor} \\
1551
1552 \addtoindexx{\textless caf\textgreater|see{code alignment factor}}
1553 constant that is factored out of all advance location
1554 instructions (see 
1555 Section \refersec{chap:rowcreationinstructions}).
1556
1557
1558 \item  \addttindex{data\_alignment\_factor} (signed LEB128)
1559 \addtoindexx{LEB128!signed}\addtoindexx{signed LEB128|see{LEB128, signed}} \\
1560 \addtoindexx{data alignment factor}
1561
1562 \addtoindexx{\textless daf\textgreater|see{data alignment factor}}
1563 constant that is factored out of certain offset instructions
1564 (see below). The resulting value is  \textit{(operand} *
1565 \texttt{data\_alignment\_factor}).
1566
1567 \item  \texttt{return\_address\_register} (unsigned LEB128)\addtoindexx{LEB128!unsigned} \\
1568 An unsigned LEB128 constant that indicates which column in the
1569 rule table represents the return address of the function. Note
1570 that this column might not correspond to an actual machine
1571 register.
1572
1573 \item \texttt{initial\_instructions} (array of \addtoindex{ubyte}) \\
1574 A sequence of rules that are interpreted to create the initial
1575 setting of each column in the table.  
1576
1577 The default rule for
1578 all columns before interpretation of the initial instructions
1579 is the undefined rule. However, an ABI authoring body or a
1580 compilation system authoring body may specify an alternate
1581 default value for any or all columns.
1582
1583 \item \texttt{padding} (array of \addtoindex{ubyte}) \\
1584 Enough \livelink{chap:DWCFAnop}{DW\_CFA\_nop} instructions to make the size of this entry
1585 match the length value above.
1586 \end{enumerate}
1587
1588 \needlines{5}
1589 An FDE contains the following fields, in order:
1590 \begin{enumerate}[1. ]
1591 \item \texttt{length} (\livelink{datarep:initiallengthvalues}{initial length})  \\
1592 A constant that gives the number of bytes of the header and
1593 instruction stream for this function, not including the length
1594 field itself 
1595 (see Section \refersec{datarep:initiallengthvalues}). 
1596 The size of the \texttt{length} field
1597 plus the value of length must be an integral multiple of the
1598 address size.
1599
1600 \item   CIE\_pointer (4 or 8 bytes, see Section \refersec{datarep:32bitand64bitdwarfformats}) \\
1601 A constant 
1602 \addtoindexx{section offset!in FDE header}
1603 offset into the \dotdebugframe{}
1604 section that denotes
1605 the CIE that is associated with this FDE.
1606
1607 \item  \texttt{initial\_location} (segment selector and target address) \\
1608 The 
1609 \addttindexx{initial\_location}
1610 address of the first location associated with this table
1611 entry. 
1612 If the \addttindex{segment\_size} field of this FDE's CIE is non-zero,
1613 the initial location is preceded by a segment selector of
1614 the given length.
1615
1616 \item  \texttt{address\_range} (target address) \\
1617 The 
1618 \addttindexx{address\_range}
1619 number 
1620 \addtoindexx{target address}
1621 of bytes of program instructions described by this entry.
1622
1623 \item \texttt{instructions} (array of \addtoindex{ubyte}) \\
1624 A sequence of table defining instructions that are described below.
1625
1626 \item \texttt{padding} (array of \addtoindex{ubyte}) \\
1627 Enough \livelink{chap:DWCFAnop}{DW\_CFA\_nop} instructions 
1628 to make the size of this entry match the length value above.
1629 \end{enumerate}
1630
1631 \subsection{Call Frame Instructions}
1632 \label{chap:callframeinstructions}
1633
1634 Each call frame instruction is defined to take 0 or more
1635 operands. Some of the operands may be encoded as part of the
1636 opcode 
1637 (see Section \refersec{datarep:callframeinformation}). 
1638 The instructions are defined in
1639 the following sections.
1640
1641 \needlines{8}
1642 Some call frame instructions have operands that are encoded
1643 as DWARF expressions 
1644 (see Section \refersec{chap:generaloperations}). 
1645 The following DWARF
1646 operators cannot be used in such operands:
1647
1648
1649 \begin{itemize}
1650 \item \livelink{chap:DWOPcall2}{DW\_OP\_call2}, \livelink{chap:DWOPcall4}{DW\_OP\_call4} 
1651 and \livelink{chap:DWOPcallref}{DW\_OP\_call\_ref} operators
1652 are not meaningful in an operand of these instructions
1653 because there is no mapping from call frame information to
1654 any corresponding debugging compilation unit information,
1655 thus there is no way to interpret the call offset.
1656
1657 \needlines{5}
1658 \item \livelink{chap:DWOPpushobjectaddress}{DW\_OP\_push\_object\_address} is not meaningful in an operand
1659 of these instructions because there is no object context to
1660 provide a value to push.
1661
1662 \item \livelink{chap:DWOPcallframecfa}{DW\_OP\_call\_frame\_cfa} is not meaningful in an operand of
1663 these instructions because its use would be circular.
1664 \end{itemize}
1665
1666 \textit{Call frame instructions to which these restrictions apply
1667 include \livelink{chap:DWCFAdefcfaexpression}{DW\_CFA\_def\_cfa\_expression}, \livelink{chap:DWCFAexpression}{DW\_CFA\_expression}
1668 and \livelink{chap:DWCFAvalexpression}{DW\_CFA\_val\_expression}.}
1669
1670 \subsubsection{Row Creation Instructions}
1671 \label{chap:rowcreationinstructions}
1672 \begin{enumerate}[1. ]
1673
1674 \item \textbf{DW\_CFA\_set\_loc} \\
1675 The \livetarg{chap:DWCFAsetloc}{DW\_CFA\_set\_loc} instruction 
1676 takes a single operand that
1677 represents a target address. The required action is to create a
1678 new table row using the specified address as the location. All
1679 other values in the new row are initially identical to the
1680 current row. The new location value is always greater than
1681 the current one. 
1682 If the \addttindex{segment\_size} field of this FDE's 
1683 \addtoindex{CIE}
1684 is non\dash zero, the initial location is preceded by a segment
1685 selector of the given length.
1686
1687
1688 \item \textbf{DW\_CFA\_advance\_loc} \\
1689 The \livetarg{chap:DWCFAadvanceloc}{DW\_CFA\_advance\_loc} instruction takes a single operand (encoded
1690 with the opcode) that represents a constant delta. The required
1691 action is to create a new table row with a location value that
1692 is computed by taking the current entry\textquoteright s location value
1693 and adding the value of 
1694 \textit{delta} * \addttindex{code\_alignment\_factor}. 
1695 All other values in the new row are initially identical to the
1696 current row
1697
1698 \item \textbf{DW\_CFA\_advance\_loc1} \\
1699 The \livetarg{chap:DWCFAadvanceloc1}{DW\_CFA\_advance\_loc1} instruction takes a single \addtoindex{ubyte}
1700 operand that represents a constant delta. This instruction
1701 is identical to \livelink{chap:DWCFAadvanceloc}{DW\_CFA\_advance\_loc} except for the encoding
1702 and size of the delta operand.
1703
1704 \needlines{6}
1705 \item \textbf{DW\_CFA\_advance\_loc2} \\
1706 The \livetarg{chap:DWCFAadvanceloc2}{DW\_CFA\_advance\_loc2} instruction takes a single
1707 \addtoindex{uhalf}
1708 operand that represents a constant delta. This instruction
1709 is identical to \livelink{chap:DWCFAadvanceloc}{DW\_CFA\_advance\_loc} except for the encoding
1710 and size of the delta operand.
1711
1712 \item \textbf{DW\_CFA\_advance\_loc4} \\
1713 The \livetarg{chap:DWCFAadvanceloc4}{DW\_CFA\_advance\_loc4} instruction takes a single
1714 \addtoindex{uword}
1715 operand that represents a constant delta. This instruction
1716 is identical to \livelink{chap:DWCFAadvanceloc}{DW\_CFA\_advance\_loc} except for the encoding
1717 and size of the delta operand.
1718
1719 \end{enumerate}
1720
1721 \subsubsection{CFA Definition Instructions}
1722 \label{chap:cfadefinitioninstructions}
1723 \begin{enumerate}[1. ]
1724
1725 \item \textbf{DW\_CFA\_def\_cfa} \\
1726 The \livetarg{chap:DWCFAdefcfa}{DW\_CFA\_def\_cfa}
1727 instruction takes two unsigned LEB128\addtoindexx{LEB128!unsigned}
1728 operands representing a register number and a (non\dash factored)
1729 offset. The required action is to define the current CFA rule
1730 to use the provided register and offset.
1731
1732 \needlines{6}
1733 \item \textbf{ DW\_CFA\_def\_cfa\_sf} \\
1734 The \livetarg{chap:DWCFAdefcfasf}{DW\_CFA\_def\_cfa\_sf} instruction takes two operands:
1735 an unsigned LEB128 value\addtoindexx{LEB128!unsigned}
1736 representing a register number and a
1737 signed LEB128\addtoindexx{LEB128!signed} factored offset. This instruction is identical
1738 to \livelink{chap:DWCFAdefcfa}{DW\_CFA\_def\_cfa} except that the second operand is signed
1739 and factored. The resulting offset is \textit{factored\_offset} *
1740 \addttindex{data\_alignment\_factor}.
1741
1742
1743 \item \textbf{DW\_CFA\_def\_cfa\_register} \\
1744 The \livetarg{chap:DWCFAdefcfaregister}{DW\_CFA\_def\_cfa\_register} 
1745 instruction takes a single
1746 unsigned LEB128\addtoindexx{LEB128!unsigned} operand representing a register number. The
1747 required action is to define the current CFA rule to use
1748 the provided register (but to keep the old offset). This
1749 operation is valid only if the current CFA rule is defined
1750 to use a register and offset.
1751
1752
1753
1754 \item \textbf{DW\_CFA\_def\_cfa\_offset} \\
1755 The \livetarg{chap:DWCFAdefcfaoffset}{DW\_CFA\_def\_cfa\_offset} instruction takes a single
1756 unsigned LEB128\addtoindexx{LEB128!unsigned} operand representing a (non-factored)
1757 offset. The required action is to define the current CFA rule
1758 to use the provided offset (but to keep the old register). This
1759 operation is valid only if the current CFA rule is defined
1760 to use a register and offset.
1761
1762
1763 \item \textbf{DW\_CFA\_def\_cfa\_offset\_sf} \\
1764 The \livetarg{chap:DWCFAdefcfaoffsetsf}{DW\_CFA\_def\_cfa\_offset\_sf} instruction takes a signed
1765 LEB128\addtoindexx{LEB128!signed} operand representing a factored offset. This instruction
1766 is identical to \livelink{chap:DWCFAdefcfaoffset}{DW\_CFA\_def\_cfa\_offset} except that the
1767 operand is signed and factored. The resulting offset is
1768 \textit{factored\_offset} * \addttindex{data\_alignment\_factor}.
1769 This operation
1770 is valid only if the current CFA rule is defined to use a
1771 register and offset.
1772
1773 \item \textbf{DW\_CFA\_def\_cfa\_expression} \\
1774 The \livetarg{chap:DWCFAdefcfaexpression}{DW\_CFA\_def\_cfa\_expression} 
1775 instruction takes a 
1776 \addtoindexx{exprloc class}
1777 single operand encoded as a 
1778 \livelink{chap:DWFORMexprloc}{DW\_FORM\_exprloc} value representing a
1779 DWARF expression. The required action is to establish that
1780 expression as the means by which the current CFA is computed.
1781
1782 \textit{See Section \refersec{chap:callframeinstructions} 
1783 regarding restrictions on the DWARF
1784 expression operators that can be used.}
1785
1786 \end{enumerate}
1787
1788 \subsubsection{Register Rule Instructions}
1789 \label{chap:registerruleinstructions}
1790 \begin{enumerate}[1. ]
1791
1792 \item \textbf{DW\_CFA\_undefined} \\
1793 The \livetarg{chap:DWCFAundefined}{DW\_CFA\_undefined} instruction takes a single unsigned
1794 LEB128\addtoindexx{LEB128!unsigned} operand that represents a register number. The required
1795 action is to set the rule for the specified register to
1796 \doublequote{undefined.}
1797
1798 \item \textbf{DW\_CFA\_same\_value} \\
1799 The \livetarg{chap:DWCFAsamevalue}{DW\_CFA\_same\_value} instruction takes a single unsigned
1800 LEB128 operand\addtoindexx{LEB128!unsigned} that represents a register number. The required
1801 action is to set the rule for the specified register to
1802 \doublequote{same value.}
1803
1804 \item \textbf{DW\_CFA\_offset} \\
1805 The \livetarg{chap:DWCFAoffset}{DW\_CFA\_offset} instruction takes two operands: a register
1806 number (encoded with the opcode) and an unsigned LEB128\addtoindexx{LEB128!unsigned}
1807 constant representing a factored offset. The required action
1808 is to change the rule for the register indicated by the
1809 register number to be an offset(N) rule where the value of
1810 N is 
1811 \textit{factored offset} * \addttindex{data\_alignment\_factor}.
1812
1813 \item \textbf{DW\_CFA\_offset\_extended} \\
1814 The \livetarg{chap:DWCFAoffsetextended}{DW\_CFA\_offset\_extended} 
1815 instruction takes two unsigned LEB128\addtoindexx{LEB128!unsigned} 
1816 operands representing a register number and a factored
1817 offset. This instruction is identical to
1818 \livelink{chap:DWCFAoffset}{DW\_CFA\_offset} 
1819 except for the encoding and size of the register operand.
1820
1821 \item \textbf{ DW\_CFA\_offset\_extended\_sf} \\
1822 The \livetarg{chap:DWCFAoffsetextendedsf}{DW\_CFA\_offset\_extended\_sf} 
1823 instruction takes two operands:
1824 an unsigned LEB128\addtoindexx{LEB128!unsigned} 
1825 value representing a register number and a
1826 signed LEB128 factored offset. This instruction is identical
1827 to \livelink{chap:DWCFAoffsetextended}{DW\_CFA\_offset\_extended} 
1828 except that the second operand is
1829 signed and factored. The resulting offset is 
1830 \textit{factored\_offset} * \addttindex{data\_alignment\_factor}.
1831
1832 \item \textbf{DW\_CFA\_val\_offset} \\
1833 The \livetarg{chap:DWCFAvaloffset}{DW\_CFA\_val\_offset} 
1834 instruction takes two unsigned
1835 LEB128 operands\addtoindexx{LEB128!unsigned} representing a register number and a
1836 factored offset. The required action is to change the rule
1837 for the register indicated by the register number to be a
1838 val\_offset(N) rule where the value of N is 
1839 \textit{factored\_offset} * \addttindex{data\_alignment\_factor}.
1840
1841 \needlines{6}
1842 \item \textbf{DW\_CFA\_val\_offset\_sf} \\
1843 The \livetarg{chap:DWCFAvaloffsetsf}{DW\_CFA\_val\_offset\_sf} instruction takes two operands: an
1844 unsigned LEB128\addtoindexx{LEB128!unsigned} value representing a register number and a
1845 signed LEB128\addtoindexx{LEB128!signed} factored offset. This instruction is identical
1846 to \livelink{chap:DWCFAvaloffset}{DW\_CFA\_val\_offset} except that the second operand is signed
1847 and factored. The resulting offset is 
1848 \textit{factored\_offset} * \addttindex{data\_alignment\_factor}.
1849
1850 \item \textbf{DW\_CFA\_register} \\
1851 The \livetarg{chap:DWCFAregister}{DW\_CFA\_register} 
1852 instruction takes two unsigned LEB128\addtoindexx{LEB128!unsigned}
1853 operands representing register numbers. The required action
1854 is to set the rule for the first register to be register(R)
1855 where R is the second register.
1856
1857 \item \textbf{DW\_CFA\_expression} \\
1858 The \livetarg{chap:DWCFAexpression}{DW\_CFA\_expression} 
1859 instruction takes two operands: an
1860 unsigned LEB128\addtoindexx{LEB128!unsigned} 
1861 value representing a register number, and
1862 a \livelink{chap:DWFORMblock}{DW\_FORM\_block} 
1863 value representing a DWARF expression. 
1864 The
1865 required action is to change the rule for the register
1866 indicated by the register number to be an expression(E)
1867 rule where E is the DWARF expression. That is, the DWARF
1868 expression computes the address. The value of the CFA is
1869 pushed on the DWARF evaluation stack prior to execution of
1870 the DWARF expression.
1871
1872 \textit{See Section \refersec{chap:callframeinstructions} 
1873 regarding restrictions on the DWARF
1874 expression operators that can be used.}
1875
1876 \needlines{7}
1877 \item \textbf{DW\_CFA\_val\_expression} \\
1878 The \livetarg{chap:DWCFAvalexpression}{DW\_CFA\_val\_expression} instruction takes two operands:
1879 an unsigned LEB128\addtoindexx{LEB128!unsigned} 
1880 value representing a register number, and
1881 a \livelink{chap:DWFORMblock}{DW\_FORM\_block} 
1882 value representing a DWARF expression. The
1883 required action is to change the rule for the register
1884 indicated by the register number to be a val\_expression(E)
1885 rule where E is the DWARF expression. That is, the DWARF
1886 expression computes the value of the given register. The value
1887 of the CFA is pushed on the DWARF evaluation stack prior to
1888 execution of the DWARF expression.
1889
1890 \textit{See Section \refersec{chap:callframeinstructions} 
1891 regarding restrictions on the DWARF
1892 expression operators that can be used.}
1893
1894 \needlines{6}
1895 \item \textbf{ DW\_CFA\_restore} \\
1896 The \livetarg{chap:DWCFArestore}{DW\_CFA\_restore} instruction takes a single operand (encoded
1897 with the opcode) that represents a register number. The
1898 required action is to change the rule for the indicated
1899 register to the rule assigned it by the \texttt{initial\_instructions}
1900 in the CIE.
1901
1902 \needlines{5}
1903 \item \textbf{DW\_CFA\_restore\_extended} \\
1904 The \livetarg{chap:DWCFArestoreextended}{DW\_CFA\_restore\_extended}
1905 instruction takes a single unsigned LEB128\addtoindexx{LEB128!unsigned} 
1906 operand that represents a register number. This
1907 instruction is identical to \livelink{chap:DWCFArestore}{DW\_CFA\_restore} except for the
1908 encoding and size of the register operand.
1909
1910 \end{enumerate}
1911
1912 \subsubsection{Row State Instructions}
1913 \label{chap:rowstateinstructions}
1914
1915 \textit{The next two instructions provide the ability to stack and
1916 retrieve complete register states. They may be useful, for
1917 example, for a compiler that moves \addtoindex{epilogue} code 
1918 into the
1919 body of a function.}
1920
1921
1922 \begin{enumerate}[1. ]
1923
1924 \item \textbf{DW\_CFA\_remember\_state} \\
1925 The \livetarg{chap:DWCFArememberstate}{DW\_CFA\_remember\_state} instruction takes no operands. The
1926 required action is to push the set of rules for every register
1927 onto an implicit stack.
1928
1929 \needlines{4}
1930 \item \textbf{DW\_CFA\_restore\_state} \\
1931 The \livetarg{chap:DWCFArestorestate}{DW\_CFA\_restore\_state} instruction takes no operands. The
1932 required action is to pop the set of rules off the implicit
1933 stack and place them in the current row.
1934
1935 \end{enumerate}
1936
1937 \subsubsection{Padding Instruction}
1938 \label{chap:paddinginstruction}
1939 \begin{enumerate}[1. ]
1940 \item \textbf{DW\_CFA\_nop} \\
1941 The \livetarg{chap:DWCFAnop}{DW\_CFA\_nop} instruction has no operands and no required
1942 actions. It is used as padding to make a CIE or FDE an
1943 appropriate size
1944
1945 \end{enumerate}
1946
1947 \subsection{Call Frame Instruction Usage} 
1948 \label{chap:callframeinstructionusage}
1949
1950 \textit{To determine the virtual unwind rule set for a given location
1951 (L1), one searches through the FDE headers looking at the
1952 \texttt{initial\_location} and \texttt{address\_range} values to see if L1 is
1953 contained in the FDE. If so, then:}
1954 \begin{enumerate}[1. ]
1955
1956 \item \textit{Initialize a register set by reading the
1957 \texttt{initial\_instructions} field of the associated CIE.}
1958
1959 \item \textit{Read and process the FDE\textquoteright s instruction
1960 sequence until a \livelink{chap:DWCFAadvanceloc}{DW\_CFA\_advance\_loc}, 
1961 \livelink{chap:DWCFAsetloc}{DW\_CFA\_set\_loc}, or the
1962 end of the instruction stream is encountered.}
1963
1964 \item \textit{ If a \livelink{chap:DWCFAadvanceloc}{DW\_CFA\_advance\_loc} or 
1965 \livelink{chap:DWCFAsetloc}{DW\_CFA\_set\_loc}
1966 instruction is encountered, then compute a new location value
1967 (L2). If L1 $\geq$ L2 then process the instruction and go back
1968 to step 2.}
1969
1970 \item \textit{ The end of the instruction stream can be thought
1971 of as a \livelink{chap:DWCFAsetloc}{DW\_CFA\_set\_loc} (\texttt{initial\_location + address\_range})
1972 instruction. Note that the FDE is ill-formed if L2 is less
1973 than L1.}
1974
1975 \end{enumerate}
1976
1977 \textit{The rules in the register set now apply to location L1.}
1978
1979 \textit{For an example, see 
1980 Appendix \refersec{app:callframeinformationexample}.}
1981
1982
1983
1984 \subsection{Call Frame Calling Address}
1985 \label{chap:callframecallingaddress}
1986
1987 \textit{When unwinding frames, consumers frequently wish to obtain the
1988 address of the instruction which called a subroutine. This
1989 information is not always provided. Typically, however,
1990 one of the registers in the virtual unwind table is the
1991 Return Address.}
1992
1993 If a Return Address register is defined in the virtual
1994 unwind table, and its rule is undefined (for example, by
1995 \livelink{chap:DWCFAundefined}{DW\_CFA\_undefined}), then there is no return address and no
1996 call address, and the virtual unwind of stack activations
1997 is complete.
1998
1999 \textit{In most cases the return address is in the same context as the
2000 calling address, but that need not be the case, especially if
2001 the producer knows in some way the call never will return. The
2002 context of the 'return address' might be on a different line,
2003 in a different lexical \livelink{chap:lexicalblock}{block}, 
2004 or past the end of the calling
2005 subroutine. If a consumer were to assume that it was in the
2006 same context as the calling address, the unwind might fail.}
2007
2008 \textit{For architectures with constant-length instructions where
2009 the return address immediately follows the call instruction,
2010 a simple solution is to subtract the length of an instruction
2011 from the return address to obtain the calling instruction. For
2012 architectures with variable-length instructions (e.g.  x86),
2013 this is not possible. However, subtracting 1 from the return
2014 address, although not guaranteed to provide the exact calling
2015 address, generally will produce an address within the same
2016 context as the calling address, and that usually is sufficient.}
2017
2018
2019