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