04fbb7f66093a87d2681c1af20aee2a9908c82dc
[dwarf-doc.git] / dwarf5 / latexdoc / examples.tex
1 \chapter{Examples (Informative)}
2 \label{app:examplesinformative}
3
4 The following sections provide examples that illustrate
5 various aspects of the DWARF debugging information format.
6
7
8 \section{Compilation Units and Abbreviations Table Example}
9 \label{app:compilationunitsandabbreviationstableexample}
10
11
12 Figure \refersec{fig:compilationunitsandabbreviationstable}
13 depicts the relationship of the abbreviations tables contained
14 \addtoindexx{abbreviations table!example}
15 \addtoindexx{\texttt{.debug\_abbrev}!example}
16 \addtoindexx{\texttt{.debug\_info}!example}
17 in the \dotdebugabbrev{}
18 section to the information contained in
19 the \dotdebuginfo{}
20 section. Values are given in symbolic form,
21 where possible.
22
23 The figure corresponds to the following two trivial source files:
24
25 File myfile.c
26 \begin{lstlisting}[numbers=none]
27 typedef char* POINTER;
28 \end{lstlisting}
29 File myfile2.c
30 \begin{lstlisting}[numbers=none]
31 typedef char* strp;
32 \end{lstlisting}
33
34 % Ensures we get the following float out before we go on.
35 \clearpage
36 \begin{figure}[here]
37 %\centering
38 %\setlength{\linewidth}{1.1\linewidth}
39 \begin{minipage}[t]{0.03\linewidth}
40 \flushright
41 \scriptsize
42 % Note: alltt is used to step down the needed number of lines to the labels
43 \begin{alltt}
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64 \textit{e1:}
65
66
67
68
69 \textit{e2:}
70 \end{alltt}
71 \end{minipage}
72 %
73 \begin{minipage}[t]{0.38\linewidth}
74 \centering
75 Compilation Unit \#1: \dotdebuginfo{}
76 \begin{framed}
77 \scriptsize
78 \begin{alltt}
79 \textit{length}
80 4
81 \textit{a1 (abbreviations table offset)}
82 4
83 \vspace{0.01cm}
84 \hrule
85 1
86 "myfile.c"
87 "Best Compiler Corp, V1.3"
88 "/home/mydir/src"
89 \DWLANGCeightynine
90 0x0
91 0x55
92 \DWFORMsecoffset
93 0x0
94 \vspace{0.01cm}
95 \hrule
96 2
97 "char"
98 \DWATEunsignedchar
99 1
100 \vspace{0.01cm}
101 \hrule
102 3
103 \textit{e1  (debug info offset)}
104 \vspace{0.01cm}
105 \hrule
106 4
107 "POINTER"
108 \textit{e2  (debug info offset)}
109 \vspace{0.01cm}
110 \hrule
111 0
112 \end{alltt}
113 %
114 %
115 \end{framed}
116 Compilation Unit \#2: \dotdebuginfo{}
117 \begin{framed}
118 \scriptsize
119 \begin{alltt}
120 \textit{length}
121 4
122 \textit{a1 (abbreviations table offset)}
123 4
124 \vspace{0.01cm}
125 \hrule
126 ...
127 \vspace{0.01cm}
128 \hrule
129 4
130 "strp"
131 \textit{e2  (debug info offset)}
132 \vspace{0.01cm}
133 \hrule
134 ...
135 \end{alltt}
136 %
137 %
138 \end{framed}
139 \end{minipage}
140 \hfill 
141 % Place the label for the abbreviation table
142 \begin{minipage}[t]{0.03\linewidth}
143 \flushright
144 \scriptsize
145 % Note: alltt is used to step down the needed number of lines to the label
146 \begin{alltt}
147
148
149
150
151
152 \textit{a1:}
153 \end{alltt}
154 \end{minipage}
155 %
156 \begin{minipage}[t]{0.41\linewidth}
157 \centering
158 Abbreviation Table: \dotdebugabbrev{}
159 \begin{framed}
160 \scriptsize
161 \begin{alltt}\vspace{0.06cm}
162 1
163 \DWTAGcompileunit
164 \DWCHILDRENyes
165 \DWATname       \DWFORMstring
166 \DWATproducer   \DWFORMstring
167 \DWATcompdir   \DWFORMstring
168 \DWATlanguage   \DWFORMdataone
169 \DWATlowpc     \DWFORMaddr
170 \DWAThighpc    \DWFORMdataone
171 \DWATstmtlist  \DWFORMindirect
172 0
173 \vspace{0.01cm}
174 \hrule
175 2
176 \DWTAGbasetype
177 \DWCHILDRENno
178 \DWATname       \DWFORMstring
179 \DWATencoding   \DWFORMdataone
180 \DWATbytesize  \DWFORMdataone
181 0
182 \vspace{0.01cm}
183 \hrule
184 3
185 \DWTAGpointertype
186 \DWCHILDRENno
187 \DWATtype       \DWFORMreffour
188 0
189 \vspace{0.01cm}
190 \hrule
191 4
192 \DWTAGtypedef
193 \DWCHILDRENno
194 \DWATname      \DWFORMstring
195 \DWATtype      \DWFORMrefaddr
196 0
197 \vspace{0.01cm}
198 \hrule
199 0
200 \end{alltt}
201 \end{framed}
202 \end{minipage}
203
204 \vspace{0.2cm}
205 \caption{Compilation units and abbreviations table} \label{fig:compilationunitsandabbreviationstable}
206 \end{figure}
207
208 % Ensures we get the above float out before we go on.
209 \clearpage
210
211 \section{Aggregate Examples}
212 \label{app:aggregateexamples}
213
214 The following examples illustrate how to represent some of
215 the more complicated forms of array and record aggregates
216 using DWARF.
217
218 \subsection{Fortran Simple Array Example}
219 \label{app:fortranarrayexample}
220 Consider the \addtoindex{Fortran array}\addtoindexx{Fortran 90} source fragment in 
221 \addtoindexx{array type entry!examples}
222 Figure \referfol{fig:fortranarrayexamplesourcefragment}.
223
224 \begin{figure}[here]
225 \begin{lstlisting}
226 type array_ptr
227 real :: myvar
228 real, dimension (:), pointer :: ap
229 end type array_ptr
230 type(array_ptr), allocatable, dimension(:) :: arrayvar
231 allocate(arrayvar(20))
232 do i = 1, 20
233 allocate(arrayvar(i)%ap(i+10))
234 end do
235 \end{lstlisting}
236 \caption{Fortran array example: source fragment} \label{fig:fortranarrayexamplesourcefragment}
237 \end{figure}
238
239 For allocatable and pointer arrays, it is essentially required
240 by the \addtoindex{Fortran array} semantics that each array consist of 
241 \addtoindexx{descriptor!array}
242 two
243 \addtoindexx{array!descriptor for}
244 parts, which we here call 1) the descriptor and 2) the raw
245 data. (A descriptor has often been called a dope vector in
246 other contexts, although it is often a structure of some kind
247 rather than a simple vector.) Because there are two parts,
248 and because the lifetime of the descriptor is necessarily
249 longer than and includes that of the raw data, there must be
250 an address somewhere in the descriptor that points to the
251 raw data when, in fact, there is some (that is, when 
252 the \doublequote{variable} is allocated or associated).
253
254 For concreteness, suppose that a descriptor looks something
255 like the C structure in 
256 Figure \refersec{fig:fortranarrayexampledescriptorrepresentation}.
257 Note, however, that it is
258 a property of the design that 1) a debugger needs no builtin
259 knowledge of this structure and 2) there does not need to
260 be an explicit representation of this structure in the DWARF
261 input to the debugger.
262
263 \begin{figure}[here]
264 \begin{lstlisting}
265 struct desc {
266     long el_len;       // Element length
267     void * base;       // Address of raw data
268     int ptr_assoc : 1; // Pointer is associated flag
269     int ptr_alloc : 1; // Pointer is allocated flag
270     int num_dims  : 6; // Number of dimensions
271     struct dims_str {  // For each dimension...  
272         long low_bound;
273         long upper_bound;
274         long stride;
275     } dims[63];
276 };
277 \end{lstlisting}
278 \caption{Fortran array example: descriptor representation}
279 \label{fig:fortranarrayexampledescriptorrepresentation}
280 \end{figure}
281
282
283 In practice, of course, a \doublequote{real} descriptor will have
284 dimension substructures only for as many dimensions as are
285 specified in the \texttt{num\_dims} component. Let us use the notation
286 \texttt{desc\textless n\textgreater}   
287 to indicate a specialization of the \texttt{desc} struct in
288 which \texttt{n} is the bound for the \texttt{dims} component as well as the
289 contents of the \texttt{num\_dims} component.
290
291 Because the arrays considered here come in two parts, it is
292 necessary to distinguish the parts carefully. In particular,
293 the \doublequote{address of the variable} or equivalently, the \doublequote{base
294 address of the object} \emph{always} refers to the descriptor. For
295 arrays that do not come in two parts, an implementation can
296 provide a descriptor anyway, thereby giving it two parts. (This
297 may be convenient for general runtime support unrelated to
298 debugging.) In this case the above vocabulary applies as
299 stated. Alternatively, an implementation can do without a
300 descriptor, in which case the \doublequote{address of the variable,}
301 or equivalently the \doublequote{base address of the object}, refers
302 to the \doublequote{raw data} (the real data, the only thing around
303 that can be the object).
304
305 If an object has a descriptor, then the DWARF type for that
306 object will have a 
307 \DWATdatalocation{} 
308 attribute. If an object
309 does not have a descriptor, then usually the DWARF type for the
310 object will not have a 
311 \DWATdatalocation. 
312 (See the following
313 \addtoindex{Ada} example for a case where the type for an object without
314 a descriptor does have a 
315 \DWATdatalocation{} attribute. In
316 that case the object doubles as its own descriptor.)
317
318 The \addtoindex{Fortran} derived type \texttt{array\_ptr} can now be redescribed
319 in C\dash like terms that expose some of the representation as in
320
321 \begin{lstlisting}[numbers=none]
322 struct array_ptr {
323     float myvar;
324     desc<1> ap;
325 };
326 \end{lstlisting}
327
328 Similarly for variable \texttt{arrayvar}:
329 \begin{lstlisting}[numbers=none]
330 desc<1> arrayvar;
331 \end{lstlisting}
332
333 (Recall that \texttt{desc\textless 1\textgreater} 
334 indicates the 1\dash dimensional version of \texttt{desc}.)
335
336 \newpage
337 Finally, the following notation is useful:
338 \begin{enumerate}[1. ]
339 \item  sizeof(type): size in bytes of entities of the given type
340 \item offset(type, comp): offset in bytes of the comp component
341 within an entity of the given type
342 \end{enumerate}
343
344 The DWARF description is shown 
345 \addtoindexx{Fortran 90}
346 in Figure \refersec{fig:fortranarrayexampledwarfdescription}.
347
348 \begin{figure}[h]
349 \figurepart{1}{2}
350 \begin{dwflisting}
351 \begin{alltt}
352 ! Description for type of 'ap'
353 !
354 1\$: \DWTAGarraytype
355         ! No name, default (Fortran) ordering, default stride
356         \DWATtype(reference to REAL)
357         \DWATassociated(expression=    ! Test 'ptr\_assoc' \nolink{flag}
358             \DWOPpushobjectaddress
359             \DWOPlitn                ! where n == offset(ptr\_assoc)
360             \DWOPplus
361             \DWOPderef
362             \DWOPlitone                  ! mask for 'ptr\_assoc' \nolink{flag}
363             \DWOPand)
364         \DWATdatalocation(expression= ! Get raw data address
365             \DWOPpushobjectaddress
366             \DWOPlitn                ! where n == offset(base)
367             \DWOPplus
368             \DWOPderef)                ! Type of index of array 'ap'
369 2\$:     \DWTAGsubrangetype
370             ! No name, default stride
371             \DWATtype(reference to INTEGER)
372             \DWATlowerbound(expression=
373                 \DWOPpushobjectaddress
374                 \DWOPlitn             ! where n ==
375                                          !   offset(desc, dims) +
376                                          !   offset(dims\_str, lower\_bound)
377                 \DWOPplus
378                 \DWOPderef)
379             \DWATupperbound(expression=
380                 \DWOPpushobjectaddress
381                 \DWOPlitn            ! where n ==
382                                         !   offset(desc, dims) +
383                                         !   offset(dims\_str, upper\_bound)
384                 \DWOPplus
385                 \DWOPderef)
386             !  Note: for the m'th dimension, the second operator becomes
387             !  \DWOPlitn where
388             !       n == offset(desc, dims)          +
389             !                (m-1)*sizeof(dims\_str)  +
390             !                 offset(dims\_str, [lower|upper]\_bound)
391             !  That is, the expression does not get longer for each successive 
392             !  dimension (other than to express the larger offsets involved).
393 \end{alltt}
394 \end{dwflisting}
395 \caption{Fortran array example: DWARF description}
396 \label{fig:fortranarrayexampledwarfdescription}
397 \end{figure}
398
399 \begin{figure}
400 \figurepart{2}{2}
401 \begin{dwflisting}
402 \begin{alltt}
403 3\$: \DWTAGstructuretype
404         \DWATname("array\_ptr")
405         \DWATbytesize(constant sizeof(REAL) + sizeof(desc<1>))
406 4\$:     \DWTAGmember
407             \DWATname("myvar")
408             \DWATtype(reference to REAL)
409             \DWATdatamemberlocation(constant 0)
410 5\$:     \DWTAGmember
411             \DWATname("ap");
412             \DWATtype(reference to 1\$)
413             \DWATdatamemberlocation(constant sizeof(REAL))
414 6\$: \DWTAGarraytype
415         ! No name, default (Fortran) ordering, default stride
416         \DWATtype(reference to 3\$)
417         \DWATallocated(expression=       ! Test 'ptr\_alloc' \nolink{flag}
418             \DWOPpushobjectaddress
419             \DWOPlitn                  ! where n == offset(ptr\_alloc)
420             \DWOPplus
421             \DWOPderef
422             \DWOPlittwo                    ! Mask for 'ptr\_alloc' \nolink{flag}
423             \DWOPand)
424         \DWATdatalocation(expression=   ! Get raw data address
425             \DWOPpushobjectaddress
426             \DWOPlitn                  ! where n == offset(base)
427             \DWOPplus
428             \DWOPderef)
429 7\$:     \DWTAGsubrangetype
430             ! No name, default stride
431             \DWATtype(reference to INTEGER)
432             \DWATlowerbound(expression=
433                 \DWOPpushobjectaddress
434                 \DWOPlitn              ! where n == ...
435                 \DWOPplus
436                 \DWOPderef)
437             \DWATupperbound(expression=
438                 \DWOPpushobjectaddress
439                 \DWOPlitn              ! where n == ...
440                 \DWOPplus
441                 \DWOPderef)
442 8\$: \DWTAGvariable
443         \DWATname("arrayvar")
444         \DWATtype(reference to 6\$)
445         \DWATlocation(expression=
446             ...as appropriate...)       ! Assume static allocation
447 \end{alltt}
448 \end{dwflisting}
449 \begin{center}
450
451 Figure~\ref{fig:fortranarrayexampledwarfdescription} Fortran array example: DWARF description \textit{(concluded)}
452 \end{center}
453 \end{figure}
454
455 Suppose 
456 \addtoindexx{Fortran array example}
457 the program is stopped immediately following completion
458 of the do loop. Suppose further that the user enters the
459 following debug command:
460
461 \begin{lstlisting}[numbers=none]
462 debug> print arrayvar(5)%ap(2)
463 \end{lstlisting}
464
465 Interpretation of this expression proceeds as follows:
466 \begin{enumerate}[1. ]
467
468 \item Lookup name \texttt{arrayvar}. We find that it is a variable,
469 whose type is given by the unnamed type at 6\$. Notice that
470 the type is an array type.
471
472
473 \item Find the 5$^{th}$ element of that array object. To do array
474 indexing requires several pieces of information:
475 \begin{enumerate}[a) ]
476
477 \item  the address of the array data
478
479 \item the lower bounds of the array \\
480 % Using plain [] here gives trouble.
481 \lbrack To check that 5 is within bounds would require the upper
482 bound too, but we will skip that for this example. \rbrack
483
484 \item the stride 
485
486 \end{enumerate}
487
488 For a), check for a 
489 \DWATdatalocation{} attribute. 
490 Since there is one, go execute the expression, whose result is
491 the address needed. The object address used in this case
492 is the object we are working on, namely the variable named
493 \texttt{arrayvar}, whose address was found in step 1. (Had there been
494 no \DWATdatalocation{} attribute, the desired address would
495 be the same as the address from step 1.)
496
497 For b), for each dimension of the array (only one
498 in this case), go interpret the usual lower bound
499 attribute. Again this is an expression, which again begins
500 with \DWOPpushobjectaddress. This object is 
501 \textbf{still} \texttt{arrayvar},
502 from step 1, because we have not begun to actually perform
503 any indexing yet.
504
505 For c), the default stride applies. Since there is no
506 \DWATbytestride{} attribute, use the size of the array element
507 type, which is the size of type \texttt{array\_ptr} (at 3\$).
508
509 \clearpage
510
511 Having acquired all the necessary data, perform the indexing
512 operation in the usual manner--which has nothing to do with
513 any of the attributes involved up to now. Those just provide
514 the actual values used in the indexing step.
515
516 The result is an object within the memory that was dynamically
517 allocated for \texttt{arrayvar}.
518
519 \item  Find the \texttt{ap} component of the object just identified,
520 whose type is \texttt{array\_ptr}.
521
522 This is a conventional record component lookup and
523 interpretation. It happens that the \texttt{ap} component in this case
524 begins at offset 4 from the beginning of the containing object.
525 Component \texttt{ap} has the unnamed array type defined at 1\$ in the
526 symbol table.
527
528 \item  Find the second element of the array object found in step 3. To do array indexing requires
529 several pieces of information:
530 \begin{enumerate}[a) ]
531 \item  the address of the array storage
532
533 \item  the lower bounds of the array \\
534 % Using plain [] here gives trouble.
535 \lbrack To check that 2 is within bounds we would require the upper
536 bound too, but we will skip that for this example \rbrack
537
538 \item  the stride
539
540 \end{enumerate}
541 \end{enumerate}
542
543 This is just like step 2), so the details are omitted. Recall
544 that because the DWARF type 1\$ has a \DWATdatalocation,
545 the address that results from step 4) is that of a
546 descriptor, and that address is the address pushed by the
547 \DWOPpushobjectaddress{} operations in 1\$ and 2\$.
548
549 Note: we happen to be accessing a pointer array here instead
550 of an allocatable array; but because there is a common
551 underlying representation, the mechanics are the same. There
552 could be completely different descriptor arrangements and the
553 mechanics would still be the same---only the stack machines
554 would be different.
555
556 %\needlines{8}
557 \subsection{Fortran Coarray Examples}
558 \label{app:Fortrancoarrayexamples}
559
560 \subsubsection{Fortran Scalar Coarray Example}
561 The \addtoindex{Fortran} scalar coarray example
562 \addtoindexx{coarray!example}\addtoindexx{scalar coarray|see{coarray}}
563 in Figure \refersec{fig:Fortranscalarcoarraysourcefragment} can be described as 
564 illustrated in Figure \refersec{fig:FortranscalarcoarrayDWARFdescription}.
565
566 \begin{figure}[!h]
567 \begin{lstlisting}
568         INTEGER X[*]
569 \end{lstlisting}
570 \caption{Fortran scalar coarray: source fragment}
571 \label{fig:Fortranscalarcoarraysourcefragment}
572 \end{figure}
573
574 \begin{figure}[!h]
575 \begin{dwflisting}
576 \begin{alltt}
577 10\$:  \DWTAGcoarraytype
578         \DWATtype(reference to INTEGER)
579         \DWTAGsubrangetype                ! Note omitted upper bound                    
580             \DWATlowerbound(constant 1)
581
582 11\$:  \DWTAGvariable
583         \DWATname("X")
584         \DWATtype(reference to coarray type at 10\$)
585 \end{alltt}
586 \end{dwflisting}
587 \caption{Fortran scalar coarray: DWARF description}
588 \label{fig:FortranscalarcoarrayDWARFdescription}
589 \end{figure}
590
591 \subsubsection{Fortran Array Coarray Example}
592 The \addtoindex{Fortran} (simple) array coarray example
593 \addtoindexx{coarray!example}\addtoindexx{array coarray|see{coarray}}
594 in Figure \refersec{fig:Fortranarraycoarraysourcefragment} can be described as 
595 illustrated in Figure \refersec{fig:FortranarraycoarrayDWARFdescription}.
596
597 \begin{figure}[here]
598 \begin{lstlisting}
599         INTEGER X(10)[*]
600 \end{lstlisting}
601 \caption{Fortran array coarray: source fragment}
602 \label{fig:Fortranarraycoarraysourcefragment}
603 \end{figure}
604
605 \begin{figure}[here]
606 \begin{dwflisting}
607 \begin{alltt}
608 10\$: \DWTAGarraytype
609         \DWATordering(\DWORDcolmajor)
610         \DWATtype(reference to INTEGER)
611 11\$:    \DWTAGsubrangetype
612             \DWATlowerbound(constant 1)
613             \DWATupperbound(constant 10)
614
615 12\$: \DWTAGcoarraytype
616         \DWATtype(reference to array type at 10\$)
617 13\$:    \DWTAGsubrangetype                ! Note omitted upper bound
618             \DWATlowerbound(constant 1)
619
620 14$: \DWTAGvariable
621         \DWATname("X")
622         \DWATtype(reference to coarray type at 12\$)
623 \end{alltt}
624 \end{dwflisting}
625 \caption{Fortran array coarray: DWARF description}
626 \label{fig:FortranarraycoarrayDWARFdescription}
627 \end{figure}
628
629 \subsubsection{Fortran Multidimensional Coarray Example}
630 The \addtoindex{Fortran} multidimensional coarray of a multidimensional array example
631 \addtoindexx{coarray!example}\addtoindexx{array coarray|see{coarray}}
632 in Figure \refersec{fig:Fortranmultidimensionalcoarraysourcefragment} can be described as 
633 illustrated in Figure \refersec{fig:FortranmultidimensionalcoarrayDWARFdescription}.
634
635 \begin{figure}[here]
636 \begin{lstlisting}
637         INTEGER X(10,11,12)[2,3,*]
638 \end{lstlisting}
639 \caption{Fortran multidimentional coarray: source fragment}
640 \label{fig:Fortranmultidimensionalcoarraysourcefragment}
641 \end{figure}
642
643 \begin{figure}[here]
644 \begin{dwflisting}
645 \begin{alltt}
646 10\$: \DWTAGarraytype
647         \DWATordering(\DWORDcolmajor)
648         \DWATtype(reference to INTEGER)
649 11\$:    \DWTAGsubrangetype
650             \DWATlowerbound(constant 1)
651             \DWATupperbound(constant 10)
652 12\$:    \DWTAGsubrangetype
653             \DWATlowerbound(constant  1)
654             \DWATupperbound(constant 11)
655 13\$:    \DWTAGsubrangetype
656             \DWATlowerbound(constant  1)
657             \DWATupperbound(constant 12)
658
659 14\$: \DWTAGcoarraytype
660         \DWATtype(reference to array_type at 10\$)
661 15\$:    \DWTAGsubrangetype
662             \DWATlowerbound(constant 1)
663             \DWATupperbound(constant 2)
664 16\$:    \DWTAGsubrangetype
665             \DWATlowerbound(constant 1)
666             \DWATupperbound(constant 3)
667 17\$:    \DWTAGsubrangetype                ! Note omitted upper bound
668             \DWATlowerbound(constant 1)
669
670 18\$: \DWTAGvariable
671         \DWATname("X")
672         \DWATtype(reference to coarray type at 14\$)
673 \end{alltt}
674 \end{dwflisting}
675 \caption{Fortran multidimensional coarray: DWARF description}
676 \label{fig:FortranmultidimensionalcoarrayDWARFdescription}
677 \end{figure}
678
679
680 \clearpage
681 \subsection{Fortran 2008 Assumed-rank Array Example}
682 \label{app:assumedrankexample}
683 \addtoindexx{array!assumed-rank}
684 Consider the example in Figure~\ref{fig:assumedrankdecl}, which shows
685 an assumed-rank array in Fortran~2008 with
686 supplement~29113:\footnote{Technical Specification ISO/IEC TS
687   29113:2012 \emph{Further Interoperability of Fortran with C}}
688
689 \begin{figure}[!h]
690 \begin{lstlisting}
691   subroutine foo(x)
692     real :: x(..)
693
694     ! x has n dimensions
695   
696   end subroutine
697 \end{lstlisting}
698 \caption{Declaration of a Fortran 2008 assumed-rank array}
699 \label{fig:assumedrankdecl}
700 \end{figure}
701
702 Let's assume the Fortran compiler used an array descriptor that
703 (in \addtoindex{C}) looks
704 like the one shown in Figure~\ref{fig:arraydesc}.
705
706 \begin{figure}[!h]
707 \begin{lstlisting}
708   struct array_descriptor {
709     void *base_addr;
710     int rank;
711     struct dim dims[]; 
712   }
713
714   struct dim {
715      int lower_bound;
716      int upper_bound;
717      int stride;
718      int flags;
719   }
720 \end{lstlisting}
721 \caption{One of many possible layouts for an array descriptor}
722 \label{fig:arraydesc}
723 \end{figure}
724
725 The DWARF type for the array \emph{x} can be described as shown in
726 Figure~\refersec{fig:assumedrankdwarf}.
727
728 \begin{figure}[!h]
729 \begin{dwflisting}
730 \begin{alltt}
731 10\$:  \DWTAGarraytype
732          \DWATtype(reference to real)
733          \DWATrank(expression=
734              \DWOPpushobjectaddress
735              \DWOPlitn                        ! offset of rank in descriptor
736              \DWOPplus
737              \DWOPderef)
738          \DWATdatalocation(expression=
739              \DWOPpushobjectaddress
740              \DWOPlitn                        ! offset of data in descriptor
741              \DWOPplus
742              \DWOPderef)
743 11\$:    \DWTAGgenericsubrange
744              \DWATtype(reference to integer)
745              \DWATlowerbound(expression=
746              !   Looks up the lower bound of dimension i.
747              !   Operation                       ! Stack effect
748              !   (implicit)                      ! i                                                                     
749                  \DWOPlitn                    ! i sizeof(dim)
750                  \DWOPmul                       ! dim[i]
751                  \DWOPlitn                    ! dim[i] offsetof(dim)
752                  \DWOPplus                      ! dim[i]+offset
753                  \DWOPpushobjectaddress       ! dim[i]+offsetof(dim) objptr
754                  \DWOPplus                      ! objptr.dim[i]
755                  \DWOPlitn                    ! objptr.dim[i] offsetof(lb)
756                  \DWOPplus                      ! objptr.dim[i].lowerbound
757                  \DWOPderef)                    ! *objptr.dim[i].lowerbound
758              \DWATupperbound(expression=
759              !   Looks up the upper bound of dimension i.
760                  \DWOPlitn                    ! sizeof(dim)
761                  \DWOPmul
762                  \DWOPlitn                    ! offsetof(dim)
763                  \DWOPplus
764                  \DWOPpushobjectaddress
765                  \DWOPplus
766                  \DWOPlitn                    ! offset of upperbound in dim
767                  \DWOPplus
768                  \DWOPderef)
769              \DWATbytestride(expression=
770              !   Looks up the byte stride of dimension i.
771                  ...
772              !   (analogous to \DWATupperboundNAME)
773                  )
774 \end{alltt}
775 \end{dwflisting}
776 \caption{Sample DWARF for the array descriptor in Figure~\ref{fig:arraydesc}}
777 \label{fig:assumedrankdwarf}
778 \end{figure}
779
780 The layout of the array descriptor is not specified by the Fortran
781 standard unless the array is explicitly marked as \addtoindex{C-interoperable}. To
782 get the bounds of an assumed-rank array, the expressions in the
783 \DWTAGgenericsubrange{}
784 entry need to be evaluated for each of the
785 \DWATrank{} dimensions as shown by the pseudocode in
786 Figure~\refersec{fig:assumedrankdwarfparser}.
787
788 \begin{figure}[!h]
789 \begin{lstlisting}
790     typedef struct {
791         int lower, upper, stride;
792     } dims_t;
793
794     typedef struct {
795         int rank;
796     struct dims_t *dims;
797     } array_t;
798
799     array_t get_dynamic_array_dims(DW_TAG_array a) {
800       array_t result;
801
802       // Evaluate the DW_AT_rank expression to get the 
803       //    number of dimensions.
804       dwarf_stack_t stack;
805       dwarf_eval(stack, a.rank_expr);
806       result.rank = dwarf_pop(stack); 
807       result.dims = new dims_t[rank];
808
809       // Iterate over all dimensions and find their bounds.
810       for (int i = 0; i < result.rank; i++) {
811         // Evaluate the generic subrange's DW_AT_lower 
812         //    expression for dimension i.
813         dwarf_push(stack, i);
814         assert( stack.size == 1 );
815         dwarf_eval(stack, a.generic_subrange.lower_expr);
816         result.dims[i].lower = dwarf_pop(stack);
817         assert( stack.size == 0 );
818
819         dwarf_push(stack, i);
820         dwarf_eval(stack, a.generic_subrange.upper_expr);
821         result.dims[i].upper = dwarf_pop(stack);
822     
823         dwarf_push(stack, i);
824         dwarf_eval(stack, a.generic_subrange.byte_stride_expr);
825         result.dims[i].stride = dwarf_pop(stack);
826       }
827       return result;
828     }
829 \end{lstlisting}
830 \caption{How to interpret the DWARF from Figure~\ref{fig:assumedrankdwarf}}
831 \label{fig:assumedrankdwarfparser}
832 \end{figure}
833
834
835
836 \clearpage
837 \subsection{Ada Example}
838 \label{app:adaexample}
839 Figure \refersec{fig:adaexamplesourcefragment}
840 illustrates two kinds of \addtoindex{Ada} 
841 parameterized array, one embedded in a record.
842
843 \begin{figure}[here]
844 \begin{lstlisting}
845 M : INTEGER := <exp>;
846 VEC1 : array (1..M) of INTEGER;
847 subtype TEENY is INTEGER range 1..100;
848 type ARR is array (INTEGER range <>) of INTEGER;
849 type REC2(N : TEENY := 100) is record
850     VEC2 : ARR(1..N);
851 end record;
852
853 OBJ2B : REC2;
854 \end{lstlisting}
855 \caption{Ada example: source fragment}
856 \label{fig:adaexamplesourcefragment}
857 \end{figure}
858
859 \texttt{VEC1} illustrates an (unnamed) array type where the upper bound
860 of the first and only dimension is determined at runtime. 
861 \addtoindex{Ada}
862 semantics require that the value of an array bound is fixed at
863 the time the array type is elaborated (where \textit{elaboration} refers
864 to the runtime executable aspects of type processing). For
865 the purposes of this example, we assume that there are no
866 other assignments to \texttt{M} so that it safe for the \texttt{REC1} type
867 description to refer directly to that variable (rather than
868 a compiler-generated copy).
869
870 \texttt{REC2} illustrates another array type (the unnamed type of
871 component \texttt{VEC2}) where the upper bound of the first and only
872 bound is also determined at runtime. In this case, the upper
873 bound is contained in a discriminant of the containing record
874 type. (A \textit{discriminant} is a component of a record whose value
875 cannot be changed independently of the rest of the record
876 because that value is potentially used in the specification
877 of other components of the record.)
878
879 The DWARF description is shown in 
880 Figure \refersec{fig:adaexampledwarfdescription}.
881
882
883 Interesting aspects about this example are:
884 \begin{enumerate}[1. ]
885 \item The array \texttt{VEC2} is \doublequote{immediately} contained within structure
886 \texttt{REC2} (there is no intermediate descriptor or indirection),
887 which is reflected in the absence of a \DWATdatalocation{}
888 attribute on the array type at 28\$.
889
890 \item One of the bounds of \texttt{VEC2} is nonetheless dynamic and part of
891 the same containing record. It is described as a reference to
892 a member, and the location of the upper bound is determined
893 as for any member. That is, the location is determined using
894 an address calculation relative to the base of the containing
895 object.  
896
897 A consumer must notice that the referenced bound is a
898 member of the same containing object and implicitly push the
899 base address of the containing object just as for accessing
900 a data member generally.
901
902 \item The lack of a subtype concept in DWARF means that DWARF types
903 serve the role of subtypes and must replicate information from
904 what should be the parent type. For this reason, DWARF for
905 the unconstrained array type \texttt{ARR} is not needed for the purposes
906 of this example and therefore is not shown.
907 \end{enumerate}
908
909 \begin{figure}[p]
910 \begin{dwflisting}
911 \begin{alltt}
912 11\$: \DWTAGvariable
913         \DWATname("M")
914         \DWATtype(reference to INTEGER)
915 12\$: \DWTAGarraytype
916         ! No name, default (\addtoindex{Ada}) order, default stride
917         \DWATtype(reference to INTEGER)
918 13\$:    \DWTAGsubrangetype
919             \DWATtype(reference to INTEGER)
920             \DWATlowerbound(constant 1)
921             \DWATupperbound(reference to variable M at 11\$)
922 14\$: \DWTAGvariable
923         \DWATname("VEC1")
924         \DWATtype(reference to array type at 12\$)
925      . . .
926 21\$: \DWTAGsubrangetype
927         \DWATname("TEENY")
928         \DWATtype(reference to INTEGER)
929         \DWATlowerbound(constant 1)
930         \DWATupperbound(constant 100)
931      . . .
932 26\$: \DWTAGstructuretype
933         \DWATname("REC2")
934 27\$:    \DWTAGmember
935             \DWATname("N")
936             \DWATtype(reference to subtype TEENY at 21\$)
937             \DWATdatamemberlocation(constant 0)
938 28\$:    \DWTAGarraytype
939             ! No name, default (\addtoindex{Ada}) order, default stride
940             ! Default data location
941             \DWATtype(reference to INTEGER)
942 29\$:        \DWTAGsubrangetype
943                 \DWATtype(reference to subrange TEENY at 21\$)
944                 \DWATlowerbound(constant 1)
945                 \DWATupperbound(reference to member N at 27\$)
946 30\$:    \DWTAGmember
947             \DWATname("VEC2")
948             \DWATtype(reference to array "subtype" at 28\$)
949             \DWATdatamemberlocation(machine=
950                 \DWOPlitn                  ! where n == offset(REC2, VEC2)
951                 \DWOPplus)
952      . . .
953 41\$: \DWTAGvariable
954         \DWATname("OBJ2B")
955         \DWATtype(reference to REC2 at 26\$)
956         \DWATlocation(...as appropriate...)
957 \end{alltt}
958 \end{dwflisting}
959 \caption{Ada example: DWARF description}
960 \label{fig:adaexampledwarfdescription}
961 \end{figure}
962
963 \clearpage
964
965 \subsection{Pascal Example}
966 \label{app:pascalexample}
967 The Pascal \addtoindexx{Pascal example} source in 
968 Figure \referfol{fig:packedrecordexamplesourcefragment}
969 is used to illustrate the representation of packed unaligned
970 \addtoindex{bit fields}.
971
972 \begin{figure}[here]
973 \begin{lstlisting}
974 TYPE T : PACKED RECORD                  ! bit size is 2
975          F5 : BOOLEAN;                  ! bit offset is 0
976          F6 : BOOLEAN;                  ! bit offset is 1
977          END;
978 VAR V :  PACKED RECORD
979          F1 : BOOLEAN;                  ! bit offset is 0
980          F2 : PACKED RECORD             ! bit offset is 1
981               F3 : INTEGER;             ! bit offset is 0 in F2, 1 in V
982               END;
983          F4 : PACKED ARRAY [0..1] OF T; ! bit offset is 33
984          F7 : T;                        ! bit offset is 37
985          END;
986 \end{lstlisting}
987 \caption{Packed record example: source fragment}
988 \label{fig:packedrecordexamplesourcefragment}
989 \end{figure}
990
991 The DWARF representation in 
992 Figure \refersec{fig:packedrecordexampledwarfdescription} 
993 is appropriate. 
994 \DWTAGpackedtype{} entries could be added to
995 better represent the source, but these do not otherwise affect
996 the example and are omitted for clarity. Note that this same
997 representation applies to both typical big\dash \ and 
998 little\dash endian
999 architectures using the conventions described in 
1000 Section \refersec{chap:datamemberentries}.
1001
1002 \begin{figure}[h]
1003 \figurepart{1}{2}
1004 \begin{dwflisting}
1005 \begin{alltt}
1006 10\$: \DWTAGbasetype
1007         \DWATname("BOOLEAN")
1008             ...
1009 11\$: \DWTAGbasetype
1010         \DWATname("INTEGER")
1011             ...
1012 20\$: \DWTAGstructuretype
1013         \DWATname("T")
1014         \DWATbitsize(2)
1015         \DWTAGmember
1016             \DWATname("F5")
1017             \DWATtype(reference to 10$)
1018             \DWATdatabitoffset(0)        ! may be omitted
1019             \DWATbitsize(1)
1020 \end{alltt}
1021 \end{dwflisting}
1022 \caption{Packed record example: DWARF description}
1023 \label{fig:packedrecordexampledwarfdescription}
1024 \end{figure}
1025
1026 \begin{figure}[h]
1027 \figurepart{2}{2}
1028 \begin{dwflisting}
1029 \begin{alltt}
1030         \DWTAGmember
1031             \DWATname("F6")
1032             \DWATtype(reference to 10$)
1033             \DWATdatabitoffset(1)
1034             \DWATbitsize(1)
1035 21\$: \DWTAGstructuretype                  ! anonymous type for F2
1036         \DWTAGmember
1037             \DWATname("F3")
1038             \DWATtype(reference to 11\$)
1039 22\$: \DWTAGarraytype                      ! anonymous type for F4
1040         \DWATtype(reference to 20\$)
1041         \DWTAGsubrangetype
1042             \DWATtype(reference to 11\$)
1043             \DWATlowerbound(0)
1044             \DWATupperbound(1)
1045         \DWATbitstride(2)
1046         \DWATbitsize(4) \addtoindexx{bit size attribute}
1047 23\$: \DWTAGstructuretype                  ! anonymous type for V
1048         \DWATbitsize(39) \addtoindexx{bit size attribute}
1049         \DWTAGmember
1050             \DWATname("F1")
1051             \DWATtype(reference to 10\$)
1052             \DWATdatabitoffset(0)        ! may be omitted
1053             \DWATbitsize(1) ! may be omitted
1054         \DWTAGmember
1055             \DWATname("F2")
1056             \DWATtype(reference to 21\$)
1057             \DWATdatabitoffset(1)
1058             \DWATbitsize(32) ! may be omitted
1059         \DWTAGmember
1060             \DWATname("F4")
1061             \DWATtype(reference to 22\$)
1062             \DWATdatabitoffset(33)
1063             \DWATbitsize(4) ! may be omitted
1064         \DWTAGmember
1065             \DWATname("F7")
1066             \DWATtype(reference to 20\$)    ! type T
1067             \DWATdatabitoffset(37)
1068             \DWATbitsize(2) \addtoindexx{bit size attribute}              ! may be omitted
1069      \DWTAGvariable
1070         \DWATname("V")
1071         \DWATtype(reference to 23\$)
1072         \DWATlocation(...)
1073         ...
1074 \end{alltt}
1075 \end{dwflisting}
1076 \begin{center}
1077 Figure~\ref{fig:packedrecordexampledwarfdescription}: Packed record example: DWARF description \textit{(concluded)}
1078 \end{center}
1079 \end{figure}
1080
1081 \clearpage
1082 \subsection{Fortran Dynamic Type Example}
1083 \label{app:fortrandynamictypeexample}
1084 Consider the \addtoindex{Fortran 90} example of dynamic properties in 
1085 Figure \refersec{fig:fortrandynamictypeexamplesource}.
1086 This can be represented in DWARF as illustrated in 
1087 Figure \refersec{fig:fortrandynamictypeexampledwarfdescription}.
1088 Note that unnamed dynamic types are used to avoid replicating
1089 the full description of the underlying type \texttt{dt} that is shared by
1090 several variables.
1091
1092 \begin{figure}[h]
1093 \begin{lstlisting}
1094             program sample
1095      
1096         type :: dt (l)
1097             integer, len :: l
1098             integer :: arr(l)
1099         end type
1100
1101         integer :: n = 4
1102         contains
1103
1104         subroutine s()
1105             type (dt(n))               :: t1
1106             type (dt(n)), pointer      :: t2
1107             type (dt(n)), allocatable  :: t3, t4
1108         end subroutine
1109      
1110         end sample
1111 \end{lstlisting}
1112 \caption{Fortran dynamic type example: source}
1113 \label{fig:fortrandynamictypeexamplesource}
1114 \end{figure}
1115
1116 \begin{figure}[h]
1117 \begin{dwflisting}
1118 \begin{alltt}
1119 11$:    \DWTAGstructuretype
1120             \DWATname("dt")
1121             \DWTAGmember
1122                 ...
1123                         ...
1124
1125 13$:    \DWTAGdynamictype             ! plain version
1126             \DWATdatalocation (dwarf expression to locate raw data)
1127             \DWATtype (11$)
1128
1129 14$:    \DWTAGdynamictype             ! 'pointer' version
1130             \DWATdatalocation (dwarf expression to locate raw data)
1131             \DWATassociated (dwarf expression to test if associated)
1132             \DWATtype (11$)
1133
1134 15$:    \DWTAGdynamictype             ! 'allocatable' version
1135             \DWATdatalocation (dwarf expression to locate raw data)
1136             \DWATallocated (dwarf expression to test is allocated)
1137             \DWATtype (11$)
1138
1139 16$:    \DWTAGvariable
1140             \DWATname ("t1")
1141             \DWATtype (13$)
1142             \DWATlocation (dwarf expression to locate descriptor)
1143 17$:    \DWTAGvariable
1144             \DWATname ("t2")
1145             \DWATtype (14$)
1146             \DWATlocation (dwarf expression to locate descriptor)
1147 18$:    \DWTAGvariable
1148             \DWATname ("t3")
1149             \DWATtype (15$)
1150             \DWATlocation (dwarf expression to locate descriptor)
1151 19$:    \DWTAGvariable
1152             \DWATname ("t4")
1153             \DWATtype (15$)
1154             \DWATlocation (dwarf expression to locate descriptor)
1155 \end{alltt}
1156 \end{dwflisting}
1157 \caption{Fortran dynamic type example: DWARF description}
1158 \label{fig:fortrandynamictypeexampledwarfdescription}
1159 \end{figure}
1160
1161 \clearpage
1162 \section{Namespace Example}
1163 \label{app:namespaceexample}
1164
1165 The \addtoindex{C++} example in 
1166 Figure \refersec{fig:namespaceexamplesourcefragment}
1167 is used 
1168 \addtoindexx{namespace (C++)!example}
1169 to illustrate the representation of namespaces.
1170 The DWARF representation in 
1171 Figure \refersec{fig:namespaceexampledwarfdescription}
1172 is appropriate.
1173
1174 \begin{figure}[h]
1175 \begin{lstlisting}
1176 namespace {
1177     int i;
1178 }
1179 namespace A {
1180     namespace B {
1181         int j;
1182         int   myfunc (int a);
1183         float myfunc (float f) { return f - 2.0; }
1184         int   myfunc2(int a)   { return a + 2; }
1185     }
1186 }
1187 namespace Y {
1188     using A::B::j;         // (1) using declaration
1189     int foo;
1190 }
1191 using A::B::j;             // (2) using declaration
1192 namespace Foo = A::B;      // (3) namespace alias
1193 using Foo::myfunc;         // (4) using declaration
1194 using namespace Foo;       // (5) using directive
1195 namespace A {
1196     namespace B {
1197         using namespace Y; // (6) using directive
1198         int k;
1199     }
1200 }
1201 int Foo::myfunc(int a)
1202 {
1203     i = 3;
1204     j = 4;
1205     return myfunc2(3) + j + i + a + 2;
1206 }
1207 \end{lstlisting}
1208 \caption{Namespace example: source fragment}
1209 \label{fig:namespaceexamplesourcefragment}
1210 \end{figure}
1211
1212
1213 \begin{figure}[p]
1214 \figurepart{1}{2}
1215 \begin{dwflisting}
1216 \begin{alltt}
1217
1218 1\$:  \DWTAGbasetype
1219         \DWATname("int")
1220         ...
1221 2\$:  \DWTAGbasetype
1222         \DWATname("float")
1223         ...
1224 6\$:  \DWTAGnamespace
1225         ! no \DWATname attribute
1226 7\$:
1227         \DWTAGvariable
1228             \DWATname("i")
1229             \DWATtype(reference to 1\$)
1230             \DWATlocation ...
1231             ...
1232 10\$: \DWTAGnamespace
1233         \DWATname("A")
1234 20\$:    \DWTAGnamespace
1235             \DWATname("B")
1236 30\$:        \DWTAGvariable
1237                 \DWATname("j")
1238                 \DWATtype(reference to 1\$)
1239                 \DWATlocation ...
1240                 ...
1241 34\$:        \DWTAGsubprogram
1242                 \DWATname("myfunc")
1243                 \DWATtype(reference to 1\$)
1244                 ...
1245 36\$:        \DWTAGsubprogram
1246                 \DWATname("myfunc")
1247                 \DWATtype(reference to 2\$)
1248                 ...
1249 38\$:        \DWTAGsubprogram
1250                 \DWATname("myfunc2")
1251                 \DWATlowpc ...
1252                 \DWAThighpc ...
1253                 \DWATtype(reference to 1\$)
1254                 ...
1255 \end{alltt}
1256 \end{dwflisting}
1257 \caption{Namespace example: DWARF description}
1258 \label{fig:namespaceexampledwarfdescription}
1259 \end{figure}
1260
1261 \begin{figure}
1262 \figurepart{2}{2}
1263 \begin{dwflisting}
1264 \begin{alltt}
1265 40\$: \DWTAGnamespace
1266         \DWATname("Y")
1267         \DWTAGimporteddeclaration            ! (1) using-declaration
1268             \DWATimport(reference to 30\$)
1269         \DWTAGvariable
1270             \DWATname("foo")
1271             \DWATtype(reference to 1\$)
1272             \DWATlocation ...
1273             ...
1274      \DWTAGimporteddeclaration               ! (2) using declaration
1275         \DWATimport(reference to 30\$)
1276         \DWTAGimporteddeclaration            ! (3) namespace alias
1277             \DWATname("Foo")
1278             \DWATimport(reference to 20\$)
1279         \DWTAGimporteddeclaration            ! (4) using declaration
1280             \DWATimport(reference to 34\$)     !     - part 1
1281         \DWTAGimporteddeclaration            ! (4) using declaration
1282             \DWATimport(reference to 36\$)     !     - part 2
1283         \DWTAGimportedmodule                 ! (5) using directive
1284             \DWATimport(reference to 20\$)
1285         \DWTAGnamespace
1286             \DWATextension(reference to 10\$)
1287             \DWTAGnamespace
1288                 \DWATextension(reference to 20\$)
1289                 \DWTAGimportedmodule         ! (6) using directive
1290                     \DWATimport(reference to 40\$)
1291                 \DWTAGvariable
1292                     \DWATname("k")
1293                     \DWATtype(reference to 1\$)
1294                     \DWATlocation ...
1295                     ...
1296 60\$: \DWTAGsubprogram
1297         \DWATspecification(reference to 34\$)
1298         \DWATlowpc ...
1299         \DWAThighpc ...
1300         ...
1301 \end{alltt}
1302 \end{dwflisting}
1303 \begin{center}
1304 Figure~\ref{fig:namespaceexampledwarfdescription}: Namespace example: DWARF description \textit{(concluded)}
1305 \end{center}
1306 \end{figure}
1307
1308 \clearpage
1309 \section{Member Function Example}
1310 \label{app:memberfunctionexample}
1311
1312 Consider the member function example fragment in 
1313 Figure \refersec{fig:memberfunctionexamplesourcefragment}.
1314 The DWARF representation in 
1315 Figure \refersec{fig:memberfunctionexampledwarfdescription}
1316 is appropriate.
1317
1318 \begin{figure}[h]
1319 \begin{lstlisting}
1320 class A
1321 {
1322     void func1(int x1);
1323     void func2() const;
1324     static void func3(int x3);
1325 };
1326 void A::func1(int x) {}
1327 \end{lstlisting}
1328 \caption{Member function example: source fragment}
1329 \label{fig:memberfunctionexamplesourcefragment}
1330 \end{figure}
1331
1332 \begin{figure}[h]
1333 \figurepart{1}{2}
1334 \begin{dwflisting}
1335 \begin{alltt}
1336 1\$: \DWTAGunspecifiedtype
1337         \DWATname("void")
1338                 ...
1339 2\$: \DWTAGbasetype
1340         \DWATname("int")
1341         ...
1342 3\$: \DWTAGclasstype
1343         \DWATname("A")
1344         ...
1345 4\$:    \DWTAGpointertype
1346             \DWATtype(reference to 3\$)
1347             ...
1348 5\$:    \DWTAGconsttype
1349             \DWATtype(reference to 3\$)
1350             ...
1351 6\$:    \DWTAGpointertype
1352             \DWATtype(reference to 5\$)
1353             ...
1354
1355 7\$:    \DWTAGsubprogram
1356             \DWATdeclaration
1357             \DWATname("func1")
1358             \DWATtype(reference to 1\$)
1359             \DWATobjectpointer(reference to 8\$) \addtoindexx{object pointer attribute}
1360                 ! References a formal parameter in this 
1361                 ! member function
1362             ...
1363 \end{alltt}
1364 \end{dwflisting}
1365 \caption{Member function example: DWARF description}
1366 \label{fig:memberfunctionexampledwarfdescription}
1367 \end{figure}
1368
1369 \begin{figure}[p]
1370 \figurepart{2}{2}
1371 \begin{dwflisting}
1372 \begin{alltt}
1373 8\$:        \DWTAGformalparameter
1374                 \DWATartificial(true)
1375                 \DWATname("this")
1376                 \DWATtype(reference to 4\$)
1377                     ! Makes type of 'this' as 'A*' =>
1378                     ! func1 has not been marked const 
1379                     ! or volatile
1380                 \DWATlocation ...
1381                 ...
1382 9\$:        \DWTAGformalparameter
1383                 \DWATname(x1)
1384                 \DWATtype(reference to 2\$)
1385                 ...
1386 10\$:    \DWTAGsubprogram
1387              \DWATdeclaration
1388              \DWATname("func2")
1389              \DWATtype(reference to 1\$)
1390              \DWATobjectpointer(reference to 11\$) \addtoindexx{object pointer attribute}
1391              ! References a formal parameter in this 
1392              ! member function
1393              ...
1394 11\$:        \DWTAGformalparameter
1395                  \DWATartificial(true)
1396                  \DWATname("this")
1397                  \DWATtype(reference to 6\$)
1398                  ! Makes type of 'this' as 'A const*' =>
1399                  !     func2 marked as const
1400                  \DWATlocation ...
1401                  ...
1402 12\$:    \DWTAGsubprogram
1403              \DWATdeclaration
1404              \DWATname("func3")
1405              \DWATtype(reference to 1\$)
1406              ...
1407                  ! No object pointer reference formal parameter
1408                  ! implies func3 is static
1409 13\$:        \DWTAGformalparameter
1410                  \DWATname(x3)
1411                  \DWATtype(reference to 2\$)
1412                  ...
1413 \end{alltt}
1414 \end{dwflisting}
1415 \begin{center}
1416 Figure~\ref{fig:memberfunctionexampledwarfdescription}: Member function example: DWARF description \textit{(concluded)}
1417 \end{center}
1418 \end{figure}
1419
1420 \clearpage
1421 \section{Line Number Program Example}
1422 \label{app:linenumberprogramexample}
1423
1424 Consider the simple source file and the resulting machine
1425 code for the Intel 8086 processor in 
1426 Figure \refersec{fig:linenumberprogramexamplemachinecode}.
1427
1428 \begin{figure}[here]
1429 \begin{lstlisting}
1430 1: int
1431 2: main()
1432     0x239: push pb
1433     0x23a: mov bp,sp
1434 3: {
1435 4: printf("Omit needless words\n");
1436     0x23c: mov ax,0xaa
1437     0x23f: push ax
1438     0x240: call _printf
1439     0x243: pop cx
1440 5: exit(0);
1441     0x244: xor ax,ax
1442     0x246: push ax
1443     0x247: call _exit
1444     0x24a: pop cx
1445 6: }
1446     0x24b: pop bp
1447     0x24c: ret
1448 7: 0x24d:
1449 \end{lstlisting}
1450 \caption{Line number program example: machine code}
1451 \label{fig:linenumberprogramexamplemachinecode}
1452 \end{figure}
1453
1454 Suppose the line number program header includes the following
1455 (header fields not needed 
1456 \addtoindexx{line\_base}
1457 below 
1458 \addtoindexx{line\_range}
1459 are 
1460 \addtoindexx{opcode\_base}
1461 not 
1462 \addtoindexx{minumum\_instruction\_length}
1463 shown):
1464 \begin{alltt}
1465     version                       4
1466     minimum_instruction_length    1
1467     opcode_base                  10   ! Opcodes 10-12 not needed
1468     line_base                     1
1469     line_range                   15
1470 \end{alltt}
1471
1472
1473 Table \refersec{tab:linenumberprogramexampleoneencoding}
1474 shows one encoding of the line number program, which occupies
1475 12 bytes (the opcode SPECIAL(\textit{m},\textit{n}) indicates the special opcode
1476 generated for a line increment of \textit{m} and an address increment
1477 of \textit{n}).
1478
1479 \newpage
1480 \begin{centering}
1481 \setlength{\extrarowheight}{0.1cm}
1482 \begin{longtable}{l|l|l}
1483   \caption{Line number program example: one \mbox{encoding}}
1484   \label{tab:linenumberprogramexampleoneencoding} \\
1485   \hline \bfseries Opcode &\bfseries Operand &\bfseries Byte Stream \\ \hline
1486 \endfirsthead
1487   \bfseries Opcode &\bfseries Operand &\bfseries Byte Stream\\ \hline
1488 \endhead
1489   \hline \emph{Continued on next page}
1490 \endfoot
1491   \hline
1492 \endlastfoot
1493 \DWLNSadvancepc&LEB128(0x239)&0x2, 0xb9, 0x04 \\
1494 SPECIAL(2, 0)& &0xb  \\
1495 SPECIAL(2, 3)& &0x38 \\
1496 SPECIAL(1, 8)& &0x82 \\
1497 SPECIAL(1, 7)& &0x73 \\
1498 \DWLNSadvancepc&LEB128(2)&0x2, 0x2 \\
1499 \DWLNEendsequence{} &&0x0, 0x1, 0x1 \\
1500 \end{longtable}
1501 \end{centering}
1502
1503
1504 Table \refersec{tab:linenumberprogramexamplealternateencoding}
1505 shows an alternate 
1506 encoding of the same program using 
1507 standard opcodes to advance
1508 the program counter; 
1509 this encoding occupies 22 bytes.
1510
1511 \begin{centering}
1512 \setlength{\extrarowheight}{0.1cm}
1513 \begin{longtable}{l|l|l}
1514   \caption{Line number program example: alternate encoding} 
1515   \label{tab:linenumberprogramexamplealternateencoding} \\
1516   \hline \bfseries Opcode &\bfseries Operand &\bfseries Byte Stream \\ \hline
1517 \endfirsthead
1518   \bfseries Opcode &\bfseries Operand &\bfseries Byte Stream\\ \hline
1519 \endhead
1520   \hline \emph{Continued on next page}
1521 \endfoot
1522   \hline
1523 \endlastfoot
1524 \DWLNSfixedadvancepc&0x239&0x9, 0x39, 0x2        \\
1525 SPECIAL(2, 0)&& 0xb        \\
1526 \DWLNSfixedadvancepc&0x3&0x9, 0x3, 0x0        \\
1527 SPECIAL(2, 0)&&0xb        \\
1528 \DWLNSfixedadvancepc&0x8&0x9, 0x8, 0x0        \\
1529 SPECIAL(1, 0)&& 0xa        \\
1530 \DWLNSfixedadvancepc&0x7&0x9, 0x7, 0x0        \\
1531 SPECIAL(1, 0) && 0xa        \\
1532 \DWLNSfixedadvancepc&0x2&0x9, 0x2, 0x0        \\
1533 \DWLNEendsequence&&0x0, 0x1, 0x1        \\
1534 \end{longtable}
1535 \end{centering}
1536
1537 \needlines{6}
1538 \section{Call Frame Information Example}
1539 \label{app:callframeinformationexample}
1540
1541 The following example uses a hypothetical RISC machine in
1542 the style of the Motorola 88000.
1543 \begin{itemize}
1544 \item Memory is byte addressed.
1545
1546 \item Instructions are all 4 bytes each and word aligned.
1547
1548 \item Instruction operands are typically of the form:
1549 \begin{alltt}
1550     <destination.reg>, <source.reg>, <constant>
1551 \end{alltt}
1552
1553 \item The address for the load and store instructions is computed
1554 by adding the contents of the
1555 source register with the constant.
1556
1557 \item There are eight 4\dash byte registers:
1558 \newline
1559 \begin{tabular}{p{5mm}l}
1560    & R0 always 0 \\
1561    & R1 holds return address on call \\
1562    & R2-R3 temp registers (not preserved on call) \\
1563    & R4-R6 preserved on call \\
1564    & R7 stack pointer \\
1565 \end{tabular}
1566
1567 \item  The stack grows in the negative direction.
1568
1569 \item The architectural ABI committee specifies that the
1570 stack pointer (R7) is the same as the CFA
1571
1572 \end{itemize}
1573
1574 Figure \referfol{fig:callframeinformationexamplemachinecodefragments}
1575 shows two code fragments from a subroutine called
1576 foo that uses a frame pointer (in addition to the stack
1577 pointer). The first column values are byte addresses. 
1578 % The \space is so we get a space after >
1579 \textless fs\textgreater\ denotes the stack frame size in bytes, namely 12.
1580
1581
1582 \begin{figure}[here]
1583 \begin{lstlisting}
1584        ;; start prologue
1585 foo    sub   R7, R7, <fs>        ; Allocate frame
1586 foo+4  store R1, R7, (<fs>-4)    ; Save the return address
1587 foo+8  store R6, R7, (<fs>-8)    ; Save R6
1588 foo+12 add   R6, R7, 0           ; R6 is now the Frame ptr
1589 foo+16 store R4, R6, (<fs>-12)   ; Save a preserved reg
1590        ;; This subroutine does not change R5
1591        ...
1592        ;; Start epilogue (R7 is returned to entry value)
1593 foo+64 load  R4, R6, (<fs>-12)   ; Restore R4
1594 foo+68 load  R6, R7, (<fs>-8)    ; Restore R6
1595 foo+72 load  R1, R7, (<fs>-4)    ; Restore return address
1596 foo+76 add   R7, R7, <fs>        ; Deallocate frame
1597 foo+80 jump  R1                  ; Return
1598 foo+84
1599 \end{lstlisting}
1600 \caption{Call frame information example: machine code fragments}
1601 \label{fig:callframeinformationexamplemachinecodefragments}
1602 \end{figure}
1603
1604
1605 An abstract table 
1606 (see Section \refersec{chap:structureofcallframeinformation}) 
1607 for the foo subroutine is shown in 
1608 Table \referfol{tab:callframeinformationexampleconceptualmatrix}.
1609 Corresponding fragments from the
1610 \dotdebugframe{} section are shown in 
1611 Table \refersec{tab:callframeinformationexamplecommoninformationentryencoding}.
1612
1613 The following notations apply in 
1614 Table \refersec{tab:callframeinformationexampleconceptualmatrix}:
1615 \newline
1616 \begin{tabular}{p{5mm}l}
1617 &1.  R8 is the return address \\
1618 &2.  s = same\_value rule \\
1619 &3.  u = undefined rule \\
1620 &4.  rN = register(N) rule \\
1621 &5.  cN = offset(N) rule \\
1622 &6.  a = architectural rule \\
1623 \end{tabular}
1624
1625 \begin{centering}
1626 \setlength{\extrarowheight}{0.1cm}
1627 \begin{longtable}{l|llllllllll}
1628   \caption{Call frame information example: conceptual matrix} 
1629   \label{tab:callframeinformationexampleconceptualmatrix} \\
1630   \hline \bfseries Location & \bfseries CFA & \bfseries R0 & \bfseries R1 & \bfseries R2 & \bfseries R3 & \bfseries R4 & \bfseries R5 & \bfseries R6 & \bfseries R7 & \bfseries R8 \\ \hline
1631 \endfirsthead
1632   \bfseries Location &\bfseries CFA &\bfseries R0 & \bfseries R1 & \bfseries R2 &\bfseries R3 &\bfseries R4 &\bfseries R5 &\bfseries R6 &\bfseries R7 &\bfseries R8\\ \hline
1633 \endhead
1634   \hline \emph{Continued on next page}
1635 \endfoot
1636   \hline
1637 \endlastfoot
1638 foo&[R7]+0&s&u&u&u&s&s&s&a&r1 \\
1639 foo+4&[R7]+fs&s&u&u&u&s&s&s&a&r1 \\
1640 foo+8&[R7]+fs&s&u&u&u&s&s&s&a&c-4 \\
1641 foo+12&[R7]+fs&s&u&u&u&s&s&c-8&a&c-4 \\
1642 foo+16&[R6]+fs&s&u&u&u&s&s&c-8&a&c-4 \\
1643 foo+20&[R6]+fs&s&u&u&u&c-12&s&c-8&a&c-4 \\
1644 ...&&&&&&&&&& \\
1645 foo+64&[R6]+fs&s&u&u&u&c-12&s&c-8&a&c-4 \\
1646 foo+68&[R6]+fs&s&u&u&u&s&s&c-8&a&c-4  \\
1647 foo+72&[R7]+fs&s&u&u&u&s&s&s&a&c-4  \\
1648 foo+76&[R7]+fs&s&u&u&u&s&s&s&a&r1 \\
1649 foo+80&[R7]+0&s&u&u&u&s&s&s&a&r1 \\
1650 \end{longtable}
1651 \end{centering}
1652
1653 \clearpage      % ?????
1654
1655 \begin{centering}
1656 \setlength{\extrarowheight}{0.1cm}
1657 \begin{longtable}{l|ll}
1658   \caption{Call frame information example: common information entry encoding} 
1659   \label{tab:callframeinformationexamplecommoninformationentryencoding} 
1660   \\
1661   \hline \bfseries Address &\bfseries Value &\bfseries Comment \\ \hline
1662 \endfirsthead
1663   \bfseries Address &\bfseries Value &\bfseries Comment \\ \hline
1664 \endhead
1665   \hline \emph{Continued on next page}
1666 \endfoot
1667   \hline
1668 \endlastfoot
1669 cie&36&length    \\
1670 cie+4&\xffffffff&CIE\_id    \\
1671 cie+8&4&version    \\
1672 cie+9&0&augmentation     \\
1673 cie+10&4&address size    \\
1674 cie+11&0&segment size    \\
1675 cie+12&4&code\_alignment\_factor, \textless caf \textgreater    \\
1676 cie+13&-4&data\_alignment\_factor, \textless daf \textgreater    \\
1677 cie+14&8&R8 is the return addr.    \\
1678 cie+15&\DWCFAdefcfa{} (7, 0)&CFA = [R7]+0    \\
1679 cie+18&\DWCFAsamevalue{} (0)&R0 not modified (=0)    \\
1680 cie+20&\DWCFAundefined{} (1)&R1 scratch    \\
1681 cie+22&\DWCFAundefined{} (2)&R2 scratch    \\
1682 cie+24&\DWCFAundefined{} (3)&R3 scratch    \\
1683 cie+26&\DWCFAsamevalue{} (4)&R4 preserve    \\
1684 cie+28&\DWCFAsamevalue{} (5)&R5 preserve    \\
1685 cie+30&\DWCFAsamevalue{} (6)&R6 preserve    \\
1686 cie+32&\DWCFAsamevalue{} (7)&R7 preserve    \\
1687 cie+34&\DWCFAregister{} (8, 1)&R8 is in R1    \\
1688 cie+37&\DWCFAnop{} &padding    \\
1689 cie+38&\DWCFAnop{} &padding \\
1690 cie+39& \DWCFAnop&padding  \\
1691 cie+40 &&  \\
1692 \end{longtable}
1693 \end{centering}
1694
1695
1696 The following notations apply in 
1697 Table \refersec{tab:callframeinformationexampleframedescriptionentryencoding}:
1698 \newline
1699 \begin{tabular}{p{5mm}l}
1700 &\texttt{<fs>  =} frame size \\
1701 &\texttt{<caf> =} code alignment factor \\
1702 &\texttt{<daf> =} data alignment factor \\
1703 \end{tabular}
1704
1705
1706 \begin{centering}
1707 \setlength{\extrarowheight}{0.1cm}
1708 \begin{longtable}{l|ll}
1709   \caption{Call frame information example: frame description entry encoding} 
1710   \label{tab:callframeinformationexampleframedescriptionentryencoding} \\
1711   \hline \bfseries Address &\bfseries Value &\bfseries Comment \\ \hline
1712 \endfirsthead
1713   \bfseries Address &\bfseries Value &\bfseries Comment \\ \hline
1714 \endhead
1715   \hline \emph{Continued on next page}
1716 \endfoot
1717   \hline
1718 \endlastfoot
1719 fde&40&length \\
1720 fde+4&cie&CIE\_ptr \\
1721 fde+8&foo&initial\_location \\
1722 fde+12&84&address\_range \\
1723 fde+16&\DWCFAadvanceloc(1)&instructions \\
1724 fde+17&\DWCFAdefcfaoffset(12)& \textless fs\textgreater \\
1725 fde+19&\DWCFAadvanceloc(1)&4/\textless caf\textgreater \\
1726 fde+20&\DWCFAoffset(8,1)&-4/\textless daf\textgreater (2nd parameter) \\
1727 fde+22&\DWCFAadvanceloc(1)& \\
1728 fde+23&\DWCFAoffset(6,2)&-8/\textless daf\textgreater (2nd parameter)  \\
1729 fde+25&\DWCFAadvanceloc(1) & \\
1730 fde+26&\DWCFAdefcfaregister(6) & \\
1731 fde+28&\DWCFAadvanceloc(1) & \\
1732 fde+29&\DWCFAoffset(4,3)&-12/\textless daf\textgreater (2nd parameter) \\
1733 fde+31&\DWCFAadvanceloc(12)&44/\textless caf\textgreater \\
1734 fde+32&\DWCFArestore(4)& \\
1735 fde+33&\DWCFAadvanceloc(1) & \\
1736 fde+34&\DWCFArestore(6) & \\
1737 fde+35&\DWCFAdefcfaregister(7)  & \\
1738 fde+37&\DWCFAadvanceloc(1) & \\
1739 fde+38&\DWCFArestore(8) &\\
1740 fde+39&\DWCFAadvanceloc(1) &\\
1741 fde+40&\DWCFAdefcfaoffset(0)  &\\
1742 fde+42&\DWCFAnop&padding \\
1743 fde+43&\DWCFAnop&padding \\
1744 fde+44 && \\
1745 \end{longtable}
1746 \end{centering}
1747
1748 \section{Inlining Examples}
1749 \label{app:inliningexamples}
1750 The pseudo\dash source in 
1751 Figure \referfol{fig:inliningexamplespseudosourcefragment}
1752 is used to illustrate the
1753 \addtoindexx{inlined subprogram call!examples}
1754 use of DWARF to describe inlined subroutine calls. This
1755 example involves a nested subprogram \texttt{INNER} that makes uplevel
1756 references to the formal parameter and local variable of the
1757 containing subprogram \texttt{OUTER}.
1758
1759 \begin{figure}[here]
1760 \begin{lstlisting}
1761 inline procedure OUTER (OUTER_FORMAL : integer) =
1762     begin
1763     OUTER_LOCAL : integer;
1764     procedure INNER (INNER_FORMAL : integer) =
1765         begin
1766         INNER_LOCAL : integer;
1767         print(INNER_FORMAL + OUTER_LOCAL);
1768         end;
1769     INNER(OUTER_LOCAL);
1770     ...
1771     INNER(31);
1772     end;
1773 ! Call OUTER
1774 !
1775 OUTER(7);
1776 \end{lstlisting}
1777 \caption{Inlining examples: pseudo-source fragmment} 
1778 \label{fig:inliningexamplespseudosourcefragment}
1779 \end{figure}
1780
1781
1782 There are several approaches that a compiler might take to
1783 inlining for this sort of example. This presentation considers
1784 three such approaches, all of which involve inline expansion
1785 of subprogram \texttt{OUTER}. (If \texttt{OUTER} is not inlined, the inlining
1786 reduces to a simpler single level subset of the two level
1787 approaches considered here.)
1788
1789 The approaches are:
1790 \begin{enumerate}[1. ]
1791 \item  Inline both \texttt{OUTER} and \texttt{INNER} in all cases
1792
1793 \item Inline \texttt{OUTER}, multiple \texttt{INNER}s \\
1794 Treat \texttt{INNER} as a non\dash inlinable part of \texttt{OUTER}, compile and
1795 call a distinct normal version of \texttt{INNER} defined within each
1796 inlining of \texttt{OUTER}.
1797
1798 \item Inline \texttt{OUTER}, one \texttt{INNER} \\
1799 Compile \texttt{INNER} as a single normal subprogram which is called
1800 from every inlining of \texttt{OUTER}.
1801 \end{enumerate}
1802
1803 This discussion does not consider why a compiler might choose
1804 one of these approaches; it considers only how to describe
1805 the result.
1806
1807 In the examples that follow in this section, the debugging
1808 information entries are given mnemonic labels of the following
1809 form
1810 \begin{verbatim}
1811     <io>.<ac>.<n>.<s>
1812 \end{verbatim}
1813 where
1814 \begin{description}
1815 \item[\textless io\textgreater]
1816 is either \texttt{INNER} or \texttt{OUTER} to indicate to which
1817 subprogram the debugging information entry applies, 
1818 \item[\textless ac\textgreater]
1819 is either AI or CI to indicate \doublequote{abstract instance} or
1820 \doublequote{concrete instance} respectively, 
1821 \item[\textless n\textgreater]
1822 is the number of the
1823 alternative being considered, and 
1824 \item[\textless s\textgreater]
1825 is a sequence number that
1826 distinguishes the individual entries. 
1827 \end{description}
1828 There is no implication
1829 that symbolic labels, nor any particular naming convention,
1830 are required in actual use.
1831
1832 For conciseness, declaration coordinates and call coordinates are omitted.
1833
1834 \subsection{Alternative \#1: inline both OUTER and INNER}
1835 \label{app:inlinebothouterandinner}
1836
1837 A suitable abstract instance for an alternative where both
1838 \texttt{OUTER} and \texttt{INNER} are always inlined is shown in 
1839 Figure \refersec{fig:inliningexample1abstractinstance}.
1840
1841 Notice in 
1842 Figure \ref{fig:inliningexample1abstractinstance} 
1843 that the debugging information entry for
1844 \texttt{INNER} (labelled \texttt{INNER.AI.1.1}) is nested in (is a child of)
1845 that for \texttt{OUTER} (labelled \texttt{OUTER.AI.1.1}). Nonetheless, the
1846 abstract instance tree for \texttt{INNER} is considered to be separate
1847 and distinct from that for \texttt{OUTER}.
1848
1849 The call of \texttt{OUTER} shown in 
1850 Figure \refersec{fig:inliningexamplespseudosourcefragment}
1851 might be described as
1852 shown in 
1853 Figure \refersec{fig:inliningexample1concreteinstance}.
1854
1855
1856 \begin{figure}[p]
1857 \begin{dwflisting}
1858 \begin{alltt}
1859     ! Abstract instance for OUTER
1860     ! \addtoindexx{abstract instance!example}
1861 OUTER.AI.1.1:
1862     \DWTAGsubprogram
1863         \DWATname("OUTER")
1864         \DWATinline(\DWINLdeclaredinlined)
1865         ! No low/high PCs
1866 OUTER.AI.1.2:
1867         \DWTAGformalparameter
1868             \DWATname("OUTER\_FORMAL")
1869             \DWATtype(reference to integer)
1870             ! No location
1871 OUTER.AI.1.3:
1872         \DWTAGvariable
1873             \DWATname("OUTER\_LOCAL")
1874             \DWATtype(reference to integer)
1875             ! No location
1876         !
1877         ! Abstract instance for INNER
1878         !
1879 INNER.AI.1.1:
1880         \DWTAGsubprogram
1881             \DWATname("INNER")
1882             \DWATinline(\DWINLdeclaredinlined)
1883             ! No low/high PCs
1884 INNER.AI.1.2:
1885             \DWTAGformalparameter
1886                 \DWATname("INNER\_FORMAL")
1887                 \DWATtype(reference to integer)
1888                 ! No location
1889 INNER.AI.1.3:
1890             \DWTAGvariable
1891                 \DWATname("INNER\_LOCAL")
1892                 \DWATtype(reference to integer)
1893                 ! No location
1894             ...
1895             0
1896         ! No \DWTAGinlinedsubroutine (concrete instance)
1897         ! for INNER corresponding to calls of INNER
1898         ...
1899         0
1900 \end{alltt}
1901 \end{dwflisting}
1902 \caption{Inlining example \#1: abstract instance}
1903 \label{fig:inliningexample1abstractinstance}
1904 \end{figure}
1905
1906 \begin{figure}[p]
1907 \begin{dwflisting}
1908 \begin{alltt}
1909 ! Concrete instance for call "OUTER(7)"
1910 ! \addtoindexx{concrete instance!example}
1911 OUTER.CI.1.1:
1912     \DWTAGinlinedsubroutine
1913         ! No name
1914         \DWATabstractorigin(reference to OUTER.AI.1.1)
1915         \DWATlowpc(...)
1916         \DWAThighpc(...)
1917 OUTER.CI.1.2:
1918         \DWTAGformalparameter
1919             ! No name
1920             \DWATabstractorigin(reference to OUTER.AI.1.2)
1921             \DWATconstvalue(7)
1922 OUTER.CI.1.3:
1923         \DWTAGvariable
1924             ! No name
1925             \DWATabstractorigin(reference to OUTER.AI.1.3)
1926             \DWATlocation(...)
1927         !
1928         ! No \DWTAGsubprogram (abstract instance) for INNER
1929         !
1930         ! Concrete instance for call INNER(OUTER\_LOCAL)
1931         !
1932 INNER.CI.1.1:
1933         \DWTAGinlinedsubroutine
1934             ! No name
1935             \DWATabstractorigin(reference to INNER.AI.1.1)
1936             \DWATlowpc(...)
1937             \DWAThighpc(...)
1938             \DWATstaticlink(...)
1939 INNER.CI.1.2:
1940             \DWTAGformalparameter
1941                 ! No name
1942                 \DWATabstractorigin(reference to INNER.AI.1.2)
1943                 \DWATlocation(...)
1944 INNER.CI.1.3:
1945             \DWTAGvariable
1946                 ! No name
1947                 \DWATabstractorigin(reference to INNER.AI.1.3)
1948                 \DWATlocation(...)
1949             ...
1950             0
1951         ! Another concrete instance of INNER within OUTER
1952         ! for the call "INNER(31)"
1953         ...
1954         0
1955 \end{alltt}
1956 \end{dwflisting}
1957 \caption{Inlining example \#1: concrete instance}
1958 \label{fig:inliningexample1concreteinstance}
1959 \end{figure}
1960
1961 \subsection{Alternative \#2: Inline OUTER, multiple INNERs}
1962 \label{app:inlineoutermultiipleinners}
1963
1964
1965 In the second alternative we assume that subprogram \texttt{INNER}
1966 is not inlinable for some reason, but subprogram \texttt{OUTER} is
1967 inlinable. 
1968 \addtoindexx{concrete instance!example}
1969 Each concrete inlined instance of \texttt{OUTER} has its
1970 own normal instance of \texttt{INNER}. 
1971 The abstract instance for \texttt{OUTER},
1972 \addtoindexx{abstract instance!example}
1973 which includes \texttt{INNER}, is shown in 
1974 Figure \refersec{fig:inliningexample2abstractinstance}.
1975
1976 Note that the debugging information in 
1977 Figure \ref{fig:inliningexample2abstractinstance}
1978 differs from that in 
1979 Figure \refersec{fig:inliningexample1abstractinstance}
1980 in that \texttt{INNER} lacks a 
1981 \DWATinline{} attribute
1982 and therefore is not a distinct abstract instance. \texttt{INNER}
1983 is merely an out\dash of\dash line routine that is part of \texttt{OUTER}\textquoteright s
1984 abstract instance. This is reflected in the Figure by
1985 \addtoindexx{abstract instance!example}
1986 the fact that the labels for \texttt{INNER} use the substring \texttt{OUTER}
1987 instead of \texttt{INNER}.
1988
1989 A resulting 
1990 \addtoindexx{concrete instance!example}
1991 concrete inlined instance of \texttt{OUTER} is shown in
1992 Figure \refersec{fig:inliningexample2concreteinstance}.
1993
1994 Notice in 
1995 Figure \ref{fig:inliningexample2concreteinstance}
1996 that \texttt{OUTER} is expanded as a concrete
1997 \addtoindexx{concrete instance!example}
1998 inlined instance, and that \texttt{INNER} is nested within it as a
1999 concrete out\dash of\dash line subprogram. Because \texttt{INNER} is cloned
2000 for each inline expansion of \texttt{OUTER}, only the invariant
2001 attributes of \texttt{INNER} 
2002 (for example, \DWATname) are specified
2003 in the abstract instance of \texttt{OUTER}, and the low\dash level,
2004 \addtoindexx{abstract instance!example}
2005 instance\dash specific attributes of \texttt{INNER} (for example,
2006 \DWATlowpc) are specified in 
2007 each concrete instance of \texttt{OUTER}.
2008 \addtoindexx{concrete instance!example}
2009
2010 The several calls of \texttt{INNER} within \texttt{OUTER} are compiled as normal
2011 calls to the instance of \texttt{INNER} that is specific to the same
2012 instance of \texttt{OUTER} that contains the calls.
2013
2014 \begin{figure}[t]
2015 \begin{dwflisting}
2016 \begin{alltt}
2017     ! Abstract instance for OUTER
2018     ! \addtoindex{abstract instance}
2019 OUTER.AI.2.1:
2020     \DWTAGsubprogram
2021         \DWATname("OUTER")
2022         \DWATinline(\DWINLdeclaredinlined)
2023         ! No low/high PCs
2024 OUTER.AI.2.2:
2025         \DWTAGformalparameter
2026             \DWATname("OUTER\_FORMAL")
2027             \DWATtype(reference to integer)
2028             ! No location
2029 OUTER.AI.2.3:
2030         \DWTAGvariable
2031             \DWATname("OUTER\_LOCAL")
2032             \DWATtype(reference to integer)
2033             ! No location
2034         !
2035         ! Nested out-of-line INNER subprogram
2036         !
2037 OUTER.AI.2.4:
2038         \DWTAGsubprogram
2039             \DWATname("INNER")
2040             ! No \DWATinline
2041             ! No low/high PCs, frame\_base, etc.
2042 OUTER.AI.2.5:
2043             \DWTAGformalparameter
2044                 \DWATname("INNER\_FORMAL")
2045                 \DWATtype(reference to integer)
2046                 ! No location
2047 OUTER.AI.2.6:
2048             \DWTAGvariable
2049                 \DWATname("INNER\_LOCAL")
2050                 \DWATtype(reference to integer)
2051                 ! No location
2052             ...
2053             0
2054         ...
2055         0
2056 \end{alltt}
2057 \end{dwflisting}
2058 \caption{Inlining example \#2: abstract instance}
2059 \label{fig:inliningexample2abstractinstance}
2060 \end{figure}
2061
2062 \begin{figure}[t]
2063 \begin{dwflisting}
2064 \begin{alltt}
2065
2066     ! Concrete instance for call "OUTER(7)"
2067     !
2068 OUTER.CI.2.1:
2069     \DWTAGinlinedsubroutine
2070         ! No name
2071         \DWATabstractorigin(reference to OUTER.AI.2.1)
2072         \DWATlowpc(...)
2073         \DWAThighpc(...)
2074 OUTER.CI.2.2:
2075         \DWTAGformalparameter
2076             ! No name
2077             \DWATabstractorigin(reference to OUTER.AI.2.2)
2078             \DWATlocation(...)
2079 OUTER.CI.2.3:
2080         \DWTAGvariable
2081             ! No name
2082             \DWATabstractorigin(reference to OUTER.AI.2.3)
2083             \DWATlocation(...)
2084         !
2085         ! Nested out-of-line INNER subprogram
2086         !
2087 OUTER.CI.2.4:
2088         \DWTAGsubprogram
2089             ! No name
2090             \DWATabstractorigin(reference to OUTER.AI.2.4)
2091             \DWATlowpc(...)
2092             \DWAThighpc(...)
2093             \DWATframebase(...)
2094             \DWATstaticlink(...)
2095 OUTER.CI.2.5:
2096             \DWTAGformalparameter
2097                 ! No name
2098                 \DWATabstractorigin(reference to OUTER.AI.2.5)
2099                 \DWATlocation(...)
2100 OUTER.CI.2.6:
2101             \DWTAGvariable
2102                 ! No name
2103                 \DWATabstractorigin(reference to OUTER.AT.2.6)
2104                 \DWATlocation(...)
2105             ...
2106             0
2107         ...
2108         0
2109 \end{alltt}
2110 \end{dwflisting}
2111 \caption{Inlining example \#2: concrete instance}
2112 \label{fig:inliningexample2concreteinstance}
2113 \end{figure}
2114
2115 \subsection{Alternative \#3: inline OUTER, one normal INNER}
2116 \label{app:inlineouteronenormalinner}
2117
2118 In the third approach, one normal subprogram for \texttt{INNER} is
2119 compiled which is called from all concrete inlined instances of
2120 \addtoindexx{concrete instance!example}
2121 \addtoindexx{abstract instance!example}
2122 \texttt{OUTER}. The abstract instance for \texttt{OUTER} is shown in 
2123 Figure \refersec{fig:inliningexample3abstractinstance}.
2124
2125 The most distinctive aspect of that Figure is that subprogram
2126 \texttt{INNER} exists only within the abstract instance of \texttt{OUTER},
2127 and not in \texttt{OUTER}\textquoteright s concrete instance. In the abstract
2128 \addtoindexx{concrete instance!example}
2129 \addtoindexx{abstract instance!example}
2130 instance of \texttt{OUTER}, the description of \texttt{INNER} has the full
2131 complement of attributes that would be expected for a
2132 normal subprogram. 
2133 While attributes such as 
2134 \DWATlowpc,
2135 \DWAThighpc, 
2136 \DWATlocation,
2137 and so on, typically are omitted
2138 \addtoindexx{high PC attribute}
2139 from 
2140 \addtoindexx{low PC attribute}
2141 an 
2142 \addtoindexx{location attribute}
2143 abstract instance because they are not invariant across
2144 instances of the containing abstract instance, in this case
2145 those same attributes are included precisely because they are
2146 invariant -- there is only one subprogram \texttt{INNER} to be described
2147 and every description is the same.
2148
2149 A concrete inlined instance of \texttt{OUTER} is illustrated in
2150 Figure \refersec{fig:inliningexample3concreteinstance}.
2151
2152 Notice in 
2153 Figure \ref{fig:inliningexample3concreteinstance}
2154 that there is no DWARF representation for
2155 \texttt{INNER} at all; the representation of \texttt{INNER} does not vary across
2156 instances of \texttt{OUTER} and the abstract instance of \texttt{OUTER} includes
2157 the complete description of \texttt{INNER}, so that the description of
2158 \texttt{INNER} may be (and for reasons of space efficiency, should be)
2159 omitted from each 
2160 \addtoindexx{concrete instance!example}
2161 concrete instance of \texttt{OUTER}.
2162
2163 There is one aspect of this approach that is problematical from
2164 the DWARF perspective. The single compiled instance of \texttt{INNER}
2165 is assumed to access up\dash level variables of \texttt{OUTER}; however,
2166 those variables may well occur at varying positions within
2167 the frames that contain the 
2168 \addtoindexx{concrete instance!example}
2169 concrete inlined instances. A
2170 compiler might implement this in several ways, including the
2171 use of additional compiler-generated parameters that provide
2172 reference parameters for the up\dash level variables, or a 
2173 compiler-generated static link like parameter that points to the group
2174 of up\dash level entities, among other possibilities. In either of
2175 these cases, the DWARF description for the location attribute
2176 of each uplevel variable needs to be different if accessed
2177 from within \texttt{INNER} compared to when accessed from within the
2178 instances of \texttt{OUTER}. An implementation is likely to require
2179 vendor\dash specific DWARF attributes and/or debugging information
2180 entries to describe such cases.
2181
2182 Note that in C++, a member function of a class defined within
2183 a function definition does not require any vendor\dash specific
2184 extensions because the C++ language disallows access to
2185 entities that would give rise to this problem. (Neither \texttt{extern}
2186 variables nor \texttt{static} members require any form of static link
2187 for accessing purposes.)
2188
2189 \begin{figure}[t]
2190 \begin{dwflisting}
2191 \begin{alltt}
2192     ! Abstract instance for OUTER
2193     ! \addtoindexx{abstract instance!example}
2194 OUTER.AI.3.1:
2195     \DWTAGsubprogram
2196         \DWATname("OUTER")
2197         \DWATinline(\DWINLdeclaredinlined)
2198         ! No low/high PCs
2199 OUTER.AI.3.2:
2200         \DWTAGformalparameter
2201             \DWATname("OUTER\_FORMAL")
2202             \DWATtype(reference to integer)
2203             ! No location
2204 OUTER.AI.3.3:
2205         \DWTAGvariable
2206             \DWATname("OUTER\_LOCAL")
2207             \DWATtype(reference to integer)
2208             ! No location
2209         !
2210         ! Normal INNER
2211         !
2212 OUTER.AI.3.4:
2213         \DWTAGsubprogram
2214             \DWATname("INNER")
2215             \DWATlowpc(...)
2216             \DWAThighpc(...)
2217             \DWATframebase(...)
2218             \DWATstaticlink(...)
2219 OUTER.AI.3.5:
2220             \DWTAGformalparameter
2221                 \DWATname("INNER\_FORMAL")
2222                 \DWATtype(reference to integer)
2223                 \DWATlocation(...)
2224 OUTER.AI.3.6:
2225             \DWTAGvariable
2226                 \DWATname("INNER\_LOCAL")
2227                 \DWATtype(reference to integer)
2228                 \DWATlocation(...)
2229             ...
2230             0
2231         ...
2232         0
2233 \end{alltt}
2234 \end{dwflisting}
2235 \caption{Inlining example \#3: abstract instance}
2236 \label{fig:inliningexample3abstractinstance}
2237 \end{figure}
2238
2239 \begin{figure}[t]
2240 \begin{dwflisting}
2241 \begin{alltt}
2242     ! Concrete instance for call "OUTER(7)"
2243     ! \addtoindexx{concrete instance!example}
2244 OUTER.CI.3.1:
2245     \DWTAGinlinedsubroutine
2246         ! No name
2247         \DWATabstractorigin(reference to OUTER.AI.3.1)
2248         \DWATlowpc(...)
2249         \DWAThighpc(...)
2250         \DWATframebase(...)
2251 OUTER.CI.3.2:
2252         \DWTAGformalparameter
2253             ! No name
2254             \DWATabstractorigin(reference to OUTER.AI.3.2)
2255             ! No type
2256             \DWATlocation(...)
2257 OUTER.CI.3.3:
2258         \DWTAGvariable
2259             ! No name
2260             \DWATabstractorigin(reference to OUTER.AI.3.3)
2261             ! No type
2262             \DWATlocation(...)
2263         ! No \DWTAGsubprogram for "INNER"
2264         ...
2265         0
2266 \end{alltt}
2267 \end{dwflisting}
2268 \caption{Inlining example \#3: concrete instance}
2269 \label{fig:inliningexample3concreteinstance}
2270 \end{figure}
2271
2272 \clearpage
2273 \section{Constant Expression Example}
2274 \label{app:constantexpressionexample}
2275 C++ generalizes the notion of constant expressions to include
2276 constant expression user-defined literals and functions.
2277 The constant declarations in Figure \refersec{fig:constantexpressionscsource}
2278 can be represented as illustrated in 
2279 Figure \refersec{fig:constantexpressionsdwarfdescription}.
2280
2281
2282 \begin{figure}[here]
2283 \begin{lstlisting}[numbers=none]
2284 constexpr double mass = 9.8;
2285 constexpr int square (int x) { return x * x; }
2286 float arr[square(9)]; // square() called and inlined
2287 \end{lstlisting}
2288 \caption{Constant expressions: C++ source} \label{fig:constantexpressionscsource}
2289 \end{figure}
2290
2291
2292 \begin{figure}[!h]
2293 \begin{dwflisting}
2294 \begin{alltt}
2295         ! For variable mass
2296         !
2297 1\$:     \DWTAGconsttype
2298             \DWATtype(reference to "double")
2299 2\$:     \DWTAGvariable
2300             \DWATname("mass")
2301             \DWATtype(reference to 1\$)
2302             \DWATconstexpr(true)
2303             \DWATconstvalue(9.8)
2304         ! Abstract instance for square
2305         !
2306 10\$:    \DWTAGsubprogram
2307             \DWATname("square")
2308             \DWATtype(reference to "int")
2309             \DWATinline(\DWINLinlined)
2310 11\$:        \DWTAGformalparameter
2311                 \DWATname("x")
2312                 \DWATtype(reference to "int")
2313         ! Concrete instance for square(9)
2314         ! \addtoindexx{concrete instance!example}
2315 20\$:    \DWTAGinlinedsubroutine
2316             \DWATabstractorigin(reference to 10\$)
2317             \DWATconstexpr(present)
2318             \DWATconstvalue(81)
2319             \DWTAGformalparameter
2320                 \DWATabstractorigin(reference to 11\$)
2321                 \DWATconstvalue(9)
2322         ! Anonymous array type for arr
2323         !
2324 30\$:    \DWTAGarraytype
2325             \DWATtype(reference to "float")
2326             \DWATbytesize(324) ! 81*4
2327             \DWTAGsubrangetype
2328                 \DWATtype(reference to "int")
2329                 \DWATupperbound(reference to 20\$)
2330         ! Variable arr
2331         !
2332 40\$:    \DWTAGvariable
2333             \DWATname("arr")
2334             \DWATtype(reference to 30\$)
2335 \end{alltt}
2336 \end{dwflisting}
2337 \caption{Constant expressions: DWARF description}
2338 \label{fig:constantexpressionsdwarfdescription}
2339 \end{figure}
2340
2341 \section{Unicode Character Example}
2342 \label{app:unicodecharacterexample}
2343 \addtoindexx{Unicode|see {\textit{also} UTF-8}}
2344 The \addtoindex{Unicode} character encodings in
2345 Figure \refersec{fig:unicodecharacterexamplesource}
2346 can be described in DWARF as illustrated in 
2347 Figure \refersec{fig:unicodecharacterexampledwarfdescription}.
2348
2349 \begin{figure}[!h]
2350 \begin{lstlisting}[numbers=none]
2351 // C++ source
2352 //
2353 char16_t chr_a = u'h';
2354 char32_t chr_b = U'h';
2355 \end{lstlisting}
2356 \caption{Unicode character example: source}
2357 \label{fig:unicodecharacterexamplesource}
2358 \end{figure}
2359
2360 \begin{figure}[h]
2361 \begin{dwflisting}
2362 \begin{alltt}
2363
2364 ! DWARF description
2365 !
2366 1\$: \DWTAGbasetype
2367         \DWATname("char16\_t")
2368         \DWATencoding(\DWATEUTF)
2369         \DWATbytesize(2)
2370 2\$: \DWTAGbasetype
2371         \DWATname("char32\_t")
2372         \DWATencoding(\DWATEUTF)
2373         \DWATbytesize(4)
2374 3\$: \DWTAGvariable
2375         \DWATname("chr\_a")
2376         \DWATtype(reference to 1\$)
2377 4\$: \DWTAGvariable
2378         \DWATname("chr\_b")
2379         \DWATtype(reference to 2\$)
2380 \end{alltt}
2381 \end{dwflisting}
2382 \caption{Unicode character example: DWARF description}
2383 \label{fig:unicodecharacterexampledwarfdescription}
2384 \end{figure}
2385
2386
2387 \section{Type-Safe Enumeration Example}
2388 \label{app:typesafeenumerationexample}
2389
2390 The \addtoindex{C++} type\dash safe enumerations in
2391 \addtoindexx{type-safe enumeration}
2392 Figure \refersec{fig:ctypesafeenumerationexamplesource}
2393 can be described in DWARF as illustrated in 
2394 Figure \refersec{fig:ctypesafeenumerationexampledwarf}.
2395
2396 \clearpage      % Get following source and DWARF on same page
2397
2398 \begin{figure}[H]
2399 \begin{lstlisting}[numbers=none]
2400 // C++ source
2401 //
2402 enum class E { E1, E2=100 };
2403 E e1;
2404 \end{lstlisting}
2405 \caption{Type-safe enumeration example: source}
2406 \label{fig:ctypesafeenumerationexamplesource}
2407 \end{figure}
2408
2409 \begin{figure}[H]
2410 \begin{dwflisting}
2411 \begin{alltt}
2412 ! DWARF description
2413 !
2414 11\$:  \DWTAGenumerationtype
2415           \DWATname("E")
2416           \DWATtype(reference to "int")
2417           \DWATenumclass(present)
2418 12\$:      \DWTAGenumerator
2419               \DWATname("E1")
2420               \DWATconstvalue(0)
2421 13\$:      \DWTAGenumerator
2422               \DWATname("E2")
2423               \DWATconstvalue(100)
2424 14\$:  \DWTAGvariable
2425          \DWATname("e1")
2426          \DWATtype(reference to 11\$)
2427 \end{alltt}
2428 \end{dwflisting}
2429 \caption{Type-safe enumeration example: DWARF description}
2430 \label{fig:ctypesafeenumerationexampledwarf}
2431 \end{figure}
2432
2433
2434 \clearpage
2435 \section{Template Examples}
2436 \label{app:templateexample}
2437
2438 The C++ template example in
2439 Figure \refersec{fig:ctemplateexample1source}
2440 can be described in DWARF as illustrated in 
2441 Figure \refersec{fig:ctemplateexample1dwarf}.
2442
2443 \begin{figure}[h]
2444 \begin{lstlisting}
2445 // C++ source
2446 //
2447 template<class T>
2448 struct wrapper {
2449     T comp;
2450 };
2451 wrapper<int> obj;
2452 \end{lstlisting}
2453 \caption{C++ template example \#1: source}
2454 \label{fig:ctemplateexample1source}
2455 \end{figure}
2456
2457 \begin{figure}[h]
2458 \begin{dwflisting}
2459 \begin{alltt}
2460 ! DWARF description
2461 !
2462 11\$: \DWTAGstructuretype
2463         \DWATname("wrapper")
2464 12\$:    \DWTAGtemplatetypeparameter
2465             \DWATname("T")
2466             \DWATtype(reference to "int")
2467 13\$:    \DWTAGmember
2468             \DWATname("comp")
2469             \DWATtype(reference to 12\$)
2470 14\$: \DWTAGvariable
2471         \DWATname("obj")
2472         \DWATtype(reference to 11\$)
2473 \end{alltt}
2474 \end{dwflisting}
2475 \caption{C++ template example \#1: DWARF description}
2476 \label{fig:ctemplateexample1dwarf}
2477 \end{figure}
2478
2479 The actual type of the component \texttt{comp} is \texttt{int}, but in the DWARF
2480 the type references the
2481 \DWTAGtemplatetypeparameter{}
2482 for \texttt{T}, which in turn references \texttt{int}. This implies that in the
2483 original template comp was of type \texttt{T} and that was replaced
2484 with \texttt{int} in the instance. 
2485
2486 \needlines{10}
2487 There exist situations where it is
2488 not possible for the DWARF to imply anything about the nature
2489 of the original template. 
2490 Consider the C++ template source in
2491 Figure \refersec{fig:ctemplateexample2source}
2492 and the DWARF that can describe it in
2493 Figure \refersec{fig:ctemplateexample2dwarf}.
2494
2495 \begin{figure}[!h]
2496 \begin{lstlisting}
2497 // C++ source
2498 //
2499     template<class T>
2500     struct wrapper {
2501         T comp;
2502     };
2503     template<class U>
2504     void consume(wrapper<U> formal)
2505     {
2506         ...
2507     }
2508     wrapper<int> obj;
2509     consume(obj);
2510 \end{lstlisting}
2511 \caption{C++ template example \#2: source}
2512 \label{fig:ctemplateexample2source}
2513 \end{figure}
2514
2515 \begin{figure}[h]
2516 \begin{dwflisting}
2517 \begin{alltt}
2518 ! DWARF description
2519 !
2520 11\$:  \DWTAGstructuretype
2521           \DWATname("wrapper")
2522 12\$:      \DWTAGtemplatetypeparameter
2523               \DWATname("T")
2524               \DWATtype(reference to "int")
2525 13\$:      \DWTAGmember
2526               \DWATname("comp")
2527               \DWATtype(reference to 12\$)
2528 14\$:  \DWTAGvariable
2529           \DWATname("obj")
2530           \DWATtype(reference to 11\$)
2531 21\$:  \DWTAGsubprogram
2532           \DWATname("consume")
2533 22\$:      \DWTAGtemplatetypeparameter
2534               \DWATname("U")
2535               \DWATtype(reference to "int")
2536 23\$:      \DWTAGformalparameter
2537               \DWATname("formal")
2538               \DWATtype(reference to 11\$)
2539 \end{alltt}
2540 \end{dwflisting}
2541 \caption{C++ template example \#2: DWARF description}
2542 \label{fig:ctemplateexample2dwarf}
2543 \end{figure}
2544
2545 In the \DWTAGsubprogram{} 
2546 entry for the instance of consume, \texttt{U} is described as \texttt{int}. 
2547 The type of formal is \texttt{wrapper\textless U\textgreater} in
2548 the source. DWARF only represents instantiations of templates;
2549 there is no entry which represents \texttt{wrapper\textless U\textgreater} 
2550 which is neither
2551 a template parameter nor a template instantiation. The type
2552 of formal is described as \texttt{wrapper\textless int\textgreater},
2553 the instantiation of \texttt{wrapper\textless U\textgreater},
2554 in the \DWATtype{} attribute at 
2555 23\$. 
2556 There is no
2557 description of the relationship between template type parameter
2558 \texttt{T} at 12\$ and \texttt{U} at 22\$ which was used to instantiate
2559 \texttt{wrapper\textless U\textgreater}.
2560
2561 A consequence of this is that the DWARF information would
2562 not distinguish between the existing example and one where
2563 the formal parameter of \texttt{consume} were declared in the source to be
2564 \texttt{wrapper\textless int\textgreater}.
2565
2566
2567 \section{Template Alias Examples}
2568 \label{app:templatealiasexample}
2569
2570 The \addtoindex{C++} template alias shown in
2571 Figure \refersec{fig:ctemplatealiasexample1source}
2572 can be described in DWARF as illustrated 
2573 \addtoindexx{template alias example} in 
2574 Figure \refersec{fig:ctemplatealiasexample1dwarf}.
2575
2576 \begin{figure}[h]
2577 \begin{lstlisting}
2578 // C++ source, template alias example 1
2579 //
2580 template<typename T, typename U>
2581 struct Alpha {
2582     T tango;
2583     U uniform;
2584 };
2585 template<typename V> using Beta = Alpha<V,V>;
2586 Beta<long> b;
2587 \end{lstlisting}
2588 \caption{C++ template alias example \#1: source}
2589 \label{fig:ctemplatealiasexample1source}
2590 \end{figure}
2591
2592 \begin{figure}[h]
2593 \addtoindexx{template alias example 1}
2594 \begin{dwflisting}
2595 \begin{alltt}
2596 ! DWARF representation for variable 'b'
2597 !
2598 20\$:  \DWTAGstructuretype
2599           \DWATname("Alpha")
2600 21\$:      \DWTAGtemplatetypeparameter
2601               \DWATname("T")
2602               \DWATtype(reference to "long")
2603 22\$:      \DWTAGtemplatetypeparameter
2604               \DWATname("U")
2605               \DWATtype(reference to "long")
2606 23\$:      \DWTAGmember
2607               \DWATname("tango")
2608               \DWATtype(reference to 21\$)
2609 24\$:      \DWTAGmember
2610               \DWATname("uniform")
2611               \DWATtype(reference to 22\$)
2612 25\$:  \DWTAGtemplatealias
2613           \DWATname("Beta")
2614           \DWATtype(reference to 20\$)
2615 26\$:      \DWTAGtemplatetypeparameter
2616               \DWATname("V")
2617               \DWATtype(reference to "long")
2618 27\$:  \DWTAGvariable
2619           \DWATname("b")
2620           \DWATtype(reference to 25\$)
2621 \end{alltt}
2622 \end{dwflisting}
2623 \caption{C++ template alias example \#1: DWARF description}
2624 \label{fig:ctemplatealiasexample1dwarf}
2625 \end{figure}
2626
2627 Similarly, the \addtoindex{C++} template alias shown in
2628 Figure \refersec{fig:ctemplatealiasexample2source}
2629 can be described in DWARF as illustrated 
2630 \addtoindexx{template alias example} in 
2631 Figure \refersec{fig:ctemplatealiasexample2dwarf}.
2632
2633 \begin{figure}[h]
2634 \begin{lstlisting}
2635 // C++ source, template alias example 2
2636 //
2637 template<class TX> struct X { };
2638 template<class TY> struct Y { };
2639 template<class T> using Z = Y<T>;
2640 X<Y<int>> y;
2641 X<Z<int>> z;
2642 \end{lstlisting}
2643 \caption{C++ template alias example \#2: source}
2644 \label{fig:ctemplatealiasexample2source}
2645 \end{figure}
2646
2647 \begin{figure}[h]
2648 \addtoindexx{template alias example 2}
2649 \begin{dwflisting}
2650 \begin{alltt}
2651 ! DWARF representation for X<Y<int>>
2652 !
2653 30\$:  \DWTAGstructuretype
2654           \DWATname("Y")
2655 31\$:      \DWTAGtemplatetypeparameter
2656               \DWATname("TY")
2657               \DWATtype(reference to "int")
2658 32\$:  \DWTAGstructuretype
2659           \DWATname("X")
2660 33\$:      \DWTAGtemplatetypeparameter
2661               \DWATname("TX")
2662               \DWATtype(reference to 30\$)
2663 !
2664 ! DWARF representation for X<Z<int>>
2665 !
2666 40\$:  \DWTAGtemplatealias
2667           \DWATname("Z")
2668           \DWATtype(reference to 30\$)
2669 41\$:      \DWTAGtemplatetypeparameter
2670               \DWATname("T")
2671               \DWATtype(reference to "int")
2672 42\$:  \DWTAGstructuretype
2673           \DWATname("X")
2674 43\$:      \DWTAGtemplatetypeparameter
2675               \DWATname("TX")
2676               \DWATtype(reference to 40\$)
2677 !
2678 ! Note that 32\$ and 42\$ are actually the same type
2679 !
2680 50\$:  \DWTAGvariable
2681           \DWATname("y")
2682           \DWATtype(reference to \$32)
2683 51\$:  \DWTAGvariable
2684           \DWATname("z")
2685           \DWATtype(reference to \$42)
2686 \end{alltt}
2687 \end{dwflisting}
2688 \caption{C++ template alias example \#2: DWARF description}
2689 \label{fig:ctemplatealiasexample2dwarf}
2690 \end{figure}
2691
2692 \clearpage
2693 \section{Implicit Pointer Examples}
2694 \label{app:implicitpointerexamples}
2695 If the compiler determines that the value of an object is
2696 constant (either throughout the program, or within a specific
2697 range), it may choose to materialize that constant only when
2698 used, rather than store it in memory or in a register. The
2699 \DWOPimplicitvalue{} operation can be used to describe such a
2700 value. Sometimes, the value may not be constant, but still can be
2701 easily rematerialized when needed. A DWARF expression terminating
2702 in \DWOPstackvalue{} can be used for this case. The compiler may
2703 also eliminate a pointer value where the target of the pointer
2704 resides in memory, and the \DWOPstackvalue{} operator may be used
2705 to rematerialize that pointer value. In other cases, the compiler
2706 will eliminate a pointer to an object that itself needs to be
2707 materialized. Since the location of such an object cannot be
2708 represented as a memory address, a DWARF expression cannot give
2709 either the location or the actual value or a pointer variable
2710 that would refer to that object. The \DWOPimplicitpointer{}
2711 operation can be used to describe the pointer, and the debugging
2712 information entry to which its first operand refers describes the
2713 value of the dereferenced object. A DWARF consumer will not be
2714 able to show the location or the value of the pointer variable,
2715 but it will be able to show the value of the dereferenced
2716 pointer.
2717
2718 Consider the \addtoindex{C} source shown in 
2719 Figure \refersec{fig:cimplicitpointerexample1source}.
2720 Assume that the function \texttt{foo} is not inlined,
2721 that the argument x is passed in register 5, and that the
2722 function \texttt{foo} is optimized by the compiler into just 
2723 an increment of the volatile variable \texttt{v}. Given these
2724 assumptions a possible DWARF description is shown in
2725 Figure \refersec{fig:cimplicitpointerexample1dwarf}.
2726
2727 \begin{figure}[h]
2728 \begin{lstlisting}
2729 struct S { short a; char b, c; };
2730 volatile int v;
2731 void foo (int x)
2732 {
2733     struct S s = { x, x + 2, x + 3 };
2734     char *p = &s.b;
2735     s.a++;
2736     v++;
2737 }
2738 int main ()
2739 {
2740     foo (v+1);
2741     return 0;
2742 }
2743 \end{lstlisting}
2744 \caption{C implicit pointer example \#1: source}
2745 \label{fig:cimplicitpointerexample1source}
2746 \end{figure}
2747
2748 \begin{figure}[h]
2749 \addtoindexx{implicit pointer example \#1}
2750 \begin{dwflisting}
2751 \begin{alltt}
2752 1\$: \DWTAGstructuretype
2753         \DWATname("S")
2754         \DWATbytesize(4)
2755 10\$:    \DWTAGmember
2756             \DWATname("a")
2757             \DWATtype(reference to "short int")
2758             \DWATdatamemberlocation(constant 0)
2759 11\$:    \DWTAGmember
2760             \DWATname("b")
2761             \DWATtype(reference to "char")
2762             \DWATdatamemberlocation(constant 2)
2763 12\$:    \DWTAGmember
2764             \DWATname("c")
2765             \DWATtype(reference to "char")
2766             \DWATdatamemberlocation(constant 3)
2767 2\$: \DWTAGsubprogram
2768         \DWATname("foo")
2769 20\$:    \DWTAGformalparameter
2770             \DWATname("x")
2771             \DWATtype(reference to "int")
2772             \DWATlocation(\DWOPregfive)
2773 21\$:    \DWTAGvariable
2774             \DWATname("s")
2775             \DWATlocation(expression=
2776                 \DWOPbregfive(1) \DWOPstackvalue \DWOPpiece(2)
2777                 \DWOPbregfive(2) \DWOPstackvalue \DWOPpiece(1)
2778                 \DWOPbregfive(3) \DWOPstackvalue \DWOPpiece(1))
2779 22\$:    \DWTAGvariable
2780             \DWATname("p")
2781             \DWATtype(reference to "char *")
2782             \DWATlocation(expression=
2783             \DWOPimplicitpointer(reference to 21\$, 2))
2784 \end{alltt}
2785 \end{dwflisting}
2786 \caption{C implicit pointer example \#1: DWARF description}
2787 \label{fig:cimplicitpointerexample1dwarf}
2788 \end{figure}
2789
2790 In Figure \refersec{fig:cimplicitpointerexample1dwarf},
2791 even though variables \texttt{s} and \texttt{p} are both optimized 
2792 away completely, this DWARF description still allows a debugger to 
2793 print the value of the variable \texttt{s}, namely \texttt{(2, 3, 4)}. 
2794 Similarly, because the variable \texttt{s} does not live in
2795 memory, there is nothing to print for the value of \texttt{p}, but the 
2796 debugger should still be able to show that \texttt{p[0]} is 3, 
2797 \texttt{p[1]} is 4, \texttt{p[-1]} is 0 and \texttt{p[-2]} is 2.
2798
2799 \needlines{6}
2800 As a further example, consider the C source 
2801 shown in Figure \refersec{fig:cimplicitpointerexample2source}. Make
2802 the following assumptions about how the code is compiled:
2803 \begin{itemize}
2804 \item The function \texttt{foo} is inlined
2805 into function \texttt{main}
2806 \item The body of the main function is optimized to just
2807 three blocks of instructions which each increment the volatile
2808 variable \texttt{v}, followed by a block of instructions to return 0 from
2809 the function
2810 \item Label \texttt{label0} is at the start of the main
2811 function, \texttt{label1} follows the first \texttt{v++} block, 
2812 \texttt{label2} follows the second \texttt{v++} block and 
2813 \texttt{label3} is at the end of the main function
2814 \item Variable \texttt{b} is optimized away completely, as it isn't used
2815 \item The string literal \texttt{"opq"} is optimized away as well
2816 \end{itemize}
2817 Given these assumptions a possible DWARF description is shown in
2818 Figure \refersec{fig:cimplicitpointerexample2dwarf}.
2819
2820 \begin{figure}[h]
2821 \begin{lstlisting}
2822 static const char *b = "opq";
2823 volatile int v;
2824 static inline void foo (int *p)
2825 {
2826     (*p)++;
2827     v++;
2828     p++;
2829     (*p)++;
2830     v++;
2831 }
2832 int main ()
2833 {
2834     int a[2] = { 1, 2 };
2835     v++;
2836     foo (a);
2837     return a[0] + a[1] - 5;
2838 }
2839 \end{lstlisting}
2840 \caption{C implicit pointer example \#2: source}
2841 \label{fig:cimplicitpointerexample2source}
2842 \end{figure}
2843
2844 \begin{figure}[h]
2845 \addtoindexx{implicit pointer example \#2}
2846 \begin{dwflisting}
2847 \begin{alltt}
2848 1\$: \DWTAGvariable
2849         \DWATname("b")
2850         \DWATtype(reference to "const char *")
2851         \DWATlocation(expression=
2852             \DWOPimplicitpointer(reference to 2$, 0))
2853 2\$: \DWTAGdwarfprocedure
2854         \DWATlocation(expression=
2855             \DWOPimplicitvalue(4, \{'o', 'p', 'q', '\slash0'\}))
2856 3\$: \DWTAGsubprogram
2857         \DWATname("foo")
2858         \DWATinline(\DWINLdeclaredinlined)
2859 30\$:    \DWTAGformalparameter
2860             \DWATname("p")
2861             \DWATtype(reference to "int *")
2862 4\$: \DWTAGsubprogram
2863         \DWATname("main")
2864 40\$:   \DWTAGvariable
2865             \DWATname("a")
2866             \DWATtype(reference to "int[2]")
2867             \DWATlocation(location list 98$)
2868 41\$:    \DWTAGinlinedsubroutine
2869             \DWATabstractorigin(reference to 3$)
2870 42\$:        \DWTAGformalparameter
2871             \DWATabstractorigin(reference to 30$)
2872             \DWATlocation(location list 99$)
2873
2874 ! .debug_loc section
2875 98\$:<label0 in main> .. <label1 in main>
2876         \DWOPlitone \DWOPstackvalue \DWOPpiece(4)
2877         \DWOPlittwo \DWOPstackvalue \DWOPpiece(4)
2878     <label1 in main> .. <label2 in main>
2879         \DWOPlittwo \DWOPstackvalue \DWOPpiece(4)
2880         \DWOPlittwo \DWOPstackvalue \DWOPpiece(4)
2881     <label2 in main> .. <label3 in main>
2882         \DWOPlittwo \DWOPstackvalue \DWOPpiece(4)
2883         \DWOPlitthree \DWOPstackvalue \DWOPpiece(4)
2884     0 .. 0
2885 99\$:<label1 in main> .. <label2 in main>
2886         \DWOPimplicitpointer(reference to 40\$, 0)
2887     <label2 in main> .. <label3 in main>
2888         \DWOPimplicitpointer(reference to 40\$, 4)
2889     0 .. 0
2890 \end{alltt}
2891 \end{dwflisting}
2892 \caption{C implicit pointer example \#2: DWARF description}
2893 \label{fig:cimplicitpointerexample2dwarf}
2894 \end{figure}