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