4952a5d920f9914d3807d36022c99c35b945ff2b
[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 value range for vendor specific extensions consist of the
24 appropriate prefix (DW\_TAG, DW\_AT, DW\_END, DW\_ATE, DW\_OP,
25 DW\_LANG, DW\_LNE, DW\_CC or DW\_CFA respectively) followed by
26 \_lo\_user or \_hi\_user. 
27 \textit{For example, for entry tags, the special
28 labels are \livetarg{chap:DWTAGlouser}{DW\_TAG\_lo\_user} and 
29 \livetarg{chap:DWTAGhiuser}{DW\_TAG\_hi\_user}.}
30 Values in the
31 range between \textit{prefix}\_lo\_user and \textit{prefix}\_hi\_user inclusive,
32 are reserved for vendor specific extensions. Vendors may
33 use values in this range without conflicting with current or
34 future system\dash defined values. All other values are reserved
35 for use by the system.
36
37 \textit{There may also be codes for vendor specific extensions
38 between the number of standard line number opcodes and
39 the first special line number opcode. However, since the
40 number of standard opcodes varies with the DWARF version,
41 the range for extensions is also version dependent. Thus,
42 \livetarg{chap:DWLNSlouser}{DW\_LNS\_lo\_user} and 
43 \livetarg{chap:DWLNShiuser}{DW\_LNS\_hi\_user} symbols are not defined.
44 }
45
46 Vendor defined tags, attributes, base type encodings, location
47 atoms, language names, line number actions, calling conventions
48 and call frame instructions, conventionally use the form
49 \text{prefix\_vendor\_id\_name}, where 
50 \textit{vendor\_id}\addtoindexx{vendor id} is some identifying
51 character sequence chosen so as to avoid conflicts with
52 other vendors.
53
54 To ensure that extensions added by one vendor may be safely
55 ignored by consumers that do not understand those extensions,
56 the following rules should be followed:
57 \begin{enumerate}[1. ]
58
59 \item New attributes should be added in such a way that a
60 debugger may recognize the format of a new attribute value
61 without knowing the content of that attribute value.
62
63 \item The semantics of any new attributes should not alter
64 the semantics of previously existing attributes.
65
66 \item The semantics of any new tags should not conflict with
67 the semantics of previously existing tags.
68
69 \item Do not add any new forms of attribute value.
70
71 \end{enumerate}
72
73
74 \section{Reserved Values}
75 \label{datarep:reservedvalues}
76 \subsection{Error Values}
77 \label{datarep:errorvalues}
78 \addtoindexx{reserved values!error}
79
80 As 
81 \addtoindexx{error value}
82 a convenience for consumers of DWARF information, the value
83 0 is reserved in the encodings for attribute names, attribute
84 forms, base type encodings, location operations, languages,
85 line number program opcodes, macro information entries and tag
86 names to represent an error condition or unknown value. DWARF
87 does not specify names for these reserved values, since they
88 do not represent valid encodings for the given type and should
89 not appear in DWARF debugging information.
90
91
92 \subsection{Initial Length Values}
93 \label{datarep:initiallengthvalues}
94 \addtoindexx{reserved values!initial length}
95
96 An \addtoindex{initial length field} is one of the length fields that occur
97 at the beginning 
98 of those DWARF sections that 
99 have a header
100 (\addtoindex{.debug\_aranges}, 
101 \addtoindex{.debug\_info}, 
102 \addtoindex{.debug\_types}, 
103 \addtoindex{.debug\_line},
104 \addtoindex{.debug\_pubnames}, and 
105 \addtoindex{.debug\_pubtypes}) or the length field
106 that occurs at the beginning of the CIE and FDE structures
107 in the \addtoindex{.debug\_frame} section.
108
109 In an \addtoindex{initial length field}, the values \wfffffffzero through
110 \wffffffff are reserved by DWARF to indicate some form of
111 extension relative to \addtoindex{DWARF Version 2}; such values must not
112 be interpreted as a length field. The use of one such value,
113 \xffffffff, is defined below 
114 (see Section \refersec{datarep:32bitand64bitdwarfformats}); 
115 the use of
116 the other values is reserved for possible future extensions.
117
118
119
120 \section{Executable Objects and Shared Objects} 
121 \label{datarep:executableobjectsandsharedobjects}
122
123 The relocated addresses in the debugging information for an
124 executable object are virtual addresses and the relocated
125 addresses in the debugging information for a shared object
126 are offsets relative to the start of the lowest region of
127 memory loaded from that shared object.
128
129 \textit{This requirement makes the debugging information for
130 shared objects position independent.  Virtual addresses in a
131 shared object may be calculated by adding the offset to the
132 base address at which the object was attached. This offset
133 is available in the run\dash time linker\textquoteright s data structures.}
134
135
136
137 \section{32-Bit and 64-Bit DWARF Formats}
138 \label{datarep:32bitand64bitdwarfformats}
139
140 \addtoindexx{32-bit DWARF format}
141 \addtoindexx{64-bit DWARF format}
142 There are two closely related file formats. In the 32\dash bit DWARF
143 format, all values that represent lengths of DWARF sections
144 and offsets relative to the beginning of DWARF sections are
145 represented using 32\dash bits. In the 64\dash bit DWARF format, all
146 values that represent lengths of DWARF sections and offsets
147 relative to the beginning of DWARF sections are represented
148 using 64\dash bits. A special convention applies to the initial
149 length field of certain DWARF sections, as well as the CIE and
150 FDE structures, so that the 32\dash bit and 64\dash bit DWARF formats
151 can coexist and be distinguished within a single linked object.
152
153 The differences between the 32\dash\   and 64\dash bit 
154 DWARF formats are
155 detailed in the following:
156 \begin{enumerate}[1. ]
157
158 \item  In the 32\dash bit DWARF format, an 
159 \addtoindex{initial length field}
160 (see 
161 \addtoindexx{initial length field!encoding}
162 Section \refersec{datarep:initiallengthvalues}) 
163 is an unsigned 32\dash bit integer (which
164 must be less than \xfffffffzero); in the 64\dash bit DWARF format,
165 an \addtoindex{initial length field} is 96 bits in size,
166 and has two parts:
167 \begin{itemize}
168 \item The first 32\dash bits have the value \xffffffff.
169
170 \item  The following 64\dash bits contain the actual length
171 represented as an unsigned 64\dash bit integer.
172 \end{itemize}
173
174 \textit{This representation allows a DWARF consumer to dynamically
175 detect that a DWARF section contribution is using the 64\dash bit
176 format and to adapt its processing accordingly.}
177
178 \item Section offset and section length 
179 \addtoindexx{section length!use in headers}
180 fields that occur
181 \addtoindexx{section offset!use in headers}
182 in the headers of DWARF sections (other 
183 \addtoindexx{initial length field}
184 than 
185 \addtoindex{initial length}
186 fields) are listed following. In the 32\dash bit DWARF format these
187 are 32\dash bit unsigned integer values; in the 64\dash bit DWARF format,
188 they 
189 \addtoindexx{section length!in .debug\_aranges header}
190 are 
191 \addtoindexx{section length!in .debug\_pubnames header}
192 64\dash bit 
193 \addtoindexx{section length!in .debug\_pubtypes header}
194 unsigned integer values.
195
196 \begin{center}
197 \begin{tabular}{lll}
198 Section &Name & Role  \\ \hline
199 \addtoindex{.debug\_aranges} & \addtoindex{debug\_info\_offset} & offset in \addtoindex{.debug\_info} \\
200 \addtoindex{.debug\_frame}/CIE & \addtoindex{CIE\_id} & CIE distinguished value \\
201 \addtoindex{.debug\_frame}/FDE & \addtoindex{CIE\_pointer} & offset in \addtoindex{.debug\_frame} \\
202 \addtoindex{.debug\_info} & \addtoindex{debug\_abbrev\_offset} & offset in \addtoindex{.debug\_abbrev} \\
203 \addtoindex{.debug\_line} & \addtoindex{header\_length} & length of header itself \\
204 \addtoindex{.debug\_pubnames} & \addtoindex{debug\_info\_offset} & offset in \addtoindex{.debug\_info} \\
205                 & \addtoindex{debug\_info\_length} & length of \addtoindex{.debug\_info} \\
206                 &                   & contribution \\
207 \addtoindex{.debug\_pubtypes} & \addtoindex{debug\_info\_offset} & offset in \addtoindex{.debug\_info} \\
208                 & \addtoindex{debug\_info\_length} & length of \addtoindex{.debug\_info} \\
209                 &                   & contribution \\
210 \addtoindex{.debug\_types} & \addtoindex{debug\_abbrev\_offset} & offset in \addtoindex{.debug\_abbrev} \\
211                 & \addtoindex{type\_offset} & offset in of \addtoindex{.debug\_types} \\
212
213 \end{tabular}
214 \end{center}
215
216 The CIE\_id field in a CIE structure must be 64 bits because
217 it overlays the CIE\_pointer in a FDE structure; this implicit
218 union must be accessed to distinguish whether a CIE or FDE is
219 present, consequently, these two fields must exactly overlay
220 each other (both offset and size).
221
222 \item Within the body of the \addtoindex{.debug\_info} or \addtoindex{.debug\_types}
223 section, certain forms of attribute value depend on the choice
224 of DWARF format as follows. For the 32\dash bit DWARF format,
225 the value is a 32\dash bit unsigned integer; for the 64\dash bit DWARF
226 format, the value is a 64\dash bit unsigned integer.
227 \begin{center}
228 \begin{tabular}{ll}
229 Form & Role  \\ \hline
230 \livelink{chap:DWFORMrefaddr}{DW\_FORM\_ref\_addr}& offset in \addtoindex{.debug\_info} \\
231 \livelink{chap:DWFORMsecoffset}{DW\_FORM\_sec\_offset}& offset in a section other than \\
232                                                                                         &\addtoindex{.debug\_info} or \addtoindex{.debug\_str} \\
233 \livelink{chap:DWFORMstrp}{DW\_FORM\_strp}&offset in \addtoindex{.debug\_str} \\
234 \livelink{chap:DWOPcallref}{DW\_OP\_call\_ref}&offset in \addtoindex{.debug\_info} \\
235 \end{tabular}
236 \end{center}
237
238 \item Within the body of the \addtoindex{.debug\_pubnames} and
239 \addtoindex{.debug\_pubtypes} 
240 sections, the representation of the first field
241 of each tuple (which represents an offset in the 
242 \addtoindex{.debug\_info}
243 section) depends on the DWARF format as follows: in the
244 32\dash bit DWARF format, this field is a 32\dash bit unsigned integer;
245 in the 64\dash bit DWARF format, it is a 64\dash bit unsigned integer.
246
247 \end{enumerate}
248
249
250 The 32\dash bit and 64\dash bit DWARF format conventions must \emph{not} be
251 intermixed within a single compilation unit.
252
253 \textit{Attribute values and section header fields that represent
254 addresses in the target program are not affected by these
255 rules.}
256
257 A DWARF consumer that supports the 64\dash bit DWARF format must
258 support executables in which some compilation units use the
259 32\dash bit format and others use the 64\dash bit format provided that
260 the combination links correctly (that is, provided that there
261 are no link\dash time errors due to truncation or overflow). (An
262 implementation is not required to guarantee detection and
263 reporting of all such errors.)
264
265 \textit{It is expected that DWARF producing compilers will \textbf{not} use
266 the 64\dash bit format \textbf{by default}. In most cases, the division of
267 even very large applications into a number of executable and
268 shared objects will suffice to assure that the DWARF sections
269 within each individual linked object are less than 4 GBytes
270 in size. However, for those cases where needed, the 64\dash bit
271 format allows the unusual case to be handled as well. Even
272 in this case, it is expected that only application supplied
273 objects will need to be compiled using the 64\dash bit format;
274 separate 32\dash bit format versions of system supplied shared
275 executable libraries can still be used.}
276
277
278
279 \section{Format of Debugging Information}
280 \label{datarep:formatofdebugginginformation}
281
282 For each compilation unit compiled with a DWARF producer,
283 a contribution is made to the \addtoindex{.debug\_info} section of
284 the object file. Each such contribution consists of a
285 compilation unit header 
286 (see Section \refersec{datarep:compilationunitheader}) 
287 followed by a
288 single \livelink{chap:DWTAGcompileunit}{DW\_TAG\_compile\_unit} or 
289 \livelink{chap:DWTAGpartialunit}{DW\_TAG\_partial\_unit} debugging
290 information entry, together with its children.
291
292 For each type defined in a compilation unit, a contribution may
293 be made to the \addtoindex{.debug\_types} 
294 section of the object file. Each
295 such contribution consists of a 
296 \addtoindex{type unit} header 
297 (see Section \refersec{datarep:typeunitheader}) 
298 followed by a \livelink{chap:DWTAGtypeunit}{DW\_TAG\_type\_unit} entry, together with
299 its children.
300
301 Each debugging information entry begins with a code that
302 represents an entry in a separate 
303 \addtoindex{abbreviations table}. This
304 code is followed directly by a series of attribute values.
305
306 The appropriate entry in the 
307 \addtoindex{abbreviations table} guides the
308 interpretation of the information contained directly in the
309 \addtoindex{.debug\_info} or 
310 \addtoindex{.debug\_types} section.
311
312 \needlines{4}
313 Multiple debugging information entries may share the same
314 abbreviation table entry. Each compilation unit is associated
315 with a particular abbreviation table, but multiple compilation
316 units may share the same table.
317 \subsection{Unit Headers}
318 \label{datarep:unitheaders}
319
320 \subsubsection{Compilation Unit Header}
321 \label{datarep:compilationunitheader}
322 \begin{enumerate}[1. ]
323
324 \item unit\_length (initial length) \\
325 \addtoindexx{unit\_length}
326 A 4\dash byte or 12\dash byte 
327 \addtoindexx{initial length}
328 unsigned integer representing the length
329 of the \addtoindex{.debug\_info}
330 contribution for that compilation unit,
331 not including the length field itself. In the 32\dash bit DWARF
332 format, this is a 4\dash byte unsigned integer (which must be less
333 than \xfffffffzero); in the 64\dash bit DWARF format, this consists
334 of the 4\dash byte value \wffffffff followed by an 8\dash byte unsigned
335 integer that gives the actual length 
336 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
337
338 \item  version (\addtoindex{uhalf}) \\
339 A 2\dash byte unsigned integer representing the version of the
340 DWARF information for the compilation unit \addtoindexx{version number!compilation unit} 
341 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
342 The value in this field is 4.
343
344 \item \addtoindex{debug\_abbrev\_offset} (section offset) \\
345
346 \addtoindexx{section offset!in .debug\_info header}
347 4\dash byte or 8\dash byte unsigned offset into the 
348 \addtoindex{.debug\_abbrev}
349 section. This offset associates the compilation unit with a
350 particular set of debugging information entry abbreviations. In
351 the 32\dash bit DWARF format, this is a 4\dash byte unsigned length;
352 in the 64\dash bit DWARF format, this is an 8\dash byte unsigned length
353 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
354
355 \item address\_size (\addtoindex{ubyte}) \\
356 A 1\dash byte unsigned integer representing the size in bytes of
357 \addtoindexx{address\_size}
358 an address on the target architecture. If the system uses
359 \addtoindexx{address space!segmented}
360 segmented addressing, this value represents the size of the
361 offset portion of an address.
362
363
364 \end{enumerate}
365
366 \subsubsection{Type Unit Header}
367 \label{datarep:typeunitheader}
368
369 The header for the series of debugging information entries
370 contributing to the description of a type that has been
371 placed in its own \addtoindex{type unit}, within the 
372 \addtoindex{.debug\_types} section,
373 consists of the following information:
374 \begin{enumerate}[1. ]
375
376 \item unit\_length (initial length) \\
377 \addtoindexx{unit\_length}
378 A 4\dash byte or 12\dash byte unsigned integer 
379 \addtoindexx{initial length}
380 representing the length
381 of the \addtoindex{.debug\_types} contribution for that compilation unit,
382 not including the length field itself. In the 32\dash bit DWARF
383 format, this is a 4\dash byte unsigned integer (which must be
384 less than \xfffffffzero); in the 64\dash bit DWARF format, this
385 consists of the 4\dash byte value \wffffffff followed by an 
386 8\dash byte unsigned integer that gives the actual length
387 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
388
389 \item  version (\addtoindex{uhalf}) \\
390 A 2\dash byte unsigned integer representing the version of the
391 DWARF information for the 
392 compilation unit\addtoindexx{version number!type unit} 
393 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
394 The value in this field is 4.
395
396 \item \addtoindex{debug\_abbrev\_offset} (section offset) \\
397
398 \addtoindexx{section offset!in .debug\_types header}
399 4\dash byte or 8\dash byte unsigned offset into the 
400 \addtoindex{.debug\_abbrev}
401 section. This offset associates the compilation unit with a
402 particular set of debugging information entry abbreviations. In
403 the 32\dash bit DWARF format, this is a 4\dash byte unsigned length;
404 in the 64\dash bit DWARF format, this is an 8\dash byte unsigned length
405 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
406
407 \item address\_size (ubyte) \\
408 A 1\dash byte unsigned integer representing the size 
409 \addtoindexx{size of an address}
410 in bytes of
411 \addtoindexx{address\_size}
412 an address on the target architecture. If the system uses
413 \addtoindexx{address space!segmented}
414 segmented addressing, this value represents the size of the
415 offset portion of an address.
416
417
418 \item type\_signature (8\dash byte unsigned integer) \\
419 \addtoindexx{type signature}
420
421 \addtoindexx{type\_signature}
422 64\dash bit unique signature (see Section 
423 \refersec{datarep:typesignaturecomputation})
424 of the type described in this type
425 unit.  
426
427 \textit{An attribute that refers (using 
428 \livelink{chap:DWFORMrefsig8}{DW\_FORM\_ref\_sig8}) to
429 the primary type contained in this 
430 \addtoindex{type unit} uses this value.}
431
432
433 \item type\_offset (section offset) \\
434 \addtoindexx{type\_offset}
435 A 4\dash byte or 8\dash byte unsigned offset 
436 \addtoindexx{section offset!in .debug\_types header}
437 relative to the beginning
438 of the \addtoindex{type unit} header.
439 This offset refers to the debugging
440 information entry that describes the type. Because the type
441 may be nested inside a namespace or other structures, and may
442 contain references to other types that have not been placed in
443 separate type units, it is not necessarily either the first or
444 the only entry in the type unit. In the 32\dash bit DWARF format,
445 this is a 4\dash byte unsigned length; in the 64\dash bit DWARF format,
446 this is an 8\dash byte unsigned length
447 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
448
449 \end{enumerate}
450
451 \subsection{Debugging Information Entry}
452 \label{datarep:debugginginformationentry}
453
454 Each debugging information entry begins with an unsigned LEB128
455 number containing the abbreviation code for the entry. This
456 code represents an entry within the abbreviations table
457 associated with the compilation unit containing this entry. The
458 abbreviation code is followed by a series of attribute values.
459
460 On some architectures, there are alignment constraints on
461 section boundaries. To make it easier to pad debugging
462 information sections to satisfy such constraints, the
463 abbreviation code 0 is reserved. Debugging information entries
464 consisting of only the abbreviation code 0 are considered
465 null entries.
466
467 \subsection{Abbreviations Tables}
468 \label{datarep:abbreviationstables}
469
470 The abbreviations tables for all compilation units
471 are contained in a separate object file section called
472 \addtoindex{.debug\_abbrev}.
473 As mentioned before, multiple compilation
474 units may share the same abbreviations table.
475
476 The abbreviations table for a single compilation unit consists
477 of a series of abbreviation declarations. Each declaration
478 specifies the tag and attributes for a particular form of
479 debugging information entry. Each declaration begins with
480 an unsigned LEB128 number representing the abbreviation
481 code itself. It is this code that appears at the beginning
482 of a debugging information entry in the 
483 \addtoindex{.debug\_info} or
484 \addtoindex{.debug\_types}
485 section. As described above, the abbreviation
486 code 0 is reserved for null debugging information entries. The
487 abbreviation code is followed by another unsigned LEB128
488 number that encodes the entry\textquoteright s tag. The encodings for the
489 tag names are given in 
490 Table \refersec{tab:tagencodings}.
491
492 \begin{centering}
493 \setlength{\extrarowheight}{0.1cm}
494 \begin{longtable}{l|l}
495   \hline
496   \caption{Tag encodings} \label{tab:tagencodings} \\
497   \hline \bfseries Tag name&\bfseries Value\\ \hline
498 \endfirsthead
499   \bfseries Tag name&\bfseries Value \\ \hline
500 \endhead
501   \hline \emph{Continued on next page}
502 \endfoot
503   \hline
504   \ddag \ \textit{New in \addtoindex{DWARF Version 4}}
505 \endlastfoot
506 \livelink{chap:DWTAGarraytype}{DW\_TAG\_array\_type} &0x01 \\
507 \livelink{chap:DWTAGclasstype}{DW\_TAG\_class\_type}&0x02 \\
508 \livelink{chap:DWTAGentrypoint}{DW\_TAG\_entry\_point}&0x03 \\
509 \livelink{chap:DWTAGenumerationtype}{DW\_TAG\_enumeration\_type}&0x04 \\
510 \livelink{chap:DWTAGformalparameter}{DW\_TAG\_formal\_parameter}&0x05 \\
511 \livelink{chap:DWTAGimporteddeclaration}{DW\_TAG\_imported\_declaration}&0x08 \\
512 \livelink{chap:DWTAGlabel}{DW\_TAG\_label}&0x0a \\
513 \livelink{chap:DWTAGlexicalblock}{DW\_TAG\_lexical\_block}&0x0b \\
514 \livelink{chap:DWTAGmember}{DW\_TAG\_member}&0x0d \\
515 \livelink{chap:DWTAGpointertype}{DW\_TAG\_pointer\_type}&0x0f \\
516 \livelink{chap:DWTAGreferencetype}{DW\_TAG\_reference\_type}&0x10 \\
517 \livelink{chap:DWTAGcompileunit}{DW\_TAG\_compile\_unit}&0x11 \\
518 \livelink{chap:DWTAGstringtype}{DW\_TAG\_string\_type}&0x12 \\
519 \livelink{chap:DWTAGstructuretype}{DW\_TAG\_structure\_type}&0x13 \\
520 \livelink{chap:DWTAGsubroutinetype}{DW\_TAG\_subroutine\_type}&0x15 \\
521 \livelink{chap:DWTAGtypedef}{DW\_TAG\_typedef}&0x16 \\
522 \livelink{chap:DWTAGuniontype}{DW\_TAG\_union\_type}&0x17 \\
523 \livelink{chap:DWTAGunspecifiedparameters}{DW\_TAG\_unspecified\_parameters}&0x18  \\
524 \livelink{chap:DWTAGvariant}{DW\_TAG\_variant}&0x19  \\
525 \livelink{chap:DWTAGcommonblock}{DW\_TAG\_common\_block}&0x1a  \\
526 \livelink{chap:DWTAGcommoninclusion}{DW\_TAG\_common\_inclusion}&0x1b  \\
527 \livelink{chap:DWTAGinheritance}{DW\_TAG\_inheritance}&0x1c  \\
528 \livelink{chap:DWTAGinlinedsubroutine}{DW\_TAG\_inlined\_subroutine}&0x1d  \\
529 \livelink{chap:DWTAGmodule}{DW\_TAG\_module}&0x1e  \\
530 \livelink{chap:DWTAGptrtomembertype}{DW\_TAG\_ptr\_to\_member\_type}&0x1f  \\
531 \livelink{chap:DWTAGsettype}{DW\_TAG\_set\_type}&0x20  \\
532 \livelink{chap:DWTAGsubrangetype}{DW\_TAG\_subrange\_type}&0x21  \\
533 \livelink{chap:DWTAGwithstmt}{DW\_TAG\_with\_stmt}&0x22  \\
534 \livelink{chap:DWTAGaccessdeclaration}{DW\_TAG\_access\_declaration}&0x23  \\
535 \livelink{chap:DWTAGbasetype}{DW\_TAG\_base\_type}&0x24  \\
536 \livelink{chap:DWTAGcatchblock}{DW\_TAG\_catch\_block}&0x25  \\
537 \livelink{chap:DWTAGconsttype}{DW\_TAG\_const\_type}&0x26  \\
538 \livelink{chap:DWTAGconstant}{DW\_TAG\_constant}&0x27  \\
539 \livelink{chap:DWTAGenumerator}{DW\_TAG\_enumerator}&0x28  \\
540 \livelink{chap:DWTAGfiletype}{DW\_TAG\_file\_type}&0x29  \\
541 \livelink{chap:DWTAGfriend}{DW\_TAG\_friend}&0x2a  \\
542 \livelink{chap:DWTAGnamelist}{DW\_TAG\_namelist}&0x2b    \\
543 \livelink{chap:DWTAGnamelistitem}{DW\_TAG\_namelist\_item}&0x2c    \\
544 \livelink{chap:DWTAGpackedtype}{DW\_TAG\_packed\_type}&0x2d    \\
545 \livelink{chap:DWTAGsubprogram}{DW\_TAG\_subprogram}&0x2e    \\
546 \livelink{chap:DWTAGtemplatetypeparameter}{DW\_TAG\_template\_type\_parameter}&0x2f    \\
547 \livelink{chap:DWTAGtemplatevalueparameter}{DW\_TAG\_template\_value\_parameter}&0x30    \\
548 \livelink{chap:DWTAGthrowntype}{DW\_TAG\_thrown\_type}&0x31    \\
549 \livelink{chap:DWTAGtryblock}{DW\_TAG\_try\_block}&0x32    \\
550 \livelink{chap:DWTAGvariantpart}{DW\_TAG\_variant\_part}&0x33    \\
551 \livelink{chap:DWTAGvariable}{DW\_TAG\_variable}&0x34    \\
552 \livelink{chap:DWTAGvolatiletype}{DW\_TAG\_volatile\_type}&0x35    \\
553 \livelink{chap:DWTAGdwarfprocedure}{DW\_TAG\_dwarf\_procedure}&0x36     \\
554 \livelink{chap:DWTAGrestricttype}{DW\_TAG\_restrict\_type}&0x37      \\
555 \livelink{chap:DWTAGinterfacetype}{DW\_TAG\_interface\_type}&0x38      \\
556 \livelink{chap:DWTAGnamespace}{DW\_TAG\_namespace}&0x39      \\
557 \livelink{chap:DWTAGimportedmodule}{DW\_TAG\_imported\_module}&0x3a      \\
558 \livelink{chap:DWTAGunspecifiedtype}{DW\_TAG\_unspecified\_type}&0x3b      \\
559 \livelink{chap:DWTAGpartialunit}{DW\_TAG\_partial\_unit}&0x3c      \\
560 \livelink{chap:DWTAGimportedunit}{DW\_TAG\_imported\_unit}&0x3d      \\
561 \livelink{chap:DWTAGcondition}{DW\_TAG\_condition}&\xiiif      \\
562 \livelink{chap:DWTAGsharedtype}{DW\_TAG\_shared\_type}&0x40      \\
563 \livelink{chap:DWTAGtypeunit}{DW\_TAG\_type\_unit} \ddag &0x41      \\
564 \livelink{chap:DWTAGrvaluereferencetype}{DW\_TAG\_rvalue\_reference\_type} \ddag &0x42      \\
565 \livelink{chap:DWTAGtemplatealias}{DW\_TAG\_template\_alias} \ddag &0x43      \\
566 \livelink{chap:DWTAGlouser}{DW\_TAG\_lo\_user}&0x4080      \\
567 \livelink{chap:DWTAGhiuser}{DW\_TAG\_hi\_user}&\xffff      \\
568 \end{longtable}
569 \end{centering}
570
571 Following the tag encoding is a 1\dash byte value that determines
572 whether a debugging information entry using this abbreviation
573 has child entries or not. If the value is 
574 \livetarg{chap:DWCHILDRENyes}{DW\_CHILDREN\_yes},
575 the next physically succeeding entry of any debugging
576 information entry using this abbreviation is the first
577 child of that entry. If the 1\dash byte value following the
578 abbreviation\textquoteright s tag encoding is 
579 \livetarg{chap:DWCHILDRENno}{DW\_CHILDREN\_no}, the next
580 physically succeeding entry of any debugging information entry
581 using this abbreviation is a sibling of that entry. (Either
582 the first child or sibling entries may be null entries). The
583 encodings for the child determination byte are given in 
584 Table \refersec{tab:childdeterminationencodings}
585 (As mentioned in 
586 Section \refersec{chap:relationshipofdebugginginformationentries}, 
587 each chain of sibling entries is terminated by a null entry.)
588
589 \needlines{6}
590 \begin{centering}
591 \setlength{\extrarowheight}{0.1cm}
592 \begin{longtable}{l|l}
593   \caption{Child determination encodings}
594   \label{tab:childdeterminationencodings}
595   \addtoindexx{Child determination encodings} \\
596   \hline \bfseries Children determination name&\bfseries Value \\ \hline
597 \endfirsthead
598   \bfseries Children determination name&\bfseries Value \\ \hline
599 \endhead
600   \hline \emph{Continued on next page}
601 \endfoot
602   \hline
603 \endlastfoot
604 \livelink{chap:DWCHILDRENno}{DW\_CHILDREN\_no}&0x00 \\ 
605 \livelink{chap:DWCHILDRENyes}{DW\_CHILDREN\_yes}&0x01 \\ \hline
606 \end{longtable}
607 \end{centering}
608
609 Finally, the child encoding is followed by a series of
610 attribute specifications. Each attribute specification
611 consists of two parts. The first part is an unsigned LEB128
612 number representing the attribute\textquoteright s name. The second part
613 is an unsigned LEB128 number representing the attribute\textquoteright s
614 form. The series of attribute specifications ends with an
615 entry containing 0 for the name and 0 for the form.
616
617 The attribute form 
618 \livetarg{chap:DWFORMindirect}{DW\_FORM\_indirect} is a special case. For
619 attributes with this form, the attribute value itself in the
620 \addtoindex{.debug\_info} or 
621 \addtoindex{.debug\_types}
622 section begins with an unsigned
623 LEB128 number that represents its form. This allows producers
624 to choose forms for particular attributes 
625 \addtoindexx{abbreviations table!dynamic forms in}
626 dynamically,
627 without having to add a new entry to the abbreviations table.
628
629 The abbreviations for a given compilation unit end with an
630 entry consisting of a 0 byte for the abbreviation code.
631
632 \textit{See 
633 Appendix \refersec{app:compilationunitsandabbreviationstableexample} 
634 for a depiction of the organization of the
635 debugging information.}
636
637
638 \subsection{Attribute Encodings}
639 \label{datarep:attributeencodings}
640
641 The encodings for the attribute names are given in 
642 Table \refersec{tab:attributeencodings}.
643
644 The attribute form governs how the value of the attribute is
645 encoded. There are nine classes of form, listed below. Each
646 class is a set of forms which have related representations
647 and which are given a common interpretation according to the
648 attribute in which the form is used.
649
650 Form \livetarg{chap:DWFORMsecoffset}{DW\_FORM\_sec\_offset} 
651 is a member of more 
652 \addtoindexx{rangelistptr class}
653 than 
654 \addtoindexx{macptr class}
655 one 
656 \addtoindexx{loclistptr class}
657 class,
658 \addtoindexx{lineptr class}
659 namely \livelink{chap:lineptr}{lineptr}, 
660 \livelink{chap:loclistptr}{loclistptr}, 
661 \livelink{chap:macptr}{macptr} or 
662 \livelink{chap:rangelistptr}{rangelistptr}; the list
663 of classes allowed by the applicable attribute in 
664 Table \refersec{tab:attributeencodings}
665 determines the class of the form.
666
667 \textit{In DWARF V3 the forms \livelink{chap:DWFORMdata4}{DW\_FORM\_data4} and 
668 \livelink{chap:DWFORMdata8}{DW\_FORM\_data8} were
669 \addtoindexx{lineptr class}
670 members 
671 \addtoindexx{rangelistptr class}
672 of 
673 \addtoindexx{macptr class}
674 either 
675 \addtoindexx{loclistptr class}
676 class constant \addtoindexx{constant class}
677 or one of the classes 
678 \livelink{chap:lineptr}{lineptr},
679 \livelink{chap:loclistptr}{loclistptr}, 
680 \livelink{chap:macptr}{macptr} or 
681 \livelink{chap:rangelistptr}{rangelistptr}, depending on context. In
682 DWARF V4 
683 \livelink{chap:DWFORMdata4}{DW\_FORM\_data4} and 
684 \livelink{chap:DWFORMdata8}{DW\_FORM\_data8} are members of class
685 constant in all cases. 
686 The new 
687 \livelink{chap:DWFORMsecoffset}{DW\_FORM\_sec\_offset} replaces
688 their usage for the other classes.}
689
690 Each possible form belongs to one or more of the following classes:
691
692 \begin{itemize}
693 \item \livelinki{chap:DWATaddressclass}{address}{address class} \\
694 Represented as an object of appropriate size to hold an
695 address on the target machine 
696 (\livetarg{chap:DWFORMaddr}{DW\_FORM\_addr}). 
697 The size is
698 encoded in the compilation unit header 
699 (see Section \refersec{datarep:compilationunitheader}).
700 This address is relocatable in a relocatable object file and
701 is relocated in an executable file or shared object.
702
703 \item \livelink{chap:block}{block} \\
704 Blocks come in four forms:
705
706 \begin{myindentpara}{1cm}
707 A 1\dash byte length followed by 0 to 255 contiguous information
708 bytes (\livetarg{chap:DWFORMblock1}{DW\_FORM\_block1}).
709 \end{myindentpara}
710
711 \begin{myindentpara}{1cm}
712 A 2\dash byte length followed by 0 to 65,535 contiguous information
713 bytes (\livetarg{chap:DWFORMblock2}{DW\_FORM\_block2}).
714 \end{myindentpara}
715
716
717 \begin{myindentpara}{1cm}
718 A 4\dash byte length followed by 0 to 4,294,967,295 contiguous
719 information bytes (\livetarg{chap:DWFORMblock4}{DW\_FORM\_block4}).
720 \end{myindentpara}
721
722
723 \begin{myindentpara}{1cm}
724 An unsigned LEB128 length followed by the number of bytes
725 specified by the length (\livetarg{chap:DWFORMblock}{DW\_FORM\_block}).
726 \end{myindentpara}
727
728 In all forms, the length is the number of information bytes
729 that follow. The information bytes may contain any mixture
730 of relocated (or relocatable) addresses, references to other
731 debugging information entries or data bytes.
732
733 \item constant \\
734 There are six forms of constants. There are fixed length
735 constant data forms for one, two, four and eight byte values
736 (respectively, 
737 \livetarg{chap:DWFORMdata1}{DW\_FORM\_data1}, 
738 \livetarg{chap:DWFORMdata2}{DW\_FORM\_data2}, 
739 \livetarg{chap:DWFORMdata4}{DW\_FORM\_data4},
740 and \livetarg{chap:DWFORMdata8}{DW\_FORM\_data8}). 
741 There are also variable length constant
742 data forms encoded using LEB128 numbers (see below). Both
743 signed (\livetarg{chap:DWFORMsdata}{DW\_FORM\_sdata}) and unsigned 
744 (\livetarg{chap:DWFORMudata}{DW\_FORM\_udata}) variable
745 length constants are available
746
747 The data in \livelink{chap:DWFORMdata1}{DW\_FORM\_data1}, 
748 \livelink{chap:DWFORMdata2}{DW\_FORM\_data2}, 
749 \livelink{chap:DWFORMdata4}{DW\_FORM\_data4} and
750 \livelink{chap:DWFORMdata8}{DW\_FORM\_data8} 
751 can be anything. Depending on context, it may
752 be a signed integer, an unsigned integer, a floating\dash point
753 constant, or anything else. A consumer must use context to
754 know how to interpret the bits, which if they are target
755 machine data (such as an integer or floating point constant)
756 will be in target machine byte\dash order.
757
758 \textit{If one of the \livetarg{chap:DWFORMdata}{DW\_FORM\_data}\textless n\textgreater 
759 forms is used to represent a
760 signed or unsigned integer, it can be hard for a consumer
761 to discover the context necessary to determine which
762 interpretation is intended. Producers are therefore strongly
763 encouraged to use \livelink{chap:DWFORMsdata}{DW\_FORM\_sdata} or 
764 \livelink{chap:DWFORMudata}{DW\_FORM\_udata} for signed and
765 unsigned integers respectively, rather than 
766 \livelink{chap:DWFORMdata}{DW\_FORM\_data}\textless n\textgreater.}
767
768 \needlines{4}
769 \item \livelink{chap:exprloc}{exprloc} \\
770 This is an unsigned LEB128 length followed by the
771 number of information bytes specified by the length
772 (\livetarg{chap:DWFORMexprloc}{DW\_FORM\_exprloc}). 
773 The information bytes contain a DWARF
774 expression 
775 (see Section \refersec{chap:dwarfexpressions}) 
776 or location description 
777 (see Section \refersec{chap:locationdescriptions}).
778
779 \item \livelink{chap:flag}{flag} \\
780 A flag \addtoindexx{flag class}
781 is represented explicitly as a single byte of data
782 (\livetarg{chap:DWFORMflag}{DW\_FORM\_flag}) or 
783 implicitly (\livetarg{chap:DWFORMflagpresent}{DW\_FORM\_flag\_present}). 
784 In the
785 first case, if the \nolink{flag} has value zero, it indicates the
786 absence of the attribute; if the \nolink{flag} has a non\dash zero value,
787 it indicates the presence of the attribute. In the second
788 case, the attribute is implicitly indicated as present, and
789 no value is encoded in the debugging information entry itself.
790
791 \item \livelink{chap:lineptr}{lineptr} \\
792 This is an offset into 
793 \addtoindexx{section offset!in class lineptr value}
794 the 
795 \addtoindex{.debug\_line} section
796 (\livelink{chap:DWFORMsecoffset}{DW\_FORM\_sec\_offset}).
797 It consists of an offset from the
798 beginning of the 
799 \addtoindex{.debug\_line}
800 section to the first byte of
801 the data making up the line number list for the compilation
802 unit. 
803 It is relocatable in a relocatable object file, and
804 relocated in an executable or shared object. In the 32\dash bit
805 DWARF format, this offset is a 4\dash byte unsigned value;
806 in the 64\dash bit DWARF format, it is an 8\dash byte unsigned value
807 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
808
809
810 \item \livelink{chap:loclistptr}{loclistptr} \\
811 This is an offset into the 
812 \addtoindex{.debug\_loc}
813 section
814 (\livelink{chap:DWFORMsecoffset}{DW\_FORM\_sec\_offset}). 
815 It consists of an offset from the
816 \addtoindexx{section offset!in class loclistptr value}
817 beginning of the 
818 \addtoindex{.debug\_loc}
819 section to the first byte of
820 the data making up the 
821 \addtoindex{location list} for the compilation
822 unit. 
823 It is relocatable in a relocatable object file, and
824 relocated in an executable or shared object. In the 32\dash bit
825 DWARF format, this offset is a 4\dash byte unsigned value;
826 in the 64\dash bit DWARF format, it is an 8\dash byte unsigned value
827 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
828
829
830 \item \livelink{chap:macptr}{macptr} \\
831 This is an 
832 \addtoindexx{section offset!in class macptr value}
833 offset into the 
834 \addtoindex{.debug\_macinfo} section
835 (\livelink{chap:DWFORMsecoffset}{DW\_FORM\_sec\_offset}). 
836 It consists of an offset from the
837 beginning of the \addtoindex{.debug\_macinfo} 
838 section to the first byte of
839 the data making up the macro information list for the compilation
840 unit. 
841 It is relocatable in a relocatable object file, and
842 relocated in an executable or shared object. In the 32\dash bit
843 DWARF format, this offset is a 4\dash byte unsigned value;
844 in the 64\dash bit DWARF format, it is an 8\dash byte unsigned value
845 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
846
847 \needlines{4}
848 \item \livelink{chap:rangelistptr}{rangelistptr} \\
849 This is an 
850 \addtoindexx{section offset!in class rangelistptr value}
851 offset into the \addtoindex{.debug\_ranges} section
852 (\livelink{chap:DWFORMsecoffset}{DW\_FORM\_sec\_offset}). 
853 It consists of an
854 offset from the beginning of the 
855 \addtoindex{.debug\_ranges} section
856 to the beginning of the non\dash contiguous address ranges
857 information for the referencing entity.  
858 It is relocatable in
859 a relocatable object file, and relocated in an executable or
860 shared object. In the 32\dash bit DWARF format, this offset
861 is a 4\dash byte unsigned value; in the 64\dash bit DWARF
862 format, it is an 8\dash byte unsigned value (see Section
863 \refersec{datarep:32bitand64bitdwarfformats}).
864 \end{itemize}
865
866 \textit{Because classes \livelink{chap:lineptr}{lineptr}, 
867 \livelink{chap:loclistptr}{loclistptr}, 
868 \livelink{chap:macptr}{macptr} and 
869 \livelink{chap:rangelistptr}{rangelistptr}
870 share a common representation, it is not possible for an
871 attribute to allow more than one of these classes}
872
873
874 \begin{itemize}
875 \item reference \\
876 There are three types of reference.
877
878 The 
879 \addtoindexx{reference class}
880 first type of reference can identify any debugging
881 information entry within the containing unit. 
882 This type of
883 reference is an 
884 \addtoindexx{section offset!in class reference value}
885 offset from the first byte of the compilation
886 header for the compilation unit containing the reference. There
887 are five forms for this type of reference. There are fixed
888 length forms for one, two, four and eight byte offsets
889 (respectively, \livetarg{chap:DWFORMref1}{DW\_FORM\_ref1}, 
890 \livetarg{chap:DWFORMref2}{DW\_FORM\_ref2}, 
891 \livetarg{chap:DWFORMref4}{DW\_FORM\_ref4},
892 and \livetarg{chap:DWFORMref8}{DW\_FORM\_ref8}). 
893 There is also an unsigned variable
894 length offset encoded form that uses unsigned LEB128 numbers
895 (\livetarg{chap:DWFORMrefudata}{DW\_FORM\_ref\_udata}). 
896 Because this type of reference is within
897 the containing compilation unit no relocation of the value
898 is required.
899
900 The second type of reference can identify any debugging
901 information entry within a 
902 \addtoindex{.debug\_info} section; in particular,
903 it may refer to an entry in a different compilation unit
904 from the unit containing the reference, and may refer to an
905 entry in a different shared object.  This type of reference
906 (\livetarg{chap:DWFORMrefaddr}{DW\_FORM\_ref\_addr}) 
907 is an offset from the beginning of the
908 \addtoindex{.debug\_info} 
909 section of the target executable or shared object;
910 it is relocatable in a relocatable object file and frequently
911 relocated in an executable file or shared object. For
912 references from one shared object or static executable file
913 to another, the relocation and identification of the target
914 object must be performed by the consumer. In the 32\dash bit DWARF
915 format, this offset is a 4\dash byte unsigned value; 
916 in the 64\dash bit DWARF format, it is an 8\dash byte
917 unsigned value 
918 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
919
920 \textit{A debugging information entry that may be referenced by
921 another compilation unit using 
922 \livelink{chap:DWFORMrefaddr}{DW\_FORM\_ref\_addr} must have a
923 global symbolic name.}
924
925 \textit{For a reference from one executable or shared object to
926 another, the reference is resolved by the debugger to identify
927 the shared object or executable and the offset into that
928 object\textquoteright s \addtoindex{.debug\_info}
929 section in the same fashion as the run
930 time loader, either when the debug information is first read,
931 or when the reference is used.}
932
933 The third type of reference can identify any debugging
934 information type entry that has been placed in its own
935 \addtoindex{type unit}. This type of 
936 reference (\livetarg{chap:DWFORMrefsig8}{DW\_FORM\_ref\_sig8}) is the
937 \addtoindexx{type signature}
938 64\dash bit type signature 
939 (see Section \refersec{datarep:typesignaturecomputation}) 
940 that was computed
941 for the type.
942
943 \textit{The use of compilation unit relative references will reduce the
944 number of link\dash time relocations and so speed up linking. The
945 use of the second and third type of reference allows for the
946 sharing of information, such as types, across compilation
947 units.}
948
949 \textit{A reference to any kind of compilation unit identifies the
950 debugging information entry for that unit, not the preceding
951 header.}
952
953 \item string \\
954 A string is a sequence of contiguous non\dash null bytes followed by
955 one null byte. 
956 \addtoindexx{string class}
957 A string may be represented immediately in the
958 debugging information entry itself 
959 (\livetarg{chap:DWFORMstring}{DW\_FORM\_string}), or may
960 be represented as an 
961 \addtoindexx{section offset!in class string value}
962 offset into a string table contained in
963 the \addtoindex{.debug\_str} section of the object file 
964 (\livetarg{chap:DWFORMstrp}{DW\_FORM\_strp}). In
965 the 32\dash bit DWARF format, the representation of a 
966 \livelink{chap:DWFORMstrp}{DW\_FORM\_strp}
967 value is a 4\dash byte unsigned offset; in the 64\dash bit DWARF format,
968 it is an 8\dash byte unsigned offset 
969 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
970
971 If the \livelink{chap:DWATuseUTF8}{DW\_AT\_use\_UTF8}
972 \addtoindexx{use UTF8 attribute}\addtoindexx{UTF-8} attribute is specified for the
973 compilation unit entry, string values are encoded using the
974 UTF\dash 8 (\addtoindex{Unicode} Transformation Format\dash 8) from the Universal
975 Character Set standard (ISO/IEC 10646\dash 1:1993). Otherwise,
976 the string representation is unspecified.
977
978 \textit{The \addtoindex{Unicode} Standard Version 3 is fully compatible with
979 ISO/IEC 10646\dash 1:1993. It contains all the same characters
980 and encoding points as ISO/IEC 10646, as well as additional
981 information about the characters and their use.}
982
983 \textit{Earlier versions of DWARF did not specify the representation
984 of strings; for compatibility, this version also does
985 not. However, the UTF\dash 8 representation is strongly recommended.}
986
987 \end{itemize}
988
989 In no case does an attribute use 
990 \addtoindexx{rangelistptr class}
991 one 
992 \addtoindexx{loclistptr class}
993 of 
994 \addtoindexx{lineptr class}
995 the 
996 \addtoindexx{macptr class}
997 classes \livelink{chap:lineptr}{lineptr},
998 \livelink{chap:loclistptr}{loclistptr}, \livelink{chap:macptr}{macptr} or 
999 \livelink{chap:rangelistptr}{rangelistptr} to point into either the
1000 \addtoindex{.debug\_info} or \addtoindex{.debug\_str} section.
1001
1002 The form encodings are listed in 
1003 Table \refersec{tab:attributeformencodings}.
1004
1005
1006 \begin{centering}
1007 \setlength{\extrarowheight}{0.1cm}
1008 \begin{longtable}{l|l|l}
1009   \caption{Attribute encodings} 
1010   \label{tab:attributeencodings} 
1011   \addtoindexx{attribute encodings} \\
1012   \hline \bfseries Attribute name&\bfseries Value &\bfseries Classes \\ \hline
1013 \endfirsthead
1014   \bfseries Attribute name&\bfseries Value &\bfseries Classes\\ \hline
1015 \endhead
1016   \hline \emph{Continued on next page}
1017 \endfoot
1018   \hline
1019   \ddag \ \textit{New in \addtoindex{DWARF Version 4}}
1020 \endlastfoot
1021 \livelink{chap:DWATsibling}{DW\_AT\_sibling}&0x01&reference 
1022         \addtoindexx{sibling attribute!encoding} \\
1023 \livelink{chap:DWATlocation}{DW\_AT\_location}&0x02&\livelink{chap:exprloc}{exprloc}, 
1024         \livelink{chap:loclistptr}{loclistptr}\addtoindexx{location attribute!encoding}   \\
1025 \livelink{chap:DWATname}{DW\_AT\_name}&0x03&string 
1026         \addtoindexx{name attribute!encoding} \\
1027 \livelink{chap:DWATordering}{DW\_AT\_ordering}&0x09&constant 
1028         \addtoindexx{ordering attribute!encoding}  \\
1029 \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size}&0x0b&constant, \livelink{chap:exprloc}{exprloc}, 
1030         reference \addtoindexx{byte size attribute!encoding} \\
1031 \livelink{chap:DWATbitoffset}{DW\_AT\_bit\_offset}&0x0c&constant, 
1032         \livelink{chap:exprloc}{exprloc}, reference \addtoindexx{bit offset attribute!encoding}  \\
1033 \livelink{chap:DWATbitsize}{DW\_AT\_bit\_size}&0x0d&constant, 
1034         \livelink{chap:exprloc}{exprloc}, reference \addtoindexx{bit size attribute!encoding} \\
1035 \livelink{chap:DWATstmtlist}{DW\_AT\_stmt\_list}&0x10&\livelink{chap:lineptr}{lineptr} 
1036         \addtoindexx{statement list attribute!encoding} \\
1037 \livelink{chap:DWATlowpc}{DW\_AT\_low\_pc}&0x11&address 
1038         \addtoindexx{low PC attribute!encoding}  \\
1039 \livelink{chap:DWAThighpc}{DW\_AT\_high\_pc}&0x12&address, constant 
1040         \addtoindexx{high PC attribute!encoding}  \\
1041 \livelink{chap:DWATlanguage}{DW\_AT\_language}&0x13&constant 
1042         \addtoindexx{language attribute!encoding}  \\
1043 \livelink{chap:DWATdiscr}{DW\_AT\_discr}&0x15&reference 
1044         \addtoindexx{discriminant attribute!encoding}  \\
1045 \livelink{chap:DWATdiscrvalue}{DW\_AT\_discr\_value}&0x16&constant 
1046         \addtoindexx{discriminant value attribute!encoding}  \\
1047 \livelink{chap:DWATvisibility}{DW\_AT\_visibility}&0x17&constant 
1048         \addtoindexx{visibility attribute!encoding} \\
1049 \livelink{chap:DWATimport}{DW\_AT\_import}&0x18&reference 
1050         \addtoindexx{import attribute!encoding}  \\
1051 \livelink{chap:DWATstringlength}{DW\_AT\_string\_length}&0x19&\livelink{chap:exprloc}{exprloc}, 
1052         \livelink{chap:loclistptr}{loclistptr} \addtoindexx{string length attribute!encoding}  \\
1053 \livelink{chap:DWATcommonreference}{DW\_AT\_common\_reference}&0x1a&reference 
1054         \addtoindexx{common reference attribute!encoding}  \\
1055 \livelink{chap:DWATcompdir}{DW\_AT\_comp\_dir}&0x1b&string 
1056         \addtoindexx{compilation directory attribute!encoding}  \\
1057 \livelink{chap:DWATconstvalue}{DW\_AT\_const\_value}&0x1c&\livelink{chap:block}{block}, constant, string 
1058         \addtoindexx{constant value attribute!encoding} \\
1059 \livelink{chap:DWATcontainingtype}{DW\_AT\_containing\_type}&0x1d&reference 
1060         \addtoindexx{containing type attribute!encoding} \\
1061 \livelink{chap:DWATdefaultvalue}{DW\_AT\_default\_value}&0x1e&reference 
1062         \addtoindexx{default value attribute!encoding} \\
1063 \livelink{chap:DWATinline}{DW\_AT\_inline}&0x20&constant 
1064         \addtoindexx{inline attribute!encoding}  \\
1065 \livelink{chap:DWATisoptional}{DW\_AT\_is\_optional}&0x21&\livelink{chap:flag}{flag} 
1066         \addtoindexx{is optional attribute!encoding} \\
1067 \livelink{chap:DWATlowerbound}{DW\_AT\_lower\_bound}&0x22&constant, 
1068         \livelink{chap:exprloc}{exprloc}, reference \addtoindexx{lower bound attribute!encoding}  \\
1069 \livelink{chap:DWATproducer}{DW\_AT\_producer}&0x25&string \addtoindexx{producer attribute!encoding}  \\
1070 \livelink{chap:DWATprototyped}{DW\_AT\_prototyped}&0x27&\livelink{chap:flag}{flag} 
1071         \addtoindexx{prototyped attribute!encoding}  \\
1072 \livelink{chap:DWATreturnaddr}{DW\_AT\_return\_addr}&0x2a&\livelink{chap:exprloc}{exprloc},
1073         \livelink{chap:loclistptr}{loclistptr} \addtoindexx{return address attribute!encoding}  \\
1074 % FIXME: lower case , not Constant
1075 \livelink{chap:DWATstartscope}{DW\_AT\_start\_scope}&0x2c&constant, 
1076         \livelink{chap:rangelistptr}{rangelistptr} \addtoindexx{start scope attribute!encoding}  \\
1077 \livelink{chap:DWATbitstride}{DW\_AT\_bit\_stride}&0x2e&constant,
1078         \livelink{chap:exprloc}{exprloc}, reference \addtoindexx{bit stride attribute!encoding}  \\
1079 \livelink{chap:DWATupperbound}{DW\_AT\_upper\_bound}&0x2f&constant,
1080         \livelink{chap:exprloc}{exprloc}, reference \addtoindexx{upper bound attribute!encoding}  \\
1081 \livelink{chap:DWATabstractorigin}{DW\_AT\_abstract\_origin}&0x31&reference 
1082         \addtoindexx{abstract origin attribute!encoding}  \\
1083 \livelink{chap:DWATaccessibility}{DW\_AT\_accessibility}&0x32&constant 
1084         \addtoindexx{accessibility attribute!encoding}  \\
1085 \livelink{chap:DWATaddressclass}{DW\_AT\_address\_class}&0x33&constant 
1086         \addtoindexx{address class attribute!encoding}  \\
1087 \livelink{chap:DWATartificial}{DW\_AT\_artificial}&0x34&\livelink{chap:flag}{flag} 
1088         \addtoindexx{artificial attribute!encoding}  \\
1089 \livelink{chap:DWATbasetypes}{DW\_AT\_base\_types}&0x35&reference 
1090         \addtoindexx{base types attribute!encoding}  \\
1091 \livelink{chap:DWATcallingconvention}{DW\_AT\_calling\_convention}&0x36&constant 
1092         \addtoindexx{calling convention attribute!encoding} \\
1093 \livelink{chap:DWATcount}{DW\_AT\_count}&0x37&constant, \livelink{chap:exprloc}{exprloc}, reference 
1094         \addtoindexx{count attribute!encoding}  \\
1095 \livelink{chap:DWATdatamemberlocation}{DW\_AT\_data\_member\_location}&0x38&constant, 
1096         \livelink{chap:exprloc}{exprloc}, \livelink{chap:loclistptr}{loclistptr} 
1097         \addtoindexx{data member attribute!encoding}  \\
1098 \livelink{chap:DWATdeclcolumn}{DW\_AT\_decl\_column}&0x39&constant 
1099         \addtoindexx{declaration column attribute!encoding}  \\
1100 \livelink{chap:DWATdeclfile}{DW\_AT\_decl\_file}&0x3a&constant 
1101         \addtoindexx{declaration file attribute!encoding}  \\
1102 \livelink{chap:DWATdeclline}{DW\_AT\_decl\_line}&0x3b&constant 
1103         \addtoindexx{declaration line attribute!encoding}  \\
1104 \livelink{chap:DWATdeclaration}{DW\_AT\_declaration}&0x3c&\livelink{chap:flag}{flag} 
1105         \addtoindexx{declaration attribute!encoding}  \\
1106 \livelink{chap:DWATdiscrlist}{DW\_AT\_discr\_list}&0x3d&\livelink{chap:block}{block} 
1107         \addtoindexx{discriminant list attribute!encoding}  \\
1108 \livelink{chap:DWATencoding}{DW\_AT\_encoding}&0x3e&constant 
1109         \addtoindexx{encoding attribute!encoding}  \\
1110 \livelink{chap:DWATexternal}{DW\_AT\_external}&\xiiif&\livelink{chap:flag}{flag} 
1111         \addtoindexx{external attribute!encoding}  \\
1112 \livelink{chap:DWATframebase}{DW\_AT\_frame\_base}&0x40&\livelink{chap:exprloc}{exprloc}, 
1113         \livelink{chap:loclistptr}{loclistptr} \addtoindexx{frame base attribute!encoding}  \\
1114 \livelink{chap:DWATfriend}{DW\_AT\_friend}&0x41&reference 
1115         \addtoindexx{friend attribute!encoding}  \\
1116 \livelink{chap:DWATidentifiercase}{DW\_AT\_identifier\_case}&0x42&constant 
1117         \addtoindexx{identifier case attribute!encoding}  \\
1118 \livelink{chap:DWATmacroinfo}{DW\_AT\_macro\_info}&0x43&\livelink{chap:macptr}{macptr} 
1119         \addtoindexx{macro information attribute!encoding}  \\
1120 \livelink{chap:DWATnamelistitem}{DW\_AT\_namelist\_item}&0x44&reference 
1121         \addtoindexx{name list item attribute!encoding}  \\
1122 \livelink{chap:DWATpriority}{DW\_AT\_priority}&0x45&reference 
1123         \addtoindexx{priority attribute!encoding}  \\
1124 \livelink{chap:DWATsegment}{DW\_AT\_segment}&0x46&\livelink{chap:exprloc}{exprloc}, 
1125         \livelink{chap:loclistptr}{loclistptr} \addtoindexx{segment attribute!encoding}  \\
1126 \livelink{chap:DWATspecification}{DW\_AT\_specification}&0x47&reference 
1127         \addtoindexx{specification attribute!encoding}  \\
1128 \livelink{chap:DWATstaticlink}{DW\_AT\_static\_link}&0x48&\livelink{chap:exprloc}{exprloc}, 
1129         \livelink{chap:loclistptr}{loclistptr} \addtoindexx{static link attribute!encoding}  \\
1130 \livelink{chap:DWATtype}{DW\_AT\_type}&0x49&reference 
1131         \addtoindexx{type attribute!encoding}  \\
1132 \livelink{chap:DWATuselocation}{DW\_AT\_use\_location}&0x4a&\livelink{chap:exprloc}{exprloc}, 
1133         \livelink{chap:loclistptr}{loclistptr} \addtoindexx{location list attribute!encoding}  \\
1134 \livelink{chap:DWATvariableparameter}{DW\_AT\_variable\_parameter}&0x4b&\livelink{chap:flag}{flag} 
1135         \addtoindexx{variable parameter attribute!encoding}  \\
1136 \livelink{chap:DWATvirtuality}{DW\_AT\_virtuality}&0x4c&constant 
1137         \addtoindexx{virtuality attribute!encoding}  \\
1138 \livelink{chap:DWATvtableelemlocation}{DW\_AT\_vtable\_elem\_location}&0x4d&\livelink{chap:exprloc}{exprloc}, 
1139         \livelink{chap:loclistptr}{loclistptr} \addtoindexx{vtable element location attribute!encoding}  \\
1140
1141 \livelink{chap:DWATallocated}{DW\_AT\_allocated}&0x4e&constant, \livelink{chap:exprloc}{exprloc}, 
1142         reference \addtoindexx{allocated attribute!encoding}  \\
1143 \livelink{chap:DWATassociated}{DW\_AT\_associated}&0x4f&constant, \livelink{chap:exprloc}{exprloc}, 
1144         reference \addtoindexx{associated attribute!encoding}  \\
1145 \livelink{chap:DWATdatalocation}{DW\_AT\_data\_location}&0x50&\livelink{chap:exprloc}{exprloc} 
1146         \addtoindexx{data location attribute!encoding}  \\
1147 \livelink{chap:DWATbytestride}{DW\_AT\_byte\_stride}&0x51&constant, \livelink{chap:exprloc}{exprloc}, 
1148         reference \addtoindexx{byte stride attribute!encoding}  \\
1149 \livelink{chap:DWATentrypc}{DW\_AT\_entry\_pc}&0x52&address 
1150         \addtoindexx{entry pc attribute!encoding}  \\
1151 \livelink{chap:DWATuseUTF8}{DW\_AT\_use\_UTF8}&0x53&\livelink{chap:flag}{flag} 
1152         \addtoindexx{use UTF8 attribute!encoding}\addtoindexx{UTF-8}  \\
1153 \livelink{chap:DWATextension}{DW\_AT\_extension}&0x54&reference 
1154         \addtoindexx{extension attribute!encoding}  \\
1155 \livelink{chap:DWATranges}{DW\_AT\_ranges}&0x55&\livelink{chap:rangelistptr}{rangelistptr} 
1156         \addtoindexx{ranges attribute!encoding}  \\
1157 \livelink{chap:DWATtrampoline}{DW\_AT\_trampoline}&0x56&address, \livelink{chap:flag}{flag}, 
1158         reference, string \addtoindexx{trampoline attribute!encoding}  \\
1159 \livelink{chap:DWATcallcolumn}{DW\_AT\_call\_column}&0x57&constant 
1160         \addtoindexx{call column attribute!encoding}  \\
1161 \livelink{chap:DWATcallfile}{DW\_AT\_call\_file}&0x58&constant 
1162         \addtoindexx{call file attribute!encoding}  \\
1163 \livelink{chap:DWATcallline}{DW\_AT\_call\_line}&0x59&constant 
1164         \addtoindexx{call line attribute!encoding}  \\
1165 \livelink{chap:DWATdescription}{DW\_AT\_description}&0x5a&string 
1166         \addtoindexx{description attribute!encoding}  \\
1167 \livelink{chap:DWATbinaryscale}{DW\_AT\_binary\_scale}&0x5b&constant 
1168         \addtoindexx{binary scale attribute!encoding}  \\
1169 \livelink{chap:DWATdecimalscale}{DW\_AT\_decimal\_scale}&0x5c&constant 
1170         \addtoindexx{decimal scale attribute!encoding}  \\
1171 \livelink{chap:DWATsmall}{DW\_AT\_small} &0x5d&reference 
1172         \addtoindexx{small attribute!encoding}  \\
1173 \livelink{chap:DWATdecimalsign}{DW\_AT\_decimal\_sign}&0x5e&constant 
1174         \addtoindexx{decimal scale attribute!encoding}  \\
1175 \livelink{chap:DWATdigitcount}{DW\_AT\_digit\_count}&0x5f&constant 
1176         \addtoindexx{digit count attribute!encoding}  \\
1177 \livelink{chap:DWATpicturestring}{DW\_AT\_picture\_string}&0x60&string 
1178         \addtoindexx{picture string attribute!encoding}  \\
1179 \livelink{chap:DWATmutable}{DW\_AT\_mutable}&0x61&\livelink{chap:flag}{flag} 
1180         \addtoindexx{mutable attribute!encoding}  \\
1181
1182 \livelink{chap:DWATthreadsscaled}{DW\_AT\_threads\_scaled}&0x62&\livelink{chap:flag}{flag} 
1183         \addtoindexx{thread scaled attribute!encoding}  \\
1184 \livelink{chap:DWATexplicit}{DW\_AT\_explicit}&0x63&\livelink{chap:flag}{flag} 
1185         \addtoindexx{explicit attribute!encoding}  \\
1186 \livelink{chap:DWATobjectpointer}{DW\_AT\_object\_pointer}&0x64&reference 
1187         \addtoindexx{object pointer attribute!encoding}  \\
1188 \livelink{chap:DWATendianity}{DW\_AT\_endianity}&0x65&constant 
1189         \addtoindexx{endianity attribute!encoding}  \\
1190 \livelink{chap:DWATelemental}{DW\_AT\_elemental}&0x66&\livelink{chap:flag}{flag} 
1191         \addtoindexx{elemental attribute!encoding}  \\
1192 \livelink{chap:DWATpure}{DW\_AT\_pure}&0x67&\livelink{chap:flag}{flag} 
1193         \addtoindexx{pure attribute!encoding}  \\
1194 \livelink{chap:DWATrecursive}{DW\_AT\_recursive}&0x68&\livelink{chap:flag}{flag} 
1195         \addtoindexx{recursive attribute!encoding}  \\
1196 \livelink{chap:DWATsignature}{DW\_AT\_signature} \ddag &0x69&reference 
1197         \addtoindexx{signature attribute!encoding}  \\ 
1198 \livelink{chap:DWATmainsubprogram}{DW\_AT\_main\_subprogram} \ddag &0x6a&\livelink{chap:flag}{flag} 
1199         \addtoindexx{main subprogram attribute!encoding}  \\
1200 \livelink{chap:DWATdatabitoffset}{DW\_AT\_data\_bit\_offset} \ddag &0x6b&constant 
1201         \addtoindexx{data bit offset attribute!encoding}  \\
1202 \livelink{chap:DWATconstexpr}{DW\_AT\_const\_expr} \ddag &0x6c&\livelink{chap:flag}{flag} 
1203         \addtoindexx{constant expression attribute!encoding}  \\
1204 \livelink{chap:DWATenumclass}{DW\_AT\_enum\_class} \ddag &0x6d&\livelink{chap:flag}{flag} 
1205         \addtoindexx{enumeration class attribute!encoding}  \\
1206 \livelink{chap:DWATlinkagename}{DW\_AT\_linkage\_name} \ddag &0x6e&string 
1207         \addtoindexx{linkage name attribute!encoding}  \\
1208 \livetarg{chap:DWATlouser}{DW\_AT\_lo\_user}&0x2000 & --- \addtoindexx{low user attribute encoding}  \\
1209 \livetarg{chap:DWAThiuser}{DW\_AT\_hi\_user}&\xiiifff& --- \addtoindexx{high user attribute encoding}  \\
1210
1211 \end{longtable} 
1212 \end{centering}
1213
1214 \begin{centering}
1215 \setlength{\extrarowheight}{0.1cm}
1216 \begin{longtable}{l|l|l}
1217   \caption{Attribute form encodings} \label{tab:attributeformencodings} \\
1218   \hline \bfseries Form name&\bfseries Value &\bfseries Classes \\ \hline
1219 \endfirsthead
1220   \bfseries Form name&\bfseries Value &\bfseries Classes\\ \hline
1221 \endhead
1222   \hline \emph{Continued on next page}
1223 \endfoot
1224   \hline
1225   \ddag \ \textit{New in \addtoindex{DWARF Version 4}}
1226 \endlastfoot
1227 \livelink{chap:DWFORMaddr}{DW\_FORM\_addr}&0x01&address  \\
1228 \livelink{chap:DWFORMblock2}{DW\_FORM\_block2}&0x03&\livelink{chap:block}{block} \\
1229 \livelink{chap:DWFORMblock4}{DW\_FORM\_block4}&0x04&\livelink{chap:block}{block}  \\
1230 \livelink{chap:DWFORMdata2}{DW\_FORM\_data2}&0x05&constant \\
1231 \livelink{chap:DWFORMdata4}{DW\_FORM\_data4}&0x06&constant \\
1232 \livelink{chap:DWFORMdata8}{DW\_FORM\_data8}&0x07&constant \\
1233 \livelink{chap:DWFORMstring}{DW\_FORM\_string}&0x08&string \\
1234 \livelink{chap:DWFORMblock}{DW\_FORM\_block}&0x09&\livelink{chap:block}{block} \\
1235 \livelink{chap:DWFORMblock1}{DW\_FORM\_block1}&0x0a&\livelink{chap:block}{block} \\
1236 \livelink{chap:DWFORMdata1}{DW\_FORM\_data1}&0x0b&constant \\
1237 \livelink{chap:DWFORMflag}{DW\_FORM\_flag}&0x0c&\livelink{chap:flag}{flag} \\
1238 \livelink{chap:DWFORMsdata}{DW\_FORM\_sdata}&0x0d&constant    \\
1239 \livelink{chap:DWFORMstrp}{DW\_FORM\_strp}&0x0e&string         \\
1240 \livelink{chap:DWFORMudata}{DW\_FORM\_udata}&0x0f&constant         \\
1241 \livelink{chap:DWFORMrefaddr}{DW\_FORM\_ref\_addr}&0x10&reference         \\
1242 \livelink{chap:DWFORMref1}{DW\_FORM\_ref1}&0x11&reference          \\
1243 \livelink{chap:DWFORMref2}{DW\_FORM\_ref2}&0x12&reference         \\
1244 \livelink{chap:DWFORMref4}{DW\_FORM\_ref4}&0x13&reference         \\
1245 \livelink{chap:DWFORMref8}{DW\_FORM\_ref8}&0x14&reference \\
1246 \livelink{chap:DWFORMrefudata}{DW\_FORM\_ref\_udata}&0x15&reference  \\
1247 \livelink{chap:DWFORMindirect}{DW\_FORM\_indirect}&0x16&(see Section \refersec{datarep:abbreviationstables}) \\
1248 \livelink{chap:DWFORMsecoffset}{DW\_FORM\_sec\_offset} \ddag &0x17&\livelink{chap:lineptr}{lineptr}, \livelink{chap:loclistptr}{loclistptr}, \livelink{chap:macptr}{macptr}, \livelink{chap:rangelistptr}{rangelistptr} \\
1249 \livelink{chap:DWFORMexprloc}{DW\_FORM\_exprloc} \ddag &0x18&\livelink{chap:exprloc}{exprloc} \\
1250 \livelink{chap:DWFORMflagpresent}{DW\_FORM\_flag\_present} \ddag &0x19&\livelink{chap:flag}{flag} \\
1251 \livelink{chap:DWFORMrefsig8}{DW\_FORM\_ref\_sig8} \ddag &0x20&reference \\
1252  
1253 \end{longtable}
1254 \end{centering}
1255
1256
1257 \needlines{6}
1258 \section{Variable Length Data}
1259 \label{datarep:variablelengthdata}
1260 \addtoindexx{variable length data|see {LEB128}}
1261 Integers may be 
1262 \addtoindexx{Little Endian Base 128|see{LEB128}}
1263 encoded using ``Little Endian Base 128''
1264 \addtoindexx{little-endian encoding|see{endian attribute}}
1265 (LEB128) numbers. 
1266 \addtoindexx{LEB128}
1267 LEB128 is a scheme for encoding integers
1268 densely that exploits the assumption that most integers are
1269 small in magnitude.
1270
1271 \textit{This encoding is equally suitable whether the target machine
1272 architecture represents data in big\dash\ endian or little\dash endian
1273 order. It is ``little\dash endian'' only in the sense that it
1274 avoids using space to represent the ``big'' end of an
1275 unsigned integer, when the big end is all zeroes or sign
1276 extension bits.}
1277
1278 Unsigned LEB128 (ULEB128) numbers are encoded as follows:
1279 \addtoindexx{LEB128!unsigned, encoding as}
1280 start at the low order end of an unsigned integer and chop
1281 it into 7\dash bit chunks. Place each chunk into the low order 7
1282 bits of a byte. Typically, several of the high order bytes
1283 will be zero; discard them. Emit the remaining bytes in a
1284 stream, starting with the low order byte; set the high order
1285 bit on each byte except the last emitted byte. The high bit
1286 of zero on the last byte indicates to the decoder that it
1287 has encountered the last byte.
1288
1289 The integer zero is a special case, consisting of a single
1290 zero byte.
1291
1292 Table \refersec{tab:examplesofunsignedleb128encodings}
1293 gives some examples of unsigned LEB128 numbers. The
1294 0x80 in each case is the high order bit of the byte, indicating
1295 that an additional byte follows.
1296
1297
1298 The encoding for signed, two\textquoteright s complement LEB128 (SLEB128)
1299 \addtoindexx{LEB128!signed, encoding as}
1300 numbers is similar, except that the criterion for discarding
1301 high order bytes is not whether they are zero, but whether
1302 they consist entirely of sign extension bits. Consider the
1303 32\dash bit integer -2. The three high level bytes of the number
1304 are sign extension, thus LEB128 would represent it as a single
1305 byte containing the low order 7 bits, with the high order
1306 bit cleared to indicate the end of the byte stream. Note
1307 that there is nothing within the LEB128 representation that
1308 indicates whether an encoded number is signed or unsigned. The
1309 decoder must know what type of number to expect. 
1310 Table \refersec{tab:examplesofunsignedleb128encodings}
1311 gives some examples of unsigned LEB128 numbers and 
1312 Table \refersec{tab:examplesofsignedleb128encodings}
1313 gives some examples of signed LEB128 
1314 numbers.
1315
1316 \textit{Appendix \refersec{app:variablelengthdataencodingdecodinginformative} 
1317 \addtoindexx{LEB128!examples}
1318 gives algorithms for encoding and decoding these forms.}
1319
1320 \needlines{8}
1321 \begin{centering}
1322 \setlength{\extrarowheight}{0.1cm}
1323 \begin{longtable}{l|l|l}
1324   \caption{Examples of unsigned LEB128 encodings}
1325   \label{tab:examplesofunsignedleb128encodings} 
1326   \addtoindexx{LEB128 encoding!examples} \\
1327   \hline \bfseries Number&\bfseries First byte &\bfseries Second byte \\ \hline
1328 \endfirsthead
1329   \bfseries Number&\bfseries First Byte &\bfseries Second byte\\ \hline
1330 \endhead
1331   \hline \emph{Continued on next page}
1332 \endfoot
1333   \hline
1334 \endlastfoot
1335 2&2& --- \\
1336 127&127& ---\\
1337 128& 0 + 0x80 & 1 \\
1338 129& 1 + 0x80 & 1 \\
1339 130& 2 + 0x80 & 1 \\
1340 12857& 57 + 0x80 & 100 \\
1341 \end{longtable}
1342 \end{centering}
1343
1344
1345
1346 \begin{centering}
1347 \setlength{\extrarowheight}{0.1cm}
1348 \begin{longtable}{l|l|l}
1349   \caption{Examples of signed LEB128 encodings} \label{tab:examplesofsignedleb128encodings} \\
1350   \hline \bfseries Number&\bfseries First byte &\bfseries Second byte \\ \hline
1351 \endfirsthead
1352   \bfseries Number&\bfseries First Byte &\bfseries Second byte\\ \hline
1353 \endhead
1354   \hline \emph{Continued on next page}
1355 \endfoot
1356   \hline
1357 \endlastfoot
1358 2&2& --- \\
1359 -2&0x7e& ---\\
1360 127& 127 + 0x80 & 0 \\
1361 -127& 1 + 0x80 & 0x7f \\
1362 128& 0 + 0x80 & 1 \\
1363 -128& 0 + 0x80 & 0x7f \\
1364 129& 1 + 0x80 & 1 \\
1365 -129& 0x7f + 0x80 & 0x7e \\
1366
1367 \end{longtable}
1368 \end{centering}
1369
1370
1371
1372 \section{DWARF Expressions and Location Descriptions}
1373 \label{datarep:dwarfexpressionsandlocationdescriptions}
1374 \subsection{DWARF Expressions}
1375 \label{datarep:dwarfexpressions}
1376
1377
1378 \addtoindexx{DWARF Expression!operator encoding}
1379 DWARF expression is stored in a \nolink{block} of contiguous
1380 bytes. The bytes form a sequence of operations. Each operation
1381 is a 1\dash byte code that identifies that operation, followed by
1382 zero or more bytes of additional data. The encodings for the
1383 operations are described in 
1384 Table \refersec{tab:dwarfoperationencodings}. 
1385
1386 \begin{centering}
1387 \setlength{\extrarowheight}{0.1cm}
1388 \begin{longtable}{l|l|c|l}
1389   \caption{DWARF operation encodings} \label{tab:dwarfoperationencodings} \\
1390   \hline & &\bfseries No. of  &\\ 
1391   \bfseries Operation&\bfseries Code &\bfseries Operands &\bfseries Notes\\ \hline
1392 \endfirsthead
1393    & &\bfseries No. of &\\ 
1394   \bfseries Operation&\bfseries Code &\bfseries  Operands &\bfseries Notes\\ \hline
1395 \endhead
1396   \hline \emph{Continued on next page}
1397 \endfoot
1398   \hline
1399   \ddag \ \textit{New in \addtoindex{DWARF Version 4}}
1400 \endlastfoot
1401
1402 \livelink{chap:DWOPaddr}{DW\_OP\_addr}&0x03&1 & constant address  \\ 
1403 & & &(size target specific) \\
1404
1405 \livelink{chap:DWOPderef}{DW\_OP\_deref}&0x06&0 & \\
1406
1407
1408 \livelink{chap:DWOPconst1u}{DW\_OP\_const1u}&0x08&1&1\dash byte constant  \\
1409 \livelink{chap:DWOPconst1s}{DW\_OP\_const1s}&0x09&1&1\dash byte constant   \\
1410 \livelink{chap:DWOPconst2u}{DW\_OP\_const2u}&0x0a&1&2\dash byte constant   \\
1411 \livelink{chap:DWOPconst2s}{DW\_OP\_const2s}&0x0b&1&2\dash byte constant   \\
1412 \livelink{chap:DWOPconst4u}{DW\_OP\_const4u}&0x0c&1&4\dash byte constant    \\
1413 \livelink{chap:DWOPconst4s}{DW\_OP\_const4s}&0x0d&1&4\dash byte constant   \\
1414 \livelink{chap:DWOPconst8u}{DW\_OP\_const8u}&0x0e&1&8\dash byte constant   \\
1415 \livelink{chap:DWOPconst8s}{DW\_OP\_const8s}&0x0f&1&8\dash byte constant   \\
1416 \livelink{chap:DWOPconstu}{DW\_OP\_constu}&0x10&1&ULEB128 constant   \\
1417 \livelink{chap:DWOPconsts}{DW\_OP\_consts}&0x11&1&SLEB128 constant   \\
1418 \livelink{chap:DWOPdup}{DW\_OP\_dup}&0x12&0 &   \\
1419 \livelink{chap:DWOPdrop}{DW\_OP\_drop}&0x13&0  &   \\
1420 \livelink{chap:DWOPover}{DW\_OP\_over}&0x14&0 &   \\
1421 \livelink{chap:DWOPpick}{DW\_OP\_pick}&0x15&1&1\dash byte stack index   \\
1422 \livelink{chap:DWOPswap}{DW\_OP\_swap}&0x16&0 &   \\
1423 \livelink{chap:DWOProt}{DW\_OP\_rot}&0x17&0 &   \\
1424 \livelink{chap:DWOPxderef}{DW\_OP\_xderef}&0x18&0 &   \\
1425 \livelink{chap:DWOPabs}{DW\_OP\_abs}&0x19&0 &   \\
1426 \livelink{chap:DWOPand}{DW\_OP\_and}&0x1a&0 &   \\
1427 \livelink{chap:DWOPdiv}{DW\_OP\_div}&0x1b&0 &   \\
1428
1429
1430
1431 \livelink{chap:DWOPminus}{DW\_OP\_minus}&0x1c&0 & \\
1432 \livelink{chap:DWOPmod}{DW\_OP\_mod}&0x1d&0 & \\
1433 \livelink{chap:DWOPmul}{DW\_OP\_mul}&0x1e&0 & \\
1434 \livelink{chap:DWOPneg}{DW\_OP\_neg}&0x1f&0 & \\
1435 \livelink{chap:DWOPnot}{DW\_OP\_not}&0x20&0 & \\
1436 \livelink{chap:DWOPor}{DW\_OP\_or}&0x21&0 & \\
1437 \livelink{chap:DWOPplus}{DW\_OP\_plus}&0x22&0 & \\
1438 \livelink{chap:DWOPplusuconst}{DW\_OP\_plus\_uconst}&0x23&1&ULEB128 addend \\
1439 \livelink{chap:DWOPshl}{DW\_OP\_shl}&0x24&0 & \\
1440 \livelink{chap:DWOPshr}{DW\_OP\_shr}&0x25&0 & \\
1441 \livelink{chap:DWOPshra}{DW\_OP\_shra}&0x26&0 & \\
1442 \livelink{chap:DWOPxor}{DW\_OP\_xor}&0x27&0 & \\
1443
1444 \livelink{chap:DWOPbra}{DW\_OP\_bra}&0x28&1 & signed 2\dash byte constant \\
1445 \livelink{chap:DWOPeq}{DW\_OP\_eq}&0x29&0 & \\
1446 \livelink{chap:DWOPge}{DW\_OP\_ge}&0x2a&0 & \\
1447 \livelink{chap:DWOPgt}{DW\_OP\_gt}&0x2b&0 & \\
1448 \livelink{chap:DWOPle}{DW\_OP\_le}&0x2c&0 & \\
1449 \livelink{chap:DWOPlt}{DW\_OP\_lt}&0x2d&0  & \\
1450 \livelink{chap:DWOPne}{DW\_OP\_ne}&0x2e&0 & \\
1451 \livelink{chap:DWOPskip}{DW\_OP\_skip}&0x2f&1&signed 2\dash byte constant \\ \hline
1452
1453 \livelink{chap:DWOPlit0}{DW\_OP\_lit0}&0x30 & 0 & \\
1454 \livelink{chap:DWOPlit1}{DW\_OP\_lit1}&0x31 & 0& literals 0 .. 31 = \\
1455 \ldots & & &\hspace{0.5cm}(\livelink{chap:DWOPlit0}{DW\_OP\_lit0} + literal) \\
1456 \livelink{chap:DWOPlit31}{DW\_OP\_lit31}&0x4f & 0 & \\ \hline
1457
1458 \livelink{chap:DWOPreg0}{DW\_OP\_reg0} & 0x50 & 0 & \\
1459 \livelink{chap:DWOPreg1}{DW\_OP\_reg1} & 0x51 & 0&reg 0 .. 31 = \\
1460 \ldots & & &\hspace{0.5cm}(\livelink{chap:DWOPreg0}{DW\_OP\_reg0} + regnum) \\
1461 \livelink{chap:DWOPreg31}{DW\_OP\_reg31} & 0x6f & 0 & \\ \hline
1462
1463 \livelink{chap:DWOPbreg0}{DW\_OP\_breg0} & 0x70 &1 & SLEB128 offset \\
1464 \livelink{chap:DWOPbreg1}{DW\_OP\_breg1} & 0x71 & 1 &base register 0 .. 31 = \\
1465 ... & &              &\hspace{0.5cm}(\livelink{chap:DWOPbreg0}{DW\_OP\_breg0} + regnum) \\
1466 \livelink{chap:DWOPbreg31}{DW\_OP\_breg31} & 0x8f & 1 & \\ \hline
1467
1468 \livelink{chap:DWOPregx}{DW\_OP\_regx} & 0x90 &1&ULEB128 register \\
1469 \livelink{chap:DWOPfbreg}{DW\_OP\_fbreg} & 0x91&1&SLEB128 offset \\
1470 \livelink{chap:DWOPbregx}{DW\_OP\_bregx} & 0x92&2 &ULEB128 register followed \\
1471 & & & by SLEB128 offset \\
1472 \livelink{chap:DWOPpiece}{DW\_OP\_piece} & 0x93 &1& ULEB128 size of piece addressed \\
1473 \livelink{chap:DWOPderefsize}{DW\_OP\_deref\_size} & 0x94 &1& 1-byte size of data retrieved \\
1474 \livelink{chap:DWOPxderefsize}{DW\_OP\_xderef\_size} & 0x95&1&1-byte size of data retrieved \\
1475 \livelink{chap:DWOPnop}{DW\_OP\_nop} & 0x96 &0& \\
1476
1477
1478 \livelink{chap:DWOPpushobjectaddress}{DW\_OP\_push\_object\_address}&0x97&0 &  \\
1479 \livelink{chap:DWOPcall2}{DW\_OP\_call2}&0x98&1& 2\dash byte offset of DIE \\
1480 \livelink{chap:DWOPcall4}{DW\_OP\_call4}&0x99&1& 4\dash byte offset of DIE \\
1481 \livelink{chap:DWOPcallref}{DW\_OP\_call\_ref}&0x9a&1& 4\dash\  or 8\dash byte\\
1482      &&& offset of DIE \\
1483 \livelink{chap:DWOPformtlsaddress}{DW\_OP\_form\_tls\_address}&0x9b &0& \\
1484 \livelink{chap:DWOPcallframecfa}{DW\_OP\_call\_frame\_cfa} &0x9c &0& \\
1485 \livelink{chap:DWOPbitpiece}{DW\_OP\_bit\_piece}&0x9d &2&ULEB128 size followed by \\
1486 &&&ULEB128 offset\\
1487 \livelink{chap:DWOPimplicitvalue}{DW\_OP\_implicit\_value} \ddag &0x9e &2&ULEB128 size followed by \\
1488 &&&\nolink{block} of that size\\
1489 \livelink{chap:DWOPstackvalue}{DW\_OP\_stack\_value} \ddag &0x9f &0& \\
1490 \livetarg{chap:DWOPlouser}{DW\_OP\_lo\_user} &0xe0 && \\
1491 \livetarg{chap:DWOPhiuser}{DW\_OP\_hi\_user} &\xff && \\
1492
1493 \end{longtable}
1494 \end{centering}
1495
1496
1497 \subsection{Location Descriptions}
1498 \label{datarep:locationdescriptions}
1499
1500 A location description is used to compute the 
1501 location of a variable or other entity.
1502
1503 \subsection{Location Lists}
1504 \label{datarep:locationlists}
1505
1506 Each entry in a \addtoindex{location list} is either a location list entry,
1507 a base address selection entry, or an 
1508 \addtoindexx{end of list entry!in location list}
1509 end of list entry.
1510
1511 A \addtoindex{location list} entry consists of two address offsets followed
1512 by a 2\dash byte length, followed by a block of contiguous bytes
1513 that contains a DWARF location description. The length
1514 specifies the number of bytes in that block. The two offsets
1515 are the same size as an address on the target machine.
1516
1517 A base address selection entry and an 
1518 \addtoindexx{end of list entry!in location list}
1519 end of list entry each
1520 consist of two (constant or relocated) address offsets. The two
1521 offsets are the same size as an address on the target machine.
1522
1523 For a \addtoindex{location list} to be specified, the base address of
1524 \addtoindexx{base address selection entry!in location list}
1525 the corresponding compilation unit must be defined 
1526 (see Section  \refersec{chap:normalandpartialcompilationunitentries}).
1527
1528 \section{Base Type Attribute Encodings}
1529 \label{datarep:basetypeattributeencodings}
1530
1531 The encodings of the 
1532 \hypertarget{chap:DWATencodingencodingofbasetype}
1533 constants used in 
1534 \addtoindexx{encoding attribute!encoding}
1535 the 
1536 \livelink{chap:DWATencoding}{DW\_AT\_encoding}
1537 attribute are given in 
1538 Table \refersec{tab:basetypeencodingvalues}
1539
1540 \begin{centering}
1541 \setlength{\extrarowheight}{0.1cm}
1542 \begin{longtable}{l|c}
1543   \caption{Base type encoding values} \label{tab:basetypeencodingvalues} \\
1544   \hline \bfseries Base type encoding code name&\bfseries Value \\ \hline
1545 \endfirsthead
1546   \bfseries Base type encoding code name&\bfseries Value\\ \hline
1547 \endhead
1548   \hline \emph{Continued on next page}
1549 \endfoot
1550   \hline
1551   \ddag \ \textit{New in \addtoindex{DWARF Version 4}}
1552 \endlastfoot
1553
1554 \livelink{chap:DWATEaddress}{DW\_ATE\_address}&0x01 \\
1555 \livelink{chap:DWATEboolean}{DW\_ATE\_boolean}&0x02 \\
1556 \livelink{chap:DWATEcomplexfloat}{DW\_ATE\_complex\_float}&0x03 \\
1557 \livelink{chap:DWATEfloat}{DW\_ATE\_float}&0x04 \\
1558 \livelink{chap:DWATEsigned}{DW\_ATE\_signed}&0x05 \\
1559 \livelink{chap:DWATEsignedchar}{DW\_ATE\_signed\_char}&0x06 \\
1560 \livelink{chap:DWATEunsigned}{DW\_ATE\_unsigned}&0x07 \\
1561 \livelink{chap:DWATEunsignedchar}{DW\_ATE\_unsigned\_char}&0x08 \\
1562 \livelink{chap:DWATEimaginaryfloat}{DW\_ATE\_imaginary\_float}&0x09 \\
1563 \livelink{chap:DWATEpackeddecimal}{DW\_ATE\_packed\_decimal}&0x0a \\
1564 \livelink{chap:DWATEnumericstring}{DW\_ATE\_numeric\_string}&0x0b \\
1565 \livelink{chap:DWATEedited}{DW\_ATE\_edited}&0x0c \\
1566 \livelink{chap:DWATEsignedfixed}{DW\_ATE\_signed\_fixed}&0x0d \\
1567 \livelink{chap:DWATEunsignedfixed}{DW\_ATE\_unsigned\_fixed}&0x0e \\
1568 \livelink{chap:DWATEdecimalfloat}{DW\_ATE\_decimal\_float} & 0x0f \\
1569 \livelink{chap:DWATEUTF}{DW\_ATE\_UTF} \ddag & 0x10 \\
1570 \livetarg{chap:DWATElouser}{DW\_ATE\_lo\_user} & 0x80 \\
1571 \livetarg{chap:DWATEhiuser}{DW\_ATE\_hi\_user} & \xff \\
1572
1573 \end{longtable}
1574 \end{centering}
1575
1576
1577 The encodings of the constants used in the 
1578 \livelink{chap:DWATdecimalsign}{DW\_AT\_decimal\_sign} attribute 
1579 are given in 
1580 Table \refersec{tab:decimalsignencodings}.
1581
1582
1583 \begin{centering}
1584 \setlength{\extrarowheight}{0.1cm}
1585 \begin{longtable}{l|c}
1586   \caption{Decimal sign encodings} \label{tab:decimalsignencodings} \\
1587   \hline \bfseries Decimal sign code name&\bfseries Value \\ \hline
1588 \endfirsthead
1589   \bfseries Decimal sign code name&\bfseries Value\\ \hline
1590 \endhead
1591   \hline \emph{Continued on next page}
1592 \endfoot
1593   \hline
1594 \endlastfoot
1595
1596 \livelink{chap:DWDSunsigned}{DW\_DS\_unsigned} & 0x01  \\
1597 \livelink{chap:DWDSleadingoverpunch}{DW\_DS\_leading\_overpunch} & 0x02  \\
1598 \livelink{chap:DWDStrailingoverpunch}{DW\_DS\_trailing\_overpunch} & 0x03  \\
1599 \livelink{chap:DWDSleadingseparate}{DW\_DS\_leading\_separate} & 0x04  \\
1600 \livelink{chap:DWDStrailingseparate}{DW\_DS\_trailing\_separate} & 0x05  \\
1601
1602 \end{longtable}
1603 \end{centering}
1604
1605 The encodings of the constants used in the 
1606 \livelink{chap:DWATendianity}{DW\_AT\_endianity} attribute are given in 
1607 Table \refersec{tab:endianityencodings}.
1608
1609 \begin{centering}
1610 \setlength{\extrarowheight}{0.1cm}
1611 \begin{longtable}{l|c}
1612   \caption{Endianity encodings} \label{tab:endianityencodings}\\
1613   \hline \bfseries Endian code name&\bfseries Value \\ \hline
1614 \endfirsthead
1615   \bfseries Endian code name&\bfseries Value\\ \hline
1616 \endhead
1617   \hline \emph{Continued on next page}
1618 \endfoot
1619   \hline
1620 \endlastfoot
1621
1622 \livelink{chap:DWENDdefault}{DW\_END\_default}  & 0x00 \\
1623 \livelink{chap:DWENDbig}{DW\_END\_big} & 0x01 \\
1624 \livelink{chap:DWENDlittle}{DW\_END\_little} & 0x02 \\
1625 \livetarg{chap:DWENDlouser}{DW\_END\_lo\_user} & 0x40 \\
1626 \livetarg{chap:DWENDhiuser}{DW\_END\_hi\_user} & \xff \\
1627
1628 \end{longtable}
1629 \end{centering}
1630
1631 \section{Accessibility Codes}
1632 \label{datarep:accessibilitycodes}
1633 The encodings of the constants used in the 
1634 \livelink{chap:DWATaccessibility}{DW\_AT\_accessibility}
1635 attribute 
1636 \addtoindexx{accessibility attribute!encoding}
1637 are given in 
1638 Table \refersec{tab:accessibilityencodings}.
1639
1640 \begin{centering}
1641 \setlength{\extrarowheight}{0.1cm}
1642 \begin{longtable}{l|c}
1643   \caption{Accessibility encodings} \label{tab:accessibilityencodings}\\
1644   \hline \bfseries Accessibility code name&\bfseries Value \\ \hline
1645 \endfirsthead
1646   \bfseries Accessibility code name&\bfseries Value\\ \hline
1647 \endhead
1648   \hline \emph{Continued on next page}
1649 \endfoot
1650   \hline
1651 \endlastfoot
1652
1653 \livelink{chap:DWACCESSpublic}{DW\_ACCESS\_public}&0x01  \\
1654 \livelink{chap:DWACCESSprotected}{DW\_ACCESS\_protected}&0x02 \\
1655 \livelink{chap:DWACCESSprivate}{DW\_ACCESS\_private}&0x03 \\
1656
1657 \end{longtable}
1658 \end{centering}
1659
1660
1661 \section{Visibility Codes}
1662 \label{datarep:visibilitycodes}
1663 The encodings of the constants used in the 
1664 \livelink{chap:DWATvisibility}{DW\_AT\_visibility} attribute are given in 
1665 Table \refersec{tab:visibilityencodings}. 
1666
1667 \begin{centering}
1668 \setlength{\extrarowheight}{0.1cm}
1669 \begin{longtable}{l|c}
1670   \caption{Visibility encodings} \label{tab:visibilityencodings}\\
1671   \hline \bfseries Visiibility code name&\bfseries Value \\ \hline
1672 \endfirsthead
1673   \bfseries Visibility code name&\bfseries Value\\ \hline
1674 \endhead
1675   \hline \emph{Continued on next page}
1676 \endfoot
1677   \hline
1678 \endlastfoot
1679
1680 \livelink{chap:DWVISlocal}{DW\_VIS\_local}&0x01 \\
1681 \livelink{chap:DWVISexported}{DW\_VIS\_exported}&0x02 \\
1682 \livelink{chap:DWVISqualified}{DW\_VIS\_qualified}&0x03 \\
1683
1684 \end{longtable}
1685 \end{centering}
1686
1687 \section{Virtuality Codes}
1688 \label{datarep:vitualitycodes}
1689
1690 The encodings of the constants used in the 
1691 \livelink{chap:DWATvirtuality}{DW\_AT\_virtuality} attribute are given in 
1692 Table \refersec{tab:virtualityencodings}.
1693
1694 \begin{centering}
1695 \setlength{\extrarowheight}{0.1cm}
1696 \begin{longtable}{l|c}
1697   \caption{Virtuality encodings} \label{tab:virtualityencodings}\\
1698   \hline \bfseries Virtuality code name&\bfseries Value \\ \hline
1699 \endfirsthead
1700   \bfseries Virtuality code name&\bfseries Value\\ \hline
1701 \endhead
1702   \hline \emph{Continued on next page}
1703 \endfoot
1704   \hline
1705 \endlastfoot
1706
1707 \livelink{chap:DWVIRTUALITYnone}{DW\_VIRTUALITY\_none}&0x00 \\
1708 \livelink{chap:DWVIRTUALITYvirtual}{DW\_VIRTUALITY\_virtual}&0x01 \\
1709 \livelink{chap:DWVIRTUALITYpurevirtual}{DW\_VIRTUALITY\_pure\_virtual}&0x02 \\
1710
1711
1712
1713 \end{longtable}
1714 \end{centering}
1715
1716 The value 
1717 \livelink{chap:DWVIRTUALITYnone}{DW\_VIRTUALITY\_none} is equivalent to the absence of the 
1718 \livelink{chap:DWATvirtuality}{DW\_AT\_virtuality}
1719 attribute.
1720
1721 \section{Source Languages}
1722 \label{datarep:sourcelanguages}
1723
1724 The encodings of the constants used 
1725 \addtoindexx{language attribute, encoding}
1726 in 
1727 \addtoindexx{language name encoding}
1728 the 
1729 \livelink{chap:DWATlanguage}{DW\_AT\_language}
1730 attribute are given in 
1731 Table \refersec{tab:languageencodings}.
1732 Names marked with
1733 % If we don't force a following space it looks odd
1734 \dag \  
1735 and their associated values are reserved, but the
1736 languages they represent are not well supported. 
1737 Table \refersec{tab:languageencodings}
1738 also shows the 
1739 \addtoindexx{lower bound attribute!default}
1740 default lower bound, if any, assumed for
1741 an omitted \livelink{chap:DWATlowerbound}{DW\_AT\_lower\_bound} attribute in the context of a
1742 \livelink{chap:DWTAGsubrangetype}{DW\_TAG\_subrange\_type} debugging information entry for each
1743 defined language.
1744
1745 \begin{centering}
1746 \setlength{\extrarowheight}{0.1cm}
1747 \begin{longtable}{l|c|c}
1748   \caption{Language encodings} \label{tab:languageencodings}\\
1749   \hline \bfseries Language name&\bfseries Value &\bfseries Default Lower Bound \\ \hline
1750 \endfirsthead
1751   \bfseries Language name&\bfseries Value &\bfseries Default Lower Bound\\ \hline
1752 \endhead
1753   \hline \emph{Continued on next page}
1754 \endfoot
1755   \hline
1756   \dag \ \textit{See text}
1757 \endlastfoot
1758
1759 \livelink{chap:DWLANGC89}{DW\_LANG\_C89}&0x0001&0       \\
1760 \livelink{chap:DWLANGC}{DW\_LANG\_C}&0x0002&0  \\
1761 \livelink{chap:DWLANGAda83}{DW\_LANG\_Ada83} \dag &0x0003&1  \addtoindexx{Ada}     \\
1762 \livelink{chap:DWLANGCplusplus}{DW\_LANG\_C\_plus\_plus} &0x0004&0       \\
1763 \livelink{chap:DWLANGCobol74}{DW\_LANG\_Cobol74} \dag &0x0005&1       \\
1764 \livelink{chap:DWLANGCobol85}{DW\_LANG\_Cobol85} \dag &0x0006&1       \\
1765 \livelink{chap:DWLANGFortran77}{DW\_LANG\_Fortran77}&0x0007&1       \\
1766 \livelink{chap:DWLANGFortran90}{DW\_LANG\_Fortran90}&0x0008&1       \\
1767 \livelink{chap:DWLANGPascal83}{DW\_LANG\_Pascal83}&0x0009&1       \\
1768 \livelink{chap:DWLANGModula2}{DW\_LANG\_Modula2}&0x000a&1       \\
1769 \livelink{chap:DWLANGJava}{DW\_LANG\_Java}&0x000b&0       \\
1770 \livelink{chap:DWLANGC99}{DW\_LANG\_C99}&0x000c&0       \\
1771 \livelink{chap:DWLANGAda95}{DW\_LANG\_Ada95} \dag &0x000d&1 \addtoindexx{Ada}      \\
1772 \livelink{chap:DWLANGFortran95}{DW\_LANG\_Fortran95} &0x000e&1       \\
1773 \livelink{chap:DWLANGPLI}{DW\_LANG\_PLI} \dag &0x000f&1 \\
1774 \livelink{chap:DWLANGObjC}{DW\_LANG\_ObjC}&0x0010&0 \\
1775 \livelink{chap:DWLANGObjCplusplus}{DW\_LANG\_ObjC\_plus\_plus}&0x0011&0 \\
1776 \livelink{chap:DWLANGUPC}{DW\_LANG\_UPC}&0x0012&0 \\
1777 \livelink{chap:DWLANGD}{DW\_LANG\_D}&0x0013&0 \\
1778 \livelink{chap:DWLANGPython}{DW\_LANG\_Python} \dag &0x0014&0 \\
1779 \livetarg{chap:DWLANGlouser}{DW\_LANG\_lo\_user}&0x8000 & \\
1780 \livetarg{chap:DWLANGhiuser}{DW\_LANG\_hi\_user}&\xffff & \\
1781
1782 \end{longtable}
1783 \end{centering}
1784
1785 \section{Address Class Encodings}
1786 \label{datarep:addressclassencodings}
1787
1788 The value of the common 
1789 \addtoindexi{address}{address class!attribute encoding}
1790 class encoding 
1791 \livelink{chap:DWADDRnone}{DW\_ADDR\_none} is 0.
1792
1793
1794 \section{Identifier Case}
1795 \label{datarep:identifiercase}
1796
1797 The encodings of the constants used in the 
1798 \livelink{chap:DWATidentifiercase}{DW\_AT\_identifier\_case} attribute are given in 
1799 Table \refersec{tab:identifiercaseencodings}.
1800
1801 \begin{centering}
1802 \setlength{\extrarowheight}{0.1cm}
1803 \begin{longtable}{l|c}
1804   \caption{Identifier case encodings} \label{tab:identifiercaseencodings}\\
1805   \hline \bfseries Identifier case name&\bfseries Value \\ \hline
1806 \endfirsthead
1807   \bfseries Identifier case name&\bfseries Value\\ \hline
1808 \endhead
1809   \hline \emph{Continued on next page}
1810 \endfoot
1811   \hline
1812 \endlastfoot
1813 \livelink{chap:DWIDcasesensitive}{DW\_ID\_case\_sensitive}&0x00     \\
1814 \livelink{chap:DWIDupcase}{DW\_ID\_up\_case}&0x01     \\
1815 \livelink{chap:DWIDdowncase}{DW\_ID\_down\_case}&0x02     \\
1816 \livelink{chap:DWIDcaseinsensitive}{DW\_ID\_case\_insensitive}&0x03     \\
1817 \end{longtable}
1818 \end{centering}
1819
1820 \section{Calling Convention Encodings}
1821 \label{datarep:callingconventionencodings}
1822 The encodings of the constants used in the 
1823 \livelink{chap:DWATcallingconvention}{DW\_AT\_calling\_convention} attribute are given in
1824 Table \refersec{tab:callingconventionencodings}.
1825
1826 \begin{centering}
1827 \setlength{\extrarowheight}{0.1cm}
1828 \begin{longtable}{l|c}
1829   \caption{Calling convention encodings} \label{tab:callingconventionencodings}\\
1830   \hline \bfseries Calling Convention name&\bfseries Value \\ \hline
1831 \endfirsthead
1832   \bfseries Calling Convention name&\bfseries Value\\ \hline
1833 \endhead
1834   \hline \emph{Continued on next page}
1835 \endfoot
1836   \hline
1837 \endlastfoot
1838
1839 \livelink{chap:DWCCnormal}{DW\_CC\_normal}&0x01     \\
1840 \livelink{chap:DWCCprogram}{DW\_CC\_program}&0x02     \\
1841 \livelink{chap:DWCCnocall}{DW\_CC\_nocall}&0x03     \\
1842 \livetarg{chap:DWCClouser}{DW\_CC\_lo\_user}&0x40     \\
1843 \livetarg{chap:DWCChiuser}{DW\_CC\_hi\_user}&\xff     \\
1844
1845 \end{longtable}
1846 \end{centering}
1847
1848 \section{Inline Codes}
1849 \label{datarep:inlinecodes}
1850
1851 The encodings of the constants used in 
1852 \addtoindexx{inline attribute!encoding}
1853 the 
1854 \livelink{chap:DWATinline}{DW\_AT\_inline} attribute are given in 
1855 Table \refersec{tab:inlineencodings}.
1856
1857 \needlines{8}
1858 \begin{centering}
1859 \setlength{\extrarowheight}{0.1cm}
1860 \begin{longtable}{l|c}
1861   \caption{Inline encodings} \label{tab:inlineencodings}\\
1862   \hline \bfseries Inline Code name&\bfseries Value \\ \hline
1863 \endfirsthead
1864   \bfseries Inline Code name&\bfseries Value\\ \hline
1865 \endhead
1866   \hline \emph{Continued on next page}
1867 \endfoot
1868   \hline
1869 \endlastfoot
1870
1871 \livelink{chap:DWINLnotinlined}{DW\_INL\_not\_inlined}&0x00      \\
1872 \livelink{chap:DWINLinlined}{DW\_INL\_inlined}&0x01      \\
1873 \livelink{chap:DWINLdeclarednotinlined}{DW\_INL\_declared\_not\_inlined}&0x02      \\
1874 \livelink{chap:DWINLdeclaredinlined}{DW\_INL\_declared\_inlined}&0x03      \\
1875
1876 \end{longtable}
1877 \end{centering}
1878
1879 % this clearpage is ugly, but the following table came
1880 % out oddly without it.
1881
1882 \section{Array Ordering}
1883 \label{datarep:arrayordering}
1884
1885 The encodings of the constants used in the 
1886 \livelink{chap:DWATordering}{DW\_AT\_ordering} attribute are given in 
1887 Table \refersec{tab:orderingencodings}.
1888
1889 \begin{centering}
1890 \setlength{\extrarowheight}{0.1cm}
1891 \begin{longtable}{l|c}
1892   \caption{Ordering encodings} \label{tab:orderingencodings}\\
1893   \hline \bfseries Ordering name&\bfseries Value \\ \hline
1894 \endfirsthead
1895   \bfseries Ordering name&\bfseries Value\\ \hline
1896 \endhead
1897   \hline \emph{Continued on next page}
1898 \endfoot
1899   \hline
1900 \endlastfoot
1901
1902 \livelink{chap:DWORDrowmajor}{DW\_ORD\_row\_major}&0x00  \\
1903 \livelink{chap:DWORDcolmajor}{DW\_ORD\_col\_major}&0x01  \\
1904
1905 \end{longtable}
1906 \end{centering}
1907
1908
1909 \section{Discriminant Lists}
1910 \label{datarep:discriminantlists}
1911
1912 The descriptors used in 
1913 \addtoindexx{discriminant list attribute!encoding}
1914 the 
1915 \livelink{chap:DWATdiscrlist}{DW\_AT\_discr\_list} attribute are 
1916 encoded as 1\dash byte constants. The
1917 defined values are given in 
1918 Table \refersec{tab:discriminantdescriptorencodings}.
1919
1920 % Odd that the 'Name' field capitalized here, it is not caps elsewhere.
1921 \begin{centering}
1922 \setlength{\extrarowheight}{0.1cm}
1923 \begin{longtable}{l|c}
1924   \caption{Discriminant descriptor encodings} \label{tab:discriminantdescriptorencodings}\\
1925   \hline \bfseries Descriptor Name&\bfseries Value \\ \hline
1926 \endfirsthead
1927   \bfseries Descriptor Name&\bfseries Value\\ \hline
1928 \endhead
1929   \hline \emph{Continued on next page}
1930 \endfoot
1931   \hline
1932 \endlastfoot
1933
1934 \livetarg{chap:DWDSClabel}{DW\_DSC\_label}&0x00 \\
1935 \livetarg{chap:DWDSCrange}{DW\_DSC\_range}&0x01 \\
1936
1937 \end{longtable}
1938 \end{centering}
1939
1940 \needlines{6}
1941 \section{Name Lookup Tables}
1942 \label{datarep:namelookuptables}
1943
1944 Each set of entries in the table of global names contained
1945 in the \addtoindex{.debug\_pubnames} and 
1946 \addtoindex{.debug\_pubtypes} sections begins
1947 with a header consisting of:
1948 \begin{enumerate}[1. ]
1949
1950 \item unit\_length (initial length) \\
1951 \addtoindexx{unit\_length}
1952 A 4\dash byte or 12\dash byte unsigned integer 
1953 \addtoindexx{initial length}
1954 representing the length
1955 of the \addtoindex{.debug\_info}
1956 contribution for that compilation unit,
1957 not including the length field itself. In the 32\dash bit DWARF
1958 format, this is a 4\dash byte unsigned integer (which must be less
1959 than \xfffffffzero); in the 64\dash bit DWARF format, this consists
1960 of the 4\dash byte value \wffffffff followed by an 8\dash byte unsigned
1961 integer that gives the actual length
1962 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
1963
1964 \item  version (\addtoindex{uhalf}) \\
1965 A 2\dash byte unsigned integer representing the version of the
1966 DWARF information for the name lookup table
1967 \addtoindexx{version number!name lookup table}
1968 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}).
1969 The value in this field is 2.
1970
1971 % Some say unsigned offset this just says offset: FIXME
1972 \item \addtoindex{debug\_info\_offset} (section offset) \\
1973
1974 \addtoindexx{section offset!in name lookup table set of entries}
1975 4\dash byte or 8\dash byte 
1976 offset into the 
1977 \addtoindex{.debug\_info}
1978 section of the compilation unit header.
1979 In
1980 the 32\dash bit DWARF format, this is a 4\dash byte unsigned offset;
1981 in the 64\dash bit DWARF format, this is an 8\dash byte unsigned offsets
1982 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
1983
1984 \item  \addtoindex{debug\_info\_length} (section length) \\
1985 \addtoindexx{section length!in .debug\_pubnames header}
1986
1987 \addtoindexx{section length!in .debug\_pubtypes header}
1988 4\dash byte or 8\dash byte length containing the size in bytes of the
1989 contents of the \addtoindex{.debug\_info}
1990 section generated to represent
1991 this compilation unit. In the 32\dash bit DWARF format, this is
1992 a 4\dash byte unsigned length; in the 64\dash bit DWARF format, this
1993 is an 8-byte unsigned length 
1994 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
1995
1996
1997 \end{enumerate}
1998
1999 This header is followed by a series of tuples. Each tuple
2000 consists of a 4\dash byte or 8\dash byte offset followed by a string
2001 of non\dash null bytes terminated by one null byte. 
2002 In the 32\dash bit
2003 DWARF format, this is a 4\dash byte offset; in the 64\dash bit DWARF
2004 format, it is an 8\dash byte offset. 
2005 Each set is terminated by an
2006 offset containing the value 0.
2007
2008
2009 \needlines{6}
2010 \section{Address Range Table}
2011 \label{datarep:addrssrangetable}
2012
2013 Each set of entries in the table of address ranges contained
2014 in the \addtoindex{.debug\_aranges}
2015 section begins with a header containing:
2016 \begin{enumerate}[1. ]
2017 % FIXME The unit length text is not fully consistent across
2018 % these tables.
2019
2020 \item unit\_length (initial length) \\
2021 \addtoindexx{unit\_length}
2022 A 4-byte or 12-byte length containing the length of the
2023 \addtoindexx{initial length}
2024 set of entries for this compilation unit, not including the
2025 length field itself. In the 32-bit DWARF format, this is a
2026 4-byte unsigned integer (which must be less than \xfffffffzero);
2027 in the 64-bit DWARF format, this consists of the 4-byte value
2028 \wffffffff followed by an 8-byte unsigned integer that gives
2029 the actual length 
2030 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
2031
2032 \item version (\addtoindex{uhalf}) \\
2033 A 2\dash byte version identifier representing the version of the
2034 DWARF information for the address range table
2035 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}).
2036 This value in this field \addtoindexx{version number!address range table} is 2. 
2037  
2038
2039 \item debug\_info\_offset (section offset) \\
2040
2041 \addtoindexx{section offset!in .debug\_aranges header}
2042 4\dash byte or 8\dash byte offset into the 
2043 \addtoindex{.debug\_info} section of
2044 the compilation unit header. In the 32\dash bit DWARF format,
2045 this is a 4\dash byte unsigned offset; in the 64\dash bit DWARF format,
2046 this is an 8\dash byte unsigned offset 
2047 (see Section \refersec{datarep:32bitand64bitdwarfformats}).
2048
2049 \item address\_size (ubyte) \\
2050 A 1\dash byte unsigned integer containing the size in bytes of an
2051 \addtoindexx{address\_size}
2052 address 
2053 \addtoindexx{size of an address}
2054 (or the offset portion of an address for segmented
2055 \addtoindexx{address space!segmented}
2056 addressing) on the target system.
2057
2058 \item segment\_size (ubyte) \\
2059
2060 \addtoindexx{segment\_size}
2061 1\dash byte unsigned integer containing the size in bytes of a
2062 segment selector on the target system.
2063
2064 \end{enumerate}
2065
2066 This header is followed by a series of tuples. Each tuple
2067 consists of a segment, an address and a length. 
2068 The segment
2069 size is given by the \addtoindex{segment\_size} field of the header; the
2070 address and length size are each given by the address\_size
2071 field of the header. 
2072 The first tuple following the header in
2073 each set begins at an offset that is a multiple of the size
2074 of a single tuple (that is, the size of a segment selector
2075 plus twice the \addtoindex{size of an address}). 
2076 The header is padded, if
2077 necessary, to that boundary. Each set of tuples is terminated
2078 by a 0 for the segment, a 0 for the address and 0 for the
2079 length. If the \addtoindex{segment\_size} field in the header is zero,
2080 the segment selectors are omitted from all tuples, including
2081 the terminating tuple.
2082
2083
2084 \section{Line Number Information}
2085 \label{datarep:linenumberinformation}
2086
2087 The \addtoindexi{version number}{version number!line number information}
2088 in the line number program header is 4
2089 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
2090
2091 The boolean values ``true'' and ``false'' 
2092 used by the line number information program are encoded
2093 as a single byte containing the value 0 
2094 for ``false,'' and a non-zero value for ``true.''
2095
2096 The encodings for the standard opcodes are given in 
2097 \addtoindexx{line number opcodes!standard opcode encoding}
2098 Table \refersec{tab:linenumberstandardopcodeencodings}.
2099
2100 % Odd that the 'Name' field capitalized here, it is not caps elsewhere.
2101 \begin{centering}
2102 \setlength{\extrarowheight}{0.1cm}
2103 \begin{longtable}{l|c}
2104   \caption{Line Number Standard Opcode encodings} \label{tab:linenumberstandardopcodeencodings}\\
2105   \hline \bfseries Opcode Name&\bfseries Value \\ \hline
2106 \endfirsthead
2107   \bfseries Opcode Name&\bfseries Value\\ \hline
2108 \endhead
2109   \hline \emph{Continued on next page}
2110 \endfoot
2111   \hline
2112 \endlastfoot
2113
2114 \livelink{chap:DWLNScopy}{DW\_LNS\_copy}&0x01 \\
2115 \livelink{chap:DWLNSadvancepc}{DW\_LNS\_advance\_pc}&0x02 \\
2116 \livelink{chap:DWLNSadvanceline}{DW\_LNS\_advance\_line}&0x03 \\
2117 \livelink{chap:DWLNSsetfile}{DW\_LNS\_set\_file}&0x04 \\
2118 \livelink{chap:DWLNSsetcolumn}{DW\_LNS\_set\_column}&0x05 \\
2119 \livelink{chap:DWLNSnegatestmt}{DW\_LNS\_negate\_stmt}&0x06 \\
2120 \livelink{chap:DWLNSsetbasicblock}{DW\_LNS\_set\_basic\_block}&0x07 \\
2121 \livelink{chap:DWLNSconstaddpc}{DW\_LNS\_const\_add\_pc}&0x08 \\
2122 \livelink{chap:DWLNSfixedadvancepc}{DW\_LNS\_fixed\_advance\_pc}&0x09 \\
2123 \livelink{chap:DWLNSsetprologueend}{DW\_LNS\_set\_prologue\_end}&0x0a \\
2124 \livelink{chap:DWLNSsetepiloguebegin}{DW\_LNS\_set\_epilogue\_begin}&0x0b \\
2125 \livelink{chap:DWLNSsetisa}{DW\_LNS\_set\_isa}&0x0c \\
2126
2127 \end{longtable}
2128 \end{centering}
2129
2130
2131 \needspace{10cm}
2132 The encodings for the extended opcodes are given in 
2133 \addtoindexx{line number opcodes!extended opcode encoding}
2134 Table \refersec{tab:linenumberextendedopcodeencodings}.
2135
2136 \begin{centering}
2137 \setlength{\extrarowheight}{0.1cm}
2138 \begin{longtable}{l|c}
2139   \caption{Line Number Extended Opcode encodings} \label{tab:linenumberextendedopcodeencodings}\\
2140   \hline \bfseries Opcode Name&\bfseries Value \\ \hline
2141 \endfirsthead
2142   \bfseries Opcode Name&\bfseries Value\\ \hline
2143 \endhead
2144   \hline \emph{Continued on next page}
2145 \endfoot
2146   \hline
2147   \ddag \ \textit{New in \addtoindex{DWARF Version 4}}
2148 \endlastfoot
2149
2150 \livelink{chap:DWLNEendsequence}{DW\_LNE\_end\_sequence}&0x01    \\
2151 \livelink{chap:DWLNEsetaddress}{DW\_LNE\_set\_address}&0x02\\
2152 \livelink{chap:DWLNEdefinefile}{DW\_LNE\_define\_file}&0x03\\
2153 \livelink{chap:DWLNEsetdiscriminator}{DW\_LNE\_set\_discriminator} \ddag &0x04   \\
2154 \livetarg{chap:DWLNElouser}{DW\_LNE\_lo\_user}&0x80   \\
2155 \livetarg{chap:DWLNEhiuser}{DW\_LNE\_hi\_user}&\xff   \\
2156
2157 \end{longtable}
2158 \end{centering}
2159
2160 \section{Macro Information}
2161 \label{datarep:macroinformation}
2162
2163 The source line numbers and source file indices encoded in the
2164 macro information section are represented as unsigned LEB128
2165 numbers as are the constants in a 
2166 \livelink{chap:DWMACINFOvendorext}{DW\_MACINFO\_vendor\_ext} entry.
2167
2168 The macinfo type is encoded as a single byte. 
2169 The encodings 
2170 \addtoindexx{macinfo types!encoding}
2171 are given in 
2172 Table \refersec{tab:macinfotypeencodings}.
2173
2174
2175 \begin{centering}
2176 \setlength{\extrarowheight}{0.1cm}
2177 \begin{longtable}{l|c}
2178   \caption{Macinfo Type Encodings} \label{tab:macinfotypeencodings}\\
2179   \hline \bfseries Macinfo Type Name&\bfseries Value \\ \hline
2180 \endfirsthead
2181   \bfseries Macinfo Type Name&\bfseries Value\\ \hline
2182 \endhead
2183   \hline \emph{Continued on next page}
2184 \endfoot
2185   \hline
2186 \endlastfoot
2187
2188 \livelink{chap:DWMACINFOdefine}{DW\_MACINFO\_define}&0x01 \\
2189 \livelink{chap:DWMACINFOundef}{DW\_MACINFO\_undef}&0x02 \\
2190 \livelink{chap:DWMACINFOstartfile}{DW\_MACINFO\_start\_file}&0x03 \\
2191 \livelink{chap:DWMACINFOendfile}{DW\_MACINFO\_end\_file}&0x04 \\
2192 \livelink{chap:DWMACINFOvendorext}{DW\_MACINFO\_vendor\_ext}&\xff \\
2193
2194 \end{longtable}
2195 \end{centering}
2196
2197 \needlines{7}
2198 \section{Call Frame Information}
2199 \label{datarep:callframeinformation}
2200
2201 In the 32\dash bit DWARF format, the value of the CIE id in the
2202 CIE header is \xffffffff; in the 64\dash bit DWARF format, the
2203 value is \xffffffffffffffff.
2204
2205 The value of the CIE \addtoindexi{version number}{version number!call frame information}
2206 is 4 (see Appendix \refersec{app:dwarfsectionversionnumbersinformative}). 
2207
2208 Call frame instructions are encoded in one or more bytes. The
2209 primary opcode is encoded in the high order two bits of
2210 the first byte (that is, opcode = byte $\gg$ 6). An operand
2211 or extended opcode may be encoded in the low order 6
2212 bits. Additional operands are encoded in subsequent bytes.
2213 The instructions and their encodings are presented in
2214 Table \refersec{tab:callframeinstructionencodings}.
2215
2216 \begin{centering}
2217 \setlength{\extrarowheight}{0.1cm}
2218 \begin{longtable}{l|c|c|l|l}
2219   \caption{Call frame instruction encodings} \label{tab:callframeinstructionencodings} \\
2220   \hline &\bfseries High 2 &\bfseries Low 6 &  & \\
2221   \bfseries Instruction&\bfseries Bits &\bfseries Bits &\bfseries Operand 1 &\bfseries Operand 2\\ \hline
2222 \endfirsthead
2223    & \bfseries High 2 &\bfseries Low 6 &  &\\
2224   \bfseries Instruction&\bfseries Bits &\bfseries Bits &\bfseries Operand 1 &\bfseries Operand 2\\ \hline
2225 \endhead
2226   \hline \emph{Continued on next page}
2227 \endfoot
2228   \hline
2229 \endlastfoot
2230
2231 \livelink{chap:DWCFAadvanceloc}{DW\_CFA\_advance\_loc}&0x1&delta & \\
2232 \livelink{chap:DWCFAoffset}{DW\_CFA\_offset}&0x2&register&ULEB128 offset \\
2233 \livelink{chap:DWCFArestore}{DW\_CFA\_restore}&0x3&register & & \\
2234 \livelink{chap:DWCFAnop}{DW\_CFA\_nop}&0&0 & & \\
2235 \livelink{chap:DWCFAsetloc}{DW\_CFA\_set\_loc}&0&0x01&address & \\
2236 \livelink{chap:DWCFAadvanceloc1}{DW\_CFA\_advance\_loc1}&0&0x02&1\dash byte delta & \\
2237 \livelink{chap:DWCFAadvanceloc2}{DW\_CFA\_advance\_loc2}&0&0x03&2\dash byte delta & \\
2238 \livelink{chap:DWCFAadvanceloc4}{DW\_CFA\_advance\_loc4}&0&0x04&4\dash byte delta & \\
2239 \livelink{chap:DWCFAoffsetextended}{DW\_CFA\_offset\_extended}&0&0x05&ULEB128 register&ULEB128 offset \\
2240 \livelink{chap:DWCFArestoreextended}{DW\_CFA\_restore\_extended}&0&0x06&ULEB128 register & \\
2241 \livelink{chap:DWCFAundefined}{DW\_CFA\_undefined}&0&0x07&ULEB128 register & \\
2242 \livelink{chap:DWCFAsamevalue}{DW\_CFA\_same\_value}&0&0x08 &ULEB128 register & \\
2243 \livelink{chap:DWCFAregister}{DW\_CFA\_register}&0&0x09&ULEB128 register &ULEB128 offset \\
2244 \livelink{chap:DWCFArememberstate}{DW\_CFA\_remember\_state}&0&0x0a & & \\
2245 \livelink{chap:DWCFArestorestate}{DW\_CFA\_restore\_state}&0&0x0b & & \\
2246 \livelink{chap:DWCFAdefcfa}{DW\_CFA\_def\_cfa}&0&0x0c &ULEB128 register&ULEB128 offset \\
2247 \livelink{chap:DWCFAdefcfaregister}{DW\_CFA\_def\_cfa\_register}&0&0x0d&ULEB128 register & \\
2248 \livelink{chap:DWCFAdefcfaoffset}{DW\_CFA\_def\_cfa\_offset}&0&0x0e &ULEB128 offset & \\
2249 \livelink{chap:DWCFAdefcfaexpression}{DW\_CFA\_def\_cfa\_expression}&0&0x0f &BLOCK  \\
2250 \livelink{chap:DWCFAexpression}{DW\_CFA\_expression}&0&0x10&ULEB128 register & BLOCK \\
2251
2252 \livelink{chap:DWCFAoffsetextendedsf}{DW\_CFA\_offset\_extended\_sf}&0&0x11&ULEB128 register&SLEB128 offset \\
2253 \livelink{chap:DWCFAdefcfasf}{DW\_CFA\_def\_cfa\_sf}&0&0x12&ULEB128 register&SLEB128 offset \\
2254 \livelink{chap:DWCFAdefcfaoffsetsf}{DW\_CFA\_def\_cfa\_offset\_sf}&0&0x13&SLEB128 offset & \\
2255 \livelink{chap:DWCFAvaloffset}{DW\_CFA\_val\_offset}&0&0x14&ULEB128&ULEB128 \\
2256 \livelink{chap:DWCFAvaloffsetsf}{DW\_CFA\_val\_offset\_sf}&0&0x15&ULEB128&SLEB128 \\
2257 \livelink{chap:DWCFAvalexpression}{DW\_CFA\_val\_expression}&0&0x16&ULEB128&BLOCK  \\
2258 \livetarg{chap:DWCFAlouser}{DW\_CFA\_lo\_user}&0&0x1c   & & \\
2259 \livetarg{chap:DWCFAhiuser}{DW\_CFA\_hi\_user}&0&\xiiif & & \\
2260 \end{longtable}
2261 \end{centering}
2262
2263 \section{Non-contiguous Address Ranges}
2264 \label{datarep:noncontiguousaddressranges}
2265
2266 Each entry in a \addtoindex{range list}
2267 (see Section \refersec{chap:noncontiguousaddressranges})
2268 is either a
2269 \addtoindexx{base address selection entry!in range list}
2270 range list entry, 
2271 \addtoindexx{range list}
2272 a base address selection entry, or an end
2273 of list entry.
2274
2275 A \addtoindex{range list} entry consists of two relative addresses. The
2276 addresses are the same size as addresses on the target machine.
2277
2278 A base address selection entry and an 
2279 \addtoindexx{end of list entry!in range list}
2280 end of list entry each
2281 \addtoindexx{base address selection entry!in range list}
2282 consist of two (constant or relocated) addresses. The two
2283 addresses are the same size as addresses on the target machine.
2284
2285 For a \addtoindex{range list} to be specified, the base address of the
2286 \addtoindexx{base address selection entry!in range list}
2287 corresponding compilation unit must be defined 
2288 (see Section \refersec{chap:normalandpartialcompilationunitentries}).
2289
2290
2291 \section{Dependencies and Constraints}
2292 \label{datarep:dependenciesandconstraints}
2293
2294 The debugging information in this format is intended to
2295 exist 
2296 \addtoindexx{DWARF section names!list of}
2297 in 
2298 the \addtoindex{.debug\_abbrev}, 
2299 \addtoindex{.debug\_aranges}, 
2300 \addtoindex{.debug\_frame},
2301 \addtoindex{.debug\_info}, 
2302 \addtoindex{.debug\_line}, 
2303 \addtoindex{.debug\_loc}, 
2304 \addtoindex{.debug\_macinfo},
2305 \addtoindex{.debug\_pubnames}, 
2306 \addtoindex{.debug\_pubtypes}, 
2307 \addtoindex{.debug\_ranges}, 
2308 \addtoindex{.debug\_str}
2309 and 
2310 \addtoindex{.debug\_types}
2311 sections of an object file, or equivalent
2312 separate file or database. The information is not 
2313 word\dash aligned. Consequently:
2314
2315 \begin{itemize}
2316 \item For the 32\dash bit DWARF format and a target architecture with
2317 32\dash bit addresses, an assembler or compiler must provide a way
2318 to produce 2\dash byte and 4\dash byte quantities without alignment
2319 restrictions, and the linker must be able to relocate a
2320 4\dash byte address or 
2321 \addtoindexx{section offset!alignment of}
2322 section offset that occurs at an arbitrary
2323 alignment.
2324
2325 \item For the 32\dash bit DWARF format and a target architecture with
2326 64\dash bit addresses, an assembler or compiler must provide a
2327 way to produce 2\dash byte, 4\dash byte and 8\dash byte quantities without
2328 alignment restrictions, and the linker must be able to relocate
2329 an 8\dash byte address or 4\dash byte 
2330 \addtoindexx{section offset!alignment of}
2331 section offset that occurs at an
2332 arbitrary alignment.
2333
2334 \item For the 64\dash bit DWARF format and a target architecture with
2335 32\dash bit addresses, an assembler or compiler must provide a
2336 way to produce 2\dash byte, 4\dash byte and 8\dash byte quantities without
2337 alignment restrictions, and the linker must be able to relocate
2338 a 4\dash byte address or 8\dash byte 
2339 \addtoindexx{section offset!alignment of}
2340 section offset that occurs at an
2341 arbitrary alignment.
2342
2343 \textit{It is expected that this will be required only for very large
2344 32\dash bit programs or by those architectures which support
2345 a mix of 32\dash bit and 64\dash bit code and data within the same
2346 executable object.}
2347
2348 \item For the 64\dash bit DWARF format and a target architecture with
2349 64\dash bit addresses, an assembler or compiler must provide a
2350 way to produce 2\dash byte, 4\dash byte and 8\dash byte quantities without
2351 alignment restrictions, and the linker must be able to
2352 relocate an 8\dash byte address or 
2353 \addtoindexx{section offset!alignment of}
2354 section offset that occurs at
2355 an arbitrary alignment.
2356 \end{itemize}
2357
2358 \section{Integer Representation Names}
2359 \label{datarep:integerrepresentationnames}
2360
2361 The sizes of the integers used in the lookup by name, lookup
2362 by address, line number and call frame information sections
2363 are given in
2364 Table 41 \refersec{tab:integerrepresentationnames}.
2365
2366 \begin{centering}
2367 \setlength{\extrarowheight}{0.1cm}
2368 \begin{longtable}{c|l}
2369   \caption{Integer Representation Names} \label{tab:integerrepresentationnames}\\
2370   \hline \bfseries Representation Name&\bfseries Representation \\ \hline
2371 \endfirsthead
2372   \bfseries Representation Name&\bfseries Representation\\ \hline
2373 \endhead
2374   \hline \emph{Continued on next page}
2375 \endfoot
2376   \hline
2377 \endlastfoot
2378
2379 \addtoindex{sbyte}&  signed, 1\dash byte integer \\
2380 \addtoindex{ubyte}&unsigned, 1\dash byte integer \\
2381 \addtoindex{uhalf}&unsigned, 2\dash byte integer \\
2382 \addtoindex{uword}&unsigned, 4\dash byte integer \\
2383
2384 \end{longtable}
2385 \end{centering}
2386
2387 \needlines{6}
2388 \section{Type Signature Computation}
2389 \label{datarep:typesignaturecomputation}
2390
2391 A type signature is computed only by the DWARF producer;
2392 \addtoindexx{type signature computation}
2393 it is used by a DWARF consumer to resolve type references to
2394 the type definitions that are contained in 
2395 \addtoindexx{type unit}
2396 type units.
2397
2398 The type signature for a type T0 is formed from the 
2399 \addtoindex{MD5 hash}
2400 of a flattened description of the type. The flattened
2401 description of the type is a byte sequence derived from the
2402 DWARF encoding of the type as follows:
2403 \begin{enumerate}[1. ]
2404
2405 \item Start with an empty sequence S and a list V of visited
2406 types, where V is initialized to a list containing the type
2407 T0 as its single element. Elements in V are indexed from 1,
2408 so that V[1] is T0.
2409
2410 \item If the debugging information entry represents a type that
2411 is nested inside another type or a namespace, append to S
2412 the type\textquoteright s context as follows: For each surrounding type
2413 or namespace, beginning with the outermost such construct,
2414 append the letter 'C', the DWARF tag of the construct, and
2415 the name (taken from 
2416 \addtoindexx{name attribute}
2417 the \livelink{chap:DWATname}{DW\_AT\_name} attribute) of the type
2418 \addtoindexx{name attribute}
2419 or namespace (including its trailing null byte).
2420
2421 \item  Append to S the letter 'D', followed by the DWARF tag of
2422 the debugging information entry.
2423
2424 \item For each of the attributes in
2425 Table \refersec{tab:attributesusedintypesignaturecomputation}
2426 that are present in
2427 the debugging information entry, in the order listed,
2428 append to S a marker letter (see below), the DWARF attribute
2429 code, and the attribute value.
2430
2431 \begin{table}[ht]
2432 \caption{Attributes used in type signature computation}
2433 \label{tab:attributesusedintypesignaturecomputation}
2434 \simplerule[\textwidth]
2435 \begin{center}
2436 \autocols[0pt]{c}{2}{l}{
2437 \livelink{chap:DWATname}{DW\_AT\_name},
2438 \livelink{chap:DWATaccessibility}{DW\_AT\_accessibility},
2439 \livelink{chap:DWATaddressclass}{DW\_AT\_address\_class},
2440 \livelink{chap:DWATallocated}{DW\_AT\_allocated},
2441 \livelink{chap:DWATartificial}{DW\_AT\_artificial},
2442 \livelink{chap:DWATassociated}{DW\_AT\_associated},
2443 \livelink{chap:DWATbinaryscale}{DW\_AT\_binary\_scale},
2444 \livelink{chap:DWATbitoffset}{DW\_AT\_bit\_offset},
2445 \livelink{chap:DWATbitsize}{DW\_AT\_bit\_size},
2446 \livelink{chap:DWATbitstride}{DW\_AT\_bit\_stride},
2447 \livelink{chap:DWATbytesize}{DW\_AT\_byte\_size},
2448 \livelink{chap:DWATbytestride}{DW\_AT\_byte\_stride},
2449 \livelink{chap:DWATconstexpr}{DW\_AT\_const\_expr},
2450 \livelink{chap:DWATconstvalue}{DW\_AT\_const\_value},
2451 \livelink{chap:DWATcontainingtype}{DW\_AT\_containing\_type},
2452 \livelink{chap:DWATcount}{DW\_AT\_count},
2453 \livelink{chap:DWATdatabitoffset}{DW\_AT\_data\_bit\_offset},
2454 \livelink{chap:DWATdatalocation}{DW\_AT\_data\_location},
2455 \livelink{chap:DWATdatamemberlocation}{DW\_AT\_data\_member\_location},
2456 \livelink{chap:DWATdecimalscale}{DW\_AT\_decimal\_scale},
2457 \livelink{chap:DWATdecimalsign}{DW\_AT\_decimal\_sign},
2458 \livelink{chap:DWATdefaultvalue}{DW\_AT\_default\_value},
2459 \livelink{chap:DWATdigitcount}{DW\_AT\_digit\_count},
2460 \livelink{chap:DWATdiscr}{DW\_AT\_discr},
2461 \livelink{chap:DWATdiscrlist}{DW\_AT\_discr\_list},
2462 \livelink{chap:DWATdiscrvalue}{DW\_AT\_discr\_value},
2463 \livelink{chap:DWATencoding}{DW\_AT\_encoding},
2464 \livelink{chap:DWATenumclass}{DW\_AT\_enum\_class},
2465 \livelink{chap:DWATendianity}{DW\_AT\_endianity},
2466 \livelink{chap:DWATexplicit}{DW\_AT\_explicit},
2467 \livelink{chap:DWATisoptional}{DW\_AT\_is\_optional},
2468 \livelink{chap:DWATlocation}{DW\_AT\_location},
2469 \livelink{chap:DWATlowerbound}{DW\_AT\_lower\_bound},
2470 \livelink{chap:DWATmutable}{DW\_AT\_mutable},
2471 \livelink{chap:DWATordering}{DW\_AT\_ordering},
2472 \livelink{chap:DWATpicturestring}{DW\_AT\_picture\_string},
2473 \livelink{chap:DWATprototyped}{DW\_AT\_prototyped},
2474 \livelink{chap:DWATsmall}{DW\_AT\_small},
2475 \livelink{chap:DWATsegment}{DW\_AT\_segment},
2476 \livelink{chap:DWATstringlength}{DW\_AT\_string\_length},
2477 \livelink{chap:DWATthreadsscaled}{DW\_AT\_threads\_scaled},
2478 \livelink{chap:DWATupperbound}{DW\_AT\_upper\_bound},
2479 \livelink{chap:DWATuselocation}{DW\_AT\_use\_location},
2480 \livelink{chap:DWATuseUTF8}{DW\_AT\_use\_UTF8},
2481 \livelink{chap:DWATvariableparameter}{DW\_AT\_variable\_parameter},
2482 \livelink{chap:DWATvirtuality}{DW\_AT\_virtuality},
2483 \livelink{chap:DWATvisibility}{DW\_AT\_visibility},
2484 \livelink{chap:DWATvtableelemlocation}{DW\_AT\_vtable\_elem\_location}
2485 }
2486 \end{center}
2487 \simplerule[\textwidth]
2488 \end{table}
2489
2490 Note that except for the initial 
2491 \livelink{chap:DWATname}{DW\_AT\_name} attribute,
2492 \addtoindexx{name attribute}
2493 attributes are appended in order according to the alphabetical
2494 spelling of their identifier.
2495
2496 If an implementation defines any vendor-specific attributes,
2497 any such attributes that are essential to the definition of
2498 the type should also be included at the end of the above list,
2499 in their own alphabetical suborder.
2500
2501 An attribute that refers to another type entry T is processed
2502 as follows: (a) If T is in the list V at some V[x], use the
2503 letter 'R' as the marker and use the unsigned LEB128 encoding
2504 of x as the attribute value; otherwise, (b) use the letter 'T'
2505 as the marker, process the type T recursively by performing
2506 Steps 2 through 7, and use the result as the attribute value.
2507
2508 Other attribute values use the letter 'A' as the marker, and
2509 the value consists of the form code (encoded as an unsigned
2510 LEB128 value) followed by the encoding of the value according
2511 to the form code. To ensure reproducibility of the signature,
2512 the set of forms used in the signature computation is limited
2513 to the following: \livelink{chap:DWFORMsdata}{DW\_FORM\_sdata}, 
2514 \livelink{chap:DWFORMflag}{DW\_FORM\_flag}, 
2515 \livelink{chap:DWFORMstring}{DW\_FORM\_string},
2516 and \livelink{chap:DWFORMblock}{DW\_FORM\_block}.
2517
2518 \item If the tag in Step 3 is one of \livelink{chap:DWTAGpointertype}{DW\_TAG\_pointer\_type},
2519 \livelink{chap:DWTAGreferencetype}{DW\_TAG\_reference\_type}, 
2520 \livelink{chap:DWTAGrvaluereferencetype}{DW\_TAG\_rvalue\_reference\_type},
2521 \livelink{chap:DWTAGptrtomembertype}{DW\_TAG\_ptr\_to\_member\_type}, 
2522 or \livelink{chap:DWTAGfriend}{DW\_TAG\_friend}, and the referenced
2523 type (via the \livelink{chap:DWATtype}{DW\_AT\_type} or 
2524 \livelink{chap:DWATfriend}{DW\_AT\_friend} attribute) has a
2525 \livelink{chap:DWATname}{DW\_AT\_name} attribute, append to S the letter 'N', the DWARF
2526 attribute code (\livelink{chap:DWATtype}{DW\_AT\_type} or 
2527 \livelink{chap:DWATfriend}{DW\_AT\_friend}), the context of
2528 the type (according to the method in Step 2), the letter 'E',
2529 and the name of the type. For \livelink{chap:DWTAGfriend}{DW\_TAG\_friend}, if the referenced
2530 entry is a \livelink{chap:DWTAGsubprogram}{DW\_TAG\_subprogram}, the context is omitted and the
2531 name to be used is the ABI-specific name of the subprogram
2532 (e.g., the mangled linker name).
2533
2534
2535 \item If the tag in Step 3 is not one of \livelink{chap:DWTAGpointertype}{DW\_TAG\_pointer\_type},
2536 \livelink{chap:DWTAGreferencetype}{DW\_TAG\_reference\_type}, 
2537 \livelink{chap:DWTAGrvaluereferencetype}{DW\_TAG\_rvalue\_reference\_type},
2538 \livelink{chap:DWTAGptrtomembertype}{DW\_TAG\_ptr\_to\_member\_type}, or 
2539 \livelink{chap:DWTAGfriend}{DW\_TAG\_friend}, but has
2540 a \livelink{chap:DWATtype}{DW\_AT\_type} attribute, or if the referenced type (via
2541 the \livelink{chap:DWATtype}{DW\_AT\_type} or 
2542 \livelink{chap:DWATfriend}{DW\_AT\_friend} attribute) does not have a
2543 \livelink{chap:DWATname}{DW\_AT\_name} attribute, the attribute is processed according to
2544 the method in Step 4 for an attribute that refers to another
2545 type entry.
2546
2547
2548 \item Visit each child C of the debugging information
2549 entry as follows: If C is a nested type entry or a member
2550 function entry, and has 
2551 a \livelink{chap:DWATname}{DW\_AT\_name} attribute, append to
2552 \addtoindexx{name attribute}
2553 S the letter 'S', the tag of C, and its name; otherwise,
2554 process C recursively by performing Steps 3 through 7,
2555 appending the result to S. Following the last child (or if
2556 there are no children), append a zero byte.
2557 \end{enumerate}
2558
2559
2560
2561 For the purposes of this algorithm, if a debugging information
2562 entry S has a 
2563 \livelink{chap:DWATspecification}{DW\_AT\_specification} 
2564 attribute that refers to
2565 another entry D (which has a 
2566 \livelink{chap:DWATdeclaration}{DW\_AT\_declaration} 
2567 attribute),
2568 then S inherits the attributes and children of D, and S is
2569 processed as if those attributes and children were present in
2570 the entry S. Exception: if a particular attribute is found in
2571 both S and D, the attribute in S is used and the corresponding
2572 one in D is ignored.
2573
2574 DWARF tag and attribute codes are appended to the sequence
2575 as unsigned LEB128 values, using the values defined earlier
2576 in this chapter.
2577
2578 \textit{A grammar describing this computation may be found in
2579 Appendix \refersec{app:typesignaturecomputationgrammar}.
2580 }
2581
2582 \textit{An attribute that refers to another type entry should
2583 be recursively processed or replaced with the name of the
2584 referent (in Step 4, 5 or 6). If neither treatment applies to
2585 an attribute that references another type entry, the entry
2586 that contains that attribute should not be considered for a
2587 separate \addtoindex{type unit}.}
2588
2589 \textit{If a debugging information entry contains an attribute from
2590 the list above that would require an unsupported form, that
2591 entry should not be considered for a separate 
2592 \addtoindex{type unit}.}
2593
2594 \textit{A type should be considered for a separate 
2595 \addtoindex{type unit} only
2596 if all of the type entries that it contains or refers to in
2597 Steps 6 and 7 can themselves each be considered for a separate
2598 \addtoindex{type unit}.}
2599
2600 \needlines{4}
2601 Where the DWARF producer may reasonably choose two or more
2602 different forms for a given attribute, it should choose
2603 the simplest possible form in computing the signature. (For
2604 example, a constant value should be preferred to a location
2605 expression when possible.)
2606
2607 Once the string S has been formed from the DWARF encoding,
2608 an \addtoindex{MD5 hash} is computed for the string and the lower 64 bits
2609 are taken as the type signature.
2610
2611 \textit{The string S is intended to be a flattened representation of
2612 the type that uniquely identifies that type (i.e., a different
2613 type is highly unlikely to produce the same string).}
2614
2615 \textit{A debugging information entry should not be placed in a
2616 separate \addtoindex{type unit}
2617 if any of the following apply:}
2618
2619 \begin{itemize}
2620
2621 \item \textit{The entry has an attribute whose value is a location
2622 expression, and the location expression contains a reference to
2623 another debugging information entry (e.g., a \livelink{chap:DWOPcallref}{DW\_OP\_call\_ref}
2624 operator), as it is unlikely that the entry will remain
2625 identical across compilation units.}
2626
2627 \item \textit{The entry has an attribute whose value refers
2628 to a code location or a \addtoindex{location list}.}
2629
2630 \item \textit{The entry has an attribute whose value refers
2631 to another debugging information entry that does not represent
2632 a type.}
2633 \end{itemize}
2634
2635
2636 \needlines{4}
2637 \textit{Certain attributes are not included in the type signature:}
2638
2639 \begin{itemize}
2640 \item \textit{The \livelink{chap:DWATdeclaration}{DW\_AT\_declaration} attribute is not included because it
2641 indicates that the debugging information entry represents an
2642 incomplete declaration, and incomplete declarations should
2643 not be placed in 
2644 \addtoindexx{type unit}
2645 separate type units.}
2646
2647 \item \textit{The \livelink{chap:DWATdescription}{DW\_AT\_description} attribute is not included because
2648 it does not provide any information unique to the defining
2649 declaration of the type.}
2650
2651 \item \textit{The \livelink{chap:DWATdeclfile}{DW\_AT\_decl\_file}, 
2652 \livelink{chap:DWATdeclline}{DW\_AT\_decl\_line}, and
2653 \livelink{chap:DWATdeclcolumn}{DW\_AT\_decl\_column} attributes are not included because they
2654 may vary from one source file to the next, and would prevent
2655 two otherwise identical type declarations from producing the
2656 \addtoindexx{MD5 hash}
2657 same hash.}
2658
2659 \item \textit{The \livelink{chap:DWATobjectpointer}{DW\_AT\_object\_pointer} attribute is not included 
2660 because the information it provides is not necessary for the 
2661 computation of a unique type signature.}
2662
2663 \end{itemize}
2664
2665 \textit{Nested types and some types referred to by a debugging 
2666 information entry are encoded by name rather than by recursively 
2667 encoding the type to allow for cases where a complete definition 
2668 of the type might not be available in all compilation units.}
2669
2670 \textit{If a type definition contains the definition of a member function, 
2671 it cannot be moved as is into a type unit, because the member function 
2672 contains attributes that are unique to that compilation unit. 
2673 Such a type definition can be moved to a type unit by rewriting the DIE tree, 
2674 moving the member function declaration into a separate declaration tree, 
2675 and replacing the function definition in the type with a non-defining 
2676 declaration of the function (as if the function had been defined out of 
2677 line).}
2678
2679 An example that illustrates the computation of an MD5 hash may be found in 
2680 Appendix \refersec{app:usingtypeunits}.
2681
2682