Cleanup loose-ends from previous submission (Dec 18).
[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{} section.
7
8 In the descriptions that follow, these terms are used to
9 specify the representation of DWARF sections:
10 \begin{itemize}
11 \item
12 \HFTinitiallength{}, \HFTsectionoffset{} and 
13 \HFTsectionlength{}, which are
14 defined in 
15 Sections \refersec{datarep:initiallengthvalues} and 
16 \refersec{datarep:32bitand64bitdwarfformats}.
17 \item
18 \HFTsbyte{}, 
19 \HFTubyte{}, 
20 \HFTuhalf{} and 
21 \HFTuword{}, 
22 which are defined in 
23 Section \refersec{datarep:integerrepresentationnames}.
24 \end{itemize}
25
26 \section{Accelerated Access}
27 \label{chap:acceleratedaccess}
28
29 \textit{A debugger frequently needs to find the debugging information
30 \addtoindexx{accelerated access}
31 for a program entity defined outside of the compilation unit
32 where the debugged program is currently stopped. Sometimes the
33 debugger will know only the name of the entity; sometimes only
34 the address. To find the debugging information associated with
35 a global entity by name, using the DWARF debugging information
36 entries alone, a debugger would need to run through all
37 entries at the highest scope within each compilation unit.}
38
39 \textit{Similarly, in languages in which the name of a type is
40 required to always refer to the same concrete type (such as
41 C++), a compiler may choose to elide type definitions in
42 all compilation units except one. In this case a debugger
43 needs a rapid way of locating the concrete type definition
44 by name. As with the definition of global data objects, this
45 would require a search of all the top level type definitions
46 of all compilation units in a program.}
47
48 \needlines{4}
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 (including data objects, 
62 functions and types) by name or by address faster, a producer 
63 of DWARF information may provide two 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 \addtoindexx{lookup!by name}
70 \addtoindexx{accelerated access!by name}
71 For lookup by name, a name index is maintained in a separate
72 object file section named \dotdebugnames{}. 
73
74 \textit{The \dotdebugnames{} section is new in \DWARFVersionV,
75 and supersedes the \dotdebugpubnames{} and \dotdebugpubtypes{}
76 sections of earlier DWARF versions. While \dotdebugnames{} and
77 either \dotdebugpubnames{} and/or \dotdebugpubtypes{} sections
78 cannot both occur in the same compilation unit, both may be
79 found in the set of units that make up an executable or shared
80 object.}
81
82 The index consists
83 primarily of two parts: a list of names, and a list of index
84 entries. A name, such as a subprogram name, type name, or
85 variable name, may have several defining declarations in the
86 debugging information. In this case, the entry for that name in
87 the list of names will refer to a sequence of index entries in
88 the second part of the table, each corresponding to one defining
89 declaration in the \dotdebuginfo{} section.
90
91 The name index may also contain an optional hash table for faster
92 lookup.
93
94 A relocatable object file may contain a "per-CU" index, which
95 provides an index to the names defined in that compilation
96 unit.
97
98 An executable or shareable object file may contain either a collection of
99 "per-CU" indexes, simply copied from each relocatable object
100 file, or the linker may produce a "per-module" index by
101 combining the per-CU indexes into a single index that covers
102 the entire load module.
103
104 \subsubsection{Contents of the Name Index}
105 \label{chap:contentsofthenameindex}
106 The name index must contain an entry for each 
107 debugging information entry that defines a
108 named subprogram, label, variable, type, or namespace, 
109 subject to the following rules:
110 \begin{itemize}
111
112 \item All non-defining declarations (that is, 
113       debugging information entries with a
114       \DWATdeclaration{} attribute) are excluded.
115
116 \item \DWTAGnamespace{} debugging information entries 
117       without a \DWATname{} attribute are
118       included with the name 
119       \doublequote{\texttt{(anonymous namespace)}}.
120
121 \item All other debugging information entries 
122       without a \DWATname{} attribute are excluded.
123
124 \item \DWTAGsubprogram{}, \DWTAGinlinedsubroutine{}, and
125       \DWTAGlabel{} debugging information entries 
126       without an address attribute (\DWATlowpc{},
127       \DWAThighpc{}, \DWATranges{}, or \DWATentrypc{}) 
128       are excluded.
129
130 \item \DWTAGvariable{} debugging information entries 
131       with a \DWATlocation{} attribute that includes a 
132       \DWOPaddr{} or \DWOPformtlsaddress{} operator are
133       included; otherwise, they are excluded.
134
135 \item If a subprogram or inlined subroutine is included, and has a
136       \DWATlinkagename{} attribute, there will be an additional
137       index entry for the linkage name.
138       
139 \end{itemize}
140
141 For the purposes of determining whether a 
142 debugging information entry has a particular
143 attribute (such as \DWATname{}), if 
144 debugging information entry $A$ has a \DWATspecification{}
145 or \DWATabstractorigin{} attribute pointing to another 
146 debugging information entry $B$, any
147 attributes of $B$ are considered to be part of $A$.
148
149 \textit{The intent of the above rules is to provide the consumer with
150 some assurance that looking up an unqualified name in the index
151 will yield all relevant debugging information entries
152 that provide a defining declaration
153 at global scope for that name.}
154
155 \textit{A producer may choose to implement additional rules for what
156 names are placed in the index, and may communicate those rules to
157 a cooperating consumer via an augmentation string, described
158 below.}
159
160 \needlines{4}
161 \subsubsection{Structure of the Name Index}
162 \label{chap:structureofthenametindex}
163 Logically, the name index can be viewed as a list of names, 
164 with a list of index entries for each name. Each index entry 
165 corresponds to a debugging information entry 
166 that matches the criteria given in the previous section. For
167 example, if one compilation unit has a function named \texttt{fred} 
168 and another has a struct named \texttt{fred}, a lookup for 
169 \doublequote{fred} will find the list containing those two index 
170 entries.
171
172 The index section contains eight individual parts, as illustrated in 
173 Figure \referfol{fig:nameindexlayoutpart1}.
174 \begin{enumerate}
175 \item A header, describing the layout of the section.
176
177 \item A list of compile units (CUs) referenced by this index.
178
179 \item A list of local type units (TUs) referenced by this index
180     that are present in this object file.
181
182 \item A list of foreign type units (TUs) referenced by this index
183     that are not present in this object file (that is, that have
184     been placed in a \splitDWARFobjectfile{} as described in
185     \refersec{datarep:splitdwarfobjectfiles}).
186
187 \item An optional hash lookup table.
188
189 \item The name table.
190
191 \item An abbreviations table, similar to the one used by the
192     \dotdebuginfo{} section.
193
194 \item The entry pool, containing a list of index entries for each
195     name in the name list.
196 \end{enumerate}
197
198 \begin{figure}[p]
199 \figurepart{1}{2}
200 \begin{center}
201 %\includegraphics[keepaspectratio=true,scale=1.0]{name-index-drawings-6p1}
202
203 \begin{tikzpicture}[
204   every node/.style={node font=\small, anchor=north west, text height=.8em, text depth=.2em, inner sep=4pt, outer ysep=0},
205   caption/.style={node font=\small \bfseries, text width=90pt},
206   overview/.style={draw, node font=\small, minimum height=28pt, text width=80pt},
207   detail1/.style={draw, minimum height=14pt, text width=116pt},
208   detail2/.style={draw, minimum height=28pt, text width=116pt},
209   detail3/.style={draw, minimum height=48pt, text width=116pt},
210   detail4/.style={draw, minimum height=72pt, text width=116pt},
211   ellip/.style={draw, shape=broken rectangle, minimum height=14pt, text width=116pt},
212   explode/.style={draw=black!50, fill=black!20, line join=bevel},
213   header/.style={fill=headerblue},
214   culist/.style={fill=cutuyellow},
215   buckets/.style={fill=bucketsblue},
216   hashes/.style={fill=hashesgreen},
217   stroffsets/.style={fill=stroffsetspink},
218   entryoffsets/.style={fill=entryoffsetspink},
219   indexentries/.style={fill=indexentriesorange}
220 ]
221
222 % Name Table Overview
223
224 \begin{scope}[start chain=going below, node distance=0]
225   \node           [on chain,caption]  {Name Index};
226   \node (header)  [on chain,overview,header] {Header};
227   \node (culist)  [on chain,overview,header] {CU List};
228   \node (ltulist) [on chain,overview,header] {Local TU List};
229   \node (ftulist) [on chain,overview,header] {Foreign TU List};
230   \node (hash)    [on chain,overview,header] {Hash Table};
231   \node (names)   [on chain,overview,header] {Name Table};
232   \node (abbrev)  [on chain,overview,header] {Abbrev Table};
233   \node (pool)    [on chain,overview,header] {Entry Pool};
234 \end{scope}
235
236 % Exploded View of CU List
237
238 \begin{scope}[start chain=going below, node distance=0, shift={($(header.north east) + (72pt,18pt)$)}]
239   \node (cu0) [on chain,detail1,culist] {offset to CU 0};
240   \node (cu1) [on chain,detail1,culist] {offset to CU 1};
241   \node (cu2) [on chain,ellip,culist]   {\dots};
242   \node (cu3) [on chain,detail1,culist] {offset to CU $k - 1$};
243 \end{scope}
244
245 \begin{scope}[on background layer]
246   \filldraw [explode] (culist.north east) -- (cu0.north west) -- (cu3.south west) -- (culist.south east) -- cycle;
247 \end{scope}
248
249 \path [decoration={brace,amplitude=6pt}] ([xshift=9pt]cu0.north east)
250       [draw,decorate] -- ([xshift=9pt]cu3.south east)
251       node [midway,right,inner xsep=9pt] {\texttt{comp\_unit\_count} $(= k)$};
252
253 % Exploded View of Local TU List
254
255 \begin{scope}[start chain=going below, node distance=0, shift={($(cu3.south west) + (0,-9pt)$)}]
256   \node (ltu0) [on chain,detail1,culist] {offset to TU 0};
257   \node (ltu1) [on chain,detail1,culist] {offset to TU 1};
258   \node (ltu2) [on chain,ellip,culist]   {\dots};
259   \node (ltu3) [on chain,detail1,culist] {offset to TU $t - 1$};
260 \end{scope}
261
262 \begin{scope}[on background layer]
263   \filldraw [explode] (ltulist.north east) -- (ltu0.north west) -- (ltu3.south west) -- (ltulist.south east) -- cycle;
264 \end{scope}
265
266 \path [decoration={brace,amplitude=6pt}] ([xshift=9pt]ltu0.north east)
267       [draw,decorate] -- ([xshift=9pt]ltu3.south east)
268       node [midway,right,inner xsep=9pt] {\texttt{local\_type\_unit\_count} $(= t)$};
269
270 % Exploded View of Foreign TU List
271
272 \begin{scope}[start chain=going below, node distance=0, shift={($(ltu3.south west) + (0,-9pt)$)}]
273   \node (ftu0) [on chain,detail1,culist] {signature of TU $t$};
274   \node (ftu1) [on chain,detail1,culist] {signature of TU $t + 1$};
275   \node (ftu2) [on chain,ellip,culist]   {\dots};
276   \node (ftu3) [on chain,detail1,culist] {signature of TU $t + f - 1$};
277 \end{scope}
278
279 \begin{scope}[on background layer]
280   \filldraw [explode] (ftulist.north east) -- (ftu0.north west) -- (ftu3.south west) -- (ftulist.south east) -- cycle;
281 \end{scope}
282
283 \path [decoration={brace,amplitude=6pt}] ([xshift=9pt]ftu0.north east)
284       [draw,decorate] -- ([xshift=9pt]ftu3.south east)
285       node [midway,right,inner xsep=9pt] {\texttt{foreign\_type\_unit\_count} $(= f)$};
286
287 % Exploded View of Hash Table
288
289 \begin{scope}[start chain=going below, node distance=0, shift={($(ftu3.south west) + (0,-9pt)$)}]
290   \node (hash0) [on chain,detail2,buckets] {Buckets};
291   \node (hash1) [on chain,detail3,hashes]  {Hashes};
292 \end{scope}
293
294 \begin{scope}[on background layer]
295   \filldraw [explode] (hash.north east) -- (hash0.north west) -- (hash1.south west) -- (hash.south east) -- cycle;
296 \end{scope}
297
298 % Exploded View of Name Table
299
300 \begin{scope}[start chain=going below, node distance=0, shift={($(hash1.south west) + (0,-9pt)$)}]
301   \node (name0) [on chain,detail3,stroffsets]   {String Offsets};
302   \node (name1) [on chain,detail3,entryoffsets] {Entry Offsets};
303 \end{scope}
304
305 \begin{scope}[on background layer]
306   \filldraw [explode] (names.north east) -- (name0.north west) -- (name1.south west) -- (names.south east) -- cycle;
307 \end{scope}
308
309 % Exploded View of Entry Pool
310
311 \begin{scope}[shift={($(name1.south west) + (0,-9pt)$)}]
312   \node (pool0) [detail4,indexentries] {Index Entries};
313 \end{scope}
314
315 \begin{scope}[on background layer]
316   \filldraw [explode] (pool.north east) -- (pool0.north west) -- (pool0.south west) -- (pool.south east) -- cycle;
317 \end{scope}
318
319 %
320 \path [decoration={brace,amplitude=6pt}] ([xshift=9pt]hash0.north east)
321       [draw,decorate] -- ([xshift=9pt]pool0.south east)
322       node [midway,right,inner xsep=9pt] {\textit{see figure part 2 on next page}};
323
324 % Arrows pointing to .debug_info
325
326 \begin{scope}[shift={($(cu0.north east) + (15pt,27pt)$)}]
327   \node (debuginfo) {\textit{.debug\_info}};
328 \end{scope}
329
330 \path ([xshift=28pt]cu0.center) coordinate (p1);
331 \path ([xshift=14pt]p1) coordinate (c1);
332 \path ([yshift=2pt]debuginfo.west) coordinate (p2);
333 \path ([xshift=-14pt]p2) coordinate (c2);
334 \draw [dashed,{Circle[open]}-{Stealth[]}] (p1) .. controls (c1) and (c2) .. (p2);
335
336 \path ([xshift=28pt]ltu0.center) coordinate (p3);
337 \path ([xshift=60pt]p3) coordinate (c3);
338 \path ([yshift=-2pt]debuginfo.west) coordinate (p4);
339 \path ([shift={(-21pt,-7pt)}]p4) coordinate (c4);
340 \draw [dashed,{Circle[open]}-{Stealth[]}] (p3) .. controls (c3) and (c4) .. (p4);
341
342 \end{tikzpicture}
343
344 \caption{Name Index Layout}
345 \label{fig:nameindexlayoutpart1}
346 \end{center}
347 \end{figure}
348
349 \begin{figure}[p]
350 \figurepart{2}{2}
351 \begin{center}
352 %\includegraphics[keepaspectratio=true,scale=1.0]{name-index-drawings-6p2}
353
354 \begin{tikzpicture}[
355   every node/.style={node font=\small, anchor=north west, text height=.8em, text depth=.2em, inner sep=4pt, outer ysep=0},
356   % This diagram has a couple of two-line captions, so set the text depth
357   % to make room for the second line.
358   caption1/.style={node font=\small \bfseries, text depth=1.2em, text width=90pt},
359   caption2/.style={node font=\small \bfseries, text depth=1.2em, text width=41pt},
360   detail1/.style={draw, minimum height=14pt, text width=90pt},
361   detail2/.style={draw, minimum height=14pt, text width=41pt},
362   ellip1/.style={draw, shape=broken rectangle, minimum height=14pt, text width=90pt},
363   ellip2/.style={draw, shape=broken rectangle, minimum height=14pt, text width=41pt},
364   buckets/.style={fill=bucketsblue},
365   hashes/.style={fill=hashesgreen},
366   stroffsets/.style={fill=stroffsetspink},
367   entryoffsets/.style={fill=entryoffsetspink}
368 ]
369
370 % Buckets
371
372 \begin{scope}[start chain=going below, node distance=0]
373   \node           [on chain,caption1]        {\\ Buckets};
374   \node (bucket0) [on chain,detail1,buckets] {bucket 0};
375   \node (bucket1) [on chain,detail1,buckets] {bucket 1};
376   \node (bucket2) [on chain,ellip1,buckets]  {\dots};
377   \node (bucket3) [on chain,detail1,buckets] {bucket $b - 1$};
378 \end{scope}
379
380 \path [decoration={brace,amplitude=6pt}] ([xshift=40pt]bucket0.north east)
381       [draw,decorate] -- ([xshift=40pt]bucket3.south east)
382       node [midway,right,inner xsep=9pt] {\texttt{bucket\_count} $(= b)$};
383
384 % Hashes
385
386 \begin{scope}[start chain=going below, node distance=0, shift={($(bucket3.south east) + (18pt,-24pt)$)}]
387   \node (hashes) [on chain,caption1]       {\\ Hashes};
388   \node (hash0)  [on chain,detail1,hashes] {hash value 1};
389   \node (hash1)  [on chain,detail1,hashes] {hash value 2};
390   \node (hash2)  [on chain,detail1,hashes] {hash value 3};
391   \node (hash3)  [on chain,detail1,hashes] {hash value 4};
392   \node (hash4)  [on chain,detail1,hashes] {hash value 5};
393   \node (hash5)  [on chain,ellip1,hashes]  {\dots};
394   \node (hash6)  [on chain,detail1,hashes] {hash value $n$};
395 \end{scope}
396
397 % String Offsets
398
399 \begin{scope}[start chain=going below, node distance=0, shift={($(hashes.north east)$)}]
400   \node (strs) [on chain,caption2]           {String \\ Offsets};
401   \node (str0) [on chain,detail2,stroffsets] {};
402   \node (str1) [on chain,detail2,stroffsets] {};
403   \node (str2) [on chain,detail2,stroffsets] {};
404   \node (str3) [on chain,detail2,stroffsets] {};
405   \node (str4) [on chain,detail2,stroffsets] {};
406   \node (str5) [on chain,ellip2,stroffsets]  {};
407   \node (str6) [on chain,detail2,stroffsets] {};
408 \end{scope}
409
410 % Entry Offsets
411
412 \begin{scope}[start chain=going below, node distance=0, shift={($(strs.north east)$)}]
413   \node (entries) [on chain,caption2]             {Entry \\ Offsets};
414   \node (entry0)  [on chain,detail2,entryoffsets] {};
415   \node (entry1)  [on chain,detail2,entryoffsets] {};
416   \node (entry2)  [on chain,detail2,entryoffsets] {};
417   \node (entry3)  [on chain,detail2,entryoffsets] {};
418   \node (entry4)  [on chain,detail2,entryoffsets] {};
419   \node (entry5)  [on chain,ellip2,entryoffsets]  {};
420   \node (entry6)  [on chain,detail2,entryoffsets] {};
421 \end{scope}
422
423 \path [decoration={brace,amplitude=6pt}] ([xshift=9pt]entry0.north east)
424       [draw,decorate] -- ([xshift=9pt]entry6.south east)
425       node [midway,right,inner xsep=9pt] {\begin{tabular}{c} 
426                                           \texttt{name\_count} \\ 
427                                                      $(= n)$ 
428                                           \end{tabular}};
429
430 % Arrows pointing to .debug_str and entry pool
431
432 \path (str0.center) coordinate (p1);
433 \path ([xshift=18pt]p1) coordinate (c1);
434 \path ([shift={(36pt,45pt)}]p1) coordinate (p2);
435 \path ([xshift=-18pt]p2) coordinate (c2);
436 \draw [dashed,{Circle[open]}-{Stealth[]}] (p1) .. controls (c1) and (c2) .. (p2) node [anchor=west] {$.debug\_str$};
437
438 \path (entry0.center) coordinate (p3);
439 \path ([xshift=18pt]p3) coordinate (c3);
440 \path ([shift={(36pt,27pt)}]p3) coordinate (p4);
441 \path ([xshift=-18pt]p4) coordinate (c4);
442 \draw [dashed,{Circle[open]}-{Stealth[]}] (p3) .. controls (c3) and (c4) .. (p4) node [anchor=west] {$entry\ pool$};
443
444 % Arrows from buckets to hashes
445
446 \path ([xshift=24pt]bucket0.center) coordinate (p5);
447 \path ([xshift=130pt]p5) coordinate (c5);
448 \path ([xshift=-70pt]hash0.west) coordinate (c6);
449 \draw [dashed,{Circle[open]}-{Stealth[]}] (p5) .. controls (c5) and (c6) .. (hash0.west);
450
451 \path ([xshift=24pt]bucket1.center) coordinate (p7);
452 \path ([xshift=120pt]p7) coordinate (c7);
453 \path ([xshift=-144pt]hash3.west) coordinate (c8);
454 \draw [dashed,{Circle[open]}-{Stealth[]}] (p7) .. controls (c7) and (c8) .. (hash3.west);
455
456 \end{tikzpicture}
457
458 \vspace{15mm}
459
460 %\includegraphics[keepaspectratio=true,scale=1.0]{name-index-drawings-6p3}
461 \begin{tikzpicture}[
462   every node/.style={node font=\small, anchor=north west, text height=.8em, text depth=.2em, inner sep=4pt, outer ysep=0},
463   caption/.style={node font=\small \bfseries, text width=120pt},
464   detail/.style={draw, node font=\small, minimum height=14pt, text width=120pt},
465   ellip/.style={draw, shape=broken rectangle, minimum height=14pt, text width=120pt},
466   explode/.style={draw=black!50, fill=black!20, line join=bevel},
467   indexentries/.style={fill=indexentriesorange}
468 ]
469
470 % Entry Pool
471
472 \begin{scope}[start chain=going below, node distance=0]
473   \node           [on chain,caption]             {Entry Pool};
474   \node (entry0)  [on chain,detail,indexentries] {index entry \#1 for ``a''};
475   \node (entry1)  [on chain,detail,indexentries] {index entry \#2 for ``a''};
476   \node (entry2)  [on chain,ellip,indexentries]  {\dots};
477   \node (entry3)  [on chain,detail,indexentries] {0 \textit{(end of entries for ``a'')}};
478   \node (entry4)  [on chain,detail,indexentries] {index entry \#1 for ``b''};
479   \node (entry5)  [on chain,detail,indexentries] {index entry \#2 for ``b''};
480   \node (entry6)  [on chain,ellip,indexentries]  {\dots};
481   \node (entry7)  [on chain,detail,indexentries] {0};
482   \node (entry8)  [on chain,detail,indexentries] {index entry \#1 for ``c''};
483   \node (entry9)  [on chain,ellip,indexentries]  {\dots};
484 \end{scope}
485
486 % Exploded Index Entry
487
488 \begin{scope}[start chain=going below, node distance=0, shift={($(entry1.north east) + (60pt,30pt)$)}]
489   \node (abbrev) [on chain,detail,indexentries] {abbrev code};
490   \node (attr1)  [on chain,detail,indexentries] {attribute};
491   \node (attr2)  [on chain,detail,indexentries] {attribute};
492   \node (attr3)  [on chain,ellip,indexentries]  {\dots};
493   \node (attr4)  [on chain,detail,indexentries] {attribute};
494 \end{scope}
495
496 \begin{scope}[on background layer]
497   \filldraw [explode] (entry1.north east) -- (abbrev.north west) -- (attr4.south west) -- (entry1.south east) -- cycle;
498 \end{scope}
499
500 % Arrows
501
502 \node (from1) [anchor=east] at ([xshift=-36pt]entry0.west) {\textit{(from name table)}};
503 \draw [dashed,-{Stealth[]}] (from1) -- (entry0.west);
504
505 \node (from2) [anchor=east] at ([xshift=-36pt]entry4.west) {\textit{(from name table)}};
506 \draw [dashed,-{Stealth[]}] (from2) -- (entry4.west);
507
508 \node (from2) [anchor=east] at ([xshift=-36pt]entry7.west) {\textit{(from name table)}};
509 \draw [dashed,-{Stealth[]}] (from2) -- (entry7.west);
510
511 \end{tikzpicture}
512
513 \vspace{3mm}
514 %\caption{Name Index Layout \textit{(concluded)}}
515 Figure~\ref{fig:nameindexlayoutpart1}: Name Index Layout \textit{(concluded)}
516 %\label{fig:nameindexlayoutpart2}
517 \end{center}
518 \end{figure}
519
520 The formats of the header and the hash lookup table are described
521 in Section \refersec{chap:datarepresentationofthenameindex}.
522
523 The list of CUs and the list of local TUs are each an array of
524 offsets, each of which is the offset of a compile unit or a type unit
525 in the \dotdebuginfo{} section. For a per-CU index, there is a single CU
526 entry, and there may be a TU entry for each type unit generated in the
527 same translation unit as the single CU. For a per-module index, there
528 will be one CU entry for each compile unit in the module, and one TU
529 entry for each unique type unit in the module. Each list is indexed
530 starting at 0.
531
532 The list of foreign TUs is an array of 64-bit (\DWFORMrefsigeight) type
533 signatures, representing types referenced by the index whose
534 definitions have been placed in a different object file (that is, a split
535 DWARF object). This list may be empty. 
536 The foreign TU list immediately follows the local TU list 
537 and they both use the same index, so that if there are $N$ local TU entries, 
538 the index for the first foreign TU is $N$.
539
540 The name table is logically a table with a row for each unique name in
541 the index, and two columns. The first column contains a reference to
542 the name, as a string. The second column contains the offset within
543 the entry pool of the list of index entries for the name.
544
545 \needlines{4}
546 The abbreviations table describes the formats of the entries in the
547 entry pool. Like the DWARF abbreviations table in the \dotdebugabbrev{}
548 section, it defines one or more abbreviation codes. Each abbreviation
549 code provides a DWARF tag value followed by a list of pairs that
550 defines an attribute and form code used by entries with that
551 abbreviation code.
552
553 The entry pool contains all the index entries, grouped by name. The
554 second column of the name list points to the first index entry for the
555 name, and all the index entries for that name are placed one after the
556 other.
557
558 Each index entry begins with an unsigned LEB128 abbreviation code.
559 The  abbreviation list for that code provides the DWARF tag value for
560 the entry as well as the set of attributes provided by the entry and
561 their forms.
562
563 \needlines{4}
564 The standard attributes are:
565 \begin{itemize}
566 \item Compilation Unit (CU), a reference to an entry in the list of
567     CUs. In a per-CU index, index entries without this attribute
568     implicitly refer to the single CU.
569
570 \item Type Unit (TU), a reference to an entry in the list of local
571     or foreign TUs.
572
573 \item Debugging information entry offset within the CU or TU.
574
575 \item Parent debugging information entry, 
576     a reference to the index entry for the parent.
577     This is represented as the offset of the entry relative to
578     the start of the entry pool.
579
580 \item Type hash, an 8-byte hash of the type declaration.
581
582 \end{itemize}
583
584 \needlines{6}
585 It is possible that an indexed debugging information entry
586 has a parent that is not
587 indexed (for example, if its parent does not have a name attribute). 
588 In such a case, a parent attribute may point to a nameless index
589 entry (that is, one that cannot be reached from any entry in the
590 name table), or it may point to the nearest ancestor that does
591 have an index entry.
592
593 A producer may define additional vendor-specific attributes, 
594 and a consumer will be able to ignore and skip over any attributes 
595 it is not prepared to handle.
596
597 \needlines{4}
598 When an index entry refers to a foreign type unit, it may have
599 attributes for both CU and (foreign) TU. For such entries, the CU
600 attribute gives the consumer a reference to the CU that may be used to
601 locate a \splitDWARFobjectfile{} that contains the type unit.
602
603 \textit{The type hash attribute, not to be confused with the type signature
604 for a TU, may be provided for type entries whose declarations are not
605 in a type unit, for the convenience of link-time or post-link
606 utilities that wish to de-duplicate type declarations across
607 compilation units. The type hash, however, is computed by the
608 same method as specified for type signatures.}
609
610 The last entry for each name is followed by a zero byte that
611 terminates the list. There may be gaps between the lists.
612
613 \subsubsection{Per-CU versus Per-Module Indexes}
614 \label{chap:percuvspermoduleindexes}
615 \textit{In a per-CU index, the CU list may have only a single entry, 
616 and index entries may omit the CU attribute. (Cross-module or link-time
617 optimization, however, may produce an object file with several compile
618 units in one object. A compiler in this case may produce a separate
619 index for each CU, or a combined index for all CUs. In the latter
620 case, index entries will require the CU attribute.) Most name table
621 entries may have only a single index entry for each, but sometimes a
622 name may be used in more than one context and will require multiple
623 index entries, each pointing to a different debugging information
624 entry.}
625
626 \textit{When linking object files containing per-CU indexes, the 
627 linker may choose to concatenate the indexes as ordinary sections, 
628 or it may choose to combine the input indexes into a single 
629 per-module index.}
630
631 \textit{A per-module index will contain a number of CUs, and each index 
632 entry contains a CU attribute or a TU attribute to identify which 
633 CU or TU contains the debugging information entry being indexed. When a
634 given name is used in multiple CUs or TUs, it will typically have a
635 series of index entries pointing to each CU or TU where it is declared. 
636 For example, an index entry for a \addtoindex{C++} namespace needs to
637 list each occurrence, since each CU may contribute additional names to
638 the namespace, and the consumer needs to find them all. On the
639 other hand, some index entries do not need to list more than one
640 definition; for example, with the one-definition rule in \addtoindex{C++},
641 duplicate entries for a function may be omitted, since the consumer
642 only needs to find one declaration. Likewise, a per-module index needs
643 to list only a single copy of a type declaration contained in a type
644 unit.}
645
646 \textit{For the benefit of link-time or post-link utilities that consume
647 per-CU indexes and produce a per-module index, the per-CU index
648 entries provide the tag encoding for the original debugging
649 information entry, and may provide a type hash for certain types that
650 may benefit from de-duplication. For example, the standard declaration
651 of the typedef \texttt{uint32\_t} is likely to occur in many CUs, but a
652 combined per-module index needs to retain only one; a user declaration
653 of a typedef \texttt{mytype} may refer to a different type at each
654 occurrence, and a combined per-module index retains each unique
655 declaration of that type.}
656
657
658 \subsubsection{Data Representation of the Name Index}
659 \label{chap:datarepresentationofthenameindex}
660 The name index is placed in a section named \dotdebugnames, and
661 consists of the eight parts described in the following sections.
662
663 \subsubsubsection{Section Header}
664 \label{chap:sectionheader}
665 The section header contains the following fields:
666 \begin{enumerate}[1. ]
667 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length}) \\
668 \addttindexx{unit\_length}
669 The length of this contribution to the name index section,
670 not including the length field itself.
671
672 \item \texttt{version} (\HFTuhalf) \\
673 A version number\addtoindexx{version number!name index table} 
674 (see Section \refersec{datarep:nameindextable}). 
675 This number is specific to the name index table and is
676 independent of the DWARF version number.
677
678 \item \textit{padding} (\HFTuhalf) \\
679 Reserved to DWARF (must be zero). 
680
681 \item \texttt{comp\_unit\_count} (\HFTuword) \\
682 The number of CUs in the CU list.
683
684 \item \texttt{local\_type\_unit\_count} (\HFTuword) \\
685 The number of TUs in the local TU list.
686
687 \item \texttt{foreign\_type\_unit\_count} (\HFTuword) \\
688 The number of TUs in the foreign TU list.
689
690 \item \texttt{bucket\_count} (\HFTuword) \\
691 The number of hash buckets in the hash lookup table. 
692 If there is no hash lookup table, this field contains 0.
693
694 \item \texttt{name\_count} (\HFTuword) \\
695 The number of unique names in the index.
696
697 \item \texttt{abbrev\_table\_size} (\HFTuword) \\
698 The size in bytes of the abbreviations table.
699
700 \item \texttt{augmentation\_string\_size} (\HFTuword) \\
701 The size in bytes of the augmentation string. This value is
702 rounded up to a multiple of 4.
703
704 \item \texttt{augmentation\_string} (\HFTaugstring) \\
705 A vendor-specific augmentation string, which provides additional 
706 information about the contents of this index. If provided, the string
707 begins with a 4-character vendor ID. The remainder of the
708 string is meant to be read by a cooperating consumer, and its
709 contents and interpretation are not specified here. The
710 string is padded with null characters to a multiple of
711 four bytes in length.
712
713 \textit{The presence of an unrecognised augmentation string may make it impossible
714 for a consumer to process data in the \dotdebugnames{} section.}
715
716 \end{enumerate}
717
718 \needlines{4}
719 \subsubsubsection{List of CUs}
720 The list of CUs immediately follows the header. Each entry in the 
721 list is an offset of the corresponding compilation unit
722 in the \dotdebuginfo{} section.
723 In the DWARF-32 format, a section offset is 4 bytes, 
724 while in the DWARF-64 format, a section offset is 8 bytes.
725
726 The total number of entries in the list is given by \texttt{comp\_unit\_count}.
727 There must be at least one CU.
728
729 \needlines{4}
730 \subsubsubsection{List of Local TUs}
731 The list of local TUs immediately follows the list of CUs. Each 
732 entry in the list is an offset of the corresponding type unit
733 in the \dotdebuginfo{} section. 
734 In the DWARF-32 format, a section offset is 4 bytes, 
735 while in the DWARF-64 format, a section offset is 8 bytes.
736
737 The total number of entries in the list is given by
738 \texttt{local\_type\_unit\_count}. This list may be empty.
739
740 \subsubsubsection{List of Foreign TUs}
741 The list of foreign TUs immediately follows the list of local TUs.
742 Each entry in the list is a 8-byte type signature (as described by
743 \DWFORMrefsigeight).
744
745 The number of entries in the list is given by \texttt{foreign\_type\_unit\_count}.
746 This list may be empty.
747
748 \needlines{4}
749 \subsubsubsection{Hash Lookup Table}
750 The optional hash lookup table immediately follows the list of type signatures.
751
752 The hash lookup table is actually two separate arrays: an array of
753 buckets, followed immediately by an array of hashes. The number of
754 entries in the buckets array is given by \texttt{bucket\_count}, and the number
755 of entries in the hashes array is given by \texttt{name\_count}. Each array
756 contains 4-byte unsigned integers.
757
758 \needlines{4}
759 Symbols are entered into the hash table by first computing a hash
760 value from the symbol name. The hash is computed 
761 using the "DJB" hash function\addtoindexx{DJB hash function} 
762 described in Section \refersec{datarep:nametablehashfunction}.
763 Given a hash value for the symbol,
764 the symbol is entered into a bucket whose index is the hash value
765 modulo \texttt{bucket\_count}. The buckets array is indexed starting at 0.
766
767 Each bucket contains the index of an entry in the hashes array. The
768 hashes array is indexed starting at 1, and an empty bucket is
769 represented by the value 0.
770
771 \needlines{4}
772 The hashes array contains a sequence of the full hash values for each
773 symbol. All symbols that have the same index into the bucket list 
774 follow one another in the hashes array, and the indexed entry in 
775 the bucket list refers to the first symbol. 
776 When searching for a symbol, the search 
777 starts at the index given by the bucket, and continues either until a
778 matching symbol is found or until a hash value from a different bucket
779 is found. If two different symbol names produce the same hash value,
780 that hash value will occur twice in the hashes array. Thus, if a
781 matching hash value is found, but the name does not match, the search
782 continues visiting subsequent entries in the hashes table.
783
784 When a matching hash value is found in the hashes array, the index of
785 that entry in the hashes array is used to find the corresponding entry
786 in the name table.
787
788 \needlines{6}
789 \subsubsubsection{Name Table}
790 \label{chap:nametable}
791 The name table immediately follows the hash lookup table. It
792 consists of two arrays: an array of string offsets, followed
793 immediately by an array of entry offsets. The items in both
794 arrays are section offsets: 4-byte unsigned integers for the
795 DWARF-32 format or 8-byte unsigned integers for the DWARF-64
796 format. The string offsets in the first array refer to names in
797 the \dotdebugstr{} (or \dotdebugstrdwo) section. The entry offsets
798 in the second array refer to index entries, and are relative to
799 the start of the entry pool area.
800
801 These two arrays are indexed starting at 1, and correspond 
802 one-to-one with each other. The length of each array is
803 given by \texttt{name\_count}.
804
805 If there is a hash lookup table, the hashes array corresponds on
806 a one-to-one basis with the string offsets array and with the
807 entry offsets array.
808
809 \textit{If there is no hash lookup table, there is no ordering
810 requirement for the name table.}
811
812 \needlines{6}
813 \subsubsubsection{Abbreviations Table}
814 The abbreviations table immediately follows the name table. This table
815 consists of a series of abbreviation declarations. Its size is given
816 by \texttt{abbrev\_table\_size}.
817
818 Each abbreviation declaration defines the tag and other attributes for
819 a particular form of index entry. Each declaration starts with an
820 unsigned LEB128 number representing the abbreviation code itself. It
821 is this code that appears at the beginning of an index entry. The
822 abbreviation code must not be 0.
823
824 The abbreviation code is followed by another unsigned LEB128 number
825 that encodes the tag of the debugging information entry corresponding
826 to the index entry.
827
828 Following the tag encoding is a series of attribute specifications.
829 Each attribute consists of two parts: an unsigned LEB128 number that
830 represents the index attribute, and another unsigned LEB128 number
831 that represents the attribute's form (as described in 
832 Section \refersec{datarep:attributeencodings}). The series of attribute 
833 specifications ends with an entry containing 0 for the attribute and 
834 0 for the form.
835
836 The index attributes and their meanings are listed in 
837 Table \referfol{tab:indexattributeencodings}.
838
839 \begin{centering}
840 \setlength{\extrarowheight}{0.1cm}
841 \begin{longtable}{l|l}
842   \caption{Index attribute encodings} \label{tab:indexattributeencodings}\\
843   \hline \bfseries Attribute name &\bfseries Meaning \\ \hline
844 \endfirsthead
845   \bfseries Attribute name &\bfseries Meaning \\ \hline
846 \endhead
847   \hline \emph{Continued on next page}
848 \endfoot
849   \hline
850 \endlastfoot
851 \DWIDXcompileunitTARG & Index of CU                                  \\
852 \DWIDXtypeunitTARG    & Index of TU (\mbox{local} or foreign)        \\
853 \DWIDXdieoffsetTARG   & Offset of DIE within CU or TU                \\
854 \DWIDXparentTARG      & Index of name \mbox{table} entry for parent  \\
855 \DWIDXtypehashTARG    & Hash of type \mbox{declaration}              \\
856 \end{longtable}
857 \end{centering}
858
859 The abbreviations table ends with an entry consisting of a single 0
860 byte for the abbreviation code. The size of the table given by
861 \texttt{abbrev\_table\_size} may include optional padding following the
862 terminating 0 byte.
863
864 \subsubsubsection{Entry Pool}
865 The entry pool immediately follows the abbreviations table. 
866 Each entry in the entry offsets array in the name table (see 
867 Section \ref{chap:nametable})
868 points to an offset in the entry pool, where a series
869 of index entries for that name is located.
870
871 \needlines{4}
872 Each index entry in the series begins with an abbreviation code, and is
873 followed by the attributes described by the abbreviation declaration
874 for that code. The last index entry in the series is followed by a
875 terminating entry whose abbreviation code is 0.
876
877 Gaps are not allowed between entries in a series (that is, the entries
878 for a single name must all be contiguous), but there may be gaps
879 between series.
880
881 \textit{For example, a producer/consumer combination may find
882 it useful to maintain alignment.}
883
884 The size of the entry pool is the remaining size of the contribution to
885 the index section, as defined by the \texttt{unit\_length} header field.
886
887 \subsection{Lookup by Address}
888 \label{chap:lookupbyaddress}
889 For \addtoindexx{lookup!by address}
890 lookup by address, a table is maintained in a separate
891 \addtoindexx{accelerated access!by address}
892 object file section called 
893 \dotdebugaranges{}. The table consists
894 of sets of variable length entries, each set describing the
895 portion of the program\textquoteright{}s address space that is covered by
896 a single compilation unit.
897
898 \needlines{4}
899 Each set begins with a header containing five values:
900 \begin{enumerate}[1. ]
901 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length}) \\
902 \addttindexx{unit\_length}
903 The length of this contribution to the address lookup section,
904 not including the length field itself.
905
906 \item \texttt{version} (\HFTuhalf) \\
907 A version number\addtoindexx{version number!address lookup table}
908 (see Section \refersec{datarep:addrssrangetable}). 
909 This number is specific to the address lookup table and is
910 independent of the DWARF version number.
911
912 \item \texttt{debug\_info\_offset} (section offset) \\
913 The offset from the
914 \addtoindexx{section offset!in .debug\_aranges header}
915 beginning of the \dotdebuginfo{} section of the
916 compilation unit header referenced by the set.
917
918 \item \texttt{address\_size} (\HFTubyte) \\
919 The \addtoindex{size of an address}
920 in bytes on
921 \addttindexx{address\_size}
922 the target architecture. For 
923 \addtoindexx{address space!segmented}
924 segmented addressing, this is
925 the size of the offset portion of the address.
926
927 \item \HFNsegmentselectorsize{} (\HFTubyte) \\
928 The size of a segment selector in
929 bytes on the target architecture. If the target system uses
930 a flat address space, this value is 0.
931
932 \end{enumerate}
933
934 This header is followed by a variable number of address range
935 descriptors. Each descriptor is a triple consisting of a
936 segment selector, the beginning address within that segment
937 of a range of text or data covered by some entry owned by
938 the corresponding compilation unit, followed by the non-zero
939 length of that range. A particular set is terminated by an
940 entry consisting of three zeroes. 
941 When the \HFNsegmentselectorsize{} value
942 is zero in the header, the segment selector is omitted so that
943 each descriptor is just a pair, including the terminating
944 entry. By scanning the table, a debugger can quickly decide
945 which compilation unit to look in to find the debugging
946 information for an object that has a given address.
947
948 \textit{If the range of addresses covered by the text and/or data
949 of a compilation unit is not contiguous, then there may be
950 multiple address range descriptors for that compilation unit.}
951
952
953 \section{Line Number Information}
954 \label{chap:linenumberinformation}
955 \textit{A source\dash level debugger needs to know how to
956 \addtoindexx{line number information|see{\textit{also} statement list attribute}}
957 associate locations in the source files with the corresponding
958 machine instruction addresses in the executable or the shared 
959 object files used by that executable object file. Such an
960 association makes it possible for the debugger user
961 to specify machine instruction addresses in terms of source
962 locations. This is done by specifying the line number
963 and the source file containing the statement. The debugger
964 can also use this information to display locations in terms
965 of the source files and to single step from line to line,
966 or statement to statement.}
967
968 Line number information generated for a compilation unit is
969 represented in the 
970 \dotdebugline{} section of an object file, and optionally
971 also in the \dotdebuglinestr{} section, and
972 is referenced by a corresponding compilation unit debugging
973 information entry 
974 (see Section \refersec{chap:fullandpartialcompilationunitentries}) 
975 in the \dotdebuginfo{} section.
976
977 \textit{Some computer architectures employ more than one instruction
978 set (for example, the ARM 
979 \addtoindexx{ARM instruction set architecture}
980 and 
981 MIPS architectures support
982 \addtoindexx{MIPS instruction set architecture}
983 a 32-bit as well as a 16-bit instruction set). Because the
984 instruction set is a function of the program counter, it is
985 convenient to encode the applicable instruction set in the
986 \dotdebugline{} section as well.}
987
988 \textit{If space were not a consideration, the information provided
989 in the \dotdebugline{} 
990 section could be represented as a large
991 matrix, with one row for each instruction in the emitted
992 object code. The matrix would have columns for:}
993 \begin{itemize}
994 \item \textit{the source file name}
995 \item \textit{the source line number}
996 \item \textit{the source column number}
997 \item \textit{whether this instruction is the beginning of a source statement}
998 \item \textit{whether this instruction is the beginning of a \addtoindex{basic block}}
999 \item \textit{and so on}
1000 \end{itemize}
1001 \textit{Such a matrix, however, would be impractically large. We
1002 shrink it with two techniques. First, we delete from
1003 the matrix each row whose file, line, source column and
1004 discriminator\addttindexx{discriminator} 
1005 is identical with that of its
1006 predecessors. Any deleted row would never be the beginning of
1007 a source statement. Second, we design a byte-coded language
1008 for a state machine and store a stream of bytes in the object
1009 file instead of the matrix. This language can be much more
1010 compact than the matrix. To the line number information a 
1011 consumer must \doublequote{run} the state machine
1012 to generate the matrix for each compilation unit of interest.
1013 The concept of an encoded matrix also leaves
1014 room for expansion. In the future, columns can be added to the
1015 matrix to encode other things that are related to individual
1016 instruction addresses.}
1017
1018 \needlines{10}
1019 \subsection{Definitions}
1020 \label{chap:definitions}
1021 The following terms are used in the description of the line
1022 number information format:
1023
1024 \begin{longtable} {lP{9cm}}
1025 state machine &
1026 The hypothetical machine used by a consumer of the line number
1027 information to expand the byte\dash coded 
1028 instruction stream into a matrix of
1029 line number information. \\
1030
1031 line number program &
1032 A series of byte\dash coded 
1033 line number information instructions representing
1034 one compilation unit. \\
1035
1036 \addtoindex{basic block} &
1037  A sequence of instructions where only the first instruction may be a
1038 branch target and only the last instruction may transfer control. A
1039 subprogram invocation is defined to be an exit from a 
1040 \addtoindex{basic block}.
1041
1042 \textit{A \addtoindex{basic block} does not 
1043 necessarily correspond to a specific source code
1044 construct.} \\
1045
1046 sequence &
1047 A series of contiguous target machine instructions. One compilation unit
1048 may emit multiple sequences (that is, not all instructions within a
1049 compilation unit are assumed to be contiguous). \\
1050 \end{longtable}
1051
1052 \needlines{8}
1053 \subsection{State Machine Registers}
1054 \label{chap:statemachineregisters}
1055 The line number information state machine has a number of  
1056 registers as shown in Table \referfol{tab:statemachineregisters}.
1057
1058 \begin{longtable}{l|P{9cm}}
1059   \caption{State machine registers } \label{tab:statemachineregisters} \\
1060   \hline \bfseries Register name&\bfseries Meaning\\ \hline
1061 \endfirsthead
1062   \bfseries Register name&\bfseries Meaning\\ \hline
1063 \endhead
1064   \hline \emph{Continued on next page}
1065 \endfoot
1066   \hline
1067 \endlastfoot
1068 \addtoindexi{\texttt{address}}{address register!in line number machine}&
1069 The program\dash counter value corresponding to a machine instruction
1070 generated by the compiler. \\
1071
1072 \addttindex{op\_index} &
1073 An unsigned integer representing the index of an operation within a VLIW
1074 instruction. The index of the first operation is 0. For non-VLIW
1075 architectures, this register will always be 0.  \\
1076
1077 \addttindex{file} &
1078 An unsigned integer indicating the identity of the source file
1079 corresponding to a machine instruction. \\
1080
1081 \addttindex{line} &
1082 An unsigned integer indicating a source line number. Lines are numbered
1083 beginning at 1. The compiler may emit the value 0 in cases where an
1084 instruction cannot be attributed to any source line. \\
1085
1086 \addttindex{column} &
1087 An unsigned integer indicating a column number within a source line.
1088 Columns are numbered beginning at 1. The value 0 is reserved to indicate
1089 that a statement begins at the \doublequote{left edge} of the line. \\
1090
1091 \addttindex{is\_stmt} &
1092 A boolean indicating that the current instruction is a recommended
1093 breakpoint location. A recommended breakpoint location 
1094 is intended to \doublequote{represent} a line, a 
1095 statement and/or a semantically distinct subpart of a
1096 statement. \\
1097
1098 \addttindex{basic\_block}  &
1099 A boolean indicating that the current instruction is the beginning of a
1100 \addtoindex{basic block}. \\
1101
1102 \addttindex{end\_sequence} &
1103 A boolean indicating that the current address is that of the first byte after
1104 the end of a sequence of target machine instructions. 
1105 \addttindex{end\_sequence}
1106 terminates a sequence of lines; therefore other information in the same
1107 row is not meaningful. \\
1108
1109 \addttindex{prologue\_end} &
1110 A boolean indicating that the current address is one (of possibly many)
1111 where execution should be suspended for a breakpoint at the entry of a
1112 function. \\
1113
1114 \addttindex{epilogue\_begin} &
1115 A boolean indicating that the current address is one (of possibly many)
1116 where execution should be suspended for a breakpoint just prior to
1117 the exit of a function. \\
1118
1119 \addttindex{isa} &
1120 An unsigned integer whose value encodes the applicable
1121 instruction set architecture for the current instruction.
1122
1123 \textit{The encoding of instruction sets should be shared by all
1124 users of a given architecture. It is recommended that this
1125 encoding be defined by the ABI authoring committee for each
1126 architecture.} \\
1127
1128 \addttindex{discriminator} &
1129 An unsigned integer identifying the block to which the
1130 current instruction belongs. Discriminator values are assigned
1131 arbitrarily by the DWARF producer and serve to distinguish
1132 among multiple blocks that may all be associated with the
1133 same source file, line, and column. Where only one block
1134 exists for a given source position, the discriminator value
1135 is be zero. \\
1136 \end{longtable}
1137
1138 The \texttt{address} and \addttindex{op\_index} registers,
1139 taken together, form an \addtoindex{operation pointer} that can 
1140 reference any individual operation within the instruction stream.
1141
1142 At the beginning  of each sequence within a line number
1143 program, the state of the registers is as show in Table
1144 \refersec{tab:linenumberprograminitiastate}.
1145 \begin{table}
1146 \caption{Line number program initial state}
1147 \label{tab:linenumberprograminitiastate}
1148 \begin{center}
1149 \begin{tabular}{l|p{9.5cm}}
1150 \hline
1151 \texttt{address} & 0 \\
1152 \addttindex{op\_index} & 0 \\
1153 \texttt{file} & 1 \\
1154 \texttt{line} & 1 \\
1155 \texttt{column} & 0 \\
1156 \addttindex{is\_stmt} & determined by \addttindex{default\_is\_stmt} 
1157                         in the line number program header \\
1158 \addttindex{basic\_block}    & \doublequote{false} \addtoindexx{basic block} \\
1159 \addttindex{end\_sequence}   & \doublequote{false} \\
1160 \addttindex{prologue\_end}   & \doublequote{false} \\
1161 \addttindex{epilogue\_begin} & \doublequote{false} \\
1162 \addttindex{isa} & 0 \\
1163 \addttindex{discriminator} & 0 \\
1164 \hline
1165 \end{tabular}
1166 \end{center}
1167 \vspace{5mm}
1168 \end{table}
1169
1170 \textit{The 
1171 \addttindex{isa} value 0 specifies that the instruction set is the
1172 architecturally determined default instruction set. This may
1173 be fixed by the ABI, or it may be specified by other means,
1174 for example, by the object file description.}
1175
1176 \needlines{6}
1177 \subsection{Line Number Program Instructions}
1178 The state machine instructions in a line number program belong to one of three categories:
1179
1180 \begin{enumerate}[1. ]
1181 \item special opcodes \\
1182 These have a \HFTubyte{} opcode field and no operands.\vspace{1ex}
1183
1184 \textit{Most of the instructions in a 
1185 line number program are special opcodes.}
1186
1187 \needlines{4}
1188 \item standard opcodes \\
1189 These have a \HFTubyte{} opcode field which may be followed by zero or more
1190 \addtoindex{LEB128} operands (except for 
1191 \mbox{\DWLNSfixedadvancepc,} see 
1192 Section \refersec{chap:standardopcodes}).
1193 The opcode implies the number of operands and their meanings, but the
1194 line number program header also specifies the number of operands for
1195 each standard opcode.
1196
1197 \needlines{4}
1198 \item extended opcodes \\
1199 These have a multiple byte format. The first byte is zero; the next bytes
1200 are an unsigned LEB128\addtoindexx{LEB128!unsigned} integer giving the number of bytes in the
1201 instruction itself (does not include the first zero byte or the size). The
1202 remaining bytes are the instruction itself (which begins with a \HFTubyte{}
1203 extended opcode). \\
1204 \end{enumerate}
1205
1206
1207 \subsection{The Line Number Program Header}
1208 \label{chap:linenumberprogramheader}
1209 The optimal encoding of line number information depends to a
1210 certain degree upon the architecture of the target machine. The
1211 line number program header provides information used by
1212 consumers in decoding the line number program instructions for
1213 a particular compilation unit and also provides information
1214 used throughout the rest of the line number program.
1215
1216 The line number program for each compilation unit begins with
1217 a header containing the following fields in order:
1218
1219 \begin{enumerate}[1. ]
1220 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length})  \\
1221 \addttindexx{unit\_length}
1222 The size in bytes of the line number information for this
1223 compilation unit, not including the length field itself
1224 (see Section \refersec{datarep:initiallengthvalues}). 
1225
1226 \needlines{4}
1227 \item \texttt{version} (\HFTuhalf) \\
1228 A version number\addtoindexx{version number!line number information} 
1229 (see Section \refersec{datarep:linenumberinformation}). 
1230 This number is specific to
1231 the line number information and is independent of the DWARF
1232 version number. 
1233
1234 \item \texttt{address\_size} (\HFTubyte)\\
1235 A 1-byte unsigned integer containing the size in bytes of an
1236 address (or offset portion of an address for segmented addressing)
1237 on the target system.
1238    
1239 \textit{The \addttindex{address\_size} field is new in DWARF Version 5. 
1240 It is needed to support the common practice of stripping all but 
1241 the line number sections (\dotdebugline{} and \dotdebuglinestr{}) 
1242 from an executable.}
1243
1244 \item \HFNsegmentselectorsize{} (\HFTubyte) \\
1245 A 1-byte unsigned integer containing the size in bytes of a segment
1246 selector on the target system.
1247    
1248 \textit{The \HFNsegmentselectorsize{} field is new in DWARF Version 5. 
1249 It is needed in combination with the \addttindex{address\_size} field 
1250 to accurately characterize the address representation on the target 
1251 system.}
1252
1253 \needlines{4}
1254 \item \texttt{header\_length}  \\
1255 The number of bytes following the \addttindex{header\_length} field to the
1256 beginning of the first byte of the line number program itself.
1257 In the \thirtytwobitdwarfformat, this is a 4-byte unsigned
1258 length; in the \sixtyfourbitdwarfformat, this field is an
1259 8-byte unsigned length 
1260 (see Section \refersec{datarep:32bitand64bitdwarfformats}). 
1261
1262 \item \texttt{minimum\_instruction\_length} (\HFTubyte)  \\
1263 \addttindexx{minimum\_instruction\_length}
1264 The size in bytes of the smallest target machine
1265 instruction. Line number program opcodes that alter
1266 the \texttt{address} and \addttindex{op\_index}
1267 registers use this and
1268 \addttindex{maximum\_operations\_per\_instruction}
1269 in their calculations. 
1270
1271 \needlines{9}
1272 \item \texttt{maximum\_operations\_per\_instruction} (\HFTubyte) \\
1273 The 
1274 \addttindexx{maximum\_operations\_per\_instruction}
1275 maximum number of individual operations that may be
1276 encoded in an instruction. Line number program opcodes
1277 that alter the \texttt{address} and 
1278 \addttindex{op\_index} registers use this and
1279 \addttindex{minimum\_instruction\_length} in their calculations.
1280
1281 For non-VLIW
1282 architectures, this field is 1, the \addttindex{op\_index} register is always
1283 0, and the \addtoindex{operation pointer} is simply the \texttt{address} register.
1284
1285 \needlines{4}
1286 \item \texttt{default\_is\_stmt} (\HFTubyte) \\
1287 \addttindexx{default\_is\_stmt}
1288 The initial value of the \addttindex{is\_stmt} register.  
1289
1290 \textit{A simple approach
1291 to building line number information when machine instructions
1292 are emitted in an order corresponding to the source program
1293 is to set \addttindex{default\_is\_stmt}
1294 to \doublequote{true} and to not change the
1295 value of the \addttindex{is\_stmt} register 
1296 within the line number program.
1297 One matrix entry is produced for each line that has code
1298 generated for it. The effect is that every entry in the
1299 matrix recommends the beginning of each represented line as
1300 a breakpoint location. This is the traditional practice for
1301 unoptimized code.}
1302
1303 \textit{A more sophisticated approach might involve multiple entries in
1304 the matrix for a line number; in this case, at least one entry
1305 (often but not necessarily only one) specifies a recommended
1306 breakpoint location for the line number. \DWLNSnegatestmt{}
1307 opcodes in the line number program control which matrix entries
1308 constitute such a recommendation and 
1309 \addttindex{default\_is\_stmt} might
1310 be either \doublequote{true} or \doublequote{false.} This approach might be
1311 used as part of support for debugging optimized code.}
1312
1313 \item \texttt{line\_base} (\HFTsbyte) \\
1314 \addttindexx{line\_base}
1315 This parameter affects the meaning of the special opcodes. See below.
1316
1317 \item \texttt{line\_range} (\HFTubyte) \\
1318 \addttindexx{line\_range}
1319 This parameter affects the meaning of the special opcodes. See below.
1320
1321 \needlines{4}
1322 \item \texttt{opcode\_base} (\HFTubyte) \\
1323 The 
1324 \addttindexx{opcode\_base}
1325 number assigned to the first special opcode.
1326
1327 \textit{Opcode base is typically one greater than the highest-numbered
1328 \addttindexx{opcode\_base}
1329 standard opcode defined for the specified version of the line
1330 number information (12 in DWARF Versions 3, 4 and 5,
1331 \addtoindexx{DWARF Version 3}
1332 \addtoindexx{DWARF Version 4}
1333 \addtoindexx{DWARF Version 5}
1334 and 9 in
1335 \addtoindexx{DWARF Version 2}
1336 Version 2).  
1337 If opcode\_base is less than the typical value,
1338 \addttindexx{opcode\_base}
1339 then standard opcode numbers greater than or equal to the
1340 opcode base are not used in the line number table of this unit
1341 (and the codes are treated as special opcodes). If \texttt{opcode\_base}
1342 is greater than the typical value, then the numbers between
1343 that of the highest standard opcode and the first special
1344 opcode (not inclusive) are used for vendor specific extensions.}
1345
1346 \needlines{4}
1347 \item \texttt{standard\_opcode\_lengths} (array of \HFTubyte) \\
1348 \addttindexx{standard\_opcode\_lengths}
1349 This array specifies the number of \addtoindex{LEB128} operands for each
1350 of the standard opcodes. The first element of the array
1351 corresponds to the opcode whose value is 1, and the last
1352 element corresponds to the opcode whose value 
1353 is \texttt{opcode\_base - 1}.
1354
1355 \textit{By increasing \texttt{opcode\_base}, and adding elements to this array,
1356 \addttindexx{opcode\_base}
1357 new standard opcodes can be added, while allowing consumers who
1358 do not know about these new opcodes to be able to skip them.}
1359
1360 \textit{Codes for vendor specific extensions, if any, are described
1361 just like standard opcodes.}
1362
1363 %%% Save the current enum counter so we can restart later
1364 %%% End this enumeration so the following text is outdented to
1365 %%% the left margin (because it applies to the many following
1366 %%% items
1367 \newcounter{saveenumi}
1368 \setcounter{saveenumi}{\value{enumi}}
1369 \end{enumerate}
1370
1371 \needlines{6}
1372 \textit{The remaining fields provide information about the
1373 source files used in the compilation. These fields
1374 have been revised in \DWARFVersionV{} to support these
1375 goals:}
1376 \begin{itemize}
1377 \item
1378     \textit{To allow new alternative means for a consumer to
1379     check that a file it can access is the same version
1380     as that used in the compilation.}
1381 \item
1382     \textit{To allow a producer to collect file name strings
1383     in a new section (\dotdebuglinestr{}) that can be used
1384     to merge duplicate file name strings.}
1385 \item
1386     \textit{To add the ability for producers to provide 
1387     vendor-defined information that can be skipped by a consumer
1388     that is unprepared to process it.}
1389 \end{itemize}
1390
1391 \begin{enumerate}[1. ]
1392 %%% Resume enumeration count where it left off above
1393 \setcounter{enumi}{\value{saveenumi}}
1394 \item \texttt{directory\_entry\_format\_count} (\HFTubyte) \\
1395 \addttindexx{directory\_entry\_format\_count}
1396     A count of the number of entries that occur in the
1397     following \addttindex{directory\_entry\_format} field.
1398
1399 \needlines{8}
1400 \item \texttt{directory\_entry\_format} (sequence of ULEB128 pairs) \\
1401 \addttindexx{directory\_entry\_format}
1402     A sequence of directory entry format descriptions.
1403     Each description consists of a pair of ULEB128 values:
1404 \begin{itemize}
1405 \setlength{\itemsep}{0em}
1406 \item A content type code (see 
1407 Sections \refersec{chap:standardcontentdescriptions} and
1408 \refersec{chap:vendordefinedcontentdescriptions}).
1409
1410 \item A form code using the attribute form codes
1411 \end{itemize}
1412
1413 \needlines{4} 
1414 \item \texttt{directories\_count} (ULEB128) \\
1415 \addttindexx{directories\_count}
1416 A count of the number of entries that occur in the
1417 following directories field.
1418
1419 \needlines{4}    
1420 \item \texttt{directories} (sequence of directory names) \\
1421 \addttindexx{directories}
1422 A sequence of directory names and optional related
1423 information. Each entry is encoded as described
1424 by the \addttindex{directory\_entry\_format} field.
1425    
1426 Entries in this sequence describe each path that was
1427 searched for included source files in this compilation,
1428 including the compilation directory of the compilation.
1429 (The paths include those directories specified by the
1430 user for the compiler to search and those the compiler
1431 searches without explicit direction.)
1432    
1433 The first entry is the current directory of the compilation.
1434 Each additional path entry is either a full path name or
1435 is relative to the current directory of the compilation.
1436    
1437 The line number program assigns a number (index) to each
1438 of the directory entries in order, beginning with 0.
1439    
1440 \textit{Prior to \DWARFVersionV, the current directory was not
1441 represented in the directories field and a directory index
1442 of 0 implicitly referred to that directory as found in the
1443 \DWATcompdir{} attribute of the compilation unit 
1444 debugging information entry. 
1445 In \DWARFVersionV, the current directory is explicitly present
1446 in the directories field. This is needed to support the
1447 common practice of stripping all but the line number sections
1448 (\dotdebugline{} and \dotdebuglinestr) from an executable.}
1449
1450 \textit{Note that if a \dotdebuglinestr{} section is present, 
1451 both the compilation unit debugging information entry 
1452 and the line number header can
1453 share a single copy of the current directory name string.}
1454
1455 \item \texttt{file\_name\_entry\_format\_count} (\HFTubyte) \\
1456 \addttindexx{file\_name\_entry\_format\_count}
1457 A count of the number of file entry format entries that
1458 occur in the following \addttindex{file\_name\_entry\_format} field. 
1459 If this field is zero, then the \addttindex{file\_names\_count} field 
1460 (see below) must also be zero.
1461
1462 \needlines{6}
1463 \item \texttt{file\_name\_entry\_format} (sequence of ULEB128 pairs) \\
1464 \addttindexx{file\_name\_entry\_format}
1465 A sequence of file entry format descriptions.
1466 Each description consists of a pair of ULEB128 values:
1467 \begin{itemize}
1468 \setlength{\itemsep}{0em}
1469 \item A content type code (see below)
1470 \item A form code using the attribute form codes
1471 \end{itemize}
1472
1473 \item \texttt{file\_names\_count} (ULEB128) \\
1474 \addttindexx{file\_names\_count}
1475 A count of the number of file name entries that occur
1476 in the following \addttindex{file\_names} field.
1477
1478 \needlines{4}
1479 \item \texttt{file\_names} (sequence of file name entries) \\
1480 \addttindexx{file\_names}
1481 A sequence of file names and optional related
1482 information. Each entry is encoded as described
1483 by the \addttindex{file\_name\_entry\_format} field.
1484   
1485 Entries in this sequence describe source files that
1486 contribute to the line number information for this
1487 compilation or is used in other contexts, such as in
1488 a declaration coordinate or a macro file inclusion.
1489  
1490 The first entry in the sequence is the primary source file 
1491 whose file name exactly matches that given in the 
1492 \DWATname{} attribute in the compilation unit 
1493 debugging information entry.
1494    
1495 The line number program references file names in this 
1496 sequence beginning with 0, and uses those numbers instead 
1497 of file names in the line number program that follows.
1498
1499 \textit{Prior to \DWARFVersionV, the current compilation 
1500 file name was not represented in the \addttindex{file\_names}
1501 field. In \DWARFVersionV, the current compilation file name 
1502 is explicitly present and has index 0. This is needed to support 
1503 the common practice of stripping all but the line number sections
1504 (\dotdebugline{} and \dotdebuglinestr) from an executable.}
1505
1506 \textit{Note that if a \dotdebuglinestr{} section is present, 
1507 both the compilation unit debugging information entry 
1508 and the line number header can
1509 share a single copy of the current file name string.}
1510
1511 \end{enumerate}
1512
1513 \needlines{8}
1514 \subsubsection{Standard Content Descriptions}
1515 \label{chap:standardcontentdescriptions}
1516 DWARF-defined content type codes are used to indicate
1517 the type of information that is represented in one
1518 component of an include directory or file name description.
1519 The following type codes are defined.
1520 \begin{enumerate}[1. ]
1521
1522 \item  \DWLNCTpathTARG \\
1523 The component is a null-terminated path name string.
1524 If the associated form code is \DWFORMstring{}, then the
1525 string occurs immediately in the containing \texttt{directories}
1526 or \addttindex{file\_names} field. If the form code is \DWFORMlinestrp{},
1527 \bb
1528 \DWFORMstrp{} or \DWFORMstrpsup{},
1529 \eb
1530 then the string is included in the 
1531 \bb
1532 \dotdebuglinestr{}, \dotdebugstr{} or supplementary string section, respectively,
1533 \eb
1534 and its offset occurs immediately in the containing
1535 \addttindex{directories} or \addttindex{file\_names} field.
1536
1537 In the 32-bit DWARF format, the representation of a
1538 \DWFORMlinestrp{} value is a 4-byte unsigned offset; in the
1539 64-bit DWARF format, it is an 8-byte unsigned offset (see
1540 Section \refersec{datarep:32bitand64bitdwarfformats}).
1541
1542 \textit{Note that this use of \DWFORMlinestrp{} is similar to
1543 \DWFORMstrp{} but refers to the \dotdebuglinestr{} section,
1544 not \dotdebugstr. 
1545 \bb
1546 It is needed to support the common practice of stripping all but 
1547 the line number sections (\dotdebugline{} and \dotdebuglinestr{}) 
1548 from an executable.
1549 \eb
1550 }
1551
1552 In a \dotdebuglinedwo{} section, the form \DWFORMstrx{} may
1553 also be used. This refers into the \dotdebugstroffsetsdwo{}
1554 section (and indirectly also the \dotdebugstrdwo{} section)
1555 because no \texttt{.debug\_line\_str\_offsets.dwo} or 
1556 \texttt{.debug\_line\_str.dwo} sections exist or are defined for 
1557 use in split objects. (The form \DWFORMstring{} may also be used, 
1558 but this precludes the benefits of string sharing.)
1559    
1560 \item \DWLNCTdirectoryindexTARG \\
1561 The unsigned directory index represents an entry in the
1562 directories field of the header. The index is 0 if
1563 the file was found in the current directory of the compilation
1564 (hence, the first directory in the directories field),
1565 1 if it was found in the second directory in the directories
1566 field, and so on.
1567
1568 This content code is always paired with one of \DWFORMdataone, 
1569 \DWFORMdatatwo{} or \DWFORMudata.
1570
1571 \textit{The optimal form for a producer to use (which results in the
1572 minimum size for the set of \addttindex{include\_index} fields) depends not only
1573 on the number of directories in the directories
1574 field, but potentially on the order in which those directories are
1575 listed and the number of times each is used in the \addttindex{file\_names} field.}
1576
1577 \needlines{4}
1578 \item \DWLNCTtimestampTARG \\
1579 \DWLNCTtimestampNAME{} indicates that the value is the implementation-defined 
1580 time of last modification of the file, or 0 if not available. 
1581 It is always paired with one of the forms
1582 \DWFORMudata, \DWFORMdatafour, \DWFORMdataeight{} or \DWFORMblock.
1583    
1584 \item  \DWLNCTsizeTARG \\
1585 \DWLNCTsizeNAME{} indicates that the value is the unsigned size of the
1586 file in bytes, or 0 if not available. It is paired with one of the
1587 forms \DWFORMudata, \DWFORMdataone, \DWFORMdatatwo, \DWFORMdatafour{}
1588 or \DWFORMdataeight.
1589  
1590 \item \DWLNCTMDfiveTARG \\
1591 \DWLNCTMDfiveNAME{} indicates that the value is a 16-byte \MDfive{} digest
1592 of the file contents. It is paired with form \DWFORMdatasixteen.
1593 \end{enumerate}
1594
1595 \textit{An example that uses this line number header format
1596 is found in Appendix \refersec{app:linenumberheaderexample}.}
1597
1598 \subsubsection{Vendor-defined Content Descriptions}
1599 \label{chap:vendordefinedcontentdescriptions}
1600 Vendor-defined content descriptions may be defined using content
1601 type codes in the range \DWLNCTlouserNAME{} to \DWLNCThiuserNAME{}. Each
1602 such code may be combined with one or more forms from the set:
1603 \DWFORMblock, \DWFORMblockone, \DWFORMblocktwo, \DWFORMblockfour,
1604 \DWFORMdataone, \DWFORMdatatwo, \DWFORMdatafour, \DWFORMdataeight,
1605 \DWFORMdatasixteen,
1606 \DWFORMflag, \DWFORMlinestrp, \DWFORMsdata, \DWFORMsecoffset,
1607 \DWFORMstring, \DWFORMstrp, \DWFORMstrx{}  and \DWFORMudata.
1608
1609 \textit{If a consumer encounters a vendor-defined content type that
1610 it does not understand, it should skip the content data as though
1611 it were not present.}
1612
1613 \needlines{6}
1614 \subsection{The Line Number Program}
1615 \label{chap:linenumberprogram}
1616 As stated before, the goal of a line number program is to build
1617 a matrix representing one compilation unit, which may have
1618 produced multiple sequences of target machine instructions.
1619 Within a sequence, addresses and 
1620 \addtoindex{operation pointer}s may only increase. 
1621 (Line numbers may decrease in cases of pipeline
1622 scheduling or other optimization.)
1623
1624 \needlines{4}
1625 \subsubsection{Special Opcodes} 
1626 \label{chap:specialopcodes}
1627 Each \HFTubyte{} special opcode has the following effect on the state machine:
1628
1629 \begin{enumerate}[1. ]
1630
1631 \item  Add a signed integer to the \texttt{line} register.
1632
1633 \item  Modify the \addtoindex{operation pointer} by incrementing the
1634 \texttt{address} and \addttindex{op\_index} registers as described below.
1635
1636 \item  Append a row to the matrix using the current values
1637 of the state machine registers.
1638
1639 \item  Set the \addttindex{basic\_block} register to \doublequote{false.} \addtoindexx{basic block}
1640 \item  Set the \addttindex{prologue\_end} register to \doublequote{false.}
1641 \item  Set the \addttindex{epilogue\_begin} register to \doublequote{false.}
1642 \item  Set the \addttindex{discriminator} register to 0.
1643
1644 \end{enumerate}
1645
1646 All of the special opcodes do those same seven things; they
1647 differ from one another only in what values they add to the
1648 \texttt{line}, \texttt{address} and \addttindex{op\_index} registers.
1649
1650
1651 \textit{Instead of assigning a fixed meaning to each special opcode,
1652 the line number program uses several parameters in the header
1653 to configure the instruction set. There are two reasons
1654 for this.  First, although the opcode space available for
1655 special opcodes ranges from 13 through 255, the lower
1656 bound may increase if one adds new standard opcodes. Thus, the
1657 \texttt{opcode\_base} field of the line number program header gives the
1658 value of the first special opcode. Second, the best choice of
1659 special\dash opcode meanings depends on the target architecture. For
1660 example, for a RISC machine where the compiler\dash generated code
1661 interleaves instructions from different lines to schedule
1662 the pipeline, it is important to be able to add a negative
1663 value to the \texttt{line} register to express the fact that a later
1664 instruction may have been emitted for an earlier source
1665 line. For a machine where pipeline scheduling never occurs,
1666 it is advantageous to trade away the ability to decrease
1667 the \texttt{line} register (a standard opcode provides an alternate
1668 way to decrease the line number) in return for the ability
1669 to add larger positive values to the \texttt{address} register. To
1670 permit this variety of strategies, the line number program
1671 header defines a 
1672 \addttindex{line\_base}
1673 field that specifies the minimum
1674 value which a special opcode can add to the line register
1675 and a 
1676 \addttindex{line\_range}
1677 field that defines the range of values it
1678 can add to the line register.}
1679
1680
1681 A special opcode value is chosen based on the amount that needs
1682 to be added to the \texttt{line}, \texttt{address} and \addttindex{op\_index} registers.
1683 The maximum line increment for a special opcode is the value
1684 of the 
1685 \addttindex{line\_base}
1686 field in the header, plus the value of the 
1687 \addttindex{line\_range} field, minus 1 (line base + 
1688 line range - 1). 
1689 If the desired line increment is greater than the maximum
1690 line increment, a standard opcode must be used instead of a
1691 special opcode. The \addtoindex{operation advance} represents the number
1692 of operations to skip when advancing the \addtoindex{operation pointer}.
1693
1694 \needlines{6}
1695 The special opcode is then calculated using the following formula:
1696 \begin{alltt}
1697   opcode = 
1698     (\textit{desired line increment} - \addttindex{line\_base}) +
1699       (\addttindex{line\_range} * \textit{operation advance}) + \addttindex{opcode\_base}
1700 \end{alltt}
1701 If the resulting opcode is greater than 255, a standard opcode
1702 must be used instead.
1703
1704 \textit{When \addttindex{maximum\_operations\_per\_instruction} is 1, 
1705 the operation advance is simply the address increment divided by the
1706 \addttindex{minimum\_instruction\_length}.}
1707
1708 \needlines{6}
1709 To decode a special opcode, subtract the \addttindex{opcode\_base} from
1710 the opcode itself to give the \textit{adjusted opcode}. 
1711 The \textit{operation advance} 
1712 is the result of the adjusted opcode divided by the
1713 \addttindex{line\_range}. The new \texttt{address} and 
1714 \addttindex{op\_index} values are given by
1715 \begin{alltt}
1716   \textit{adjusted opcode} = opcode \dash opcode\_base
1717   \textit{operation advance} = \textit{adjusted opcode} / line\_range
1718
1719   new address = address +
1720     \addttindex{minimum\_instruction\_length} *
1721       ((\addttindex{op\_index} + \addtoindex{operation advance}) / \addttindex{maximum\_operations\_per\_instruction})
1722
1723   new op\_index =
1724     (\addttindex{op\_index} + \addtoindex{operation advance}) \% \addttindex{maximum\_operations\_per\_instruction}
1725 \end{alltt}
1726
1727 \textit{When the \addttindex{maximum\_operations\_per\_instruction} 
1728 field is 1,
1729 \texttt{op\_index} is always 0 and these calculations simplify to 
1730 those given for addresses in \DWARFVersionIII{} and earlier.}
1731
1732 The amount to increment the line register is the 
1733 \addttindex{line\_base} plus
1734 the result of the 
1735 \textit{\addtoindex{adjusted opcode}} modulo the 
1736 \addttindex{line\_range}. That
1737 is,
1738
1739 \begin{alltt}
1740   line increment = \addttindex{line\_base} + (\textit{adjusted opcode} \% \addttindex{line\_range})
1741 \end{alltt}
1742
1743 \textit{See Appendix \refersec{app:linenumberspecialopcodeexample} for an example.}
1744
1745
1746 \needlines{6}
1747 \subsubsection{Standard Opcodes}
1748 \label{chap:standardopcodes}
1749
1750 The standard opcodes, their applicable operands and the
1751 actions performed by these opcodes are as follows:
1752
1753 \begin{enumerate}[1. ]
1754
1755 \item \textbf{\DWLNScopyTARG} \\
1756 The \DWLNScopyNAME{} 
1757 opcode takes no operands. It appends a row
1758 to the matrix using the current values of the state machine
1759 registers. Then it sets the \addttindex{discriminator} register to 0,
1760 and sets the \addttindex{basic\_block}, 
1761 \addttindex{prologue\_end} and 
1762 \addttindex{epilogue\_begin}
1763 registers to \doublequote{false.}
1764
1765 \needlines{5}
1766 \item \textbf{\DWLNSadvancepcTARG} \\
1767 The \DWLNSadvancepcNAME{} 
1768 opcode takes a single unsigned LEB128\addtoindexx{LEB128!unsigned}
1769 operand as the \addtoindex{operation advance} and modifies the \texttt{address}
1770 and \addttindex{op\_index} registers as specified in 
1771 Section \refersec{chap:specialopcodes}.
1772
1773 \item \textbf{\DWLNSadvancelineTARG} \\
1774 The \DWLNSadvancelineNAME{} 
1775 opcode takes a single signed LEB128\addtoindexx{LEB128!signed}
1776 operand and adds that value to the \texttt{line} register of the
1777 state machine.
1778
1779 \needlines{4}
1780 \item \textbf{\DWLNSsetfileTARG} \\ 
1781 The \DWLNSsetfileNAME{} opcode takes a single
1782 unsigned LEB128\addtoindexx{LEB128!unsigned} 
1783 operand and stores it in the \texttt{file} register
1784 of the state machine.
1785
1786 \needlines{4}
1787 \item \textbf{\DWLNSsetcolumnTARG} \\ 
1788 The \DWLNSsetcolumnNAME{} opcode takes a
1789 single unsigned LEB128\addtoindexx{LEB128!unsigned} operand 
1790 and stores it in the \texttt{column}
1791 register of the state machine.
1792
1793 \needlines{4}
1794 \item \textbf{\DWLNSnegatestmtTARG} \\
1795 The \DWLNSnegatestmtNAME{} opcode takes no
1796 operands. It sets the \addttindex{is\_stmt} register of the state machine
1797 to the logical negation of its current value.
1798
1799 \needlines{4}
1800 \item \textbf{\DWLNSsetbasicblockTARG} \\
1801 The \DWLNSsetbasicblockNAME{}
1802 opcode
1803 \addtoindexx{basic block}
1804 takes no operands. 
1805 It sets the \addttindex{basic\_block} register of the
1806 state machine to \doublequote{true.}
1807
1808 \item \textbf{\DWLNSconstaddpcTARG} \\
1809 The \DWLNSconstaddpcNAME{} opcode takes
1810 no operands. It advances the \texttt{address} and \addttindex{op\_index} registers
1811 by the increments corresponding to special opcode 255.
1812
1813 \textit{When the line number program needs to advance the \texttt{address}
1814 by a small amount, it can use a single special opcode,
1815 which occupies a single byte. When it needs to advance the
1816 \texttt{address} by up to twice the range of the last special opcode,
1817 it can use \DWLNSconstaddpc{} followed by a special opcode,
1818 for a total of two bytes. Only if it needs to advance the
1819 address by more than twice that range will it need to use
1820 both \DWLNSadvancepc{} and a special opcode, requiring three
1821 or more bytes.}
1822
1823 \item \textbf{\DWLNSfixedadvancepcTARG} \\ 
1824 The \DWLNSfixedadvancepcNAME{} opcode
1825 takes a single \HFTuhalf{} (unencoded) operand and adds it to the
1826 \texttt{address} register of the state machine and sets the \addttindex{op\_index}
1827 register to 0. This is the only standard opcode whose operand
1828 is \textbf{not} a variable length number. It also does 
1829 \textbf{not} multiply the
1830 operand by the \addttindex{minimum\_instruction\_length} 
1831 field of the header.
1832
1833 \textit{Some assemblers may not be able emit 
1834 \DWLNSadvancepc{} or special opcodes because they cannot encode 
1835 \addtoindex{LEB128} numbers or judge when
1836 the computation of a special opcode overflows and requires
1837 the use of \DWLNSadvancepc. Such assemblers, however, can
1838 use \DWLNSfixedadvancepc{} instead, sacrificing compression.}
1839
1840 \needlines{6}
1841 \item \textbf{\DWLNSsetprologueendTARG} \\
1842 The \DWLNSsetprologueendNAME{}
1843 opcode takes no operands. It sets the 
1844 \addttindex{prologue\_end} register
1845 to \doublequote{true.}
1846
1847 \textit{When a breakpoint is set on entry to a function, it is
1848 generally desirable for execution to be suspended, not on the
1849 very first instruction of the function, but rather at a point
1850 after the function's frame has been set up, after any language
1851 defined local declaration processing has been completed,
1852 and before execution of the first statement of the function
1853 begins. Debuggers generally cannot properly determine where
1854 this point is. This command allows a compiler to communicate
1855 the location(s) to use.}
1856
1857 \textit{In the case of optimized code, there may be more than one such
1858 location; for example, the code might test for a special case
1859 and make a fast exit prior to setting up the frame.}
1860
1861 \textit{Note that the function to which the 
1862 \addtoindex{prologue end} applies cannot
1863 be directly determined from the line number information alone;
1864 it must be determined in combination with the subroutine
1865 information entries of the compilation (including inlined
1866 subroutines).}
1867
1868
1869 \item \textbf{\DWLNSsetepiloguebeginTARG} \\
1870 The \DWLNSsetepiloguebeginNAME{} opcode takes no operands. It
1871 sets the \addttindex{epilogue\_begin} register to \doublequote{true.}
1872
1873 \textit{When a breakpoint is set on the exit of a function or execution
1874 steps over the last executable statement of a function, it is
1875 generally desirable to suspend execution after completion of
1876 the last statement but prior to tearing down the frame (so that
1877 local variables can still be examined). Debuggers generally
1878 cannot properly determine where this point is. This command
1879 allows a compiler to communicate the location(s) to use.}
1880
1881 \textit{Note that the function to which the 
1882 \addtoindex{epilogue end} applies cannot
1883 be directly determined from the line number information alone;
1884 it must be determined in combination with the subroutine
1885 information entries of the compilation (including inlined
1886 subroutines).}
1887
1888 \textit{In the case of a trivial function, both 
1889 \addtoindex{prologue end} and
1890 \addtoindex{epilogue begin} may occur at the same address.}
1891
1892 \item \textbf{\DWLNSsetisaTARG} \\
1893 The \DWLNSsetisaNAME{} opcode takes a single
1894 unsigned LEB128\addtoindexx{LEB128!unsigned} operand and stores that value in the 
1895 \addttindex{isa}
1896 register of the state machine.
1897 \end{enumerate}
1898
1899 \needlines{8}
1900 \subsubsection{Extended Opcodes}
1901 \label{chap:extendedopcodes}
1902
1903 The extended opcodes are as follows:
1904
1905 \begin{enumerate}[1. ]
1906
1907 \item \textbf{\DWLNEendsequenceTARG} \\
1908 The \DWLNEendsequenceNAME{} opcode takes no operands. It sets the
1909 \addttindex{end\_sequence}
1910 register of the state machine to \doublequote{true} and
1911 appends a row to the matrix using the current values of the
1912 state-machine registers. Then it resets the registers to the
1913 initial values specified above 
1914 (see Section \refersec{chap:statemachineregisters}). 
1915 Every line
1916 number program sequence must end with a \DWLNEendsequence{}
1917 instruction which creates a row whose address is that of the
1918 byte after the last target machine instruction of the sequence.
1919
1920 \needlines{5}
1921 \item \textbf{\DWLNEsetaddressTARG} \\
1922 The \DWLNEsetaddressNAME{} opcode takes a single relocatable
1923 address as an operand. The size of the operand is the size
1924 of an address on the target machine. It sets the \texttt{address}
1925 register to the value given by the relocatable address and
1926 sets the \addttindex{op\_index} register to 0.
1927
1928 \textit{All of the other line number program opcodes that
1929 affect the \texttt{address} register add a delta to it. This instruction
1930 stores a relocatable value into it instead.}
1931
1932 \item \textbf{\DWLNEsetdiscriminatorTARG} \\
1933 The \DWLNEsetdiscriminatorNAME{}
1934 opcode takes a single
1935 parameter, an unsigned LEB128\addtoindexx{LEB128!unsigned} 
1936 integer. It sets the
1937 \addttindex{discriminator} register to the new value.
1938
1939 \end{enumerate}
1940
1941 \textit{The DW\_LNE\_define\_file operation defined
1942 in earlier versions of DWARF is deprecated in \DWARFVersionV.}
1943 \addtoindexx{DW\_LNE\_define\_file  (deprecated)}
1944
1945 \textit{Appendix \refersec{app:linenumberprogramexample} 
1946 gives some sample line number programs.}
1947
1948 \section{Macro Information}
1949 \label{chap:macroinformation}
1950 \textit{Some languages, such as 
1951 \addtoindex{C} and 
1952 \addtoindex{C++}, provide a way to replace
1953 \addtoindexx{macro information}
1954 text in the source program with macros defined either in the
1955 source file itself, or in another file included by the source
1956 file.  Because these macros are not themselves defined in the
1957 target language, it is difficult to represent their definitions
1958 using the standard language constructs of DWARF. The debugging
1959 information therefore reflects the state of the source after
1960 the macro definition has been expanded, rather than as the
1961 programmer wrote it. The macro information table provides a way
1962 of preserving the original source in the debugging information.}
1963
1964 As described in 
1965 Section \refersec{chap:fullandpartialcompilationunitentries},
1966 the macro information for a
1967 given compilation unit is represented in the 
1968 \dotdebugmacro{}
1969 section of an object file. 
1970
1971 \needlines{4}
1972 \textit{The \dotdebugmacro{} section is new in 
1973 \DWARFVersionV, and supersedes the
1974 \dotdebugmacinfo{} section of earlier DWARF versions. 
1975 While \dotdebugmacro{} and \dotdebugmacinfo{}
1976 sections cannot both occur in the same compilation unit, both may be found in the 
1977 set of units that make up an executable or shared object file.}
1978
1979 \textit{The representation of debugging information in the \dotdebugmacinfo{} section is specified
1980 in earlier versions of the DWARF standard. Note that the \dotdebugmacinfo{} section does not contain 
1981 any headers and does not support sharing of strings or sharing of repeated macro sequences.}
1982
1983 The macro information for each compilation unit consists of one or
1984 more macro units.  Each macro unit starts with a header
1985 and is followed by a series of macro information entries or file
1986 inclusion entries.  Each entry consists of an opcode followed by
1987 zero or more operands. Each macro unit ends with an entry
1988 containing an opcode of 0.
1989
1990 In all macro information entries,
1991 the line number of the entry is encoded as an
1992 unsigned LEB128 integer.
1993
1994 \needlines{6}
1995 \subsection{Macro Information Header}
1996 The macro information header contains the following fields:
1997
1998 \begin{enumerate}[1. ]
1999 \item \texttt{version} (\HFTuhalf) \\
2000 A version number (see Section \refersec{datarep:macroinformation}).
2001 This number is specific to the macro information and is independent
2002 of the DWARF version number.
2003
2004 \item \texttt{flags} (\HFTubyte) \\
2005 The bits of the \texttt{flags} field are interpreted as a set
2006 of flags, some of which may indicate that additional fields follow.
2007
2008 \needlines{4}
2009 The following flags, beginning with the least significant bit, are defined:
2010 \begin{itemize}
2011 \item \HFNoffsetsizeflag \\
2012 If the \HFNoffsetsizeflag{} is zero, the header is for a 32-bit 
2013 DWARF format macro section and all offsets are 4 bytes long;
2014 if it is one, the header is for a 64-bit DWARF format macro section 
2015 and all offsets are 8 bytes long.
2016
2017 \item \addttindex{debug\_line\_offset\_flag} \\
2018 If the \addttindex{debug\_line\_offset\_flag} is one, 
2019 the \addttindex{debug\_line\_offset} field (see below) is present. 
2020 If zero, that field is omitted.
2021
2022 \item \addttindex{opcode\_operands\_table\_flag} \\
2023 If the \addttindex{opcode\_operands\_table\_flag} is one,
2024 the \addttindex{opcode\_operands\_table} field (see below) is present.
2025 If zero, that field is omitted.
2026
2027 \end{itemize}
2028 All other flags are reserved by DWARF.
2029
2030 \item \addttindex{debug\_line\_offset} \\
2031 An offset in the \dotdebugline{} section of the
2032 beginning of the line number information in the containing
2033 compilation, encoded as a 4-byte offset for a 32-bit DWARF 
2034 format macro section and an 8-byte offset for a 64-bit DWARF format
2035 macro section.  
2036
2037 \item \addttindex{opcode\_operands\_table} \\
2038 An \texttt{opcode\_operands\_table} describing the operands 
2039 of the macro information entry opcodes.
2040
2041 The macro information entries defined in this standard may, but need not, be
2042 described in the table, while other user-defined entry opcodes used in the section
2043 are described there.  Vendor extension entry opcodes are
2044 allocated in the range from \DWMACROlouser{} to \DWMACROhiuser. Other
2045 unassigned codes are reserved for future DWARF standards.
2046
2047 \needlines{4}
2048 The table starts with a 1-byte \texttt{count} of the defined opcodes, followed by
2049 an entry for each of those opcodes.  Each entry starts with a 1-byte unsigned
2050 opcode number, followed by unsigned LEB128\addtoindexx{ULEB128} encoded number of operands
2051 and for each operand there is a single unsigned byte describing the form in which
2052 the operand is encoded.  The allowed forms are: 
2053 \DWFORMblock, \DWFORMblockone, \DWFORMblocktwo, \DWFORMblockfour,
2054 \DWFORMdataone, \DWFORMdatatwo, \DWFORMdatafour, \DWFORMdataeight, 
2055 \DWFORMdatasixteen,  
2056 \bb
2057 \DWFORMflag, \DWFORMlinestrp, \DWFORMsdata, 
2058 \eb
2059 \DWFORMsecoffset, \DWFORMstring, \DWFORMstrp{}, 
2060 \bb
2061 \DWFORMstrpsup, \DWFORMstrx{} and \DWFORMudata.
2062 \eb
2063 \end{enumerate}
2064
2065 \subsection{Macro Information Entries}
2066 \label{chap:macroinformationentries}
2067 All macro information entries within a \dotdebugmacro{}
2068 section for a given compilation unit appear in the same 
2069 order in which the directives were processed by the 
2070 compiler (after taking into account the effect of the
2071 macro import directives).
2072
2073 \textit{The source file in which a macro information entry occurs
2074 can be derived by interpreting the sequence of entries from the
2075 beginning of the \dotdebugmacro{} section. \DWMACROstartfile{} and 
2076 \DWMACROendfile{} indicate changes in the containing file.} 
2077
2078 \subsubsection{Define and Undefine Entries}
2079 \label{chap:defineandundefineentries}
2080 The define and undefine macro entries have multiple forms that
2081 use different representations of their two operands.
2082
2083 While described in pairs below, the forms of define 
2084 and undefine entries may be freely intermixed.
2085
2086 \begin{enumerate}[1. ]
2087
2088 \itembfnl{\DWMACROdefineTARG{}, \DWMACROundefTARG{}}
2089 A \DWMACROdefineNAME{} or \DWMACROundefNAME{} entry has two
2090 operands. The first operand encodes the source line number 
2091 of the \texttt{\#define} or \texttt{\#undef} macro directive.
2092 The second operand is a null-terminated character
2093 string for the macro being defined or undefined. 
2094
2095 The contents of the operands are described below (see Sections 
2096 \ref{chap:macrodefinestring} and \referfol{chap:macroundefinestring}).
2097
2098 \itembfnl{\DWMACROdefinestrpTARG{}, \DWMACROundefstrpTARG{}}
2099 A \DWMACROdefinestrpNAME{} or \DWMACROundefstrpNAME{} 
2100 entry has two operands.  The first operand encodes the source line number
2101 of the \texttt{\#define} or \texttt{\#undef} macro directive. 
2102 The second operand consists of an offset into a string table contained in
2103 the \dotdebugstr{} section of the object file.  The size of the operand is
2104 given in the header \HFNoffsetsizeflag{} field. 
2105
2106 The contents of the operands are described below (see Sections 
2107 \ref{chap:macrodefinestring} and \referfol{chap:macroundefinestring}).
2108
2109 \itembfnl{\DWMACROdefinestrxTARG{}, \DWMACROundefstrxTARG{}}
2110 A \DWMACROdefinestrxNAME{} or \DWMACROundefstrxNAME{} entry 
2111 has two operands.  The first operand encodes the line number 
2112 of the \texttt{\#define} or \texttt{\#undef} macro directive.
2113 The second operand identifies a string; it is represented using an 
2114 unsigned LEB128\addtoindexx{ULEB128} encoded value,
2115 which is interpreted as a zero-based index into an array of offsets in the
2116 \dotdebugstroffsets{} section. 
2117
2118 The contents of the operands are described below (see Sections 
2119 \ref{chap:macrodefinestring} and \referfol{chap:macroundefinestring}).
2120
2121 \needlines{6}
2122 \itembfnl{\DWMACROdefinesupTARG{}, \DWMACROundefsupTARG{}}
2123 A \DWMACROdefinesupNAME{} or \DWMACROundefsupNAME{} entry 
2124 has two operands.  The first operand encodes the line number 
2125 of the \texttt{\#define} or \texttt{\#undef} macro directive.
2126 The second operand identifies a string; it is represented as
2127 an offset into a string table contained in the \dotdebugstr{} 
2128 section of the \addtoindex{supplementary object file}.  
2129 The size of the operand depends on the macro section header 
2130 \HFNoffsetsizeflag{} field.  
2131
2132 The contents of the operands are described below (see Sections 
2133 \ref{chap:macrodefinestring} and \referfol{chap:macroundefinestring}).
2134
2135 \end{enumerate}
2136
2137
2138 \subsubsection{Macro Define String}
2139 \label{chap:macrodefinestring}
2140 In the case of a 
2141 \DWMACROdefine{},
2142 \DWMACROdefinestrp{},
2143 \DWMACROdefinestrx{} or
2144 \DWMACROdefinesup{}
2145 entry, the value of the
2146 second operand is the name of the macro symbol that is defined
2147 at the indicated source line, followed immediately by the 
2148 \addtoindex{macro formal parameter list}
2149 including the surrounding parentheses (in
2150 the case of a function-like macro) followed by the definition
2151 string for the macro. If there is no formal parameter list,
2152 then the name of the defined macro is followed immediately by
2153 its definition string.
2154
2155 In the case of a function-like macro definition, no whitespace
2156 characters appear between the name of the defined
2157 macro and the following left parenthesis. Formal parameters
2158 are separated by a comma without any whitespace.
2159 Exactly one space
2160 character separates the right parenthesis that terminates
2161 the formal parameter list and the following definition string.
2162
2163 In the case of a \doublequote{normal} (that is, non-function-like) macro
2164 definition, exactly one space character separates the
2165 name of the defined macro from the following definition text.
2166
2167 \subsubsection{Macro Undefine String}
2168 \label{chap:macroundefinestring}
2169 In the case of a 
2170 \DWMACROundef{},
2171 \DWMACROundefstrp{},
2172 \DWMACROundefstrx{} or
2173 \DWMACROundefsup{}
2174 entry, the value of the second string is the name of the pre-processor
2175 symbol that is undefined at the indicated source line.
2176
2177 \subsubsection{Entries for Command Line Options}
2178 \label{chap:entriesforcommandlineoptions}
2179 \DWMACROdefineINDX{}\DWMACROdefinestrpINDX{}\DWMACROdefinestrxINDX
2180 \DWMACROundefINDX{}\DWMACROundefstrpINDX{}\DWMACROundefstrxINDX
2181 A DWARF producer
2182 generates a define or undefine entry for
2183 each pre-processor symbol which is defined or undefined by
2184 some means other than such a directive
2185 within the compiled source text. In particular, pre-processor
2186 symbol definitions and undefinitions which occur as a
2187 result of command line options (when invoking the compiler)
2188 are represented by their own define and
2189 undefine entries.
2190
2191 All such define and undefine entries representing compilation 
2192 options appear before the first \DWMACROstartfile{} 
2193 entry for that compilation unit
2194 (see Section \referfol{chap:fileinclusionentries})
2195 and encode the value 0 in their line number operands.
2196
2197 \subsection{File Inclusion Entries}
2198 \label{chap:fileinclusionentries}
2199
2200 \subsubsection{Source Include Directives}
2201 \label{chap:sourceincludedirectives}
2202
2203 The following directives describe a source
2204 file inclusion directive (\texttt{\#include} in
2205 \addtoindex{C}/\addtoindex{C++}) and the
2206 ending of an included file.
2207
2208 \begin{enumerate}[1. ]
2209
2210 \itembfnl{\DWMACROstartfileTARG{}}
2211 A \DWMACROstartfileNAME{} entry has two operands. The
2212 first operand encodes the line number of the source line on
2213 which the \texttt{\#include} macro directive occurs. 
2214 The second operand encodes a source file name index. 
2215
2216 The source file name index is the file number in the 
2217 line number information table for the compilation unit.
2218
2219 If a \DWMACROstartfileNAME{} entry is present, the header
2220 contains a reference to the \dotdebugline{} section of 
2221 the compilation.
2222
2223 \itembfnl{\DWMACROendfileTARG{}}
2224 A \DWMACROendfileNAME{} entry has no operands. The presence of
2225 the entry marks the end of the current source file inclusion.
2226
2227 \end{enumerate}
2228
2229 \needlines{4}
2230 When providing macro information in an object file,
2231 a producer generates \DWMACROstartfile{} and
2232 \DWMACROendfile{} entries for the source file submitted to
2233 the compiler for compilation. This \DWMACROstartfile{} entry
2234 has the value 0 in its line number operand and references
2235 the file entry in the line number information table for the
2236 primary source file.
2237
2238 \subsubsection{Importation of Macro Units}
2239 \label{chap:importationofmacrounits}
2240 The import entries make it possible to replicate macro units.
2241 The first form supports replication within the current compilation
2242 and the second form supports replication across separate 
2243 executable or shared object files.
2244
2245 \textit{Import entries do not reflect the source program
2246 and, in fact, are not necessary at all. However, they do
2247 provide a mechanism that can be used to reduce redundancy
2248 in the macro information and thereby to save space.}
2249
2250 \begin{enumerate}[1. ]
2251
2252 \itembfnl{\DWMACROimportTARG{}}
2253 A \DWMACROimportNAME{} entry has one operand, an offset into
2254 another part of the \dotdebugmacro{} section that is
2255 the beginning of a target macro unit. The size of the operand
2256 depends on the header \HFNoffsetsizeflag{} field.  The
2257 \DWMACROimportNAME{} entry instructs the consumer to
2258 replicate the sequence of entries following the target macro 
2259 header which begins at the given 
2260 \dotdebugmacro{} offset, up to, but excluding,
2261 the terminating entry with opcode \texttt{0},
2262 as though it occurs in place of the import operation.
2263
2264 \itembfnl{\DWMACROimportsupTARG}
2265 A \DWMACROimportsupNAME{} entry has one operand, an 
2266 offset from the start of the \dotdebugmacro{} section in the 
2267 \addtoindex{supplementary object file}.  
2268 The size of the operand depends on the section header 
2269 \HFNoffsetsizeflag{} field. 
2270 Apart from the different location in which to find the macro unit,
2271 this entry type is equivalent to \DWMACROimport. 
2272
2273 \textit{This entry type is aimed at sharing duplicate 
2274 macro units between \dotdebugmacro{}
2275 sections from different executable or shared object files.}  
2276
2277 \needlines{4}
2278 From within the \dotdebugmacro{} section of the 
2279 \addtoindex{supplementary object file}, \DWMACROdefinestrp{} 
2280 and \DWMACROundefstrp{} entries refer to the
2281 \dotdebugstr{} section of that same supplementary file;
2282 similarly, \DWMACROimport{} entries refer to the 
2283 \dotdebugmacro{} section of that same supplementary file.
2284
2285 \end{enumerate}
2286
2287
2288 \needlines{6}
2289 \section{Call Frame Information}
2290 \label{chap:callframeinformation}
2291 \addtoindexx{unwind|see{virtual unwind}}\addtoindexx{virtual unwind}
2292
2293 \textit{Debuggers often need to be able to view and modify the 
2294 state of any subroutine activation that is
2295 \addtoindexx{activation of call frame}
2296 on the call stack. An activation consists of:}
2297
2298 \begin{itemize}
2299 \item \textit{A code location that is within the
2300 subroutine. This location is either the place where the program
2301 stopped when the debugger got control (for example, a breakpoint), or
2302 is a place where a subroutine made a call or was interrupted
2303 by an asynchronous event (for example, a signal).}
2304
2305 \item \textit{An area of memory that is allocated on a stack called a
2306 \doublequote{call frame.} The call frame is identified by an address
2307 on the stack. We refer to this address as the Canonical
2308 Frame Address or CFA. Typically, the CFA is defined to be the
2309 value of the stack pointer at the call site in the previous
2310 frame (which may be different from its value on entry to the
2311 current frame).}
2312
2313 \item \textit{A set of registers that are in use by the subroutine
2314 at the code location.}
2315
2316 \end{itemize}
2317
2318 \textit{Typically, a set of registers are designated to be preserved
2319 across a call. If a callee wishes to use such a register, it
2320 saves the value that the register had at entry time in its call
2321 frame and restores it on exit. The code that allocates space
2322 on the call frame stack and performs the save operation is
2323 called the subroutine\textquoteright{s} \addtoindex{prologue}, and the code that performs
2324 the restore operation and deallocates the frame is called its
2325 \addtoindex{epilogue}. Typically, the 
2326 \addtoindex{prologue} code is physically at the
2327 beginning of a subroutine and the 
2328 \addtoindex{epilogue} code is at the end.}
2329
2330 \textit{To be able to view or modify an activation that is not
2331 on the top of the call frame stack, the debugger must
2332 virtually unwind the stack of activations until
2333 it finds the activation of interest.  A debugger virtually unwinds
2334 a stack in steps. Starting with the current activation it
2335 virtually restores any registers that were preserved by the
2336 current activation and computes the predecessor\textquoteright{s} CFA and
2337 code location. This has the logical effect of returning from
2338 the current subroutine to its predecessor. We say that the
2339 debugger virtually unwinds the stack because the actual state
2340 of the target process is unchanged.}
2341
2342 \needlines{4}
2343 \textit{The virtual unwind 
2344 operation needs to know where registers are
2345 saved and how to compute the predecessor\textquoteright{s} CFA and code
2346 location. When considering an architecture-independent way
2347 of encoding this information one has to consider a number of
2348 special things:}
2349
2350 \begin{itemize} % bullet list
2351
2352 \item \textit{Prologue 
2353 \addtoindexx{prologue}
2354 and 
2355 \addtoindex{epilogue} code is not always in 
2356 distinct \nolink{blocks}
2357 at the beginning and end of a subroutine. It is common
2358 to duplicate the \addtoindex{epilogue} code 
2359 at the site of each return
2360 from the code. Sometimes a compiler breaks up the register
2361 save/unsave operations and moves them into the body of the
2362 subroutine to just where they are needed.}
2363
2364
2365 \item \textit{Compilers use different ways to manage the call
2366 frame. Sometimes they use a frame pointer register, sometimes
2367 not.}
2368
2369 \item \textit{The algorithm to compute CFA changes as you progress through
2370 the \addtoindex{prologue} 
2371 and \addtoindex{epilogue code}. 
2372 (By definition, the CFA value
2373 does not change.)}
2374
2375 \item \textit{Some subroutines have no call frame.}
2376
2377 \item \textit{Sometimes a register is saved in another register that by
2378 convention does not need to be saved.}
2379
2380 \item \textit{Some architectures have special instructions that perform
2381 some or all of the register management in one instruction,
2382 leaving special information on the stack that indicates how
2383 registers are saved.}
2384
2385 \item \textit{Some architectures treat return address values specially. For
2386 example, in one architecture, the call instruction guarantees
2387 that the low order two bits will be zero and the return
2388 instruction ignores those bits. This leaves two bits of
2389 storage that are available to other uses that must be treated
2390 specially.}
2391
2392 \end{itemize}
2393
2394
2395 \needlines{6}
2396 \subsection{Structure of Call Frame Information}
2397 \label{chap:structureofcallframeinformation}
2398
2399 DWARF supports virtual unwinding by defining an architecture
2400 independent basis for recording how subprograms save and restore
2401 registers during their lifetimes. This basis must be augmented
2402 on some machines with specific information that is defined by
2403 an architecture specific ABI authoring committee, a hardware
2404 vendor, or a compiler producer. The body defining a specific
2405 augmentation is referred to below as the \doublequote{augmenter.}
2406
2407 \needlines{8}
2408 Abstractly, this mechanism describes a very large table that
2409 has the following structure:
2410
2411 \begin{verbatim}
2412         LOC CFA R0 R1 ... RN
2413         L0
2414         L1
2415         ...
2416         LN
2417 \end{verbatim}
2418
2419
2420 The first column indicates an address for every location
2421 that contains code in a program. (In shared object files, this
2422 is an object-relative offset.) The remaining columns contain
2423 virtual unwinding rules that are associated with the indicated
2424 location.
2425
2426 The CFA column defines the rule which computes the Canonical
2427 Frame Address value; it may be either a register and a signed
2428 offset that are added together, or a DWARF expression that
2429 is evaluated.
2430
2431 \needlines{4}
2432 The remaining columns are labelled by register number. This
2433 includes some registers that have special designation on
2434 some architectures such as the PC and the stack pointer
2435 register. (The actual mapping of registers for a particular
2436 architecture is defined by the augmenter.) The register columns
2437 contain rules that describe whether a given register has been
2438 saved and the rule to find the value for the register in the
2439 previous frame.
2440
2441 \needlines{6}
2442 The register rules are:
2443
2444 \begin{longtable}{lP{9cm}}
2445 undefined 
2446 &A register that has this rule has no recoverable value in the previous frame.
2447 (By convention, it is not preserved by a callee.) \\
2448
2449 same value
2450 &This register has not been modified from the previous frame. (By convention,
2451 it is preserved by the callee, but the callee has not modified it.) \\
2452
2453 offset(N)
2454 &The previous value of this register is saved at the address CFA+N where CFA
2455 is the current CFA value and N is a signed offset.\\
2456
2457 val\_offset(N)
2458 &The previous value of this register is the value CFA+N where CFA is the
2459 current CFA value and N is a signed offset.\\
2460
2461 register(R)
2462 &The previous value of this register is stored 
2463 in another register numbered R.\\
2464
2465 expression(E)
2466 &The previous value of this register is located at the address produced by
2467 executing the DWARF expression E (see Section \refersec{chap:dwarfexpressions}).\\
2468
2469 val\_expression(E) 
2470 &The previous value of this register is the value produced by executing the
2471 DWARF expression E (see Section \refersec{chap:dwarfexpressions}).\\
2472
2473 architectural
2474 &The rule is defined externally to this specification by the augmenter.\\
2475
2476 \end{longtable}
2477
2478 \textit{This table would be extremely large if actually constructed
2479 as described. Most of the entries at any point in the table
2480 are identical to the ones above them. The whole table can be
2481 represented quite compactly by recording just the differences
2482 starting at the beginning address of each subroutine in
2483 the program.}
2484
2485 \needlines{4}
2486 The virtual unwind information is encoded in a self-contained
2487 section called 
2488 \dotdebugframe{}.  Entries in a 
2489 \dotdebugframe{} section
2490 are aligned on a multiple of the address size relative to
2491 the start of the section and come in two forms: a Common
2492 \addtoindexx{common information entry}
2493 Information Entry (CIE) and a 
2494 \addtoindexx{frame description entry}
2495 Frame Description Entry (FDE).
2496
2497 \textit{If the range of code addresses for a function is not
2498 contiguous, there may be multiple CIEs and FDEs corresponding
2499 to the parts of that function.}
2500
2501 \needlines{6}
2502 A Common Information Entry holds information that is shared
2503 among many Frame Description Entries. There is at least one
2504 CIE in every non-empty \dotdebugframe{} section. A CIE contains
2505 the following fields, in order:
2506 \begin{enumerate}[1. ]
2507 \item \HFNlength{} (\livelink{datarep:initiallengthvalues}{initial length})  \\
2508 A constant that gives the number of bytes of the CIE structure,
2509 not including the length field itself 
2510 (see Section \refersec{datarep:initiallengthvalues}). 
2511 The
2512 size of the \texttt{length} field plus the value of \texttt{length} must be an
2513 integral multiple of the address size.
2514
2515 \item  \HFNCIEid{} (4 or 8 bytes, see Section \refersec{datarep:32bitand64bitdwarfformats}) \\
2516 A constant that is used to distinguish CIEs from FDEs.
2517
2518 \item  \HFNversion{} (\HFTubyte) \\
2519 A version number\addtoindexx{version number!call frame information} 
2520 (see Section \refersec{datarep:callframeinformation}). 
2521 This number is specific to the call frame information
2522 and is independent of the DWARF version number.
2523
2524 \needlines{8}
2525 \item  \HFNaugmentation{} (\HFTaugstring) \\
2526 A null-terminated UTF\dash 8 string that identifies the augmentation
2527 to this CIE or to the FDEs that use it. If a reader encounters
2528 an augmentation string that is unexpected, then only the
2529 following fields can be read:
2530
2531
2532 \begin{itemize}
2533
2534 \item CIE: \HFNlength, \HFNCIEid, \HFNversion, \HFNaugmentation
2535
2536 \item FDE: \HFNlength, \HFNCIEpointer, \HFNinitiallocation, \HFNaddressrange
2537
2538 \end{itemize}
2539 If there is no augmentation, this value is a zero byte.
2540
2541 \needlines{5}
2542 \textit{The augmentation string allows users to indicate that there
2543 is additional target\dash specific information in the CIE or FDE
2544 which is needed to virtually 
2545 unwind a stack frame. For example, this
2546 might be information about dynamically allocated data which
2547 needs to be freed on exit from the routine.}
2548
2549 \textit{Because the \dotdebugframe{} section is useful independently of
2550 any \dotdebuginfo{} section, the augmentation string always uses
2551 UTF\dash 8 encoding.}
2552
2553 \needlines{4}
2554 \item \HFNaddresssize{} (\HFTubyte) \\
2555 The size of a target address in this CIE and any FDEs that
2556 use it, in bytes. If a compilation unit exists for this frame,
2557 its address size must match the address size here.
2558
2559 \item \HFNsegmentselectorsize{} (\HFTubyte) \\
2560 The size of a segment selector in this CIE and any FDEs that
2561 use it, in bytes.
2562
2563 \item \HFNcodealignmentfactor{} (unsigned LEB128) 
2564 \addtoindexx{LEB128!unsigned}\addtoindexx{unsigned LEB128|see{LEB128, unsigned}}
2565 \addtoindexx{code alignment factor} \\
2566
2567 \addtoindexx{\textless caf\textgreater|see{code alignment factor}}
2568 constant that is factored out of all advance location
2569 instructions (see 
2570 Section \refersec{chap:rowcreationinstructions}).
2571 The resulting value is  
2572 \mbox{\textit{(operand} * \HFNcodealignmentfactor)}.
2573
2574 \item  \HFNdataalignmentfactor{} (signed LEB128)
2575 \addtoindexx{LEB128!signed}\addtoindexx{signed LEB128|see{LEB128, signed}} \\
2576 \addtoindexx{data alignment factor}
2577
2578 \addtoindexx{\textless daf\textgreater|see{data alignment factor}}
2579 constant that is factored out of certain offset instructions
2580 (see Sections \refersec{chap:cfadefinitioninstructions} and 
2581 \refersec{chap:registerruleinstructions}).
2582 The resulting value is  \textit{(operand} *
2583 \HFNdataalignmentfactor).
2584
2585 \item  \HFNreturnaddressregister{} (unsigned LEB128)\addtoindexx{LEB128!unsigned} \\
2586 An unsigned LEB128 constant that indicates which column in the
2587 rule table represents the return address of the function. Note
2588 that this column might not correspond to an actual machine
2589 register.
2590
2591 \needlines{8}
2592 \item \HFNinitialinstructions{} (array of \HFTubyte) \\
2593 A sequence of rules that are interpreted to create the initial
2594 setting of each column in the table.  
2595
2596 The default rule for
2597 all columns before interpretation of the initial instructions
2598 is the undefined rule. However, an ABI authoring body or a
2599 compilation system authoring body may specify an alternate
2600 default value for any or all columns.
2601
2602 \item \HFNpadding{} (array of \HFTubyte) \\
2603 Enough \DWCFAnop{} instructions to make the size of this entry
2604 match the length value above.
2605 \end{enumerate}
2606
2607 \needlines{5}
2608 An FDE contains the following fields, in order:
2609 \begin{enumerate}[1. ]
2610 \item \HFNlength{} (\livelink{datarep:initiallengthvalues}{initial length})  \\
2611 A constant that gives the number of bytes of the header and
2612 instruction stream for this function, not including the length
2613 field itself 
2614 (see Section \refersec{datarep:initiallengthvalues}). 
2615 The size of the \texttt{length} field
2616 plus the value of length must be an integral multiple of the
2617 address size.
2618
2619 \item \HFNCIEpointer{} (4 or 8 bytes, see Section \refersec{datarep:32bitand64bitdwarfformats}) \\
2620 A constant 
2621 \addtoindexx{section offset!in FDE header}
2622 offset into the \dotdebugframe{}
2623 section that denotes
2624 the CIE that is associated with this FDE.
2625
2626 \needlines{4}
2627 \item  \HFNinitiallocation{} (segment selector and target address) \\
2628 The address of the first location associated with this table
2629 entry. 
2630 If the \HFNsegmentselectorsize{} field of this FDE's CIE is non-zero,
2631 the initial location is preceded by a segment selector of
2632 the given length.
2633
2634 \needlines{4}
2635 \item  \HFNaddressrange{} (target address) \\
2636 The number 
2637 \addtoindexx{target address}
2638 of bytes of program instructions described by this entry.
2639
2640 \item \HFNinstructions{} (array of \HFTubyte) \\
2641 A sequence of table defining instructions that are described 
2642 in Section \refersec{chap:callframeinstructions}.
2643
2644 \needlines{4}
2645 \item \HFNpadding{} (array of \HFTubyte) \\
2646 Enough \DWCFAnop{} instructions 
2647 to make the size of this entry match the \HFNlength{} value above.
2648 \end{enumerate}
2649
2650 \needlines{8}
2651 \subsection{Call Frame Instructions}
2652 \label{chap:callframeinstructions}
2653
2654 Each call frame instruction is defined to take 0 or more
2655 operands. Some of the operands may be encoded as part of the
2656 opcode 
2657 (see Section \refersec{datarep:callframeinformation}). 
2658 The instructions are defined in
2659 the following sections.
2660
2661 \needlines{8}
2662 Some call frame instructions have operands that are encoded
2663 as DWARF expressions 
2664 (see Section \refersec{chap:generaloperations}). 
2665 The following DWARF
2666 operators cannot be used in such operands:
2667
2668
2669 \begin{itemize}
2670 \item
2671 \DWOPaddrx, \DWOPcalltwo, \DWOPcallfour{}, \DWOPcallref, 
2672 \DWOPconsttype, \DWOPconstx, \DWOPconvert, \DWOPdereftype, 
2673 \DWOPregvaltype{} and \DWOPreinterpret{}
2674 operators are 
2675 not allowed in an operand of these instructions because
2676 the call frame information must not depend on other
2677 debug sections.
2678
2679 \needlines{5}
2680 \item \DWOPpushobjectaddress{} is not meaningful in an operand
2681 of these instructions because there is no object context to
2682 provide a value to push.
2683
2684 \item \DWOPcallframecfa{} is not meaningful in an operand of
2685 these instructions because its use would be circular.
2686 \end{itemize}
2687
2688 \textit{Call frame instructions to which these restrictions apply
2689 include \DWCFAdefcfaexpression, \DWCFAexpression{}
2690 and \DWCFAvalexpression.}
2691
2692 \needlines{8}
2693 \subsubsection{Row Creation Instructions}
2694 \label{chap:rowcreationinstructions}
2695 \begin{enumerate}[1. ]
2696
2697 \item \textbf{\DWCFAsetlocTARG} \\
2698 The \DWCFAsetlocNAME{} instruction 
2699 takes a single operand that
2700 represents a target address. The required action is to create a
2701 new table row using the specified address as the location. All
2702 other values in the new row are initially identical to the
2703 current row. The new location value is always greater than
2704 the current one. 
2705 If the \HFNsegmentselectorsize{} field of this FDE's 
2706 \addtoindex{CIE}
2707 is non-zero, the initial location is preceded by a segment
2708 selector of the given length.
2709
2710 \needlines{4}
2711 \item \textbf{\DWCFAadvancelocTARG} \\
2712 The \DWCFAadvancelocNAME{} instruction takes a single operand (encoded
2713 with the opcode) that represents a constant delta. The required
2714 action is to create a new table row with a location value that
2715 is computed by taking the current entry\textquoteright s location value
2716 and adding the value of 
2717 \textit{delta} * \addttindex{code\_alignment\_factor}. 
2718 All other values in the new row are initially identical to the
2719 current row
2720
2721 \needlines{6}
2722 \item \textbf{\DWCFAadvanceloconeTARG{}} \\
2723 The \DWCFAadvanceloconeNAME{} instruction takes a single \HFTubyte{}
2724 operand that represents a constant delta. This instruction
2725 is identical to \DWCFAadvanceloc{} except for the encoding
2726 and size of the delta operand.
2727
2728 \item \textbf{\DWCFAadvanceloctwoTARG} \\
2729 The \DWCFAadvanceloctwoNAME{} instruction takes a single \HFTuhalf{}
2730 operand that represents a constant delta. This instruction
2731 is identical to \DWCFAadvanceloc{} except for the encoding
2732 and size of the delta operand.
2733
2734 \item \textbf{\DWCFAadvancelocfourTARG} \\
2735 The \DWCFAadvancelocfourNAME{} instruction takes a single \HFTuword{}
2736 operand that represents a constant delta. This instruction
2737 is identical to \DWCFAadvanceloc{} except for the encoding
2738 and size of the delta operand.
2739
2740 \end{enumerate}
2741
2742 \subsubsection{CFA Definition Instructions}
2743 \label{chap:cfadefinitioninstructions}
2744 \begin{enumerate}[1. ]
2745
2746 \item \textbf{\DWCFAdefcfaTARG} \\
2747 The \DWCFAdefcfaNAME{}
2748 instruction takes two unsigned LEB128\addtoindexx{LEB128!unsigned}
2749 operands representing a register number and a (non-factored)
2750 offset. The required action is to define the current CFA rule
2751 to use the provided register and offset.
2752
2753 \needlines{6}
2754 \item \textbf{\DWCFAdefcfasfTARG} \\
2755 The \DWCFAdefcfasfNAME{} instruction takes two operands:
2756 an unsigned LEB128 value\addtoindexx{LEB128!unsigned}
2757 representing a register number and a
2758 signed LEB128\addtoindexx{LEB128!signed} factored offset. This instruction is identical
2759 to \DWCFAdefcfa{} except that the second operand is signed
2760 and factored. The resulting offset is \textit{factored\_offset} *
2761 \addttindex{data\_alignment\_factor}.
2762
2763
2764 \item \textbf{\DWCFAdefcfaregisterTARG} \\
2765 The \DWCFAdefcfaregisterNAME{} 
2766 instruction takes a single
2767 unsigned LEB128\addtoindexx{LEB128!unsigned} operand representing a register number. The
2768 required action is to define the current CFA rule to use
2769 the provided register (but to keep the old offset). This
2770 operation is valid only if the current CFA rule is defined
2771 to use a register and offset.
2772
2773
2774 \needlines{5}
2775 \item \textbf{\DWCFAdefcfaoffsetTARG} \\
2776 The \DWCFAdefcfaoffsetNAME{} instruction takes a single
2777 unsigned LEB128\addtoindexx{LEB128!unsigned} operand representing a (non-factored)
2778 offset. The required action is to define the current CFA rule
2779 to use the provided offset (but to keep the old register). This
2780 operation is valid only if the current CFA rule is defined
2781 to use a register and offset.
2782
2783 \needlines{6}
2784 \item \textbf{\DWCFAdefcfaoffsetsfTARG} \\
2785 The \DWCFAdefcfaoffsetsfNAME{} instruction takes a signed
2786 LEB128\addtoindexx{LEB128!signed} operand representing a factored offset. This instruction
2787 is identical to \DWCFAdefcfaoffset{} except that the
2788 operand is signed and factored. The resulting offset is
2789 \textit{factored\_offset} * \addttindex{data\_alignment\_factor}.
2790 This operation
2791 is valid only if the current CFA rule is defined to use a
2792 register and offset.
2793
2794 \item \textbf{\DWCFAdefcfaexpressionTARG} \\
2795 The \DWCFAdefcfaexpressionNAME{} instruction takes a 
2796 \addtoindexx{exprloc class}
2797 single operand encoded as a 
2798 \DWFORMexprloc{} value representing a
2799 DWARF expression. The required action is to establish that
2800 expression as the means by which the current CFA is computed.
2801
2802 \textit{See Section \refersec{chap:callframeinstructions} 
2803 regarding restrictions on the DWARF
2804 expression operators that can be used.}
2805
2806 \end{enumerate}
2807
2808 \needlines{8}
2809 \subsubsection{Register Rule Instructions}
2810 \label{chap:registerruleinstructions}
2811 \begin{enumerate}[1. ]
2812
2813 \item \textbf{\DWCFAundefinedTARG} \\
2814 The \DWCFAundefinedNAME{} instruction takes a single unsigned
2815 LEB128\addtoindexx{LEB128!unsigned} operand that represents a register number. The required
2816 action is to set the rule for the specified register to
2817 \doublequote{undefined.}
2818
2819 \item \textbf{\DWCFAsamevalueTARG} \\
2820 The \DWCFAsamevalueNAME{} instruction takes a single unsigned
2821 LEB128 operand\addtoindexx{LEB128!unsigned} that represents a register number. The required
2822 action is to set the rule for the specified register to
2823 \doublequote{same value.}
2824
2825 \item \textbf{\DWCFAoffsetTARG} \\
2826 The \DWCFAoffsetNAME{} instruction takes two operands: a register
2827 number (encoded with the opcode) and an unsigned LEB128\addtoindexx{LEB128!unsigned}
2828 constant representing a factored offset. The required action
2829 is to change the rule for the register indicated by the
2830 register number to be an offset(N) rule where the value of
2831 N is 
2832 \textit{factored offset} * \addttindex{data\_alignment\_factor}.
2833
2834 \needlines{4}
2835 \item \textbf{\DWCFAoffsetextendedTARG} \\
2836 The \DWCFAoffsetextendedNAME{} 
2837 instruction takes two unsigned LEB128\addtoindexx{LEB128!unsigned} 
2838 operands representing a register number and a factored
2839 offset. This instruction is identical to
2840 \DWCFAoffset{} 
2841 except for the encoding and size of the register operand.
2842
2843 \needlines{6}
2844 \item \textbf{\DWCFAoffsetextendedsfTARG} \\
2845 The \DWCFAoffsetextendedsfNAME{} 
2846 instruction takes two operands:
2847 an unsigned LEB128\addtoindexx{LEB128!unsigned} 
2848 value representing a register number and a
2849 signed LEB128 factored offset. This instruction is identical
2850 to \DWCFAoffsetextended{} 
2851 except that the second operand is
2852 signed and factored. The resulting offset is 
2853 \textit{factored\_offset} * \addttindex{data\_alignment\_factor}.
2854
2855 \needlines{4}
2856 \item \textbf{\DWCFAvaloffsetTARG} \\
2857 The \DWCFAvaloffsetNAME{} 
2858 instruction takes two unsigned
2859 LEB128 operands\addtoindexx{LEB128!unsigned} representing a register number and a
2860 factored offset. The required action is to change the rule
2861 for the register indicated by the register number to be a
2862 val\_offset(N) rule where the value of N is 
2863 \textit{factored\_offset} * \addttindex{data\_alignment\_factor}.
2864
2865 \needlines{6}
2866 \item \textbf{\DWCFAvaloffsetsfTARG} \\
2867 The \DWCFAvaloffsetsfNAME{} instruction takes two operands: an
2868 unsigned LEB128\addtoindexx{LEB128!unsigned} value representing a register number and a
2869 signed LEB128\addtoindexx{LEB128!signed} factored offset. This instruction is identical
2870 to \DWCFAvaloffset{} except that the second operand is signed
2871 and factored. The resulting offset is 
2872 \textit{factored\_offset} * \addttindex{data\_alignment\_factor}.
2873
2874 \item \textbf{\DWCFAregisterTARG} \\
2875 The \DWCFAregisterNAME{} 
2876 instruction takes two unsigned LEB128\addtoindexx{LEB128!unsigned}
2877 operands representing register numbers. The required action
2878 is to set the rule for the first register to be register(R)
2879 where R is the second register.
2880
2881 \item \textbf{\DWCFAexpressionTARG} \\
2882 The \DWCFAexpressionNAME{} instruction takes two operands: an
2883 unsigned LEB128\addtoindexx{LEB128!unsigned} 
2884 value representing a register number, and
2885 a \DWFORMblock{} 
2886 value representing a DWARF expression. 
2887 The
2888 required action is to change the rule for the register
2889 indicated by the register number to be an expression(E)
2890 rule where E is the DWARF expression. That is, the DWARF
2891 expression computes the address. The value of the CFA is
2892 pushed on the DWARF evaluation stack prior to execution of
2893 the DWARF expression.
2894
2895 \textit{See Section \refersec{chap:callframeinstructions} 
2896 regarding restrictions on the DWARF
2897 expression operators that can be used.}
2898
2899 \needlines{7}
2900 \item \textbf{\DWCFAvalexpressionTARG} \\
2901 The \DWCFAvalexpressionNAME{} instruction takes two operands:
2902 an unsigned LEB128\addtoindexx{LEB128!unsigned} 
2903 value representing a register number, and
2904 a \DWFORMblock{} 
2905 value representing a DWARF expression. The
2906 required action is to change the rule for the register
2907 indicated by the register number to be a val\_expression(E)
2908 rule where E is the DWARF expression. That is, the DWARF
2909 expression computes the value of the given register. The value
2910 of the CFA is pushed on the DWARF evaluation stack prior to
2911 execution of the DWARF expression.
2912
2913 \textit{See Section \refersec{chap:callframeinstructions} 
2914 regarding restrictions on the DWARF
2915 expression operators that can be used.}
2916
2917 \needlines{6}
2918 \item \textbf{\DWCFArestoreTARG} \\
2919 The \DWCFArestoreNAME{} instruction takes a single operand (encoded
2920 with the opcode) that represents a register number. The
2921 required action is to change the rule for the indicated
2922 register to the rule assigned it by the \texttt{initial\_instructions}
2923 in the CIE.
2924
2925 \needlines{5}
2926 \item \textbf{\DWCFArestoreextendedTARG} \\
2927 The \DWCFArestoreextendedNAME{}
2928 instruction takes a single unsigned LEB128\addtoindexx{LEB128!unsigned} 
2929 operand that represents a register number. This
2930 instruction is identical to \DWCFArestore{} except for the
2931 encoding and size of the register operand.
2932
2933 \end{enumerate}
2934
2935 \subsubsection{Row State Instructions}
2936 \label{chap:rowstateinstructions}
2937
2938 \textit{The next two instructions provide the ability to stack and
2939 retrieve complete register states. They may be useful, for
2940 example, for a compiler that moves \addtoindex{epilogue} code 
2941 into the
2942 body of a function.}
2943
2944
2945 \begin{enumerate}[1. ]
2946
2947 \item \textbf{\DWCFArememberstateTARG} \\
2948 The \DWCFArememberstateNAME{} instruction takes no operands. The
2949 required action is to push the set of rules for every register
2950 onto an implicit stack.
2951
2952 \needlines{4}
2953 \item \textbf{\DWCFArestorestateTARG} \\
2954 The \DWCFArestorestateNAME{} instruction takes no operands. The
2955 required action is to pop the set of rules off the implicit
2956 stack and place them in the current row.
2957
2958 \end{enumerate}
2959
2960 \subsubsection{Padding Instruction}
2961 \label{chap:paddinginstruction}
2962 \begin{enumerate}[1. ]
2963 \item \textbf{\DWCFAnopTARG} \\
2964 The \DWCFAnopNAME{} instruction has no operands and no required
2965 actions. It is used as padding to make a CIE or FDE an
2966 appropriate size.
2967
2968 \end{enumerate}
2969
2970 \subsection{Call Frame Instruction Usage} 
2971 \label{chap:callframeinstructionusage}
2972
2973 \textit{To determine the virtual unwind rule set for a given location
2974 (L1), search through the FDE headers looking at the
2975 \HFNinitiallocation{} and \HFNaddressrange{} values to see if L1 is
2976 contained in the FDE. If so, then:}
2977 \begin{enumerate}[1. ]
2978
2979 \item \textit{Initialize a register set by reading the
2980 \HFNinitialinstructions{} field of the associated CIE.
2981 Set L2 to the value of the \HFNinitiallocation{} field from the FDE header.}
2982
2983
2984 \item \textit{Read and process the FDE's instruction
2985 sequence until a \DWCFAadvanceloc, 
2986 \DWCFAsetloc, or the
2987 end of the instruction stream is encountered.}
2988
2989 \item \textit{ If a \DWCFAadvanceloc{} or \DWCFAsetloc{}
2990 instruction is encountered, then compute a new location value
2991 (L2). If L1 $\geq$ L2 then process the instruction and go back
2992 to step 2.}
2993
2994 \needlines{6}
2995 \item \textit{ The end of the instruction stream can be thought
2996 of as a \DWCFAsetloc{} (\addttindex{initial\_location} + \addttindex{address\_range})
2997 instruction. Note that the FDE is ill-formed if L2 is less
2998 than L1.}
2999
3000 \end{enumerate}
3001
3002 \textit{The rules in the register set now apply to location L1.}
3003
3004 \textit{For an example, see 
3005 Appendix \refersec{app:callframeinformationexample}.}
3006
3007
3008
3009 \subsection{Call Frame Calling Address}
3010 \label{chap:callframecallingaddress}
3011
3012 \textit{When 
3013 virtually unwinding frames, consumers frequently wish to obtain 
3014 the address of the instruction which called a subroutine. This
3015 information is not always provided. Typically, however,
3016 one of the registers in the virtual unwind table is the
3017 Return Address.}
3018
3019 If a Return Address register is defined in the virtual
3020 unwind table, and its rule is undefined (for example, by
3021 \DWCFAundefined), then there is no return address and no
3022 call address, and the virtual unwind of stack activations
3023 \addtoindexx{activation of call frame}
3024 is complete.
3025
3026 \textit{In most cases the return address is in the same context as the
3027 calling address, but that need not be the case, especially if
3028 the producer knows in some way the call never will return. The
3029 context of the 'return address' might be on a different line,
3030 in a different lexical \livelink{chap:lexicalblock}{block}, 
3031 or past the end of the calling
3032 subroutine. If a consumer were to assume that it was in the
3033 same context as the calling address, the 
3034 virtual unwind might fail.}
3035
3036 \needlines{5}
3037 \textit{For architectures with constant-length instructions where
3038 the return address immediately follows the call instruction,
3039 a simple solution is to subtract the length of an instruction
3040 from the return address to obtain the calling instruction. For
3041 architectures with variable-length instructions (for example, x86),
3042 this is not possible. However, subtracting 1 from the return
3043 address, although not guaranteed to provide the exact calling
3044 address, generally will produce an address within the same
3045 context as the calling address, and that usually is sufficient.}
3046
3047
3048