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