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