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