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