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