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