Posted a review document this date. Includes all issues and
[dwarf-doc.git] / dwarf5 / latexdoc / splitobjects.tex
1 \chapter[Split DWARF Objects (Informative)]{Split DWARF Objects (Informative)}
2 \label{app:splitdwarfobjectsinformative}
3
4 With the traditional DWARF format, debug information is designed
5 with the expectation that it will be processed by the linker to
6 produce an output binary with complete debug information, and
7 with fully-resolved references to locations within the
8 application. For very large applications, however, this approach
9 can result in excessively large link times and excessively large
10 output files. 
11
12 Several vendors have independently developed
13 proprietary approaches that allow the debug information to remain
14 in the relocatable object files, so that the linker does not have
15 to process the debug information or copy it to the output file.
16 These approaches have all required that additional information be
17 made available to the debug information consumer, and that the
18 consumer perform some minimal amount of relocation in order to
19 interpret the debug info correctly. The additional information
20 required, in the form of load maps or symbol tables, and the
21 details of the relocation are not covered by the DWARF
22 specification, and vary with each vendor's implementation.
23
24 These limitations are removed by the design described here.
25
26 \section{Overview}
27 \label{app:splitoverview}
28 \DWARFVersionV{} introduces an optional set of debugging sections
29 that allow the compiler to partition the debugging information
30 into a set of (small) sections that require link-time relocation
31 and a set of (large) sections that do not. The sections that
32 require relocation are written to the relocatable object file as
33 usual, and are linked into the final executable. The sections
34 that do not require relocation, however, can be written to the
35 relocatable object (.o) file but ignored by the linker, or they
36 can be written to a separate DWARF object (dwo{}) file.
37
38 \needlines{4}
39 The optional set of debugging sections includes the following:
40 \begin{itemize}
41 \item
42 \dotdebuginfodwo{} - Contains the \DWTAGcompileunit{} and
43 \DWTAGtypeunit{} DIEs and
44 their descendants. This is the bulk of the debugging
45 information for the compilation unit that is normally found
46 in the \dotdebuginfo{} section.
47 \item
48 \dotdebugabbrevdwo{} - Contains the abbreviations tables used by
49 the \dotdebuginfodwo{} sections.
50 \item
51 \dotdebuglocdwo{} - Contains the location lists referenced by
52 the debugging information entries in the \dotdebuginfodwo{}
53 section. This contains the location lists normally found in 
54 the \dotdebugloc{} section,
55 with a slightly modified format to eliminate the need for
56 relocations.
57 \item
58 \dotdebugstrdwo{} - Contains the string table for all indirect
59 strings referenced by the debugging information in the
60 \dotdebuginfodwo{} sections.
61 \item
62 \dotdebugstroffsetsdwo{} - Contains the string offsets table
63 for the strings in the \dotdebugstrdwo{}{} section.
64 \item
65 \dotdebugmacrodwo{} - Contains macro definition information,
66 normally found in the \dotdebugmacro{} section.
67 \item
68 \dotdebuglinedwo{} - Contains skeleton line tables for the type
69 units in the \dotdebuginfodwo{} section. These line tables
70 contain only the directory and files lists needed to
71 interpret \DWATdeclfile{} attributes in the debugging
72 information entries. Actual line number tables remain in the
73 \dotdebugline{} section, and remain in the relocatable object
74 (.o) files.
75 \end{itemize}
76
77 In order for the consumer to locate and process the debug
78 information, the compiler must produce a small amount of debug
79 information that passes through the linker into the output
80 binary. A skeleton \dotdebuginfo{} section for each compilation unit
81 contains a reference to the corresponding ".o" or ".dwo"
82 file, and the \dotdebugline{} section (which is typically small
83 compared to the \dotdebuginfo{} sections) is
84 linked into the output binary, as is the new \dotdebugaddr{}
85 section.
86
87 \needlines{6}
88 The debug sections that continue to be linked into the
89 output binary include the following:
90 \begin{itemize}
91 \item
92 \dotdebugabbrev{} - Contains the abbreviation codes used by the
93 skeleton \dotdebuginfo{} section.
94 \item
95 \dotdebuginfo{} - Contains a skeleton \DWTAGcompileunit{} DIE,
96 but no children.
97 \item
98 \dotdebugstr{} - Contains any strings referenced by the skeleton
99 \dotdebuginfo{} sections (via \DWFORMstrp{} or \DWFORMstrx{}).
100 \item
101 \dotdebugstroffsets{} - Contains the string offsets table for
102 the strings in the \dotdebugstr{} section.
103 \item
104 \dotdebugaddr{} - Contains references to loadable sections,
105 indexed by attributes of form \DWFORMaddrx{} or location
106 expression \DWOPaddrx{} opcodes.
107 \item
108 \dotdebugline{} - Contains the line number tables, unaffected by
109 this design. (These could be moved to the .dwo file, but in
110 order to do so, each \DWLNEsetaddress{} opcode would need to
111 be replaced by a new opcode that referenced an entry in the
112 \dotdebugaddr{} section. Furthermore, leaving this section in the
113 .o file allows many debug info consumers to remain unaware of
114 .dwo files.)
115 \item
116 \dotdebugframe{} - Contains the frame tables, unaffected by this
117 design.
118 \item
119 \dotdebugranges{} - Contains the range lists, unaffected by this
120 design.
121 \item
122 \dotdebugpubnames{} - Contains the public names for use in
123 building an index section. This section has the same
124 format and use as always. The section header refers to a
125 compilation unit offset, which is the offset of the
126 skeleton compilation unit in the \dotdebuginfo{} section.
127 \item
128 \dotdebugpubtypes{} - Contains the public types for use in
129 building an index section. This section has the same
130 format and use as always. The section header refers to a
131 compilation unit offset, which is the offset of the
132 skeleton compilation unit in the \dotdebuginfo{} section.
133 \item
134 \dotdebugaranges{} - Contains the accelerated range lookup table
135 for the compilation unit, unaffected by this design.
136 \end{itemize}
137
138 \needlines{6}
139 The skeleton \DWTAGcompileunit{} DIE has the following attributes:
140 \autocols[0pt]{c}{3}{l}{
141 \DWATaddrbase{},
142 \DWATcompdir{},
143 \DWATdwoname{},
144 \DWATdwoid{},
145 \DWAThighpc{} \dag,
146 \DWATlowpc{} \dag,
147 \DWATranges{} \dag,
148 \DWATrangesbase{},
149 \DWATstmtlist{},
150 \DWATstroffsetsbase{}
151 }
152 \dag{} If \DWATranges{} is present, \DWATlowpc{} and \DWAThighpc{} are
153 not used, and vice versa.
154
155 All other attributes of the compilation unit DIE are moved to
156 the full DIE in the \dotdebuginfodwo{} section.
157
158 \needlines{4}
159 Because of other improvements in \DWARFVersionV, most of the
160 relocations that would normally be found in the \dotdebuginfodwo{}
161 sections are moved to the \dotdebugaddr{} and
162 \dotdebugstroffsetsdwo{} sections. Those in the
163 \dotdebugstroffsetsdwo{} sections are simply omitted because the
164 DWARF information in those sections is not combined at link
165 time, so no relocation is necessary. Similarly,
166 many of the remaining relocations referring to range lists are
167 eliminated. 
168
169 The relocations that remain fall into the following categories:
170 \begin{itemize}
171 \item
172 References from compilation unit and type unit headers to the
173 \dotdebugabbrevdwo{} section. Because the new sections are not
174 combined at link time, these references need no relocations.
175 \item
176 References from \DWTAGcompileunit{} DIEs to the
177 \dotdebuglinedwo{} section, via \DWATstmtlist{}. This attribute
178 remains in the skeleton \dotdebuginfo{} section, so no
179 relocation in the \dotdebuginfodwo{} section is necessary.
180 \item
181 References from \DWTAGtypeunit{} DIEs to the skeleton
182 \dotdebuglinedwo{} section, via \DWATstmtlist{}. Because the new
183 sections are not combined at link time, these references need
184 no relocations.
185 \item
186 References from \DWTAGcompileunit{} and \DWTAGtypeunit{} DIEs
187 to the \dotdebugstroffsetsdwo{} section, via
188 \DWATstroffsetsbase{}. Because the new sections are not
189 combined at link time, the \DWATstroffsetsbase{} attribute
190 is not required in a \dotdebuginfodwo{}
191 section.
192 \item
193 References from \DWTAGcompileunit{} DIEs to the \dotdebugaddr{}
194 section, via \DWATaddrbase{}. This attribute remains in
195 the skeleton \dotdebuginfo{} section, so no relocation in the
196 \dotdebuginfodwo{} section is necessary.
197 \needlines{4}
198 \item
199 References from \DWTAGcompileunit{} DIEs to the \dotdebugranges{}
200 section, via \DWATrangesbase{}. This attribute remains in
201 the skeleton \dotdebuginfo{} section, so no relocation in the
202 \dotdebuginfodwo{} section is necessary.
203 \item
204 References from the \dotdebuglocdwo{} section to machine addresses
205 via a location list entry or a base address selection entry.
206 With a minor change to the location list entry format,
207 described below, these relocations are also eliminated.
208 \end{itemize}
209
210 \needlines{4}
211 Each location list entry contains beginning and ending address
212 offsets, which normally may be relocated addresses. In the
213 \dotdebuglocdwo{} section, these offsets are replaced by indices
214 into the \dotdebugaddr{} section. Each location list entry begins
215 with a single byte identifying the entry type:
216 \begin{itemize}
217 \item
218 \DWLLEendoflistentry{} (0) indicates an end-of-list entry,
219 \item
220 \DWLLEbaseaddressselectionentry{} (1) indicates a base address
221 selection entry, 
222 \item
223 \DWLLEstartendentry{} (2) indicates a normal
224 location list entry providing start and end addresses,
225 \item
226 \DWLLEstartlengthentry{} (3) indicates a normal location list
227 entry providing a start address and a length, and
228 \item
229 \DWLLEoffsetpairentry{} (4) indicates a normal location list
230 entry providing start and end offsets relative to the base
231 address. 
232 \end{itemize}
233 An end-of-list entry has no further data. A base address
234 selection entry contains a single unsigned LEB128
235 \addtoindexx{LEB128!unsigned} number
236 following the entry type byte, which is an index into the
237 \dotdebugaddr{} section that selects the new base address for
238 subsequent location list entries. A start/end entry contains two
239 unsigned LEB128\addtoindexx{LEB128!unsigned} numbers 
240 following the entry type byte, which are
241 indices into the \dotdebugaddr{} section that select the beginning
242 and ending addresses. A start/length entry contains one unsigned
243 LEB128 number and a 4-byte unsigned value (as would be
244 represented by the form code \DWFORMdatafour). The first number
245 is an index into the \dotdebugaddr{} section that selects the
246 beginning offset, and the second number is the length of the
247 range. Addresses fetched from the \dotdebugaddr{} section are not
248 relative to the base address. An offset pair entry contains two
249 4-byte unsigned values (as would be represented by the form code
250 \DWFORMdatafour){}, treated as the beginning and ending offsets,
251 respectively, relative to the base address. As in the \dotdebugloc{}
252 section, the base address is obtained either from the nearest
253 preceding base address selection entry, or, if there is no such
254 entry, from the compilation unit base address (as defined in
255 Section 3.1.1). For the latter three types (start/end,
256 start/length, and offset pair), the two operand values are
257 followed by a location description as in a normal location list
258 entry in the \dotdebugloc{} section.
259
260 This design depends on having an index of debugging information
261 available to the consumer. For name lookups, the consumer can use
262 the \dotdebugpubnames{} and \dotdebugpubtypes{} sections (or an index
263 built at link time based on the information in those sections),
264 which will lead to a skeleton compilation unit. The
265 \DWATcompdir{} and \DWATdwoname{} attributes in the skeleton
266 compilation unit can then be used to locate the corresponding
267 DWARF object file for the compilation unit. Similarly, for an
268 address lookup, the consumer can use the \dotdebugaranges{} table,
269 which will also lead to a skeleton compilation unit. For a file
270 and line number lookup, the skeleton compilation units can be
271 used to locate the line number tables.
272
273 \section{Split DWARF Object Examples}
274 \label{app:splitdwarfobjectexamples}
275
276 [TBD]
277
278 \section{DWARF Package File Example}
279 \label{app:dwarfpackagefileexample}
280
281 [TBD]