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