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