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