Check point of work to date.
[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 \bb
792 The name table immediately follows the hash lookup table. It
793 consists of two arrays: an array of string offsets, followed
794 immediately by an array of entry offsets. The items in both
795 arrays are section offsets: 4-byte unsigned integers for the
796 DWARF-32 format or 8-byte unsigned integers for the DWARF-64
797 format. The string offsets in the first array refer to names in
798 the \dotdebugstr{} (or \dotdebugstrdwo) section. The entry offsets
799 in the second array refer to index entries, and are relative to
800 the start of the entry pool area.
801
802 These two arrays are indexed starting at 1, and correspond 
803 one-to-one with each other. The length of each array is
804 given by \texttt{name\_count}.
805
806 If there is a hash lookup table, the hashes array corresponds on
807 a one-to-one basis with the string offsets array and with the
808 entry offsets array.
809
810 \textit{If there is no hash lookup table, there is no ordering
811 requirement for the name table.}
812 \eb
813
814 \needlines{6}
815 \subsubsubsection{Abbreviations Table}
816 The abbreviations table immediately follows the name table. This table
817 consists of a series of abbreviation declarations. Its size is given
818 by \texttt{abbrev\_table\_size}.
819
820 Each abbreviation declaration defines the tag and other attributes for
821 a particular form of index entry. Each declaration starts with an
822 unsigned LEB128 number representing the abbreviation code itself. It
823 is this code that appears at the beginning of an index entry. The
824 abbreviation code must not be 0.
825
826 The abbreviation code is followed by another unsigned LEB128 number
827 that encodes the tag of the debugging information entry corresponding
828 to the index entry.
829
830 Following the tag encoding is a series of attribute specifications.
831 Each attribute consists of two parts: an unsigned LEB128 number that
832 represents the index attribute, and another unsigned LEB128 number
833 that represents the attribute's form (as described in 
834 Section \refersec{datarep:attributeencodings}). The series of attribute 
835 specifications ends with an entry containing 0 for the attribute and 
836 0 for the form.
837
838 The index attributes and their meanings are listed in 
839 Table \referfol{tab:indexattributeencodings}.
840
841 \begin{centering}
842 \setlength{\extrarowheight}{0.1cm}
843 \begin{longtable}{l|l}
844   \caption{Index attribute encodings} \label{tab:indexattributeencodings}\\
845   \hline \bfseries Attribute name &\bfseries Meaning \\ \hline
846 \endfirsthead
847   \bfseries Attribute name &\bfseries Meaning \\ \hline
848 \endhead
849   \hline \emph{Continued on next page}
850 \endfoot
851   \hline
852 \endlastfoot
853 \DWIDXcompileunitTARG & Index of CU                                  \\
854 \DWIDXtypeunitTARG    & Index of TU (\mbox{local} or foreign)        \\
855 \DWIDXdieoffsetTARG   & Offset of DIE within CU or TU                \\
856 \DWIDXparentTARG      & Index of name \mbox{table} entry for parent  \\
857 \DWIDXtypehashTARG    & Hash of type \mbox{declaration}              \\
858 \end{longtable}
859 \end{centering}
860
861 The abbreviations table ends with an entry consisting of a single 0
862 byte for the abbreviation code. The size of the table given by
863 \texttt{abbrev\_table\_size} may include optional padding following the
864 terminating 0 byte.
865
866 \subsubsubsection{Entry Pool}
867 \bb
868 The entry pool immediately follows the abbreviations table. 
869 Each entry in the entry offsets array in the name table (see 
870 Section \ref{chap:nametable})
871 \eb
872 points to an offset in the entry pool, where a series
873 of index entries for that name is located.
874
875 \needlines{4}
876 Each index entry in the series begins with an abbreviation code, and is
877 followed by the attributes described by the abbreviation declaration
878 for that code. The last index entry in the series is followed by a
879 terminating entry whose abbreviation code is 0.
880
881 Gaps are not allowed between entries in a series (that is, the entries
882 for a single name must all be contiguous), but there may be gaps
883 between series.
884
885 \textit{For example, a producer/consumer combination may find
886 it useful to maintain alignment.}
887
888 The size of the entry pool is the remaining size of the contribution to
889 the index section, as defined by the \texttt{unit\_length} header field.
890
891 \subsection{Lookup by Address}
892 \label{chap:lookupbyaddress}
893 For \addtoindexx{lookup!by address}
894 lookup by address, a table is maintained in a separate
895 \addtoindexx{accelerated access!by address}
896 object file section called 
897 \dotdebugaranges{}. The table consists
898 of sets of variable length entries, each set describing the
899 portion of the program\textquoteright{}s address space that is covered by
900 a single compilation unit.
901
902 \needlines{4}
903 Each set begins with a header containing five values:
904 \begin{enumerate}[1. ]
905 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length}) \\
906 \addttindexx{unit\_length}
907 The length of this contribution to the address lookup section,
908 not including the length field itself.
909
910 \item \texttt{version} (\HFTuhalf) \\
911 A version number\addtoindexx{version number!address lookup table}
912 (see Section \refersec{datarep:addrssrangetable}). 
913 This number is specific to the address lookup table and is
914 independent of the DWARF version number.
915
916 \item \texttt{debug\_info\_offset} (section offset) \\
917 The offset from the
918 \addtoindexx{section offset!in .debug\_aranges header}
919 beginning of the \dotdebuginfo{} section of the
920 compilation unit header referenced by the set.
921
922 \item \texttt{address\_size} (\HFTubyte) \\
923 The \addtoindex{size of an address}
924 in bytes on
925 \addttindexx{address\_size}
926 the target architecture. For 
927 \addtoindexx{address space!segmented}
928 segmented addressing, this is
929 the size of the offset portion of the address.
930
931 \item \HFNsegmentselectorsize{} (\HFTubyte) \\
932 The size of a segment selector in
933 bytes on the target architecture. If the target system uses
934 a flat address space, this value is 0.
935
936 \end{enumerate}
937
938 This header is followed by a variable number of address range
939 descriptors. Each descriptor is a triple consisting of a
940 segment selector, the beginning address within that segment
941 of a range of text or data covered by some entry owned by
942 the corresponding compilation unit, followed by the non-zero
943 length of that range. A particular set is terminated by an
944 entry consisting of three zeroes. 
945 When the \HFNsegmentselectorsize{} value
946 is zero in the header, the segment selector is omitted so that
947 each descriptor is just a pair, including the terminating
948 entry. By scanning the table, a debugger can quickly decide
949 which compilation unit to look in to find the debugging
950 information for an object that has a given address.
951
952 \textit{If the range of addresses covered by the text and/or data
953 of a compilation unit is not contiguous, then there may be
954 multiple address range descriptors for that compilation unit.}
955
956
957 \section{Line Number Information}
958 \label{chap:linenumberinformation}
959 \textit{A source\dash level debugger needs to know how to
960 \addtoindexx{line number information|see{\textit{also} statement list attribute}}
961 associate locations in the source files with the corresponding
962 machine instruction addresses in the executable or the shared 
963 object files used by that executable object file. Such an
964 association makes it possible for the debugger user
965 to specify machine instruction addresses in terms of source
966 locations. This is done by specifying the line number
967 and the source file containing the statement. The debugger
968 can also use this information to display locations in terms
969 of the source files and to single step from line to line,
970 or statement to statement.}
971
972 Line number information generated for a compilation unit is
973 represented in the 
974 \dotdebugline{} section of an object file, and optionally
975 also in the \dotdebuglinestr{} section, and
976 is referenced by a corresponding compilation unit debugging
977 information entry 
978 (see Section \refersec{chap:fullandpartialcompilationunitentries}) 
979 in the \dotdebuginfo{} section.
980
981 \textit{Some computer architectures employ more than one instruction
982 set (for example, the ARM 
983 \addtoindexx{ARM instruction set architecture}
984 and 
985 MIPS architectures support
986 \addtoindexx{MIPS instruction set architecture}
987 a 32-bit as well as a 16-bit instruction set). Because the
988 instruction set is a function of the program counter, it is
989 convenient to encode the applicable instruction set in the
990 \dotdebugline{} section as well.}
991
992 \textit{If space were not a consideration, the information provided
993 in the \dotdebugline{} 
994 section could be represented as a large
995 matrix, with one row for each instruction in the emitted
996 object code. The matrix would have columns for:}
997 \begin{itemize}
998 \item \textit{the source file name}
999 \item \textit{the source line number}
1000 \item \textit{the source column number}
1001 \item \textit{whether this instruction is the beginning of a source statement}
1002 \item \textit{whether this instruction is the beginning of a \addtoindex{basic block}}
1003 \item \textit{and so on}
1004 \end{itemize}
1005 \textit{Such a matrix, however, would be impractically large. We
1006 shrink it with two techniques. First, we delete from
1007 the matrix each row whose file, line, source column and
1008 discriminator\addttindexx{discriminator} 
1009 is identical with that of its
1010 predecessors. Any deleted row would never be the beginning of
1011 a source statement. Second, we design a byte-coded language
1012 for a state machine and store a stream of bytes in the object
1013 file instead of the matrix. This language can be much more
1014 compact than the matrix. To the line number information a 
1015 consumer must \doublequote{run} the state machine
1016 to generate the matrix for each compilation unit of interest.
1017 The concept of an encoded matrix also leaves
1018 room for expansion. In the future, columns can be added to the
1019 matrix to encode other things that are related to individual
1020 instruction addresses.}
1021
1022 \needlines{10}
1023 \subsection{Definitions}
1024 \label{chap:definitions}
1025 The following terms are used in the description of the line
1026 number information format:
1027
1028 \begin{longtable} {lP{9cm}}
1029 state machine &
1030 The hypothetical machine used by a consumer of the line number
1031 information to expand the byte\dash coded 
1032 instruction stream into a matrix of
1033 line number information. \\
1034
1035 line number program &
1036 A series of byte\dash coded 
1037 line number information instructions representing
1038 one compilation unit. \\
1039
1040 \addtoindex{basic block} &
1041  A sequence of instructions where only the first instruction may be a
1042 branch target and only the last instruction may transfer control. A
1043 subprogram invocation is defined to be an exit from a 
1044 \addtoindex{basic block}.
1045
1046 \textit{A \addtoindex{basic block} does not 
1047 necessarily correspond to a specific source code
1048 construct.} \\
1049
1050 sequence &
1051 A series of contiguous target machine instructions. One compilation unit
1052 may emit multiple sequences (that is, not all instructions within a
1053 compilation unit are assumed to be contiguous). \\
1054 \end{longtable}
1055
1056 \needlines{8}
1057 \subsection{State Machine Registers}
1058 \label{chap:statemachineregisters}
1059 The line number information state machine has a number of  
1060 registers as shown in Table \referfol{tab:statemachineregisters}.
1061
1062 \begin{longtable}{l|P{9cm}}
1063   \caption{State machine registers } \label{tab:statemachineregisters} \\
1064   \hline \bfseries Register name&\bfseries Meaning\\ \hline
1065 \endfirsthead
1066   \bfseries Register name&\bfseries Meaning\\ \hline
1067 \endhead
1068   \hline \emph{Continued on next page}
1069 \endfoot
1070   \hline
1071 \endlastfoot
1072 \addtoindexi{\texttt{address}}{address register!in line number machine}&
1073 The program\dash counter value corresponding to a machine instruction
1074 generated by the compiler. \\
1075
1076 \addttindex{op\_index} &
1077 An unsigned integer representing the index of an operation within a VLIW
1078 instruction. The index of the first operation is 0. For non-VLIW
1079 architectures, this register will always be 0.  \\
1080
1081 \addttindex{file} &
1082 An unsigned integer indicating the identity of the source file
1083 corresponding to a machine instruction. \\
1084
1085 \addttindex{line} &
1086 An unsigned integer indicating a source line number. Lines are numbered
1087 beginning at 1. The compiler may emit the value 0 in cases where an
1088 instruction cannot be attributed to any source line. \\
1089
1090 \addttindex{column} &
1091 An unsigned integer indicating a column number within a source line.
1092 Columns are numbered beginning at 1. The value 0 is reserved to indicate
1093 that a statement begins at the \doublequote{left edge} of the line. \\
1094
1095 \addttindex{is\_stmt} &
1096 A boolean indicating that the current instruction is a recommended
1097 breakpoint location. A recommended breakpoint location 
1098 is intended to \doublequote{represent} a line, a 
1099 statement and/or a semantically distinct subpart of a
1100 statement. \\
1101
1102 \addttindex{basic\_block}  &
1103 A boolean indicating that the current instruction is the beginning of a
1104 \addtoindex{basic block}. \\
1105
1106 \addttindex{end\_sequence} &
1107 A boolean indicating that the current address is that of the first byte after
1108 the end of a sequence of target machine instructions. 
1109 \addttindex{end\_sequence}
1110 terminates a sequence of lines; therefore other information in the same
1111 row is not meaningful. \\
1112
1113 \addttindex{prologue\_end} &
1114 A boolean indicating that the current address is one (of possibly many)
1115 where execution should be suspended for a breakpoint at the entry of a
1116 function. \\
1117
1118 \addttindex{epilogue\_begin} &
1119 A boolean indicating that the current address is one (of possibly many)
1120 where execution should be suspended for a breakpoint just prior to
1121 the exit of a function. \\
1122
1123 \addttindex{isa} &
1124 An unsigned integer whose value encodes the applicable
1125 instruction set architecture for the current instruction.
1126
1127 \textit{The encoding of instruction sets should be shared by all
1128 users of a given architecture. It is recommended that this
1129 encoding be defined by the ABI authoring committee for each
1130 architecture.} \\
1131
1132 \addttindex{discriminator} &
1133 An unsigned integer identifying the block to which the
1134 current instruction belongs. Discriminator values are assigned
1135 arbitrarily by the DWARF producer and serve to distinguish
1136 among multiple blocks that may all be associated with the
1137 same source file, line, and column. Where only one block
1138 exists for a given source position, the discriminator value
1139 is be zero. \\
1140 \end{longtable}
1141
1142 The \texttt{address} and \addttindex{op\_index} registers,
1143 taken together, form an \addtoindex{operation pointer} that can 
1144 reference any individual operation within the instruction stream.
1145
1146 At the beginning  of each sequence within a line number
1147 program, the state of the registers is as show in Table
1148 \refersec{tab:linenumberprograminitiastate}.
1149 \begin{table}
1150 \caption{Line number program initial state}
1151 \label{tab:linenumberprograminitiastate}
1152 \begin{center}
1153 \begin{tabular}{l|p{9.5cm}}
1154 \hline
1155 \texttt{address} & 0 \\
1156 \addttindex{op\_index} & 0 \\
1157 \texttt{file} & 1 \\
1158 \texttt{line} & 1 \\
1159 \texttt{column} & 0 \\
1160 \addttindex{is\_stmt} & determined by \addttindex{default\_is\_stmt} 
1161                         in the line number program header \\
1162 \addttindex{basic\_block}    & \doublequote{false} \addtoindexx{basic block} \\
1163 \addttindex{end\_sequence}   & \doublequote{false} \\
1164 \addttindex{prologue\_end}   & \doublequote{false} \\
1165 \addttindex{epilogue\_begin} & \doublequote{false} \\
1166 \addttindex{isa} & 0 \\
1167 \addttindex{discriminator} & 0 \\
1168 \hline
1169 \end{tabular}
1170 \end{center}
1171 \vspace{5mm}
1172 \end{table}
1173
1174 \textit{The 
1175 \addttindex{isa} value 0 specifies that the instruction set is the
1176 architecturally determined default instruction set. This may
1177 be fixed by the ABI, or it may be specified by other means,
1178 for example, by the object file description.}
1179
1180 \needlines{6}
1181 \subsection{Line Number Program Instructions}
1182 The state machine instructions in a line number program belong to one of three categories:
1183
1184 \begin{enumerate}[1. ]
1185 \item special opcodes \\
1186 These have a \HFTubyte{} opcode field and no operands.\vspace{1ex}
1187
1188 \textit{Most of the instructions in a 
1189 line number program are special opcodes.}
1190
1191 \needlines{4}
1192 \item standard opcodes \\
1193 These have a \HFTubyte{} opcode field which may be followed by zero or more
1194 \addtoindex{LEB128} operands (except for 
1195 \mbox{\DWLNSfixedadvancepc,} see 
1196 Section \refersec{chap:standardopcodes}).
1197 The opcode implies the number of operands and their meanings, but the
1198 line number program header also specifies the number of operands for
1199 each standard opcode.
1200
1201 \needlines{4}
1202 \item extended opcodes \\
1203 These have a multiple byte format. The first byte is zero; the next bytes
1204 are an unsigned LEB128\addtoindexx{LEB128!unsigned} integer giving the number of bytes in the
1205 instruction itself (does not include the first zero byte or the size). The
1206 remaining bytes are the instruction itself (which begins with a \HFTubyte{}
1207 extended opcode). \\
1208 \end{enumerate}
1209
1210
1211 \subsection{The Line Number Program Header}
1212 \label{chap:linenumberprogramheader}
1213 The optimal encoding of line number information depends to a
1214 certain degree upon the architecture of the target machine. The
1215 line number program header provides information used by
1216 consumers in decoding the line number program instructions for
1217 a particular compilation unit and also provides information
1218 used throughout the rest of the line number program.
1219
1220 The line number program for each compilation unit begins with
1221 a header containing the following fields in order:
1222
1223 \begin{enumerate}[1. ]
1224 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length})  \\
1225 \addttindexx{unit\_length}
1226 The size in bytes of the line number information for this
1227 compilation unit, not including the length field itself
1228 (see Section \refersec{datarep:initiallengthvalues}). 
1229
1230 \needlines{4}
1231 \item \texttt{version} (\HFTuhalf) \\
1232 A version number\addtoindexx{version number!line number information} 
1233 (see Section \refersec{datarep:linenumberinformation}). 
1234 This number is specific to
1235 the line number information and is independent of the DWARF
1236 version number. 
1237
1238 \item \texttt{address\_size} (\HFTubyte)\\
1239 A 1-byte unsigned integer containing the size in bytes of an
1240 address (or offset portion of an address for segmented addressing)
1241 on the target system.
1242    
1243 \textit{The \addttindex{address\_size} field is new in DWARF Version 5. 
1244 It is needed to support the common practice of stripping all but 
1245 the line number sections (\dotdebugline{} and \dotdebuglinestr{}) 
1246 from an executable.}
1247
1248 \item \HFNsegmentselectorsize{} (\HFTubyte) \\
1249 A 1-byte unsigned integer containing the size in bytes of a segment
1250 selector on the target system.
1251    
1252 \textit{The \HFNsegmentselectorsize{} field is new in DWARF Version 5. 
1253 It is needed in combination with the \addttindex{address\_size} field 
1254 to accurately characterize the address representation on the target 
1255 system.}
1256
1257 \needlines{4}
1258 \item \texttt{header\_length}  \\
1259 The number of bytes following the \addttindex{header\_length} field to the
1260 beginning of the first byte of the line number program itself.
1261 In the \thirtytwobitdwarfformat, this is a 4-byte unsigned
1262 length; in the \sixtyfourbitdwarfformat, this field is an
1263 8-byte unsigned length 
1264 (see Section \refersec{datarep:32bitand64bitdwarfformats}). 
1265
1266 \item \texttt{minimum\_instruction\_length} (\HFTubyte)  \\
1267 \addttindexx{minimum\_instruction\_length}
1268 The size in bytes of the smallest target machine
1269 instruction. Line number program opcodes that alter
1270 the \texttt{address} and \addttindex{op\_index}
1271 registers use this and
1272 \addttindex{maximum\_operations\_per\_instruction}
1273 in their calculations. 
1274
1275 \needlines{9}
1276 \item \texttt{maximum\_operations\_per\_instruction} (\HFTubyte) \\
1277 The 
1278 \addttindexx{maximum\_operations\_per\_instruction}
1279 maximum number of individual operations that may be
1280 encoded in an instruction. Line number program opcodes
1281 that alter the \texttt{address} and 
1282 \addttindex{op\_index} registers use this and
1283 \addttindex{minimum\_instruction\_length} in their calculations.
1284
1285 For non-VLIW
1286 architectures, this field is 1, the \addttindex{op\_index} register is always
1287 0, and the \addtoindex{operation pointer} is simply the \texttt{address} register.
1288
1289 \needlines{4}
1290 \item \texttt{default\_is\_stmt} (\HFTubyte) \\
1291 \addttindexx{default\_is\_stmt}
1292 The initial value of the \addttindex{is\_stmt} register.  
1293
1294 \textit{A simple approach
1295 to building line number information when machine instructions
1296 are emitted in an order corresponding to the source program
1297 is to set \addttindex{default\_is\_stmt}
1298 to \doublequote{true} and to not change the
1299 value of the \addttindex{is\_stmt} register 
1300 within the line number program.
1301 One matrix entry is produced for each line that has code
1302 generated for it. The effect is that every entry in the
1303 matrix recommends the beginning of each represented line as
1304 a breakpoint location. This is the traditional practice for
1305 unoptimized code.}
1306
1307 \textit{A more sophisticated approach might involve multiple entries in
1308 the matrix for a line number; in this case, at least one entry
1309 (often but not necessarily only one) specifies a recommended
1310 breakpoint location for the line number. \DWLNSnegatestmt{}
1311 opcodes in the line number program control which matrix entries
1312 constitute such a recommendation and 
1313 \addttindex{default\_is\_stmt} might
1314 be either \doublequote{true} or \doublequote{false.} This approach might be
1315 used as part of support for debugging optimized code.}
1316
1317 \item \texttt{line\_base} (\HFTsbyte) \\
1318 \addttindexx{line\_base}
1319 This parameter affects the meaning of the special opcodes. See below.
1320
1321 \item \texttt{line\_range} (\HFTubyte) \\
1322 \addttindexx{line\_range}
1323 This parameter affects the meaning of the special opcodes. See below.
1324
1325 \needlines{4}
1326 \item \texttt{opcode\_base} (\HFTubyte) \\
1327 The 
1328 \addttindexx{opcode\_base}
1329 number assigned to the first special opcode.
1330
1331 \textit{Opcode base is typically one greater than the highest-numbered
1332 \addttindexx{opcode\_base}
1333 standard opcode defined for the specified version of the line
1334 number information (12 in DWARF Versions 3, 4 and 5,
1335 \addtoindexx{DWARF Version 3}
1336 \addtoindexx{DWARF Version 4}
1337 \addtoindexx{DWARF Version 5}
1338 and 9 in
1339 \addtoindexx{DWARF Version 2}
1340 Version 2).  
1341 If opcode\_base is less than the typical value,
1342 \addttindexx{opcode\_base}
1343 then standard opcode numbers greater than or equal to the
1344 opcode base are not used in the line number table of this unit
1345 (and the codes are treated as special opcodes). If \texttt{opcode\_base}
1346 is greater than the typical value, then the numbers between
1347 that of the highest standard opcode and the first special
1348 opcode (not inclusive) are used for vendor specific extensions.}
1349
1350 \needlines{4}
1351 \item \texttt{standard\_opcode\_lengths} (array of \HFTubyte) \\
1352 \addttindexx{standard\_opcode\_lengths}
1353 This array specifies the number of \addtoindex{LEB128} operands for each
1354 of the standard opcodes. The first element of the array
1355 corresponds to the opcode whose value is 1, and the last
1356 element corresponds to the opcode whose value 
1357 is \texttt{opcode\_base - 1}.
1358
1359 \textit{By increasing \texttt{opcode\_base}, and adding elements to this array,
1360 \addttindexx{opcode\_base}
1361 new standard opcodes can be added, while allowing consumers who
1362 do not know about these new opcodes to be able to skip them.}
1363
1364 \textit{Codes for vendor specific extensions, if any, are described
1365 just like standard opcodes.}
1366
1367 %%% Save the current enum counter so we can restart later
1368 %%% End this enumeration so the following text is outdented to
1369 %%% the left margin (because it applies to the many following
1370 %%% items
1371 \newcounter{saveenumi}
1372 \setcounter{saveenumi}{\value{enumi}}
1373 \end{enumerate}
1374
1375 \needlines{6}
1376 \textit{The remaining fields provide information about the
1377 source files used in the compilation. These fields
1378 have been revised in \DWARFVersionV{} to support these
1379 goals:}
1380 \begin{itemize}
1381 \item
1382     \textit{To allow new alternative means for a consumer to
1383     check that a file it can access is the same version
1384     as that used in the compilation.}
1385 \item
1386     \textit{To allow a producer to collect file name strings
1387     in a new section (\dotdebuglinestr{}) that can be used
1388     to merge duplicate file name strings.}
1389 \item
1390     \textit{To add the ability for producers to provide 
1391     vendor-defined information that can be skipped by a consumer
1392     that is unprepared to process it.}
1393 \end{itemize}
1394
1395 \begin{enumerate}[1. ]
1396 %%% Resume enumeration count where it left off above
1397 \setcounter{enumi}{\value{saveenumi}}
1398 \item \texttt{directory\_entry\_format\_count} (\HFTubyte) \\
1399 \addttindexx{directory\_entry\_format\_count}
1400     A count of the number of entries that occur in the
1401     following \addttindex{directory\_entry\_format} field.
1402
1403 \needlines{8}
1404 \item \texttt{directory\_entry\_format} (sequence of ULEB128 pairs) \\
1405 \addttindexx{directory\_entry\_format}
1406     A sequence of directory entry format descriptions.
1407     Each description consists of a pair of ULEB128 values:
1408 \begin{itemize}
1409 \setlength{\itemsep}{0em}
1410 \item A content type code (see 
1411 Sections \refersec{chap:standardcontentdescriptions} and
1412 \refersec{chap:vendordefinedcontentdescriptions}).
1413
1414 \item A form code using the attribute form codes
1415 \end{itemize}
1416
1417 \needlines{4} 
1418 \item \texttt{directories\_count} (ULEB128) \\
1419 \addttindexx{directories\_count}
1420 A count of the number of entries that occur in the
1421 following directories field.
1422
1423 \needlines{4}    
1424 \item \texttt{directories} (sequence of directory names) \\
1425 \addttindexx{directories}
1426 A sequence of directory names and optional related
1427 information. Each entry is encoded as described
1428 by the \addttindex{directory\_entry\_format} field.
1429    
1430 Entries in this sequence describe each path that was
1431 searched for included source files in this compilation,
1432 including the compilation directory of the compilation.
1433 (The paths include those directories specified by the
1434 user for the compiler to search and those the compiler
1435 searches without explicit direction.)
1436    
1437 The first entry is the current directory of the compilation.
1438 Each additional path entry is either a full path name or
1439 is relative to the current directory of the compilation.
1440    
1441 The line number program assigns a number (index) to each
1442 of the directory entries in order, beginning with 0.
1443    
1444 \textit{Prior to \DWARFVersionV, the current directory was not
1445 represented in the directories field and a directory index
1446 of 0 implicitly referred to that directory as found in the
1447 \DWATcompdir{} attribute of the compilation unit 
1448 debugging information entry. 
1449 In \DWARFVersionV, the current directory is explicitly present
1450 in the directories field. This is needed to support the
1451 common practice of stripping all but the line number sections
1452 (\dotdebugline{} and \dotdebuglinestr) from an executable.}
1453
1454 \textit{Note that if a \dotdebuglinestr{} section is present, 
1455 both the compilation unit debugging information entry 
1456 and the line number header can
1457 share a single copy of the current directory name string.}
1458
1459 \item \texttt{file\_name\_entry\_format\_count} (\HFTubyte) \\
1460 \addttindexx{file\_name\_entry\_format\_count}
1461 A count of the number of file entry format entries that
1462 occur in the following \addttindex{file\_name\_entry\_format} field. 
1463 If this field is zero, then the \addttindex{file\_names\_count} field 
1464 (see below) must also be zero.
1465
1466 \needlines{6}
1467 \item \texttt{file\_name\_entry\_format} (sequence of ULEB128 pairs) \\
1468 \addttindexx{file\_name\_entry\_format}
1469 A sequence of file entry format descriptions.
1470 Each description consists of a pair of ULEB128 values:
1471 \begin{itemize}
1472 \setlength{\itemsep}{0em}
1473 \item A content type code (see below)
1474 \item A form code using the attribute form codes
1475 \end{itemize}
1476
1477 \item \texttt{file\_names\_count} (ULEB128) \\
1478 \addttindexx{file\_names\_count}
1479 A count of the number of file name entries that occur
1480 in the following \addttindex{file\_names} field.
1481
1482 \needlines{4}
1483 \item \texttt{file\_names} (sequence of file name entries) \\
1484 \addttindexx{file\_names}
1485 A sequence of file names and optional related
1486 information. Each entry is encoded as described
1487 by the \addttindex{file\_name\_entry\_format} field.
1488   
1489 Entries in this sequence describe source files that
1490 contribute to the line number information for this
1491 compilation or is used in other contexts, such as in
1492 a declaration coordinate or a macro file inclusion.
1493  
1494 The first entry in the sequence is the primary source file 
1495 whose file name exactly matches that given in the 
1496 \DWATname{} attribute in the compilation unit 
1497 debugging information entry.
1498    
1499 The line number program references file names in this 
1500 sequence beginning with 0, and uses those numbers instead 
1501 of file names in the line number program that follows.
1502
1503 \textit{Prior to \DWARFVersionV, the current compilation 
1504 file name was not represented in the \addttindex{file\_names}
1505 field. In \DWARFVersionV, the current compilation file name 
1506 is explicitly present and has index 0. This is needed to support 
1507 the common practice of stripping all but the line number sections
1508 (\dotdebugline{} and \dotdebuglinestr) from an executable.}
1509
1510 \textit{Note that if a \dotdebuglinestr{} section is present, 
1511 both the compilation unit debugging information entry 
1512 and the line number header can
1513 share a single copy of the current file name string.}
1514
1515 \end{enumerate}
1516
1517 \needlines{8}
1518 \subsubsection{Standard Content Descriptions}
1519 \label{chap:standardcontentdescriptions}
1520 DWARF-defined content type codes are used to indicate
1521 the type of information that is represented in one
1522 component of an include directory or file name description.
1523 The following type codes are defined.
1524 \begin{enumerate}[1. ]
1525
1526 \item  \DWLNCTpathTARG \\
1527 The component is a null-terminated path name string.
1528 If the associated form code is \DWFORMstring{}, then the
1529 string occurs immediately in the containing \texttt{directories}
1530 or \addttindex{file\_names} field. If the form code is \DWFORMlinestrp{},
1531 then the string is included in the \dotdebuglinestr{} section
1532 and its offset occurs immediately in the containing
1533 \addttindex{directories} or \addttindex{file\_names} field.
1534
1535 In the 32-bit DWARF format, the representation of a
1536 \DWFORMlinestrp{} value is a 4-byte unsigned offset; in the
1537 64-bit DWARF format, it is an 8-byte unsigned offset (see
1538 Section \refersec{datarep:32bitand64bitdwarfformats}).
1539
1540 \textit{Note that this use of \DWFORMlinestrp{} is similar to
1541 \DWFORMstrp{} but refers to the \dotdebuglinestr{} section,
1542 not \dotdebugstr.}
1543    
1544 In a \dotdebuglinedwo{} section, the form \DWFORMstrx{} may
1545 also be used. This refers into the \dotdebugstroffsetsdwo{}
1546 section (and indirectly also the \dotdebugstrdwo{} section)
1547 because no \texttt{.debug\_line\_str\_offsets.dwo} or 
1548 \texttt{.debug\_line\_str.dwo} sections exist or are defined for 
1549 use in split objects. (The form \DWFORMstring{} may also be used, 
1550 but this precludes the benefits of string sharing.)
1551    
1552 \item \DWLNCTdirectoryindexTARG \\
1553 The unsigned directory index represents an entry in the
1554 directories field of the header. The index is 0 if
1555 the file was found in the current directory of the compilation
1556 (hence, the first directory in the directories field),
1557 1 if it was found in the second directory in the directories
1558 field, and so on.
1559
1560 This content code is always paired with one of \DWFORMdataone, 
1561 \DWFORMdatatwo{} or \DWFORMudata.
1562
1563 \textit{The optimal form for a producer to use (which results in the
1564 minimum size for the set of \addttindex{include\_index} fields) depends not only
1565 on the number of directories in the directories
1566 field, but potentially on the order in which those directories are
1567 listed and the number of times each is used in the \addttindex{file\_names} field.}
1568
1569 \needlines{4}
1570 \item \DWLNCTtimestampTARG \\
1571 \DWLNCTtimestampNAME{} indicates that the value is the implementation-defined 
1572 time of last modification of the file, or 0 if not available. 
1573 It is always paired with one of the forms
1574 \DWFORMudata, \DWFORMdatafour, \DWFORMdataeight{} or \DWFORMblock.
1575    
1576 \item  \DWLNCTsizeTARG \\
1577 \DWLNCTsizeNAME{} indicates that the value is the unsigned size of the
1578 file in bytes, or 0 if not available. It is paired with one of the
1579 forms \DWFORMudata, \DWFORMdataone, \DWFORMdatatwo, \DWFORMdatafour{}
1580 or \DWFORMdataeight.
1581  
1582 \item \DWLNCTMDfiveTARG \\
1583 \DWLNCTMDfiveNAME{} indicates that the value is a 16-byte \MDfive{} digest
1584 of the file contents. It is paired with form \DWFORMdatasixteen.
1585 \end{enumerate}
1586
1587 \textit{An example that uses this line number header format
1588 is found in Appendix \refersec{app:linenumberheaderexample}.}
1589
1590 \subsubsection{Vendor-defined Content Descriptions}
1591 \label{chap:vendordefinedcontentdescriptions}
1592 Vendor-defined content descriptions may be defined using content
1593 type codes in the range \DWLNCTlouserNAME{} to \DWLNCThiuserNAME{}. Each
1594 such code may be combined with one or more forms from the set:
1595 \DWFORMblock, \DWFORMblockone, \DWFORMblocktwo, \DWFORMblockfour,
1596 \DWFORMdataone, \DWFORMdatatwo, \DWFORMdatafour, \DWFORMdataeight,
1597 \DWFORMdatasixteen,
1598 \DWFORMflag, \DWFORMlinestrp, \DWFORMsdata, \DWFORMsecoffset,
1599 \DWFORMstring, \DWFORMstrp, \DWFORMstrx{}  and \DWFORMudata.
1600
1601 \bb
1602 \textit{If a consumer encounters a vendor-defined content type that
1603 it does not understand, it should skip the content data as though
1604 it were not present.}
1605 \eb
1606
1607 \needlines{6}
1608 \subsection{The Line Number Program}
1609 \label{chap:linenumberprogram}
1610 As stated before, the goal of a line number program is to build
1611 a matrix representing one compilation unit, which may have
1612 produced multiple sequences of target machine instructions.
1613 Within a sequence, addresses and 
1614 \addtoindex{operation pointer}s may only increase. 
1615 (Line numbers may decrease in cases of pipeline
1616 scheduling or other optimization.)
1617
1618 \needlines{4}
1619 \subsubsection{Special Opcodes} 
1620 \label{chap:specialopcodes}
1621 Each \HFTubyte{} special opcode has the following effect on the state machine:
1622
1623 \begin{enumerate}[1. ]
1624
1625 \item  Add a signed integer to the \texttt{line} register.
1626
1627 \item  Modify the \addtoindex{operation pointer} by incrementing the
1628 \texttt{address} and \addttindex{op\_index} registers as described below.
1629
1630 \item  Append a row to the matrix using the current values
1631 of the state machine registers.
1632
1633 \item  Set the \addttindex{basic\_block} register to \doublequote{false.} \addtoindexx{basic block}
1634 \item  Set the \addttindex{prologue\_end} register to \doublequote{false.}
1635 \item  Set the \addttindex{epilogue\_begin} register to \doublequote{false.}
1636 \item  Set the \addttindex{discriminator} register to 0.
1637
1638 \end{enumerate}
1639
1640 All of the special opcodes do those same seven things; they
1641 differ from one another only in what values they add to the
1642 \texttt{line}, \texttt{address} and \addttindex{op\_index} registers.
1643
1644
1645 \textit{Instead of assigning a fixed meaning to each special opcode,
1646 the line number program uses several parameters in the header
1647 to configure the instruction set. There are two reasons
1648 for this.  First, although the opcode space available for
1649 special opcodes ranges from 13 through 255, the lower
1650 bound may increase if one adds new standard opcodes. Thus, the
1651 \texttt{opcode\_base} field of the line number program header gives the
1652 value of the first special opcode. Second, the best choice of
1653 special\dash opcode meanings depends on the target architecture. For
1654 example, for a RISC machine where the compiler\dash generated code
1655 interleaves instructions from different lines to schedule
1656 the pipeline, it is important to be able to add a negative
1657 value to the \texttt{line} register to express the fact that a later
1658 instruction may have been emitted for an earlier source
1659 line. For a machine where pipeline scheduling never occurs,
1660 it is advantageous to trade away the ability to decrease
1661 the \texttt{line} register (a standard opcode provides an alternate
1662 way to decrease the line number) in return for the ability
1663 to add larger positive values to the \texttt{address} register. To
1664 permit this variety of strategies, the line number program
1665 header defines a 
1666 \addttindex{line\_base}
1667 field that specifies the minimum
1668 value which a special opcode can add to the line register
1669 and a 
1670 \addttindex{line\_range}
1671 field that defines the range of values it
1672 can add to the line register.}
1673
1674
1675 A special opcode value is chosen based on the amount that needs
1676 to be added to the \texttt{line}, \texttt{address} and \addttindex{op\_index} registers.
1677 The maximum line increment for a special opcode is the value
1678 of the 
1679 \addttindex{line\_base}
1680 field in the header, plus the value of the 
1681 \addttindex{line\_range} field, minus 1 (line base + 
1682 line range - 1). 
1683 If the desired line increment is greater than the maximum
1684 line increment, a standard opcode must be used instead of a
1685 special opcode. The \addtoindex{operation advance} represents the number
1686 of operations to skip when advancing the \addtoindex{operation pointer}.
1687
1688 \needlines{6}
1689 The special opcode is then calculated using the following formula:
1690 \begin{alltt}
1691   opcode = 
1692     (\textit{desired line increment} - \addttindex{line\_base}) +
1693       (\addttindex{line\_range} * \textit{operation advance}) + \addttindex{opcode\_base}
1694 \end{alltt}
1695 If the resulting opcode is greater than 255, a standard opcode
1696 must be used instead.
1697
1698 \textit{When \addttindex{maximum\_operations\_per\_instruction} is 1, 
1699 the operation advance is simply the address increment divided by the
1700 \addttindex{minimum\_instruction\_length}.}
1701
1702 \needlines{6}
1703 To decode a special opcode, subtract the \addttindex{opcode\_base} from
1704 the opcode itself to give the \textit{adjusted opcode}. 
1705 The \textit{operation advance} 
1706 is the result of the adjusted opcode divided by the
1707 \addttindex{line\_range}. The new \texttt{address} and 
1708 \addttindex{op\_index} values are given by
1709 \begin{alltt}
1710   \textit{adjusted opcode} = opcode \dash opcode\_base
1711   \textit{operation advance} = \textit{adjusted opcode} / line\_range
1712
1713   new address = address +
1714     \addttindex{minimum\_instruction\_length} *
1715       ((\addttindex{op\_index} + \addtoindex{operation advance}) / \addttindex{maximum\_operations\_per\_instruction})
1716
1717   new op\_index =
1718     (\addttindex{op\_index} + \addtoindex{operation advance}) \% \addttindex{maximum\_operations\_per\_instruction}
1719 \end{alltt}
1720
1721 \textit{When the \addttindex{maximum\_operations\_per\_instruction} 
1722 field is 1,
1723 \texttt{op\_index} is always 0 and these calculations simplify to 
1724 those given for addresses in \DWARFVersionIII{} and earlier.}
1725
1726 The amount to increment the line register is the 
1727 \addttindex{line\_base} plus
1728 the result of the 
1729 \textit{\addtoindex{adjusted opcode}} modulo the 
1730 \addttindex{line\_range}. That
1731 is,
1732
1733 \begin{alltt}
1734   line increment = \addttindex{line\_base} + (\textit{adjusted opcode} \% \addttindex{line\_range})
1735 \end{alltt}
1736
1737 \textit{See Appendix \refersec{app:linenumberspecialopcodeexample} for an example.}
1738
1739
1740 \needlines{6}
1741 \subsubsection{Standard Opcodes}
1742 \label{chap:standardopcodes}
1743
1744 The standard opcodes, their applicable operands and the
1745 actions performed by these opcodes are as follows:
1746
1747 \begin{enumerate}[1. ]
1748
1749 \item \textbf{\DWLNScopyTARG} \\
1750 The \DWLNScopyNAME{} 
1751 opcode takes no operands. It appends a row
1752 to the matrix using the current values of the state machine
1753 registers. Then it sets the \addttindex{discriminator} register to 0,
1754 and sets the \addttindex{basic\_block}, 
1755 \addttindex{prologue\_end} and 
1756 \addttindex{epilogue\_begin}
1757 registers to \doublequote{false.}
1758
1759 \needlines{5}
1760 \item \textbf{\DWLNSadvancepcTARG} \\
1761 The \DWLNSadvancepcNAME{} 
1762 opcode takes a single unsigned LEB128\addtoindexx{LEB128!unsigned}
1763 operand as the \addtoindex{operation advance} and modifies the \texttt{address}
1764 and \addttindex{op\_index} registers as specified in 
1765 Section \refersec{chap:specialopcodes}.
1766
1767 \item \textbf{\DWLNSadvancelineTARG} \\
1768 The \DWLNSadvancelineNAME{} 
1769 opcode takes a single signed LEB128\addtoindexx{LEB128!signed}
1770 operand and adds that value to the \texttt{line} register of the
1771 state machine.
1772
1773 \needlines{4}
1774 \item \textbf{\DWLNSsetfileTARG} \\ 
1775 The \DWLNSsetfileNAME{} opcode takes a single
1776 unsigned LEB128\addtoindexx{LEB128!unsigned} 
1777 operand and stores it in the \texttt{file} register
1778 of the state machine.
1779
1780 \needlines{4}
1781 \item \textbf{\DWLNSsetcolumnTARG} \\ 
1782 The \DWLNSsetcolumnNAME{} opcode takes a
1783 single unsigned LEB128\addtoindexx{LEB128!unsigned} operand 
1784 and stores it in the \texttt{column}
1785 register of the state machine.
1786
1787 \needlines{4}
1788 \item \textbf{\DWLNSnegatestmtTARG} \\
1789 The \DWLNSnegatestmtNAME{} opcode takes no
1790 operands. It sets the \addttindex{is\_stmt} register of the state machine
1791 to the logical negation of its current value.
1792
1793 \needlines{4}
1794 \item \textbf{\DWLNSsetbasicblockTARG} \\
1795 The \DWLNSsetbasicblockNAME{}
1796 opcode
1797 \addtoindexx{basic block}
1798 takes no operands. 
1799 It sets the \addttindex{basic\_block} register of the
1800 state machine to \doublequote{true.}
1801
1802 \item \textbf{\DWLNSconstaddpcTARG} \\
1803 The \DWLNSconstaddpcNAME{} opcode takes
1804 no operands. It advances the \texttt{address} and \addttindex{op\_index} registers
1805 by the increments corresponding to special opcode 255.
1806
1807 \textit{When the line number program needs to advance the \texttt{address}
1808 by a small amount, it can use a single special opcode,
1809 which occupies a single byte. When it needs to advance the
1810 \texttt{address} by up to twice the range of the last special opcode,
1811 it can use \DWLNSconstaddpc{} followed by a special opcode,
1812 for a total of two bytes. Only if it needs to advance the
1813 address by more than twice that range will it need to use
1814 both \DWLNSadvancepc{} and a special opcode, requiring three
1815 or more bytes.}
1816
1817 \item \textbf{\DWLNSfixedadvancepcTARG} \\ 
1818 The \DWLNSfixedadvancepcNAME{} opcode
1819 takes a single \HFTuhalf{} (unencoded) operand and adds it to the
1820 \texttt{address} register of the state machine and sets the \addttindex{op\_index}
1821 register to 0. This is the only standard opcode whose operand
1822 is \textbf{not} a variable length number. It also does 
1823 \textbf{not} multiply the
1824 operand by the \addttindex{minimum\_instruction\_length} 
1825 field of the header.
1826
1827 \textit{Some assemblers may not be able emit 
1828 \DWLNSadvancepc{} or special opcodes because they cannot encode 
1829 \addtoindex{LEB128} numbers or judge when
1830 the computation of a special opcode overflows and requires
1831 the use of \DWLNSadvancepc. Such assemblers, however, can
1832 use \DWLNSfixedadvancepc{} instead, sacrificing compression.}
1833
1834 \needlines{6}
1835 \item \textbf{\DWLNSsetprologueendTARG} \\
1836 The \DWLNSsetprologueendNAME{}
1837 opcode takes no operands. It sets the 
1838 \addttindex{prologue\_end} register
1839 to \doublequote{true.}
1840
1841 \textit{When a breakpoint is set on entry to a function, it is
1842 generally desirable for execution to be suspended, not on the
1843 very first instruction of the function, but rather at a point
1844 after the function's frame has been set up, after any language
1845 defined local declaration processing has been completed,
1846 and before execution of the first statement of the function
1847 begins. Debuggers generally cannot properly determine where
1848 this point is. This command allows a compiler to communicate
1849 the location(s) to use.}
1850
1851 \textit{In the case of optimized code, there may be more than one such
1852 location; for example, the code might test for a special case
1853 and make a fast exit prior to setting up the frame.}
1854
1855 \textit{Note that the function to which the 
1856 \addtoindex{prologue end} applies cannot
1857 be directly determined from the line number information alone;
1858 it must be determined in combination with the subroutine
1859 information entries of the compilation (including inlined
1860 subroutines).}
1861
1862
1863 \item \textbf{\DWLNSsetepiloguebeginTARG} \\
1864 The \DWLNSsetepiloguebeginNAME{} opcode takes no operands. It
1865 sets the \addttindex{epilogue\_begin} register to \doublequote{true.}
1866
1867 \textit{When a breakpoint is set on the exit of a function or execution
1868 steps over the last executable statement of a function, it is
1869 generally desirable to suspend execution after completion of
1870 the last statement but prior to tearing down the frame (so that
1871 local variables can still be examined). Debuggers generally
1872 cannot properly determine where this point is. This command
1873 allows a compiler to communicate the location(s) to use.}
1874
1875 \textit{Note that the function to which the 
1876 \addtoindex{epilogue end} applies cannot
1877 be directly determined from the line number information alone;
1878 it must be determined in combination with the subroutine
1879 information entries of the compilation (including inlined
1880 subroutines).}
1881
1882 \textit{In the case of a trivial function, both 
1883 \addtoindex{prologue end} and
1884 \addtoindex{epilogue begin} may occur at the same address.}
1885
1886 \item \textbf{\DWLNSsetisaTARG} \\
1887 The \DWLNSsetisaNAME{} opcode takes a single
1888 unsigned LEB128\addtoindexx{LEB128!unsigned} operand and stores that value in the 
1889 \addttindex{isa}
1890 register of the state machine.
1891 \end{enumerate}
1892
1893 \needlines{8}
1894 \subsubsection{Extended Opcodes}
1895 \label{chap:extendedopcodes}
1896
1897 The extended opcodes are as follows:
1898
1899 \begin{enumerate}[1. ]
1900
1901 \item \textbf{\DWLNEendsequenceTARG} \\
1902 The \DWLNEendsequenceNAME{} opcode takes no operands. It sets the
1903 \addttindex{end\_sequence}
1904 register of the state machine to \doublequote{true} and
1905 appends a row to the matrix using the current values of the
1906 state-machine registers. Then it resets the registers to the
1907 initial values specified above 
1908 (see Section \refersec{chap:statemachineregisters}). 
1909 Every line
1910 number program sequence must end with a \DWLNEendsequence{}
1911 instruction which creates a row whose address is that of the
1912 byte after the last target machine instruction of the sequence.
1913
1914 \needlines{5}
1915 \item \textbf{\DWLNEsetaddressTARG} \\
1916 The \DWLNEsetaddressNAME{} opcode takes a single relocatable
1917 address as an operand. The size of the operand is the size
1918 of an address on the target machine. It sets the \texttt{address}
1919 register to the value given by the relocatable address and
1920 sets the \addttindex{op\_index} register to 0.
1921
1922 \textit{All of the other line number program opcodes that
1923 affect the \texttt{address} register add a delta to it. This instruction
1924 stores a relocatable value into it instead.}
1925
1926 \item \textbf{\DWLNEsetdiscriminatorTARG} \\
1927 The \DWLNEsetdiscriminatorNAME{}
1928 opcode takes a single
1929 parameter, an unsigned LEB128\addtoindexx{LEB128!unsigned} 
1930 integer. It sets the
1931 \addttindex{discriminator} register to the new value.
1932
1933 \end{enumerate}
1934
1935 \textit{The DW\_LNE\_define\_file operation defined
1936 in earlier versions of DWARF is deprecated in \DWARFVersionV.}
1937 \addtoindexx{DW\_LNE\_define\_file  (deprecated)}
1938
1939 \textit{Appendix \refersec{app:linenumberprogramexample} 
1940 gives some sample line number programs.}
1941
1942 \section{Macro Information}
1943 \label{chap:macroinformation}
1944 \textit{Some languages, such as 
1945 \addtoindex{C} and 
1946 \addtoindex{C++}, provide a way to replace
1947 \addtoindexx{macro information}
1948 text in the source program with macros defined either in the
1949 source file itself, or in another file included by the source
1950 file.  Because these macros are not themselves defined in the
1951 target language, it is difficult to represent their definitions
1952 using the standard language constructs of DWARF. The debugging
1953 information therefore reflects the state of the source after
1954 the macro definition has been expanded, rather than as the
1955 programmer wrote it. The macro information table provides a way
1956 of preserving the original source in the debugging information.}
1957
1958 As described in 
1959 Section \refersec{chap:fullandpartialcompilationunitentries},
1960 the macro information for a
1961 given compilation unit is represented in the 
1962 \dotdebugmacro{}
1963 section of an object file. 
1964
1965 \needlines{4}
1966 \textit{The \dotdebugmacro{} section is new in 
1967 \DWARFVersionV, and supersedes the
1968 \dotdebugmacinfo{} section of earlier DWARF versions. 
1969 While \dotdebugmacro{} and \dotdebugmacinfo{}
1970 sections cannot both occur in the same compilation unit, both may be found in the 
1971 set of units that make up an executable or shared object file.}
1972
1973 \textit{The representation of debugging information in the \dotdebugmacinfo{} section is specified
1974 in earlier versions of the DWARF standard. Note that the \dotdebugmacinfo{} section does not contain 
1975 any headers and does not support sharing of strings or sharing of repeated macro sequences.}
1976
1977 The macro information for each compilation unit consists of one or
1978 more macro units.  Each macro unit starts with a header
1979 and is followed by a series of macro information entries or file
1980 inclusion entries.  Each entry consists of an opcode followed by
1981 zero or more operands. Each macro unit ends with an entry
1982 containing an opcode of 0.
1983
1984 In all macro information entries,
1985 the line number of the entry is encoded as an
1986 unsigned LEB128 integer.
1987
1988 \needlines{6}
1989 \subsection{Macro Information Header}
1990 The macro information header contains the following fields:
1991
1992 \begin{enumerate}[1. ]
1993 \item \texttt{version} (\HFTuhalf) \\
1994 A version number (see Section \refersec{datarep:macroinformation}).
1995 This number is specific to the macro information and is independent
1996 of the DWARF version number.
1997
1998 \item \texttt{flags} (\HFTubyte) \\
1999 The bits of the \texttt{flags} field are interpreted as a set
2000 of flags, some of which may indicate that additional fields follow.
2001
2002 \needlines{4}
2003 The following flags, beginning with the least significant bit, are defined:
2004 \begin{itemize}
2005 \item \HFNoffsetsizeflag \\
2006 If the \HFNoffsetsizeflag{} is zero, the header is for a 32-bit 
2007 DWARF format macro section and all offsets are 4 bytes long;
2008 if it is one, the header is for a 64-bit DWARF format macro section 
2009 and all offsets are 8 bytes long.
2010
2011 \item \addttindex{debug\_line\_offset\_flag} \\
2012 If the \addttindex{debug\_line\_offset\_flag} is one, 
2013 the \addttindex{debug\_line\_offset} field (see below) is present. 
2014 If zero, that field is omitted.
2015
2016 \item \addttindex{opcode\_operands\_table\_flag} \\
2017 If the \addttindex{opcode\_operands\_table\_flag} is one,
2018 the \addttindex{opcode\_operands\_table} field (see below) is present.
2019 If zero, that field is omitted.
2020
2021 \end{itemize}
2022 All other flags are reserved by DWARF.
2023
2024 \item \addttindex{debug\_line\_offset} \\
2025 An offset in the \dotdebugline{} section of the
2026 beginning of the line number information in the containing
2027 compilation, encoded as a 4-byte offset for a 32-bit DWARF 
2028 format macro section and an 8-byte offset for a 64-bit DWARF format
2029 macro section.  
2030
2031 \item \addttindex{opcode\_operands\_table} \\
2032 An \texttt{opcode\_operands\_table} describing the operands 
2033 of the macro information entry opcodes.
2034
2035 The macro information entries defined in this standard may, but need not, be
2036 described in the table, while other user-defined entry opcodes used in the section
2037 are described there.  Vendor extension entry opcodes are
2038 allocated in the range from \DWMACROlouser{} to \DWMACROhiuser. Other
2039 unassigned codes are reserved for future DWARF standards.
2040
2041 \needlines{4}
2042 The table starts with a 1-byte \texttt{count} of the defined opcodes, followed by
2043 an entry for each of those opcodes.  Each entry starts with a 1-byte unsigned
2044 opcode number, followed by unsigned LEB128\addtoindexx{ULEB128} encoded number of operands
2045 and for each operand there is a single unsigned byte describing the form in which
2046 the operand is encoded.  The allowed forms are: 
2047 \DWFORMblock, \DWFORMblockone, \DWFORMblocktwo, \DWFORMblockfour,
2048 \DWFORMdataone, \DWFORMdatatwo, \DWFORMdatafour, \DWFORMdataeight, 
2049 \DWFORMdatasixteen, \DWFORMsdata, \DWFORMudata, \DWFORMflag, \DWFORMsecoffset,
2050 \DWFORMstring, \DWFORMstrp{} and \DWFORMstrx.
2051 \end{enumerate}
2052
2053 \subsection{Macro Information Entries}
2054 \label{chap:macroinformationentries}
2055 All macro information entries within a \dotdebugmacro{}
2056 section for a given compilation unit appear in the same 
2057 order in which the directives were processed by the 
2058 compiler (after taking into account the effect of the
2059 macro import directives).
2060
2061 \textit{The source file in which a macro information entry occurs
2062 can be derived by interpreting the sequence of entries from the
2063 beginning of the \dotdebugmacro{} section. \DWMACROstartfile{} and 
2064 \DWMACROendfile{} indicate changes in the containing file.} 
2065
2066 \subsubsection{Define and Undefine Entries}
2067 \label{chap:defineandundefineentries}
2068 The define and undefine macro entries have multiple forms that
2069 use different representations of their two operands.
2070
2071 While described in pairs below, the forms of define 
2072 and undefine entries may be freely intermixed.
2073
2074 \begin{enumerate}[1. ]
2075
2076 \itembfnl{\DWMACROdefineTARG{}, \DWMACROundefTARG{}}
2077 A \DWMACROdefineNAME{} or \DWMACROundefNAME{} entry has two
2078 operands. The first operand encodes the source line number 
2079 of the \texttt{\#define} or \texttt{\#undef} macro directive.
2080 The second operand is a null-terminated character
2081 string for the macro being defined or undefined. 
2082
2083 The contents of the operands are described below (see Sections 
2084 \ref{chap:macrodefinestring} and \referfol{chap:macroundefinestring}).
2085
2086 \itembfnl{\DWMACROdefinestrpTARG{}, \DWMACROundefstrpTARG{}}
2087 A \DWMACROdefinestrpNAME{} or \DWMACROundefstrpNAME{} 
2088 entry has two operands.  The first operand encodes the source line number
2089 of the \texttt{\#define} or \texttt{\#undef} macro directive. 
2090 The second operand consists of an offset into a string table contained in
2091 the \dotdebugstr{} section of the object file.  The size of the operand is
2092 given in the header \HFNoffsetsizeflag{} field. 
2093
2094 The contents of the operands are described below (see Sections 
2095 \ref{chap:macrodefinestring} and \referfol{chap:macroundefinestring}).
2096
2097 \itembfnl{\DWMACROdefinestrxTARG{}, \DWMACROundefstrxTARG{}}
2098 A \DWMACROdefinestrxNAME{} or \DWMACROundefstrxNAME{} entry 
2099 has two operands.  The first operand encodes the line number 
2100 of the \texttt{\#define} or \texttt{\#undef} macro directive.
2101 The second operand identifies a string; it is represented using an 
2102 unsigned LEB128\addtoindexx{ULEB128} encoded value,
2103 which is interpreted as a zero-based index into an array of offsets in the
2104 \dotdebugstroffsets{} section. 
2105
2106 The contents of the operands are described below (see Sections 
2107 \ref{chap:macrodefinestring} and \referfol{chap:macroundefinestring}).
2108
2109 \needlines{6}
2110 \itembfnl{\DWMACROdefinesupTARG{}, \DWMACROundefsupTARG{}}
2111 A \DWMACROdefinesupNAME{} or \DWMACROundefsupNAME{} entry 
2112 has two operands.  The first operand encodes the line number 
2113 of the \texttt{\#define} or \texttt{\#undef} macro directive.
2114 The second operand identifies a string; it is represented as
2115 an offset into a string table contained in the \dotdebugstr{} 
2116 section of the \addtoindex{supplementary object file}.  
2117 The size of the operand depends on the macro section header 
2118 \HFNoffsetsizeflag{} field.  
2119
2120 The contents of the operands are described below (see Sections 
2121 \ref{chap:macrodefinestring} and \referfol{chap:macroundefinestring}).
2122
2123 \end{enumerate}
2124
2125
2126 \subsubsection{Macro Define String}
2127 \label{chap:macrodefinestring}
2128 In the case of a 
2129 \DWMACROdefine{},
2130 \DWMACROdefinestrp{},
2131 \DWMACROdefinestrx{} or
2132 \DWMACROdefinesup{}
2133 entry, the value of the
2134 second operand is the name of the macro symbol that is defined
2135 at the indicated source line, followed immediately by the 
2136 \addtoindex{macro formal parameter list}
2137 including the surrounding parentheses (in
2138 the case of a function-like macro) followed by the definition
2139 string for the macro. If there is no formal parameter list,
2140 then the name of the defined macro is followed immediately by
2141 its definition string.
2142
2143 In the case of a function-like macro definition, no whitespace
2144 characters appear between the name of the defined
2145 macro and the following left parenthesis. Formal parameters
2146 are separated by a comma without any whitespace.
2147 Exactly one space
2148 character separates the right parenthesis that terminates
2149 the formal parameter list and the following definition string.
2150
2151 In the case of a \doublequote{normal} (that is, non-function-like) macro
2152 definition, exactly one space character separates the
2153 name of the defined macro from the following definition text.
2154
2155 \subsubsection{Macro Undefine String}
2156 \label{chap:macroundefinestring}
2157 In the case of a 
2158 \DWMACROundef{},
2159 \DWMACROundefstrp{},
2160 \DWMACROundefstrx{} or
2161 \DWMACROundefsup{}
2162 entry, the value of the second string is the name of the pre-processor
2163 symbol that is undefined at the indicated source line.
2164
2165 \subsubsection{Entries for Command Line Options}
2166 \label{chap:entriesforcommandlineoptions}
2167 \DWMACROdefineINDX{}\DWMACROdefinestrpINDX{}\DWMACROdefinestrxINDX
2168 \DWMACROundefINDX{}\DWMACROundefstrpINDX{}\DWMACROundefstrxINDX
2169 A DWARF producer
2170 generates a define or undefine entry for
2171 each pre-processor symbol which is defined or undefined by
2172 some means other than such a directive
2173 within the compiled source text. In particular, pre-processor
2174 symbol definitions and undefinitions which occur as a
2175 result of command line options (when invoking the compiler)
2176 are represented by their own define and
2177 undefine entries.
2178
2179 All such define and undefine entries representing compilation 
2180 options appear before the first \DWMACROstartfile{} 
2181 entry for that compilation unit
2182 (see Section \referfol{chap:fileinclusionentries})
2183 and encode the value 0 in their line number operands.
2184
2185 \subsection{File Inclusion Entries}
2186 \label{chap:fileinclusionentries}
2187
2188 \subsubsection{Source Include Directives}
2189 \label{chap:sourceincludedirectives}
2190
2191 The following directives describe a source
2192 file inclusion directive (\texttt{\#include} in
2193 \addtoindex{C}/\addtoindex{C++}) and the
2194 ending of an included file.
2195
2196 \begin{enumerate}[1. ]
2197
2198 \itembfnl{\DWMACROstartfileTARG{}}
2199 A \DWMACROstartfileNAME{} entry has two operands. The
2200 first operand encodes the line number of the source line on
2201 which the \texttt{\#include} macro directive occurs. 
2202 The second operand encodes a source file name index. 
2203
2204 The source file name index is the file number in the 
2205 line number information table for the compilation unit.
2206
2207 If a \DWMACROstartfileNAME{} entry is present, the header
2208 contains a reference to the \dotdebugline{} section of 
2209 the compilation.
2210
2211 \itembfnl{\DWMACROendfileTARG{}}
2212 A \DWMACROendfileNAME{} entry has no operands. The presence of
2213 the entry marks the end of the current source file inclusion.
2214
2215 \end{enumerate}
2216
2217 \needlines{4}
2218 When providing macro information in an object file,
2219 a producer generates \DWMACROstartfile{} and
2220 \DWMACROendfile{} entries for the source file submitted to
2221 the compiler for compilation. This \DWMACROstartfile{} entry
2222 has the value 0 in its line number operand and references
2223 the file entry in the line number information table for the
2224 primary source file.
2225
2226 \subsubsection{Importation of Macro Units}
2227 \label{chap:importationofmacrounits}
2228 The import entries make it possible to replicate macro units.
2229 The first form supports replication within the current compilation
2230 and the second form supports replication across separate 
2231 executable or shared object files.
2232
2233 \textit{Import entries do not reflect the source program
2234 and, in fact, are not necessary at all. However, they do
2235 provide a mechanism that can be used to reduce redundancy
2236 in the macro information and thereby to save space.}
2237
2238 \begin{enumerate}[1. ]
2239
2240 \itembfnl{\DWMACROimportTARG{}}
2241 A \DWMACROimportNAME{} entry has one operand, an offset into
2242 another part of the \dotdebugmacro{} section that is
2243 the beginning of a target macro unit. The size of the operand
2244 depends on the header \HFNoffsetsizeflag{} field.  The
2245 \DWMACROimportNAME{} entry instructs the consumer to
2246 replicate the sequence of entries following the target macro 
2247 header which begins at the given 
2248 \dotdebugmacro{} offset, up to, but excluding,
2249 the terminating entry with opcode \texttt{0},
2250 as though it occurs in place of the import operation.
2251
2252 \itembfnl{\DWMACROimportsupTARG}
2253 A \DWMACROimportsupNAME{} entry has one operand, an 
2254 offset from the start of the \dotdebugmacro{} section in the 
2255 \addtoindex{supplementary object file}.  
2256 The size of the operand depends on the section header 
2257 \HFNoffsetsizeflag{} field. 
2258 Apart from the different location in which to find the macro unit,
2259 this entry type is equivalent to \DWMACROimport. 
2260
2261 \textit{This entry type is aimed at sharing duplicate 
2262 macro units between \dotdebugmacro{}
2263 sections from different executable or shared object files.}  
2264
2265 \needlines{4}
2266 From within the \dotdebugmacro{} section of the 
2267 \addtoindex{supplementary object file}, \DWMACROdefinestrp{} 
2268 and \DWMACROundefstrp{} entries refer to the
2269 \dotdebugstr{} section of that same supplementary file;
2270 similarly, \DWMACROimport{} entries refer to the 
2271 \dotdebugmacro{} section of that same supplementary file.
2272
2273 \end{enumerate}
2274
2275
2276 \needlines{6}
2277 \section{Call Frame Information}
2278 \label{chap:callframeinformation}
2279 \addtoindexx{unwind|see{virtual unwind}}\addtoindexx{virtual unwind}
2280
2281 \textit{Debuggers often need to be able to view and modify the 
2282 state of any subroutine activation that is
2283 \addtoindexx{activation of call frame}
2284 on the call stack. An activation consists of:}
2285
2286 \begin{itemize}
2287 \item \textit{A code location that is within the
2288 subroutine. This location is either the place where the program
2289 stopped when the debugger got control (for example, a breakpoint), or
2290 is a place where a subroutine made a call or was interrupted
2291 by an asynchronous event (for example, a signal).}
2292
2293 \item \textit{An area of memory that is allocated on a stack called a
2294 \doublequote{call frame.} The call frame is identified by an address
2295 on the stack. We refer to this address as the Canonical
2296 Frame Address or CFA. Typically, the CFA is defined to be the
2297 value of the stack pointer at the call site in the previous
2298 frame (which may be different from its value on entry to the
2299 current frame).}
2300
2301 \item \textit{A set of registers that are in use by the subroutine
2302 at the code location.}
2303
2304 \end{itemize}
2305
2306 \textit{Typically, a set of registers are designated to be preserved
2307 across a call. If a callee wishes to use such a register, it
2308 saves the value that the register had at entry time in its call
2309 frame and restores it on exit. The code that allocates space
2310 on the call frame stack and performs the save operation is
2311 called the subroutine\textquoteright{s} \addtoindex{prologue}, and the code that performs
2312 the restore operation and deallocates the frame is called its
2313 \addtoindex{epilogue}. Typically, the 
2314 \addtoindex{prologue} code is physically at the
2315 beginning of a subroutine and the 
2316 \addtoindex{epilogue} code is at the end.}
2317
2318 \textit{To be able to view or modify an activation that is not
2319 on the top of the call frame stack, the debugger must
2320 virtually unwind the stack of activations until
2321 it finds the activation of interest.  A debugger virtually unwinds
2322 a stack in steps. Starting with the current activation it
2323 virtually restores any registers that were preserved by the
2324 current activation and computes the predecessor\textquoteright{s} CFA and
2325 code location. This has the logical effect of returning from
2326 the current subroutine to its predecessor. We say that the
2327 debugger virtually unwinds the stack because the actual state
2328 of the target process is unchanged.}
2329
2330 \needlines{4}
2331 \textit{The virtual unwind 
2332 operation needs to know where registers are
2333 saved and how to compute the predecessor\textquoteright{s} CFA and code
2334 location. When considering an architecture-independent way
2335 of encoding this information one has to consider a number of
2336 special things:}
2337
2338 \begin{itemize} % bullet list
2339
2340 \item \textit{Prologue 
2341 \addtoindexx{prologue}
2342 and 
2343 \addtoindex{epilogue} code is not always in 
2344 distinct \nolink{blocks}
2345 at the beginning and end of a subroutine. It is common
2346 to duplicate the \addtoindex{epilogue} code 
2347 at the site of each return
2348 from the code. Sometimes a compiler breaks up the register
2349 save/unsave operations and moves them into the body of the
2350 subroutine to just where they are needed.}
2351
2352
2353 \item \textit{Compilers use different ways to manage the call
2354 frame. Sometimes they use a frame pointer register, sometimes
2355 not.}
2356
2357 \item \textit{The algorithm to compute CFA changes as you progress through
2358 the \addtoindex{prologue} 
2359 and \addtoindex{epilogue code}. 
2360 (By definition, the CFA value
2361 does not change.)}
2362
2363 \item \textit{Some subroutines have no call frame.}
2364
2365 \item \textit{Sometimes a register is saved in another register that by
2366 convention does not need to be saved.}
2367
2368 \item \textit{Some architectures have special instructions that perform
2369 some or all of the register management in one instruction,
2370 leaving special information on the stack that indicates how
2371 registers are saved.}
2372
2373 \item \textit{Some architectures treat return address values specially. For
2374 example, in one architecture, the call instruction guarantees
2375 that the low order two bits will be zero and the return
2376 instruction ignores those bits. This leaves two bits of
2377 storage that are available to other uses that must be treated
2378 specially.}
2379
2380 \end{itemize}
2381
2382
2383 \needlines{6}
2384 \subsection{Structure of Call Frame Information}
2385 \label{chap:structureofcallframeinformation}
2386
2387 DWARF supports virtual unwinding by defining an architecture
2388 independent basis for recording how subprograms save and restore
2389 registers during their lifetimes. This basis must be augmented
2390 on some machines with specific information that is defined by
2391 an architecture specific ABI authoring committee, a hardware
2392 vendor, or a compiler producer. The body defining a specific
2393 augmentation is referred to below as the \doublequote{augmenter.}
2394
2395 \needlines{8}
2396 Abstractly, this mechanism describes a very large table that
2397 has the following structure:
2398
2399 \begin{verbatim}
2400         LOC CFA R0 R1 ... RN
2401         L0
2402         L1
2403         ...
2404         LN
2405 \end{verbatim}
2406
2407
2408 The first column indicates an address for every location
2409 that contains code in a program. (In shared object files, this
2410 is an object-relative offset.) The remaining columns contain
2411 virtual unwinding rules that are associated with the indicated
2412 location.
2413
2414 The CFA column defines the rule which computes the Canonical
2415 Frame Address value; it may be either a register and a signed
2416 offset that are added together, or a DWARF expression that
2417 is evaluated.
2418
2419 \needlines{4}
2420 The remaining columns are labelled by register number. This
2421 includes some registers that have special designation on
2422 some architectures such as the PC and the stack pointer
2423 register. (The actual mapping of registers for a particular
2424 architecture is defined by the augmenter.) The register columns
2425 contain rules that describe whether a given register has been
2426 saved and the rule to find the value for the register in the
2427 previous frame.
2428
2429 \needlines{6}
2430 The register rules are:
2431
2432 \begin{longtable}{lP{9cm}}
2433 undefined 
2434 &A register that has this rule has no recoverable value in the previous frame.
2435 (By convention, it is not preserved by a callee.) \\
2436
2437 same value
2438 &This register has not been modified from the previous frame. (By convention,
2439 it is preserved by the callee, but the callee has not modified it.) \\
2440
2441 offset(N)
2442 &The previous value of this register is saved at the address CFA+N where CFA
2443 is the current CFA value and N is a signed offset.\\
2444
2445 val\_offset(N)
2446 &The previous value of this register is the value CFA+N where CFA is the
2447 current CFA value and N is a signed offset.\\
2448
2449 register(R)
2450 &The previous value of this register is stored 
2451 in another register numbered R.\\
2452
2453 expression(E)
2454 &The previous value of this register is located at the address produced by
2455 executing the DWARF expression E (see Section \refersec{chap:dwarfexpressions}).\\
2456
2457 val\_expression(E) 
2458 &The previous value of this register is the value produced by executing the
2459 DWARF expression E (see Section \refersec{chap:dwarfexpressions}).\\
2460
2461 architectural
2462 &The rule is defined externally to this specification by the augmenter.\\
2463
2464 \end{longtable}
2465
2466 \textit{This table would be extremely large if actually constructed
2467 as described. Most of the entries at any point in the table
2468 are identical to the ones above them. The whole table can be
2469 represented quite compactly by recording just the differences
2470 starting at the beginning address of each subroutine in
2471 the program.}
2472
2473 \needlines{4}
2474 The virtual unwind information is encoded in a self-contained
2475 section called 
2476 \dotdebugframe{}.  Entries in a 
2477 \dotdebugframe{} section
2478 are aligned on a multiple of the address size relative to
2479 the start of the section and come in two forms: a Common
2480 \addtoindexx{common information entry}
2481 Information Entry (CIE) and a 
2482 \addtoindexx{frame description entry}
2483 Frame Description Entry (FDE).
2484
2485 \textit{If the range of code addresses for a function is not
2486 contiguous, there may be multiple CIEs and FDEs corresponding
2487 to the parts of that function.}
2488
2489 \needlines{6}
2490 A Common Information Entry holds information that is shared
2491 among many Frame Description Entries. There is at least one
2492 CIE in every non-empty \dotdebugframe{} section. A CIE contains
2493 the following fields, in order:
2494 \begin{enumerate}[1. ]
2495 \item \HFNlength{} (\livelink{datarep:initiallengthvalues}{initial length})  \\
2496 A constant that gives the number of bytes of the CIE structure,
2497 not including the length field itself 
2498 (see Section \refersec{datarep:initiallengthvalues}). 
2499 The
2500 size of the \texttt{length} field plus the value of \texttt{length} must be an
2501 integral multiple of the address size.
2502
2503 \item  \HFNCIEid{} (4 or 8 bytes, see Section \refersec{datarep:32bitand64bitdwarfformats}) \\
2504 A constant that is used to distinguish CIEs from FDEs.
2505
2506 \item  \HFNversion{} (\HFTubyte) \\
2507 A version number\addtoindexx{version number!call frame information} 
2508 (see Section \refersec{datarep:callframeinformation}). 
2509 This number is specific to the call frame information
2510 and is independent of the DWARF version number.
2511
2512 \needlines{8}
2513 \item  \HFNaugmentation{} (\HFTaugstring) \\
2514 A null-terminated UTF\dash 8 string that identifies the augmentation
2515 to this CIE or to the FDEs that use it. If a reader encounters
2516 an augmentation string that is unexpected, then only the
2517 following fields can be read:
2518
2519
2520 \begin{itemize}
2521
2522 \item CIE: \HFNlength, \HFNCIEid, \HFNversion, \HFNaugmentation
2523
2524 \item FDE: \HFNlength, \HFNCIEpointer, \HFNinitiallocation, \HFNaddressrange
2525
2526 \end{itemize}
2527 If there is no augmentation, this value is a zero byte.
2528
2529 \needlines{5}
2530 \textit{The augmentation string allows users to indicate that there
2531 is additional target\dash specific information in the CIE or FDE
2532 which is needed to virtually 
2533 unwind a stack frame. For example, this
2534 might be information about dynamically allocated data which
2535 needs to be freed on exit from the routine.}
2536
2537 \textit{Because the \dotdebugframe{} section is useful independently of
2538 any \dotdebuginfo{} section, the augmentation string always uses
2539 UTF\dash 8 encoding.}
2540
2541 \needlines{4}
2542 \item \HFNaddresssize{} (\HFTubyte) \\
2543 The size of a target address in this CIE and any FDEs that
2544 use it, in bytes. If a compilation unit exists for this frame,
2545 its address size must match the address size here.
2546
2547 \item \HFNsegmentselectorsize{} (\HFTubyte) \\
2548 The size of a segment selector in this CIE and any FDEs that
2549 use it, in bytes.
2550
2551 \item \HFNcodealignmentfactor{} (unsigned LEB128) 
2552 \addtoindexx{LEB128!unsigned}\addtoindexx{unsigned LEB128|see{LEB128, unsigned}}
2553 \addtoindexx{code alignment factor} \\
2554
2555 \addtoindexx{\textless caf\textgreater|see{code alignment factor}}
2556 constant that is factored out of all advance location
2557 instructions (see 
2558 Section \refersec{chap:rowcreationinstructions}).
2559 The resulting value is  
2560 \mbox{\textit{(operand} * \HFNcodealignmentfactor)}.
2561
2562 \item  \HFNdataalignmentfactor{} (signed LEB128)
2563 \addtoindexx{LEB128!signed}\addtoindexx{signed LEB128|see{LEB128, signed}} \\
2564 \addtoindexx{data alignment factor}
2565
2566 \addtoindexx{\textless daf\textgreater|see{data alignment factor}}
2567 constant that is factored out of certain offset instructions
2568 (see Sections \refersec{chap:cfadefinitioninstructions} and 
2569 \refersec{chap:registerruleinstructions}).
2570 The resulting value is  \textit{(operand} *
2571 \HFNdataalignmentfactor).
2572
2573 \item  \HFNreturnaddressregister{} (unsigned LEB128)\addtoindexx{LEB128!unsigned} \\
2574 An unsigned LEB128 constant that indicates which column in the
2575 rule table represents the return address of the function. Note
2576 that this column might not correspond to an actual machine
2577 register.
2578
2579 \needlines{8}
2580 \item \HFNinitialinstructions{} (array of \HFTubyte) \\
2581 A sequence of rules that are interpreted to create the initial
2582 setting of each column in the table.  
2583
2584 The default rule for
2585 all columns before interpretation of the initial instructions
2586 is the undefined rule. However, an ABI authoring body or a
2587 compilation system authoring body may specify an alternate
2588 default value for any or all columns.
2589
2590 \item \HFNpadding{} (array of \HFTubyte) \\
2591 Enough \DWCFAnop{} instructions to make the size of this entry
2592 match the length value above.
2593 \end{enumerate}
2594
2595 \needlines{5}
2596 An FDE contains the following fields, in order:
2597 \begin{enumerate}[1. ]
2598 \item \HFNlength{} (\livelink{datarep:initiallengthvalues}{initial length})  \\
2599 A constant that gives the number of bytes of the header and
2600 instruction stream for this function, not including the length
2601 field itself 
2602 (see Section \refersec{datarep:initiallengthvalues}). 
2603 The size of the \texttt{length} field
2604 plus the value of length must be an integral multiple of the
2605 address size.
2606
2607 \item \HFNCIEpointer{} (4 or 8 bytes, see Section \refersec{datarep:32bitand64bitdwarfformats}) \\
2608 A constant 
2609 \addtoindexx{section offset!in FDE header}
2610 offset into the \dotdebugframe{}
2611 section that denotes
2612 the CIE that is associated with this FDE.
2613
2614 \needlines{4}
2615 \item  \HFNinitiallocation{} (segment selector and target address) \\
2616 The address of the first location associated with this table
2617 entry. 
2618 If the \HFNsegmentselectorsize{} field of this FDE's CIE is non-zero,
2619 the initial location is preceded by a segment selector of
2620 the given length.
2621
2622 \needlines{4}
2623 \item  \HFNaddressrange{} (target address) \\
2624 The number 
2625 \addtoindexx{target address}
2626 of bytes of program instructions described by this entry.
2627
2628 \item \HFNinstructions{} (array of \HFTubyte) \\
2629 A sequence of table defining instructions that are described 
2630 in Section \refersec{chap:callframeinstructions}.
2631
2632 \needlines{4}
2633 \item \HFNpadding{} (array of \HFTubyte) \\
2634 Enough \DWCFAnop{} instructions 
2635 to make the size of this entry match the \HFNlength{} value above.
2636 \end{enumerate}
2637
2638 \needlines{8}
2639 \subsection{Call Frame Instructions}
2640 \label{chap:callframeinstructions}
2641
2642 Each call frame instruction is defined to take 0 or more
2643 operands. Some of the operands may be encoded as part of the
2644 opcode 
2645 (see Section \refersec{datarep:callframeinformation}). 
2646 The instructions are defined in
2647 the following sections.
2648
2649 \needlines{8}
2650 Some call frame instructions have operands that are encoded
2651 as DWARF expressions 
2652 (see Section \refersec{chap:generaloperations}). 
2653 The following DWARF
2654 operators cannot be used in such operands:
2655
2656
2657 \begin{itemize}
2658 \item
2659 \DWOPaddrx, \DWOPcalltwo, \DWOPcallfour{}, \DWOPcallref, 
2660 \DWOPconsttype, \DWOPconstx, \DWOPconvert, \DWOPdereftype, 
2661 \DWOPregvaltype{} and \DWOPreinterpret{}
2662 operators are 
2663 not allowed in an operand of these instructions because
2664 the call frame information must not depend on other
2665 debug sections.
2666
2667 \needlines{5}
2668 \item \DWOPpushobjectaddress{} is not meaningful in an operand
2669 of these instructions because there is no object context to
2670 provide a value to push.
2671
2672 \item \DWOPcallframecfa{} is not meaningful in an operand of
2673 these instructions because its use would be circular.
2674 \end{itemize}
2675
2676 \textit{Call frame instructions to which these restrictions apply
2677 include \DWCFAdefcfaexpression, \DWCFAexpression{}
2678 and \DWCFAvalexpression.}
2679
2680 \needlines{8}
2681 \subsubsection{Row Creation Instructions}
2682 \label{chap:rowcreationinstructions}
2683 \begin{enumerate}[1. ]
2684
2685 \item \textbf{\DWCFAsetlocTARG} \\
2686 The \DWCFAsetlocNAME{} instruction 
2687 takes a single operand that
2688 represents a target address. The required action is to create a
2689 new table row using the specified address as the location. All
2690 other values in the new row are initially identical to the
2691 current row. The new location value is always greater than
2692 the current one. 
2693 If the \HFNsegmentselectorsize{} field of this FDE's 
2694 \addtoindex{CIE}
2695 is non-zero, the initial location is preceded by a segment
2696 selector of the given length.
2697
2698 \needlines{4}
2699 \item \textbf{\DWCFAadvancelocTARG} \\
2700 The \DWCFAadvancelocNAME{} instruction takes a single operand (encoded
2701 with the opcode) that represents a constant delta. The required
2702 action is to create a new table row with a location value that
2703 is computed by taking the current entry\textquoteright s location value
2704 and adding the value of 
2705 \textit{delta} * \addttindex{code\_alignment\_factor}. 
2706 All other values in the new row are initially identical to the
2707 current row
2708
2709 \needlines{6}
2710 \item \textbf{\DWCFAadvanceloconeTARG{}} \\
2711 The \DWCFAadvanceloconeNAME{} instruction takes a single \HFTubyte{}
2712 operand that represents a constant delta. This instruction
2713 is identical to \DWCFAadvanceloc{} except for the encoding
2714 and size of the delta operand.
2715
2716 \item \textbf{\DWCFAadvanceloctwoTARG} \\
2717 The \DWCFAadvanceloctwoNAME{} instruction takes a single \HFTuhalf{}
2718 operand that represents a constant delta. This instruction
2719 is identical to \DWCFAadvanceloc{} except for the encoding
2720 and size of the delta operand.
2721
2722 \item \textbf{\DWCFAadvancelocfourTARG} \\
2723 The \DWCFAadvancelocfourNAME{} instruction takes a single \HFTuword{}
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 \end{enumerate}
2729
2730 \subsubsection{CFA Definition Instructions}
2731 \label{chap:cfadefinitioninstructions}
2732 \begin{enumerate}[1. ]
2733
2734 \item \textbf{\DWCFAdefcfaTARG} \\
2735 The \DWCFAdefcfaNAME{}
2736 instruction takes two unsigned LEB128\addtoindexx{LEB128!unsigned}
2737 operands representing a register number and a (non-factored)
2738 offset. The required action is to define the current CFA rule
2739 to use the provided register and offset.
2740
2741 \needlines{6}
2742 \item \textbf{\DWCFAdefcfasfTARG} \\
2743 The \DWCFAdefcfasfNAME{} instruction takes two operands:
2744 an unsigned LEB128 value\addtoindexx{LEB128!unsigned}
2745 representing a register number and a
2746 signed LEB128\addtoindexx{LEB128!signed} factored offset. This instruction is identical
2747 to \DWCFAdefcfa{} except that the second operand is signed
2748 and factored. The resulting offset is \textit{factored\_offset} *
2749 \addttindex{data\_alignment\_factor}.
2750
2751
2752 \item \textbf{\DWCFAdefcfaregisterTARG} \\
2753 The \DWCFAdefcfaregisterNAME{} 
2754 instruction takes a single
2755 unsigned LEB128\addtoindexx{LEB128!unsigned} operand representing a register number. The
2756 required action is to define the current CFA rule to use
2757 the provided register (but to keep the old offset). This
2758 operation is valid only if the current CFA rule is defined
2759 to use a register and offset.
2760
2761
2762 \needlines{5}
2763 \item \textbf{\DWCFAdefcfaoffsetTARG} \\
2764 The \DWCFAdefcfaoffsetNAME{} instruction takes a single
2765 unsigned LEB128\addtoindexx{LEB128!unsigned} operand representing a (non-factored)
2766 offset. The required action is to define the current CFA rule
2767 to use the provided offset (but to keep the old register). This
2768 operation is valid only if the current CFA rule is defined
2769 to use a register and offset.
2770
2771 \needlines{6}
2772 \item \textbf{\DWCFAdefcfaoffsetsfTARG} \\
2773 The \DWCFAdefcfaoffsetsfNAME{} instruction takes a signed
2774 LEB128\addtoindexx{LEB128!signed} operand representing a factored offset. This instruction
2775 is identical to \DWCFAdefcfaoffset{} except that the
2776 operand is signed and factored. The resulting offset is
2777 \textit{factored\_offset} * \addttindex{data\_alignment\_factor}.
2778 This operation
2779 is valid only if the current CFA rule is defined to use a
2780 register and offset.
2781
2782 \item \textbf{\DWCFAdefcfaexpressionTARG} \\
2783 The \DWCFAdefcfaexpressionNAME{} instruction takes a 
2784 \addtoindexx{exprloc class}
2785 single operand encoded as a 
2786 \DWFORMexprloc{} value representing a
2787 DWARF expression. The required action is to establish that
2788 expression as the means by which the current CFA is computed.
2789
2790 \textit{See Section \refersec{chap:callframeinstructions} 
2791 regarding restrictions on the DWARF
2792 expression operators that can be used.}
2793
2794 \end{enumerate}
2795
2796 \needlines{8}
2797 \subsubsection{Register Rule Instructions}
2798 \label{chap:registerruleinstructions}
2799 \begin{enumerate}[1. ]
2800
2801 \item \textbf{\DWCFAundefinedTARG} \\
2802 The \DWCFAundefinedNAME{} instruction takes a single unsigned
2803 LEB128\addtoindexx{LEB128!unsigned} operand that represents a register number. The required
2804 action is to set the rule for the specified register to
2805 \doublequote{undefined.}
2806
2807 \item \textbf{\DWCFAsamevalueTARG} \\
2808 The \DWCFAsamevalueNAME{} instruction takes a single unsigned
2809 LEB128 operand\addtoindexx{LEB128!unsigned} that represents a register number. The required
2810 action is to set the rule for the specified register to
2811 \doublequote{same value.}
2812
2813 \item \textbf{\DWCFAoffsetTARG} \\
2814 The \DWCFAoffsetNAME{} instruction takes two operands: a register
2815 number (encoded with the opcode) and an unsigned LEB128\addtoindexx{LEB128!unsigned}
2816 constant representing a factored offset. The required action
2817 is to change the rule for the register indicated by the
2818 register number to be an offset(N) rule where the value of
2819 N is 
2820 \textit{factored offset} * \addttindex{data\_alignment\_factor}.
2821
2822 \needlines{4}
2823 \item \textbf{\DWCFAoffsetextendedTARG} \\
2824 The \DWCFAoffsetextendedNAME{} 
2825 instruction takes two unsigned LEB128\addtoindexx{LEB128!unsigned} 
2826 operands representing a register number and a factored
2827 offset. This instruction is identical to
2828 \DWCFAoffset{} 
2829 except for the encoding and size of the register operand.
2830
2831 \needlines{6}
2832 \item \textbf{\DWCFAoffsetextendedsfTARG} \\
2833 The \DWCFAoffsetextendedsfNAME{} 
2834 instruction takes two operands:
2835 an unsigned LEB128\addtoindexx{LEB128!unsigned} 
2836 value representing a register number and a
2837 signed LEB128 factored offset. This instruction is identical
2838 to \DWCFAoffsetextended{} 
2839 except that the second operand is
2840 signed and factored. The resulting offset is 
2841 \textit{factored\_offset} * \addttindex{data\_alignment\_factor}.
2842
2843 \needlines{4}
2844 \item \textbf{\DWCFAvaloffsetTARG} \\
2845 The \DWCFAvaloffsetNAME{} 
2846 instruction takes two unsigned
2847 LEB128 operands\addtoindexx{LEB128!unsigned} representing a register number and a
2848 factored offset. The required action is to change the rule
2849 for the register indicated by the register number to be a
2850 val\_offset(N) rule where the value of N is 
2851 \textit{factored\_offset} * \addttindex{data\_alignment\_factor}.
2852
2853 \needlines{6}
2854 \item \textbf{\DWCFAvaloffsetsfTARG} \\
2855 The \DWCFAvaloffsetsfNAME{} instruction takes two operands: an
2856 unsigned LEB128\addtoindexx{LEB128!unsigned} value representing a register number and a
2857 signed LEB128\addtoindexx{LEB128!signed} factored offset. This instruction is identical
2858 to \DWCFAvaloffset{} except that the second operand is signed
2859 and factored. The resulting offset is 
2860 \textit{factored\_offset} * \addttindex{data\_alignment\_factor}.
2861
2862 \item \textbf{\DWCFAregisterTARG} \\
2863 The \DWCFAregisterNAME{} 
2864 instruction takes two unsigned LEB128\addtoindexx{LEB128!unsigned}
2865 operands representing register numbers. The required action
2866 is to set the rule for the first register to be register(R)
2867 where R is the second register.
2868
2869 \item \textbf{\DWCFAexpressionTARG} \\
2870 The \DWCFAexpressionNAME{} instruction takes two operands: an
2871 unsigned LEB128\addtoindexx{LEB128!unsigned} 
2872 value representing a register number, and
2873 a \DWFORMblock{} 
2874 value representing a DWARF expression. 
2875 The
2876 required action is to change the rule for the register
2877 indicated by the register number to be an expression(E)
2878 rule where E is the DWARF expression. That is, the DWARF
2879 expression computes the address. The value of the CFA is
2880 pushed on the DWARF evaluation stack prior to execution of
2881 the DWARF expression.
2882
2883 \textit{See Section \refersec{chap:callframeinstructions} 
2884 regarding restrictions on the DWARF
2885 expression operators that can be used.}
2886
2887 \needlines{7}
2888 \item \textbf{\DWCFAvalexpressionTARG} \\
2889 The \DWCFAvalexpressionNAME{} instruction takes two operands:
2890 an unsigned LEB128\addtoindexx{LEB128!unsigned} 
2891 value representing a register number, and
2892 a \DWFORMblock{} 
2893 value representing a DWARF expression. The
2894 required action is to change the rule for the register
2895 indicated by the register number to be a val\_expression(E)
2896 rule where E is the DWARF expression. That is, the DWARF
2897 expression computes the value of the given register. The value
2898 of the CFA is pushed on the DWARF evaluation stack prior to
2899 execution of the DWARF expression.
2900
2901 \textit{See Section \refersec{chap:callframeinstructions} 
2902 regarding restrictions on the DWARF
2903 expression operators that can be used.}
2904
2905 \needlines{6}
2906 \item \textbf{\DWCFArestoreTARG} \\
2907 The \DWCFArestoreNAME{} instruction takes a single operand (encoded
2908 with the opcode) that represents a register number. The
2909 required action is to change the rule for the indicated
2910 register to the rule assigned it by the \texttt{initial\_instructions}
2911 in the CIE.
2912
2913 \needlines{5}
2914 \item \textbf{\DWCFArestoreextendedTARG} \\
2915 The \DWCFArestoreextendedNAME{}
2916 instruction takes a single unsigned LEB128\addtoindexx{LEB128!unsigned} 
2917 operand that represents a register number. This
2918 instruction is identical to \DWCFArestore{} except for the
2919 encoding and size of the register operand.
2920
2921 \end{enumerate}
2922
2923 \subsubsection{Row State Instructions}
2924 \label{chap:rowstateinstructions}
2925
2926 \textit{The next two instructions provide the ability to stack and
2927 retrieve complete register states. They may be useful, for
2928 example, for a compiler that moves \addtoindex{epilogue} code 
2929 into the
2930 body of a function.}
2931
2932
2933 \begin{enumerate}[1. ]
2934
2935 \item \textbf{\DWCFArememberstateTARG} \\
2936 The \DWCFArememberstateNAME{} instruction takes no operands. The
2937 required action is to push the set of rules for every register
2938 onto an implicit stack.
2939
2940 \needlines{4}
2941 \item \textbf{\DWCFArestorestateTARG} \\
2942 The \DWCFArestorestateNAME{} instruction takes no operands. The
2943 required action is to pop the set of rules off the implicit
2944 stack and place them in the current row.
2945
2946 \end{enumerate}
2947
2948 \subsubsection{Padding Instruction}
2949 \label{chap:paddinginstruction}
2950 \begin{enumerate}[1. ]
2951 \item \textbf{\DWCFAnopTARG} \\
2952 The \DWCFAnopNAME{} instruction has no operands and no required
2953 actions. It is used as padding to make a CIE or FDE an
2954 appropriate size.
2955
2956 \end{enumerate}
2957
2958 \subsection{Call Frame Instruction Usage} 
2959 \label{chap:callframeinstructionusage}
2960
2961 \textit{To determine the virtual unwind rule set for a given location
2962 (L1), 
2963 \bb
2964 search 
2965 \eb
2966 through the FDE headers looking at the
2967 \HFNinitiallocation{} and \HFNaddressrange{} values to see if L1 is
2968 contained in the FDE. If so, then:}
2969 \begin{enumerate}[1. ]
2970
2971 \item \textit{Initialize a register set by reading the
2972 \HFNinitialinstructions{} field of the associated CIE.
2973 \bb
2974 Set L2 to the value of the \HFNinitiallocation{} field from the FDE header.
2975 \eb}
2976
2977
2978 \item \textit{Read and process the FDE's instruction
2979 sequence until a \DWCFAadvanceloc, 
2980 \DWCFAsetloc, or the
2981 end of the instruction stream is encountered.}
2982
2983 \item \textit{ If a \DWCFAadvanceloc{} or \DWCFAsetloc{}
2984 instruction is encountered, then compute a new location value
2985 (L2). If L1 $\geq$ L2 then process the instruction and go back
2986 to step 2.}
2987
2988 \needlines{6}
2989 \item \textit{ The end of the instruction stream can be thought
2990 of as a \DWCFAsetloc{} (\addttindex{initial\_location} + \addttindex{address\_range})
2991 instruction. Note that the FDE is ill-formed if L2 is less
2992 than L1.}
2993
2994 \end{enumerate}
2995
2996 \textit{The rules in the register set now apply to location L1.}
2997
2998 \textit{For an example, see 
2999 Appendix \refersec{app:callframeinformationexample}.}
3000
3001
3002
3003 \subsection{Call Frame Calling Address}
3004 \label{chap:callframecallingaddress}
3005
3006 \textit{When 
3007 virtually unwinding frames, consumers frequently wish to obtain 
3008 the address of the instruction which called a subroutine. This
3009 information is not always provided. Typically, however,
3010 one of the registers in the virtual unwind table is the
3011 Return Address.}
3012
3013 If a Return Address register is defined in the virtual
3014 unwind table, and its rule is undefined (for example, by
3015 \DWCFAundefined), then there is no return address and no
3016 call address, and the virtual unwind of stack activations
3017 \addtoindexx{activation of call frame}
3018 is complete.
3019
3020 \textit{In most cases the return address is in the same context as the
3021 calling address, but that need not be the case, especially if
3022 the producer knows in some way the call never will return. The
3023 context of the 'return address' might be on a different line,
3024 in a different lexical \livelink{chap:lexicalblock}{block}, 
3025 or past the end of the calling
3026 subroutine. If a consumer were to assume that it was in the
3027 same context as the calling address, the 
3028 virtual unwind might fail.}
3029
3030 \needlines{5}
3031 \textit{For architectures with constant-length instructions where
3032 the return address immediately follows the call instruction,
3033 a simple solution is to subtract the length of an instruction
3034 from the return address to obtain the calling instruction. For
3035 architectures with variable-length instructions (for example, x86),
3036 this is not possible. However, subtracting 1 from the return
3037 address, although not guaranteed to provide the exact calling
3038 address, generally will produce an address within the same
3039 context as the calling address, and that usually is sufficient.}
3040
3041
3042