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