Misc corrections in App B through end
[dwarf-doc.git] / dwarf5 / latexdoc / compression.tex
1 \chapter[Compression (Informative)]{DWARF Compression and Duplicate Elimination (Informative)}
2 \label{dwarfcompressionandduplicateeliminationinformative}
3
4 % It seemed difficult to get close to the same layout and 
5 % captioning as DWARF4 here with figures as they moved (floated)
6 % making it hard to follow.  Hence this uses fewer figures.
7
8 DWARF 
9 \addtoindexx{DWARF compression}
10 can 
11 \addtoindexx{DWARF duplicate elimination}
12 use a lot of disk space.
13
14 This is especially true for C++, where the depth and complexity
15 of headers can mean that many, many (possibly thousands of)
16 declarations are repeated in every compilation unit. C++
17 templates can also mean that some functions and their DWARF
18 descriptions get duplicated.
19
20 This Appendix describes techniques for using the DWARF
21 representation in combination with features and characteristics
22 of some common object file representations to reduce redundancy
23 without losing information. It is worth emphasizing that none
24 of these techniques are necessary to provide a complete and
25 accurate DWARF description; they are solely concerned with
26 reducing the size of DWARF information.
27
28 The techniques described here depend more directly and more
29 obviously on object file concepts and linker mechanisms than
30 most other parts of DWARF. While the presentation tends to
31 use the vocabulary of specific systems, this is primarily to
32 aid in describing the techniques by appealing to well\dash known
33 terminology. These techniques can be employed on any system
34 that supports certain general functional capabilities
35 (described below).
36
37
38 \section{Using Compilation Units}
39 \label{app:usingcompilationunits}
40
41 \subsection{Overview}
42 The general approach is to break up the debug information of
43 a compilation into separate normal and partial compilation
44 units, each consisting of one or more sections. By arranging
45 that a sufficiently similar partitioning occurs in other
46 compilations, a suitable system linker can delete redundant
47 groups of sections when combining object files.
48
49 \textit{The following uses some traditional section naming here
50 but aside from the DWARF sections, the names are just meant
51 to suggest traditional contents as a way of explaining the
52 approach, not to be limiting.}
53
54 A traditional relocatable object output 
55 from a single compilation might contain sections 
56 named:
57 \begin{alltt}
58     \addtoindex{.data}
59     \addtoindex{.text}
60     \addtoindex{.debug\_info}
61     \addtoindex{.debug\_abbrev}
62     \addtoindex{.debug\_line}
63     \addtoindex{.debug\_aranges}
64 \end{alltt}
65 A relocatable object from a compilation system 
66 attempting duplicate DWARF elimination might
67 contain sections as in:
68
69 \begin{alltt}
70     \addtoindex{.data}
71     \addtoindex{.text}
72     \addtoindex{.debug\_info}
73     \addtoindex{.debug\_abbrev}
74     \addtoindex{.debug\_line}
75     \addtoindex{.debug\_aranges}
76 \end{alltt}
77
78 followed (or preceded, the order is not significant) 
79 by a series of 
80 \addtoindexx{section group}
81 section groups:
82 \begin{alltt}
83 ==== Section group 1
84     \addtoindex{.debug\_info}
85     \addtoindex{.debug\_abbrev}
86     \addtoindex{.debug\_line}
87 ==== ...
88 ==== Section group N
89     \addtoindex{.debug\_info}
90     \addtoindex{.debug\_abbrev}
91     \addtoindex{.debug\_line}
92 \end{alltt}
93
94 where each \addtoindex{section group} might or might not contain executable
95 code (\textit{.text} sections) or data (\textit{.data} sections).
96
97 A \textit{\addtoindex{section group}} is a named set 
98 of section contributions
99 within an object file with the property that the entire set
100 of section contributions must be retained or discarded as a
101 whole; no partial elimination is allowed. Section groups can
102 generally be handled by a linker in two ways:
103
104 \begin{enumerate}[1.]
105 \item Given multiple identical (duplicate) section groups,
106 \addtoindexx{section group}
107 one of them is chosen to be kept and used, while the rest
108 are discarded.
109
110 \item Given a \addtoindex{section group} 
111 that is not referenced from any
112 section outside of the \addtoindex{section group}, 
113 the section group
114 is discarded.
115
116
117 \end{enumerate}
118
119
120 Which handling applies may be indicated by the 
121 \addtoindex{section group}
122 itself and/or selection of certain linker options.
123
124 For example, if a linker determines that 
125 \addtoindex{section group} 1
126 from A.o and 
127 \addtoindex{section group} 3 from B.o are identical, it could
128 discard one group and arrange that all references in A.o and
129 B.o apply to the remaining one of the two identical section
130 groups. This saves space.
131
132 An important part of making it possible to “redirect”
133 references to the surviving 
134 \addtoindex{section group} is the use of
135 consistently chosen linker global symbols for referring to
136 locations within each 
137 \addtoindex{section group}.
138 It follows that references
139 are simply to external names and the linker already knows
140 how to match up references and definitions.
141
142 What is minimally needed from the object file format and system
143 linker (outside of DWARF itself, and normal object/linker
144 facilities such as simple relocations) are:
145
146 \begin{enumerate}[1.]
147
148 \item A means of referencing from inside one \addtoindex{.debug\_info}
149 compilation unit to another 
150 \addtoindex{.debug\_info} compilation unit
151 (\livelink{chap:DWFORMrefaddr}{DW\-\_FORM\-\_ref\-\_addr} provides this).
152
153 \item A means of having multiple contributions to specific sections
154 (for example, \addtoindex{.debug\_info}, and so on) in a single object file.
155
156 \item  A means of identifying a \addtoindex{section group} (giving it a name).
157
158 \item A means of identifying which sections go together to make
159 up a \addtoindex{section group}, 
160 so that the group can be treated as a unit
161 (kept or discarded).
162
163 \item  A means of indicating how each \addtoindex{section group} should be
164 processed by the linker.
165
166 \end{enumerate}
167
168 \textit{The notion of section and section contribution used here
169 corresponds closely to the similarly named concepts in the
170 ELF object file representation. 
171 The notion of \addtoindex{section group} is
172 an abstraction of common extensions of the ELF representation
173 widely known as ``COMDATs'' or ``COMDAT sections''. (Other
174 object file representations provide COMDAT\dash style mechanisms as
175 well.) There are several variations in the COMDAT schemes in
176 common use, any of which should be sufficient for the purposes
177 of the 
178 \addtoindexx{duplication elimination|see{DWARF duplicate elimination}}
179 DWARF duplicate elimination techniques described here.}
180
181 \subsection{Naming and Usage Considerations}
182 \label{app:namingandusageconsiderations}
183
184 A precise description of the means of deriving names usable
185 by the linker to access DWARF entities is not part of this
186 specification. Nonetheless, an outline of a usable approach
187 is given here to make this more understandable and to guide
188 implementors.
189
190 Implementations should clearly document their naming conventions.
191
192 In the following, it will be helpful to refer to the examples
193 in 
194 Figure \ref{app:duplicateeliminationexample1csource}
195 through 
196 Figure \ref{app:duplicateeliminationexample2companiondwarf}
197 of 
198 Section \refersec{app:examples}.
199
200 \textbf{Section Group Names}
201
202 Section groups must have a \addtoindex{section group} name.
203 \addtoindexx{section group!name}
204 For the subsequent 
205 \addtoindex{C++} example, a name like
206 \begin{alltt}
207     <producer-prefix>.<file-designator>.<gid-number>
208 \end{alltt}
209 will suffice, where
210
211 \begin{description}
212
213 \item  [\textless producer\dash prefix\textgreater] 
214 is some string specific to the
215 producer, which has a language\dash designation embedded in the
216 name when appropriate. (Alternatively, the language name
217 could be embedded in the 
218 \textless gid\dash number \textgreater).
219
220
221 \item  [\textless file\dash designator\textgreater]
222 names the file, such as wa.h in
223 the example.
224
225
226 \item  [\textless gid\dash number\textgreater]
227 is a string generated to identify the
228 specific wa.h header file in such a way that
229
230 \begin{itemize}
231
232 \item  a 'matching' output from another compile generates
233 the same 
234 \textless gid\dash number\textgreater,
235 and
236
237 \item  a non\dash matching output (say because of \#defines)
238 generates a different 
239 \textless gid\dash number\textgreater.
240 \end{itemize}
241
242 \end{description}
243
244 \textit{It may be useful to think of a 
245 \textless gid\dash number\textgreater
246 as a kind
247 of ``digital signature'' that allows a fast test for the
248 equality of two 
249 \addtoindexx{section group}
250 section groups.}
251
252 So, for example, the \addtoindex{section group} 
253 corresponding to file wa.h
254 above is given the name \textit{my.compiler.company.cpp.wa.h.123456}.
255
256
257
258 \textbf{Debugging Information Entry Names}
259
260 Global labels for 
261 \addtoindexx{debugging information entry!ownership relation}
262 debugging information entries (need explained
263 below) within a \addtoindex{section group}
264 can be given names of the form
265
266 \begin{alltt}
267     <prefix>.<file-designator>.<gid-number>.<die-number>
268 \end{alltt}
269
270 such as
271
272 \begin{alltt}
273     my.compiler.company.wa.h.123456.987
274 \end{alltt}
275
276 where
277 \begin{description}
278 \item [\textless prefix\textgreater]  
279 distinguishes this as a DWARF debug info name, and should identify the producer
280 and, when appropriate, the language.
281 \item [\textless file\dash designator\textgreater]  
282 and 
283 \texttt{\textless gid\dash number\textgreater} 
284 are as above.
285
286 \item  [\textless die\dash number\textgreater]
287 could be a number sequentially assigned 
288 to entities (tokens, perhaps) found
289 during compilation.
290
291 \end{description}
292
293 In general, every point in the 
294 \addtoindexx{section group}
295 section group 
296 \addtoindex{.debug\_info} that
297 could be referenced from outside by any compilation unit must
298 normally have an external name generated for it in the linker
299 symbol table, whether the current compilation references all
300 those points or not.
301
302 The completeness of the set of names generated is a
303 quality\dash of\dash implementation issue.
304
305 It is up to the producer to ensure that if 
306 \textless die\dash numbers\textgreater\ 
307 in separate compilations would not match properly then a
308 distinct 
309 \textless gid\dash number\textgreater\ 
310 is generated.
311
312 Note that only 
313 \addtoindexx{section group}
314 section groups that are designated as
315 duplicate\dash removal\dash applies actually require the
316 \begin{alltt}
317     <prefix>.<file-designator>.<gid-number>.<die-number>
318 \end{alltt}
319 external labels for debugging information entries as all other
320 \addtoindex{section group} sections can use 'local' labels 
321 (section\dash relative
322 relocations).
323
324 (This is a consequence of separate compilation, not a rule
325 imposed by this document.)
326
327 \textit{Local labels use references with form \livelink{chap:DWFORMref4}{DW\-\_FORM\-\_ref4}
328 or 
329 \livelink{chap:DWFORMref8}{DW\-\_FORM\-\_ref8}. 
330 (These are affected by relocations
331 so 
332 \livelink{chap:DWFORMrefudata}{DW\-\_FORM\-\_ref\-\_udata}, 
333 \livelink{chap:DWFORMref1}{DW\-\_FORM\-\_ref1} and 
334 \livelink{chap:DWFORMref2}{DW\-\_FORM\-\_ref2} are
335 normally not usable and 
336 \livelink{chap:DWFORMrefaddr}{DW\-\_FORM\-\_ref\-\_addr} is not necessary
337 for a local label.)}
338
339 % This should be a subsubsubsection header but that does work...
340 \textbf{Use of \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit} versus 
341 \livelink{chap:DWTAGpartialunit}{DW\-\_TAG\-\_partial\-\_unit}}
342
343 A \addtoindex{section group} compilation unit that uses 
344 \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit}
345 is like any other compilation unit, in that its contents
346 are evaluated by consumers as though it were an ordinary
347 compilation unit.
348
349 An \#include directive appearing outside any other
350 declarations is a good candidate to be represented using
351 \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit}. 
352 However, an \#include appearing inside
353 a \addtoindex{C++} namespace declaration or a function, for example, is
354 not a good candidate because the entities included are not
355 necessarily file level entities.
356
357 This also applies to \addtoindex{Fortran} INCLUDE lines when declarations
358 are included into a procedure or module context.
359
360 Consequently a compiler must use \livelink{chap:DWTAGpartialunit}{DW\-\_TAG\-\_partial\-\_unit} (instead
361 of \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit}) 
362 in a \addtoindex{section group} 
363 whenever the section group 
364 contents are not necessarily globally visible. 
365 This
366 directs consumers to ignore that compilation unit when scanning
367 top level declarations and definitions.
368
369 The \livelink{chap:DWTAGpartialunit}{DW\-\_TAG\-\_partial\-\_unit} compilation unit will be referenced
370 from elsewhere and the referencing locations give the
371 appropriate context for interpreting the partial compilation
372 unit.
373
374 A \livelink{chap:DWTAGpartialunit}{DW\-\_TAG\-\_partial\-\_unit} entry may have, as appropriate, any of
375 the attributes assigned to a \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit}.
376
377
378 \textbf{Use of \livelink{chap:DWTAGimportedunit}{DW\-\_TAG\-\_imported\-\_unit}}
379
380 A \livelink{chap:DWTAGimportedunit}{DW\-\_TAG\-\_imported\-\_unit} debugging information entry has an
381 \livelink{chap:DWATimport}{DW\-\_AT\-\_import} attribute referencing a \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit} or
382 \livelink{chap:DWTAGpartialunit}{DW\-\_TAG\-\_partial\-\_unit} debugging information entry.
383
384 A \livelink{chap:DWTAGimportedunit}{DW\-\_TAG\-\_imported\-\_unit} debugging information entry refers
385 to a 
386 \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit} or 
387 \livelink{chap:DWTAGpartialunit}{DW\-\_TAG\-\_partial\-\_unit} debugging
388 information entry to specify that the 
389 \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit} or
390 \livelink{chap:DWTAGpartialunit}{DW\-\_TAG\-\_partial\-\_unit} contents logically appear at the point
391 of the 
392 \livelink{chap:DWTAGimportedunit}{DW\-\_TAG\-\_imported\-\_unit} entry.
393
394
395 \textbf{Use of \livelink{chap:DWFORMrefaddr}{DW\-\_FORM\-\_ref\-\_addr}}
396
397 Use 
398 \livelink{chap:DWFORMrefaddr}{DW\-\_FORM\-\_ref\-\_addr} to reference from one compilation
399 unit's debugging information entries to those of another
400 compilation unit.
401
402 When referencing into a removable \addtoindex{section group}
403 \addtoindex{.debug\_info}
404 from another \addtoindex{.debug\_info} (from anywhere), the
405 \texttt{<prefix>.<file-designator>.<gid-number>.<die-number>}
406 name should be used for an external symbol and a relocation
407 generated based on that name.
408
409 When referencing into a 
410 \addtoindexx{section group}
411 non-section group 
412 \addtoindex{.debug\_info},
413 from another \addtoindex{.debug\_info} (from anywhere) 
414 \livelink{chap:DWFORMrefaddr}{DW\-\_FORM\-\_ref\-\_addr} is
415 still the form to be used, but a section\dash relative relocation
416 generated by use of a non-exported name (often called an
417 ``internal name'') may be used for references within the
418 same object file.
419
420 \subsection{Examples}
421 \label{app:examples}
422
423 This section provides several 
424 \addtoindexx{DWARF duplicate elimination!examples}
425 examples in order to have a
426 concrete basis for discussion.
427
428 In these examples, the focus is on the arrangement of DWARF
429 information into sections (specifically the 
430 \addtoindex{.debug\_info}
431 section) and the naming conventions used to achieve references
432 into 
433 \addtoindexx{section group}
434 section groups. 
435 In practice, all of the examples that
436 follow involve DWARF sections other than just 
437 \addtoindex{.debug\_info}
438 (for example, \addtoindex{.debug\_line}, 
439 \addtoindex{.debug\_aranges}, or others);
440 however, only the \addtoindex{.debug\_info}
441 section is shown to keep the
442 examples compact and easier to read.
443
444 The grouping of sections into a named set is shown, but the means for achieving this in terms of
445 the underlying object language is not (and varies from system to system).
446
447 \subsubsection{C++ Example}
448
449 The \addtoindex{C++} source 
450 \addtoindexx{DWARF duplicate elimination!C++ example}
451 in 
452 Section \refersec{app:duplicateeliminationexample1csource}
453 is used to illustrate the DWARF
454 representation intended to allow duplicate elimination.
455
456 \paragraph{Duplicate elimination example 1: C++ Source} 
457 \label{app:duplicateeliminationexample1csource}
458
459 File wa.h
460
461 \begin{lstlisting}
462 struct A {
463    int i;
464 };
465 \end{lstlisting}
466
467 File wa.C
468
469 \begin{lstlisting}
470 #include "wa.h";
471 int
472 f(A &a)
473 {
474     return a.i + 2;
475 }
476 \end{lstlisting}
477
478
479 section \refersec{app:duplicateeliminationexample1dwarfsectiongroup}
480 shows the \addtoindex{section group} corresponding to the included file 
481 wa.h.
482
483
484 \paragraph{Duplicate elimination example 1: DWARF section group} 
485
486 \label{app:duplicateeliminationexample1dwarfsectiongroup}
487 % FIXME: the DWFORMrefn could use rethinking
488 \begin{alltt}
489 ==== Section group name:
490     my.compiler.company.cpp.wa.h.123456
491 == section \addtoindex{.debug\_info}
492 DW.cpp.wa.h.123456.1: ! linker global symbol
493     \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit}
494         \livelink{chap:DWATlanguage}{DW\-\_AT\-\_language}(\livelink{chap:DWLANGCplusplus}{DW\-\_LANG\-\_C\-\_plus\-\_plus})
495         ...  ! other unit attributes
496 DW.cpp.wa.h.123456.2: ! linker global symbol
497     \livelink{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type}
498         \livelink{chap:DWATname}{DW\-\_AT\-\_name}("int")
499 DW.cpp.wa.h.123456.3: ! linker global symbol
500     \livelink{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type}
501         \livelink{chap:DWATname}{DW\-\_AT\-\_name}("A")
502 DW.cpp.wa.h.123456.4: ! linker global symbol
503         \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
504         \livelink{chap:DWATname}{DW\-\_AT\-\_name}("i")
505         \livelink{chap:DWATtype}{DW\-\_AT\-\_type}(\livelink{chap:DWFORMrefn}{DW\-\_FORM\-\_refn} to DW.cpp.wa.h.123456.2)
506             ! (This is a local reference, so the more
507             ! compact form \livetarg{chap:DWFORMrefn}{DW\-\_FORM\-\_refn} 
508             ! for n 1,2,4, or 8 can be used)
509 \end{alltt}
510
511
512 Figure \refersec{app:duplicateeliminationexample1primarycompilationunit}
513 shows the ``normal'' DWARF sections, which are not part of
514 any \addtoindex{section group}, 
515 and how they make use of the information
516 in the \addtoindex{section group} shown above.
517
518 \paragraph{Duplicate elimination example 1: primary compilation unit} 
519 \label{app:duplicateeliminationexample1primarycompilationunit}
520 \begin{alltt}
521 == section .text
522     [generated code for function f]
523 == section \addtoindex{.debug\_info}
524     \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit}
525 .L1:                   ! local (non-linker) symbol
526         \livelink{chap:DWTAGreferencetype}{DW\-\_TAG\-\_reference\-\_type}
527             \livelink{chap:DWATtype}{DW\-\_AT\-\_type}(reference to DW.cpp.wa.h.123456.3)
528         \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram}
529             \livelink{chap:DWATname}{DW\-\_AT\-\_name}("f")
530             \livelink{chap:DWATtype}{DW\-\_AT\-\_type}(reference to DW.cpp.wa.h.123456.2)
531             \livelink{chap:DWTAGvariable}{DW\-\_TAG\-\_variable}
532                 \livelink{chap:DWATname}{DW\-\_AT\-\_name}("a")
533                 \livelink{chap:DWATtype}{DW\-\_AT\-\_type}(reference to .L1)
534         ...
535 \end{alltt}
536
537 This example uses \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit} for the \addtoindex{section group},
538 implying that the contents of the compilation unit are
539 globally visible (in accordance with 
540 \addtoindex{C++} language rules).
541 \livelink{chap:DWTAGpartialunit}{DW\-\_TAG\-\_partial\-\_unit} is not needed for the same reason.
542
543 \subsubsection{Fortran Example}
544
545
546 For a \addtoindex{Fortran}
547 \addtoindexx{DWARF duplicate elimination!Fortran example}
548 example, consider 
549 Figure \refersec{app:duplicateeliminationexample2fortransource}.
550
551
552 \paragraph{Duplicate elimination example 2: Fortran source} 
553 \label{app:duplicateeliminationexample2fortransource}
554
555 File CommonStuff.fh
556 \addtoindexx{Fortran}
557
558 \begin{lstlisting}
559 IMPLICIT INTEGER(A-Z)
560 COMMON /Common1/ C(100)
561 PARAMETER(SEVEN = 7)
562 \end{lstlisting}
563
564 File Func.f
565 \begin{lstlisting}
566
567 FUNCTION FOO (N)
568 INCLUDE 'CommonStuff.fh'
569 FOO = C(N + SEVEN)
570 RETURN
571 END
572 \end{lstlisting}
573
574
575 Section \refersec{app:duplicateeliminationexample2dwarfsectiongroup}
576 shows the \addtoindex{section group}
577 corresponding to the included file 
578 \addtoindexx{Fortran example}
579 CommonStuff.fh.
580
581 \paragraph{Duplicate elimination example 2: DWARF section group}
582 \label{app:duplicateeliminationexample2dwarfsectiongroup}
583
584 \begin{alltt}
585 ==== Section group name:
586
587     my.f90.company.f90.CommonStuff.fh.654321
588
589 == section \addtoindex{.debug\_info}
590
591 DW.myf90.CommonStuff.fh.654321.1:    ! linker global symbol
592     \livelink{chap:DWTAGpartialunit}{DW\-\_TAG\-\_partial\-\_unit}
593         ! ...compilation unit attributes, including...
594         \livelink{chap:DWATlanguage}{DW\-\_AT\-\_language}(\livelink{chap:DWLANGFortran90}{DW\-\_LANG\-\_Fortran90})
595         \livelink{chap:DWATidentifiercase}{DW\-\_AT\-\_identifier\-\_case}(\livelink{chap:DWIDcaseinsensitive}{DW\-\_ID\-\_case\-\_insensitive})
596
597 DW.myf90.CommonStuff.fh.654321.2: ! linker global symbol
598 3\$: \livelink{chap:DWTAGarraytype}{DW\-\_TAG\-\_array\-\_type}
599         ! unnamed
600         \livelink{chap:DWATtype}{DW\-\_AT\-\_type}(reference to DW.f90.F90\$main.f.2)
601             ! base type INTEGER
602         \livelink{chap:DWTAGsubrangetype}{DW\-\_TAG\-\_subrange\-\_type}
603             \livelink{chap:DWATtype}{DW\-\_AT\-\_type}(reference to DW.f90.F90\$main.f.2)
604                 ! base type INTEGER)
605             \livelink{chap:DWATlowerbound}{DW\-\_AT\-\_lower\-\_bound}(constant 1)
606             \livelink{chap:DWATupperbound}{DW\-\_AT\-\_upper\-\_bound}(constant 100)
607
608 DW.myf90.CommonStuff.fh.654321.3: ! linker global symbol
609     \livelink{chap:DWTAGcommonblock}{DW\-\_TAG\-\_common\-\_block}
610         \livelink{chap:DWATname}{DW\-\_AT\-\_name}("Common1")
611         \livelink{chap:DWATlocation}{DW\-\_AT\-\_location}(Address of common \nolink{block} Common1)
612         \livelink{chap:DWTAGvariable}{DW\-\_TAG\-\_variable}
613             \livelink{chap:DWATname}{DW\-\_AT\-\_name}("C")
614             \livelink{chap:DWATtype}{DW\-\_AT\-\_type}(reference to 3\$)
615             \livelink{chap:DWATlocation}{DW\-\_AT\-\_location}(address of C)
616
617 DW.myf90.CommonStuff.fh.654321.4: ! linker global symbol
618     \livelink{chap:DWTAGconstant}{DW\-\_TAG\-\_constant}
619         \livelink{chap:DWATname}{DW\-\_AT\-\_name}("SEVEN")
620         \livelink{chap:DWATtype}{DW\-\_AT\-\_type}(reference to DW.f90.F90\$main.f.2)
621             ! base type INTEGER
622         \livelink{chap:DWATconstvalue}{DW\-\_AT\-\_const\-\_value}(constant 7)
623 \end{alltt}
624
625 Section \refersec{app:duplicateeliminationexample2primaryunit}
626 shows the sections for the primary compilation unit.
627
628
629
630 \paragraph{Duplicate elimination example 2: primary unit }
631 \label{app:duplicateeliminationexample2primaryunit}
632 \begin{alltt}
633 == section .text
634     [code for function Foo]
635
636 == section \addtoindex{.debug\_info}
637     \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit}
638         \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram}
639             \livelink{chap:DWATname}{DW\-\_AT\-\_name}("Foo")
640             \livelink{chap:DWATtype}{DW\-\_AT\-\_type}(reference to DW.f90.F90\$main.f.2)
641                 ! base type INTEGER
642             \livelink{chap:DWTAGimportedunit}{DW\-\_TAG\-\_imported\-\_unit}
643                 \livelink{chap:DWATimport}{DW\-\_AT\-\_import}(reference to
644                     DW.myf90.CommonStuff.fh.654321.1)
645             \livelink{chap:DWTAGcommoninclusion}{DW\-\_TAG\-\_common\-\_inclusion} ! For Common1
646                 \livelink{chap:DWATcommonreference}{DW\-\_AT\-\_common\-\_reference}(reference to
647                     DW.myf90.CommonStuff.fh.654321.3)
648             \livelink{chap:DWTAGvariable}{DW\-\_TAG\-\_variable} ! For function result
649                 \livelink{chap:DWATname}{DW\-\_AT\-\_name}("Foo")
650                     \livelink{chap:DWATtype}{DW\-\_AT\-\_type}(reference to DW.f90.F90\$main.f.2)
651                         ! base type INTEGER
652 \end{alltt}
653
654 A companion main program is shown in 
655 Section \refersec{app:duplicateeliminationexample2companionsource}
656
657 \paragraph{Duplicate elimination example 2: companion source }
658 \label{app:duplicateeliminationexample2companionsource}
659
660 File Main.f 
661
662 \begin{lstlisting}
663 INCLUDE 'CommonStuff.fh'
664 C(50) = 8
665 PRINT *, 'Result = ', FOO(50 - SEVEN)
666 END
667 \end{lstlisting}
668
669 That main program results in an object file that
670 contained a duplicate of the \addtoindex{section group} named
671 my.f90.company.f90.CommonStuff.fh.654321 
672 corresponding to the
673 included file as well as the remainder of the main subprogram
674 as shown in 
675 Section \refersec{app:duplicateeliminationexample2companiondwarf}.
676
677 \paragraph{Duplicate elimination example 2: companion DWARF }
678 \label{app:duplicateeliminationexample2companiondwarf}
679
680 \begin{alltt}
681 == section \addtoindex{.debug\_info}
682     \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit}
683         \livelink{chap:DWATname}{DW\-\_AT\-\_name}(F90\$main)
684         \livelink{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type}
685             \livelink{chap:DWATname}{DW\-\_AT\-\_name}("INTEGER")
686             \livelink{chap:DWATencoding}{DW\-\_AT\-\_encoding}(\livelink{chap:DWATEsigned}{DW\-\_ATE\-\_signed})
687             \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size}(...)
688
689         \livelink{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type}
690             ...
691         ...  ! other base types
692         \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram}
693             \livelink{chap:DWATname}{DW\-\_AT\-\_name}("F90\$main")
694             \livelink{chap:DWTAGimportedunit}{DW\-\_TAG\-\_imported\-\_unit}
695                 \livelink{chap:DWATimport}{DW\-\_AT\-\_import}(reference to
696                     DW.myf90.CommonStuff.fh.654321.1)
697             \livelink{chap:DWTAGcommoninclusion}{DW\-\_TAG\-\_common\-\_inclusion} ! for Common1
698                 \livelink{chap:DWATcommonreference}{DW\-\_AT\-\_common\-\_reference}(reference to
699                     DW.myf90.CommonStuff.fh.654321.3)
700             ...
701 \end{alltt}
702
703
704 This example uses \livelink{chap:DWTAGpartialunit}{DW\-\_TAG\-\_partial\-\_unit} for the \addtoindex{section group}
705 because the included declarations are not independently
706 visible as global entities.
707
708
709 \subsubsection{C Example}
710
711 The \addtoindex{C} example 
712 \addtoindexx{DWARF duplicate elimination!C example}
713 in this Section might appear to be equally
714 valid as a \addtoindex{C} example. However, it is prudent to include
715 a \livelink{chap:DWTAGimportedunit}{DW\-\_TAG\-\_imported\-\_unit}
716 in the primary unit 
717 (see Figure \refersec{app:duplicateeliminationexample1primarycompilationunit})
718 with an \livelink{chap:DWATimport}{DW\-\_AT\-\_import} attribute that refers to the proper unit
719 in the \addtoindex{section group}.
720
721 \textit{The \addtoindex{C} rules for consistency of global (file scope) symbols
722 across compilations are less strict than for C++; inclusion
723 of the import unit attribute assures that the declarations of
724 the proper \addtoindex{section group} are considered before declarations
725 from other compilations.}
726
727
728 \section{Using Type Units}
729 \label{app:usingtypeunits}
730
731 A large portion of debug information is type information, and
732 in a typical compilation environment, many types are duplicated
733 many times. One method of controlling the amount of duplication
734 is separating each type into a separate 
735 \addtoindex{.debug\_types} section
736 and arranging for the linker to recognize and eliminate
737 duplicates at the individual type level.
738
739 Using this technique, each substantial type definition is
740 placed in its own individual section, while the remainder
741 of the DWARF information (non-type information, incomplete
742 type declarations, and definitions of trivial types) is
743 placed in the usual debug information section. In a typical
744 implementation, the relocatable object file may contain one
745 of each of these debug sections:
746
747 \begin{alltt}
748 \addtoindex{.debug\_abbrev}
749 \addtoindex{.debug\_info}
750 \addtoindex{.debug\_line}
751 \end{alltt}
752
753 and any number of these additional sections:
754
755 \begin{alltt}
756 \addtoindex{.debug\_types}
757 \end{alltt}
758
759 As discussed in the previous section 
760 (Section \refersec{app:usingcompilationunits}), 
761 many
762 linkers today support the concept of a COMDAT group or
763 linkonce section. The general idea is that a ``key'' can be
764 attached to a section or a group of sections, and the linker
765 will include only one copy of a \addtoindex{section group}
766 (or individual section) for any given key. 
767 For 
768 \addtoindex{.debug\_types} sections, the
769 key is the \addtoindex{type signature}
770 formed from the algorithm given in
771 Section \refersec{datarep:typesignaturecomputation}.
772
773 \subsection{Signature Computation Example}
774 \label{app:signaturecomputationexample}
775
776 As an example, 
777 \addtoindexx{type signature!example computation}
778 consider a \addtoindex{C++} header file 
779 containing the type definitions shown
780 in Section \refersec{app:typesignatureexamplescsource}.
781
782 \subsubsection{ Type signature examples: C++ source}
783 \label{app:typesignatureexamplescsource}
784 \begin{lstlisting}
785 namespace N {
786
787  struct B;
788
789  struct C {
790      int x;
791      int y;
792  };
793
794  class A {
795    public:
796      A(int v);
797      int v();
798    private:
799      int v_;
800      struct A *next;
801      struct B *bp;
802      struct C c;
803  };
804
805  }
806 \end{lstlisting}
807
808 Next, consider one possible representation of the DWARF
809 information that describes the type “struct C” as shown
810 in 
811 \refersec{app:typesignaturecomputation1dwarfrepresentation}:
812
813 \subsubsection{Type signature  computation 1: DWARF representation}
814 \label{app:typesignaturecomputation1dwarfrepresentation}
815 % We keep the : (colon) away from the attribute so tokenizing in the python tools
816 % does not result in adding : into the attribute name.
817 \begin{alltt}
818   \livelink{chap:DWTAGtypeunit}{DW\-\_TAG\-\_type\-\_unit}
819       \livelink{chap:DWATlanguage}{DW\-\_AT\-\_language} : \livelink{chap:DWLANGCplusplus}{DW\-\_LANG\-\_C\-\_plus\-\_plus} (4)
820     \livelink{chap:DWTAGnamespace}{DW\-\_TAG\-\_namespace}
821         \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "N"
822 L1:
823       \livelink{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type}
824           \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "C"
825           \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} : 8
826           \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file} : 1
827           \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} : 5
828         \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
829             \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "x"
830             \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file} : 1
831             \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} : 6
832             \livelink{chap:DWATtype}{DW\-\_AT\-\_type} : reference to L2
833             \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} : 0
834         \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
835             \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "y"
836             \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file} : 1
837             \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} : 7
838             \livelink{chap:DWATtype}{DW\-\_AT\-\_type} : reference to L2
839             \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} : 4
840 L2:
841      \livelink{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type}
842          \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} : 4
843          \livelink{chap:DWATencoding}{DW\-\_AT\-\_encoding} : \livelink{chap:DWATEsigned}{DW\-\_ATE\-\_signed}
844          \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "int"
845 \end{alltt}
846
847 In computing a signature for the type N::C, flatten the type
848 \addtoindexx{type signature}
849 description into a byte stream according to the procedure
850 outlined in 
851 Section \refersec{datarep:typesignaturecomputation}.
852 The result is shown in 
853 Section \refersec{app:typesignaturecomputation1flattenedbytestream}.
854
855 \subsubsection{Type signature  computation 1: flattened byte stream}
856 \label{app:typesignaturecomputation1flattenedbytestream}
857
858 \begin{alltt}
859 // Step 2: 'C' \livelink{chap:DWTAGnamespace}{DW\-\_TAG\-\_namespace} "N"
860 0x43 0x39 0x4e 0x00
861 // Step 3: 'D' \livelink{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type}
862 0x44 0x13
863 // Step 4: 'A' \livelink{chap:DWATname}{DW\-\_AT\-\_name} \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} "C"
864 0x41 0x03 0x08 0x43 0x00
865 // Step 4: 'A' \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} 8
866 0x41 0x0b 0x0d 0x08
867 // Step 7: First child ("x")
868     // Step 3: 'D' \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
869     0x44 0x0d
870     // Step 4: 'A' \livelink{chap:DWATname}{DW\-\_AT\-\_name} \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} "x"
871     0x41 0x03 0x08 0x78 0x00
872     // Step 4: 'A' \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} 0
873     0x41 0x38 0x0d 0x00
874     // Step 6: 'T' \livelink{chap:DWATtype}{DW\-\_AT\-\_type} (type \#2)
875     0x54 0x49
876         // Step 3: 'D' \livelink{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type}
877         0x44 0x24
878         // Step 4: 'A' \livelink{chap:DWATname}{DW\-\_AT\-\_name} \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} "int"
879         0x41 0x03 0x08 0x69 0x6e 0x74 0x00
880         // Step 4: 'A' \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} 4
881         0x41 0x0b 0x0d 0x04
882         // Step 4: 'A' \livelink{chap:DWATencoding}{DW\-\_AT\-\_encoding} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} \livelink{chap:DWATEsigned}{DW\-\_ATE\-\_signed}
883         0x41 0x3e 0x0d 0x05
884         // Step 7: End of \livelink{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type} "int"
885         0x00
886     // Step 7: End of \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member} "x"
887     0x00
888 // Step 7: Second child ("y")
889     // Step 3: 'D' \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
890     0x44 0x0d
891     // Step 4: 'A' \livelink{chap:DWATname}{DW\-\_AT\-\_name} \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} "y"
892     0x41 0x03 0x08 0x78 0x00
893     // Step 4: 'A' \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} 4
894     0x41 0x38 0x0d 0x04
895     // Step 6: 'R' \livelink{chap:DWATtype}{DW\-\_AT\-\_type} (type \#2)
896     0x52 0x49 0x02
897     // Step 7: End of \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member} "y"
898     0x00
899 // Step 7: End of \livelink{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type} "C"
900 0x00
901 \end{alltt}
902
903 Running an \addtoindex{MD5 hash} over this byte stream, and taking the
904 low\dash order 64 bits, yields the final signature: 
905 0xd28081e8 dcf5070a.
906
907 Next, consider a representation of the DWARF information that
908 describes the type ``class A'' as shown in 
909 Section \refersec{app:typesignaturecomputation2dwarfrepresentation}.
910
911
912 \subsubsection{Type signature  computation 2: DWARF representation}
913 \label{app:typesignaturecomputation2dwarfrepresentation}
914
915 \begin{alltt}
916   \livelink{chap:DWTAGtypeunit}{DW\-\_TAG\-\_type\-\_unit}
917       \livelink{chap:DWATlanguage}{DW\-\_AT\-\_language} : \livelink{chap:DWLANGCplusplus}{DW\-\_LANG\-\_C\-\_plus\-\_plus} (4)
918     \livelink{chap:DWTAGnamespace}{DW\-\_TAG\-\_namespace}
919           \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "N"
920 L1:
921         \livelink{chap:DWTAGclasstype}{DW\-\_TAG\-\_class\-\_type}
922              \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "A"
923              \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} : 20
924              \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file} : 1
925              \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} : 10
926            \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
927                 \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "v\_"
928                 \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file} : 1
929                 \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} : 15
930                 \livelink{chap:DWATtype}{DW\-\_AT\-\_type} : reference to L2
931                 \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} : 0
932                 \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility} : \livelink{chap:DWACCESSprivate}{DW\-\_ACCESS\-\_private}
933           \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
934                \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "next"
935                \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file} : 1
936                \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} : 16
937                \livelink{chap:DWATtype}{DW\-\_AT\-\_type} : reference to L3
938                \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} : 4
939                \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility} : \livelink{chap:DWACCESSprivate}{DW\-\_ACCESS\-\_private}
940           \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
941                \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "bp"
942                \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file} : 1
943                \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} : 17
944                \livelink{chap:DWATtype}{DW\-\_AT\-\_type} : reference to L4
945                \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} : 8
946                \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility} : \livelink{chap:DWACCESSprivate}{DW\-\_ACCESS\-\_private}
947           \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
948                \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "c"
949                \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file} : 1
950                \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} : 18
951                \livelink{chap:DWATtype}{DW\-\_AT\-\_type} : 0xd28081e8 dcf5070a (signature for struct C)
952                \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} : 12
953                \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility} : \livelink{chap:DWACCESSprivate}{DW\-\_ACCESS\-\_private}
954        \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram}
955            \livelink{chap:DWATexternal}{DW\-\_AT\-\_external} : 1
956            \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "A"
957            \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file} : 1
958            \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} : 12
959            \livelink{chap:DWATdeclaration}{DW\-\_AT\-\_declaration} : 1
960         \livelink{chap:DWTAGformalparameter}{DW\-\_TAG\-\_formal\-\_parameter}
961            \livelink{chap:DWATtype}{DW\-\_AT\-\_type} : reference to L3
962            \livelink{chap:DWATartificial}{DW\-\_AT\-\_artificial} : 1
963         \livelink{chap:DWTAGformalparameter}{DW\-\_TAG\-\_formal\-\_parameter}
964            \livelink{chap:DWATtype}{DW\-\_AT\-\_type} : reference to L2
965        \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram}
966            \livelink{chap:DWATexternal}{DW\-\_AT\-\_external} : 1
967            \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "v"
968            \livelink{chap:DWATdeclfile}{DW\-\_AT\-\_decl\-\_file} : 1
969            \livelink{chap:DWATdeclline}{DW\-\_AT\-\_decl\-\_line} : 13
970            \livelink{chap:DWATtype}{DW\-\_AT\-\_type} : reference to L2
971            \livelink{chap:DWATdeclaration}{DW\-\_AT\-\_declaration} : 1
972          \livelink{chap:DWTAGformalparameter}{DW\-\_TAG\-\_formal\-\_parameter}
973            \livelink{chap:DWATtype}{DW\-\_AT\-\_type} : reference to L3
974            \livelink{chap:DWATartificial}{DW\-\_AT\-\_artificial} : 1
975 L2:
976     \livelink{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type}
977          \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} : 4
978          \livelink{chap:DWATencoding}{DW\-\_AT\-\_encoding} : \livelink{chap:DWATEsigned}{DW\-\_ATE\-\_signed}
979          \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "int"
980 L3:
981     \livelink{chap:DWTAGpointertype}{DW\-\_TAG\-\_pointer\-\_type}
982          \livelink{chap:DWATtype}{DW\-\_AT\-\_type} : reference to L1
983 L4:
984     \livelink{chap:DWTAGpointertype}{DW\-\_TAG\-\_pointer\-\_type}
985          \livelink{chap:DWATtype}{DW\-\_AT\-\_type} : reference to L5
986     \livelink{chap:DWTAGnamespace}{DW\-\_TAG\-\_namespace}
987          \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "N"
988 L5:
989        \livelink{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type}
990            \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "B"
991            \livelink{chap:DWATdeclaration}{DW\-\_AT\-\_declaration} : 1
992 \end{alltt}
993
994 In this example, the structure types N::A and N::C have each
995 been placed in separate 
996 \addtoindexx{type unit}
997 type units.  For N::A, the actual
998 definition of the type begins at label L1. The definition
999 involves references to the int base type and to two pointer
1000 types. The information for each of these referenced types is
1001 also included in this \addtoindex{type unit}, 
1002 since base types and pointer
1003 types are trivial types that are not worth the overhead of a
1004 separate \addtoindex{type unit}. 
1005 The last pointer type contains a reference
1006 to an incomplete type N::B, which is also included here as
1007 a declaration, since the complete type is unknown and its
1008 signature is therefore unavailable. There is also a reference
1009 to N::C, using 
1010 \livelink{chap:DWFORMrefsig8}{DW\-\_FORM\-\_ref\-\_sig8} to 
1011 refer to the type signature
1012 \addtoindexx{type signature}
1013 for that type.
1014
1015 In computing a signature for the type N::A, flatten the type
1016 description into a byte stream according to the procedure
1017 outlined in 
1018 Section \refersec{datarep:typesignaturecomputation}.
1019 The result is shown in 
1020 Section \refersec{app:typesignatureexample2flattenedbytestream}.
1021
1022 \subsubsection{Type signature example 2: flattenedbytestream}
1023 \label{app:typesignatureexample2flattenedbytestream}
1024 % DWARF4 had a \livelink{chap:DWATnamespace}{DW_AT_namespace} below, 
1025 % but this error is fixed here to be \livelink{chap:DWTAGnamespace}{DW_TAG_namespace}.
1026 \begin{alltt}
1027 // Step 2: 'C' \livelink{chap:DWTAGnamespace}{DW\-\_TAG\-\_namespace} "N"
1028 0x43 0x39 0x4e 0x00
1029 // Step 3: 'D' \livelink{chap:DWTAGclasstype}{DW\-\_TAG\-\_class\-\_type}
1030 0x44 0x02
1031 // Step 4: 'A' \livelink{chap:DWATname}{DW\-\_AT\-\_name} \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} "A"
1032 0x41 0x03 0x08 0x41 0x00
1033 // Step 4: 'A' \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} 20
1034 0x41 0x0b 0x0d 0x14
1035 // Step 7: First child ("v\_")
1036     // Step 3: 'D' \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
1037     0x44 0x0d
1038     // Step 4: 'A' \livelink{chap:DWATname}{DW\-\_AT\-\_name} \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} "v\_"
1039     0x41 0x03 0x08 0x76 0x5f 0x00
1040     // Step 4: 'A' \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} \livelink{chap:DWACCESSprivate}{DW\-\_ACCESS\-\_private}
1041     0x41 0x32 0x0d 0x03
1042     // Step 4: 'A' \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} 0
1043     0x41 0x38 0x0d 0x00
1044     // Step 6: 'T' \livelink{chap:DWATtype}{DW\-\_AT\-\_type} (type \#2)
1045     0x54 0x49
1046         // Step 3: 'D' \livelink{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type}
1047         0x44 0x24
1048         // Step 4: 'A' \livelink{chap:DWATname}{DW\-\_AT\-\_name} \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} "int"
1049         0x41 0x03 0x08 0x69 0x6e 0x74 0x00
1050         // Step 4: 'A' \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} 4
1051         0x41 0x0b 0x0d 0x04
1052         // Step 4: 'A' \livelink{chap:DWATencoding}{DW\-\_AT\-\_encoding} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} \livelink{chap:DWATEsigned}{DW\-\_ATE\-\_signed}
1053         0x41 0x3e 0x0d 0x05
1054         // Step 7: End of \livelink{chap:DWTAGbasetype}{DW\-\_TAG\-\_base\-\_type} "int"
1055         0x00
1056     // Step 7: End of \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member} "v\_"
1057     0x00
1058 // Step 7: Second child ("next")
1059     // Step 3: 'D' \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
1060     0x44 0x0d
1061     // Step 4: 'A' \livelink{chap:DWATname}{DW\-\_AT\-\_name} \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} "next"
1062     0x41 0x03 0x08 0x6e 0x65 0x78 0x74 0x00
1063     // Step 4: 'A' \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} \livelink{chap:DWACCESSprivate}{DW\-\_ACCESS\-\_private}
1064     0x41 0x32 0x0d 0x03
1065     // Step 4: 'A' \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} 4
1066     0x41 0x38 0x0d 0x04
1067     // Step 6: 'T' \livelink{chap:DWATtype}{DW\-\_AT\-\_type} (type \#3)
1068     0x54 0x49
1069         // Step 3: 'D' \livelink{chap:DWTAGpointertype}{DW\-\_TAG\-\_pointer\-\_type}
1070         0x44 0x0f
1071         // Step 5: 'N' \livelink{chap:DWATtype}{DW\-\_AT\-\_type}
1072         0x4e 0x49
1073         // Step 5: 'C' \livelink{chap:DWTAGnamespace}{DW\-\_TAG\-\_namespace} "N" 'E'
1074         0x43 0x39 0x4e 0x00 0x45
1075         // Step 5: "A"
1076         0x41 0x00
1077         // Step 7: End of \livelink{chap:DWTAGpointertype}{DW\-\_TAG\-\_pointer\-\_type}
1078         0x00
1079     // Step 7: End of \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member} "next"
1080     0x00
1081 // Step 7: Third child ("bp")
1082     // Step 3: 'D' \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
1083     0x44 0x0d
1084     // Step 4: 'A' \livelink{chap:DWATname}{DW\-\_AT\-\_name} \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} "bp"
1085     0x41 0x03 0x08 0x62 0x70 0x00
1086     // Step 4: 'A' \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} \livelink{chap:DWACCESSprivate}{DW\-\_ACCESS\-\_private}
1087     0x41 0x32 0x0d 0x03
1088     // Step 4: 'A' \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} 8
1089     0x41 0x38 0x0d 0x08
1090     // Step 6: 'T' \livelink{chap:DWATtype}{DW\-\_AT\-\_type} (type \#4)
1091     0x54 0x49
1092         // Step 3: 'D' \livelink{chap:DWTAGpointertype}{DW\-\_TAG\-\_pointer\-\_type}
1093 0x44 0x0f
1094         // Step 5: 'N' \livelink{chap:DWATtype}{DW\-\_AT\-\_type}
1095         0x4e 0x49
1096         // Step 5: 'C' \livelink{chap:DWTAGnamespace}{DW\-\_TAG\-\_namespace} "N" 'E'
1097         0x43 0x39 0x4e 0x00 0x45
1098         // Step 5: "B"
1099         0x42 0x00
1100         // Step 7: End of \livelink{chap:DWTAGpointertype}{DW\-\_TAG\-\_pointer\-\_type}
1101         0x00
1102     // Step 7: End of \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member} "next"
1103     0x00
1104 // Step 7: Fourth child ("c")
1105     // Step 3: 'D' \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
1106     0x44 0x0d
1107     // Step 4: 'A' \livelink{chap:DWATname}{DW\-\_AT\-\_name} \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} "c"
1108     0x41 0x03 0x08 0x63 0x00
1109     // Step 4: 'A' \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} \livelink{chap:DWACCESSprivate}{DW\-\_ACCESS\-\_private}
1110     0x41 0x32 0x0d 0x03
1111     // Step 4: 'A' \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} 12
1112     0x41 0x38 0x0d 0x0c
1113     // Step 6: 'T' \livelink{chap:DWATtype}{DW\-\_AT\-\_type} (type \#5)
1114     0x54 0x49
1115         // Step 2: 'C' \livelink{chap:DWTAGnamespace}{DW\-\_TAG\-\_namespace} "N"
1116         0x43 0x39 0x4e 0x00
1117         // Step 3: 'D' \livelink{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type}
1118         0x44 0x13
1119         // Step 4: 'A' \livelink{chap:DWATname}{DW\-\_AT\-\_name} \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} "C"
1120         0x41 0x03 0x08 0x43 0x00
1121         // Step 4: 'A' \livelink{chap:DWATbytesize}{DW\-\_AT\-\_byte\-\_size} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} 8
1122         0x41 0x0b 0x0d 0x08
1123         // Step 7: First child ("x")
1124             // Step 3: 'D' \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
1125             0x44 0x0d
1126             // Step 4: 'A' \livelink{chap:DWATname}{DW\-\_AT\-\_name} \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} "x"
1127             0x41 0x03 0x08 0x78 0x00
1128             // Step 4: 'A' \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} 0
1129             0x41 0x38 0x0d 0x00
1130             // Step 6: 'R' \livelink{chap:DWATtype}{DW\-\_AT\-\_type} (type \#2)
1131             0x52 0x49 0x02
1132             // Step 7: End of \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member} "x"
1133             0x00
1134         // Step 7: Second child ("y")
1135             // Step 3: 'D' \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member}
1136             0x44 0x0d
1137             // Step 4: 'A' \livelink{chap:DWATname}{DW\-\_AT\-\_name} \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} "y"
1138             0x41 0x03 0x08 0x79 0x00
1139             // Step 4: 'A' \livelink{chap:DWATdatamemberlocation}{DW\-\_AT\-\_data\-\_member\-\_location} \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} 4
1140             0x41 0x38 0x0d 0x04
1141             // Step 6: 'R' \livelink{chap:DWATtype}{DW\-\_AT\-\_type} (type \#2)
1142             0x52 0x49 0x02
1143             // Step 7: End of \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member} "y"
1144             0x00
1145         // Step 7: End of \livelink{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type} "C"
1146         0x00
1147     // Step 7: End of \livelink{chap:DWTAGmember}{DW\-\_TAG\-\_member} "c"
1148     0x00
1149 // Step 7: Fifth child ("A")
1150     // Step 3: 'S' \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram} "A"
1151     0x53 0x2e 0x41 0x00
1152 // Step 7: Sixth child ("v")
1153     // Step 3: 'S' \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram} "v"
1154     0x53 0x2e 0x76 0x00
1155 // Step 7: End of \livelink{chap:DWTAGstructuretype}{DW\-\_TAG\-\_structure\-\_type} "A"
1156 0x00
1157 \end{alltt}
1158
1159 Running an \addtoindex{MD5 hash} over this byte stream, and taking the
1160 low-order 64 bits, yields the final signature: 0xd6d160f5
1161 5589f6e9.
1162
1163
1164 A source file that includes this header file may declare a
1165 variable of type N::A, and its DWARF information may look
1166 that shown in 
1167 Section \refersec{app:typesignatureexampleusage}.
1168
1169
1170 \subsubsection{Type signature example usage}
1171 \label{app:typesignatureexampleusage}
1172
1173 \begin{alltt}
1174   \livelink{chap:DWTAGcompileunit}{DW\-\_TAG\-\_compile\-\_unit}
1175   ...
1176   \livelink{chap:DWTAGsubprogram}{DW\-\_TAG\-\_subprogram}
1177     ...
1178     \livelink{chap:DWTAGvariable}{DW\-\_TAG\-\_variable}
1179       \livelink{chap:DWATname}{DW\-\_AT\-\_name} : "a"
1180       \livelink{chap:DWATtype}{DW\-\_AT\-\_type} : (signature) 0xd6d160f5 5589f6e9
1181       \livelink{chap:DWATlocation}{DW\-\_AT\-\_location} : ...
1182     ...
1183 \end{alltt}
1184
1185 \subsection{Type Signature Computation Grammar}
1186 \label{app:typesignaturecomputationgrammar}
1187
1188 This section
1189 \addtoindexx{type signature!computation grammar}
1190 presents a semi-formal grammar that may aid in understanding
1191 how the bytes of the flattened type description are formed
1192 during the type signature computation algorithm of Section
1193 Section \refersec{datarep:typesignaturecomputation}. 
1194
1195 %FIXME: The index entries here with \addtoindexx are ineffective.
1196 \begin{alltt}
1197 signature
1198     : opt-context debug-entry attributes children
1199
1200 opt-context           // Step 2
1201     : 'C' tag-code string opt-context
1202     : empty
1203
1204 debug-entry           // Step 3
1205     : 'D' tag-code
1206
1207 attributes            // Steps 4, 5, 6
1208     : attribute attributes
1209     : empty
1210
1211 attribute
1212     : 'A' at-code form-encoded-value     // Normal attributes
1213     : 'N' at-code opt-context 'E' string // Reference to type
1214                                          // by name
1215     : 'R' at-code back-ref               // Back-reference 
1216                                          // to visited type
1217     : 'T' at-code signature              // Recursive type
1218 children             //  Step 7
1219     : child children
1220     : '0'
1221
1222 child
1223     : 'S' tag-code string
1224     : signature
1225 tag-code
1226     : <ULEB128>
1227 at-code
1228     : <ULEB128>
1229 form-encoded-value
1230     : \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} value \addtoindexx{constant class}
1231     : \livelink{chap:DWFORMflag}{DW\-\_FORM\-\_flag} value \addtoindexx{flag class}
1232     : \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} string \addtoindexx{string class}
1233     : \livelink{chap:DWFORMblock}{DW\-\_FORM\-\_block} \nolink{block} \addtoindexx{block class}
1234 \livelink{chap:DWFORMstring}{DW\-\_FORM\-\_string} \addtoindexx{string class}
1235     : 'x08'
1236 \livelink{chap:DWFORMblock}{DW\-\_FORM\-\_block}  \addtoindexx{block class}
1237     : 'x09'
1238 \livelink{chap:DWFORMflag}{DW\-\_FORM\-\_flag} \addtoindexx{flag class}
1239     : 'x0c'
1240 \livelink{chap:DWFORMsdata}{DW\-\_FORM\-\_sdata} \addtoindexx{constant class}
1241     : 'x0d'
1242 value
1243     : <SLEB128>
1244 \nolink{block}
1245     : <ULEB128> <fixed-length-block>
1246                       // The ULEB128 gives the length of the \nolink{block}
1247 back-ref
1248     : <ULEB128>
1249 string
1250     : <null-terminated-string>
1251 empty
1252     :
1253 \end{alltt}
1254
1255
1256 \section{Summary of Compression Techniques}
1257 \label{app:summaryofcompressiontechniques}
1258 \subsection{\#include compression}
1259 \label{app:includecompression}
1260
1261 \addtoindex{C++} has a much greater 
1262 problem than 
1263 \addtoindex{C} with the number and
1264 size of the headers included and the amount of data in each,
1265 but even with \addtoindex{C} 
1266 there is substantial header file information
1267 duplication.
1268
1269 A reasonable approach is to put each header file in its own
1270 \addtoindex{section group}, using the naming rules mentioned above. The
1271 section groups are marked to ensure duplicate removal.
1272
1273 All data instances and code instances (even if they came
1274 from the header files above) are put 
1275 \addtoindexx{section group}
1276 into non-section group
1277 sections such as the base object file 
1278 \addtoindex{.debug\_info} section.
1279
1280 \subsection{Eliminating function duplication}
1281 \label{app:eliminatingfunctionduplication}
1282
1283
1284 Function templates (C++) result in code for the same template
1285 instantiation being compiled into multiple archives or
1286 relocatable objects. The linker wants to keep only one of a
1287 given entity. The DWARF description, and everything else for
1288 this function, should be reduced to just a single copy.
1289
1290 For each such code group (function template in this example)
1291 the compiler assigns a name for the group which will match
1292 all other instantiations of this function but match nothing
1293 else. 
1294 The 
1295 \addtoindexx{section group}
1296 section groups are marked to ensure duplicate
1297 removal, so that the second and subsequent definitions seen
1298 by the static linker are simply discarded.
1299
1300
1301 References to other 
1302 \addtoindex{.debug\_info} sections follow the approach
1303 suggested above, but the naming rule might be slightly
1304 different in that the 
1305 \begin{alltt}
1306 <file-designator> 
1307 \end{alltt}
1308 should be interpreted
1309 as a 
1310 \begin{alltt}
1311 <function-designator>.
1312 \end{alltt}
1313
1314
1315
1316 \subsection{Single-function-per-DWARF-compilation-unit}
1317 \label{app:singlefunctionperdwarfcompilationunit}
1318
1319 Section groups can help make it easy for a linker to completely
1320 remove unused functions.
1321
1322 Such 
1323 \addtoindexx{section group}
1324 section groups are not marked for duplicate removal,
1325 since the functions are not duplicates of anything.
1326
1327 Each function is given a compilation unit and a section
1328 group. Each such compilation unit is complete, with its own
1329 text, data, and DWARF sections.
1330
1331 There will also be a compilation unit that has the file\dash level
1332 declarations and definitions. Other per\dash function compilation
1333 unit DWARF information (
1334 \addtoindex{.debug\_info}) points to this common
1335 file\dash level compilation unit using \livelink{chap:DWTAGimportedunit}{DW\-\_TAG\-\_imported\-\_unit}.
1336
1337 Section groups can use \livelink{chap:DWFORMrefaddr}{DW\-\_FORM\-\_ref\-\_addr} and internal labels
1338 (section\dash relative relocations) to refer to the main object
1339 file sections, as the 
1340 \addtoindexx{section group}
1341 section groups here are either deleted
1342 as unused or kept. There is no possibility (aside from error)
1343 of a group from some other compilation being used in place
1344 of one of these groups.
1345
1346
1347 \subsection{Inlining and out-of-line-instances}
1348 \label{app:inliningandoutoflineinstances}
1349
1350 Abstract instances
1351 \addtoindexx{abstract instance}
1352 \addtoindexx{concrete out-of-line instance}
1353 and concrete-out-of-line instances may be
1354 put in distinct compilation units using 
1355 \addtoindexx{section group}
1356 section groups. 
1357 This
1358 makes possible some useful duplicate DWARF elimination.
1359
1360 \textit{No special provision for eliminating class duplication
1361 resulting from template instantiation is made here, though
1362 nothing prevents eliminating such duplicates using section
1363 groups.}
1364
1365
1366 \subsection{Separate Type Units}
1367 \label{app:separatetypeunits}
1368
1369 Each complete declaration of a globally-visible type can be
1370 \addtoindexx{type unit}
1371 placed in its own separate type section, with a group key
1372 derived from the type signature. The linker can then remove
1373 all duplicate type declarations based on the key.
1374