Checkpoint following major upgrade of the Name index figure (Fig 6.1)
[dwarf-doc.git] / dwarf5 / latexdoc / datarepresentation.tex
1 \chapter{Data Representation}
2 \label{datarep:datarepresentation}
3
4 This section describes the binary representation of the
5 debugging information entry itself, of the attribute types
6 and of other fundamental elements described above.
7
8 \section{Vendor Extensibility}
9 \label{datarep:vendorextensibility}
10 \addtoindexx{vendor extensibility}
11 \addtoindexx{vendor specific extensions|see{vendor extensibility}}
12
13 To 
14 \addtoindexx{extensibility|see{vendor extensibility}}
15 reserve a portion of the DWARF name space and ranges of
16 enumeration values for use for vendor specific extensions,
17 special labels are reserved for tag names, attribute names,
18 base type encodings, location operations, language names,
19 calling conventions and call frame instructions.
20
21 The labels denoting the beginning and end of the reserved
22 \hypertarget{chap:DWXXXlohiuser}{}
23 value range for vendor specific extensions consist of the
24 appropriate prefix 
25 (\DWATlouserMARK{}\DWAThiuserMARK{}     DW\_AT,
26 \DWATElouserMARK{}\DWATEhiuserMARK{}    DW\_ATE, 
27 \DWCClouserMARK{}\DWCChiuserMARK{}      DW\_CC,
28 \DWCFAlouserMARK{}\DWCFAhiuserMARK{}    DW\_CFA 
29 \DWENDlouserMARK{}\DWENDhiuserMARK{}    DW\_END, 
30 \DWLANGlouserMARK{}\DWLANGhiuserMARK{}  DW\_LANG, 
31 \DWLNElouserMARK{}\DWLNEhiuserMARK{}    DW\_LNE, 
32 \DWMACROlouserMARK{}\DWMACROhiuserMARK{}DW\_MACRO,
33 \DWOPlouserMARK{}\DWOPhiuserMARK{}      DW\_OP or
34 \DWTAGlouserMARK{}\DWTAGhiuserMARK{}    DW\_TAG, 
35 respectively) followed by
36 \_lo\_user or \_hi\_user. 
37 Values in the  range between \textit{prefix}\_lo\_user 
38 and \textit{prefix}\_hi\_user inclusive,
39 are reserved for vendor specific extensions. Vendors may
40 use values in this range without conflicting with current or
41 future system\dash defined values. All other values are reserved
42 for use by the system.
43
44 \textit{For example, for DIE tags, the special
45 labels are \DWTAGlouserNAME{} and \DWTAGhiuserNAME.}
46
47 \textit{There may also be codes for vendor specific extensions
48 between the number of standard line number opcodes and
49 the first special line number opcode. However, since the
50 number of standard opcodes varies with the DWARF version,
51 the range for extensions is also version dependent. Thus,
52 \DWLNSlouserTARG{} and 
53 \DWLNShiuserTARG{} symbols are not defined.
54 }
55
56 Vendor defined tags, attributes, base type encodings, location
57 atoms, language names, line number actions, calling conventions
58 and call frame instructions, conventionally use the form
59 \text{prefix\_vendor\_id\_name}, where 
60 \textit{vendor\_id}\addtoindexx{vendor id} is some identifying
61 character sequence chosen so as to avoid conflicts with
62 other vendors.
63
64 To ensure that extensions added by one vendor may be safely
65 ignored by consumers that do not understand those extensions,
66 the following rules must be followed:
67 \begin{enumerate}[1. ]
68
69 \item New attributes are added in such a way that a
70 debugger may recognize the format of a new attribute value
71 without knowing the content of that attribute value.
72
73 \item The semantics of any new attributes do not alter
74 the semantics of previously existing attributes.
75
76 \item The semantics of any new tags do not conflict with
77 the semantics of previously existing tags.
78
79 \item New forms of attribute value are not added.
80
81 \end{enumerate}
82
83
84 \section{Reserved Values}
85 \label{datarep:reservedvalues}
86 \subsection{Error Values}
87 \label{datarep:errorvalues}
88 \addtoindexx{reserved values!error}
89
90 As 
91 \addtoindexx{error value}
92 a convenience for consumers of DWARF information, the value
93 0 is reserved in the encodings for attribute names, attribute
94 forms, base type encodings, location operations, languages,
95 line number program opcodes, macro information entries and tag
96 names to represent an error condition or unknown value. DWARF
97 does not specify names for these reserved values, because they
98 do not represent valid encodings for the given type and do
99 not appear in DWARF debugging information.
100
101
102 \subsection{Initial Length Values}
103 \label{datarep:initiallengthvalues}
104 \addtoindexx{reserved values!initial length}
105
106 An \livetarg{datarep:initiallengthvalues}{initial length} field 
107 \addtoindexx{initial length field|see{initial length}}
108 is one of the fields that occur at the beginning 
109 of those DWARF sections that have a header
110 (\dotdebugaranges{}, 
111 \dotdebuginfo{}, 
112 \dotdebugline{} and
113 \dotdebugnames{}) or the length field
114 that occurs at the beginning of the CIE and FDE structures
115 in the \dotdebugframe{} section.
116
117 \needlines{4}
118 In an \addtoindex{initial length} field, the values \wfffffffzero through
119 \wffffffff are reserved by DWARF to indicate some form of
120 extension relative to \DWARFVersionII; such values must not
121 be interpreted as a length field. The use of one such value,
122 \xffffffff, is defined below 
123 (see Section \refersec{datarep:32bitand64bitdwarfformats}); 
124 the use of
125 the other values is reserved for possible future extensions.
126
127
128
129 \section{Relocatable, Split, Executable, Shared and Package Object Files} 
130 \label{datarep:executableobjectsandsharedobjects}
131
132 \subsection{Relocatable Object Files}
133 \label{datarep:relocatableobjectfiles}
134 A DWARF producer (for example, a compiler) typically generates its
135 debugging information as part of a relocatable object file.
136 Relocatable object files are then combined by a linker to form an
137 executable file. During the linking process, the linker resolves
138 (binds) symbolic references between the various object files, and
139 relocates the contents of each object file into a combined virtual
140 address space.
141
142 The DWARF debugging information is placed in several sections (see
143 Appendix \refersec{app:debugsectionrelationshipsinformative}), and 
144 requires an object file format capable of
145 representing these separate sections. There are symbolic references
146 between these sections, and also between the debugging information
147 sections and the other sections that contain the text and data of the
148 program itself. Many of these references require relocation, and the
149 producer must emit the relocation information appropriate to the
150 object file format and the target processor architecture. These
151 references include the following:
152
153 \begin{itemize}
154 \item The compilation unit header (see Section 
155 \refersec{datarep:unitheaders}) in the \dotdebuginfo{}
156 section contains a reference to the \dotdebugabbrev{} table. This
157 reference requires a relocation so that after linking, it refers to
158 that contribution to the combined \dotdebugabbrev{} section in the
159 executable file.
160
161 \item Debugging information entries may have attributes with the form
162 \DWFORMaddr{} (see Section \refersec{datarep:attributeencodings}). 
163 These attributes represent locations
164 within the virtual address space of the program, and require
165 relocation.
166
167 \item A DWARF expression may contain a \DWOPaddr{} (see Section 
168 \refersec{chap:literalencodings}) which contains a location within 
169 the virtual address space of the program, and require relocation.
170
171 \needlines{4}
172 \item Debugging information entries may have attributes with the form
173 \DWFORMsecoffset{} (see Section \refersec{datarep:attributeencodings}). 
174 These attributes refer to
175 debugging information in other debugging information sections within
176 the object file, and must be relocated during the linking process.
177 \par
178 However, if a \DWATrangesbase{} attribute is present, the offset in
179 a \DWATranges{} attribute (which uses form \DWFORMsecoffset) is
180 relative to the given base offset--no relocation is involved.
181
182 \item Debugging information entries may have attributes with the form
183 \DWFORMrefaddr{} (see Section \refersec{datarep:attributeencodings}). 
184 These attributes refer to
185 debugging information entries that may be outside the current
186 compilation unit. These values require both symbolic binding and
187 relocation.
188
189 \item Debugging information entries may have attributes with the form
190 \DWFORMstrp{} (see Section \refersec{datarep:attributeencodings}). 
191 These attributes refer to strings in
192 the \dotdebugstr{} section. These values require relocation.
193
194 \item Entries in the \dotdebugaddr, \dotdebugloc{}, \dotdebugranges{} 
195 and \dotdebugaranges{}
196 sections contain references to locations within the virtual address
197 space of the program, and require relocation.
198
199 \item In the \dotdebugline{} section, the operand of the \DWLNEsetaddress{}
200 opcode is a reference to a location within the virtual address space
201 of the program, and requires relocation.
202
203 \item The \dotdebugstroffsets{} section contains a list of string offsets,
204 each of which is an offset of a string in the \dotdebugstr{} section. Each
205 of these offsets requires relocation. Depending on the implementation,
206 these relocations may be implicit (that is, the producer may not need to
207 emit any explicit relocation information for these offsets).
208
209 \item The \HFNdebuginfooffset{} field in the \dotdebugaranges{} header and 
210 the list of compilation units following the \dotdebugnames{} header contain 
211 references to the \dotdebuginfo{} section.  These references require relocation 
212 so that after linking they refer to the correct contribution in the combined 
213 \dotdebuginfo{} section in the executable file.
214
215 \item Frame descriptor entries in the \dotdebugframe{} section 
216 (see Section \refersec{chap:structureofcallframeinformation}) contain an 
217 \HFNinitiallocation{} field value within the virtual address 
218 space of the program and require relocation. 
219
220 \end{itemize}
221
222 \needlines{4}
223 \textit{Note that operands of classes \CLASSblock, \CLASSconstant{} and 
224 \CLASSflag{} do not require relocation. Attribute operands that use 
225 form \DWFORMstring{} also do not require relocation. Further, 
226 attribute operands that use form
227 \DWFORMrefone, \DWFORMreftwo, \DWFORMreffour, \DWFORMrefeight, or
228 \DWFORMrefudata{} do not need relocation.}
229
230 \subsection{Split DWARF Object Files}
231 \label{datarep:splitdwarfobjectfiles}
232 \addtoindexx{split DWARF object file}
233 A DWARF producer may partition the debugging
234 information such that the majority of the debugging
235 information can remain in individual object files without
236 being processed by the linker. 
237
238 \needlines{6}
239 \subsubsection{First Partition (with Skeleton Unit)}
240 The first partition contains
241 debugging information that must still be processed by the linker,
242 and includes the following:
243 \begin{itemize}
244 \item
245 The line number tables, range tables, frame tables, and
246 accelerated access tables, in the usual sections:
247 \dotdebugline, \dotdebuglinestr, \dotdebugranges, \dotdebugframe,
248 \dotdebugnames{} and \dotdebugaranges,
249 respectively.
250 \needlines{4}
251 \item
252 An address table, in the \dotdebugaddr{} section. This table
253 contains all addresses and constants that require
254 link-time relocation, and items in the table can be
255 referenced indirectly from the debugging information via
256 the \DWFORMaddrx{} form, and by the \DWOPaddrx{} and
257 \DWOPconstx{} operators.
258 \item
259 A skeleton compilation unit, as described in Section
260 \refersec{chap:skeletoncompilationunitentries}, 
261 in the \dotdebuginfo{} section.
262 \item
263 An abbreviations table for the skeleton compilation unit,
264 in the \dotdebugabbrev{} section.
265 \item
266 A string table, in the \dotdebugstr{} section. The string
267 table is necessary only if the skeleton compilation unit
268 uses either indirect string form, \DWFORMstrp{} or
269 \DWFORMstrx.
270 \item
271 A string offsets table, in the \dotdebugstroffsets{}
272 section. The string offsets table is necessary only if
273 the skeleton compilation unit uses the \DWFORMstrx{} form.
274 \end{itemize}
275 The attributes contained in the skeleton compilation
276 unit can be used by a DWARF consumer to find the split or 
277 hybrid DWARF object file that contains the second partition.
278
279 \subsubsection{Second Partition (Unlinked or In \texttt{.dwo} File)}
280 The second partition contains the debugging information that
281 does not need to be processed by the linker. These sections
282 may be left in the object files and ignored by the linker
283 (that is, not combined and copied to the executable object file), or
284 they may be placed by the producer in a separate DWARF object
285 file. This partition includes the following:
286 \begin{itemize}
287 \item
288 The full compilation unit, in the \dotdebuginfodwo{} section.
289 \begin{itemize}
290 \item
291 The full compilation unit entry includes a \DWATdwoid{} 
292 attribute whose form and value is the same as that of the \DWATdwoid{} 
293 attribute of the associated skeleton unit.
294 \needlines{4}
295 \item
296 Attributes contained in the full compilation unit
297 may refer to machine addresses indirectly using the \DWFORMaddrx{} 
298 form, which accesses the table of addresses specified by the
299 \DWATaddrbase{} attribute in the associated skeleton unit.
300 Location expressions may similarly do so using the \DWOPaddrx{} and
301 \DWOPconstx{} operations. 
302 \item
303 \DWATranges{} attributes contained in the full compilation unit
304 may refer to range table entries with a \DWFORMsecoffset{} offset 
305 relative to the base offset specified by the \DWATrangesbase{}
306 attribute in the associated skeleton unit.
307 \end{itemize}
308 \item Separate type units, in the \dotdebuginfodwo{} section.
309
310 \item
311 Abbreviations table(s) for the compilation unit and type
312 units, in the \dotdebugabbrevdwo{} section.
313
314 \item Location lists, in the \dotdebuglocdwo{} section.
315
316 \item
317 A \addtoindex{specialized line number table} (for the type units), 
318 in the \dotdebuglinedwo{} section. This table
319 contains only the directory and filename lists needed to
320 interpret \DWATdeclfile{} attributes in the debugging
321 information entries.
322
323 \item Macro information, in the \dotdebugmacrodwo{} section.
324
325 \item A string table, in the \dotdebugstrdwo{} section.
326
327 \item A string offsets table, in the \dotdebugstroffsetsdwo{}
328 section.
329 \end{itemize}
330
331 Except where noted otherwise, all references in this document
332 to a debugging information section (for example, \dotdebuginfo),
333 applies also to the corresponding split DWARF section (for example,
334 \dotdebuginfodwo).
335
336 \needlines{4}
337 Split DWARF object files do not get linked with any other files,
338 therefore references between sections must not make use of
339 normal object file relocation information. As a result, symbolic
340 references within or between sections are not possible.
341
342 \subsection{Executable Objects}
343 \label{chap:executableobjects}
344 The relocated addresses in the debugging information for an
345 executable object are virtual addresses.
346
347 \needlines{6}
348 \subsection{Shared Object Files}
349 \label{datarep:sharedobjectfiles}
350 The relocated
351 addresses in the debugging information for a shared object file
352 are offsets relative to the start of the lowest region of
353 memory loaded from that shared object file.
354
355 \needlines{4}
356 \textit{This requirement makes the debugging information for
357 shared object files position independent.  Virtual addresses in a
358 shared object file may be calculated by adding the offset to the
359 base address at which the object file was attached. This offset
360 is available in the run\dash time linker\textquoteright s data structures.}
361
362 \subsection{DWARF Package Files}
363 \label{datarep:dwarfpackagefiles}
364 \textit{Using \splitDWARFobjectfile{s} allows the developer to compile, 
365 link, and debug an application quickly with less link-time overhead,
366 but a more convenient format is needed for saving the debug
367 information for later debugging of a deployed application. A
368 DWARF package file can be used to collect the debugging
369 information from the object (or separate DWARF object) files
370 produced during the compilation of an application.}
371
372 \textit{The package file is typically placed in the same directory as the
373 application, and is given the same name with a \doublequote{\texttt{.dwp}}
374 extension.\addtoindexx{\texttt{.dwp} file extension}}
375
376 A DWARF package file is itself an object file, using the
377 \addtoindexx{package files}
378 \addtoindexx{DWARF package files}
379 same object file format (including \byteorder) as the
380 corresponding application binary. It consists only of a file
381 header, a section table, a number of DWARF debug information
382 sections, and two index sections.
383
384 \needlines{10}
385 Each DWARF package file contains no more than one of each of the
386 following sections, copied from a set of object or DWARF object
387 files, and combined, section by section:
388 \begin{alltt}
389     \dotdebuginfodwo
390     \dotdebugabbrevdwo
391     \dotdebuglinedwo
392     \dotdebuglocdwo
393     \dotdebugstroffsetsdwo
394     \dotdebugstrdwo
395     \dotdebugmacrodwo
396 \end{alltt}
397
398 The string table section in \dotdebugstrdwo{} contains all the
399 strings referenced from DWARF attributes using the form
400 \DWFORMstrx. Any attribute in a compilation unit or a type
401 unit using this form refers to an entry in that unit's
402 contribution to the \dotdebugstroffsetsdwo{} section, which in turn
403 provides the offset of a string in the \dotdebugstrdwo{}
404 section.
405
406 The DWARF package file also contains two index sections that
407 provide a fast way to locate debug information by compilation
408 \bb
409 unit ID 
410 \eb
411 (\DWATdwoid) for compilation units, or by type
412 signature for type units:
413 \begin{alltt}
414     \dotdebugcuindex
415     \dotdebugtuindex
416 \end{alltt}
417
418 \subsubsection{The Compilation Unit (CU) Index Section}
419 The \dotdebugcuindex{} section is a hashed lookup table that maps a
420 compilation unit
421 \bb
422 ID 
423 \eb
424 to a set of contributions in the
425 various debug information sections. Each contribution is stored
426 as an offset within its corresponding section and a size.
427
428 Each \compunitset{} may contain contributions from the
429 following sections:
430 \begin{alltt}
431     \dotdebuginfodwo{} (required)
432     \dotdebugabbrevdwo{} (required)
433     \dotdebuglinedwo
434     \dotdebuglocdwo
435     \dotdebugstroffsetsdwo
436     \dotdebugmacrodwo
437 \end{alltt}
438
439 \textit{Note that a \compunitset{} is not able to represent \dotdebugmacinfo{}
440 information from \DWARFVersionIV{} or earlier formats.}
441
442 \subsubsection{The Type Unit (TU) Index Section}
443 The \dotdebugtuindex{} section is a hashed lookup table that maps a
444 type signature to a set of offsets into the various debug
445 information sections. Each contribution is stored as an offset
446 within its corresponding section and a size.
447
448 Each \typeunitset{} may contain contributions from the following
449 sections:
450 \begin{alltt}
451     \dotdebuginfodwo{} (required) 
452     \dotdebugabbrevdwo{} (required)
453     \dotdebuglinedwo
454     \dotdebugstroffsetsdwo
455 \end{alltt}
456
457 \subsubsection{Format of the CU and TU Index Sections}
458 Both index sections have the same format, and serve to map an
459 8-byte signature to a set of contributions to the debug sections.
460 Each index section begins with a header, followed by a hash table of
461 signatures, a parallel table of indexes, a table of offsets, and
462 a table of sizes. The index sections are aligned at 8-byte
463 boundaries in the DWARF package file.
464
465 \needlines{6}
466 The index section header contains the following fields:
467 \begin{enumerate}[1. ]
468 \item \texttt{version} (\HFTuhalf) \\
469 A version number
470 \addtoindexx{version number!CU index information} 
471 \addtoindexx{version number!TU index information}
472 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
473 This number is specific to the CU and TU index information
474 and is independent of the DWARF version number.
475
476 The version number is \versiondotdebugcuindex.
477
478 \item \textit{padding} (\HFTuhalf) \\
479 Reserved to DWARF (must be zero).
480
481 \item \texttt{column\_count} (\HFTuword) \\
482 The number of columns in the table of section counts that follows.
483 For brevity, the contents of this field is referred to as $C$ below.
484
485 \item \texttt{unit\_count} (\HFTuword) \\
486 The number of compilation units or type units in the index.
487 For brevity, the contents of this field is referred to as $U$ below.
488
489 \item \texttt{slot\_count} (\HFTuword) \\
490 The number of slots in the hash table.
491 For brevity, the contents of this field is referred to as $S$ below.
492
493 \end{enumerate}
494
495 \textit{We assume that $U$ and $S$ do not exceed $2^{32}$.}
496
497 The size of the hash table, $S$, must be $2^k$ such that:
498 \hspace{0.3cm}$2^k\ \ >\ \ 3*U/2$
499
500 The hash table begins at offset 16 in the section, and consists
501 of an array of $S$ 8-byte slots. Each slot contains a 64-bit
502 signature.
503 % (using the \byteorder{} of the application binary).
504
505 The parallel table of indices begins immediately after the hash table 
506 (at offset \mbox{$16 + 8 * S$} from the beginning of the section), and
507 consists of an array of $S$ 4-byte slots,
508 % (using the byte order of the application binary), 
509 corresponding 1-1 with slots in the hash
510 table. Each entry in the parallel table contains a row index into
511 the tables of offsets and sizes.
512
513 Unused slots in the hash table have 0 in both the hash table
514 entry and the parallel table entry. While 0 is a valid hash
515 value, the row index in a used slot will always be non-zero.
516
517 \bb
518 Given an 8-byte compilation unit ID
519 \eb
520 or type signature $X$,
521 an entry in the hash table is located as follows:
522 \begin{enumerate}[1. ]
523 \bb
524 \item Define $REP(X)$ to be the value of $X$ interpreted as an 
525       unsigned 64-bit integer in the target byte order.
526
527 \item Calculate a primary hash $H = REP(X)\ \&\ MASK(k)$, where
528 \eb 
529       $MASK(k)$ is a mask with the low-order $k$ bits all set to 1.
530 \bb
531 \item Calculate a secondary hash $H' = (((REP(X)>>32)\ \&\ MASK(k))\ |\ 1)$.
532 \eb
533
534 \item If the hash table entry at index $H$ matches the signature, use
535       that entry. If the hash table entry at index $H$ is unused (all
536       zeroes), terminate the search: the signature is not present
537       in the table.
538
539 \item Let $H = (H + H')\ modulo\ S$. Repeat at Step 4.
540 \end{enumerate}
541
542 Because $S > U$, and $H'$ and $S$ are relatively prime, the search is
543 guaranteed to stop at an unused slot or find the match.
544
545 \needlines{4}
546 The table of offsets begins immediately following the parallel
547 table (at offset \mbox{$16 + 12 * S$} from the beginning of the section).
548 The table is a two-dimensional array of 4-byte words, 
549 %(using the byte order of the application binary), 
550 with $C$ columns and $U + 1$
551 rows, in row-major order. Each row in the array is indexed
552 starting from 0. The first row provides a key to the columns:
553 each column in this row provides a section identifier for a debug
554 section, and the offsets in the same column of subsequent rows
555 refer to that section. The section identifiers are shown in
556 Table \referfol{tab:dwarfpackagefilesectionidentifierencodings}.
557
558 \needlines{12}
559 \begin{centering}
560 \setlength{\extrarowheight}{0.1cm}
561 \begin{longtable}{l|c|l}
562   \caption{DWARF package file section identifier \mbox{encodings}}
563   \label{tab:dwarfpackagefilesectionidentifierencodings}
564   \addtoindexx{DWARF package files!section identifier encodings} \\
565   \hline \bfseries Section identifier &\bfseries Value &\bfseries Section \\ \hline
566 \endfirsthead
567   \bfseries Section identifier &\bfseries Value &\bfseries Section\\ \hline
568 \endhead
569   \hline \emph{Continued on next page}
570 \endfoot
571   \hline
572 \endlastfoot
573 \DWSECTINFOTARG         & 1 & \dotdebuginfodwo \\
574 \textit{Reserved}       & 2 & \\
575 \DWSECTABBREVTARG       & 3 & \dotdebugabbrevdwo \\
576 \DWSECTLINETARG         & 4 & \dotdebuglinedwo \\
577 \DWSECTLOCTARG          & 5 & \dotdebuglocdwo \\
578 \DWSECTSTROFFSETSTARG   & 6 & \dotdebugstroffsetsdwo \\
579 %DWSECTMACINFO          &   & \dotdebugmacinfodwo \\
580 \DWSECTMACROTARG        & 7 & \dotdebugmacrodwo \\
581 \end{longtable}
582 \end{centering}
583
584 The offsets provided by the CU and TU index sections are the 
585 base offsets for the contributions made by each CU or TU to the
586 corresponding section in the package file. Each CU and TU header
587 contains a \HFNdebugabbrevoffset{} field, used to find the abbreviations
588 table for that CU or TU within the contribution to the
589 \dotdebugabbrevdwo{} section for that CU or TU, and are
590 interpreted as relative to the base offset given in the index
591 section. Likewise, offsets into \dotdebuglinedwo{} from
592 \DWATstmtlist{} attributes are interpreted as relative to
593 the base offset for \dotdebuglinedwo{}, and offsets into other debug
594 sections obtained from DWARF attributes are also 
595 interpreted as relative to the corresponding base offset.
596
597 The table of sizes begins immediately following the table of
598 offsets, and provides the sizes of the contributions made by each
599 CU or TU to the corresponding section in the package file. Like
600 the table of offsets, it is a two-dimensional array of 4-byte
601 words, with $C$ columns and $U$ rows, in row-major order. Each row in
602 the array is indexed starting from 1 (row 0 of the table of
603 offsets also serves as the key for the table of sizes).
604
605 \subsection{DWARF Supplementary Object Files}
606 \label{datarep:dwarfsupplemetaryobjectfiles}
607 In order to minimize the size of debugging information, it is possible
608 to move duplicate debug information entries, strings and macro entries from
609 several executables or shared object files into a separate 
610 \addtoindexi{\textit{supplementary object file}}{supplementary object file} by some
611 post-linking utility; the moved entries and strings can be then referenced
612 from the debugging information of each of those executable or shared object files.
613
614 \needlines{4}
615 A DWARF \addtoindex{supplementary object file} is itself an object file, 
616 using the same object
617 file format, \byteorder{}, and size as the corresponding application executables
618 or shared libraries. It consists only of a file header, section table, and
619 a number of DWARF debug information sections.  Both the 
620 \addtoindex{supplementary object file}
621 and all the executable or shared object files that reference entries or strings in that
622 file must contain a \dotdebugsup{} section that establishes the relationship.
623
624 The \dotdebugsup{} section contains:
625 \begin{enumerate}[1. ]
626 \item \texttt{version} (\HFTuhalf) \\
627 \addttindexx{version}
628 A 2-byte unsigned integer representing the version of the DWARF
629 information for the compilation unit (see Appendix G). The
630 value in this field is \versiondotdebugsup.
631
632 \item \texttt{is\_supplementary} (\HFTubyte) \\
633 \addttindexx{is\_supplementary}
634 A 1-byte unsigned integer, which contains the value 1 if it is
635 in the \addtoindex{supplementary object file} that other executable or 
636 shared object files refer to, or 0 if it is an executable or shared object 
637 referring to a \addtoindex{supplementary object file}.
638
639 \needlines{4}
640 \item \texttt{sup\_filename} (null terminated filename string) \\
641 \addttindexx{sup\_filename}
642 If \addttindex{is\_supplementary} is 0, this contains either an absolute 
643 filename for the \addtoindex{supplementary object file}, or a filename 
644 relative to the object file containing the \dotdebugsup{} section.  
645 If \addttindex{is\_supplementary} is 1, then \addttindex{sup\_filename}
646 is not needed and must be an empty string (a single null byte).
647
648 \needlines{4}
649 \item \texttt{sup\_checksum\_len} (unsigned LEB128) \\
650 \addttindexx{sup\_checksum\_len}
651 Length of the following \addttindex{sup\_checksum} field; 
652 his value can be 0 if no checksum is provided.
653
654
655 \item \texttt{sup\_checksum} (array of \HFTubyte) \\
656 \addttindexx{sup\_checksum}
657 Some checksum or cryptographic hash function of the \dotdebuginfo{}, 
658 \dotdebugstr{} and \dotdebugmacro{} sections of the 
659 \addtoindex{supplementary object file}, or some unique identifier
660 which the implementation can choose to verify that the supplementary 
661 section object file matches what the debug information in the executable 
662 or shared object file expects.
663 \end{enumerate}
664
665 Debug information entries that refer to an executable's or shared
666 object's addresses must \emph{not} be moved to supplementary files (the
667 addesses will likely not be the same). Similarly,
668 entries referenced from within location expressions or using loclistptr
669 form attributes must not be moved to a \addtoindex{supplementary object file}.
670
671 Executable or shared object file compilation units can use
672 \DWTAGimportedunit{} with \DWFORMrefsup{} form \DWATimport{} attribute
673 to import entries from the \addtoindex{supplementary object file}, other \DWFORMrefsup{}
674 attributes to refer to them and \DWFORMstrpsup{} form attributes to
675 refer to strings that are used by debug information of multiple
676 executables or shared object files.  Within the \addtoindex{supplementary object file}'s
677 debugging sections, form \DWFORMrefsup{} or \DWFORMstrpsup{} are
678 not used, and all reference forms referring to some other sections
679 refer to the local sections in the \addtoindex{supplementary object file}.
680
681 In macro information, \DWMACROdefinesup{} or
682 \DWMACROundefsup{} opcodes can refer to strings in the 
683 \dotdebugstr{} section of the \addtoindex{supplementary object file}, 
684 or \DWMACROimportsup{} 
685 can refer to \dotdebugmacro{} section entries.  Within the 
686 \dotdebugmacro{} section of a \addtoindex{supplementary object file}, 
687 \DWMACROdefinestrp{} and \DWMACROundefstrp{}
688 opcodes refer to the local \dotdebugstr{} section in that
689 supplementary file, not the one in
690 the executable or shared object file.
691
692
693 \needlines{6}
694 \section{32-Bit and 64-Bit DWARF Formats}
695 \label{datarep:32bitand64bitdwarfformats}
696 \hypertarget{datarep:xxbitdwffmt}{}
697 \addtoindexx{32-bit DWARF format}
698 \addtoindexx{64-bit DWARF format}
699 There are two closely related file formats. In the 32-bit DWARF
700 format, all values that represent lengths of DWARF sections
701 and offsets relative to the beginning of DWARF sections are
702 represented using four bytes. In the 64-bit DWARF format, all
703 values that represent lengths of DWARF sections and offsets
704 relative to the beginning of DWARF sections are represented
705 using eight bytes. A special convention applies to the initial
706 length field of certain DWARF sections, as well as the CIE and
707 FDE structures, so that the 32-bit and 64-bit DWARF formats
708 can coexist and be distinguished within a single linked object.
709
710 The differences between the 32- and 64-bit DWARF formats are
711 detailed in the following:
712 \begin{enumerate}[1. ]
713
714 \item  In the 32-bit DWARF format, an 
715 \addtoindex{initial length} field (see 
716 \addtoindexx{initial length!encoding}
717 Section \ref{datarep:initiallengthvalues} on page \pageref{datarep:initiallengthvalues})
718 is an unsigned 4-byte integer (which
719 must be less than \xfffffffzero); in the 64-bit DWARF format,
720 an \addtoindex{initial length} field is 12 bytes in size,
721 and has two parts:
722 \begin{itemize}
723 \item The first four bytes have the value \xffffffff.
724
725 \item  The following eight bytes contain the actual length
726 represented as an unsigned 8-byte integer.
727 \end{itemize}
728
729 \textit{This representation allows a DWARF consumer to dynamically
730 detect that a DWARF section contribution is using the 64-bit
731 format and to adapt its processing accordingly.}
732
733 \needlines{4}
734 \item Section offset and section length
735 \hypertarget{datarep:sectionoffsetlength}{} 
736 \addtoindexx{section length!use in headers}
737 fields that occur
738 \addtoindexx{section offset!use in headers}
739 in the headers of DWARF sections (other than initial length
740 \addtoindexx{initial length}
741 fields) are listed following. In the 32-bit DWARF format these
742 are 4-byte unsigned integer values; in the 64-bit DWARF format,
743 they are 8-byte unsigned integer values.
744
745 \begin{center}
746 \begin{tabular}{lll}
747 Section &Name & Role  \\ \hline
748 \dotdebugaranges{}   & \addttindex{debug\_info\_offset}   & offset in \dotdebuginfo{} \\
749 \dotdebugframe{}/CIE & \addttindex{CIE\_id}               & CIE distinguished value \\
750 \dotdebugframe{}/FDE & \addttindex{CIE\_pointer}          & offset in \dotdebugframe{} \\
751 \dotdebuginfo{}      & \addttindex{debug\_abbrev\_offset} & offset in \dotdebugabbrev{} \\
752 \dotdebugline{}      & \addttindex{header\_length}        & length of header itself \\
753 \dotdebugnames{}     & entry in array of CUs              & offset in \dotdebuginfo{} \\
754                      & or local TUs                       & \\
755 \end{tabular}
756 \end{center}
757
758 \needlines{4}
759 The \texttt{CIE\_id} field in a CIE structure must be 64 bits because
760 it overlays the \texttt{CIE\_pointer} in a FDE structure; this implicit
761 union must be accessed to distinguish whether a CIE or FDE is
762 present, consequently, these two fields must exactly overlay
763 each other (both offset and size).
764
765 \item Within the body of the \dotdebuginfo{}
766 section, certain forms of attribute value depend on the choice
767 of DWARF format as follows. For the 32-bit DWARF format,
768 the value is a 4-byte unsigned integer; for the 64-bit DWARF
769 format, the value is an 8-byte unsigned integer.
770 \begin{center}
771 \begin{tabular}{lp{6cm}}
772 Form             & Role  \\ \hline
773 \DWFORMlinestrp  & offset in \dotdebuglinestr \\
774 \DWFORMrefaddr   & offset in \dotdebuginfo{} \\
775 \DWFORMrefsup    & offset in \dotdebuginfo{} section of a \mbox{supplementary} object file \\
776                    \addtoindexx{supplementary object file}
777 \DWFORMsecoffset & offset in a section other than \\
778                  & \dotdebuginfo{} or \dotdebugstr{} \\
779 \DWFORMstrp      & offset in \dotdebugstr{} \\
780 \DWFORMstrpsup   & offset in \dotdebugstr{} section of a \mbox{supplementary} object file \\
781 \DWOPcallref     & offset in \dotdebuginfo{} \\
782 \end{tabular}
783 \end{center}
784
785 \needlines{5}
786 \item Within the body of the \dotdebugline{} section, certain forms of content
787 description depend on the choice of DWARF format as follows: for the
788 32-bit DWARF format, the value is a 4-byte unsigned integer; for the
789 64-bit DWARF format, the value is a 8-byte unsigned integer.
790 \begin{center}
791 \begin{tabular}{lp{6cm}}
792 Form             & Role  \\ \hline
793 \DWFORMlinestrp  & offset in \dotdebuglinestr
794 \end{tabular}
795 \end{center}
796
797 \item Within the body of the \dotdebugnames{} 
798 sections, the representation of each entry in the array of
799 compilation units (CUs) and the array of local type units
800 (TUs), which represents an offset in the 
801 \dotdebuginfo{}
802 section, depends on the DWARF format as follows: in the
803 32-bit DWARF format, each entry is a 4-byte unsigned integer;
804 in the 64-bit DWARF format, it is a 8-byte unsigned integer.
805
806 \needlines{4}
807 \item In the body of the \dotdebugstroffsets{} and \dotdebugstroffsetsdwo{}
808 sections, the size of entries in the body depend on the DWARF
809 format as follows: in the 32-bit DWARF format, entries are 4-byte
810 unsigned integer values; in the 64-bit DWARF format, they are
811 8-byte unsigned integers.
812
813 \item In the body of the \dotdebugaddr{}, \dotdebugloc{} and \dotdebugranges{}
814 sections, the contents of the address size fields depends on the
815 DWARF format as follows: in the 32-bit DWARF format, these fields
816 contain 4; in the 64-bit DWARF format these fields contain 8.
817 \end{enumerate}
818
819
820 The 32-bit and 64-bit DWARF format conventions must \emph{not} be
821 intermixed within a single compilation unit.
822
823 \textit{Attribute values and section header fields that represent
824 addresses in the target program are not affected by these
825 rules.}
826
827 A DWARF consumer that supports the 64-bit DWARF format must
828 support executables in which some compilation units use the
829 32-bit format and others use the 64-bit format provided that
830 the combination links correctly (that is, provided that there
831 are no link\dash time errors due to truncation or overflow). (An
832 implementation is not required to guarantee detection and
833 reporting of all such errors.)
834
835 \textit{It is expected that DWARF producing compilers will \emph{not} use
836 the 64-bit format \emph{by default}. In most cases, the division of
837 even very large applications into a number of executable and
838 shared object files will suffice to assure that the DWARF sections
839 within each individual linked object are less than 4 GBytes
840 in size. However, for those cases where needed, the 64-bit
841 format allows the unusual case to be handled as well. Even
842 in this case, it is expected that only application supplied
843 objects will need to be compiled using the 64-bit format;
844 separate 32-bit format versions of system supplied shared
845 executable libraries can still be used.}
846
847
848
849 \section{Format of Debugging Information}
850 \label{datarep:formatofdebugginginformation}
851
852 For each compilation unit compiled with a DWARF producer,
853 a contribution is made to the \dotdebuginfo{} section of
854 the object file. Each such contribution consists of a
855 compilation unit header 
856 (see Section \refersec{datarep:compilationunitheader}) 
857 followed by a
858 single \DWTAGcompileunit{} or 
859 \DWTAGpartialunit{} debugging
860 information entry, together with its children.
861
862 For each type defined in a compilation unit, a separate
863 contribution may also be made to the 
864 \dotdebuginfo{} 
865 section of the object file. Each
866 such contribution consists of a 
867 \addtoindex{type unit} header 
868 (see Section \refersec{datarep:typeunitheader}) 
869 followed by a \DWTAGtypeunit{} entry, together with
870 its children.
871
872 Each debugging information entry begins with a code that
873 represents an entry in a separate 
874 \addtoindex{abbreviations table}. This
875 code is followed directly by a series of attribute values.
876
877 The appropriate entry in the 
878 \addtoindex{abbreviations table} guides the
879 interpretation of the information contained directly in the
880 \dotdebuginfo{} section.
881
882 \needlines{4}
883 Multiple debugging information entries may share the same
884 abbreviation table entry. Each compilation unit is associated
885 with a particular abbreviation table, but multiple compilation
886 units may share the same table.
887
888 \subsection{Unit Headers}
889 \label{datarep:unitheaders}
890 Unit headers contain a field, \addttindex{unit\_type}, whose value indicates the kind of
891 compilation unit that follows. The encodings for the unit type 
892 enumeration are shown in Table \refersec{tab:unitheaderunitkindencodings}.
893
894 \needlines{6}
895 \begin{centering}
896 \setlength{\extrarowheight}{0.1cm}
897 \begin{longtable}{l|c}
898   \caption{Unit header unit type encodings}
899   \label{tab:unitheaderunitkindencodings}
900   \addtoindexx{unit header unit type encodings} \\
901   \hline \bfseries Unit header unit type encodings&\bfseries Value \\ \hline
902 \endfirsthead
903   \bfseries Unit header unit type encodings&\bfseries Value \\ \hline
904 \endhead
905   \hline \emph{Continued on next page}
906 \endfoot
907   \hline \ddag\ \textit{New in DWARF Version 5}
908 \endlastfoot
909 \DWUTcompileTARG~\ddag    &0x01 \\ 
910 \DWUTtypeTARG~\ddag       &0x02 \\ 
911 \DWUTpartialTARG~\ddag    &0x03 \\ \hline
912 \end{longtable}
913 \end{centering}
914
915 \needlines{5}
916 \subsubsection{Compilation Unit Header}
917 \label{datarep:compilationunitheader}
918 \begin{enumerate}[1. ]
919
920 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length}) \\
921 \addttindexx{unit\_length}
922 A 4-byte or 12-byte 
923 \addtoindexx{initial length}
924 unsigned integer representing the length
925 of the \dotdebuginfo{}
926 contribution for that compilation unit,
927 not including the length field itself. In the \thirtytwobitdwarfformat,
928  this is a 4-byte unsigned integer (which must be less
929 than \xfffffffzero); in the \sixtyfourbitdwarfformat, this consists
930 of the 4-byte value \wffffffff followed by an 8-byte unsigned
931 integer that gives the actual length 
932 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
933
934 \item  \texttt{version} (\HFTuhalf) \\
935 \addttindexx{version}
936 A 2-byte unsigned integer representing the version of the
937 DWARF information for the compilation unit \addtoindexx{version number!compilation unit} 
938 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
939 The value in this field is \versiondotdebuginfo.
940
941 \needlines{4}
942 \item \texttt{unit\_type} (\HFTubyte) \\
943 \addttindexx{unit\_type}
944 A 1-byte unsigned integer identifying this unit as a compilation unit.
945 The value of this field is 
946 \DWUTcompile{} for a full compilation unit or
947 \DWUTpartial{} for a partial compilation unit
948 (see Section \refersec{chap:fullandpartialcompilationunitentries}).
949
950 \textit{This field is new in \DWARFVersionV.}
951
952 \needlines{4}
953 \item \HFNdebugabbrevoffset{} (\livelink{datarep:sectionoffsetlength}{section offset}) \\
954
955 \addtoindexx{section offset!in .debug\_info header}
956 4-byte or 8-byte unsigned offset into the 
957 \dotdebugabbrev{}
958 section. This offset associates the compilation unit with a
959 particular set of debugging information entry abbreviations. In
960 the \thirtytwobitdwarfformat, this is a 4-byte unsigned length;
961 in the \sixtyfourbitdwarfformat, this is an 8-byte unsigned length
962 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
963
964 \item \texttt{address\_size} (\HFTubyte) \\
965 \addttindexx{address\_size}
966 A 1-byte unsigned integer representing the size in bytes of
967 an address on the target architecture. If the system uses
968 \addtoindexx{address space!segmented}
969 segmented addressing, this value represents the size of the
970 offset portion of an address.
971
972 \end{enumerate}
973
974 \subsubsection{Type Unit Header}
975 \label{datarep:typeunitheader}
976
977 The header for the series of debugging information entries
978 contributing to the description of a type that has been
979 placed in its own \addtoindex{type unit}, within the 
980 \dotdebuginfo{} section,
981 consists of the following information:
982 \begin{enumerate}[1. ]
983
984 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length}) \\
985 \addttindexx{unit\_length}
986 A 4-byte or 12-byte unsigned integer 
987 \addtoindexx{initial length}
988 representing the length
989 of the \dotdebuginfo{} contribution for that type unit,
990 not including the length field itself. In the \thirtytwobitdwarfformat, 
991 this is a 4-byte unsigned integer (which must be
992 less than \xfffffffzero); in the \sixtyfourbitdwarfformat, this
993 consists of the 4-byte value \wffffffff followed by an 
994 8-byte unsigned integer that gives the actual length
995 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
996
997 \needlines{4}
998 \item  \texttt{version} (\HFTuhalf) \\
999 \addttindexx{version}
1000 A 2-byte unsigned integer representing the version of the
1001 DWARF information for the 
1002 type unit\addtoindexx{version number!type unit} 
1003 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
1004 The value in this field is \versiondotdebuginfo.
1005
1006 \item \texttt{unit\_type} (\HFTubyte) \\
1007 \addttindexx{unit\_type}
1008 A 1-byte unsigned integer identifying this unit as a type unit.
1009 The value of this field is \DWUTtype{} for a type unit
1010 (see Section \refersec{chap:typeunitentries}).
1011
1012 \textit{This field is new in \DWARFVersionV.}
1013
1014 \needlines{4}
1015 \item \HFNdebugabbrevoffset{} (\livelink{datarep:sectionoffsetlength}{section offset}) \\
1016
1017 \addtoindexx{section offset!in .debug\_info header}
1018 4-byte or 8-byte unsigned offset into the 
1019 \dotdebugabbrev{}
1020 section. This offset associates the type unit with a
1021 particular set of debugging information entry abbreviations. In
1022 the \thirtytwobitdwarfformat, this is a 4-byte unsigned length;
1023 in the \sixtyfourbitdwarfformat, this is an 8-byte unsigned length
1024 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
1025
1026 \needlines{4}
1027 \item \texttt{address\_size} (\HFTubyte) \\
1028 \addttindexx{address\_size}
1029 A 1-byte unsigned integer representing the size 
1030 \addtoindexx{size of an address}
1031 in bytes of
1032 an address on the target architecture. If the system uses
1033 \addtoindexx{address space!segmented}
1034 segmented addressing, this value represents the size of the
1035 offset portion of an address.
1036
1037 \item \texttt{type\_signature} (8-byte unsigned integer) \\
1038 \addttindexx{type\_signature}
1039 \addtoindexx{type signature}
1040 A unique 8-byte signature (see Section 
1041 \refersec{datarep:typesignaturecomputation})
1042 of the type described in this type
1043 unit.  
1044
1045 \textit{An attribute that refers (using 
1046 \DWFORMrefsigeight{}) to
1047 the primary type contained in this 
1048 \addtoindex{type unit} uses this value.}
1049
1050 \item \texttt{type\_offset} (\livelink{datarep:sectionoffsetlength}{section offset}) \\
1051 \addttindexx{type\_offset}
1052 A 4-byte or 8-byte unsigned offset 
1053 \addtoindexx{section offset!in .debug\_info header}
1054 relative to the beginning
1055 of the \addtoindex{type unit} header.
1056 This offset refers to the debugging
1057 information entry that describes the type. Because the type
1058 may be nested inside a namespace or other structures, and may
1059 contain references to other types that have not been placed in
1060 separate type units, it is not necessarily either the first or
1061 the only entry in the type unit. In the \thirtytwobitdwarfformat,
1062 this is a 4-byte unsigned length; in the \sixtyfourbitdwarfformat,
1063 this is an 8-byte unsigned length
1064 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
1065
1066 \end{enumerate}
1067
1068 \subsection{Debugging Information Entry}
1069 \label{datarep:debugginginformationentry}
1070
1071 Each debugging information entry begins with an 
1072 unsigned LEB128\addtoindexx{LEB128!unsigned}
1073 number containing the abbreviation code for the entry. This
1074 code represents an entry within the abbreviations table
1075 associated with the compilation unit containing this entry. The
1076 abbreviation code is followed by a series of attribute values.
1077
1078 On some architectures, there are alignment constraints on
1079 section boundaries. To make it easier to pad debugging
1080 information sections to satisfy such constraints, the
1081 abbreviation code 0 is reserved. Debugging information entries
1082 consisting of only the abbreviation code 0 are considered
1083 null entries.
1084
1085 \subsection{Abbreviations Tables}
1086 \label{datarep:abbreviationstables}
1087
1088 The abbreviations tables for all compilation units
1089 are contained in a separate object file section called
1090 \dotdebugabbrev{}.
1091 As mentioned before, multiple compilation
1092 units may share the same abbreviations table.
1093
1094 The abbreviations table for a single compilation unit consists
1095 of a series of abbreviation declarations. Each declaration
1096 specifies the tag and attributes for a particular form of
1097 debugging information entry. Each declaration begins with
1098 an unsigned LEB128\addtoindexx{LEB128!unsigned}
1099 number representing the abbreviation
1100 code itself. It is this code that appears at the beginning
1101 of a debugging information entry in the 
1102 \dotdebuginfo{}
1103 section. As described above, the abbreviation
1104 code 0 is reserved for null debugging information entries. The
1105 abbreviation code is followed by another unsigned LEB128\addtoindexx{LEB128!unsigned}
1106 number that encodes the entry\textquoteright s tag. The encodings for the
1107 tag names are given in 
1108 Table \referfol{tab:tagencodings}.
1109
1110 \begin{centering}
1111 \setlength{\extrarowheight}{0.1cm}
1112 \begin{longtable}{l|c}
1113   \caption{Tag encodings} \label{tab:tagencodings} \\
1114   \hline \bfseries Tag name&\bfseries Value\\ \hline
1115 \endfirsthead
1116   \bfseries Tag name&\bfseries Value \\ \hline
1117 \endhead
1118   \hline \emph{Continued on next page}
1119 \endfoot
1120   \hline \ddag\ \textit{New in DWARF Version 5}
1121 \endlastfoot
1122 \DWTAGarraytype{} &0x01 \\
1123 \DWTAGclasstype&0x02 \\
1124 \DWTAGentrypoint&0x03 \\
1125 \DWTAGenumerationtype&0x04 \\
1126 \DWTAGformalparameter&0x05 \\
1127 \DWTAGimporteddeclaration&0x08 \\
1128 \DWTAGlabel&0x0a \\
1129 \DWTAGlexicalblock&0x0b \\
1130 \DWTAGmember&0x0d \\
1131 \DWTAGpointertype&0x0f \\
1132 \DWTAGreferencetype&0x10 \\
1133 \DWTAGcompileunit&0x11 \\
1134 \DWTAGstringtype&0x12 \\
1135 \DWTAGstructuretype&0x13 \\
1136 \DWTAGsubroutinetype&0x15 \\
1137 \DWTAGtypedef&0x16 \\
1138 \DWTAGuniontype&0x17 \\
1139 \DWTAGunspecifiedparameters&0x18  \\
1140 \DWTAGvariant&0x19  \\
1141 \DWTAGcommonblock&0x1a  \\
1142 \DWTAGcommoninclusion&0x1b  \\
1143 \DWTAGinheritance&0x1c  \\
1144 \DWTAGinlinedsubroutine&0x1d  \\
1145 \DWTAGmodule&0x1e  \\
1146 \DWTAGptrtomembertype&0x1f  \\
1147 \DWTAGsettype&0x20  \\
1148 \DWTAGsubrangetype&0x21  \\
1149 \DWTAGwithstmt&0x22  \\
1150 \DWTAGaccessdeclaration&0x23  \\
1151 \DWTAGbasetype&0x24  \\
1152 \DWTAGcatchblock&0x25  \\
1153 \DWTAGconsttype&0x26  \\
1154 \DWTAGconstant&0x27  \\
1155 \DWTAGenumerator&0x28  \\
1156 \DWTAGfiletype&0x29  \\
1157 \DWTAGfriend&0x2a  \\
1158 \DWTAGnamelist&0x2b    \\
1159 \DWTAGnamelistitem&0x2c    \\
1160 \DWTAGpackedtype&0x2d    \\
1161 \DWTAGsubprogram&0x2e    \\
1162 \DWTAGtemplatetypeparameter&0x2f    \\
1163 \DWTAGtemplatevalueparameter&0x30    \\
1164 \DWTAGthrowntype&0x31    \\
1165 \DWTAGtryblock&0x32    \\
1166 \DWTAGvariantpart&0x33    \\
1167 \DWTAGvariable&0x34    \\
1168 \DWTAGvolatiletype&0x35    \\
1169 \DWTAGdwarfprocedure&0x36     \\
1170 \DWTAGrestricttype&0x37      \\
1171 \DWTAGinterfacetype&0x38      \\
1172 \DWTAGnamespace&0x39      \\
1173 \DWTAGimportedmodule&0x3a      \\
1174 \DWTAGunspecifiedtype&0x3b      \\
1175 \DWTAGpartialunit&0x3c      \\
1176 \DWTAGimportedunit&0x3d      \\
1177 \DWTAGcondition&\xiiif      \\
1178 \DWTAGsharedtype&0x40      \\
1179 \DWTAGtypeunit & 0x41      \\
1180 \DWTAGrvaluereferencetype & 0x42      \\
1181 \DWTAGtemplatealias & 0x43      \\
1182 \DWTAGcoarraytype~\ddag & 0x44 \\
1183 \DWTAGgenericsubrange~\ddag & 0x45 \\
1184 \DWTAGdynamictype~\ddag & 0x46 \\
1185 \DWTAGatomictype~\ddag & 0x47 \\
1186 \DWTAGcallsite~\ddag & 0x48 \\
1187 \DWTAGcallsiteparameter~\ddag & 0x49 \\
1188 \DWTAGlouser&0x4080      \\
1189 \DWTAGhiuser&\xffff      \\
1190 \end{longtable}
1191 \end{centering}
1192
1193 \needlines{8}
1194 Following the tag encoding is a 1-byte value that determines
1195 whether a debugging information entry using this abbreviation
1196 has child entries or not. If the value is 
1197 \DWCHILDRENyesTARG,
1198 the next physically succeeding entry of any debugging
1199 information entry using this abbreviation is the first
1200 child of that entry. If the 1-byte value following the
1201 abbreviation\textquoteright s tag encoding is 
1202 \DWCHILDRENnoTARG, the next
1203 physically succeeding entry of any debugging information entry
1204 using this abbreviation is a sibling of that entry. (Either
1205 the first child or sibling entries may be null entries). The
1206 encodings for the child determination byte are given in 
1207 Table \refersec{tab:childdeterminationencodings}
1208 (As mentioned in 
1209 Section \refersec{chap:relationshipofdebugginginformationentries}, 
1210 each chain of sibling entries is terminated by a null entry.)
1211
1212 \needlines{6}
1213 \begin{centering}
1214 \setlength{\extrarowheight}{0.1cm}
1215 \begin{longtable}{l|c}
1216   \caption{Child determination encodings}
1217   \label{tab:childdeterminationencodings}
1218   \addtoindexx{Child determination encodings} \\
1219   \hline \bfseries Children determination name&\bfseries Value \\ \hline
1220 \endfirsthead
1221   \bfseries Children determination name&\bfseries Value \\ \hline
1222 \endhead
1223   \hline \emph{Continued on next page}
1224 \endfoot
1225   \hline
1226 \endlastfoot
1227 \DWCHILDRENno&0x00 \\ 
1228 \DWCHILDRENyes&0x01 \\ \hline
1229 \end{longtable}
1230 \end{centering}
1231
1232 \needlines{4}
1233 Finally, the child encoding is followed by a series of
1234 attribute specifications. Each attribute specification
1235 consists of two parts. The first part is an 
1236 unsigned LEB128\addtoindexx{LEB128!unsigned}
1237 number representing the attribute\textquoteright s name. 
1238 The second part is an 
1239 unsigned LEB128\addtoindexx{LEB128!unsigned} 
1240 number representing the attribute\textquoteright s form. 
1241 The series of attribute specifications ends with an
1242 entry containing 0 for the name and 0 for the form.
1243
1244 The attribute form 
1245 \DWFORMindirectTARG{} is a special case. For
1246 attributes with this form, the attribute value itself in the
1247 \dotdebuginfo{}
1248 section begins with an unsigned
1249 LEB128 number that represents its form. This allows producers
1250 to choose forms for particular attributes 
1251 \addtoindexx{abbreviations table!dynamic forms in}
1252 dynamically,
1253 without having to add a new entry to the abbreviations table.
1254
1255 The attribute form \DWFORMimplicitconstTARG{} is another special case.
1256 For attributes with this form, the attribute specification contains 
1257 a third part, which is a signed LEB128\addtoindexx{LEB128!signed} 
1258 number. The value of this number is used as the value of the 
1259 attribute, and no value is stored in the \dotdebuginfo{} section.
1260
1261 The abbreviations for a given compilation unit end with an
1262 entry consisting of a 0 byte for the abbreviation code.
1263
1264 \textit{See 
1265 Appendix \refersec{app:compilationunitsandabbreviationstableexample} 
1266 for a depiction of the organization of the
1267 debugging information.}
1268
1269 \needlines{12}
1270 \subsection{Attribute Encodings}
1271 \label{datarep:attributeencodings}
1272
1273 The encodings for the attribute names are given in 
1274 Table \referfol{tab:attributeencodings}.
1275
1276 \begin{centering}
1277 \setlength{\extrarowheight}{0.1cm}
1278 \begin{longtable}{l|c|l}
1279   \caption{Attribute encodings} 
1280   \label{tab:attributeencodings} 
1281   \addtoindexx{attribute encodings} \\
1282   \hline \bfseries Attribute name&\bfseries Value &\bfseries Classes \\ \hline
1283 \endfirsthead
1284   \bfseries Attribute name&\bfseries Value &\bfseries Classes\\ \hline
1285 \endhead
1286   \hline \emph{Continued on next page}
1287 \endfoot
1288   \hline \ddag\ \textit{New in DWARF Version 5}
1289 \endlastfoot
1290 \DWATsibling&0x01&\livelink{chap:classreference}{reference} 
1291             \addtoindexx{sibling attribute} \\
1292 \DWATlocation&0x02&\livelink{chap:classexprloc}{exprloc}, 
1293         \livelink{chap:classloclistptr}{loclistptr}
1294             \addtoindexx{location attribute}   \\
1295 \DWATname&0x03&\livelink{chap:classstring}{string} 
1296             \addtoindexx{name attribute} \\
1297 \DWATordering&0x09&\livelink{chap:classconstant}{constant} 
1298             \addtoindexx{ordering attribute}  \\
1299 \DWATbytesize&0x0b&\livelink{chap:classconstant}{constant}, 
1300         \livelink{chap:classexprloc}{exprloc}, 
1301         \livelink{chap:classreference}{reference}
1302             \addtoindexx{byte size attribute} \\
1303 \textit{Reserved}&0x0c\footnote{Code 0x0c is reserved to allow backward compatible support of the 
1304                                        DW\_AT\_bit\_offset \mbox{attribute} which was 
1305                                        defined in \DWARFVersionIII{} and earlier.}
1306        &\livelink{chap:classconstant}{constant}, 
1307         \livelink{chap:classexprloc}{exprloc}, 
1308         \livelink{chap:classreference}{reference}
1309             \addtoindexx{bit offset attribute (Version 3)}
1310             \addtoindexx{DW\_AT\_bit\_offset (deprecated)}  \\
1311 \DWATbitsize&0x0d&\livelink{chap:classconstant}{constant}, 
1312         \livelink{chap:classexprloc}{exprloc}, 
1313         \livelink{chap:classreference}{reference}   
1314             \addtoindexx{bit size attribute} \\
1315 \DWATstmtlist&0x10&\livelink{chap:classlineptr}{lineptr} 
1316             \addtoindexx{statement list attribute} \\
1317 \DWATlowpc&0x11&\livelink{chap:classaddress}{address} 
1318             \addtoindexx{low PC attribute}  \\
1319 \DWAThighpc&0x12&\livelink{chap:classaddress}{address}, 
1320         \livelink{chap:classconstant}{constant}
1321             \addtoindexx{high PC attribute}  \\
1322 \DWATlanguage&0x13&\livelink{chap:classconstant}{constant} 
1323             \addtoindexx{language attribute}  \\
1324 \DWATdiscr&0x15&\livelink{chap:classreference}{reference} 
1325             \addtoindexx{discriminant attribute}  \\
1326 \DWATdiscrvalue&0x16&\livelink{chap:classconstant}{constant} 
1327             \addtoindexx{discriminant value attribute}  \\
1328 \DWATvisibility&0x17&\livelink{chap:classconstant}{constant} 
1329             \addtoindexx{visibility attribute} \\
1330 \DWATimport&0x18&\livelink{chap:classreference}{reference} 
1331             \addtoindexx{import attribute}  \\
1332 \DWATstringlength&0x19&\livelink{chap:classexprloc}{exprloc}, 
1333         \livelink{chap:classloclistptr}{loclistptr}
1334             \addtoindexx{string length attribute}  \\
1335 \DWATcommonreference&0x1a&\livelink{chap:classreference}{reference} 
1336             \addtoindexx{common reference attribute}  \\
1337 \DWATcompdir&0x1b&\livelink{chap:classstring}{string} 
1338             \addtoindexx{compilation directory attribute}  \\
1339 \DWATconstvalue&0x1c&\livelink{chap:classblock}{block}, 
1340         \livelink{chap:classconstant}{constant}, 
1341         \livelink{chap:classstring}{string}
1342             \addtoindexx{constant value attribute} \\
1343 \DWATcontainingtype&0x1d&\livelink{chap:classreference}{reference} 
1344             \addtoindexx{containing type attribute} \\
1345 \DWATdefaultvalue&0x1e&\livelink{chap:classconstant}{constant}, 
1346         \livelink{chap:classreference}{reference}, 
1347         \livelink{chap:classflag}{flag}
1348             \addtoindexx{default value attribute} \\
1349 \DWATinline&0x20&\livelink{chap:classconstant}{constant} 
1350             \addtoindexx{inline attribute}  \\
1351 \DWATisoptional&0x21&\livelink{chap:classflag}{flag} 
1352             \addtoindexx{is optional attribute} \\
1353 \DWATlowerbound&0x22&\livelink{chap:classconstant}{constant}, 
1354         \livelink{chap:classexprloc}{exprloc}, 
1355         \livelink{chap:classreference}{reference}
1356             \addtoindexx{lower bound attribute}  \\
1357 \DWATproducer&0x25&\livelink{chap:classstring}{string}
1358             \addtoindexx{producer attribute}  \\
1359 \DWATprototyped&0x27&\livelink{chap:classflag}{flag}
1360             \addtoindexx{prototyped attribute}  \\
1361 \DWATreturnaddr&0x2a&\livelink{chap:classexprloc}{exprloc},
1362         \livelink{chap:classloclistptr}{loclistptr}
1363             \addtoindexx{return address attribute}  \\
1364 \DWATstartscope&0x2c&\livelink{chap:classconstant}{constant}, 
1365         \livelink{chap:classrangelistptr}{rangelistptr}
1366             \addtoindexx{start scope attribute}  \\
1367 \DWATbitstride&0x2e&\livelink{chap:classconstant}{constant},
1368         \livelink{chap:classexprloc}{exprloc}, 
1369         \livelink{chap:classreference}{reference}
1370             \addtoindexx{bit stride attribute}  \\
1371 \DWATupperbound&0x2f&\livelink{chap:classconstant}{constant},
1372         \livelink{chap:classexprloc}{exprloc}, 
1373         \livelink{chap:classreference}{reference}
1374             \addtoindexx{upper bound attribute}  \\
1375 \DWATabstractorigin&0x31&\livelink{chap:classreference}{reference} 
1376             \addtoindexx{abstract origin attribute}  \\
1377 \DWATaccessibility&0x32&\livelink{chap:classconstant}{constant} 
1378             \addtoindexx{accessibility attribute}  \\
1379 \DWATaddressclass&0x33&\livelink{chap:classconstant}{constant} 
1380             \addtoindexx{address class attribute}  \\
1381 \DWATartificial&0x34&\livelink{chap:classflag}{flag} 
1382             \addtoindexx{artificial attribute}  \\
1383 \DWATbasetypes&0x35&\livelink{chap:classreference}{reference} 
1384             \addtoindexx{base types attribute}  \\
1385 \DWATcallingconvention&0x36&\livelink{chap:classconstant}{constant} 
1386         \addtoindexx{calling convention attribute} \\
1387 \DWATcount&0x37&\livelink{chap:classconstant}{constant}, 
1388         \livelink{chap:classexprloc}{exprloc}, 
1389         \livelink{chap:classreference}{reference} 
1390             \addtoindexx{count attribute}  \\
1391 \DWATdatamemberlocation&0x38&\livelink{chap:classconstant}{constant}, 
1392         \livelink{chap:classexprloc}{exprloc}, 
1393         \livelink{chap:classloclistptr}{loclistptr} 
1394             \addtoindexx{data member attribute}  \\
1395 \DWATdeclcolumn&0x39&\livelink{chap:classconstant}{constant} 
1396             \addtoindexx{declaration column attribute}  \\
1397 \DWATdeclfile&0x3a&\livelink{chap:classconstant}{constant} 
1398             \addtoindexx{declaration file attribute}  \\
1399 \DWATdeclline&0x3b&\livelink{chap:classconstant}{constant} 
1400             \addtoindexx{declaration line attribute}  \\
1401 \DWATdeclaration&0x3c&\livelink{chap:classflag}{flag} 
1402             \addtoindexx{declaration attribute}  \\
1403 \DWATdiscrlist&0x3d&\livelink{chap:classblock}{block} 
1404             \addtoindexx{discriminant list attribute}  \\
1405 \DWATencoding&0x3e&\livelink{chap:classconstant}{constant} 
1406             \addtoindexx{encoding attribute}  \\
1407 \DWATexternal&\xiiif&\livelink{chap:classflag}{flag} 
1408             \addtoindexx{external attribute}  \\
1409 \DWATframebase&0x40&\livelink{chap:classexprloc}{exprloc}, 
1410         \livelink{chap:classloclistptr}{loclistptr} 
1411             \addtoindexx{frame base attribute}  \\
1412 \DWATfriend&0x41&\livelink{chap:classreference}{reference} 
1413             \addtoindexx{friend attribute}  \\
1414 \DWATidentifiercase&0x42&\livelink{chap:classconstant}{constant} 
1415             \addtoindexx{identifier case attribute}  \\
1416 \DWATmacroinfo\footnote{\raggedright Not used in \DWARFVersionV. 
1417                         Reserved for compatibility and coexistence
1418                         with prior DWARF versions.}
1419             &0x43&\livelink{chap:classmacptr}{macptr} 
1420             \addtoindexx{macro information attribute (legacy)!encoding}  \\
1421 \DWATnamelistitem&0x44&\livelink{chap:classreference}{reference} 
1422             \addtoindexx{name list item attribute}  \\
1423 \DWATpriority&0x45&\livelink{chap:classreference}{reference} 
1424             \addtoindexx{priority attribute}  \\
1425 \DWATsegment&0x46&\livelink{chap:classexprloc}{exprloc}, 
1426         \livelink{chap:classloclistptr}{loclistptr} 
1427             \addtoindexx{segment attribute}  \\
1428 \DWATspecification&0x47&\livelink{chap:classreference}{reference} 
1429         \addtoindexx{specification attribute}  \\
1430 \DWATstaticlink&0x48&\livelink{chap:classexprloc}{exprloc}, 
1431         \livelink{chap:classloclistptr}{loclistptr} 
1432             \addtoindexx{static link attribute}  \\
1433 \DWATtype&0x49&\livelink{chap:classreference}{reference} 
1434             \addtoindexx{type attribute}  \\
1435 \DWATuselocation&0x4a&\livelink{chap:classexprloc}{exprloc}, 
1436         \livelink{chap:classloclistptr}{loclistptr} 
1437             \addtoindexx{location list attribute}  \\
1438 \DWATvariableparameter&0x4b&\livelink{chap:classflag}{flag} 
1439             \addtoindexx{variable parameter attribute}  \\
1440 \DWATvirtuality&0x4c&\livelink{chap:classconstant}{constant} 
1441             \addtoindexx{virtuality attribute}  \\
1442 \DWATvtableelemlocation&0x4d&\livelink{chap:classexprloc}{exprloc}, 
1443         \livelink{chap:classloclistptr}{loclistptr} 
1444             \addtoindexx{vtable element location attribute}  \\
1445 \DWATallocated&0x4e&\livelink{chap:classconstant}{constant}, 
1446         \livelink{chap:classexprloc}{exprloc}, 
1447         \livelink{chap:classreference}{reference} 
1448             \addtoindexx{allocated attribute}  \\
1449 \DWATassociated&0x4f&\livelink{chap:classconstant}{constant}, 
1450         \livelink{chap:classexprloc}{exprloc}, 
1451         \livelink{chap:classreference}{reference} 
1452             \addtoindexx{associated attribute}  \\
1453 \DWATdatalocation&0x50&\livelink{chap:classexprloc}{exprloc} 
1454         \addtoindexx{data location attribute}  \\
1455 \DWATbytestride&0x51&\livelink{chap:classconstant}{constant}, 
1456         \livelink{chap:classexprloc}{exprloc}, 
1457         \livelink{chap:classreference}{reference} 
1458             \addtoindexx{byte stride attribute}  \\
1459 \DWATentrypc&0x52&\livelink{chap:classaddress}{address}, 
1460         \livelink{chap:classconstant}{constant} 
1461             \addtoindexx{entry PC attribute}  \\
1462 \DWATuseUTFeight&0x53&\livelink{chap:classflag}{flag} 
1463             \addtoindexx{use UTF8 attribute}\addtoindexx{UTF-8}  \\
1464 \DWATextension&0x54&\livelink{chap:classreference}{reference} 
1465             \addtoindexx{extension attribute}  \\
1466 \DWATranges&0x55&\livelink{chap:classrangelistptr}{rangelistptr} 
1467             \addtoindexx{ranges attribute}  \\
1468 \DWATtrampoline&0x56&\livelink{chap:classaddress}{address}, 
1469         \livelink{chap:classflag}{flag}, 
1470         \livelink{chap:classreference}{reference}, 
1471         \livelink{chap:classstring}{string} 
1472             \addtoindexx{trampoline attribute}  \\
1473 \DWATcallcolumn&0x57&\livelink{chap:classconstant}{constant} 
1474             \addtoindexx{call column attribute}  \\
1475 \DWATcallfile&0x58&\livelink{chap:classconstant}{constant} 
1476             \addtoindexx{call file attribute}  \\
1477 \DWATcallline&0x59&\livelink{chap:classconstant}{constant} 
1478             \addtoindexx{call line attribute}  \\
1479 \DWATdescription&0x5a&\livelink{chap:classstring}{string} 
1480             \addtoindexx{description attribute}  \\
1481 \DWATbinaryscale&0x5b&\livelink{chap:classconstant}{constant} 
1482             \addtoindexx{binary scale attribute}  \\
1483 \DWATdecimalscale&0x5c&\livelink{chap:classconstant}{constant} 
1484             \addtoindexx{decimal scale attribute}  \\
1485 \DWATsmall{} &0x5d&\livelink{chap:classreference}{reference} 
1486             \addtoindexx{small attribute}  \\
1487 \DWATdecimalsign&0x5e&\livelink{chap:classconstant}{constant} 
1488             \addtoindexx{decimal scale attribute}  \\
1489 \DWATdigitcount&0x5f&\livelink{chap:classconstant}{constant} 
1490             \addtoindexx{digit count attribute}  \\
1491 \DWATpicturestring&0x60&\livelink{chap:classstring}{string} 
1492             \addtoindexx{picture string attribute}  \\
1493 \DWATmutable&0x61&\livelink{chap:classflag}{flag} 
1494             \addtoindexx{mutable attribute}  \\
1495 \DWATthreadsscaled&0x62&\livelink{chap:classflag}{flag} 
1496             \addtoindexx{thread scaled attribute}  \\
1497 \DWATexplicit&0x63&\livelink{chap:classflag}{flag} 
1498             \addtoindexx{explicit attribute}  \\
1499 \DWATobjectpointer&0x64&\livelink{chap:classreference}{reference} 
1500             \addtoindexx{object pointer attribute}  \\
1501 \DWATendianity&0x65&\livelink{chap:classconstant}{constant} 
1502             \addtoindexx{endianity attribute}  \\
1503 \DWATelemental&0x66&\livelink{chap:classflag}{flag} 
1504             \addtoindexx{elemental attribute}  \\
1505 \DWATpure&0x67&\livelink{chap:classflag}{flag} 
1506             \addtoindexx{pure attribute}  \\
1507 \DWATrecursive&0x68&\livelink{chap:classflag}{flag} 
1508             \addtoindexx{recursive attribute}  \\
1509 \DWATsignature{} &0x69&\livelink{chap:classreference}{reference} 
1510             \addtoindexx{signature attribute}  \\ 
1511 \DWATmainsubprogram{} &0x6a&\livelink{chap:classflag}{flag} 
1512             \addtoindexx{main subprogram attribute}  \\
1513 \DWATdatabitoffset{} &0x6b&\livelink{chap:classconstant}{constant} 
1514             \addtoindexx{data bit offset attribute}  \\
1515 \DWATconstexpr{} &0x6c&\livelink{chap:classflag}{flag} 
1516             \addtoindexx{constant expression attribute}  \\
1517 \DWATenumclass{} &0x6d&\livelink{chap:classflag}{flag} 
1518             \addtoindexx{enumeration class attribute}  \\
1519 \DWATlinkagename{} &0x6e&\livelink{chap:classstring}{string} 
1520             \addtoindexx{linkage name attribute}  \\
1521 \DWATstringlengthbitsize{}~\ddag&0x6f&
1522                 \livelink{chap:classconstant}{constant}
1523             \addtoindexx{string length attribute!size of length}  \\
1524 \DWATstringlengthbytesize{}~\ddag&0x70&
1525                 \livelink{chap:classconstant}{constant}
1526             \addtoindexx{string length attribute!size of length}  \\
1527 \DWATrank~\ddag&0x71&
1528         \livelink{chap:classconstant}{constant},
1529         \livelink{chap:classexprloc}{exprloc}
1530             \addtoindexx{rank attribute}  \\
1531 \DWATstroffsetsbase~\ddag&0x72&
1532                 \livelinki{chap:classstroffsetsptr}{stroffsetsptr}{stroffsetsptr class}
1533             \addtoindexx{string offsets base!encoding}  \\
1534 \DWATaddrbase~\ddag &0x73&
1535                 \livelinki{chap:classaddrptr}{addrptr}{addrptr class}
1536             \addtoindexx{address table base!encoding} \\
1537 \DWATrangesbase~\ddag&0x74&
1538                 \livelinki{chap:classrangelistptr}{rangelistptr}{rangelistptr class}
1539             \addtoindexx{ranges base!encoding} \\
1540 \DWATdwoid~\ddag &0x75&
1541                 \livelink{chap:classconstant}{constant}
1542             \addtoindexx{split DWARF object file id!encoding} \\
1543 \DWATdwoname~\ddag &0x76&
1544                 \livelink{chap:classstring}{string}
1545             \addtoindexx{split DWARF object file name!encoding} \\
1546 \DWATreference~\ddag &0x77&
1547         \livelink{chap:classflag}{flag} \\
1548 \DWATrvaluereference~\ddag &0x78&
1549         \livelink{chap:classflag}{flag} \\
1550 \DWATmacros~\ddag &0x79&\livelink{chap:classmacptr}{macptr} 
1551         \addtoindexx{macro information attribute}  \\
1552 \DWATcallallcalls~\ddag &0x7a&\CLASSflag
1553         \addtoindexx{all calls summary attribute} \\
1554 \DWATcallallsourcecalls~\ddag &0x7b &\CLASSflag
1555         \addtoindexx{all source calls summary attribute} \\
1556 \DWATcallalltailcalls~\ddag &0x7c&\CLASSflag
1557         \addtoindexx{all tail calls summary attribute} \\
1558 \DWATcallreturnpc~\ddag &0x7d &\CLASSaddress
1559         \addtoindexx{call return PC attribute} \\
1560 \DWATcallvalue~\ddag &0x7e &\CLASSexprloc
1561         \addtoindexx{call value attribute} \\
1562 \DWATcallorigin~\ddag &0x7f &\CLASSexprloc
1563         \addtoindexx{call origin attribute} \\
1564 \DWATcallparameter~\ddag &0x80 &\CLASSreference
1565         \addtoindexx{call parameter attribute} \\
1566 \DWATcallpc~\ddag &0x81 &\CLASSaddress
1567         \addtoindexx{call PC attribute} \\
1568 \DWATcalltailcall~\ddag &0x82 &\CLASSflag
1569         \addtoindexx{call tail call attribute} \\
1570 \DWATcalltarget~\ddag &0x83 &\CLASSexprloc
1571         \addtoindexx{call target attribute} \\
1572 \DWATcalltargetclobbered~\ddag &0x84 &\CLASSexprloc
1573         \addtoindexx{call target clobbered attribute} \\
1574 \DWATcalldatalocation~\ddag &0x85 &\CLASSexprloc
1575         \addtoindexx{call data location attribute} \\
1576 \DWATcalldatavalue~\ddag &0x86 &\CLASSexprloc
1577         \addtoindexx{call data value attribute} \\
1578 \DWATnoreturn~\ddag &0x87 &\CLASSflag 
1579         \addtoindexx{noreturn attribute} \\
1580 \DWATalignment~\ddag &0x88 &\CLASSconstant 
1581         \addtoindexx{alignment attribute} \\
1582 \DWATexportsymbols~\ddag &0x89 &\CLASSflag
1583         \addtoindexx{export symbols attribute} \\
1584 \DWATdeleted~\ddag &0x8a &\CLASSflag \addtoindexx{deleted attribute} \\
1585 \DWATdefaulted~\ddag &0x8b &\CLASSconstant \addtoindexx{defaulted attribute} \\
1586 \DWATlouser&0x2000 & --- \addtoindexx{low user attribute encoding}  \\
1587 \DWAThiuser&\xiiifff& --- \addtoindexx{high user attribute encoding}  \\
1588
1589 \end{longtable} 
1590 \end{centering}
1591
1592 The attribute form governs how the value of the attribute is
1593 encoded. There are nine classes of form, listed below. Each
1594 class is a set of forms which have related representations
1595 and which are given a common interpretation according to the
1596 attribute in which the form is used.
1597
1598 Form \DWFORMsecoffsetTARG{} 
1599 is a member of more 
1600 \addtoindexx{rangelistptr class}
1601 than 
1602 \addtoindexx{macptr class}
1603 one 
1604 \addtoindexx{loclistptr class}
1605 class,
1606 \addtoindexx{lineptr class}
1607 namely 
1608 \CLASSaddrptr, 
1609 \CLASSlineptr, 
1610 \CLASSloclistptr, 
1611 \CLASSmacptr,  
1612 \CLASSrangelistptr{} or
1613 \CLASSstroffsetsptr; 
1614 the list of classes allowed by the applicable attribute in 
1615 Table \refersec{tab:attributeencodings}
1616 determines the class of the form.
1617
1618 \needlines{4}
1619 In the form descriptions that follow, some forms are said
1620 to depend in part on the value of an attribute of the
1621 \definition{\associatedcompilationunit}:
1622 \begin{itemize}
1623 \item
1624 In the case of a \splitDWARFobjectfile{}, the associated
1625 compilation unit is the skeleton compilation unit corresponding 
1626 to the containing unit.
1627 \item Otherwise, the associated compilation unit 
1628 is the containing unit.
1629 \end{itemize}
1630
1631 \needlines{4}
1632 Each possible form belongs to one or more of the following classes
1633 (see Table \refersec{tab:classesofattributevalue} for a summary of
1634 the purpose and general usage of each class):
1635
1636 \begin{itemize}
1637 \item \livelinki{chap:classaddress}{address}{address class} \\
1638 \livetarg{datarep:classaddress}{}
1639 Represented as either:
1640 \begin{itemize}
1641 \item An object of appropriate size to hold an
1642 address on the target machine 
1643 (\DWFORMaddrTARG). 
1644 The size is encoded in the compilation unit header 
1645 (see Section \refersec{datarep:compilationunitheader}).
1646 This address is relocatable in a relocatable object file and
1647 is relocated in an executable file or shared object file.
1648
1649 \item An indirect index into a table of addresses (as 
1650 described in the previous bullet) in the
1651 \dotdebugaddr{} section (\DWFORMaddrxTARG). 
1652 The representation of a \DWFORMaddrxNAME{} value is an unsigned
1653 \addtoindex{LEB128} value, which is interpreted as a zero-based 
1654 index into an array of addresses in the \dotdebugaddr{} section.
1655 The index is relative to the value of the \DWATaddrbase{} attribute 
1656 of the associated compilation unit.
1657
1658 \end{itemize}
1659
1660 \needlines{5}
1661 \item \livelink{chap:classaddrptr}{addrptr} \\
1662 \livetarg{datarep:classaddrptr}{}
1663 This is an offset into the \dotdebugaddr{} section (\DWFORMsecoffset). It
1664 consists of an offset from the beginning of the \dotdebugaddr{} section to the
1665 beginning of the list of machine addresses information for the
1666 referencing entity. It is relocatable in
1667 a relocatable object file, and relocated in an executable or
1668 shared object file. In the \thirtytwobitdwarfformat, this offset
1669 is a 4-byte unsigned value; in the 64-bit DWARF
1670 format, it is an 8-byte unsigned value (see Section
1671 \refersec{datarep:32bitand64bitdwarfformats}).
1672
1673 \textit{This class is new in \DWARFVersionV.}
1674
1675 \needlines{4}
1676 \item \livelink{chap:classblock}{block} \\
1677 \livetarg{datarep:classblock}{}
1678 Blocks come in four forms:
1679 \begin{itemize}
1680 \item
1681 A 1-byte length followed by 0 to 255 contiguous information
1682 bytes (\DWFORMblockoneTARG).
1683
1684 \item
1685 A 2-byte length followed by 0 to 65,535 contiguous information
1686 bytes (\DWFORMblocktwoTARG).
1687
1688 \item
1689 A 4-byte length followed by 0 to 4,294,967,295 contiguous
1690 information bytes (\DWFORMblockfourTARG).
1691
1692 \item
1693 An unsigned LEB128\addtoindexx{LEB128!unsigned}
1694 length followed by the number of bytes
1695 specified by the length (\DWFORMblockTARG).
1696 \end{itemize}
1697
1698 In all forms, the length is the number of information bytes
1699 that follow. The information bytes may contain any mixture
1700 of relocated (or relocatable) addresses, references to other
1701 debugging information entries or data bytes.
1702
1703 \item \livelinki{chap:classconstant}{constant}{constant class} \\
1704 \livetarg{datarep:classconstant}{}
1705 There are eight forms of constants. There are fixed length
1706 constant data forms for one-, two-, four-, eight- and sixteen-byte values
1707 (respectively, 
1708 \DWFORMdataoneTARG, 
1709 \DWFORMdatatwoTARG, 
1710 \DWFORMdatafourTARG,
1711 \DWFORMdataeightTARG{} and
1712 \DWFORMdatasixteenTARG). 
1713 There are also variable length constant
1714 data forms encoded using LEB128 numbers (see below). 
1715 Both signed (\DWFORMsdataTARG) and unsigned 
1716 (\DWFORMudataTARG) variable length constants are available.
1717 There is also an implicit constant (\DWFORMimplicitconst),
1718 whose value is provided as part of the abbreviation
1719 declaration.
1720
1721 \needlines{4}
1722 The data in \DWFORMdataone, 
1723 \DWFORMdatatwo, 
1724 \DWFORMdatafour{}, 
1725 \DWFORMdataeight{} and
1726 \DWFORMdatasixteen{} 
1727 can be anything. Depending on context, it may
1728 be a signed integer, an unsigned integer, a floating\dash point
1729 constant, or anything else. A consumer must use context to
1730 know how to interpret the bits, which if they are target
1731 machine data (such as an integer or floating-point constant)
1732 will be in target machine \byteorder.
1733
1734 \textit{If one of the \DWFORMdataTARG\textless n\textgreater 
1735 forms is used to represent a
1736 signed or unsigned integer, it can be hard for a consumer
1737 to discover the context necessary to determine which
1738 interpretation is intended. Producers are therefore strongly
1739 encouraged to use \DWFORMsdata{} or 
1740 \DWFORMudata{} for signed and
1741 unsigned integers respectively, rather than 
1742 \DWFORMdata\textless n\textgreater.}
1743
1744 \needlines{4}
1745 \item \livelinki{chap:classexprloc}{exprloc}{exprloc class} \\
1746 \livetarg{datarep:classexprloc}{}
1747 This is an unsigned LEB128\addtoindexx{LEB128!unsigned} length followed by the
1748 number of information bytes specified by the length
1749 (\DWFORMexprlocTARG). 
1750 The information bytes contain a DWARF expression 
1751 (see Section \refersec{chap:dwarfexpressions}) 
1752 or location description 
1753 (see Section \refersec{chap:locationdescriptions}).
1754
1755 \needlines{4}
1756 \item \livelinki{chap:classflag}{flag}{flag class} \\
1757 \livetarg{datarep:classflag}{}
1758 A flag \addtoindexx{flag class}
1759 is represented explicitly as a single byte of data
1760 (\DWFORMflagTARG) or 
1761 implicitly (\DWFORMflagpresentTARG). 
1762 In the
1763 first case, if the \nolink{flag} has value zero, it indicates the
1764 absence of the attribute; if the \nolink{flag} has a non\dash zero value,
1765 it indicates the presence of the attribute. In the second
1766 case, the attribute is implicitly indicated as present, and
1767 no value is encoded in the debugging information entry itself.
1768
1769 \item \livelinki{chap:classlineptr}{lineptr}{lineptr class} \\
1770 \livetarg{datarep:classlineptr}{}
1771 This is an offset into 
1772 \addtoindexx{section offset!in class lineptr value}
1773 the 
1774 \dotdebugline{} or \dotdebuglinedwo{} section
1775 (\DWFORMsecoffset).
1776 It consists of an offset from the beginning of the 
1777 \dotdebugline{}
1778 section to the first byte of
1779 the data making up the line number list for the compilation
1780 unit. 
1781 It is relocatable in a relocatable object file, and
1782 relocated in an executable or shared object file. In the 
1783 \thirtytwobitdwarfformat, this offset is a 4-byte unsigned value;
1784 in the \sixtyfourbitdwarfformat, it is an 8-byte unsigned value
1785 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
1786
1787
1788 \item \livelinki{chap:classloclistptr}{loclistptr}{loclistptr class} \\
1789 \livetarg{datarep:classloclistptr}{}
1790 This is an offset into the 
1791 \dotdebugloc{}
1792 section
1793 (\DWFORMsecoffset). 
1794 It consists of an offset from the
1795 \addtoindexx{section offset!in class loclistptr value}
1796 beginning of the 
1797 \dotdebugloc{}
1798 section to the first byte of
1799 the data making up the 
1800 \addtoindex{location list} for the compilation unit. 
1801 It is relocatable in a relocatable object file, and
1802 relocated in an executable or shared object file. In the 
1803 \thirtytwobitdwarfformat, this offset is a 4-byte unsigned value;
1804 in the \sixtyfourbitdwarfformat, it is an 8-byte unsigned value
1805 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
1806
1807
1808 \item \livelinki{chap:classmacptr}{macptr}{macptr class} \\
1809 \livetarg{datarep:classmacptr}{}
1810 This is an 
1811 \addtoindexx{section offset!in class macptr value}
1812 offset into the 
1813 \dotdebugmacro{} or \dotdebugmacrodwo{} section
1814 (\DWFORMsecoffset). 
1815 It consists of an offset from the beginning of the 
1816 \dotdebugmacro{} or \dotdebugmacrodwo{} 
1817 section to the the header making up the 
1818 macro information list for the compilation unit. 
1819 It is relocatable in a relocatable object file, and
1820 relocated in an executable or shared object file. In the 
1821 \thirtytwobitdwarfformat, this offset is a 4-byte unsigned value;
1822 in the \sixtyfourbitdwarfformat, it is an 8-byte unsigned value
1823 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
1824
1825 \needlines{4}
1826 \item \livelinki{chap:classrangelistptr}{rangelistptr}{rangelistptr class} \\
1827 \livetarg{datarep:classrangelistptr}{}
1828 This is an 
1829 \addtoindexx{section offset!in class rangelistptr value}
1830 offset into the \dotdebugranges{} section
1831 (\DWFORMsecoffset). 
1832 It consists of an
1833 offset from the beginning of the 
1834 \dotdebugranges{} section
1835 to the beginning of the non\dash contiguous address ranges
1836 information for the referencing entity.  
1837 It is relocatable in
1838 a relocatable object file, and relocated in an executable or
1839 shared object file. 
1840 However, if a \DWATrangesbase{} attribute applies, the offset
1841 is relative to the base offset given by \DWATrangesbase.
1842 In the \thirtytwobitdwarfformat, this offset
1843 is a 4-byte unsigned value; in the 64-bit DWARF
1844 format, it is an 8-byte unsigned value (see Section
1845 \refersec{datarep:32bitand64bitdwarfformats}).
1846 \end{itemize}
1847
1848 \textit{Because classes
1849 \CLASSaddrptr, 
1850 \CLASSlineptr, 
1851 \CLASSloclistptr, 
1852 \CLASSmacptr, 
1853 \CLASSrangelistptr{} and
1854 \CLASSstroffsetsptr{}
1855 share a common representation, it is not possible for an
1856 attribute to allow more than one of these classes}
1857
1858
1859 \begin{itemize}
1860 \item \livelinki{chap:classreference}{reference}{reference class} \\
1861 \livetarg{datarep:classreference}{}
1862 There are four types of reference.
1863
1864 The 
1865 \addtoindexx{reference class}
1866 first type of reference can identify any debugging
1867 information entry within the containing unit. 
1868 This type of
1869 reference is an 
1870 \addtoindexx{section offset!in class reference value}
1871 offset from the first byte of the compilation
1872 header for the compilation unit containing the reference. There
1873 are five forms for this type of reference. There are fixed
1874 length forms for one, two, four and eight byte offsets
1875 (respectively,
1876 \DWFORMrefnMARK 
1877 \DWFORMrefoneTARG, 
1878 \DWFORMreftwoTARG, 
1879 \DWFORMreffourTARG,
1880 and \DWFORMrefeightTARG). 
1881 There is also an unsigned variable
1882 length offset encoded form that uses 
1883 unsigned LEB128\addtoindexx{LEB128!unsigned} numbers
1884 (\DWFORMrefudataTARG). 
1885 Because this type of reference is within
1886 the containing compilation unit no relocation of the value
1887 is required.
1888
1889 The second type of reference can identify any debugging
1890 information entry within a 
1891 \dotdebuginfo{} section; in particular,
1892 it may refer to an entry in a different compilation unit
1893 from the unit containing the reference, and may refer to an
1894 entry in a different shared object file.  This type of reference
1895 (\DWFORMrefaddrTARG) 
1896 is an offset from the beginning of the
1897 \dotdebuginfo{} 
1898 section of the target executable or shared object file, or, for
1899 references within a \addtoindex{supplementary object file}, 
1900 an offset from the beginning of the local \dotdebuginfo{} section;
1901 it is relocatable in a relocatable object file and frequently
1902 relocated in an executable or shared object file. For
1903 references from one shared object or static executable file
1904 to another, the relocation and identification of the target
1905 object must be performed by the consumer. In the 
1906 \thirtytwobitdwarfformat, this offset is a 4-byte unsigned value; 
1907 in the \sixtyfourbitdwarfformat, it is an 8-byte
1908 unsigned value 
1909 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
1910
1911 \textit{A debugging information entry that may be referenced by
1912 another compilation unit using 
1913 \DWFORMrefaddr{} must have a global symbolic name.}
1914
1915 \textit{For a reference from one executable or shared object file to
1916 another, the reference is resolved by the debugger to identify
1917 the executable or shared object file and the offset into that
1918 file\textquoteright s \dotdebuginfo{}
1919 section in the same fashion as the run
1920 time loader, either when the debug information is first read,
1921 or when the reference is used.}
1922
1923 The third type of reference can identify any debugging
1924 information type entry that has been placed in its own
1925 \addtoindex{type unit}. This type of 
1926 reference (\DWFORMrefsigeightTARG) is the
1927 \addtoindexx{type signature}
1928 8-byte type signature 
1929 (see Section \refersec{datarep:typesignaturecomputation}) 
1930 that was computed for the type. 
1931
1932 The fourth type of reference is a reference from within the 
1933 \dotdebuginfo{} section of the executable or shared object file to
1934 a debugging information entry in the \dotdebuginfo{} section of 
1935 a \addtoindex{supplementary object file}.
1936 This type of reference (\DWFORMrefsupTARG) is an offset from the 
1937 beginning of the \dotdebuginfo{} section in the 
1938 \addtoindex{supplementary object file}.
1939
1940 \textit{The use of compilation unit relative references will reduce the
1941 number of link\dash time relocations and so speed up linking. The
1942 use of the second, third and fourth type of reference allows for the
1943 sharing of information, such as types, across compilation
1944 units, while the fourth type further allows for sharing of information 
1945 across compilation units from different executables or shared object files.}
1946
1947 \textit{A reference to any kind of compilation unit identifies the
1948 debugging information entry for that unit, not the preceding
1949 header.}
1950
1951 \needlines{4}
1952 \item \livelinki{chap:classstring}{string}{string class} \\
1953 \livetarg{datarep:classstring}{}
1954 A string is a sequence of contiguous non\dash null bytes followed by
1955 one null byte. 
1956 \addtoindexx{string class}
1957 A string may be represented: 
1958 \begin{itemize}
1959 \setlength{\itemsep}{0em}
1960 \item immediately in the debugging information entry itself 
1961 (\DWFORMstringTARG), 
1962
1963 \item as an 
1964 \addtoindexx{section offset!in class string value}
1965 offset into a string table contained in
1966 the \dotdebugstr{} section of the object file (\DWFORMstrpTARG), 
1967 the \dotdebuglinestr{} section of the object file (\DWFORMlinestrpTARG),
1968 or as an offset into a string table contained in the
1969 \dotdebugstr{} section of a \addtoindex{supplementary object file} 
1970 (\DWFORMstrpsupTARG).  \DWFORMstrpsupNAME{} offsets from the \dotdebuginfo{}  
1971 section of a \addtoindex{supplementary object file}
1972 refer to the local \dotdebugstr{} section of that same file.
1973 In the \thirtytwobitdwarfformat, the representation of a 
1974 \DWFORMstrpNAME{}, \DWFORMstrpNAME{} or \DWFORMstrpsupNAME{}
1975 value is a 4-byte unsigned offset; in the \sixtyfourbitdwarfformat,
1976 it is an 8-byte unsigned offset 
1977 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
1978
1979 \needlines{6}
1980 \item as an indirect offset into the string table using an 
1981 index into a table of offsets contained in the 
1982 \dotdebugstroffsets{} section of the object file (\DWFORMstrxTARG).
1983 The representation of a \DWFORMstrxNAME{} value is an unsigned 
1984 \addtoindex{LEB128} value, which is interpreted as a zero-based 
1985 index into an array of offsets in the \dotdebugstroffsets{} section. 
1986 The offset entries in the \dotdebugstroffsets{} section have the 
1987 same representation as \DWFORMstrp{} values.
1988 \end{itemize}
1989 Any combination of these three forms may be used within a single compilation.
1990
1991 If the \DWATuseUTFeight{}
1992 \addtoindexx{use UTF8 attribute}\addtoindexx{UTF-8} attribute is specified for the
1993 compilation, partial, skeleton or type unit entry, string values are encoded using the
1994 UTF\dash 8 (\addtoindex{Unicode} Transformation Format\dash 8) from the Universal
1995 Character Set standard (ISO/IEC 10646\dash 1:1993).
1996 \addtoindexx{ISO 10646 character set standard}
1997 Otherwise, the string representation is unspecified.
1998
1999 \textit{The \addtoindex{Unicode} Standard Version 3 is fully compatible with
2000 ISO/IEC 10646\dash 1:1993. 
2001 \addtoindexx{ISO 10646 character set standard}
2002 It contains all the same characters
2003 and encoding points as ISO/IEC 10646, as well as additional
2004 information about the characters and their use.}
2005
2006 \textit{Earlier versions of DWARF did not specify the representation
2007 of strings; for compatibility, this version also does
2008 not. However, the UTF\dash 8 representation is strongly recommended.}
2009
2010 \needlines{4}
2011 \item \livelinki{chap:classstroffsetsptr}{stroffsetsptr}{stroffsetsptr class} \\
2012 \livetarg{datarep:classstroffsetsptr}{}
2013 This is an offset into the \dotdebugstroffsets{} section 
2014 (\DWFORMsecoffset). It consists of an offset from the beginning of the 
2015 \dotdebugstroffsets{} section to the
2016 beginning of the string offsets information for the
2017 referencing entity. It is relocatable in
2018 a relocatable object file, and relocated in an executable or
2019 shared object file. In the \thirtytwobitdwarfformat, this offset
2020 is a 4-byte unsigned value; in the \sixtyfourbitdwarfformat,
2021 it is an 8-byte unsigned value (see Section
2022 \refersec{datarep:32bitand64bitdwarfformats}).
2023
2024 \textit{This class is new in \DWARFVersionV.}
2025
2026 \end{itemize}
2027
2028 In no case does an attribute use one of the classes 
2029 \CLASSaddrptr,
2030 \CLASSlineptr,
2031 \CLASSloclistptr, 
2032 \CLASSmacptr, 
2033 \CLASSrangelistptr{} or 
2034 \CLASSstroffsetsptr{}
2035 to point into either the
2036 \dotdebuginfo{} or \dotdebugstr{} section.
2037
2038 The form encodings are listed in 
2039 Table \referfol{tab:attributeformencodings}.
2040
2041 \needlines{8}
2042 \begin{centering}
2043 \setlength{\extrarowheight}{0.1cm}
2044 \begin{longtable}{l|c|l}
2045   \caption{Attribute form encodings} \label{tab:attributeformencodings} \\
2046   \hline \bfseries Form name&\bfseries Value &\bfseries Classes \\ \hline
2047 \endfirsthead
2048   \bfseries Form name&\bfseries Value &\bfseries Classes\\ \hline
2049 \endhead
2050   \hline \emph{Continued on next page}
2051 \endfoot
2052   \hline \ddag\ \textit{New in DWARF Version 5}
2053 \endlastfoot
2054
2055 \DWFORMaddr &0x01&\livelink{chap:classaddress}{address}  \\
2056 \textit{Reserved} &0x02& \\
2057 \DWFORMblocktwo &0x03&\livelink{chap:classblock}{block} \\
2058 \DWFORMblockfour &0x04&\livelink{chap:classblock}{block}  \\
2059 \DWFORMdatatwo &0x05&\livelink{chap:classconstant}{constant} \\
2060 \DWFORMdatafour &0x06&\livelink{chap:classconstant}{constant} \\
2061 \DWFORMdataeight &0x07&\livelink{chap:classconstant}{constant} \\
2062 \DWFORMstring&0x08&\livelink{chap:classstring}{string} \\
2063 \DWFORMblock&0x09&\livelink{chap:classblock}{block} \\
2064 \DWFORMblockone &0x0a&\livelink{chap:classblock}{block} \\
2065 \DWFORMdataone &0x0b&\livelink{chap:classconstant}{constant} \\
2066 \DWFORMflag&0x0c&\livelink{chap:classflag}{flag} \\
2067 \DWFORMsdata&0x0d&\livelink{chap:classconstant}{constant}    \\
2068 \DWFORMstrp&0x0e&\livelink{chap:classstring}{string}         \\
2069 \DWFORMudata&0x0f&\livelink{chap:classconstant}{constant}         \\
2070 \DWFORMrefaddr&0x10&\livelink{chap:classreference}{reference}         \\
2071 \DWFORMrefone&0x11&\livelink{chap:classreference}{reference}          \\
2072 \DWFORMreftwo&0x12&\livelink{chap:classreference}{reference}         \\
2073 \DWFORMreffour&0x13&\livelink{chap:classreference}{reference}         \\
2074 \DWFORMrefeight&0x14&\livelink{chap:classreference}{reference} \\
2075 \DWFORMrefudata&0x15&\livelink{chap:classreference}{reference}  \\
2076 \DWFORMindirect&0x16&(see Section \refersec{datarep:abbreviationstables}) \\
2077 \DWFORMsecoffset{} &0x17& \CLASSaddrptr, \CLASSlineptr, \CLASSloclistptr, \\
2078                    &    & \CLASSmacptr, \CLASSrangelistptr, \CLASSstroffsetsptr \\
2079 \DWFORMexprloc{} &0x18&\livelink{chap:classexprloc}{exprloc} \\
2080 \DWFORMflagpresent{} &0x19&\livelink{chap:classflag}{flag} \\
2081 \DWFORMstrx{} \ddag &0x1a&\livelink{chap:classstring}{string} \\
2082 \DWFORMaddrx{} \ddag &0x1b&\livelink{chap:classaddress}{address} \\
2083 \DWFORMrefsup{}~\ddag &0x1c &\livelink{chap:classreference}{reference} \\
2084 \DWFORMstrpsup{}~\ddag &0x1d &\livelink{chap:classstring}{string} \\
2085 \DWFORMdatasixteen~\ddag &0x1e &\CLASSconstant \\
2086 \DWFORMlinestrp~\ddag &0x1f &\CLASSstring \\
2087 \DWFORMrefsigeight &0x20 &\livelink{chap:classreference}{reference} \\
2088 \DWFORMimplicitconst~\ddag &0x21 &\CLASSconstant \\
2089 \end{longtable}
2090 \end{centering}
2091
2092
2093 \needlines{6}
2094 \section{Variable Length Data}
2095 \label{datarep:variablelengthdata}
2096 \addtoindexx{variable length data|see {LEB128}}
2097 Integers may be 
2098 \addtoindexx{Little Endian Base 128|see{LEB128}}
2099 encoded using \doublequote{Little Endian Base 128}
2100 \addtoindexx{little-endian encoding|see{endian attribute}}
2101 (LEB128) numbers. 
2102 \addtoindexx{LEB128}
2103 LEB128 is a scheme for encoding integers
2104 densely that exploits the assumption that most integers are
2105 small in magnitude.
2106
2107 \textit{This encoding is equally suitable whether the target machine
2108 architecture represents data in big-endian or little-endian
2109 \byteorder. It is \doublequote{little-endian} only in the sense that it
2110 avoids using space to represent the \doublequote{big} end of an
2111 unsigned integer, when the big end is all zeroes or sign
2112 extension bits.}
2113
2114 Unsigned LEB128\addtoindexx{LEB128!unsigned} (\addtoindex{ULEB128}) 
2115 numbers are encoded as follows:
2116 \addtoindexx{LEB128!unsigned, encoding as}
2117 start at the low order end of an unsigned integer and chop
2118 it into 7-bit chunks. Place each chunk into the low order 7
2119 bits of a byte. Typically, several of the high order bytes
2120 will be zero; discard them. Emit the remaining bytes in a
2121 stream, starting with the low order byte; set the high order
2122 bit on each byte except the last emitted byte. The high bit
2123 of zero on the last byte indicates to the decoder that it
2124 has encountered the last byte.
2125
2126 The integer zero is a special case, consisting of a single
2127 zero byte.
2128
2129 Table \refersec{tab:examplesofunsignedleb128encodings}
2130 gives some examples of unsigned LEB128\addtoindexx{LEB128!unsigned}
2131 numbers. The
2132 0x80 in each case is the high order bit of the byte, indicating
2133 that an additional byte follows.
2134
2135
2136 The encoding for signed, two\textquoteright{s} complement LEB128 
2137 (\addtoindex{SLEB128}) \addtoindexx{LEB128!signed, encoding as}
2138 numbers is similar, except that the criterion for discarding
2139 high order bytes is not whether they are zero, but whether
2140 they consist entirely of sign extension bits. Consider the
2141 4-byte integer -2. The three high level bytes of the number
2142 are sign extension, thus LEB128 would represent it as a single
2143 byte containing the low order 7 bits, with the high order
2144 bit cleared to indicate the end of the byte stream. Note
2145 that there is nothing within the LEB128 representation that
2146 indicates whether an encoded number is signed or unsigned. The
2147 decoder must know what type of number to expect. 
2148 Table \refersec{tab:examplesofunsignedleb128encodings}
2149 gives some examples of unsigned LEB128\addtoindexx{LEB128!unsigned}
2150 numbers and Table \refersec{tab:examplesofsignedleb128encodings}
2151 gives some examples of signed LEB128\addtoindexx{LEB128!signed} 
2152 numbers.
2153
2154 \textit{Appendix \refersec{app:variablelengthdataencodingdecodinginformative} 
2155 \addtoindexx{LEB128!examples}
2156 gives algorithms for encoding and decoding these forms.}
2157
2158 \needlines{8}
2159 \begin{centering}
2160 \setlength{\extrarowheight}{0.1cm}
2161 \begin{longtable}{c|c|c}
2162   \caption{Examples of unsigned LEB128 encodings}
2163   \label{tab:examplesofunsignedleb128encodings} 
2164   \addtoindexx{LEB128 encoding!examples}\addtoindexx{LEB128!unsigned} \\
2165   \hline \bfseries Number&\bfseries First byte &\bfseries Second byte \\ \hline
2166 \endfirsthead
2167   \bfseries Number&\bfseries First Byte &\bfseries Second byte\\ \hline
2168 \endhead
2169   \hline \emph{Continued on next page}
2170 \endfoot
2171   \hline
2172 \endlastfoot
2173 2&2& --- \\
2174 127&127& ---\\
2175 128& 0 + 0x80 & 1 \\
2176 129& 1 + 0x80 & 1 \\
2177 %130& 2 + 0x80 & 1 \\
2178 12857& 57 + 0x80 & 100 \\
2179 \end{longtable}
2180 \end{centering}
2181
2182
2183
2184 \begin{centering}
2185 \setlength{\extrarowheight}{0.1cm}
2186 \begin{longtable}{c|c|c}
2187   \caption{Examples of signed LEB128 encodings} 
2188   \label{tab:examplesofsignedleb128encodings} 
2189   \addtoindexx{LEB128!signed} \\
2190   \hline \bfseries Number&\bfseries First byte &\bfseries Second byte \\ \hline
2191 \endfirsthead
2192   \bfseries Number&\bfseries First Byte &\bfseries Second byte\\ \hline
2193 \endhead
2194   \hline \emph{Continued on next page}
2195 \endfoot
2196   \hline
2197 \endlastfoot
2198 2&2& --- \\
2199 -2&0x7e& ---\\
2200 127& 127 + 0x80 & 0 \\
2201 -127& 1 + 0x80 & 0x7f \\
2202 128& 0 + 0x80 & 1 \\
2203 -128& 0 + 0x80 & 0x7f \\
2204 129& 1 + 0x80 & 1 \\
2205 -129& 0x7f + 0x80 & 0x7e \\
2206
2207 \end{longtable}
2208 \end{centering}
2209
2210
2211
2212 \section{DWARF Expressions and Location Descriptions}
2213 \label{datarep:dwarfexpressionsandlocationdescriptions}
2214 \subsection{DWARF Expressions}
2215 \label{datarep:dwarfexpressions}
2216
2217
2218 \addtoindexx{DWARF expression!operator encoding}
2219 DWARF expression is stored in a \nolink{block} of contiguous
2220 bytes. The bytes form a sequence of operations. Each operation
2221 is a 1-byte code that identifies that operation, followed by
2222 zero or more bytes of additional data. The encodings for the
2223 operations are described in 
2224 Table \refersec{tab:dwarfoperationencodings}. 
2225
2226 \begin{centering}
2227 \setlength{\extrarowheight}{0.1cm}
2228 \begin{longtable}{l|c|c|l}
2229   \caption{DWARF operation encodings} \label{tab:dwarfoperationencodings} \\
2230   \hline & &\bfseries No. of  &\\ 
2231   \bfseries Operation&\bfseries Code &\bfseries Operands &\bfseries Notes\\ \hline
2232 \endfirsthead
2233    & &\bfseries No. of &\\ 
2234   \bfseries Operation&\bfseries Code &\bfseries  Operands &\bfseries Notes\\ \hline
2235 \endhead
2236   \hline \emph{Continued on next page}
2237 \endfoot
2238   \hline \ddag\ \textit{New in DWARF Version 5}
2239 \endlastfoot
2240
2241 \DWOPaddr&0x03&1 & constant address  \\ 
2242 & & &(size is target specific) \\
2243
2244 \DWOPderef&0x06&0 & \\
2245
2246 \DWOPconstoneu&0x08&1&1-byte constant  \\
2247 \DWOPconstones&0x09&1&1-byte constant   \\
2248 \DWOPconsttwou&0x0a&1&2-byte constant   \\
2249 \DWOPconsttwos&0x0b&1&2-byte constant   \\
2250 \DWOPconstfouru&0x0c&1&4-byte constant    \\
2251 \DWOPconstfours&0x0d&1&4-byte constant   \\
2252 \DWOPconsteightu&0x0e&1&8-byte constant   \\
2253 \DWOPconsteights&0x0f&1&8-byte constant   \\
2254 \DWOPconstu&0x10&1&ULEB128 constant   \\
2255 \DWOPconsts&0x11&1&SLEB128 constant   \\
2256 \DWOPdup&0x12&0 &   \\
2257 \DWOPdrop&0x13&0  &   \\
2258 \DWOPover&0x14&0 &   \\
2259 \DWOPpick&0x15&1&1-byte stack index   \\
2260 \DWOPswap&0x16&0 &   \\
2261 \DWOProt&0x17&0 &   \\
2262 \DWOPxderef&0x18&0 &   \\
2263 \DWOPabs&0x19&0 &   \\
2264 \DWOPand&0x1a&0 &   \\
2265 \DWOPdiv&0x1b&0 &   \\
2266 \DWOPminus&0x1c&0 & \\
2267 \DWOPmod&0x1d&0 & \\
2268 \DWOPmul&0x1e&0 & \\
2269 \DWOPneg&0x1f&0 & \\
2270 \DWOPnot&0x20&0 & \\
2271 \DWOPor&0x21&0 & \\
2272 \DWOPplus&0x22&0 & \\
2273 \DWOPplusuconst&0x23&1&ULEB128 addend \\
2274 \DWOPshl&0x24&0 & \\
2275 \DWOPshr&0x25&0 & \\
2276 \DWOPshra&0x26&0 & \\
2277 \DWOPxor&0x27&0 & \\
2278
2279 \DWOPbra&0x28&1 & signed 2-byte constant \\
2280 \DWOPeq&0x29&0 & \\
2281 \DWOPge&0x2a&0 & \\
2282 \DWOPgt&0x2b&0 & \\
2283 \DWOPle&0x2c&0 & \\
2284 \DWOPlt&0x2d&0  & \\
2285 \DWOPne&0x2e&0 & \\
2286 \DWOPskip&0x2f&1&signed 2-byte constant \\ \hline
2287
2288 \DWOPlitzero & 0x30 & 0 & \\
2289 \DWOPlitone  & 0x31 & 0& literals 0 .. 31 = \\
2290 \ldots & & &\hspace{0.3cm}(\DWOPlitzero{} + literal) \\
2291 \DWOPlitthirtyone & 0x4f & 0 & \\ \hline
2292
2293 \DWOPregzero & 0x50 & 0 & \\*
2294 \DWOPregone  & 0x51 & 0&reg 0 .. 31 = \\*
2295 \ldots & & &\hspace{0.3cm}(\DWOPregzero{} + regnum) \\*
2296 \DWOPregthirtyone & 0x6f & 0 & \\ \hline
2297
2298 \DWOPbregzero & 0x70 &1 & SLEB128 offset \\*
2299 \DWOPbregone  & 0x71 & 1 &base register 0 .. 31 = \\*
2300 ... & &              &\hspace{0.3cm}(\DWOPbregzero{} + regnum) \\*
2301 \DWOPbregthirtyone & 0x8f & 1 & \\ \hline
2302
2303 \DWOPregx{} & 0x90 &1&ULEB128 register \\
2304 \DWOPfbreg{} & 0x91&1&SLEB128 offset \\
2305 \DWOPbregx{} & 0x92&2 &ULEB128 register, \\*
2306                   & & &SLEB128 offset \\
2307 \DWOPpiece{} & 0x93 &1& ULEB128 size of piece \\
2308 \DWOPderefsize{} & 0x94 &1& 1-byte size of data retrieved \\
2309 \DWOPxderefsize{} & 0x95&1&1-byte size of data retrieved \\
2310 \DWOPnop{} & 0x96 &0& \\
2311
2312 \DWOPpushobjectaddress&0x97&0 &  \\
2313 \DWOPcalltwo&0x98&1& 2-byte offset of DIE \\
2314 \DWOPcallfour&0x99&1& 4-byte offset of DIE \\
2315 \DWOPcallref&0x9a&1& 4\dash\  or 8-byte offset of DIE \\
2316 \DWOPformtlsaddress&0x9b &0& \\
2317 \DWOPcallframecfa{} &0x9c &0& \\
2318 \DWOPbitpiece&0x9d &2&ULEB128 size, \\*
2319                    &&&ULEB128 offset\\
2320 \DWOPimplicitvalue{} &0x9e &2&ULEB128 size, \\*
2321                    &&&\nolink{block} of that size\\
2322 \DWOPstackvalue{} &0x9f &0& \\
2323 \DWOPimplicitpointer{}~\ddag &0xa0& 2 &4- or 8-byte offset of DIE, \\*
2324                               &&&SLEB128 constant offset \\
2325 \DWOPaddrx~\ddag&0xa1&1&ULEB128 indirect address \\
2326 \DWOPconstx~\ddag&0xa2&1&ULEB128 indirect constant   \\
2327 \DWOPentryvalue~\ddag&0xa3&2&ULEB128 size, \\*
2328                    &&&\nolink{block} of that size\\
2329 \DWOPconsttype~\ddag    & 0xa4 & 3 & ULEB128 type entry offset,\\*
2330                                & & & 1-byte size, \\*
2331                                & & & constant value \\
2332 \DWOPregvaltype~\ddag   & 0xa5 & 2 & ULEB128 register number, \\*
2333                                  &&& ULEB128 constant offset \\
2334 \DWOPdereftype~\ddag    & 0xa6 & 2 & 1-byte size, \\*
2335                                  &&& ULEB128 type entry offset \\
2336 \DWOPxdereftype~\ddag   & 0xa7 & 2 & 1-byte size, \\*
2337                                  &&& ULEB128 type entry offset \\
2338 \DWOPconvert~\ddag      & 0xa8 & 1 & ULEB128 type entry offset \\
2339 \DWOPreinterpret~\ddag  & 0xa9 & 1 & ULEB128 type entry offset \\
2340 \DWOPlouser{} &0xe0 && \\
2341 \DWOPhiuser{} &\xff && \\
2342
2343 \end{longtable}
2344 \end{centering}
2345
2346
2347 \subsection{Location Descriptions}
2348 \label{datarep:locationdescriptions}
2349
2350 A location description is used to compute the 
2351 location of a variable or other entity.
2352
2353 \subsection{Location Lists}
2354 \label{datarep:locationlists}
2355
2356 Each entry in a \addtoindex{location list} is either a location list entry,
2357 a base address selection entry, or an 
2358 \addtoindexx{end-of-list entry!in location list}
2359 end-of-list entry.
2360
2361 \needlines{6}
2362 \subsubsection{Location List Entries in Non-Split Objects}
2363 A \addtoindex{location list} entry consists of two address offsets followed
2364 by an unsigned 2-byte length, followed by a block of contiguous bytes
2365 that contains a DWARF location description. The length
2366 specifies the number of bytes in that block. The two offsets
2367 are the same size as an address on the target machine.
2368
2369 \needlines{5}
2370 A base address selection entry and an 
2371 \addtoindexx{end-of-list entry!in location list}
2372 end-of-list entry each
2373 consist of two (constant or relocated) address offsets. The two
2374 offsets are the same size as an address on the target machine.
2375
2376 For a \addtoindex{location list} to be specified, the base address of
2377 \addtoindexx{base address selection entry!in location list}
2378 the corresponding compilation unit must be defined 
2379 (see Section \refersec{chap:normalandpartialcompilationunitentries}).
2380
2381 \subsubsection{Location List Entries in Split Objects}
2382 \label{datarep:locationlistentriesinsplitobjects}
2383 An alternate form for location list entries is used in split objects. 
2384 Each entry begins with an unsigned 1-byte code that indicates the kind of entry
2385 that follows. The encodings for these constants are given in
2386 Table \refersec{tab:locationlistentryencodingvalues}.
2387
2388 \needlines{10}
2389 \begin{centering}
2390 \setlength{\extrarowheight}{0.1cm}
2391 \begin{longtable}{l|c}
2392   \caption{Location list entry encoding values} \label{tab:locationlistentryencodingvalues} \\
2393   \hline \bfseries Location list entry encoding name&\bfseries Value \\ \hline
2394 \endfirsthead
2395   \bfseries Location list entry encoding name&\bfseries Value\\ \hline
2396 \endhead
2397   \hline \emph{Continued on next page}
2398 \endfoot
2399   \hline
2400 \endlastfoot
2401 \DWLLEendoflistentry & 0x0 \\
2402 \DWLLEbaseaddressselectionentry & 0x01 \\
2403 \DWLLEstartendentry & 0x02 \\
2404 \DWLLEstartlengthentry & 0x03 \\
2405 \DWLLEoffsetpairentry & 0x04 \\
2406 \end{longtable}
2407 \end{centering}
2408
2409 \section{Base Type Attribute Encodings}
2410 \label{datarep:basetypeattributeencodings}
2411
2412 The encodings of the 
2413 \hypertarget{chap:DWATencodingencodingofbasetype}{}
2414 constants used in the 
2415 \DWATencodingDEFN{} attribute\addtoindexx{encoding attribute} 
2416 are given in 
2417 Table \refersec{tab:basetypeencodingvalues}
2418
2419 \begin{centering}
2420 \setlength{\extrarowheight}{0.1cm}
2421 \begin{longtable}{l|c}
2422   \caption{Base type encoding values} \label{tab:basetypeencodingvalues} \\
2423   \hline \bfseries Base type encoding name&\bfseries Value \\ \hline
2424 \endfirsthead
2425   \bfseries Base type encoding name&\bfseries Value\\ \hline
2426 \endhead
2427   \hline \emph{Continued on next page}
2428 \endfoot
2429   \hline
2430   \ddag \ \textit{New in \DWARFVersionV}
2431 \endlastfoot
2432 \DWATEaddress&0x01 \\
2433 \DWATEboolean&0x02 \\
2434 \DWATEcomplexfloat&0x03 \\
2435 \DWATEfloat&0x04 \\
2436 \DWATEsigned&0x05 \\
2437 \DWATEsignedchar&0x06 \\
2438 \DWATEunsigned&0x07 \\
2439 \DWATEunsignedchar&0x08 \\
2440 \DWATEimaginaryfloat&0x09 \\
2441 \DWATEpackeddecimal&0x0a \\
2442 \DWATEnumericstring&0x0b \\
2443 \DWATEedited&0x0c \\
2444 \DWATEsignedfixed&0x0d \\
2445 \DWATEunsignedfixed&0x0e \\
2446 \DWATEdecimalfloat & 0x0f \\
2447 \DWATEUTF{} & 0x10 \\
2448 \DWATEUCS~\ddag   & 0x11 \\
2449 \DWATEASCII~\ddag & 0x12 \\
2450 \DWATElouser{} & 0x80 \\
2451 \DWATEhiuser{} & \xff \\
2452 \end{longtable}
2453 \end{centering}
2454
2455 \vspace*{1cm}
2456 The encodings of the constants used in the 
2457 \DWATdecimalsign{} attribute 
2458 are given in 
2459 Table \refersec{tab:decimalsignencodings}.
2460
2461 \begin{centering}
2462 \setlength{\extrarowheight}{0.1cm}
2463 \begin{longtable}{l|c}
2464   \caption{Decimal sign encodings} \label{tab:decimalsignencodings} \\
2465   \hline \bfseries Decimal sign code name&\bfseries Value \\ \hline
2466 \endfirsthead
2467   \bfseries Decimal sign code name&\bfseries Value\\ \hline
2468 \endhead
2469 %  \hline \emph{Continued on next page}
2470 %\endfoot
2471   \hline
2472 \endlastfoot
2473 \DWDSunsigned{}          & 0x01  \\
2474 \DWDSleadingoverpunch{}  & 0x02  \\
2475 \DWDStrailingoverpunch{} & 0x03  \\
2476 \DWDSleadingseparate{}   & 0x04  \\
2477 \DWDStrailingseparate{}  & 0x05 \\ 
2478 \end{longtable}
2479 \end{centering}
2480
2481 \needlines{9}
2482 The encodings of the constants used in the 
2483 \DWATendianity{} attribute are given in 
2484 Table \refersec{tab:endianityencodings}.
2485
2486 \begin{centering}
2487 \setlength{\extrarowheight}{0.1cm}
2488 \begin{longtable}{l|c}
2489   \caption{Endianity encodings} \label{tab:endianityencodings}\\
2490   \hline \bfseries Endian code name&\bfseries Value \\ \hline
2491 \endfirsthead
2492   \bfseries Endian code name&\bfseries Value\\ \hline
2493 \endhead
2494   \hline \emph{Continued on next page}
2495 \endfoot
2496   \hline
2497 \endlastfoot
2498
2499 \DWENDdefault{}  & 0x00 \\
2500 \DWENDbig{} & 0x01 \\
2501 \DWENDlittle{} & 0x02 \\
2502 \DWENDlouser{} & 0x40 \\
2503 \DWENDhiuser{} & \xff \\
2504
2505 \end{longtable}
2506 \end{centering}
2507
2508 \needlines{10}
2509 \section{Accessibility Codes}
2510 \label{datarep:accessibilitycodes}
2511 The encodings of the constants used in the 
2512 \DWATaccessibility{}
2513 attribute 
2514 \addtoindexx{accessibility attribute}
2515 are given in 
2516 Table \refersec{tab:accessibilityencodings}.
2517
2518 \begin{centering}
2519 \setlength{\extrarowheight}{0.1cm}
2520 \begin{longtable}{l|c}
2521   \caption{Accessibility encodings} \label{tab:accessibilityencodings}\\
2522   \hline \bfseries Accessibility code name&\bfseries Value \\ \hline
2523 \endfirsthead
2524   \bfseries Accessibility code name&\bfseries Value\\ \hline
2525 \endhead
2526   \hline \emph{Continued on next page}
2527 \endfoot
2528   \hline
2529 \endlastfoot
2530
2531 \DWACCESSpublic&0x01  \\
2532 \DWACCESSprotected&0x02 \\
2533 \DWACCESSprivate&0x03 \\
2534
2535 \end{longtable}
2536 \end{centering}
2537
2538
2539 \section{Visibility Codes}
2540 \label{datarep:visibilitycodes}
2541 The encodings of the constants used in the 
2542 \DWATvisibility{} attribute are given in 
2543 Table \refersec{tab:visibilityencodings}. 
2544
2545 \begin{centering}
2546 \setlength{\extrarowheight}{0.1cm}
2547 \begin{longtable}{l|c}
2548   \caption{Visibility encodings} \label{tab:visibilityencodings}\\
2549   \hline \bfseries Visibility code name&\bfseries Value \\ \hline
2550 \endfirsthead
2551   \bfseries Visibility code name&\bfseries Value\\ \hline
2552 \endhead
2553   \hline \emph{Continued on next page}
2554 \endfoot
2555   \hline
2556 \endlastfoot
2557
2558 \DWVISlocal&0x01 \\
2559 \DWVISexported&0x02 \\
2560 \DWVISqualified&0x03 \\
2561
2562 \end{longtable}
2563 \end{centering}
2564
2565 \section{Virtuality Codes}
2566 \label{datarep:vitualitycodes}
2567
2568 The encodings of the constants used in the 
2569 \DWATvirtuality{} attribute are given in 
2570 Table \refersec{tab:virtualityencodings}.
2571
2572 \begin{centering}
2573 \setlength{\extrarowheight}{0.1cm}
2574 \begin{longtable}{l|c}
2575   \caption{Virtuality encodings} \label{tab:virtualityencodings}\\
2576   \hline \bfseries Virtuality code name&\bfseries Value \\ \hline
2577 \endfirsthead
2578   \bfseries Virtuality code name&\bfseries Value\\ \hline
2579 \endhead
2580   \hline \emph{Continued on next page}
2581 \endfoot
2582   \hline
2583 \endlastfoot
2584
2585 \DWVIRTUALITYnone&0x00 \\
2586 \DWVIRTUALITYvirtual&0x01 \\
2587 \DWVIRTUALITYpurevirtual&0x02 \\
2588
2589 \end{longtable}
2590 \end{centering}
2591
2592 \needlines{4}
2593 The value 
2594 \DWVIRTUALITYnone{} is equivalent to the absence of the 
2595 \DWATvirtuality{}
2596 attribute.
2597
2598 \section{Source Languages}
2599 \label{datarep:sourcelanguages}
2600
2601 The encodings of the constants used 
2602 \addtoindexx{language attribute, encoding}
2603 in 
2604 \addtoindexx{language name encoding}
2605 the 
2606 \DWATlanguage{}
2607 attribute are given in 
2608 Table \refersec{tab:languageencodings}.
2609 Names marked with
2610 % If we don't force a following space it looks odd
2611 \dag \  
2612 and their associated values are reserved, but the
2613 languages they represent are not well supported. 
2614 Table \refersec{tab:languageencodings}
2615 also shows the 
2616 \addtoindexx{lower bound attribute!default}
2617 default lower bound, if any, assumed for
2618 an omitted \DWATlowerbound{} attribute in the context of a
2619 \DWTAGsubrangetype{} debugging information entry for each
2620 defined language.
2621
2622 \begin{centering}
2623 \setlength{\extrarowheight}{0.1cm}
2624 \begin{longtable}{l|c|c}
2625   \caption{Language encodings} \label{tab:languageencodings}\\
2626   \hline \bfseries Language name&\bfseries Value &\bfseries Default Lower Bound \\ \hline
2627 \endfirsthead
2628   \bfseries Language name&\bfseries Value &\bfseries Default Lower Bound\\ \hline
2629 \endhead
2630   \hline \emph{Continued on next page}
2631 \endfoot
2632   \hline
2633   \dag \ \textit{See text} \\ \ddag \ \textit{New in \DWARFVersionV}
2634 \endlastfoot
2635 \addtoindexx{ISO-defined language names}
2636
2637 \DWLANGCeightynine &0x0001 &0 \addtoindexx{C:1989 (ISO)}      \\
2638 \DWLANGC{} &0x0002 &0  \addtoindexx{C!non-standard} \\
2639 \DWLANGAdaeightythree{} \dag &0x0003 &1  \addtoindexx{Ada:1983 (ISO)}     \\
2640 \DWLANGCplusplus{} &0x0004 &0 \addtoindexx{C++:1998 (ISO)}      \\
2641 \DWLANGCobolseventyfour{} \dag &0x0005 &1 \addtoindexx{COBOL:1974 (ISO)}      \\
2642 \DWLANGCoboleightyfive{} \dag &0x0006 &1 \addtoindexx{COBOL:1985 (ISO)}      \\
2643 \DWLANGFortranseventyseven &0x0007 &1 \addtoindexx{FORTRAN:1977 (ISO)}      \\
2644 \DWLANGFortranninety &0x0008 &1 \addtoindexx{Fortran:1990 (ISO)}      \\
2645 \DWLANGPascaleightythree &0x0009 &1 \addtoindexx{Pascal:1983 (ISO)}      \\
2646 \DWLANGModulatwo &0x000a &1 \addtoindexx{Modula-2:1996 (ISO)}      \\
2647 \DWLANGJava &0x000b &0 \addtoindexx{Java}      \\
2648 \DWLANGCninetynine &0x000c &0 \addtoindexx{C:1999 (ISO)}      \\
2649 \DWLANGAdaninetyfive{} \dag &0x000d &1 \addtoindexx{Ada:1995 (ISO)}      \\
2650 \DWLANGFortranninetyfive &0x000e &1 \addtoindexx{Fortran:1995 (ISO)}      \\
2651 \DWLANGPLI{} \dag &0x000f &1 \addtoindexx{PL/I:1976 (ANSI)}\\
2652 \DWLANGObjC{} &0x0010 &0 \addtoindexx{Objective C}\\
2653 \DWLANGObjCplusplus{} &0x0011 &0 \addtoindexx{Objective C++}\\
2654 \DWLANGUPC{} &0x0012 &0 \addtoindexx{UPC}\\
2655 \DWLANGD{} &0x0013 &0 \addtoindexx{D language}\\
2656 \DWLANGPython{} \dag &0x0014 &0 \addtoindexx{Python}\\
2657 \DWLANGOpenCL{} \dag \ddag &0x0015 &0 \addtoindexx{OpenCL}\\
2658 \DWLANGGo{} \dag \ddag &0x0016 &0 \addtoindexx{Go}\\
2659 \DWLANGModulathree{} \dag \ddag &0x0017 &1 \addtoindexx{Modula-3}\\
2660 \DWLANGHaskell{} \dag \ddag &0x0018 &0 \addtoindexx{Haskell}\\
2661 \DWLANGCpluspluszerothree{} \ddag &0x0019 &0 \addtoindexx{C++:2003 (ISO)}\\
2662 \DWLANGCpluspluseleven{} \ddag &0x001a &0 \addtoindexx{C++:2011 (ISO)}\\
2663 \DWLANGOCaml{} \ddag &0x001b &0 \addtoindexx{OCaml}\\
2664 \DWLANGRust{} \ddag &0x001c &0 \addtoindexx{Rust}\\
2665 \DWLANGCeleven{} \ddag &0x001d &0 \addtoindexx{C:2011 (ISO)}\\
2666 \DWLANGSwift{} \ddag &0x001e &0 \addtoindexx{Swift} \\
2667 \DWLANGJulia{} \ddag &0x001f &1 \addtoindexx{Julia} \\
2668 \DWLANGDylan{} \ddag &0x0020 &0 \addtoindexx{Dylan} \\
2669 \DWLANGCplusplusfourteen{}~\ddag &0x0021 &0 \addtoindexx{C++:2014 (ISO)}     \\
2670 \DWLANGFortranzerothree{}~\ddag  &0x0022 &1 \addtoindexx{Fortran:2004 (ISO)} \\
2671 \DWLANGFortranzeroeight{}~\ddag  &0x0023 &1 \addtoindexx{Fortran:2010 (ISO)} \\
2672 \DWLANGlouser{} &0x8000 & \\
2673 \DWLANGhiuser{} &\xffff & \\
2674
2675 \end{longtable}
2676 \end{centering}
2677
2678 \section{Address Class Encodings}
2679 \label{datarep:addressclassencodings}
2680
2681 The value of the common 
2682 \addtoindex{address class} encoding 
2683 \DWADDRnone{} is 0.
2684
2685 \needlines{16}
2686 \section{Identifier Case}
2687 \label{datarep:identifiercase}
2688
2689 The encodings of the constants used in the 
2690 \DWATidentifiercase{} attribute are given in 
2691 Table \refersec{tab:identifiercaseencodings}.
2692
2693 \needlines{8}
2694 \begin{centering}
2695 \setlength{\extrarowheight}{0.1cm}
2696 \begin{longtable}{l|c}
2697   \caption{Identifier case encodings} \label{tab:identifiercaseencodings}\\
2698   \hline \bfseries Identifier case name&\bfseries Value \\ \hline
2699 \endfirsthead
2700   \bfseries Identifier case name&\bfseries Value\\ \hline
2701 \endhead
2702   \hline \emph{Continued on next page}
2703 \endfoot
2704   \hline
2705 \endlastfoot
2706 \DWIDcasesensitive&0x00     \\
2707 \DWIDupcase&0x01     \\
2708 \DWIDdowncase&0x02     \\
2709 \DWIDcaseinsensitive&0x03     \\
2710 \end{longtable}
2711 \end{centering}
2712
2713 \section{Calling Convention Encodings}
2714 \label{datarep:callingconventionencodings}
2715 The encodings of the constants used in the 
2716 \DWATcallingconvention{} attribute are given in
2717 Table \refersec{tab:callingconventionencodings}.
2718
2719 \begin{centering}
2720 \setlength{\extrarowheight}{0.1cm}
2721 \begin{longtable}{l|c}
2722   \caption{Calling convention encodings} \label{tab:callingconventionencodings}\\
2723   \hline \bfseries Calling convention name&\bfseries Value \\ \hline
2724 \endfirsthead
2725   \bfseries Calling convention name&\bfseries Value\\ \hline
2726 \endhead
2727   \hline \emph{Continued on next page}
2728 \endfoot
2729   \hline \ddag\ \textit{New in DWARF Version 5}
2730 \endlastfoot
2731
2732 \DWCCnormal &0x01     \\
2733 \DWCCprogram&0x02     \\
2734 \DWCCnocall &0x03     \\
2735 \DWCCpassbyreference~\ddag &0x04 \\
2736 \DWCCpassbyvalue~\ddag     &0x05 \\
2737 \DWCClouser &0x40     \\
2738 \DWCChiuser&\xff     \\
2739
2740 \end{longtable}
2741 \end{centering}
2742
2743 \needlines{12}
2744 \section{Inline Codes}
2745 \label{datarep:inlinecodes}
2746
2747 The encodings of the constants used in 
2748 \addtoindexx{inline attribute}
2749 the 
2750 \DWATinline{} attribute are given in 
2751 Table \refersec{tab:inlineencodings}.
2752
2753 \needlines{8}
2754 \begin{centering}
2755 \setlength{\extrarowheight}{0.1cm}
2756 \begin{longtable}{l|c}
2757   \caption{Inline encodings} \label{tab:inlineencodings}\\
2758   \hline \bfseries Inline code name&\bfseries Value \\ \hline
2759 \endfirsthead
2760   \bfseries Inline Code name&\bfseries Value\\ \hline
2761 \endhead
2762   \hline \emph{Continued on next page}
2763 \endfoot
2764   \hline
2765 \endlastfoot
2766
2767 \DWINLnotinlined&0x00      \\
2768 \DWINLinlined&0x01      \\
2769 \DWINLdeclarednotinlined&0x02      \\
2770 \DWINLdeclaredinlined&0x03      \\
2771
2772 \end{longtable}
2773 \end{centering}
2774
2775 % this clearpage is ugly, but the following table came
2776 % out oddly without it.
2777
2778 \section{Array Ordering}
2779 \label{datarep:arrayordering}
2780
2781 The encodings of the constants used in the 
2782 \DWATordering{} attribute are given in 
2783 Table \refersec{tab:orderingencodings}.
2784
2785 \needlines{8}
2786 \begin{centering}
2787 \setlength{\extrarowheight}{0.1cm}
2788 \begin{longtable}{l|c}
2789   \caption{Ordering encodings} \label{tab:orderingencodings}\\
2790   \hline \bfseries Ordering name&\bfseries Value \\ \hline
2791 \endfirsthead
2792   \bfseries Ordering name&\bfseries Value\\ \hline
2793 \endhead
2794   \hline \emph{Continued on next page}
2795 \endfoot
2796   \hline
2797 \endlastfoot
2798
2799 \DWORDrowmajor&0x00  \\
2800 \DWORDcolmajor&0x01  \\
2801
2802 \end{longtable}
2803 \end{centering}
2804
2805
2806 \section{Discriminant Lists}
2807 \label{datarep:discriminantlists}
2808
2809 The descriptors used in 
2810 \addtoindexx{discriminant list attribute}
2811 the 
2812 \DWATdiscrlist{} attribute are 
2813 encoded as 1-byte constants. The
2814 defined values are given in 
2815 Table \refersec{tab:discriminantdescriptorencodings}.
2816
2817 % Odd that the 'Name' field capitalized here, it is not caps elsewhere.
2818 \begin{centering}
2819 \setlength{\extrarowheight}{0.1cm}
2820 \begin{longtable}{l|c}
2821   \caption{Discriminant descriptor encodings} \label{tab:discriminantdescriptorencodings}\\
2822   \hline \bfseries Descriptor name&\bfseries Value \\ \hline
2823 \endfirsthead
2824   \bfseries Descriptor name&\bfseries Value\\ \hline
2825 \endhead
2826   \hline \emph{Continued on next page}
2827 \endfoot
2828   \hline
2829 \endlastfoot
2830
2831 \DWDSClabel&0x00 \\
2832 \DWDSCrange&0x01 \\
2833
2834 \end{longtable}
2835 \end{centering}
2836
2837 \needlines{6}
2838 \section{Name Index Table}
2839 \label{datarep:nameindextable}
2840 The \addtoindexi{version number}{version number!name index table}
2841 in the name index table header is \versiondotdebugnames{}
2842 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
2843
2844 The name index attributes and their encodings are listed in Table \referfol{datarep:indexattributeencodings}.
2845
2846 \begin{centering}
2847 \setlength{\extrarowheight}{0.1cm}
2848 \begin{longtable}{l|c|l}
2849   \caption{Name index attribute encodings} \label{datarep:indexattributeencodings}\\
2850   \hline \bfseries Attribute name &\bfseries Value &\bfseries Form/Class \\ \hline
2851 \endfirsthead
2852   \bfseries Attribute name &\bfseries Value &\bfseries Form/Class \\ \hline
2853 \endhead
2854   \hline \emph{Continued on next page}
2855 \endfoot
2856   \hline
2857   \ddag~\textit{New in \DWARFVersionV}
2858 \endlastfoot
2859 \DWIDXcompileunit~\ddag & 1        & \CLASSconstant \\
2860 \DWIDXtypeunit~\ddag    & 2        & \CLASSconstant \\
2861 \DWIDXdieoffset~\ddag   & 3        & \CLASSreference \\
2862 \DWIDXparent~\ddag      & 4        & \CLASSconstant \\
2863 \DWIDXtypehash~\ddag    & 5        & \DWFORMdataeight \\
2864 \DWIDXlouser~\ddag      & 0x2000   & \\
2865 \DWIDXhiuser~\ddag      & \xiiifff & \\
2866 \end{longtable}
2867 \end{centering}
2868
2869 The abbreviations table ends with an entry consisting of a single 0
2870 byte for the abbreviation code. The size of the table given by
2871 \texttt{abbrev\_table\_size} may include optional padding following the
2872 terminating 0 byte.
2873
2874 \section{Defaulted Member Encodings}
2875 \hypertarget{datarep:defaultedmemberencodings}{}
2876
2877 The encodings of the constants used in the \DWATdefaulted{} attribute
2878 are given in Table \referfol{datarep:defaultedattributeencodings}.
2879
2880 \begin{centering}
2881 \setlength{\extrarowheight}{0.1cm}
2882 \begin{longtable}{l|c}
2883   \caption{Defaulted attribute encodings} \label{datarep:defaultedattributeencodings} \\
2884   \hline \bfseries Defaulted name &\bfseries Value \\ \hline
2885 \endfirsthead
2886   \bfseries Defaulted name &\bfseries Value \\ \hline
2887 \endhead
2888   \hline \emph{Continued on next page}
2889 \endfoot
2890   \hline
2891   \ddag~\textit{New in \DWARFVersionV}
2892 \endlastfoot
2893 \DWDEFAULTEDno~\ddag   & 0x00 \\
2894 \DWDEFAULTEDinclass~\ddag       & 0x01 \\
2895 \DWDEFAULTEDoutofclass~\ddag    & 0x02 \\
2896 \end{longtable}
2897 \end{centering}
2898
2899 \needlines{10}
2900 \section{Address Range Table}
2901 \label{datarep:addrssrangetable}
2902
2903 Each set of entries in the table of address ranges contained
2904 in the \dotdebugaranges{}
2905 section begins with a header containing:
2906 \begin{enumerate}[1. ]
2907 % FIXME The unit length text is not fully consistent across
2908 % these tables.
2909
2910 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length}) \\
2911 \addttindexx{unit\_length}
2912 A 4-byte or 12-byte length containing the length of the
2913 \addtoindexx{initial length}
2914 set of entries for this compilation unit, not including the
2915 length field itself. In the \thirtytwobitdwarfformat, this is a
2916 4-byte unsigned integer (which must be less than \xfffffffzero);
2917 in the \sixtyfourbitdwarfformat, this consists of the 4-byte value
2918 \wffffffff followed by an 8-byte unsigned integer that gives
2919 the actual length 
2920 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
2921
2922 \item version (\HFTuhalf) \\
2923 A 2-byte version identifier representing the version of the
2924 DWARF information for the address range table
2925 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}).
2926
2927 This value in this field \addtoindexx{version number!address range table} is 2. 
2928  
2929 \item debug\_info\_offset (\livelink{datarep:sectionoffsetlength}{section offset}) \\
2930
2931 \addtoindexx{section offset!in .debug\_aranges header}
2932 4-byte or 8-byte offset into the 
2933 \dotdebuginfo{} section of
2934 the compilation unit header. In the \thirtytwobitdwarfformat,
2935 this is a 4-byte unsigned offset; in the \sixtyfourbitdwarfformat,
2936 this is an 8-byte unsigned offset 
2937 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
2938
2939 \item \texttt{address\_size} (\HFTubyte) \\
2940 A 1-byte unsigned integer containing the size in bytes of an
2941 \addttindexx{address\_size}
2942 address 
2943 \addtoindexx{size of an address}
2944 (or the offset portion of an address for segmented
2945 \addtoindexx{address space!segmented}
2946 addressing) on the target system.
2947
2948 \item \HFNsegmentselectorsize{} (\HFTubyte) \\
2949 A 1-byte unsigned integer containing the size in bytes of a
2950 segment selector on the target system.
2951
2952 \end{enumerate}
2953
2954 This header is followed by a series of tuples. Each tuple
2955 consists of a segment, an address and a length. 
2956 The segment selector
2957 size is given by the \HFNsegmentselectorsize{} field of the header; the
2958 address and length size are each given by the \addttindex{address\_size}
2959 field of the header. 
2960 The first tuple following the header in
2961 each set begins at an offset that is a multiple of the size
2962 of a single tuple (that is, the size of a segment selector
2963 plus twice the \addtoindex{size of an address}). 
2964 The header is padded, if
2965 necessary, to that boundary. Each set of tuples is terminated
2966 by a 0 for the segment, a 0 for the address and 0 for the
2967 length. If the \HFNsegmentselectorsize{} field in the header is zero,
2968 the segment selectors are omitted from all tuples, including
2969 the terminating tuple.
2970
2971
2972 \section{Line Number Information}
2973 \label{datarep:linenumberinformation}
2974
2975 The \addtoindexi{version number}{version number!line number information}
2976 in the line number program header is \versiondotdebugline{}
2977 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
2978
2979 The boolean values \doublequote{true} and \doublequote{false} 
2980 used by the line number information program are encoded
2981 as a single byte containing the value 0 
2982 for \doublequote{false,} and a non-zero value for \doublequote{true.}
2983
2984 \needlines{10}
2985 The encodings for the standard opcodes are given in 
2986 \addtoindexx{line number opcodes!standard opcode encoding}
2987 Table \refersec{tab:linenumberstandardopcodeencodings}.
2988
2989 \begin{centering}
2990 \setlength{\extrarowheight}{0.1cm}
2991 \begin{longtable}{l|c}
2992   \caption{Line number standard opcode encodings} \label{tab:linenumberstandardopcodeencodings}\\
2993   \hline \bfseries Opcode name&\bfseries Value \\ \hline
2994 \endfirsthead
2995   \bfseries Opcode name&\bfseries Value\\ \hline
2996 \endhead
2997   \hline \emph{Continued on next page}
2998 \endfoot
2999   \hline
3000 \endlastfoot
3001
3002 \DWLNScopy&0x01 \\
3003 \DWLNSadvancepc&0x02 \\
3004 \DWLNSadvanceline&0x03 \\
3005 \DWLNSsetfile&0x04 \\
3006 \DWLNSsetcolumn&0x05 \\
3007 \DWLNSnegatestmt&0x06 \\
3008 \DWLNSsetbasicblock&0x07 \\
3009 \DWLNSconstaddpc&0x08 \\
3010 \DWLNSfixedadvancepc&0x09 \\
3011 \DWLNSsetprologueend&0x0a \\*
3012 \DWLNSsetepiloguebegin&0x0b \\*
3013 \DWLNSsetisa&0x0c \\*
3014 \end{longtable}
3015 \end{centering}
3016
3017 \clearpage
3018 \needlines{12}
3019 The encodings for the extended opcodes are given in 
3020 \addtoindexx{line number opcodes!extended opcode encoding}
3021 Table \refersec{tab:linenumberextendedopcodeencodings}.
3022
3023 \begin{centering}
3024 \setlength{\extrarowheight}{0.1cm}
3025 \begin{longtable}{l|c}
3026   \caption{Line number extended opcode encodings} \label{tab:linenumberextendedopcodeencodings}\\
3027   \hline \bfseries Opcode name&\bfseries Value \\ \hline
3028 \endfirsthead
3029   \bfseries Opcode name&\bfseries Value\\ \hline
3030 \endhead
3031   \hline \emph{Continued on next page}
3032 \endfoot
3033   \hline %\ddag~\textit{New in DWARF Version 5}
3034 \endlastfoot
3035
3036 \DWLNEendsequence       &0x01 \\
3037 \DWLNEsetaddress        &0x02 \\
3038 \textit{Reserved}       &0x03\footnote{Code 0x03 is reserved to allow backward compatible support of the 
3039                                        DW\_LNE\_define\_file operation which was defined in \DWARFVersionIV{} 
3040                                        and earlier.} \\
3041 \DWLNEsetdiscriminator  &0x04 \\
3042 \DWLNElouser            &0x80 \\
3043 \DWLNEhiuser            &\xff \\
3044
3045 \end{longtable}
3046 \end{centering}
3047
3048 \needlines{6}
3049 The encodings for the line number header entry formats are given in 
3050 \addtoindexx{line number opcodes!file entry format encoding}
3051 Table \refersec{tab:linenumberheaderentryformatencodings}.
3052
3053 \begin{centering}
3054 \setlength{\extrarowheight}{0.1cm}
3055 \begin{longtable}{l|c}
3056   \caption{Line number header entry format \mbox{encodings}} \label{tab:linenumberheaderentryformatencodings}\\
3057   \hline \bfseries Line number header entry format name&\bfseries Value \\ \hline
3058 \endfirsthead
3059   \bfseries Line number header entry format name&\bfseries Value\\ \hline
3060 \endhead
3061   \hline \emph{Continued on next page}
3062 \endfoot
3063   \hline \ddag~\textit{New in DWARF Version 5}
3064 \endlastfoot
3065 \DWLNCTpath~\ddag           & 0x1 \\
3066 \DWLNCTdirectoryindex~\ddag & 0x2 \\
3067 \DWLNCTtimestamp~\ddag      & 0x3 \\
3068 \DWLNCTsize~\ddag           & 0x4 \\
3069 \DWLNCTMDfive~\ddag         & 0x5 \\
3070 \DWLNCTlouser~\ddag         & 0x2000 \\
3071 \DWLNCThiuser~\ddag         & \xiiifff \\
3072 \end{longtable}
3073 \end{centering}
3074
3075 \needlines{6}
3076 \section{Macro Information}
3077 \label{datarep:macroinformation}
3078 The \addtoindexi{version number}{version number!macro information}
3079 in the macro information header is \versiondotdebugmacro{}
3080 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
3081
3082 The source line numbers and source file indices encoded in the
3083 macro information section are represented as 
3084 unsigned LEB128\addtoindexx{LEB128!unsigned} numbers.
3085
3086 \needlines{4}
3087 The macro information entry type is encoded as a single unsigned byte. 
3088 The encodings 
3089 \addtoindexx{macro information entry types!encoding}
3090 are given in 
3091 Table \refersec{tab:macroinfoentrytypeencodings}.
3092
3093 \needlines{10}
3094 \begin{centering}
3095 \setlength{\extrarowheight}{0.1cm}
3096 \begin{longtable}{l|c}
3097   \caption{Macro information entry type encodings} \label{tab:macroinfoentrytypeencodings}\\
3098   \hline \bfseries Macro information entry type name&\bfseries Value \\ \hline
3099 \endfirsthead
3100   \bfseries Macro information entry type name&\bfseries Value\\ \hline
3101 \endhead
3102   \hline \emph{Continued on next page}
3103 \endfoot
3104   \hline \ddag~\textit{New in DWARF Version 5}
3105 \endlastfoot
3106
3107 \DWMACROdefine~\ddag          &0x01 \\
3108 \DWMACROundef~\ddag           &0x02 \\
3109 \DWMACROstartfile~\ddag       &0x03 \\
3110 \DWMACROendfile~\ddag         &0x04 \\
3111 \DWMACROdefinestrp~\ddag      &0x05 \\
3112 \DWMACROundefstrp~\ddag       &0x06 \\
3113 \DWMACROimport~\ddag          &0x07 \\
3114 \DWMACROdefinesup~\ddag       &0x08 \\
3115 \DWMACROundefsup~\ddag        &0x09 \\
3116 \DWMACROimportsup~\ddag       &0x0a \\
3117 \DWMACROdefinestrx~\ddag      &0x0b \\
3118 \DWMACROundefstrx~\ddag       &0x0c \\
3119 \DWMACROlouser~\ddag          &0xe0 \\
3120 \DWMACROhiuser~\ddag          &\xff \\
3121
3122 \end{longtable}
3123 \end{centering}
3124
3125 \needlines{7}
3126 \section{Call Frame Information}
3127 \label{datarep:callframeinformation}
3128
3129 In the \thirtytwobitdwarfformat, the value of the CIE id in the
3130 CIE header is \xffffffff; in the \sixtyfourbitdwarfformat, the
3131 value is \xffffffffffffffff.
3132
3133 The value of the CIE \addtoindexi{version number}{version number!call frame information}
3134 is 4 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
3135
3136 Call frame instructions are encoded in one or more bytes. The
3137 primary opcode is encoded in the high order two bits of
3138 the first byte (that is, opcode = byte $\gg$ 6). An operand
3139 or extended opcode may be encoded in the low order 6
3140 bits. Additional operands are encoded in subsequent bytes.
3141 The instructions and their encodings are presented in
3142 Table \refersec{tab:callframeinstructionencodings}.
3143
3144 \begin{centering}
3145 \setlength{\extrarowheight}{0.1cm}
3146 \begin{longtable}{l|c|c|l|l}
3147   \caption{Call frame instruction encodings} \label{tab:callframeinstructionencodings} \\
3148   \hline &\bfseries High 2 &\bfseries Low 6 &  & \\
3149   \bfseries Instruction&\bfseries Bits &\bfseries Bits &\bfseries Operand 1 &\bfseries Operand 2\\ \hline
3150 \endfirsthead
3151    & \bfseries High 2 &\bfseries Low 6 &  &\\
3152   \bfseries Instruction&\bfseries Bits &\bfseries Bits &\bfseries Operand 1 &\bfseries Operand 2\\ \hline
3153 \endhead
3154   \hline \emph{Continued on next page}
3155 \endfoot
3156   \hline
3157 \endlastfoot
3158
3159 \DWCFAadvanceloc&0x1&delta & \\
3160 \DWCFAoffset&0x2&register&ULEB128 offset \\
3161 \DWCFArestore&0x3&register & & \\
3162 \DWCFAnop&0&0 & & \\
3163 \DWCFAsetloc&0&0x01&address & \\
3164 \DWCFAadvancelocone&0&0x02&1-byte delta & \\
3165 \DWCFAadvanceloctwo&0&0x03&2-byte delta & \\
3166 \DWCFAadvancelocfour&0&0x04&4-byte delta & \\
3167 \DWCFAoffsetextended&0&0x05&ULEB128 register&ULEB128 offset \\
3168 \DWCFArestoreextended&0&0x06&ULEB128 register & \\
3169 \DWCFAundefined&0&0x07&ULEB128 register & \\
3170 \DWCFAsamevalue&0&0x08 &ULEB128 register & \\
3171 \DWCFAregister&0&0x09&ULEB128 register &ULEB128 offset \\
3172 \DWCFArememberstate&0&0x0a & & \\
3173 \DWCFArestorestate&0&0x0b & & \\
3174 \DWCFAdefcfa&0&0x0c &ULEB128 register&ULEB128 offset \\
3175 \DWCFAdefcfaregister&0&0x0d&ULEB128 register & \\
3176 \DWCFAdefcfaoffset&0&0x0e &ULEB128 offset & \\
3177 \DWCFAdefcfaexpression&0&0x0f &BLOCK  \\
3178 \DWCFAexpression&0&0x10&ULEB128 register & BLOCK \\
3179
3180 \DWCFAoffsetextendedsf&0&0x11&ULEB128 register&SLEB128 offset \\
3181 \DWCFAdefcfasf&0&0x12&ULEB128 register&SLEB128 offset \\
3182 \DWCFAdefcfaoffsetsf&0&0x13&SLEB128 offset & \\
3183 \DWCFAvaloffset&0&0x14&ULEB128&ULEB128 \\
3184 \DWCFAvaloffsetsf&0&0x15&ULEB128&SLEB128 \\
3185 \DWCFAvalexpression&0&0x16&ULEB128&BLOCK  \\
3186 \DWCFAlouser&0&0x1c   & & \\
3187 \DWCFAhiuser&0&\xiiif & & \\
3188 \end{longtable}
3189 \end{centering}
3190
3191 \section{Non-contiguous Address Ranges}
3192 \label{datarep:noncontiguousaddressranges}
3193
3194 Each entry in a \addtoindex{range list}
3195 (see Section \refersec{chap:noncontiguousaddressranges})
3196 is either a
3197 \addtoindexx{base address selection entry!in range list}
3198 range list entry, 
3199 \addtoindexx{range list}
3200 a base address selection entry, or an end-of-list entry.
3201
3202 A \addtoindex{range list} entry consists of two relative addresses. The
3203 addresses are the same size as addresses on the target machine.
3204
3205 \needlines{4}
3206 A base address selection entry and an 
3207 \addtoindexx{end-of-list entry!in range list}
3208 end-of-list entry each
3209 \addtoindexx{base address selection entry!in range list}
3210 consist of two (constant or relocated) addresses. The two
3211 addresses are the same size as addresses on the target machine.
3212
3213 For a \addtoindex{range list} to be specified, the base address of the
3214 \addtoindexx{base address selection entry!in range list}
3215 corresponding compilation unit must be defined 
3216 (see Section \refersec{chap:normalandpartialcompilationunitentries}).
3217
3218 \needlines{6}
3219 \section{String Offsets Table}
3220 \label{chap:stringoffsetstable}
3221 Each set of entries in the string offsets table contained in the
3222 \dotdebugstroffsets{} or \dotdebugstroffsetsdwo{}
3223 section begins with a header containing:
3224 \begin{enumerate}[1. ]
3225 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length}) \\
3226 \addttindexx{unit\_length}
3227 A 4-byte or 12-byte length containing the length of
3228 the set of entries for this compilation unit, not
3229 including the length field itself. In the 32-bit
3230 DWARF format, this is a 4-byte unsigned integer
3231 (which must be less than \xfffffffzero); in the 64-bit
3232 DWARF format, this consists of the 4-byte value
3233 \wffffffff followed by an 8-byte unsigned integer
3234 that gives the actual length (see 
3235 Section \refersec{datarep:32bitand64bitdwarfformats}).
3236
3237 %\needlines{4}
3238 \item  \texttt{version} (\HFTuhalf) \\
3239 A 2-byte version identifier containing the value
3240 \versiondotdebugstroffsets{} 
3241 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}).
3242
3243 \item \texttt{padding} (\HFTuhalf) \\
3244 \end{enumerate}
3245
3246 This header is followed by a series of string table offsets
3247 that have the same representation as \DWFORMstrp.
3248 For the 32-bit DWARF format, each offset is 4 bytes long; for
3249 the 64-bit DWARF format, each offset is 8 bytes long.
3250
3251 The \DWATstroffsetsbase{} attribute points to the first
3252 entry following the header. The entries are indexed
3253 sequentially from this base entry, starting from 0.
3254
3255 \section{Address Table}
3256 \label{chap:addresstable}
3257 Each set of entries in the address table contained in the
3258 \dotdebugaddr{} section begins with a header containing:
3259 \begin{enumerate}[1. ]
3260 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length}) \\
3261 \addttindexx{unit\_length}
3262 A 4-byte or 12-byte length containing the length of
3263 the set of entries for this compilation unit, not
3264 including the length field itself. In the 32-bit
3265 DWARF format, this is a 4-byte unsigned integer
3266 (which must be less than \xfffffffzero); in the 64-bit
3267 DWARF format, this consists of the 4-byte value
3268 \wffffffff followed by an 8-byte unsigned integer
3269 that gives the actual length (see 
3270 Section \refersec{datarep:32bitand64bitdwarfformats}).
3271
3272 \needlines{4}
3273 \item  \texttt{version} (\HFTuhalf) \\
3274 A 2-byte version identifier containing the value
3275 \versiondotdebugaddr{} 
3276 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}).
3277
3278 \needlines{4}
3279 \item   \texttt{address\_size} (\HFTubyte) \\
3280 A 1-byte unsigned integer containing the size in
3281 bytes of an address (or the offset portion of an
3282 address for segmented addressing) on the target
3283 system.
3284
3285 \needlines{4}
3286 \item   \HFNsegmentselectorsize{} (\HFTubyte) \\
3287 A 1-byte unsigned integer containing the size in
3288 bytes of a segment selector on the target system.
3289 \end{enumerate}
3290
3291 This header is followed by a series of segment/address pairs.
3292 The segment size is given by the \HFNsegmentselectorsize{} field of the
3293 header, and the address size is given by the \addttindex{address\_size}
3294 field of the header. If the \HFNsegmentselectorsize{} field in the header
3295 is zero, the entries consist only of an addresses.
3296
3297 The \DWATaddrbase{} attribute points to the first entry
3298 following the header. The entries are indexed sequentially
3299 from this base entry, starting from 0.
3300
3301 \needlines{10}
3302 \section{Range List Table}
3303 \label{app:rangelisttable}
3304 Each set of entries in the range list table contained in the
3305 \dotdebugranges{} section begins with a header containing:
3306 \begin{enumerate}[1. ]
3307 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length}) \\
3308 \addttindexx{unit\_length}
3309 A 4-byte or 12-byte length containing the length of
3310 the set of entries for this compilation unit, not
3311 including the length field itself. In the 32-bit
3312 DWARF format, this is a 4-byte unsigned integer
3313 (which must be less than \xfffffffzero); in the 64-bit
3314 DWARF format, this consists of the 4-byte value
3315 \wffffffff followed by an 8-byte unsigned integer
3316 that gives the actual length (see 
3317 Section \refersec{datarep:32bitand64bitdwarfformats}).
3318
3319 \needlines{4}
3320 \item  \texttt{version} (\HFTuhalf) \\
3321 A 2-byte version identifier containing the value
3322 \versiondotdebugranges{} 
3323 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}).
3324
3325 \needlines{4}
3326 \item   \texttt{address\_size} (\HFTubyte) \\
3327 A 1-byte unsigned integer containing the size in
3328 bytes of an address (or the offset portion of an
3329 address for segmented addressing) on the target
3330 system.
3331
3332 \needlines{4}
3333 \item   \HFNsegmentselectorsize{} (\HFTubyte) \\
3334 A 1-byte unsigned integer containing the size in
3335 bytes of a segment selector on the target system.
3336 \end{enumerate}
3337
3338 This header is followed by a series of range list entries as
3339 described in Section \refersec{chap:noncontiguousaddressranges}.
3340 The segment size is given by the
3341 \HFNsegmentselectorsize{} field of the header, and the address size is
3342 given by the \addttindex{address\_size} field of the header. If the
3343 \HFNsegmentselectorsize{} field in the header is zero, the segment
3344 selector is omitted from the range list entries.
3345
3346 The \DWATrangesbase{} attribute points to the first entry
3347 following the header. The entries are referenced by a byte
3348 offset relative to this base address.
3349
3350 \needlines{12}
3351 \section{Location List Table}
3352 \label{datarep:locationlisttable}
3353 Each set of entries in the location list table contained in the
3354 \dotdebugloc{} or \dotdebuglocdwo{} sections begins with a header containing:
3355 \begin{enumerate}[1. ]
3356 \item \texttt{unit\_length} (\livelink{datarep:initiallengthvalues}{initial length}) \\
3357 \addttindexx{unit\_length}
3358 A 4-byte or 12-byte length containing the length of
3359 the set of entries for this compilation unit, not
3360 including the length field itself. In the 32-bit
3361 DWARF format, this is a 4-byte unsigned integer
3362 (which must be less than \xfffffffzero); in the 64-bit
3363 DWARF format, this consists of the 4-byte value
3364 \wffffffff followed by an 8-byte unsigned integer
3365 that gives the actual length (see 
3366 Section \refersec{datarep:32bitand64bitdwarfformats}).
3367
3368 \needlines{4}
3369 \item  \texttt{version} (\HFTuhalf) \\
3370 A 2-byte version identifier containing the value
3371 \versiondotdebugloc{} 
3372 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}).
3373
3374 \needlines{5}
3375 \item   \texttt{address\_size} (\HFTubyte) \\
3376 A 1-byte unsigned integer containing the size in
3377 bytes of an address (or the offset portion of an
3378 address for segmented addressing) on the target
3379 system.
3380
3381 \needlines{4}
3382 \item   \HFNsegmentselectorsize{} (\HFTubyte) \\
3383 A 1-byte unsigned integer containing the size in
3384 bytes of a segment selector on the target system.
3385 \end{enumerate}
3386
3387 This header is followed by a series of location list entries as
3388 described in Section \refersec{chap:locationlists}.
3389 The segment size is given by the
3390 \HFNsegmentselectorsize{} field of the header, and the address size is
3391 given by the \HFNaddresssize{} field of the header. If the
3392 \HFNsegmentselectorsize{} field in the header is zero, the segment
3393 selector is omitted from range list entries.
3394
3395 The entries are referenced by a byte offset relative to the first
3396 location list following this header.
3397
3398 \needlines{6}
3399 \section{Dependencies and Constraints}
3400 \label{datarep:dependenciesandconstraints}
3401 The debugging information in this format is intended to
3402 exist in sections of an object file, or an equivalent
3403 separate file or database, having names beginning with
3404 the prefix ".debug\_" (see Appendix 
3405 \refersec{app:dwarfsectionversionnumbersinformative}
3406 for a complete list of such names). 
3407 Except as specifically specified, this information is not 
3408 aligned on 2-, 4- or 8-byte boundaries. Consequently:
3409
3410 \begin{itemize}
3411 \item For the \thirtytwobitdwarfformat{} and a target architecture with
3412 32-bit addresses, an assembler or compiler must provide a way
3413 to produce 2-byte and 4-byte quantities without alignment
3414 restrictions, and the linker must be able to relocate a
3415 4-byte address or 
3416 \addtoindexx{section offset!alignment of}
3417 section offset that occurs at an arbitrary
3418 alignment.
3419
3420 \item For the \thirtytwobitdwarfformat{} and a target architecture with
3421 64-bit addresses, an assembler or compiler must provide a
3422 way to produce 2-byte, 4-byte and 8-byte quantities without
3423 alignment restrictions, and the linker must be able to relocate
3424 an 8-byte address or 4-byte 
3425 \addtoindexx{section offset!alignment of}
3426 section offset that occurs at an
3427 arbitrary alignment.
3428
3429 \item For the \sixtyfourbitdwarfformat{} and a target architecture with
3430 32-bit addresses, an assembler or compiler must provide a
3431 way to produce 2-byte, 4-byte and 8-byte quantities without
3432 alignment restrictions, and the linker must be able to relocate
3433 a 4-byte address or 8-byte 
3434 \addtoindexx{section offset!alignment of}
3435 section offset that occurs at an
3436 arbitrary alignment.
3437
3438 \textit{It is expected that this will be required only for very large
3439 32-bit programs or by those architectures which support
3440 a mix of 32-bit and 64-bit code and data within the same
3441 executable object.}
3442
3443 \item For the \sixtyfourbitdwarfformat{} and a target architecture with
3444 64-bit addresses, an assembler or compiler must provide a
3445 way to produce 2-byte, 4-byte and 8-byte quantities without
3446 alignment restrictions, and the linker must be able to
3447 relocate an 8-byte address or 
3448 \addtoindexx{section offset!alignment of}
3449 section offset that occurs at
3450 an arbitrary alignment.
3451 \end{itemize}
3452
3453 \needlines{10}
3454 \section{Integer Representation Names}
3455 \label{datarep:integerrepresentationnames}
3456 The sizes of the integers used in the lookup by name, lookup
3457 by address, line number, call frame information and other sections
3458 are given in
3459 Table \ref{tab:integerrepresentationnames}.
3460
3461 \needlines{12}
3462 \begin{centering}
3463 \setlength{\extrarowheight}{0.1cm}
3464 \begin{longtable}{c|l}
3465   \caption{Integer representation names} \label{tab:integerrepresentationnames}\\
3466   \hline \bfseries Representation name&\bfseries Representation \\ \hline
3467 \endfirsthead
3468   \bfseries Representation name&\bfseries Representation\\ \hline
3469 \endhead
3470   \hline \emph{Continued on next page}
3471 \endfoot
3472   \hline
3473 \endlastfoot
3474
3475 \HFTsbyte&  signed, 1-byte integer \\
3476 \HFTubyte&unsigned, 1-byte integer \\
3477 \HFTuhalf&unsigned, 2-byte integer \\
3478 \HFTuword&unsigned, 4-byte integer \\
3479
3480 \end{longtable}
3481 \end{centering}
3482
3483 \needlines{6}
3484 \section{Type Signature Computation}
3485 \label{datarep:typesignaturecomputation}
3486
3487 A \addtoindex{type signature} is used by a DWARF consumer 
3488 to resolve type references to the type definitions that 
3489 are contained in \addtoindex{type unit}s (see Section
3490 \refersec{chap:typeunitentries}).
3491
3492 \textit{A type signature is computed only by a DWARF producer;
3493 \addtoindexx{type signature!computation} a consumer need
3494 compare two type signatures to check for equality.}
3495
3496 \needlines{4}
3497 The type signature for a type T0 is formed from the 
3498 \MDfive{}\footnote{\livetarg{def:MDfive}{MD5} Message Digest Algorithm, 
3499 R.L. Rivest, RFC 1321, April 1992}
3500 digest of a flattened description of the type. The flattened
3501 description of the type is a byte sequence derived from the
3502 DWARF encoding of the type as follows:
3503 \begin{enumerate}[1. ]
3504
3505 \item Start with an empty sequence S and a list V of visited
3506 types, where V is initialized to a list containing the type
3507 T0 as its single element. Elements in V are indexed from 1,
3508 so that V[1] is T0.
3509
3510 \item If the debugging information entry represents a type that
3511 is nested inside another type or a namespace, append to S
3512 the type\textquoteright s context as follows: For each surrounding type
3513 or namespace, beginning with the outermost such construct,
3514 append the letter 'C', the DWARF tag of the construct, and
3515 the name (taken from 
3516 \addtoindexx{name attribute}
3517 the \DWATname{} attribute) of the type
3518 \addtoindexx{name attribute}
3519 or namespace (including its trailing null byte).
3520
3521 \item  Append to S the letter 'D', followed by the DWARF tag of
3522 the debugging information entry.
3523
3524 \item For each of the attributes in
3525 Table \refersec{tab:attributesusedintypesignaturecomputation}
3526 that are present in
3527 the debugging information entry, in the order listed,
3528 append to S a marker letter (see below), the DWARF attribute
3529 code, and the attribute value.
3530
3531 \begin{table}[ht]
3532 \caption{Attributes used in type signature computation}
3533 \label{tab:attributesusedintypesignaturecomputation}
3534 \simplerule[\textwidth]
3535 \begin{center}
3536 \autocols[0pt]{c}{2}{l}{
3537 \DWATname,
3538 \DWATaccessibility,
3539 \DWATaddressclass,
3540 \DWATalignment,
3541 \DWATallocated,
3542 \DWATartificial,
3543 \DWATassociated,
3544 \DWATbinaryscale,
3545 %\DWATbitoffset,
3546 \DWATbitsize,
3547 \DWATbitstride,
3548 \DWATbytesize,
3549 \DWATbytestride,
3550 \DWATconstexpr,
3551 \DWATconstvalue,
3552 \DWATcontainingtype,
3553 \DWATcount,
3554 \DWATdatabitoffset,
3555 \DWATdatalocation,
3556 \DWATdatamemberlocation,
3557 \DWATdecimalscale,
3558 \DWATdecimalsign,
3559 \DWATdefaultvalue,
3560 \DWATdigitcount,
3561 \DWATdiscr,
3562 \DWATdiscrlist,
3563 \DWATdiscrvalue,
3564 \DWATencoding,
3565 \DWATendianity,
3566 \DWATenumclass,
3567 \DWATexplicit,
3568 \DWATisoptional,
3569 \DWATlocation,
3570 \DWATlowerbound,
3571 \DWATmutable,
3572 \DWATordering,
3573 \DWATpicturestring,
3574 \DWATprototyped,
3575 \DWATrank,
3576 \DWATreference,
3577 \DWATrvaluereference,
3578 \DWATsmall,
3579 \DWATsegment,
3580 \DWATstringlength,
3581 \DWATstringlengthbitsize,
3582 \DWATstringlengthbytesize,
3583 \DWATthreadsscaled,
3584 \DWATupperbound,
3585 \DWATuselocation,
3586 \DWATuseUTFeight,
3587 \DWATvariableparameter,
3588 \DWATvirtuality,
3589 \DWATvisibility,
3590 \DWATvtableelemlocation
3591 }
3592 \end{center}
3593 \simplerule[\textwidth]
3594 \end{table}
3595
3596 Note that except for the initial 
3597 \DWATname{} attribute,
3598 \addtoindexx{name attribute}
3599 attributes are appended in order according to the alphabetical
3600 spelling of their identifier.
3601
3602 If an implementation defines any vendor-specific attributes,
3603 any such attributes that are essential to the definition of
3604 the type are also included at the end of the above list,
3605 in their own alphabetical suborder.
3606
3607 An attribute that refers to another type entry T is processed
3608 as follows: (a) If T is in the list V at some V[x], use the
3609 letter 'R' as the marker and use the unsigned LEB128\addtoindexx{LEB128!unsigned}
3610 encoding of x as the attribute value; otherwise, (b) use the letter 'T'
3611 as the marker, process the type T recursively by performing
3612 Steps 2 through 7, and use the result as the attribute value.