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