Initial commit of a work-in-progress of latex source
[dwarf-doc.git] / dwarf5 / latexdoc / generaldescription.tex
1 \chapter{General Description}
2 \label{chap:generaldescription}
3 \section{The Debugging Entry (DIE)}
4 \label{chap:thedebuggingentrydie}
5 DWARF uses a series of debugging information entries (DIEs) to 
6 define a low\dash{} level
7 representation of a source program. 
8 Each debugging information entry consists of an identifying
9 tag and a series of attributes. 
10 An entry, or group of entries together, provide a description of a
11 corresponding entity in the source program. 
12 The tag specifies the class to which an entry belongs
13 and the attributes define the specific characteristics of the entry.
14
15 The set of tag names is listed in Figure 1. 
16 The debugging information entries they identify are
17 described in Sections 3, 4 and 5.
18
19 The debugging information entry descriptions 
20 in Sections 3, 4 and 5 generally include mention of
21 most, but not necessarily all, of the attributes 
22 that are normally or possibly used with the entry.
23 Some attributes, whose applicability tends to be 
24 pervasive and invariant across many kinds of
25 debugging information entries, are described in 
26 this section and not necessarily mentioned in all
27 contexts where they may be appropriate. 
28 Examples include DW\_AT\_artificial, the declaration
29 coordinates, and DW\_AT\_description, among others.
30
31 The debugging information entries are contained 
32 in the .debug\_info and .debug\_types
33 sections of an object file.
34
35
36
37 \section{Attribute Types}
38 \label{chap:attributetypes}
39 Each attribute value is characterized by an attribute name. 
40 No more than one attribute with a given name may appear in any
41 debugging information entry. 
42 There are no limitations on the
43 ordering of attributes within a debugging information entry.
44
45 The attributes are listed in Figure 2.  
46
47 The permissible values
48 for an attribute belong to one or more classes of attribute
49 value forms.  
50 Each form class may be represented in one or more ways. 
51 For example, some attribute values consist
52 of a single piece of constant data. 
53 ``Constant data''
54 is the class of attribute value that those attributes may have. 
55 There are several representations of constant data,
56 however (one, two, ,four, or eight bytes, and variable length
57 data). 
58 The particular representation for any given instance
59 of an attribute is encoded along with the attribute name as
60 part of the information that guides the interpretation of a
61 debugging information entry.  
62
63 Attribute value forms belong
64 to one of the classes shown in Figure \refersec{tab:classesofattributevalue}.
65
66 % These each need to link to definition page: FIXME
67 \begin{figure}[here]
68 \autorows[0pt]{c}{2}{l}{
69 \addtoindex{DW\_TAG\_access\_declaration},
70 \addtoindex{DW\_TAG\_array\_type},
71 \addtoindex{DW\_TAG\_base\_type},
72 \addtoindex{DW\_TAG\_catch\_block},
73 \addtoindex{DW\_TAG\_class\_type},
74 \addtoindex{DW\_TAG\_common\_block},
75 \addtoindex{DW\_TAG\_common\_inclusion},
76 \addtoindex{DW\_TAG\_compile\_unit},
77 \addtoindex{DW\_TAG\_condition},
78 \addtoindex{DW\_TAG\_const\_type},
79 \addtoindex{DW\_TAG\_constant},
80 \addtoindex{DW\_TAG\_dwarf\_procedure},
81 \addtoindex{DW\_TAG\_entry\_point},
82 \addtoindex{DW\_TAG\_enumeration\_type},
83 \addtoindex{DW\_TAG\_enumerator},
84 \addtoindex{DW\_TAG\_file\_type},
85 \addtoindex{DW\_TAG\_formal\_parameter},
86 \addtoindex{DW\_TAG\_friend},
87 \addtoindex{DW\_TAG\_imported\_declaration},
88 \addtoindex{DW\_TAG\_imported\_module},
89 \addtoindex{DW\_TAG\_imported\_unit},
90 \addtoindex{DW\_TAG\_inheritance},
91 \addtoindex{DW\_TAG\_inlined\_subroutine},
92 \addtoindex{DW\_TAG\_interface\_type},
93 \addtoindex{DW\_TAG\_label},
94 \addtoindex{DW\_TAG\_lexical\_block},
95 \addtoindex{DW\_TAG\_module},
96 \addtoindex{DW\_TAG\_member},
97 \addtoindex{DW\_TAG\_namelist},
98 \addtoindex{DW\_TAG\_namelist\_item},
99 \addtoindex{DW\_TAG\_namespace},
100 \addtoindex{DW\_TAG\_packed\_type},
101 \addtoindex{DW\_TAG\_partial\_unit},
102 \addtoindex{DW\_TAG\_pointer\_type},
103 \addtoindex{DW\_TAG\_ptr\_to\_member\_type},
104 \addtoindex{DW\_TAG\_reference\_type},
105 \addtoindex{DW\_TAG\_restrict\_type},
106 \addtoindex{DW\_TAG\_rvalue\_reference\_type},
107 \addtoindex{DW\_TAG\_set\_type},
108 \addtoindex{DW\_TAG\_shared\_type},
109 \addtoindex{DW\_TAG\_string\_type},
110 \addtoindex{DW\_TAG\_structure\_type},
111 \addtoindex{DW\_TAG\_subprogram},
112 \addtoindex{DW\_TAG\_subrange\_type},
113 \addtoindex{DW\_TAG\_subroutine\_type},
114 \addtoindex{DW\_TAG\_template\_alias},
115 \addtoindex{DW\_TAG\_template\_type\_parameter},
116 \addtoindex{DW\_TAG\_template\_value\_parameter},
117 \addtoindex{DW\_TAG\_thrown\_type},
118 \addtoindex{DW\_TAG\_try\_block},
119 \addtoindex{DW\_TAG\_typedef},
120 \addtoindex{DW\_TAG\_type\_unit},
121 \addtoindex{DW\_TAG\_union\_type},
122 \addtoindex{DW\_TAG\_unspecified\_parameters},
123 \addtoindex{DW\_TAG\_unspecified\_type},
124 \addtoindex{DW\_TAG\_variable},
125 \addtoindex{DW\_TAG\_variant},
126 \addtoindex{DW\_TAG\_variant\_part},
127 \addtoindex{DW\_TAG\_volatile\_type},
128 \addtoindex{DW\_TAG\_with\_stmt},
129 }
130 \caption{Tag names}\label{fig:tagnames}
131 \end{figure}
132
133 \label{tab:attributenames}
134 \setlength{\extrarowheight}{0.1cm}
135 \begin{longtable}{l|p{9cm}}
136   \caption{Attribute names} \\
137   \hline \\ \bfseries Attribute&\bfseries Identifies or Specifies \\ \hline
138 \endfirsthead
139   \bfseries Attribute&\bfseries Identifies or Specifies \\ \hline
140 \endhead
141   \hline \emph{Continued on next page}
142 \endfoot
143   \hline
144 \endlastfoot
145 DW\_AT\_abstract\_origin
146 &Inline instances of inline subprograms \\
147 &Out\dash{} of\dash{} line instances of inline subprograms \\
148 DW\_AT\_accessibility
149 &C++ and Ada declarations \\
150 &C++ base classes \\
151 &C++ inherited members \\
152 DW\_AT\_address\_class
153 &Pointer or reference types \\
154 &Subroutine or subroutine type \\
155 DW\_AT\_allocated
156 &Allocation status of types \\
157 DW\_AT\_artificial
158 &Objects or types that are not
159 actually declared in the source \\
160 DW\_AT\_associated 
161 &Association status of types \\
162 DW\_AT\_base\_types 
163 &Primitive data types of compilation unit \\
164 DW\_AT\_binary\_scale 
165 &Binary scale factor for fixed\dash point type \\
166 DW\_AT\_bit\_offset 
167 &Base type bit location \\
168 &Data member bit location \\
169 DW\_AT\_bit\_size 
170 &Base type bit size \\
171 &Data member bit size \\
172 DW\_AT\_bit\_stride 
173 &Array element stride (of array type) \\
174 &Subrange stride (dimension of array type) \\
175 &Enumeration stride (dimension of array type) \\
176 DW\_AT\_byte\_size 
177 &Data object or data type size \\
178 DW\_AT\_byte\_stride 
179 &Array element stride (of array type) \\
180 &Subrange stride (dimension of array type) \\
181 &Enumeration stride (dimension of array type) \\
182 DW\_AT\_call\_column 
183 &Column position of inlined subroutine call \\
184 DW\_AT\_call\_file
185 &File containing inlined subroutine call \\
186 DW\_AT\_call\_line 
187 &Line number of inlined subroutine call \\
188 DW\_AT\_calling\_convention 
189 &Subprogram calling convention \\
190 &DW\_AT\_common\_reference \\
191 &Common block usage \\
192 DW\_AT\_comp\_dir
193 &Compilation directory \\
194 DW\_AT\_const\_value
195 &Constant object \\
196 DW\_AT\_const\_value
197 &Enumeration literal value \\
198 &Template value parameter \\
199 DW\_AT\_const\_expr
200 &Compile\dash time constant object \\
201 &Compile\dash time constant function \\
202 DW\_AT\_containing\_type
203 &Containing type of pointer to member type \\
204 DW\_AT\_count
205 &Elements of subrange type \\
206 DW\_AT\_data\_bit\_offset
207 &Base type bit location \\
208 &Data member bit location \\
209 DW\_AT\_data\_location 
210 &Indirection to actual data \\
211 DW\_AT\_data\_member\_location
212 &Data member location \\
213 &Inherited member location \\
214 DW\_AT\_decimal\_scale
215 &Decimal scale factor \\
216 DW\_AT\_decimal\_sign
217 &Decimal sign representation \\
218 DW\_AT\_decl\_column
219 &Column position of source declaration \\
220 DW\_AT\_decl\_file
221 &File containing source declaration \\
222 DW\_AT\_decl\_line
223 &Line number of source declaration \\
224 DW\_AT\_declaration
225 &Incomplete, non\dash defining, or separate entity declaration \\
226 DW\_AT\_default\_value
227 &Default value of parameter \\
228 DW\_AT\_description 
229 & Artificial name or description \\
230 DW\_AT\_digit\_count
231 &Digit count for packed decimal or numeric string type\\
232 DW\_AT\_discr
233 &Discriminant of variant part\\
234 DW\_AT\_discr\_list
235 &List of discriminant values\\
236 DW\_AT\_discr\_value
237 &Discriminant value\\
238 DW\_AT\_elemental
239 &Elemental property of a subroutine\\
240 DW\_AT\_encoding
241 &Encoding of base type\\
242 DW\_AT\_endianity
243 &Endianity of data\\
244 DW\_AT\_entry\_pc
245 &Entry address of module initialization\\
246 &Entry address of subprogram\\
247 &Entry address of inlined subprogram\\
248 DW\_AT\_enum\_class
249 &Type safe enumeration definition\\
250 DW\_AT\_explicit
251 &Explicit property of member function\\
252 DW\_AT\_extension
253 &Previous namespace extension or original namespace\\
254 DW\_AT\_external
255 &External subroutine\\
256 &External variable\\
257 DW\_AT\_frame\_base
258 &Subroutine frame base address\\
259 DW\_AT\_friend
260 &Friend relationship\\
261 DW\_AT\_high\_pc
262 &Contiguous range of code addresses\\
263 DW\_AT\_identifier\_case
264 &Identifier case rule \\
265 DW\_AT\_import
266 &Imported declaration \\
267 &Imported unit \\
268 &Namespace alias \\
269 &Namespace using declaration \\
270 &Namespace using directive \\
271 DW\_AT\_inline
272 &Abstract instance\\
273 &Inlined subroutine\\
274 DW\_AT\_is\_optional
275 &Optional parameter\\
276 DW\_AT\_language
277 &Programming language\\
278 DW\_AT\_linkage\_name
279 &Object file linkage name of an entity\\
280 DW\_AT\_location
281 &Data object location\\
282 DW\_AT\_low\_pc
283 &Code address or range of addresses\\
284 DW\_AT\_lower\_bound
285 &Lower bound of subrange\\
286 DW\_AT\_macro\_info
287 &Macro information (\#define, \#undef)\\
288 DW\_AT\_main\_subprogram
289 &Main or starting subprogram\\
290 &Unit containing main or starting subprogram\\
291 DW\_AT\_mutable
292 &Mutable property of member data\\
293 DW\_AT\_name
294 &Name of declaration\\
295 &Path name of compilation source\\
296 DW\_AT\_namelist\_item
297 &Namelist item\\
298 DW\_AT\_object\_pointer
299 &Object (this, self) pointer of member function\\
300 DW\_AT\_ordering
301 &Array row/column ordering\\
302 DW\_AT\_picture\_string
303 &Picture string for numeric string type\\
304 DW\_AT\_priority
305 &Module priority\\
306 DW\_AT\_producer
307 &Compiler identification\\
308 DW\_AT\_prototyped
309 &Subroutine prototype\\
310 DW\_AT\_pure
311 &Pure property of a subroutine\\
312 DW\_AT\_ranges
313 &Non\dash contiguous range of code addresses\\
314 DW\_AT\_recursive
315 &Recursive property of a subroutine\\
316 DW\_AT\_return\_addr
317 &Subroutine return address save location\\
318 DW\_AT\_segment
319 &Addressing information\\
320 DW\_AT\_sibling
321 &Debugging information entry relationship\\
322 DW\_AT\_small
323 &Scale factor for fixed\dash point type\\
324 DW\_AT\_signature
325 &Type signature\\
326 DW\_AT\_specification
327 &Incomplete, non\dash defining, or separate declaration
328 corresponding to a declaration\\
329 DW\_AT\_start\_scope
330 &Object declaration\\
331 &Type declaration\\
332 DW\_AT\_static\_link
333 &Location of uplevel frame\\
334 DW\_AT\_stmt\_list
335 &Line number information for unit\\
336 DW\_AT\_string\_length
337 &String length of string type\\
338 DW\_AT\_threads\_scaled
339 &UPC array bound THREADS scale factor\\
340 DW\_AT\_trampoline
341 &Target subroutine\\
342 DW\_AT\_type
343 &Type of declaration\\
344 &Type of subroutine return\\
345 DW\_AT\_upper\_bound
346 &Upper bound of subrange\\
347 DW\_AT\_use\_location
348 &Member location for pointer to member type\\
349 DW\_AT\_use\_UTF8
350 &Compilation unit uses UTF\dash 8 strings \\
351 DW\_AT\_variable\_parameter
352 &Non\dash constant parameter flag \\
353 DW\_AT\_virtuality
354 &Virtuality indication \\
355 &Virtuality of base class \\
356 &Virtuality of function \\
357 DW\_AT\_visibility
358 &Visibility of declaration\\
359 DW\_AT\_vtable\_elem\_location
360 &Virtual function vtable slot\\
361 \end{longtable}
362
363 \begin{figure}[here]
364 \centering
365 % Attribute Class entries need a ref to definition point.
366 \setlength{\extrarowheight}{0.1cm}
367 \label{tab:classesofattributevalue}
368 \begin{tabular}{l|p{10cm}} \hline
369 Attribute Class & General Use and Encoding \\ \hline
370 \index{address class}address&Refers to some location in the address space of the described program.
371  \\ 
372 \index{block class}block& An arbitrary number of uninterpreted bytes of data.
373  \\
374 \index{constant class}constant&
375 One, two, four or eight bytes of uninterpreted data, or data
376 encoded in the variable length format known as LEB128 (see
377 Section 7.6.).
378
379 \textit{Most constant values are integers of one kind or
380 another (codes, offsets, counts, and so on); these are
381 sometimes called ``integer constants'' for emphasis.} \\
382
383 \index{exprloc class}exprloc\label{chap:exprloc}&A DWARF expression or location description.
384 \\
385 \index{flag class}flag&A small constant that indicates the presence or absence of an attribute.
386 \\
387 \index{lineptr class}lineptr& Refers to a location in the DWARF section that holds line number information.
388 \\
389 \index{loclistptr class}loclistptr&Refers to a location in the DWARF section that holds location lists, which
390 describe objects whose location can change during their lifetime.
391 \\
392 \index{macptr class}macptr
393 & Refers to a location in the DWARF section that holds macro definition
394  information.  \\
395
396 \index{rangelistptr class}rangelistptr
397 & Refers to a location in the DWARF section that holds non\dash contiguous address ranges.  \\
398
399 \index{reference class}reference& Refers to one of the debugging information
400 entries that describe the program.  There are three types of
401 reference. The first is an offset relative to the beginning
402 of the compilation unit in which the reference occurs and must
403 refer to an entry within that same compilation unit. The second
404 type of reference is the offset of a debugging information
405 entry in any compilation unit, including one different from
406 the unit containing the reference. The third type of reference
407 is an indirect reference to a type definition using a 64\dash
408 bit signature for that type.  \\
409
410 \index{string class}string&A null\dash terminated sequence of zero or more
411 (non\dash null) bytes. Data in this class are generally
412 printable strings. Strings may be represented directly in
413 the debugging information entry or as an offset in a separate
414 string table.  
415 \end{tabular}
416 \caption{Classes of Attribute value}
417 \end{figure}
418 % It is difficult to get the above table to appear before
419 % the end of the chapter without a clearpage here.
420 \clearpage
421 \section{Relationship of Debugging Information Entries}
422 \label{chap:relationshipofdebugginginformationentries}
423 \textit{
424 A variety of needs can be met by permitting a single
425 debugging information entry to “own” an arbitrary number
426 of other debugging entries and by permitting the same debugging
427 information entry to be one of many owned by another debugging
428 information entry. 
429 This makes it possible, for example, to
430 describe the static block structure within a source file,
431 to show the members of a structure, union, or class, and to
432 associate declarations with source files or source files
433 with shared objects.  
434 }
435
436
437 The ownership relation of debugging
438 information entries is achieved naturally because the debugging
439 information is represented as a tree. 
440 The nodes of the tree
441 are the debugging information entries themselves. 
442 The child
443 entries of any node are exactly those debugging information
444 entries owned by that node.  
445
446 \textit{
447 While the ownership relation
448 of the debugging information entries is represented as a
449 tree, other relations among the entries exist, for example,
450 a reference from an entry representing a variable to another
451 entry representing the type of that variable. 
452 If all such
453 relations are taken into account, the debugging entries
454 form a graph, not a tree.  
455 }
456
457 The tree itself is represented
458 by flattening it in prefix order. 
459 Each debugging information
460 entry is defined either to have child entries or not to have
461 child entries (see Section 7.5.3). 
462 If an entry is defined not
463 to have children, the next physically succeeding entry is a
464 sibling. 
465 If an entry is defined to have children, the next
466 physically succeeding entry is its first child. 
467 Additional
468 children are represented as siblings of the first child. 
469 A chain of sibling entries is terminated by a null entry.
470
471 In cases where a producer of debugging information feels that
472 it will be important for consumers of that information to
473 quickly scan chains of sibling entries, while ignoring the
474 children of individual siblings, that producer may attach a
475 DW\_AT\_sibling attribute to any debugging information entry. 
476 The
477 value of this attribute is a reference to the sibling entry
478 of the entry to which the attribute is attached.
479
480
481 \section{Target Addresses}
482 \label{chap:targetaddresses}
483 Many places in this document refer to the size of an address
484 on the target architecture (or equivalently, target machine)
485 to which a DWARF description applies. For processors which
486 can be configured to have different address sizes or different
487 instruction sets, the intent is to refer to the configuration
488 which is either the default for that processor or which is
489 specified by the object file or executable file which contains
490 the DWARF information.
491
492
493
494 \textit{
495 For example, if a particular target architecture supports
496 both 32\dash bit and 64\dash bit addresses, the compiler will generate
497 an object file which specifies that it contains executable
498 code generated for one or the other of these address sizes. In
499 that case, the DWARF debugging information contained in this
500 object file will use the same address size.
501 }
502
503 \textit{
504 Architectures which have multiple instruction sets are
505 supported by the isa entry in the line number information
506 (see Section \refersec{chap:statemachineregisters}).
507 }
508
509
510 \section{DWARF Expressions}
511 \label{chap:dwarfexpressions}
512 DWARF expressions describe how to compute a value or name a
513 location during debugging of a program. 
514 They are expressed in
515 terms of DWARF operations that operate on a stack of values.
516
517 All DWARF operations are encoded as a stream of opcodes that
518 are each followed by zero or more literal operands. 
519 The number
520 of operands is determined by the opcode.  
521
522 In addition to the
523 general operations that are defined here, operations that are
524 specific to location descriptions are defined in 
525 Section \refersec{chap:locationdescriptions} .
526
527 \subsection{General Operations}
528 \label{chap:generaloperations}
529 Each general operation represents a postfix operation on
530 a simple stack machine. Each element of the stack is the
531 size of an address on the target machine. The value on the
532 top of the stack after ``executing'' the DWARF expression
533 is taken to be the result (the address of the object, the
534 value of the array bound, the length of a dynamic string,
535 the desired value itself, and so on).
536
537 \subsubsection{Literal Encodings}
538 \label{chap:literalencodings}
539 The following operations all push a value onto the DWARF
540 stack. If the value of a constant in one of these operations
541 is larger than can be stored in a single stack element, the
542 value is truncated to the element size and the low\dash order bits
543 are pushed on the stack.
544
545 \begin{enumerate}[1]
546 \item DW\_OP\_lit0, DW\_OP\_lit1, \dots, DW\_OP\_lit31 \\
547 The DW\_OP\_litn operations encode the unsigned literal values
548 from 0 through 31, inclusive.
549
550 \item DW\_OP\_addr \\
551 The DW\_OP\_addr operation has a single operand that encodes
552 a machine address and whose size is the size of an address
553 on the target machine.
554
555 \item DW\_OP\_const1u, DW\_OP\_const2u, DW\_OP\_const4u, DW\_OP\_const8u \\
556 The single operand of a DW\_OP\_constnu operation provides a 1,
557 2, 4, or 8\dash byte unsigned integer constant, respectively.
558
559 \item DW\_OP\_const1s , DW\_OP\_const2s, DW\_OP\_const4s, DW\_OP\_const8s \\
560 The single operand of a DW\_OP\_constns operation provides a 1,
561 2, 4, or 8\dash byte signed integer constant, respectively.
562
563 \item DW\_OP\_constu \\
564 The single operand of the DW\_OP\_constu operation provides
565 an unsigned LEB128 integer constant.
566
567 \item DW\_OP\_consts \\
568 The single operand of the DW\_OP\_consts operation provides
569 a signed LEB128 integer constant.
570
571 \end{enumerate}
572
573
574 \subsubsection{Register Based Addressing}
575 \label{chap:registerbasedaddressing}
576 The following operations push a value onto the stack that is
577 the result of adding the contents of a register to a given
578 signed offset.
579
580 \begin{enumerate}[1]
581
582 \item DW\_OP\_fbreg \\
583 The DW\_OP\_fbreg operation provides a signed LEB128 offset
584 from the address specified by the location description in the
585 DW\_AT\_frame\_base attribute of the current function. (This
586 is typically a “stack pointer” register plus or minus
587 some offset. On more sophisticated systems it might be a
588 location list that adjusts the offset according to changes
589 in the stack pointer as the PC changes.)
590
591 \item DW\_OP\_breg0, DW\_OP\_breg1, \dots, DW\_OP\_breg31\\
592 The single operand of the DW\_OP\_bregn operations provides
593 a signed LEB128 offset from
594 the specified register.
595
596 \item DW\_OP\_bregx \\
597 The DW\_OP\_bregx operation has two operands: a register
598 which is specified by an unsigned LEB128 number, followed by
599 a signed LEB128 offset.
600
601 \end{enumerate}
602
603
604 \subsubsection{Stack Operations}
605 \label{chap:stackoperations}
606 The following operations manipulate the DWARF stack. Operations
607 that index the stack assume that the top of the stack (most
608 recently added entry) has index 0.
609
610 \begin{enumerate}[1]
611 \label{chap:DWOPdup}
612 \item DW\_OP\_dup \\
613 The DW\_OP\_dup operation duplicates the value at the top of the stack.
614
615 \label{chap:DWOPdrop}
616 \item DW\_OP\_drop \\
617 The DW\_OP\_drop operation pops the value at the top of the stack.
618
619 \label{chap:DWOPpick}
620 \item DW\_OP\_pick \\
621 The single operand of the DW\_OP\_pick operation provides a
622 1\dash byte index. A copy of the stack entry with the specified
623 index (0 through 255, inclusive) is pushed onto the stack.
624
625 \label{chap:DWOPover}
626 \item DW\_OP\_over \\
627 The DW\_OP\_over operation duplicates the entry currently second
628 in the stack at the top of the stack. 
629 This is equivalent to
630 a DW\_OP\_pick operation, with index 1.  
631
632 \label{chap:DWOPswap}
633 \item DW\_OP\_swap \\
634 The DW\_OP\_swap operation swaps the top two stack entries. 
635 The entry at the top of the
636 stack becomes the second stack entry, 
637 and the second entry becomes the top of the stack.
638
639 \label{chap:DWOProt}
640 \item DW\_OP\_rot \\
641 The DW\_OP\_rot operation rotates the first three stack
642 entries. The entry at the top of the stack becomes the third
643 stack entry, the second entry becomes the top of the stack,
644 and the third entry becomes the second entry.
645
646 \label{chap:DWOPderef}
647 \item  DW\_OP\_deref \\
648 The DW\_OP\_deref operation pops the top stack entry and 
649 treats it as an address. The value
650 retrieved from that address is pushed. 
651 The size of the data retrieved from the dereferenced
652 address is the size of an address on the target machine.
653
654 \label{chap:DWOPderefsize}
655 \item DW\_OP\_deref\_size \\
656 The DW\_OP\_deref\_size operation behaves like the DW\_OP\_deref
657 operation: it pops the top stack entry and treats it as an
658 address. The value retrieved from that address is pushed. In
659 the DW\_OP\_deref\_size operation, however, the size in bytes
660 of the data retrieved from the dereferenced address is
661 specified by the single operand. This operand is a 1\dash byte
662 unsigned integral constant whose value may not be larger
663 than the size of an address on the target machine. The data
664 retrieved is zero extended to the size of an address on the
665 target machine before being pushed onto the expression stack.
666
667 \label{chap:DWOPxderef}
668 \item DW\_OP\_xderef \\
669 The DW\_OP\_xderef operation provides an extended dereference
670 mechanism. The entry at the top of the stack is treated as an
671 address. The second stack entry is treated as an “address
672 space identifier” for those architectures that support
673 multiple address spaces. The top two stack elements are popped,
674 and a data item is retrieved through an implementation\dash defined
675 address calculation and pushed as the new stack top. The size
676 of the data retrieved from the dereferenced address is the
677 size of an address on the target machine.
678
679 \label{chap:DWOPxderefsize}
680 \item  DW\_OP\_xderef\_size \\
681 The DW\_OP\_xderef\_size operation behaves like the
682 DW\_OP\_xderef operation.The entry at the top of the stack is
683 treated as an address. The second stack entry is treated as
684 an “address space identifier” for those architectures
685 that support multiple address spaces. The top two stack
686 elements are popped, and a data item is retrieved through an
687 implementation\dash defined address calculation and pushed as the
688 new stack top. In the DW\_OP\_xderef\_size operation, however,
689 the size in bytes of the data retrieved from the dereferenced
690 address is specified by the single operand. This operand is a
691 1\dash byte unsigned integral constant whose value may not be larger
692 than the size of an address on the target machine. The data
693 retrieved is zero extended to the size of an address on the
694 target machine before being pushed onto the expression stack.
695
696 \label{chap:DWOPpushobjectaddress}
697 \item DW\_OP\_push\_object\_address \\
698 The DW\_OP\_push\_object\_address operation pushes the address
699 of the object currently being evaluated as part of evaluation
700 of a user presented expression. This object may correspond
701 to an independent variable described by its own debugging
702 information entry or it may be a component of an array,
703 structure, or class whose address has been dynamically
704 determined by an earlier step during user expression
705 evaluation.  This operator provides explicit functionality
706 (especially for arrays involving descriptors) that is analogous
707 to the implicit push of the base address of a structure prior
708 to evaluation of a DW\_AT\_data\_member\_location to access a
709 data member of a structure. For an example, see 
710 Appendix \refersec{app:aggregateexamples}.
711
712 \label{chap:DWOPformtlsaddress}
713 \item DW\_OP\_form\_tls\_address \\
714 The DW\_OP\_form\_tls\_address operation pops a value from the
715 stack, translates it into an address in the current thread's
716 thread\dash local storage block, and pushes the address. If the
717 DWARF expression containing the DW\_OP\_form\_tls\_address
718 operation belongs to the main executable's DWARF info, the
719 operation uses the main executable's thread\dash local storage
720 block; if the expression belongs to a shared library's
721 DWARF info, then it uses that shared library's thread\dash local
722 storage block.  Some implementations of C and C++ support a
723 \_\_thread storage class. Variables with this storage class
724 have distinct values and addresses in distinct threads, much
725 as automatic variables have distinct values and addresses in
726 each function invocation. Typically, there is a single block
727 of storage containing all \_\_thread variables declared in
728 the main executable, and a separate block for the variables
729 declared in each shared library. Computing the address of
730 the appropriate block can be complex (in some cases, the
731 compiler emits a function call to do it), and difficult
732 to describe using ordinary DWARF location descriptions.
733 DW\_OP\_form\_tls\_address leaves the computation to the
734 consumer.
735
736 \label{chap:DWOPcallframecfa}
737 \item DW\_OP\_call\_frame\_cfa \\
738 The DW\_OP\_call\_frame\_cfa operation pushes the value of the
739 CFA, obtained from the Call Frame Information 
740 (see Section \refersec{chap:callframeinformation}).
741 Although the value of DW\_AT\_frame\_base
742 can be computed using other DWARF expression operators,
743 in some cases this would require an extensive location list
744 because the values of the registers used in computing the
745 CFA change during a subroutine. If the 
746 Call Frame Information 
747 is present, then it already encodes such changes, and it is
748 space efficient to reference that.
749 \end{enumerate}
750
751 \subsubsection{Arithmetic and Logical Operations}
752 The following provide arithmetic and logical operations. Except
753 as otherwise specified, the arithmetic operations perfom
754 addressing arithmetic, that is, unsigned arithmetic that is
755 performed modulo one plus the largest representable address
756 (for example, 0x100000000 when the size of an address is 32
757 bits). Such operations do not cause an exception on overflow.
758
759 \begin{enumerate}[1]
760 \label{chap:DWOPabs}
761 \item DW\_OP\_abs  \\
762 The DW\_OP\_abs operation pops the top stack entry, interprets
763 it as a signed value and pushes its absolute value. If the
764 absolute value cannot be represented, the result is undefined.
765
766 \label{chap:DWOPand}
767 \item DW\_OP\_and \\
768 The DW\_OP\_and operation pops the top two stack values, performs
769 a bitwise and operation on the two, and pushes the result.
770
771 \label{chap:DWOPdiv}
772 \item DW\_OP\_div \\
773 The DW\_OP\_div operation pops the top two stack values, divides the former second entry by
774 the former top of the stack using signed division, and pushes the result.
775
776 \label{chap:DWOPminus}
777 \item DW\_OP\_minus \\
778 The DW\_OP\_minus operation pops the top two stack values, subtracts the former top of the
779 stack from the former second entry, and pushes the result.
780
781 \label{chap:DWOPmod}
782 \item DW\_OP\_mod \\
783 The DW\_OP\_mod operation pops the top two stack values and pushes the result of the
784 calculation: former second stack entry modulo the former top of the stack.
785
786 \label{chap:DWOPmul}
787 \item DW\_OP\_mul \\
788 The DW\_OP\_mul operation pops the top two stack entries, multiplies them together, and
789 pushes the result.
790
791 \label{chap:DWOPneg}
792 \item  DW\_OP\_neg \\
793 The DW\_OP\_neg operation pops the top stack entry, interprets
794 it as a signed value and pushes its negation. If the negation
795 cannot be represented, the result is undefined.
796
797 \label{chap:DWOPnot}
798 \item  DW\_OP\_not \\
799 The DW\_OP\_not operation pops the top stack entry, and pushes
800 its bitwise complement.
801
802 \label{chap:DWOPor}
803 \item  DW\_OP\_or \\
804 The DW\_OP\_or operation pops the top two stack entries, performs
805 a bitwise or operation on the two, and pushes the result.
806
807 \label{chap:DWOPplus}
808 \item  DW\_OP\_plus \\
809 The DW\_OP\_plus operation pops the top two stack entries,
810 adds them together, and pushes the result.
811
812 \label{chap:DWOPplusuconst}
813 \item  DW\_OP\_plus\_uconst \\
814 The DW\_OP\_plus\_uconst operation pops the top stack entry,
815 adds it to the unsigned LEB128 constant operand and pushes
816 the result.  This operation is supplied specifically to be
817 able to encode more field offsets in two bytes than can be
818 done with “DW\_OP\_litn DW\_OP\_plus”.
819
820 \label{chap:DWOPshl}
821 \item DW\_OP\_shl \\
822 The DW\_OP\_shl operation pops the top two stack entries,
823 shifts the former second entry left (filling with zero bits)
824 by the number of bits specified by the former top of the stack,
825 and pushes the result.
826
827 \label{chap:DWOPshr}
828 \item DW\_OP\_shr \\
829 The DW\_OP\_shr operation pops the top two stack entries,
830 shifts the former second entry right logically (filling with
831 zero bits) by the number of bits specified by the former top
832 of the stack, and pushes the result.
833
834 \label{chap:DWOPshra}
835 \item DW\_OP\_shra \\
836 The DW\_OP\_shra operation pops the top two stack entries,
837 shifts the former second entry right arithmetically (divide
838 the magnitude by 2, keep the same sign for the result) by
839 the number of bits specified by the former top of the stack,
840 and pushes the result.
841
842 \label{chap:DWOPxor}
843 \item DW\_OP\_xor \\
844 The DW\_OP\_xor operation pops the top two stack entries,
845 performs a bitwise exclusive\dash or operation on the two, and
846 pushes the result.
847
848 \end{enumerate}
849
850 \subsubsection{Control Flow Operations}
851 \label{chap:controlflowoperations}
852 The following operations provide simple control of the flow of a DWARF expression.
853 \begin{enumerate}[1]
854 \item  DW\_OP\_le, DW\_OP\_ge, DW\_OP\_eq, DW\_OP\_lt, DW\_OP\_gt, DW\_OP\_ne \\
855 The six relational operators each:
856 \begin{itemize}
857 \item pop the top two stack values,
858
859 \item compare the operands:
860 \textless~former second entry~\textgreater  \textless~relational operator~\textgreater \textless~former top entry~\textgreater
861
862 \item push the constant value 1 onto the stack 
863 if the result of the operation is true or the
864 constant value 0 if the result of the operation is false.
865 \end{itemize}
866
867 Comparisons are performed as signed operations. The six
868 operators are DW\_OP\_le (less than or equal to), DW\_OP\_ge
869 (greater than or equal to), DW\_OP\_eq (equal to), DW\_OP\_lt (less
870 than), DW\_OP\_gt (greater than) and DW\_OP\_ne (not equal to).
871
872 \item DW\_OP\_skip \\
873 DW\_OP\_skip is an unconditional branch. Its single operand
874 is a 2\dash byte signed integer constant. The 2\dash byte constant is
875 the number of bytes of the DWARF expression to skip forward
876 or backward from the current operation, beginning after the
877 2\dash byte constant.
878
879 \item DW\_OP\_bra \\
880 DW\_OP\_bra is a conditional branch. Its single operand is a
881 2\dash byte signed integer constant.  This operation pops the
882 top of stack. If the value popped is not the constant 0,
883 the 2\dash byte constant operand is the number of bytes of the
884 DWARF expression to skip forward or backward from the current
885 operation, beginning after the 2\dash byte constant.
886
887 % The following item does not correctly hyphenate leading
888 % to an overfull hbox and a visible artifact. 
889 % So we use \- to suggest hyphenation in this rare situation.
890 \item DW\_OP\_call2, DW\_OP\_call4, DW\_OP\_call\_ref \\
891 DW\_OP\_call2, DW\_OP\_call4, and DW\_OP\_call\_ref perform
892 subroutine calls during evaluation of a DWARF expression or
893 location description. 
894 For DW\_OP\_call2 and 
895 DW\-\_OP\-\_call4, 
896 the
897 operand is the 2\dash~ or 4\dash byte 
898 unsigned offset, respectively,
899 of a debugging information entry in the current compilation
900 unit. The DW\_OP\_call\_ref operator has a single operand. In the
901 32\dash bit DWARF format, the operand is a 4\dash byte unsigned value;
902 in the 64\dash bit DWARF format, it is an 8\dash byte unsigned value
903 (see Section \refersec{datarep:32bitand64bitdwarfformats}). 
904 The operand is used as the offset of a
905 debugging information entry in a .debug\_info or .debug\_types
906 section which may be contained in a shared object or executable
907 other than that containing the operator. For references from
908 one shared object or executable to another, the relocation
909 must be performed by the consumer.  
910
911 \textit{Operand interpretation of
912 DW\_OP\_call2, DW\_OP\_call4 and DW\_OP\_call\_ref is exactly like
913 that for DW\_FORM\_ref2, DW\_FORM\_ref4 and DW\_FORM\_ref\_addr,
914 respectively  
915 (see Section  \refersec{datarep:attributeencodings}).  
916 }
917
918 These operations transfer
919 control of DWARF expression evaluation to the 
920 DW\-\_AT\-\_location
921 attribute of the referenced debugging information entry. If
922 there is no such attribute, then there is no effect. Execution
923 of the DWARF expression of a DW\-\_AT\-\_location attribute may add
924 to and/or remove from values on the stack. Execution returns
925 to the point following the call when the end of the attribute
926 is reached. Values on the stack at the time of the call may be
927 used as parameters by the called expression and values left on
928 the stack by the called expression may be used as return values
929 by prior agreement between the calling and called expressions.
930 \end{enumerate}
931
932
933 \subsubsection{Special Operations}
934 There is one special operation currently defined:
935 \begin{enumerate}[1]
936 \item DW\_OP\_nop \\
937 The DW\_OP\_nop operation is a place holder. It has no effect
938 on the location stack or any of its values.
939
940 \end{enumerate}
941 \subsection{Example Stack Operations}
942 \textit {The stack operations defined in 
943 Section \refersec{chap:stackoperations}.
944 are fairly conventional, but the following
945 examples illustrate their behavior graphically.
946 }
947
948 \begin{tabular}{rrcrr} 
949  &Before & Operation&& After \\
950
951 0& 17& \livelink{DW\_OP\_dup}{chap:DWOPdup} &0 &17 \\
952 1&   29& &  1 & 17 \\
953 2& 1000 & & 2 & 29\\
954 & & &         3&1000\\
955 & & & & \\
956 0 & 17 & \livelink{DW\_OP\_drop}{chap:DWOPdrop} & 0 & 29 \\
957 1 &29  &            & 1 & 1000 \\
958 2 &1000& & &          \\
959
960 & & & & \\
961 0 & 17 & \livelink{DW\_OP\_pick}{chap:DWOPpick} & 0 & 1000 \\
962 1 & 29 & & 1&17 \\
963 2 &1000& &2&29 \\
964   &    & &3&1000 \\
965
966 & & & & \\
967 0&17& \livelink{DW\_OP\_over}{chap:DWOPover}&0&29 \\
968 1&29& &  1&17 \\
969 2&1000 & & 2&29\\
970  &     & & 3&1000 \\
971
972 & & & & \\
973 0&17& \livelink{DW\_OP\_swap}{chap:DWOPswap} &0&29 \\
974 1&29& &  1&17 \\
975 2&1000 & & 2&1000 \\
976
977 & & & & \\
978 0&17&\livelink{DW\_OP\_rot}{chap:DWOProt} & 0 &29 \\
979 1&29 & & 1 & 1000 \\
980 2& 1000 & &  2 & 17 \\
981 \end{tabular}
982
983 \section{Location Descriptions}
984 \label{chap:locationdescriptions}
985 \textit{ Debugging information must provide consumers a way to find
986 the location of program variables, determine the bounds
987 of dynamic arrays and strings, and possibly to find the
988 base address of a subroutine’s stack frame or the return
989 address of a subroutine. Furthermore, to meet the needs of
990 recent computer architectures and optimization techniques,
991 debugging information must be able to describe the location of
992 an object whose location changes over the object’s lifetime.}
993
994 Information about the location of program objects is provided
995 by location descriptions. Location descriptions can be either
996 of two forms:
997 \begin{enumerate}[1]
998 \item \textit{Single location descriptions}, which are a language independent representation of
999 addressing rules of arbitrary complexity built from 
1000 DWARF expressions (See section \refersec{chap:dwarfexpressions}) 
1001 and/or other
1002 DWARF operations specific to describing locations. They are
1003 sufficient for describing the location of any object as long
1004 as its lifetime is either static or the same as the lexical
1005 block that owns it, and it does not move during its lifetime.
1006
1007 Single location descriptions are of two kinds:
1008 \begin{enumerate}[a]
1009 \item Simple location descriptions, which describe the location
1010 of one contiguous piece (usually all) of an object. A simple
1011 location description may describe a location in addressable
1012 memory, or in a register, or the lack of a location (with or
1013 without a known value).
1014
1015 \item  Composite location descriptions, which describe an
1016 object in terms of pieces each of which may be contained in
1017 part of a register or stored in a memory location unrelated
1018 to other pieces.
1019
1020 \end{enumerate}
1021 \item \textit{Location lists}, which are used to describe
1022 objects that have a limited lifetime or change their location
1023 during their lifetime. Location lists are more completely
1024 described below.
1025
1026 \end{enumerate}
1027
1028 The two forms are distinguished in a context sensitive
1029 manner. As the value of an attribute, a location description
1030 is encoded using class \livelink{exprloc}{chap:exprloc}  
1031 FIXME HYPERREF WRONG
1032 and a location list is encoded
1033 using class loclistptr (which serves as an offset into a
1034 separate location list table).
1035
1036
1037 \subsection{Single Location Descriptions}
1038 A single location description is either:
1039
1040 \begin{enumerate}[1]
1041 \item A simple location description, representing an object
1042 which exists in one contiguous piece at the given location, or 
1043 \item A composite location description consisting of one or more
1044 simple location descriptions, each of which is followed by
1045 one composition operation. Each simple location description
1046 describes the location of one piece of the object; each
1047 composition operation describes which part of the object is
1048 located there. Each simple location description that is a
1049 DWARF expression is evaluated independently of any others
1050 (as though on its own separate stack, if any). 
1051 \end{enumerate}
1052
1053
1054
1055 \subsubsection{Simple Location Descriptions}
1056
1057 A simple location description consists of one 
1058 contiguous piece or all of an object or value.
1059
1060
1061 \paragraph{Memory Location Descriptions}
1062
1063 A memory location description consists of a non\dash empty DWARF
1064 expression (see 
1065 Section \refersec{chap:dwarfexpressions}
1066 ), whose value is the address of
1067 a piece or all of an object or other entity in memory.
1068
1069 \paragraph{Register Location Descriptions}
1070
1071 A register location description consists of a register name
1072 operation, which represents a piece or all of an object
1073 located in a given register.
1074
1075 \textit{Register location descriptions describe an object
1076 (or a piece of an object) that resides in a register, while
1077 the opcodes listed in 
1078 Section \refersec{chap:registerbasedaddressing}
1079 are used to describe an object (or a piece of
1080 an object) that is located in memory at an address that is
1081 contained in a register (possibly offset by some constant). A
1082 register location description must stand alone as the entire
1083 description of an object or a piece of an object.
1084 }
1085
1086 The following DWARF operations can be used to name a register.
1087
1088
1089 \textit{Note that the register number represents a DWARF specific
1090 mapping of numbers onto the actual registers of a given
1091 architecture. The mapping should be chosen to gain optimal
1092 density and should be shared by all users of a given
1093 architecture. It is recommended that this mapping be defined
1094 by the ABI authoring committee for each architecture.
1095 }
1096 \begin{enumerate}[1]
1097 \item DW\_OP\_reg0, DW\_OP\_reg1, ..., DW\_OP\_reg31 \\
1098 The DW\_OP\_regn operations encode the names of up to 32
1099 registers, numbered from 0 through 31, inclusive. The object
1100 addressed is in register n.
1101
1102 \item DW\_OP\_regx \\
1103 The DW\_OP\_regx operation has a single unsigned LEB128 literal
1104 operand that encodes the name of a register.  
1105 \end{enumerate}
1106
1107 \textit{These operations name a register location. To
1108 fetch the contents of a register, it is necessary to use
1109 one of the register based addressing operations, such as
1110 DW\_OP\_bregx 
1111 (Section \refersec{chap:registerbasedaddressing})}.
1112
1113
1114 \paragraph{Implicit Location Descriptions}
1115
1116 An implicit location description represents a piece or all
1117 of an object which has no actual location but whose contents
1118 are nonetheless either known or known to be undefined.
1119
1120 The following DWARF operations may be used to specify a value
1121 that has no location in the program but is a known constant
1122 or is computed from other locations and values in the program.
1123
1124 The following DWARF operations may be used to specify a value
1125 that has no location in the program but is a known constant
1126 or is computed from other locations and values in the program.
1127
1128 \begin{enumerate}[1]
1129 \item DW\_OP\_implicit\_value \\
1130 The DW\_OP\_implicit\_value operation specifies an immediate value
1131 using two operands: an unsigned LEB128 length, followed by
1132 a block representing the value in the memory representation
1133 of the target machine. The length operand gives the length
1134 in bytes of the block.
1135
1136 \item DW\_OP\_stack\_value \\
1137 The DW\_OP\_stack\_value operation specifies that the object
1138 does not exist in memory but its value is nonetheless known
1139 and is at the top of the DWARF expression stack. In this form
1140 of location description, the DWARF expression represents the
1141 actual value of the object, rather than its location. The
1142 DW\_OP\_stack\_value operation terminates the expression.
1143 \end{enumerate}
1144
1145
1146 \paragraph{Empty Location Descriptions}
1147
1148 An empty location description consists of a DWARF expression
1149 containing no operations. It represents a piece or all of an
1150 object that is present in the source but not in the object code
1151 (perhaps due to optimization).
1152
1153 \subsubsection{Composite Location Descriptions}
1154 A composite location description describes an object or
1155 value which may be contained in part of a register or stored
1156 in more than one location. Each piece is described by a
1157 composition operation, which does not compute a value nor
1158 store any result on the DWARF stack. There may be one or
1159 more composition operations in a single composite location
1160 description. A series of such operations describes the parts
1161 of a value in memory address order.
1162
1163 Each composition operation is immediately preceded by a simple
1164 location description which describes the location where part
1165 of the resultant value is contained.
1166
1167 \begin{enumerate}[1]
1168 \item DW\_OP\_piece \\
1169 The DW\_OP\_piece operation takes a single operand, which is an
1170 unsigned LEB128 number.  The number describes the size in bytes
1171 of the piece of the object referenced by the preceding simple
1172 location description. If the piece is located in a register,
1173 but does not occupy the entire register, the placement of
1174 the piece within that register is defined by the ABI.
1175
1176 \textit{Many compilers store a single variable in sets of registers,
1177 or store a variable partially in memory and partially in
1178 registers. DW\_OP\_piece provides a way of describing how large
1179 a part of a variable a particular DWARF location description
1180 refers to. }
1181
1182 \item DW\_OP\_bit\_piece \\
1183 The DW\_OP\_bit\_piece operation takes two operands. The first
1184 is an unsigned LEB128 number that gives the size in bits
1185 of the piece. The second is an unsigned LEB128 number that
1186 gives the offset in bits from the location defined by the
1187 preceding DWARF location description.  
1188
1189 Interpretation of the
1190 offset depends on the kind of location description. If the
1191 location description is empty, the offset doesn’t matter and
1192 the DW\_OP\_bit\_piece operation describes a piece consisting
1193 of the given number of bits whose values are undefined. If
1194 the location is a register, the offset is from the least
1195 significant bit end of the register. If the location is a
1196 memory address, the DW\_OP\_bit\_piece operation describes a
1197 sequence of bits relative to the location whose address is
1198 on the top of the DWARF stack using the bit numbering and
1199 direction conventions that are appropriate to the current
1200 language on the target system. If the location is any implicit
1201 value or stack value, the DW\_OP\_bit\_piece operation describes
1202 a sequence of bits using the least significant bits of that
1203 value.  
1204 \end{enumerate}
1205
1206 \textit{DW\_OP\_bit\_piece is used instead of DW\_OP\_piece when
1207 the piece to be assembled into a value or assigned to is not
1208 byte-sized or is not at the start of a register or addressable
1209 unit of memory.}
1210
1211
1212
1213
1214 \subsubsection{Example Single Location Descriptions}
1215
1216 Here are some examples of how DWARF operations are used to form location descriptions:
1217
1218 DW\_OP\_reg3
1219 \begin{myindentpara}{1cm}
1220 The value is in register 3.
1221 \end{myindentpara}
1222
1223 DW\_OP\_regx 54
1224 \begin{myindentpara}{1cm}
1225 The value is in register 54.
1226 \end{myindentpara}
1227
1228 DW\_OP\_addr 0x80d0045c
1229 \begin{myindentpara}{1cm}
1230 The value of a static variable is at machine address 0x80d0045c.
1231 \end{myindentpara}
1232
1233 DW\_OP\_breg11 44
1234 \begin{myindentpara}{1cm}
1235 Add 44 to the value in register 11 to get the address of an automatic
1236 variable instance.
1237 \end{myindentpara}
1238
1239 DW\_OP\_fbreg -50
1240 \begin{myindentpara}{1cm}
1241 Given a DW\_AT\_frame\_base value of ``DW\_OP\_breg31 64,''this example
1242 computes the address of a local variable that is -50 bytes from a
1243 logical frame pointer that is computed by adding 64 to the current
1244 stack pointer (register 31).
1245 \end{myindentpara}
1246
1247 DW\_OP\_bregx 54 32 DW\_OP\_deref
1248 \begin{myindentpara}{1cm}
1249 A call-by-reference parameter whose address is in the word 32 bytes
1250 from where register 54 points.
1251 \end{myindentpara}
1252
1253 DW\_OP\_plus\_uconst 4
1254 \begin{myindentpara}{1cm}
1255 A structure member is four bytes from the start of the structure
1256 instance. The base address is assumed to be already on the stack.
1257 \end{myindentpara}
1258
1259 DW\_OP\_reg3 DW\_OP\_piece 4 DW\_OP\_reg10 DW\_OP\_piece 2
1260 \begin{myindentpara}{1cm}
1261 A variable whose first four bytes reside in register 3 and whose next
1262 two bytes reside in register 10.
1263 \end{myindentpara}
1264
1265 DW\_OP\_reg0 DW\_OP\_piece 4 DW\_OP\_piece 4 DW\_OP\_fbreg -12 DW\_OP\_piece 4
1266 \begin{myindentpara}{1cm}
1267 A twelve byte value whose first four bytes reside in register zero,
1268 whose middle four bytes are unavailable (perhaps due to optimization),
1269 and whose last four bytes are in memory, 12 bytes before the frame
1270 base.
1271 \end{myindentpara}
1272
1273 DW\_OP\_breg1 0 DW\_OP\_breg2 0 DW\_OP\_plus DW\_OP\_stack\_value
1274 \begin{myindentpara}{1cm}
1275 Add the contents of r1 and r2 to compute a value. This value is the
1276 “contents” of an otherwise anonymous location.
1277 \end{myindentpara}
1278
1279 DW\_OP\_lit1 DW\_OP\_stack\_value DW\_OP\_piece a \\
1280 DW\_OP\_breg3 0 DW\_OP\_breg4 0 DW\_OP\_plus DW\_OP\_stack\_value DW\_OP\_piece 4
1281 \begin{myindentpara}{1cm}
1282 The object value is found in an anonymous (virtual) location whose
1283 value consists of two parts, given in memory address order: the 4 byte
1284 value 1 followed by the four byte value computed from the sum of the
1285 contents of r3 and r4.
1286 \end{myindentpara}
1287
1288
1289 \subsection{Location Lists}
1290 \label{chap:locationlists}
1291 Location lists are used in place of location expressions
1292 whenever the object whose location is being described
1293 can change location during its lifetime. Location lists
1294 are contained in a separate object file section called
1295 .debug\_loc. A location list is indicated by a location
1296 attribute whose value is an offset from the beginning of
1297 the .debug\_loc section to the first byte of the list for the
1298 object in question.
1299
1300 Each entry in a location list is either a location list entry,
1301 a base address selection entry, or an end of list entry.
1302
1303 A location list entry consists of:
1304
1305 \begin{enumerate}[1]
1306 \item A beginning address offset. 
1307 This address offset has the size of an address and is
1308 relative to the applicable base address of the compilation
1309 unit referencing this location list. It marks the beginning
1310 of the address range over which the location is valid.
1311
1312 \item An ending address offset.  This address offset again
1313 has the size of an address and is relative to the applicable
1314 base address of the compilation unit referencing this location
1315 list. It marks the first address past the end of the address
1316 range over which the location is valid. The ending address
1317 must be greater than or equal to the beginning address.
1318
1319 \textit{A location list entry (but not a base address selection or end of list entry) whose beginning
1320 and ending addresses are equal has no effect because the size of the range covered by such
1321 an entry is zero.}
1322
1323 \item A single location description 
1324 describing the location of the object over the range specified by
1325 the beginning and end addresses.
1326 \end{enumerate}
1327
1328 The applicable base address of a location list entry is
1329 determined by the closest preceding base address selection
1330 entry (see below) in the same location list. If there is
1331 no such selection entry, then the applicable base address
1332 defaults to the base address of the compilation unit (see
1333 Section \refersec{chap:normalandpartialcompilationunitentries}).  
1334 In the case of a compilation unit where all of
1335 the machine code is contained in a single contiguous section,
1336 no base address selection entry is needed.
1337
1338 Address ranges may overlap. When they do, they describe a
1339 situation in which an object exists simultaneously in more than
1340 one place. If all of the address ranges in a given location
1341 list do not collectively cover the entire range over which the
1342 object in question is defined, it is assumed that the object is
1343 not available for the portion of the range that is not covered.
1344
1345 A base address selection entry consists of:
1346 \begin{enumerate}[1]
1347 \item The value of the largest representable 
1348 address offset (for example, 0xffffffff when the size of
1349 an address is 32 bits).
1350 \item An address, which defines the 
1351 appropriate base address for use in interpreting the beginning
1352 and ending address offsets of subsequent entries of the location list.
1353 \end{enumerate}
1354
1355
1356 \textit{A base address selection entry 
1357 affects only the list in which it is contained.}
1358
1359 The end of any given location list is marked by an end of
1360 list entry, which consists of a 0 for the beginning address
1361 offset and a 0 for the ending address offset. A location list
1362 containing only an end of list entry describes an object that
1363 exists in the source code but not in the executable program.
1364
1365 Neither a base address selection entry nor an end of list
1366 entry includes a location description.
1367
1368 \textit{A base address selection entry and an end of list
1369 entry for a location list are identical to a base address
1370 selection entry and end of list entry, respectively, for a
1371 range list 
1372 (see Section \refersec{chap:noncontiguousaddressranges}) 
1373 in interpretation
1374 and representation.}
1375
1376
1377
1378
1379
1380
1381 \section{Types of Program Entities}
1382 \label{chap:typesofprogramentities}
1383 Any debugging information entry describing a declaration that
1384 has a type has a DW\-\_AT\-\_type attribute, whose value is a
1385 reference to another debugging information entry. The entry
1386 referenced may describe a base type, that is, a type that is
1387 not defined in terms of other data types, or it may describe a
1388 user-defined type, such as an array, structure or enumeration.
1389 Alternatively, the entry referenced may describe a type
1390 modifier, such as constant, packed, pointer, reference or
1391 volatile, which in turn will reference another entry describing
1392 a type or type modifier (using a DW\-\_AT\-\_type attribute of its
1393 own). See 
1394 Section  \refersec{chap:typeentries} 
1395 for descriptions of the entries describing
1396 base types, user-defined types and type modifiers.
1397
1398
1399
1400 \section{Accessibility of Declarations}
1401 \label{chap:accessibilityofdeclarations}
1402 \textit{Some languages, notably C++ and Ada, have the concept of
1403 the accessibility of an object or of some other program
1404 entity. The accessibility specifies which classes of other
1405 program objects are permitted access to the object in question.}
1406
1407 The accessibility of a declaration is represented by a DW\_AT\_accessibility attribute, whose
1408 value is a constant drawn from the set of codes listed in Figure 
1409 \ref{fig:accessibilitycodes}.
1410
1411 \begin{figure}[here]
1412 \begin{description}
1413 \centering
1414 \item [DW\_ACCESS\_public]
1415 \item [DW\_ACCESS\_private]
1416 \item [DW\_ACCESS\_protected]
1417 \end{description}
1418 \caption{Accessibility codes}
1419 \label{fig:accessibilitycodes}
1420 \end{figure}
1421
1422 \section{Visibility of Declarations}
1423 \label{chap:visibilityofdeclarations}
1424
1425 \textit{Several languages (such as Modula-2) 
1426 have the concept of the visibility of a declaration. The
1427 visibility specifies which declarations are to be 
1428 visible outside of the entity in which they are
1429 declared.}
1430
1431 The visibility of a declaration is represented 
1432 by a DW\_AT\_visibility attribute, whose value is a
1433 constant drawn from the set of codes listed in 
1434 Figure \ref{fig:visibilitycodes}.
1435
1436 \begin{figure}[here]
1437 \begin{description}
1438 \centering
1439 \item [DW\_VIS\_local]
1440 \item [DW\_VIS\_exported]
1441 \item [DW\_VIS\_qualified]
1442 \end{description}
1443 \caption{Visibility codes}
1444 \label{fig:visibilitycodes}
1445 \end{figure}
1446
1447 \section{Virtuality of Declarations}
1448 \label{chap:virtualityofdeclarations}
1449 \textit{C++ provides for virtual and pure virtual structure or class
1450 member functions and for virtual base classes.}
1451
1452 The virtuality of a declaration is represented by a
1453 DW\_AT\_virtuality attribute, whose value is a constant drawn
1454 from the set of codes listed in 
1455 Figure \ref{fig:virtualitycodes}.
1456
1457 \begin{figure}[here]
1458 \begin{description}
1459 \centering
1460 \item [DW\_VIRTUALITY\_none]
1461 \item [DW\_VIRTUALITY\_virtual]
1462 \item [DW\_VIRTUALITY\_pure\_virtual]
1463 \end{description}
1464 \caption{Virtuality codes}
1465 \label{fig:virtualitycodes}
1466 \end{figure}
1467
1468 \section{Artificial Entries}
1469 \label{chap:artificialentries}
1470 \textit{A compiler may wish to generate debugging information entries
1471 for objects or types that were not actually declared in the
1472 source of the application. An example is a formal parameter
1473 entry to represent the hidden this parameter that most C++
1474 implementations pass as the first argument to non-static member
1475 functions.}  
1476
1477 Any debugging information entry representing the
1478 declaration of an object or type artificially generated by
1479 a compiler and not explicitly declared by the source program
1480 may have a DW\_AT\_artificial attribute, which is a flag.
1481
1482 \section{Segmented Addresses}
1483 \label{chap:segmentedaddresses}
1484 \textit{In some systems, addresses are specified as offsets within a
1485 given segment rather than as locations within a single flat
1486 address space.}
1487
1488 Any debugging information entry that contains a description
1489 of the location of an object or subroutine may have
1490 a DW\_AT\_segment attribute, whose value is a location
1491 description. The description evaluates to the segment selector
1492 of the item being described. If the entry containing the
1493 DW\_AT\_segment attribute has a DW\_AT\_low\_pc, DW\_AT\_high\_pc,
1494 DW\_AT\_ranges or DW\_AT\_entry\_pc attribute, or a location
1495 description that evaluates to an address, then those address
1496 values represent the offset portion of the address within
1497 the segment specified by DW\_AT\_segment.
1498
1499 If an entry has no DW\_AT\_segment attribute, it inherits
1500 the segment value from its parent entry.  If none of the
1501 entries in the chain of parents for this entry back to
1502 its containing compilation unit entry have DW\_AT\_segment
1503 attributes, then the entry is assumed to exist within a flat
1504 address space. Similarly, if the entry has a DW\_AT\_segment
1505 attribute containing an empty location description, that
1506 entry is assumed to exist within a flat address space.
1507
1508 \textit{Some systems support different classes of addresses. The
1509 address class may affect the way a pointer is dereferenced
1510 or the way a subroutine is called.}
1511
1512
1513 Any debugging information entry representing a pointer or
1514 reference type or a subroutine or subroutine type may have
1515 a DW\_AT\_address\_class attribute, whose value is an integer
1516 constant.  The set of permissible values is specific to
1517 each target architecture. The value DW\_ADDR\_none, however,
1518 is common to all encodings, and means that no address class
1519 has been specified.
1520
1521 \textit {For example, the Intel386 ™ processor might use the following values:}
1522
1523 \begin{figure}[here]
1524 \centering
1525 \begin{tabular}{lll} 
1526 Name&Value&Meaning  \\
1527 \hline
1528 \textit{DW\_ADDR\_none}&   0 & \textit{no class specified} \\
1529 \textit{DW\_ADDR\_near16}& 1 & \textit{16\dash bit offset, no segment} \\
1530 \textit{DW\_ADDR\_far16}&  2 & \textit{16\dash bit offset, 16\dash bit segment} \\
1531 \textit{DW\_ADDR\_huge16}& 3 & \textit{16\dash bit offset, 16\dash bit segment} \\
1532 \textit{DW\_ADDR\_near32}& 4 & \textit{32\dash bit offset, no segment} \\
1533 \textit{DW\_ADDR\_far32}&  5 & \textit{32\dash bit offset, 16\dash bit segment}
1534 \end{tabular}
1535 \caption{Example address class codes}
1536 \label{fig:inteladdressclasstable}
1537 \end{figure}
1538
1539 \section{Non-Defining Declarations and Completions}
1540 \label{nondefiningdeclarationsandcompletions}
1541 A debugging information entry representing a program entity
1542 typically represents the defining declaration of that
1543 entity. In certain contexts, however, a debugger might need
1544 information about a declaration of an entity that is not
1545 also a definition, or is otherwise incomplete, to evaluate
1546 an expression correctly.
1547
1548 \textit{As an example, consider the following fragment of C code:}
1549
1550 \begin{lstlisting}
1551 void myfunc()
1552 {
1553   int x;
1554   {
1555     extern float x;
1556     g(x);
1557   }
1558 }
1559 \end{lstlisting}
1560
1561
1562 \textit{C scoping rules require that the 
1563 value of the variable x passed to the function g is the value of the
1564 global variable x rather than of the local version.}
1565
1566
1567 \section{Declaration Coordinates}
1568 \label{chap:declarationcoordinates}
1569 \textit{It is sometimes useful in a debugger to be able to associate
1570 a declaration with its occurrence in the program source.
1571 }
1572
1573 Any debugging information entry representing the
1574 declaration of an object, module, subprogram or type may have
1575 DW\_AT\_decl\_file, DW\_AT\_decl\_line and DW\_AT\_decl\_column
1576 attributes each of whose value is an unsigned integer constant.
1577
1578 The value of the DW\_AT\_decl\_file attribute corresponds to
1579 a file number from the line number information table for the
1580 compilation unit containing the debugging information entry and
1581 represents the source file in which the declaration appeared
1582 (see Section 6.2). The value 0 indicates that no source file
1583 has been specified.
1584
1585 The value of the DW\_AT\_decl\_line attribute represents
1586 the source line number at which the first character of
1587 the identifier of the declared object appears. The value 0
1588 indicates that no source line has been specified.
1589
1590 The value of the DW\_AT\_decl\_column attribute represents
1591 the source column number at which the first character of
1592 the identifier of the declared object appears. The value 0
1593 indicates that no column has been specified.
1594
1595 \section{Identifier Names}
1596 \label{chap:identifiernames}
1597 Any debugging information entry representing a program entity
1598 that has been given a name may have a DW\_AT\_name attribute,
1599 whose value is a string representing the name as it appears in
1600 the source program. A debugging information entry containing
1601 no name attribute, or containing a name attribute whose value
1602 consists of a name containing a single null byte, represents
1603 a program entity for which no name was given in the source.
1604
1605 \textit{Because the names of program objects described by DWARF are the
1606 names as they appear in the source program, implementations
1607 of language translators that use some form of mangled name
1608 (as do many implementations of C++) should use the unmangled
1609 form of the name in the DWARF DW\_AT\_name attribute,
1610 including the keyword operator (in names such as “operator
1611 +”), if present. See also 
1612 Section \refersec{chap:linkagenames} regarding the use
1613 of DW\_AT\_linkage\_name for mangled names. Sequences of
1614 multiple whitespace characters may be compressed.}
1615
1616 \section{Data Locations and DWARF Procedures}
1617 Any debugging information entry describing a data object (which
1618 includes variables and parameters) or common block may have a
1619 DW\_AT\_location attribute, whose value is a location description
1620 (see Section 2.6).  
1621
1622 A DWARF procedure is represented by any
1623 kind of debugging information entry that has a DW\-\_AT\-\_location
1624 attribute. If a suitable entry is not otherwise available,
1625 a DWARF procedure can be represented using a debugging
1626 information entry with the tag DW\-\_TAG\-\_dwarf\-\_procedure
1627 together with a DW\-\_AT\-\_location attribute.  
1628
1629 A DWARF procedure
1630 is called by a DW\-\_OP\-\_call2, 
1631 DW\-\_OP\-\_call4 or 
1632 DW\-\_OP\-\_call\-\_ref
1633 DWARF expression operator 
1634 (see Section \refersec{chap:controlflowoperations}).
1635
1636 \section{Code Addresses and Ranges}
1637 \label{chap:codeaddressesandranges}
1638 Any debugging information entry describing an entity that has
1639 a machine code address or range of machine code addresses,
1640 which includes compilation units, module initialization,
1641 subroutines, ordinary blocks, try/catch blocks, labels and
1642 the like, may have
1643
1644 \begin{itemize}
1645 \item A DW\_AT\_low\_pc and DW\_AT\_high\_pc pair of 
1646 attributes for a single contiguous range of
1647 addresses, or
1648
1649 \item A DW\_AT\_ranges attribute for a non-contiguous range of addresses.
1650 \end{itemize}
1651
1652 In addition, a non-contiguous range of 
1653 addresses may also be specified for the
1654 DW\_AT\_start\_scope attribute.
1655 If an entity has no associated machine code, 
1656 none of these attributes are specified.
1657
1658 \subsection{Single Address} 
1659 When there is a single address associated with an entity,
1660 such as a label or alternate entry point of a subprogram,
1661 the entry has a DW\_AT\_low\_pc attribute whose value is the
1662 relocated address for the entity.  While the DW\_AT\_entry\_pc
1663 attribute might also seem appropriate for this purpose,
1664 historically the DW\_AT\_low\_pc attribute was used before the
1665 DW\_AT\_entry\_pc was introduced (in DWARF Version 3). There is
1666 insufficient reason to change this.
1667
1668 \subsection{Continuous Address Range}
1669 \label{chap:contiguousaddressranges}
1670 When the set of addresses of a debugging information entry can
1671 be described as a single continguous range, the entry may have
1672 a DW\_AT\_low\_pc and DW\_AT\_high\_pc pair of attributes. The value
1673 of the DW\_AT\_low\_pc attribute is the relocated address of the
1674 first instruction associated with the entity. If the value of
1675 the DW\_AT\_high\_pc is of class address, it is the relocated
1676 address of the first location past the last instruction
1677 associated with the entity; if it is of class constant, the
1678 value is an unsigned integer offset which when added to the
1679 low PC gives the address of the first location past the last
1680 instruction associated with the entity.  The high PC value
1681 may be beyond the last valid instruction in the executable.
1682 The presence of low and high PC attributes for an entity
1683 implies that the code generated for the entity is contiguous
1684 and exists totally within the boundaries specified by those
1685 two attributes. If that is not the case, no low and high PC
1686 attributes should be produced.
1687
1688 \subsection{Non\dash Contiguous Address Ranges}
1689 \label{chap:noncontiguousaddressranges}
1690 When the set of addresses of a debugging information entry
1691 cannot be described as a single contiguous range, the entry has
1692 a DW\_AT\_ranges attribute whose value is of class rangelistptr
1693 and indicates the beginning of a range list. Similarly,
1694 a DW\_AT\_start\_scope attribute may have a value of class
1695 rangelistptr for the same reason.  
1696
1697 Range lists are contained
1698 in a separate object file section called .debug\_ranges. A
1699 range list is indicated by a DW\_AT\_ranges attribute whose
1700 value is represented as an offset from the beginning of the
1701 .debug\_ranges section to the beginning of the range list.
1702
1703 Each entry in a range list is either a range list entry,
1704 a base address selection entry, or an end of list entry.
1705
1706 A range list entry consists of:
1707
1708 \begin{enumerate}[1]
1709 \item A beginning address offset. This address offset has the size of an address and is relative to
1710 the applicable base address of the compilation unit referencing this range list. It marks the
1711 beginning of an address range.
1712
1713 \item An ending address offset. This address offset again has the size of an address and is relative
1714 to the applicable base address of the compilation unit referencing this range list. It marks the
1715 first address past the end of the address range.The ending address must be greater than or
1716 equal to the beginning address.
1717
1718 \textit{A range list entry (but not a base address selection or end of list entry) whose beginning and
1719 ending addresses are equal has no effect because the size of the range covered by such an
1720 entry is zero.}
1721 \end{enumerate}
1722
1723 The applicable base address of a range list entry is determined
1724 by the closest preceding base address selection entry (see
1725 below) in the same range list. If there is no such selection
1726 entry, then the applicable base address defaults to the base
1727 address of the compilation unit 
1728 (see Section \refersec{chap:normalandpartialcompilationunitentries}).
1729
1730 \textit{In the case of a compilation unit where all of the machine
1731 code is contained in a single contiguous section, no base
1732 address selection entry is needed.}
1733
1734 Address range entries in
1735 a range list may not overlap. There is no requirement that
1736 the entries be ordered in any particular way.
1737
1738 A base address selection entry consists of:
1739
1740 \begin{enumerate}[1]
1741 \item The value of the largest representable address offset (for example, 0xffffffff when the size of
1742 an address is 32 bits).
1743
1744 \item An address, which defines the appropriate base address for use in interpreting the beginning
1745 and ending address offsets of subsequent entries of the location list.
1746 \end{enumerate}
1747 \textit{A base address selection entry 
1748 affects only the list in which it is contained.}
1749
1750
1751 The end of any given range list is marked by an end of
1752 list entry, which consists of a 0 for the beginning address
1753 offset and a 0 for the ending address offset. A range list
1754 containing only an end of list entry describes an empty scope
1755 (which contains no instructions).
1756
1757 \textit{A base address selection entry and an end of list entry for
1758 a range list are identical to a base address selection entry
1759 and end of list entry, respectively, for a location list
1760 (see Section 2.6.2) in interpretation and representation.}
1761
1762
1763
1764 \section{Entry Address}
1765 \label{chap:entryaddress}
1766 \textit{The entry or first executable instruction generated
1767 for an entity, if applicable, is often the lowest addressed
1768 instruction of a contiguous range of instructions. In other
1769 cases, the entry address needs to be specified explicitly.}
1770
1771 Any debugging information entry describing an entity that has
1772 a range of code addresses, which includes compilation units,
1773 module initialization, subroutines, ordinary blocks, try/catch
1774 blocks, and the like, may have a DW\_AT\_entry\_pc attribute to
1775 indicate the first executable instruction within that range
1776 of addresses. The value of the DW\_AT\_entry\_pc attribute is a
1777 relocated address. If no DW\_AT\_entry\_pc attribute is present,
1778 then the entry address is assumed to be the same as the
1779 value of the DW\_AT\_low\_pc attribute, if present; otherwise,
1780 the entry address is unknown.
1781
1782 \section{Static and Dynamic Values of Attributes}
1783 \label{chap:staticanddynamicvaluesofattributes}
1784
1785 Some attributes that apply to types specify a property (such
1786 as the lower bound of an array) that is an integer value,
1787 where the value may be known during compilation or may be
1788 computed dynamically during execution.  The value of these
1789 attributes is determined based on the class as follows:
1790
1791 \begin{itemize}
1792 \item For a constant FIXME HYPERRREF, the value of the constant is the value of
1793 the attribute.
1794
1795 \item For a reference FIXME HYPERRREF, the value is a reference to another
1796 entity which specifies the value of the attribute.
1797
1798 \item For an exprloc, the value is interpreted as a 
1799 DWARF expression FIXME HYPERREF; 
1800 evaluation of the expression yields the value of
1801 the attribute.
1802 \end{itemize}
1803
1804 \textit{
1805 Whether an attribute value can be dynamic depends on the
1806 rules of the applicable programming language.
1807 }
1808
1809 \textit{The applicable attributes include: 
1810 DW\-\_AT\-\_allocated,
1811 DW\-\_AT\-\_associated, 
1812 DW\-\_AT\-\_bit\-\_offset, 
1813 DW\-\_AT\-\_bit\-\_size,
1814 DW\-\_AT\-\_byte\-\_size, 
1815 DW\-\_AT\-\_count, 
1816 DW\-\_AT\-\_lower\-\_bound,
1817 DW\-\_AT\-\_byte\-\_stride, 
1818 DW\-\_AT\-\_bit\-\_stride, 
1819 DW\-\_AT\-\_upper\-\_bound (and
1820 possibly others).}
1821
1822
1823 \section{Entity Descriptions}
1824 \textit{Some debugging information entries may describe entities
1825 in the program that are artificial, or which otherwise are
1826 ``named'' in ways which are not valid identifiers in the
1827 programming language. For example, several languages may
1828 capture or freeze the value of a variable at a particular
1829 point in the program. Ada 95 has package elaboration routines,
1830 type descriptions of the form typename’Class, and 
1831 ``access typename'' parameters.  }
1832
1833 Generally, any debugging information
1834 entry that has, or may have, a DW\_AT\_name attribute, may
1835 also have a DW\_AT\_description attribute whose value is a
1836 null-terminated string providing a description of the entity.
1837
1838
1839 \textit{It is expected that a debugger will only display these
1840 descriptions as part of the description of other entities. It
1841 should not accept them in expressions, nor allow them to be
1842 assigned, or the like.}
1843
1844 \section{Byte and Bit Sizes}
1845 \label{chap:byteandbitsizes}
1846 % Some trouble here with hbox full, so we try optional word breaks.
1847 Many debugging information entries allow either a
1848 DW\-\_AT\-\_byte\-\_size attribute or a DW\-\_AT\-\_bit\-\_size attribute,
1849 whose integer constant value 
1850 (see \refersec{chap:staticanddynamicvaluesofattributes}) 
1851 specifies an
1852 amount of storage. The value of the DW\_AT\_byte\_size attribute
1853 is interpreted in bytes and the value of the DW\_AT\_bit\_size
1854 attribute is interpreted in bits.  
1855
1856 Similarly, the integer
1857 constant value of a DW\_AT\_byte\_stride attribute is interpreted
1858 in bytes and the integer constant value of a DW\_AT\_bit\_stride
1859 attribute is interpreted in bits.
1860
1861 \section{Linkage Names}
1862 \label{chap:linkagenames}
1863 \textit{Some language implementations, notably C++ and similar
1864 languages, make use of implementation defined names within
1865 object files that are different from the identifier names
1866 (see \refersec{chap:identifiernames}) of entities as they appear in the
1867 source. Such names, sometimes known as mangled names,
1868 are used in various ways, such as: to encode additional
1869 information about an entity, to distinguish multiple entities
1870 that have the same name, and so on. When an entity has an
1871 associated distinct linkage name it may sometimes be useful
1872 for a producer to include this name in the DWARF description
1873 of the program to facilitate consumer access to and use of
1874 object file information about an entity and/or information
1875 that is encoded in the linkage name itself.  
1876 }
1877
1878 % Some trouble maybe with hbox full, so we try optional word breaks.
1879 A debugging
1880 information entry may have a DW\-\_AT\-\_linkage\-\_name attribute
1881 whose value is a null-terminated string describing the object
1882 file linkage name associated with the corresponding entity.
1883
1884 % Some trouble here with hbox full, so we try optional word breaks.
1885 \textit{Debugging information entries to which DW\-\_AT\-\_linkage\-\_name
1886 may apply include: DW\-\_TAG\-\_common\-\_block, DW\-\_TAG\-\_constant,
1887 DW\-\_TAG\-\_entry\-\_point, DW\-\_TAG\-\_subprogram 
1888 and DW\-\_TAG\-\_variable.
1889 }