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