Add split objects example in App F.2 and correct misc other
[dwarf-doc.git] / dwarf5 / latexdoc / debugsectionrelationships.tex
1 \chapter{Debug Section Relationships (Informative)}
2 \label{app:debugsectionrelationshipsinformative}
3 DWARF information is organized into multiple program sections, 
4 each of which holds a particular kind of information. In some 
5 cases, information in one section refers to information in one 
6 or more of the others. These relationships are illustrated by 
7 the diagram and associated notes on the following pages.
8
9 \textit{This diagram does not distinguish between the normal
10 and split object section pairs (for example, \dotdebuginfo{} 
11 versus \dotdebuginfodwo). Similarly, it does not show the 
12 relationship between the main debugging sections of an executable
13 or sharable file and a related \addtoindex{supplementary object file}.}
14
15 \begin{landscape}
16 \begin{figure}
17 \scriptsize
18 \begin{tikzpicture}
19     [sect/.style={rectangle, rounded corners=10pt, draw, fill=blue!15, 
20         inner sep=.2cm, minimum width=4.0cm},
21          link/.style={rectangle,                       draw,
22         inner sep=.2cm, minimum width=4.5cm}]
23
24 % The first (leftmost) column, first sections, then links, from top to bottom
25 %
26 \node(zsectara) at ( 0, 15.0) [sect] {\dotdebugaranges};
27 \node(zlinka)   at ( 0, 13.5) [link] {To compilation unit~~(a)};
28 \node(zsectinf) at ( 0,  7.5) [sect] {\begin{tabular}{c} 
29                                       \dotdebuginfo 
30                                       \end{tabular}};
31 \node(zlinkb)   at ( 0,  1.5) [link] {To compilation unit~~(b)};
32 \node(zsectpub) at ( 0,  0.0) [sect] {\begin{tabular}{c} 
33                                       \dotdebugpubnames \\ 
34                                       \dotdebugpubtypes 
35                                       \end{tabular}};
36
37 \draw[thick,-to reversed]               (zlinka) -- (zsectara);
38 \draw[thick,angle 90-]                  (zsectinf) -- (zlinka);
39 \draw[thick,-angle 90]                  (zlinkb) -- (zsectinf);
40 \draw[thick,to reversed-]               (zsectpub) -- (zlinkb);
41
42 % The seond column, similarly
43 %
44 \node(zsectfra) at (5, 15.0)  [sect] {\dotdebugframe};
45 \node(zlinkc)   at (5, 13.5)  [link] {To abbreviations~~(c)};
46 \node(zlinkd)   at (5, 12.1)  [link] {\DWFORMstrp{}~~(d)};
47 \node(zlinke)   at (5, 10.4)  [link] {\begin{tabular}{c}
48                                       \DWATstroffsetsbase \\
49                                       \DWFORMstrx{}~~~~~~~~~(e) \\
50                                       \end{tabular}};
51 \node(zlinkf)   at (5,  8.4)  [link] {\begin{tabular}{c}
52                                       \DWOPcallref{}~~~~~(f) \\
53                                       \DWFORMrefaddr
54                                       \end{tabular}};
55 \node(zlinki)   at (5,  6.7)  [link] {\DWATmacros{}~~(g)};
56 \node(zlinkj)   at (5,  5.4)  [link] {\DWATstmtlist{}~~(h)};
57 \node(zlinkh)   at (5,  3.9)  [link] {\begin{tabular}{c}
58                                       \DWATranges{}~~~~(i) \\
59                                       \DWATrangesbase
60                                       \end{tabular}};
61 \node(zlinkg)   at (5,  2.4)  [link] {\DWATlocation{}, etc.~~(j)};
62 \node(zlinkk)   at (5,  0.5)  [link] {\begin{tabular}(c)
63                                       \DWATaddrbase    \\
64                                       \DWFORMaddrx \\
65                                       \DWOPaddrx \\
66                                       \DWOPconstx
67                                       \end{tabular} (k)};
68
69 % Links between first and second columns
70 %
71 \draw[thick,to reversed-]       (zsectinf) -- (zlinkc.west);
72 \draw[thick,to reversed-]       (zsectinf) -- (zlinkd.west);
73 \draw[thick,to reversed-]       (zsectinf) -- (zlinke.west);
74 \draw[<->,thick]                (zsectinf) -- (zlinkf.west);
75 \draw[thick,to reversed-]       (zsectinf) -- (zlinkg.west);
76 \draw[thick,to reversed-]       (zsectinf) -- (zlinkh.west);
77 \draw[thick,to reversed-]       (zsectinf) -- (zlinki.west);
78 \draw[thick,to reversed-]       (zsectinf) -- (zlinkj.west);
79 \draw[thick,to reversed-]       (zsectinf) -- (zlinkk.north west);
80
81 % The thrid column
82 %
83 \node(zsectabb) at (10, 15.00) [sect] {\dotdebugabbrev};
84 \node(zsectstr) at (10, 13.75) [sect] {\dotdebugstr};
85 \node(zlinkl)   at (10, 12.50) [link] {To strings~~(l)};
86 \node(zsectstx) at (10, 11.25) [sect] {\dotdebugstroffsets};
87 \node(zlinkm)   at (10,  9.50) [link] {\begin{tabular}{c}
88                                       \DWMACROdefineindirectx \\
89                                       \DWMACROundefindirectx \\
90                                       (m)
91                                       \end{tabular}};
92 \node(zsectmac) at (10,  7.80) [sect] {\dotdebugmacro};
93 \node(zlinkn)   at (10,  6.40) [link] {\begin{tabular}{c}
94                                       macroinfo header~~~~~~(n)\\
95                                       \DWMACROstartfile
96                                       \end{tabular}};
97 \node(zsectlin) at (10,  5.00) [sect] {\dotdebugline};
98 \node(zsectran) at (10,  3.85) [sect] {\dotdebugranges};
99 \node(zsectloc) at (10,  2.70) [sect] {\dotdebugloc{}};
100 \node(zlinko)   at (10,  1.20) [link] {\begin{tabular}{c}
101                                        \DWOPaddrx \\
102                                        \DWOPconstx
103                                        \end{tabular} (o)};
104 \node(zsectadx) at (10,  -0.25) [sect] {\dotdebugaddr{}};
105
106 \draw[thick,to reversed-]       (zsectstx) -- (zlinkl);
107 \draw[thick,-angle 90]          (zlinkl) -- (zsectstr);
108 \draw[thick,to reversed-]       (zsectmac) -- (zlinkm);
109 \draw[thick,-angle 90]          (zlinkm) -- (zsectstx);
110 \draw[thick,to reversed-]       (zsectmac) -- (zlinkn);
111 \draw[thick,-angle 90]          (zlinkn) -- (zsectlin);
112 \draw[thick,to reversed-]       (zsectloc) -- (zlinko);
113 \draw[thick,-angle 90]          (zlinko) -- (zsectadx);
114
115 % Links between second and third colums
116 %
117 \draw[thick,-angle 90]          (zlinkc.east) -- (zsectabb.west);
118 \draw[thick,-angle 90]          (zlinkd.east) -- (zsectstr.west);
119 \draw[thick,-angle 90]          (zlinke.east) -- (zsectstx.west);
120 \draw[thick,-angle 90]          (zlinkg.east) -- (zsectloc.west);
121 \draw[thick,-angle 90]          (zlinkh.east) -- (zsectran.west);
122 \draw[thick,-angle 90]          (zlinki.east) -- (zsectmac.west);
123 \draw[thick,-angle 90]          (zlinkj.east) -- (zsectlin.west);
124 \draw[thick,-angle 90]          (zlinkk.east) -- (zsectadx.west);
125
126 % The fourth column
127 %
128 \node(zlinky)   at (15.6, 10.5) [link] {\begin{tabular}{c}
129                                         \DWMACROdefineindirect \\
130                                         \DWMACROundefindirect \\
131                                         (p)
132                                         \end{tabular}};
133 \node(zlinkz)   at (15.6,  6.0) [link] {\begin{tabular}{c}
134                                         \DWMACROtransparentinclude \\
135                                         (q)
136                                         \end{tabular}};
137 \node(zlinkx)   at (15.6,  3.8) [link]  {\DWFORMlinestrp~(r)};
138 \node(zsectlns) at (15.6,  2.0) [sect]  {\dotdebuglinestr};
139                                         
140 \draw[thick,to reversed-]       (zsectmac.east) -- (zlinky);
141 \draw[thick,-angle 90]          (zlinky) -- (zsectstr.east);
142 \draw[<->,thick]                (zsectmac.east) -- (zlinkz);
143 \draw[thick,to reversed-]       (zsectlin.east) -- (zlinkx);
144 \draw[thick, -angle 90]         (zlinkx) -- (zsectlns);
145 \end{tikzpicture}
146 \vspace{5mm}
147 \caption{Debug section relationships}
148 \label{fig:debugsectionrelationships}
149 \end{figure}
150 \end{landscape}
151
152 \clearpage
153 \begin{center}
154    \textbf{Notes}
155 \end{center}
156 \begin{enumerate}[(a)]  
157 \item  \dotdebugaranges{} to \dotdebuginfo \\
158 The \texttt{debug\_info\_offset} value in
159 the header is
160 the offset in the \dotdebuginfo{} section of the
161 corresponding compilation unit header (not the compilation
162 unit entry).
163
164 %b
165 \item \dotdebugpubnames{} and \dotdebugpubtypes{} to \dotdebuginfo \\
166 The \texttt{debug\_info\_offset} value in the header is the offset in the
167 \dotdebuginfo{} section of the 
168 corresponding compilation unit header (not
169 the compilation unit entry). Each pubname/pubtype unit has the offset (within
170 the corresponding compilation unit) of the applicable debugging
171 information entry.
172
173 %c
174 \item \dotdebuginfo{} to \dotdebugabbrev \\
175 The \texttt{debug\_abbrev\_offset} value in the header is the offset in the
176 \dotdebugabbrev{} 
177 section of the abbreviations for that compilation unit.
178
179 %d
180 \item  \dotdebuginfo{} to \dotdebugstr \\
181 Attribute values of class string may have form 
182 \DWFORMstrp, whose
183 value is the offset in the \dotdebugstr{}
184 section of the corresponding string.
185
186 %e
187 \item \dotdebugstroffsets{} to \dotdebugstroffsets \\
188 The value of the \DWATstroffsetsbase{} attribute in a
189 \DWTAGcompileunit{}, \DWTAGtypeunit{} or \DWTAGpartialunit{} 
190 DIE is the offset in the
191 \dotdebugstroffsets{} section of the 
192 \addtoindex{string offsets table}
193 for that unit.
194 In addition, attribute values of class string may have form 
195 \DWFORMstrx, whose value is an index into the
196 string offsets table.
197
198 %f
199 \item \dotdebuginfo{} to \dotdebuginfo \\
200 The operand of the \DWOPcallref{} 
201 DWARF expression operator is the
202 offset of a debugging information entry in the 
203 \dotdebuginfo{} section of another compilation.
204 Similarly for attribute operands that have use
205 \DWFORMrefaddr.
206
207 %g
208 \item \dotdebuginfo{} to \dotdebugmacro \\
209 An attribute value of class 
210 \livelink{chap:classmacptr}{macptr} (specifically form
211 \DWFORMsecoffset) is an 
212 offset within the 
213 \dotdebugmacro{} section
214 of the beginning of the macro information for the referencing unit.
215
216 %h
217 \item \dotdebuginfo{} to \dotdebugline \\
218 An attribute value of class 
219 \livelink{chap:classlineptr}{lineptr} (specifically form
220 \DWFORMsecoffset) 
221 is an offset in the 
222 \dotdebugline{} section of the
223 beginning of the line number information for the referencing unit.
224
225 %i
226 \needlines{5}
227 \item \dotdebuginfo{} to \dotdebugranges \\
228 An attribute value of class \livelink{chap:classrangelistptr}{rangelistptr} 
229 (specifically form
230 \DWFORMsecoffset) 
231 is an offset within the \dotdebugranges{} section of
232 a range list.
233
234 %j
235 \item \dotdebuginfo{} to \dotdebugloc \\
236 An attribute value of class \livelink{chap:classloclistptr}{loclistptr} 
237 (specifically form
238 \DWFORMsecoffset) 
239 is an offset within the \dotdebugloc{} 
240 section of a
241 \addtoindex{location list}.
242
243 %k
244 \item \dotdebuginfo{} to \dotdebugaddr \\
245 The value of the \DWATaddrbase{} attribute in the
246 \DWTAGcompileunit{}, \DWTAGtypeunit{} or \DWTAGpartialunit{} DIE is the
247 offset in the \dotdebugaddr{} section of the machine
248 addresses for that unit.
249 \DWFORMaddrx, \DWOPaddrx{} and \DWOPconstx{} contain
250 indices relative to that offset.
251
252 %l
253 \item \dotdebugstroffsets{} to \dotdebugstr \\
254 Entries in the string offsets table
255 are offsets to the corresponding string text in the 
256 \dotdebugstr{} section.
257
258 %m
259 \item \dotdebugmacro{} to \dotdebugstroffsets \\
260 The second operand of a 
261 \DWMACROdefineindirect{} or \DWMACROundefindirect{} macro information
262 entry is an index into the string table in the 
263 \dotdebugstr{} section.
264
265
266 %n
267 \item \dotdebugmacro{} to \dotdebugline \\
268 The second operand of 
269 \DWMACROstartfile{} refers to a file entry in the 
270 \dotdebugline{} section relative to the start 
271 of that section given in the macro information header.
272
273 %o
274 \item \dotdebugloc{} to \dotdebugaddr \\
275 \DWOPaddrx{} and \DWOPconstx{} operators that occur in the 
276 \dotdebugloc{} section refer indirectly to the 
277 \dotdebugaddr{} section by way of the 
278 \DWATaddrbase{} attribute in the associated \dotdebuginfo{} 
279 section. 
280
281 %p
282 \item \dotdebugmacro{} to \dotdebugstroffsets \\
283 The second operand of a 
284 \DWMACROdefineindirectx{} or \DWMACROundefindirectx{} 
285 macro information entry is an index
286 into the string offset table in the 
287 \dotdebugstroffsets{} section.
288
289 %q
290 \needlines{4}
291 \item \dotdebugmacro{} to \dotdebugmacro \\
292 The second operand of a 
293 \DWMACROtransparentinclude{} macro information
294 entry is an offset into another part of the 
295 \dotdebugmacro{} section to the header for the 
296 sequence to be transparently included.
297
298 %r
299 \needlines{4}
300 \item \dotdebugline{} to \dotdebuglinestr \\
301 The value of a \DWFORMlinestrp{} form refers to a
302 string section specific to the line number table.
303 This form can be used in a \dotdebugline{} section
304 (as shown) or in a \dotdebuginfo{} section (not shown).
305
306 \end{enumerate}