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