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