Changes from review comments and July 15 meeting, except changes
[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 multidimensional 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 \clearpage
836 \subsection{Fortran Dynamic Type Example}
837 \label{app:fortrandynamictypeexample}
838 Consider the \addtoindex{Fortran 90} example of dynamic properties in 
839 Figure \refersec{fig:fortrandynamictypeexamplesource}.
840 This can be represented in DWARF as illustrated in 
841 Figure \refersec{fig:fortrandynamictypeexampledwarfdescription}.
842 Note that unnamed dynamic types are used to avoid replicating
843 the full description of the underlying type \texttt{dt} that is shared by
844 several variables.
845
846 \begin{figure}[h]
847 \begin{lstlisting}
848             program sample
849      
850         type :: dt (l)
851             integer, len :: l
852             integer :: arr(l)
853         end type
854
855         integer :: n = 4
856         contains
857
858         subroutine s()
859             type (dt(n))               :: t1
860             type (dt(n)), pointer      :: t2
861             type (dt(n)), allocatable  :: t3, t4
862         end subroutine
863      
864         end sample
865 \end{lstlisting}
866 \caption{Fortran dynamic type example: source}
867 \label{fig:fortrandynamictypeexamplesource}
868 \end{figure}
869
870 \begin{figure}[h]
871 \begin{dwflisting}
872 \begin{alltt}
873 11$:    \DWTAGstructuretype
874             \DWATname("dt")
875             \DWTAGmember
876                 ...
877                         ...
878
879 13$:    \DWTAGdynamictype             ! plain version
880             \DWATdatalocation (dwarf expression to locate raw data)
881             \DWATtype (11$)
882
883 14$:    \DWTAGdynamictype             ! 'pointer' version
884             \DWATdatalocation (dwarf expression to locate raw data)
885             \DWATassociated (dwarf expression to test if associated)
886             \DWATtype (11$)
887
888 15$:    \DWTAGdynamictype             ! 'allocatable' version
889             \DWATdatalocation (dwarf expression to locate raw data)
890             \DWATallocated (dwarf expression to test is allocated)
891             \DWATtype (11$)
892
893 16$:    \DWTAGvariable
894             \DWATname ("t1")
895             \DWATtype (13$)
896             \DWATlocation (dwarf expression to locate descriptor)
897 17$:    \DWTAGvariable
898             \DWATname ("t2")
899             \DWATtype (14$)
900             \DWATlocation (dwarf expression to locate descriptor)
901 18$:    \DWTAGvariable
902             \DWATname ("t3")
903             \DWATtype (15$)
904             \DWATlocation (dwarf expression to locate descriptor)
905 19$:    \DWTAGvariable
906             \DWATname ("t4")
907             \DWATtype (15$)
908             \DWATlocation (dwarf expression to locate descriptor)
909 \end{alltt}
910 \end{dwflisting}
911 \caption{Fortran dynamic type example: DWARF description}
912 \label{fig:fortrandynamictypeexampledwarfdescription}
913 \end{figure}
914
915
916 \clearpage
917 \subsection{Ada Example}
918 \label{app:adaexample}
919 Figure \refersec{fig:adaexamplesourcefragment}
920 illustrates two kinds of \addtoindex{Ada} 
921 parameterized array, one embedded in a record.
922
923 \begin{figure}[here]
924 \begin{lstlisting}
925 M : INTEGER := <exp>;
926 VEC1 : array (1..M) of INTEGER;
927 subtype TEENY is INTEGER range 1..100;
928 type ARR is array (INTEGER range <>) of INTEGER;
929 type REC2(N : TEENY := 100) is record
930     VEC2 : ARR(1..N);
931 end record;
932
933 OBJ2B : REC2;
934 \end{lstlisting}
935 \caption{Ada example: source fragment}
936 \label{fig:adaexamplesourcefragment}
937 \end{figure}
938
939 \texttt{VEC1} illustrates an (unnamed) array type where the upper bound
940 of the first and only dimension is determined at runtime. 
941 \addtoindex{Ada}
942 semantics require that the value of an array bound is fixed at
943 the time the array type is elaborated (where \textit{elaboration} refers
944 to the runtime executable aspects of type processing). For
945 the purposes of this example, we assume that there are no
946 other assignments to \texttt{M} so that it safe for the \texttt{REC1} type
947 description to refer directly to that variable (rather than
948 a compiler-generated copy).
949
950 \texttt{REC2} illustrates another array type (the unnamed type of
951 component \texttt{VEC2}) where the upper bound of the first and only
952 bound is also determined at runtime. In this case, the upper
953 bound is contained in a discriminant of the containing record
954 type. (A \textit{discriminant} is a component of a record whose value
955 cannot be changed independently of the rest of the record
956 because that value is potentially used in the specification
957 of other components of the record.)
958
959 The DWARF description is shown in 
960 Figure \refersec{fig:adaexampledwarfdescription}.
961
962
963 Interesting aspects about this example are:
964 \begin{enumerate}[1. ]
965 \item The array \texttt{VEC2} is \doublequote{immediately} contained within structure
966 \texttt{REC2} (there is no intermediate descriptor or indirection),
967 which is reflected in the absence of a \DWATdatalocation{}
968 attribute on the array type at 28\$.
969
970 \item One of the bounds of \texttt{VEC2} is nonetheless dynamic and part of
971 the same containing record. It is described as a reference to
972 a member, and the location of the upper bound is determined
973 as for any member. That is, the location is determined using
974 an address calculation relative to the base of the containing
975 object.  
976
977 A consumer must notice that the referenced bound is a
978 member of the same containing object and implicitly push the
979 base address of the containing object just as for accessing
980 a data member generally.
981
982 \item The lack of a subtype concept in DWARF means that DWARF types
983 serve the role of subtypes and must replicate information from
984 what should be the parent type. For this reason, DWARF for
985 the unconstrained array type \texttt{ARR} is not needed for the purposes
986 of this example and therefore is not shown.
987 \end{enumerate}
988
989 \begin{figure}[p]
990 \begin{dwflisting}
991 \begin{alltt}
992 11\$: \DWTAGvariable
993         \DWATname("M")
994         \DWATtype(reference to INTEGER)
995 12\$: \DWTAGarraytype
996         ! No name, default (\addtoindex{Ada}) order, default stride
997         \DWATtype(reference to INTEGER)
998 13\$:    \DWTAGsubrangetype
999             \DWATtype(reference to INTEGER)
1000             \DWATlowerbound(constant 1)
1001             \DWATupperbound(reference to variable M at 11\$)
1002 14\$: \DWTAGvariable
1003         \DWATname("VEC1")
1004         \DWATtype(reference to array type at 12\$)
1005      . . .
1006 21\$: \DWTAGsubrangetype
1007         \DWATname("TEENY")
1008         \DWATtype(reference to INTEGER)
1009         \DWATlowerbound(constant 1)
1010         \DWATupperbound(constant 100)
1011      . . .
1012 26\$: \DWTAGstructuretype
1013         \DWATname("REC2")
1014 27\$:    \DWTAGmember
1015             \DWATname("N")
1016             \DWATtype(reference to subtype TEENY at 21\$)
1017             \DWATdatamemberlocation(constant 0)
1018 28\$:    \DWTAGarraytype
1019             ! No name, default (\addtoindex{Ada}) order, default stride
1020             ! Default data location
1021             \DWATtype(reference to INTEGER)
1022 29\$:        \DWTAGsubrangetype
1023                 \DWATtype(reference to subrange TEENY at 21\$)
1024                 \DWATlowerbound(constant 1)
1025                 \DWATupperbound(reference to member N at 27\$)
1026 30\$:    \DWTAGmember
1027             \DWATname("VEC2")
1028             \DWATtype(reference to array "subtype" at 28\$)
1029             \DWATdatamemberlocation(machine=
1030                 \DWOPlitn                  ! where n == offset(REC2, VEC2)
1031                 \DWOPplus)
1032      . . .
1033 41\$: \DWTAGvariable
1034         \DWATname("OBJ2B")
1035         \DWATtype(reference to REC2 at 26\$)
1036         \DWATlocation(...as appropriate...)
1037 \end{alltt}
1038 \end{dwflisting}
1039 \caption{Ada example: DWARF description}
1040 \label{fig:adaexampledwarfdescription}
1041 \end{figure}
1042
1043 \clearpage
1044
1045 \subsection{Pascal Example}
1046 \label{app:pascalexample}
1047 The Pascal \addtoindexx{Pascal example} source in 
1048 Figure \referfol{fig:packedrecordexamplesourcefragment}
1049 is used to illustrate the representation of packed unaligned
1050 \addtoindex{bit fields}.
1051
1052 \begin{figure}[here]
1053 \begin{lstlisting}
1054 TYPE T : PACKED RECORD                  ! bit size is 2
1055          F5 : BOOLEAN;                  ! bit offset is 0
1056          F6 : BOOLEAN;                  ! bit offset is 1
1057          END;
1058 VAR V :  PACKED RECORD
1059          F1 : BOOLEAN;                  ! bit offset is 0
1060          F2 : PACKED RECORD             ! bit offset is 1
1061               F3 : INTEGER;             ! bit offset is 0 in F2, 1 in V
1062               END;
1063          F4 : PACKED ARRAY [0..1] OF T; ! bit offset is 33
1064          F7 : T;                        ! bit offset is 37
1065          END;
1066 \end{lstlisting}
1067 \caption{Packed record example: source fragment}
1068 \label{fig:packedrecordexamplesourcefragment}
1069 \end{figure}
1070
1071 The DWARF representation in 
1072 Figure \refersec{fig:packedrecordexampledwarfdescription} 
1073 is appropriate. 
1074 \DWTAGpackedtype{} entries could be added to
1075 better represent the source, but these do not otherwise affect
1076 the example and are omitted for clarity. Note that this same
1077 representation applies to both typical big\dash \ and 
1078 little\dash endian
1079 architectures using the conventions described in 
1080 Section \refersec{chap:datamemberentries}.
1081
1082 \begin{figure}[h]
1083 \figurepart{1}{2}
1084 \begin{dwflisting}
1085 \begin{alltt}
1086 10\$: \DWTAGbasetype
1087         \DWATname("BOOLEAN")
1088             ...
1089 11\$: \DWTAGbasetype
1090         \DWATname("INTEGER")
1091             ...
1092 20\$: \DWTAGstructuretype
1093         \DWATname("T")
1094         \DWATbitsize(2)
1095         \DWTAGmember
1096             \DWATname("F5")
1097             \DWATtype(reference to 10$)
1098             \DWATdatabitoffset(0)        ! may be omitted
1099             \DWATbitsize(1)
1100 \end{alltt}
1101 \end{dwflisting}
1102 \caption{Packed record example: DWARF description}
1103 \label{fig:packedrecordexampledwarfdescription}
1104 \end{figure}
1105
1106 \begin{figure}[h]
1107 \figurepart{2}{2}
1108 \begin{dwflisting}
1109 \begin{alltt}
1110         \DWTAGmember
1111             \DWATname("F6")
1112             \DWATtype(reference to 10$)
1113             \DWATdatabitoffset(1)
1114             \DWATbitsize(1)
1115 21\$: \DWTAGstructuretype                  ! anonymous type for F2
1116         \DWTAGmember
1117             \DWATname("F3")
1118             \DWATtype(reference to 11\$)
1119 22\$: \DWTAGarraytype                      ! anonymous type for F4
1120         \DWATtype(reference to 20\$)
1121         \DWTAGsubrangetype
1122             \DWATtype(reference to 11\$)
1123             \DWATlowerbound(0)
1124             \DWATupperbound(1)
1125         \DWATbitstride(2)
1126         \DWATbitsize(4) \addtoindexx{bit size attribute}
1127 23\$: \DWTAGstructuretype                  ! anonymous type for V
1128         \DWATbitsize(39) \addtoindexx{bit size attribute}
1129         \DWTAGmember
1130             \DWATname("F1")
1131             \DWATtype(reference to 10\$)
1132             \DWATdatabitoffset(0)        ! may be omitted
1133             \DWATbitsize(1) ! may be omitted
1134         \DWTAGmember
1135             \DWATname("F2")
1136             \DWATtype(reference to 21\$)
1137             \DWATdatabitoffset(1)
1138             \DWATbitsize(32) ! may be omitted
1139         \DWTAGmember
1140             \DWATname("F4")
1141             \DWATtype(reference to 22\$)
1142             \DWATdatabitoffset(33)
1143             \DWATbitsize(4) ! may be omitted
1144         \DWTAGmember
1145             \DWATname("F7")
1146             \DWATtype(reference to 20\$)    ! type T
1147             \DWATdatabitoffset(37)
1148             \DWATbitsize(2) \addtoindexx{bit size attribute}              ! may be omitted
1149      \DWTAGvariable
1150         \DWATname("V")
1151         \DWATtype(reference to 23\$)
1152         \DWATlocation(...)
1153         ...
1154 \end{alltt}
1155 \end{dwflisting}
1156 \begin{center}
1157 Figure~\ref{fig:packedrecordexampledwarfdescription}: Packed record example: DWARF description \textit{(concluded)}
1158 \end{center}
1159 \end{figure}
1160
1161 %\clearpage
1162
1163 \clearpage
1164 \section{Namespace Example}
1165 \label{app:namespaceexample}
1166
1167 The \addtoindex{C++} example in 
1168 Figure \refersec{fig:namespaceexamplesourcefragment}
1169 is used 
1170 \addtoindexx{namespace (C++)!example}
1171 to illustrate the representation of namespaces.
1172 The DWARF representation in 
1173 Figure \refersec{fig:namespaceexampledwarfdescription}
1174 is appropriate.
1175
1176 \begin{figure}[h]
1177 \begin{lstlisting}
1178 namespace {
1179     int i;
1180 }
1181 namespace A {
1182     namespace B {
1183         int j;
1184         int   myfunc (int a);
1185         float myfunc (float f) { return f - 2.0; }
1186         int   myfunc2(int a)   { return a + 2; }
1187     }
1188 }
1189 namespace Y {
1190     using A::B::j;         // (1) using declaration
1191     int foo;
1192 }
1193 using A::B::j;             // (2) using declaration
1194 namespace Foo = A::B;      // (3) namespace alias
1195 using Foo::myfunc;         // (4) using declaration
1196 using namespace Foo;       // (5) using directive
1197 namespace A {
1198     namespace B {
1199         using namespace Y; // (6) using directive
1200         int k;
1201     }
1202 }
1203 int Foo::myfunc(int a)
1204 {
1205     i = 3;
1206     j = 4;
1207     return myfunc2(3) + j + i + a + 2;
1208 }
1209 \end{lstlisting}
1210 \caption{Namespace example: source fragment}
1211 \label{fig:namespaceexamplesourcefragment}
1212 \end{figure}
1213
1214
1215 \begin{figure}[p]
1216 \figurepart{1}{2}
1217 \begin{dwflisting}
1218 \begin{alltt}
1219
1220 1\$:  \DWTAGbasetype
1221         \DWATname("int")
1222         ...
1223 2\$:  \DWTAGbasetype
1224         \DWATname("float")
1225         ...
1226 6\$:  \DWTAGnamespace
1227         ! no \DWATname attribute
1228 7\$:
1229         \DWTAGvariable
1230             \DWATname("i")
1231             \DWATtype(reference to 1\$)
1232             \DWATlocation ...
1233             ...
1234 10\$: \DWTAGnamespace
1235         \DWATname("A")
1236 20\$:    \DWTAGnamespace
1237             \DWATname("B")
1238 30\$:        \DWTAGvariable
1239                 \DWATname("j")
1240                 \DWATtype(reference to 1\$)
1241                 \DWATlocation ...
1242                 ...
1243 34\$:        \DWTAGsubprogram
1244                 \DWATname("myfunc")
1245                 \DWATtype(reference to 1\$)
1246                 ...
1247 36\$:        \DWTAGsubprogram
1248                 \DWATname("myfunc")
1249                 \DWATtype(reference to 2\$)
1250                 ...
1251 38\$:        \DWTAGsubprogram
1252                 \DWATname("myfunc2")
1253                 \DWATlowpc ...
1254                 \DWAThighpc ...
1255                 \DWATtype(reference to 1\$)
1256                 ...
1257 \end{alltt}
1258 \end{dwflisting}
1259 \caption{Namespace example: DWARF description}
1260 \label{fig:namespaceexampledwarfdescription}
1261 \end{figure}
1262
1263 \begin{figure}
1264 \figurepart{2}{2}
1265 \begin{dwflisting}
1266 \begin{alltt}
1267 40\$: \DWTAGnamespace
1268         \DWATname("Y")
1269         \DWTAGimporteddeclaration            ! (1) using-declaration
1270             \DWATimport(reference to 30\$)
1271         \DWTAGvariable
1272             \DWATname("foo")
1273             \DWATtype(reference to 1\$)
1274             \DWATlocation ...
1275             ...
1276      \DWTAGimporteddeclaration               ! (2) using declaration
1277         \DWATimport(reference to 30\$)
1278         \DWTAGimporteddeclaration            ! (3) namespace alias
1279             \DWATname("Foo")
1280             \DWATimport(reference to 20\$)
1281         \DWTAGimporteddeclaration            ! (4) using declaration
1282             \DWATimport(reference to 34\$)     !     - part 1
1283         \DWTAGimporteddeclaration            ! (4) using declaration
1284             \DWATimport(reference to 36\$)     !     - part 2
1285         \DWTAGimportedmodule                 ! (5) using directive
1286             \DWATimport(reference to 20\$)
1287         \DWTAGnamespace
1288             \DWATextension(reference to 10\$)
1289             \DWTAGnamespace
1290                 \DWATextension(reference to 20\$)
1291                 \DWTAGimportedmodule         ! (6) using directive
1292                     \DWATimport(reference to 40\$)
1293                 \DWTAGvariable
1294                     \DWATname("k")
1295                     \DWATtype(reference to 1\$)
1296                     \DWATlocation ...
1297                     ...
1298 60\$: \DWTAGsubprogram
1299         \DWATspecification(reference to 34\$)
1300         \DWATlowpc ...
1301         \DWAThighpc ...
1302         ...
1303 \end{alltt}
1304 \end{dwflisting}
1305 \begin{center}
1306 Figure~\ref{fig:namespaceexampledwarfdescription}: Namespace example: DWARF description \textit{(concluded)}
1307 \end{center}
1308 \end{figure}
1309
1310 \clearpage
1311 \section{Member Function Examples}
1312 \label{app:memberfunctionexample}
1313 \addtoindexx{member function example}
1314 Consider the member function example fragment in 
1315 Figure \refersec{fig:memberfunctionexamplesourcefragment}.
1316 The DWARF representation in 
1317 Figure \refersec{fig:memberfunctionexampledwarfdescription}
1318 is appropriate.
1319
1320 \begin{figure}[h]
1321 \begin{lstlisting}
1322 class A
1323 {
1324     void func1(int x1);
1325     void func2() const;
1326     static void func3(int x3);
1327 };
1328 void A::func1(int x) {}
1329 \end{lstlisting}
1330 \caption{Member function example: source fragment}
1331 \label{fig:memberfunctionexamplesourcefragment}
1332 \end{figure}
1333
1334 \begin{figure}[h]
1335 \figurepart{1}{2}
1336 \begin{dwflisting}
1337 \begin{alltt}
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             \DWATobjectpointer(reference to 8\$) \addtoindexx{object pointer attribute}
1359                 ! References a formal parameter in this 
1360                 ! member function
1361             ...
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
1374 8\$:         \DWTAGformalparameter
1375                 \DWATartificial(true)
1376                 \DWATname("this")
1377                 \DWATtype(reference to 4\$)
1378                     ! Makes type of 'this' as 'A*' =>
1379                     ! func1 has not been marked const 
1380                     ! or volatile
1381                 \DWATlocation ...
1382                 ...
1383 9\$:         \DWTAGformalparameter
1384                 \DWATname(x1)
1385                 \DWATtype(reference to 2\$)
1386                 ...
1387 10\$:    \DWTAGsubprogram
1388             \DWATdeclaration
1389             \DWATname("func2")
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             ...
1406                 ! No object pointer reference formal parameter
1407                 ! implies func3 is static
1408 13\$:        \DWTAGformalparameter
1409                 \DWATname(x3)
1410                 \DWATtype(reference to 2\$)
1411                 ...
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 As a further example illustrating \&- and \&\&-qualification
1422 of member functions, 
1423 consider the member function example fragment in 
1424 Figure \refersec{fig:memberfunctionrefqualexamplesourcefragment}.
1425 The DWARF representation in 
1426 Figure \refersec{fig:memberfunctionrefqualexampledwarfdescription}
1427 is appropriate.
1428
1429 \begin{figure}[h]
1430 \begin{lstlisting}
1431 class A {
1432 public:
1433     void f() const &&;
1434 };
1435    
1436 void g() {
1437     A a;
1438     // The type of pointer is "void (A::*)() const &&".
1439     auto pointer_to_member_function = &A::f;
1440 }
1441 \end{lstlisting}
1442 \caption{Reference- and rvalue-reference-qualification example: source \mbox{fragment}}
1443 \label{fig:memberfunctionrefqualexamplesourcefragment}
1444 \end{figure}
1445
1446 \begin{figure}[h]
1447 %\figurepart{1}{2}
1448 \begin{dwflisting}
1449 \begin{alltt}
1450
1451 100$:   \DWTAGclasstype
1452             \DWATname("A")
1453             \DWTAGsubprogram
1454                 \DWATname("f")
1455                 \DWATrvaluereference(0x01)
1456                 \DWTAGformalparameter
1457                     \DWATtype({ref to 200$})    ! to const A*
1458                     \DWATartificial(0x01)
1459
1460 200$:   ! const A*
1461         \DWTAGpointertype
1462             \DWATtype({ref to 300$})             ! to const A
1463
1464 300$:   ! const A
1465         \DWTAGconsttype
1466             \DWATtype({ref to 100$})             ! to class A
1467
1468 400$:   ! mfptr
1469         \DWTAGptrtomembertype
1470             \DWATtype({ref to 400$})             ! to functype
1471             \DWATcontainingtype({ref to 100$})  ! to class A
1472
1473 500$:   ! functype
1474         \DWTAGsubroutinetype
1475             \DWATrvaluereference(0x01)
1476             \DWTAGformalparameter
1477                 \DWATtype({ref to 200$})         ! to const A*
1478                 \DWATartificial(0x01)
1479
1480 600$:   \DWTAGsubprogram
1481             \DWATname("g")
1482             \DWTAGvariable
1483                 \DWATname("a")
1484                 \DWATtype({ref to 100$})         ! to class A
1485             \DWTAGvariable
1486                 \DWATname("pointer_to_member_function")
1487                 \DWATtype({ref to 300$})
1488          
1489 \end{alltt}
1490 \end{dwflisting}
1491 \caption{Reference- and rvalue-reference-qualification example: DWARF \mbox{description}}
1492 \label{fig:memberfunctionrefqualexampledwarfdescription}
1493 \end{figure}
1494
1495
1496 \clearpage
1497 \section{Line Number Program Example}
1498 \label{app:linenumberprogramexample}
1499
1500 Consider the simple source file and the resulting machine
1501 code for the Intel 8086 processor in 
1502 Figure \refersec{fig:linenumberprogramexamplemachinecode}.
1503
1504 \begin{figure}[here]
1505 \begin{lstlisting}
1506 1: int
1507 2: main()
1508     0x239: push pb
1509     0x23a: mov bp,sp
1510 3: {
1511 4: printf("Omit needless words\n");
1512     0x23c: mov ax,0xaa
1513     0x23f: push ax
1514     0x240: call _printf
1515     0x243: pop cx
1516 5: exit(0);
1517     0x244: xor ax,ax
1518     0x246: push ax
1519     0x247: call _exit
1520     0x24a: pop cx
1521 6: }
1522     0x24b: pop bp
1523     0x24c: ret
1524 7: 0x24d:
1525 \end{lstlisting}
1526 \caption{Line number program example: machine code}
1527 \label{fig:linenumberprogramexamplemachinecode}
1528 \end{figure}
1529
1530 Suppose the line number program header includes the following
1531 (header fields not needed 
1532 \addtoindexx{line\_base}
1533 below 
1534 \addtoindexx{line\_range}
1535 are 
1536 \addtoindexx{opcode\_base}
1537 not 
1538 \addtoindexx{minumum\_instruction\_length}
1539 shown):
1540 \begin{alltt}
1541     version                       4
1542     minimum_instruction_length    1
1543     opcode_base                  10   ! Opcodes 10-12 not needed
1544     line_base                     1
1545     line_range                   15
1546 \end{alltt}
1547
1548
1549 Table \refersec{tab:linenumberprogramexampleoneencoding}
1550 shows one encoding of the line number program, which occupies
1551 12 bytes (the opcode SPECIAL(\textit{m},\textit{n}) indicates the special opcode
1552 generated for a line increment of \textit{m} and an address increment
1553 of \textit{n}).
1554
1555 \newpage
1556 \begin{centering}
1557 \setlength{\extrarowheight}{0.1cm}
1558 \begin{longtable}{l|l|l}
1559   \caption{Line number program example: one \mbox{encoding}}
1560   \label{tab:linenumberprogramexampleoneencoding} \\
1561   \hline \bfseries Opcode &\bfseries Operand &\bfseries Byte Stream \\ \hline
1562 \endfirsthead
1563   \bfseries Opcode &\bfseries Operand &\bfseries Byte Stream\\ \hline
1564 \endhead
1565   \hline \emph{Continued on next page}
1566 \endfoot
1567   \hline
1568 \endlastfoot
1569 \DWLNSadvancepc&LEB128(0x239)&0x2, 0xb9, 0x04 \\
1570 SPECIAL(2, 0)& &0xb  \\
1571 SPECIAL(2, 3)& &0x38 \\
1572 SPECIAL(1, 8)& &0x82 \\
1573 SPECIAL(1, 7)& &0x73 \\
1574 \DWLNSadvancepc&LEB128(2)&0x2, 0x2 \\
1575 \DWLNEendsequence{} &&0x0, 0x1, 0x1 \\
1576 \end{longtable}
1577 \end{centering}
1578
1579
1580 Table \refersec{tab:linenumberprogramexamplealternateencoding}
1581 shows an alternate 
1582 encoding of the same program using 
1583 standard opcodes to advance
1584 the program counter; 
1585 this encoding occupies 22 bytes.
1586
1587 \begin{centering}
1588 \setlength{\extrarowheight}{0.1cm}
1589 \begin{longtable}{l|l|l}
1590   \caption{Line number program example: alternate encoding} 
1591   \label{tab:linenumberprogramexamplealternateencoding} \\
1592   \hline \bfseries Opcode &\bfseries Operand &\bfseries Byte Stream \\ \hline
1593 \endfirsthead
1594   \bfseries Opcode &\bfseries Operand &\bfseries Byte Stream\\ \hline
1595 \endhead
1596   \hline \emph{Continued on next page}
1597 \endfoot
1598   \hline
1599 \endlastfoot
1600 \DWLNSfixedadvancepc&0x239&0x9, 0x39, 0x2        \\
1601 SPECIAL(2, 0)&& 0xb        \\
1602 \DWLNSfixedadvancepc&0x3&0x9, 0x3, 0x0        \\
1603 SPECIAL(2, 0)&&0xb        \\
1604 \DWLNSfixedadvancepc&0x8&0x9, 0x8, 0x0        \\
1605 SPECIAL(1, 0)&& 0xa        \\
1606 \DWLNSfixedadvancepc&0x7&0x9, 0x7, 0x0        \\
1607 SPECIAL(1, 0) && 0xa        \\
1608 \DWLNSfixedadvancepc&0x2&0x9, 0x2, 0x0        \\
1609 \DWLNEendsequence&&0x0, 0x1, 0x1        \\
1610 \end{longtable}
1611 \end{centering}
1612
1613 \needlines{6}
1614 \section{Call Frame Information Example}
1615 \label{app:callframeinformationexample}
1616
1617 The following example uses a hypothetical RISC machine in
1618 the style of the Motorola 88000.
1619 \begin{itemize}
1620 \item Memory is byte addressed.
1621
1622 \item Instructions are all 4 bytes each and word aligned.
1623
1624 \item Instruction operands are typically of the form:
1625 \begin{alltt}
1626     <destination.reg>, <source.reg>, <constant>
1627 \end{alltt}
1628
1629 \item The address for the load and store instructions is computed
1630 by adding the contents of the
1631 source register with the constant.
1632
1633 \item There are eight 4\dash byte registers:
1634 \newline
1635 \begin{tabular}{p{5mm}l}
1636    & R0 always 0 \\
1637    & R1 holds return address on call \\
1638    & R2-R3 temp registers (not preserved on call) \\
1639    & R4-R6 preserved on call \\
1640    & R7 stack pointer \\
1641 \end{tabular}
1642
1643 \item  The stack grows in the negative direction.
1644
1645 \item The architectural ABI committee specifies that the
1646 stack pointer (R7) is the same as the CFA
1647
1648 \end{itemize}
1649
1650 Figure \referfol{fig:callframeinformationexamplemachinecodefragments}
1651 shows two code fragments from a subroutine called
1652 foo that uses a frame pointer (in addition to the stack
1653 pointer). The first column values are byte addresses. 
1654 % The \space is so we get a space after >
1655 \textless fs\textgreater\ denotes the stack frame size in bytes, namely 12.
1656
1657
1658 \begin{figure}[here]
1659 \begin{lstlisting}
1660        ;; start prologue
1661 foo    sub   R7, R7, <fs>        ; Allocate frame
1662 foo+4  store R1, R7, (<fs>-4)    ; Save the return address
1663 foo+8  store R6, R7, (<fs>-8)    ; Save R6
1664 foo+12 add   R6, R7, 0           ; R6 is now the Frame ptr
1665 foo+16 store R4, R6, (<fs>-12)   ; Save a preserved reg
1666        ;; This subroutine does not change R5
1667        ...
1668        ;; Start epilogue (R7 is returned to entry value)
1669 foo+64 load  R4, R6, (<fs>-12)   ; Restore R4
1670 foo+68 load  R6, R7, (<fs>-8)    ; Restore R6
1671 foo+72 load  R1, R7, (<fs>-4)    ; Restore return address
1672 foo+76 add   R7, R7, <fs>        ; Deallocate frame
1673 foo+80 jump  R1                  ; Return
1674 foo+84
1675 \end{lstlisting}
1676 \caption{Call frame information example: machine code fragments}
1677 \label{fig:callframeinformationexamplemachinecodefragments}
1678 \end{figure}
1679
1680
1681 An abstract table 
1682 (see Section \refersec{chap:structureofcallframeinformation}) 
1683 for the foo subroutine is shown in 
1684 Table \referfol{tab:callframeinformationexampleconceptualmatrix}.
1685 Corresponding fragments from the
1686 \dotdebugframe{} section are shown in 
1687 Table \refersec{tab:callframeinformationexamplecommoninformationentryencoding}.
1688
1689 The following notations apply in 
1690 Table \refersec{tab:callframeinformationexampleconceptualmatrix}:
1691 \newline
1692 \begin{tabular}{p{5mm}l}
1693 &1.  R8 is the return address \\
1694 &2.  s = same\_value rule \\
1695 &3.  u = undefined rule \\
1696 &4.  rN = register(N) rule \\
1697 &5.  cN = offset(N) rule \\
1698 &6.  a = architectural rule \\
1699 \end{tabular}
1700
1701 \begin{centering}
1702 \setlength{\extrarowheight}{0.1cm}
1703 \begin{longtable}{l|llllllllll}
1704   \caption{Call frame information example: conceptual matrix} 
1705   \label{tab:callframeinformationexampleconceptualmatrix} \\
1706   \hline \bfseries Location & \bfseries CFA & \bfseries R0 & \bfseries R1 & \bfseries R2 & \bfseries R3 & \bfseries R4 & \bfseries R5 & \bfseries R6 & \bfseries R7 & \bfseries R8 \\ \hline
1707 \endfirsthead
1708   \bfseries Location &\bfseries CFA &\bfseries R0 & \bfseries R1 & \bfseries R2 &\bfseries R3 &\bfseries R4 &\bfseries R5 &\bfseries R6 &\bfseries R7 &\bfseries R8\\ \hline
1709 \endhead
1710   \hline \emph{Continued on next page}
1711 \endfoot
1712   \hline
1713 \endlastfoot
1714 foo&[R7]+0&s&u&u&u&s&s&s&a&r1 \\
1715 foo+4&[R7]+fs&s&u&u&u&s&s&s&a&r1 \\
1716 foo+8&[R7]+fs&s&u&u&u&s&s&s&a&c-4 \\
1717 foo+12&[R7]+fs&s&u&u&u&s&s&c-8&a&c-4 \\
1718 foo+16&[R6]+fs&s&u&u&u&s&s&c-8&a&c-4 \\
1719 foo+20&[R6]+fs&s&u&u&u&c-12&s&c-8&a&c-4 \\
1720 ...&&&&&&&&&& \\
1721 foo+64&[R6]+fs&s&u&u&u&c-12&s&c-8&a&c-4 \\
1722 foo+68&[R6]+fs&s&u&u&u&s&s&c-8&a&c-4  \\
1723 foo+72&[R7]+fs&s&u&u&u&s&s&s&a&c-4  \\
1724 foo+76&[R7]+fs&s&u&u&u&s&s&s&a&r1 \\
1725 foo+80&[R7]+0&s&u&u&u&s&s&s&a&r1 \\
1726 \end{longtable}
1727 \end{centering}
1728
1729 \clearpage      % ?????
1730
1731 \begin{centering}
1732 \setlength{\extrarowheight}{0.1cm}
1733 \begin{longtable}{l|ll}
1734   \caption{Call frame information example: common information entry encoding} 
1735   \label{tab:callframeinformationexamplecommoninformationentryencoding} 
1736   \\
1737   \hline \bfseries Address &\bfseries Value &\bfseries Comment \\ \hline
1738 \endfirsthead
1739   \bfseries Address &\bfseries Value &\bfseries Comment \\ \hline
1740 \endhead
1741   \hline \emph{Continued on next page}
1742 \endfoot
1743   \hline
1744 \endlastfoot
1745 cie&36&length    \\
1746 cie+4&\xffffffff&CIE\_id    \\
1747 cie+8&4&version    \\
1748 cie+9&0&augmentation     \\
1749 cie+10&4&address size    \\
1750 cie+11&0&segment size    \\
1751 cie+12&4&code\_alignment\_factor, \textless caf \textgreater    \\
1752 cie+13&-4&data\_alignment\_factor, \textless daf \textgreater    \\
1753 cie+14&8&R8 is the return addr.    \\
1754 cie+15&\DWCFAdefcfa{} (7, 0)&CFA = [R7]+0    \\
1755 cie+18&\DWCFAsamevalue{} (0)&R0 not modified (=0)    \\
1756 cie+20&\DWCFAundefined{} (1)&R1 scratch    \\
1757 cie+22&\DWCFAundefined{} (2)&R2 scratch    \\
1758 cie+24&\DWCFAundefined{} (3)&R3 scratch    \\
1759 cie+26&\DWCFAsamevalue{} (4)&R4 preserve    \\
1760 cie+28&\DWCFAsamevalue{} (5)&R5 preserve    \\
1761 cie+30&\DWCFAsamevalue{} (6)&R6 preserve    \\
1762 cie+32&\DWCFAsamevalue{} (7)&R7 preserve    \\
1763 cie+34&\DWCFAregister{} (8, 1)&R8 is in R1    \\
1764 cie+37&\DWCFAnop{} &padding    \\
1765 cie+38&\DWCFAnop{} &padding \\
1766 cie+39& \DWCFAnop&padding  \\
1767 cie+40 &&  \\
1768 \end{longtable}
1769 \end{centering}
1770
1771
1772 The following notations apply in 
1773 Table \refersec{tab:callframeinformationexampleframedescriptionentryencoding}:
1774 \newline
1775 \begin{tabular}{p{5mm}l}
1776 &\texttt{<fs>  =} frame size \\
1777 &\texttt{<caf> =} code alignment factor \\
1778 &\texttt{<daf> =} data alignment factor \\
1779 \end{tabular}
1780
1781
1782 \begin{centering}
1783 \setlength{\extrarowheight}{0.1cm}
1784 \begin{longtable}{l|ll}
1785   \caption{Call frame information example: frame description entry encoding} 
1786   \label{tab:callframeinformationexampleframedescriptionentryencoding} \\
1787   \hline \bfseries Address &\bfseries Value &\bfseries Comment \\ \hline
1788 \endfirsthead
1789   \bfseries Address &\bfseries Value &\bfseries Comment \\ \hline
1790 \endhead
1791   \hline \emph{Continued on next page}
1792 \endfoot
1793   \hline
1794 \endlastfoot
1795 fde&40&length \\
1796 fde+4&cie&CIE\_ptr \\
1797 fde+8&foo&initial\_location \\
1798 fde+12&84&address\_range \\
1799 fde+16&\DWCFAadvanceloc(1)&instructions \\
1800 fde+17&\DWCFAdefcfaoffset(12)& \textless fs\textgreater \\
1801 fde+19&\DWCFAadvanceloc(1)&4/\textless caf\textgreater \\
1802 fde+20&\DWCFAoffset(8,1)&-4/\textless daf\textgreater (2nd parameter) \\
1803 fde+22&\DWCFAadvanceloc(1)& \\
1804 fde+23&\DWCFAoffset(6,2)&-8/\textless daf\textgreater (2nd parameter)  \\
1805 fde+25&\DWCFAadvanceloc(1) & \\
1806 fde+26&\DWCFAdefcfaregister(6) & \\
1807 fde+28&\DWCFAadvanceloc(1) & \\
1808 fde+29&\DWCFAoffset(4,3)&-12/\textless daf\textgreater (2nd parameter) \\
1809 fde+31&\DWCFAadvanceloc(12)&44/\textless caf\textgreater \\
1810 fde+32&\DWCFArestore(4)& \\
1811 fde+33&\DWCFAadvanceloc(1) & \\
1812 fde+34&\DWCFArestore(6) & \\
1813 fde+35&\DWCFAdefcfaregister(7)  & \\
1814 fde+37&\DWCFAadvanceloc(1) & \\
1815 fde+38&\DWCFArestore(8) &\\
1816 fde+39&\DWCFAadvanceloc(1) &\\
1817 fde+40&\DWCFAdefcfaoffset(0)  &\\
1818 fde+42&\DWCFAnop&padding \\
1819 fde+43&\DWCFAnop&padding \\
1820 fde+44 && \\
1821 \end{longtable}
1822 \end{centering}
1823
1824 \section{Inlining Examples}
1825 \label{app:inliningexamples}
1826 The pseudo\dash source in 
1827 Figure \referfol{fig:inliningexamplespseudosourcefragment}
1828 is used to illustrate the
1829 \addtoindexx{inlined subprogram call!examples}
1830 use of DWARF to describe inlined subroutine calls. This
1831 example involves a nested subprogram \texttt{INNER} that makes uplevel
1832 references to the formal parameter and local variable of the
1833 containing subprogram \texttt{OUTER}.
1834
1835 \begin{figure}[here]
1836 \begin{lstlisting}
1837 inline procedure OUTER (OUTER_FORMAL : integer) =
1838     begin
1839     OUTER_LOCAL : integer;
1840     procedure INNER (INNER_FORMAL : integer) =
1841         begin
1842         INNER_LOCAL : integer;
1843         print(INNER_FORMAL + OUTER_LOCAL);
1844         end;
1845     INNER(OUTER_LOCAL);
1846     ...
1847     INNER(31);
1848     end;
1849 ! Call OUTER
1850 !
1851 OUTER(7);
1852 \end{lstlisting}
1853 \caption{Inlining examples: pseudo-source fragmment} 
1854 \label{fig:inliningexamplespseudosourcefragment}
1855 \end{figure}
1856
1857
1858 There are several approaches that a compiler might take to
1859 inlining for this sort of example. This presentation considers
1860 three such approaches, all of which involve inline expansion
1861 of subprogram \texttt{OUTER}. (If \texttt{OUTER} is not inlined, the inlining
1862 reduces to a simpler single level subset of the two level
1863 approaches considered here.)
1864
1865 The approaches are:
1866 \begin{enumerate}[1. ]
1867 \item  Inline both \texttt{OUTER} and \texttt{INNER} in all cases
1868
1869 \item Inline \texttt{OUTER}, multiple \texttt{INNER}s \\
1870 Treat \texttt{INNER} as a non\dash inlinable part of \texttt{OUTER}, compile and
1871 call a distinct normal version of \texttt{INNER} defined within each
1872 inlining of \texttt{OUTER}.
1873
1874 \item Inline \texttt{OUTER}, one \texttt{INNER} \\
1875 Compile \texttt{INNER} as a single normal subprogram which is called
1876 from every inlining of \texttt{OUTER}.
1877 \end{enumerate}
1878
1879 This discussion does not consider why a compiler might choose
1880 one of these approaches; it considers only how to describe
1881 the result.
1882
1883 In the examples that follow in this section, the debugging
1884 information entries are given mnemonic labels of the following
1885 form
1886 \begin{verbatim}
1887     <io>.<ac>.<n>.<s>
1888 \end{verbatim}
1889 where
1890 \begin{description}
1891 \item[\textless io\textgreater]
1892 is either \texttt{INNER} or \texttt{OUTER} to indicate to which
1893 subprogram the debugging information entry applies, 
1894 \item[\textless ac\textgreater]
1895 is either AI or CI to indicate \doublequote{abstract instance} or
1896 \doublequote{concrete instance} respectively, 
1897 \item[\textless n\textgreater]
1898 is the number of the
1899 alternative being considered, and 
1900 \item[\textless s\textgreater]
1901 is a sequence number that
1902 distinguishes the individual entries. 
1903 \end{description}
1904 There is no implication
1905 that symbolic labels, nor any particular naming convention,
1906 are required in actual use.
1907
1908 For conciseness, declaration coordinates and call coordinates are omitted.
1909
1910 \subsection{Alternative \#1: inline both OUTER and INNER}
1911 \label{app:inlinebothouterandinner}
1912
1913 A suitable abstract instance for an alternative where both
1914 \texttt{OUTER} and \texttt{INNER} are always inlined is shown in 
1915 Figure \refersec{fig:inliningexample1abstractinstance}.
1916
1917 Notice in 
1918 Figure \ref{fig:inliningexample1abstractinstance} 
1919 that the debugging information entry for
1920 \texttt{INNER} (labelled \texttt{INNER.AI.1.1}) is nested in (is a child of)
1921 that for \texttt{OUTER} (labelled \texttt{OUTER.AI.1.1}). Nonetheless, the
1922 abstract instance tree for \texttt{INNER} is considered to be separate
1923 and distinct from that for \texttt{OUTER}.
1924
1925 The call of \texttt{OUTER} shown in 
1926 Figure \refersec{fig:inliningexamplespseudosourcefragment}
1927 might be described as
1928 shown in 
1929 Figure \refersec{fig:inliningexample1concreteinstance}.
1930
1931
1932 \begin{figure}[p]
1933 \begin{dwflisting}
1934 \begin{alltt}
1935     ! Abstract instance for OUTER
1936     ! \addtoindexx{abstract instance!example}
1937 OUTER.AI.1.1:
1938     \DWTAGsubprogram
1939         \DWATname("OUTER")
1940         \DWATinline(\DWINLdeclaredinlined)
1941         ! No low/high PCs
1942 OUTER.AI.1.2:
1943         \DWTAGformalparameter
1944             \DWATname("OUTER\_FORMAL")
1945             \DWATtype(reference to integer)
1946             ! No location
1947 OUTER.AI.1.3:
1948         \DWTAGvariable
1949             \DWATname("OUTER\_LOCAL")
1950             \DWATtype(reference to integer)
1951             ! No location
1952         !
1953         ! Abstract instance for INNER
1954         !
1955 INNER.AI.1.1:
1956         \DWTAGsubprogram
1957             \DWATname("INNER")
1958             \DWATinline(\DWINLdeclaredinlined)
1959             ! No low/high PCs
1960 INNER.AI.1.2:
1961             \DWTAGformalparameter
1962                 \DWATname("INNER\_FORMAL")
1963                 \DWATtype(reference to integer)
1964                 ! No location
1965 INNER.AI.1.3:
1966             \DWTAGvariable
1967                 \DWATname("INNER\_LOCAL")
1968                 \DWATtype(reference to integer)
1969                 ! No location
1970             ...
1971             0
1972         ! No \DWTAGinlinedsubroutine (concrete instance)
1973         ! for INNER corresponding to calls of INNER
1974         ...
1975         0
1976 \end{alltt}
1977 \end{dwflisting}
1978 \caption{Inlining example \#1: abstract instance}
1979 \label{fig:inliningexample1abstractinstance}
1980 \end{figure}
1981
1982 \begin{figure}[p]
1983 \begin{dwflisting}
1984 \begin{alltt}
1985 ! Concrete instance for call "OUTER(7)"
1986 ! \addtoindexx{concrete instance!example}
1987 OUTER.CI.1.1:
1988     \DWTAGinlinedsubroutine
1989         ! No name
1990         \DWATabstractorigin(reference to OUTER.AI.1.1)
1991         \DWATlowpc(...)
1992         \DWAThighpc(...)
1993 OUTER.CI.1.2:
1994         \DWTAGformalparameter
1995             ! No name
1996             \DWATabstractorigin(reference to OUTER.AI.1.2)
1997             \DWATconstvalue(7)
1998 OUTER.CI.1.3:
1999         \DWTAGvariable
2000             ! No name
2001             \DWATabstractorigin(reference to OUTER.AI.1.3)
2002             \DWATlocation(...)
2003         !
2004         ! No \DWTAGsubprogram (abstract instance) for INNER
2005         !
2006         ! Concrete instance for call INNER(OUTER\_LOCAL)
2007         !
2008 INNER.CI.1.1:
2009         \DWTAGinlinedsubroutine
2010             ! No name
2011             \DWATabstractorigin(reference to INNER.AI.1.1)
2012             \DWATlowpc(...)
2013             \DWAThighpc(...)
2014             \DWATstaticlink(...)
2015 INNER.CI.1.2:
2016             \DWTAGformalparameter
2017                 ! No name
2018                 \DWATabstractorigin(reference to INNER.AI.1.2)
2019                 \DWATlocation(...)
2020 INNER.CI.1.3:
2021             \DWTAGvariable
2022                 ! No name
2023                 \DWATabstractorigin(reference to INNER.AI.1.3)
2024                 \DWATlocation(...)
2025             ...
2026             0
2027         ! Another concrete instance of INNER within OUTER
2028         ! for the call "INNER(31)"
2029         ...
2030         0
2031 \end{alltt}
2032 \end{dwflisting}
2033 \caption{Inlining example \#1: concrete instance}
2034 \label{fig:inliningexample1concreteinstance}
2035 \end{figure}
2036
2037 \subsection{Alternative \#2: Inline OUTER, multiple INNERs}
2038 \label{app:inlineoutermultiipleinners}
2039
2040
2041 In the second alternative we assume that subprogram \texttt{INNER}
2042 is not inlinable for some reason, but subprogram \texttt{OUTER} is
2043 inlinable. 
2044 \addtoindexx{concrete instance!example}
2045 Each concrete inlined instance of \texttt{OUTER} has its
2046 own normal instance of \texttt{INNER}. 
2047 The abstract instance for \texttt{OUTER},
2048 \addtoindexx{abstract instance!example}
2049 which includes \texttt{INNER}, is shown in 
2050 Figure \refersec{fig:inliningexample2abstractinstance}.
2051
2052 Note that the debugging information in 
2053 Figure \ref{fig:inliningexample2abstractinstance}
2054 differs from that in 
2055 Figure \refersec{fig:inliningexample1abstractinstance}
2056 in that \texttt{INNER} lacks a 
2057 \DWATinline{} attribute
2058 and therefore is not a distinct abstract instance. \texttt{INNER}
2059 is merely an out\dash of\dash line routine that is part of \texttt{OUTER}\textquoteright s
2060 abstract instance. This is reflected in the Figure by
2061 \addtoindexx{abstract instance!example}
2062 the fact that the labels for \texttt{INNER} use the substring \texttt{OUTER}
2063 instead of \texttt{INNER}.
2064
2065 A resulting 
2066 \addtoindexx{concrete instance!example}
2067 concrete inlined instance of \texttt{OUTER} is shown in
2068 Figure \refersec{fig:inliningexample2concreteinstance}.
2069
2070 Notice in 
2071 Figure \ref{fig:inliningexample2concreteinstance}
2072 that \texttt{OUTER} is expanded as a concrete
2073 \addtoindexx{concrete instance!example}
2074 inlined instance, and that \texttt{INNER} is nested within it as a
2075 concrete out\dash of\dash line subprogram. Because \texttt{INNER} is cloned
2076 for each inline expansion of \texttt{OUTER}, only the invariant
2077 attributes of \texttt{INNER} 
2078 (for example, \DWATname) are specified
2079 in the abstract instance of \texttt{OUTER}, and the low\dash level,
2080 \addtoindexx{abstract instance!example}
2081 instance\dash specific attributes of \texttt{INNER} (for example,
2082 \DWATlowpc) are specified in 
2083 each concrete instance of \texttt{OUTER}.
2084 \addtoindexx{concrete instance!example}
2085
2086 The several calls of \texttt{INNER} within \texttt{OUTER} are compiled as normal
2087 calls to the instance of \texttt{INNER} that is specific to the same
2088 instance of \texttt{OUTER} that contains the calls.
2089
2090 \begin{figure}[t]
2091 \begin{dwflisting}
2092 \begin{alltt}
2093     ! Abstract instance for OUTER
2094     ! \addtoindex{abstract instance}
2095 OUTER.AI.2.1:
2096     \DWTAGsubprogram
2097         \DWATname("OUTER")
2098         \DWATinline(\DWINLdeclaredinlined)
2099         ! No low/high PCs
2100 OUTER.AI.2.2:
2101         \DWTAGformalparameter
2102             \DWATname("OUTER\_FORMAL")
2103             \DWATtype(reference to integer)
2104             ! No location
2105 OUTER.AI.2.3:
2106         \DWTAGvariable
2107             \DWATname("OUTER\_LOCAL")
2108             \DWATtype(reference to integer)
2109             ! No location
2110         !
2111         ! Nested out-of-line INNER subprogram
2112         !
2113 OUTER.AI.2.4:
2114         \DWTAGsubprogram
2115             \DWATname("INNER")
2116             ! No \DWATinline
2117             ! No low/high PCs, frame\_base, etc.
2118 OUTER.AI.2.5:
2119             \DWTAGformalparameter
2120                 \DWATname("INNER\_FORMAL")
2121                 \DWATtype(reference to integer)
2122                 ! No location
2123 OUTER.AI.2.6:
2124             \DWTAGvariable
2125                 \DWATname("INNER\_LOCAL")
2126                 \DWATtype(reference to integer)
2127                 ! No location
2128             ...
2129             0
2130         ...
2131         0
2132 \end{alltt}
2133 \end{dwflisting}
2134 \caption{Inlining example \#2: abstract instance}
2135 \label{fig:inliningexample2abstractinstance}
2136 \end{figure}
2137
2138 \begin{figure}[t]
2139 \begin{dwflisting}
2140 \begin{alltt}
2141
2142     ! Concrete instance for call "OUTER(7)"
2143     !
2144 OUTER.CI.2.1:
2145     \DWTAGinlinedsubroutine
2146         ! No name
2147         \DWATabstractorigin(reference to OUTER.AI.2.1)
2148         \DWATlowpc(...)
2149         \DWAThighpc(...)
2150 OUTER.CI.2.2:
2151         \DWTAGformalparameter
2152             ! No name
2153             \DWATabstractorigin(reference to OUTER.AI.2.2)
2154             \DWATlocation(...)
2155 OUTER.CI.2.3:
2156         \DWTAGvariable
2157             ! No name
2158             \DWATabstractorigin(reference to OUTER.AI.2.3)
2159             \DWATlocation(...)
2160         !
2161         ! Nested out-of-line INNER subprogram
2162         !
2163 OUTER.CI.2.4:
2164         \DWTAGsubprogram
2165             ! No name
2166             \DWATabstractorigin(reference to OUTER.AI.2.4)
2167             \DWATlowpc(...)
2168             \DWAThighpc(...)
2169             \DWATframebase(...)
2170             \DWATstaticlink(...)
2171 OUTER.CI.2.5:
2172             \DWTAGformalparameter
2173                 ! No name
2174                 \DWATabstractorigin(reference to OUTER.AI.2.5)
2175                 \DWATlocation(...)
2176 OUTER.CI.2.6:
2177             \DWTAGvariable
2178                 ! No name
2179                 \DWATabstractorigin(reference to OUTER.AT.2.6)
2180                 \DWATlocation(...)
2181             ...
2182             0
2183         ...
2184         0
2185 \end{alltt}
2186 \end{dwflisting}
2187 \caption{Inlining example \#2: concrete instance}
2188 \label{fig:inliningexample2concreteinstance}
2189 \end{figure}
2190
2191 \subsection{Alternative \#3: inline OUTER, one normal INNER}
2192 \label{app:inlineouteronenormalinner}
2193
2194 In the third approach, one normal subprogram for \texttt{INNER} is
2195 compiled which is called from all concrete inlined instances of
2196 \addtoindexx{concrete instance!example}
2197 \addtoindexx{abstract instance!example}
2198 \texttt{OUTER}. The abstract instance for \texttt{OUTER} is shown in 
2199 Figure \refersec{fig:inliningexample3abstractinstance}.
2200
2201 The most distinctive aspect of that Figure is that subprogram
2202 \texttt{INNER} exists only within the abstract instance of \texttt{OUTER},
2203 and not in \texttt{OUTER}\textquoteright s concrete instance. In the abstract
2204 \addtoindexx{concrete instance!example}
2205 \addtoindexx{abstract instance!example}
2206 instance of \texttt{OUTER}, the description of \texttt{INNER} has the full
2207 complement of attributes that would be expected for a
2208 normal subprogram. 
2209 While attributes such as 
2210 \DWATlowpc,
2211 \DWAThighpc, 
2212 \DWATlocation,
2213 and so on, typically are omitted
2214 \addtoindexx{high PC attribute}
2215 from 
2216 \addtoindexx{low PC attribute}
2217 an 
2218 \addtoindexx{location attribute}
2219 abstract instance because they are not invariant across
2220 instances of the containing abstract instance, in this case
2221 those same attributes are included precisely because they are
2222 invariant -- there is only one subprogram \texttt{INNER} to be described
2223 and every description is the same.
2224
2225 A concrete inlined instance of \texttt{OUTER} is illustrated in
2226 Figure \refersec{fig:inliningexample3concreteinstance}.
2227
2228 Notice in 
2229 Figure \ref{fig:inliningexample3concreteinstance}
2230 that there is no DWARF representation for
2231 \texttt{INNER} at all; the representation of \texttt{INNER} does not vary across
2232 instances of \texttt{OUTER} and the abstract instance of \texttt{OUTER} includes
2233 the complete description of \texttt{INNER}, so that the description of
2234 \texttt{INNER} may be (and for reasons of space efficiency, should be)
2235 omitted from each 
2236 \addtoindexx{concrete instance!example}
2237 concrete instance of \texttt{OUTER}.
2238
2239 There is one aspect of this approach that is problematical from
2240 the DWARF perspective. The single compiled instance of \texttt{INNER}
2241 is assumed to access up\dash level variables of \texttt{OUTER}; however,
2242 those variables may well occur at varying positions within
2243 the frames that contain the 
2244 \addtoindexx{concrete instance!example}
2245 concrete inlined instances. A
2246 compiler might implement this in several ways, including the
2247 use of additional compiler-generated parameters that provide
2248 reference parameters for the up\dash level variables, or a 
2249 compiler-generated static link like parameter that points to the group
2250 of up\dash level entities, among other possibilities. In either of
2251 these cases, the DWARF description for the location attribute
2252 of each uplevel variable needs to be different if accessed
2253 from within \texttt{INNER} compared to when accessed from within the
2254 instances of \texttt{OUTER}. An implementation is likely to require
2255 vendor\dash specific DWARF attributes and/or debugging information
2256 entries to describe such cases.
2257
2258 Note that in \addtoindex{C++}, a member function of a class defined within
2259 a function definition does not require any vendor\dash specific
2260 extensions because the \addtoindex{C++} language disallows access to
2261 entities that would give rise to this problem. (Neither \texttt{extern}
2262 variables nor \texttt{static} members require any form of static link
2263 for accessing purposes.)
2264
2265 \begin{figure}[t]
2266 \begin{dwflisting}
2267 \begin{alltt}
2268     ! Abstract instance for OUTER
2269     ! \addtoindexx{abstract instance!example}
2270 OUTER.AI.3.1:
2271     \DWTAGsubprogram
2272         \DWATname("OUTER")
2273         \DWATinline(\DWINLdeclaredinlined)
2274         ! No low/high PCs
2275 OUTER.AI.3.2:
2276         \DWTAGformalparameter
2277             \DWATname("OUTER\_FORMAL")
2278             \DWATtype(reference to integer)
2279             ! No location
2280 OUTER.AI.3.3:
2281         \DWTAGvariable
2282             \DWATname("OUTER\_LOCAL")
2283             \DWATtype(reference to integer)
2284             ! No location
2285         !
2286         ! Normal INNER
2287         !
2288 OUTER.AI.3.4:
2289         \DWTAGsubprogram
2290             \DWATname("INNER")
2291             \DWATlowpc(...)
2292             \DWAThighpc(...)
2293             \DWATframebase(...)
2294             \DWATstaticlink(...)
2295 OUTER.AI.3.5:
2296             \DWTAGformalparameter
2297                 \DWATname("INNER\_FORMAL")
2298                 \DWATtype(reference to integer)
2299                 \DWATlocation(...)
2300 OUTER.AI.3.6:
2301             \DWTAGvariable
2302                 \DWATname("INNER\_LOCAL")
2303                 \DWATtype(reference to integer)
2304                 \DWATlocation(...)
2305             ...
2306             0
2307         ...
2308         0
2309 \end{alltt}
2310 \end{dwflisting}
2311 \caption{Inlining example \#3: abstract instance}
2312 \label{fig:inliningexample3abstractinstance}
2313 \end{figure}
2314
2315 \begin{figure}[t]
2316 \begin{dwflisting}
2317 \begin{alltt}
2318     ! Concrete instance for call "OUTER(7)"
2319     ! \addtoindexx{concrete instance!example}
2320 OUTER.CI.3.1:
2321     \DWTAGinlinedsubroutine
2322         ! No name
2323         \DWATabstractorigin(reference to OUTER.AI.3.1)
2324         \DWATlowpc(...)
2325         \DWAThighpc(...)
2326         \DWATframebase(...)
2327 OUTER.CI.3.2:
2328         \DWTAGformalparameter
2329             ! No name
2330             \DWATabstractorigin(reference to OUTER.AI.3.2)
2331             ! No type
2332             \DWATlocation(...)
2333 OUTER.CI.3.3:
2334         \DWTAGvariable
2335             ! No name
2336             \DWATabstractorigin(reference to OUTER.AI.3.3)
2337             ! No type
2338             \DWATlocation(...)
2339         ! No \DWTAGsubprogram for "INNER"
2340         ...
2341         0
2342 \end{alltt}
2343 \end{dwflisting}
2344 \caption{Inlining example \#3: concrete instance}
2345 \label{fig:inliningexample3concreteinstance}
2346 \end{figure}
2347
2348 \clearpage
2349 \section{Constant Expression Example}
2350 \label{app:constantexpressionexample}
2351 \addtoindex{C++} generalizes the notion of constant expressions to include
2352 constant expression user-defined literals and functions.
2353 The constant declarations in Figure \refersec{fig:constantexpressionscsource}
2354 can be represented as illustrated in 
2355 Figure \refersec{fig:constantexpressionsdwarfdescription}.
2356
2357
2358 \begin{figure}[here]
2359 \begin{lstlisting}[numbers=none]
2360 constexpr double mass = 9.8;
2361 constexpr int square (int x) { return x * x; }
2362 float arr[square(9)]; // square() called and inlined
2363 \end{lstlisting}
2364 \caption{Constant expressions: C++ source} \label{fig:constantexpressionscsource}
2365 \end{figure}
2366
2367
2368 \begin{figure}[!h]
2369 \begin{dwflisting}
2370 \begin{alltt}
2371         ! For variable mass
2372         !
2373 1\$:     \DWTAGconsttype
2374             \DWATtype(reference to "double")
2375 2\$:     \DWTAGvariable
2376             \DWATname("mass")
2377             \DWATtype(reference to 1\$)
2378             \DWATconstexpr(true)
2379             \DWATconstvalue(9.8)
2380         ! Abstract instance for square
2381         !
2382 10\$:    \DWTAGsubprogram
2383             \DWATname("square")
2384             \DWATtype(reference to "int")
2385             \DWATinline(\DWINLinlined)
2386 11\$:        \DWTAGformalparameter
2387                 \DWATname("x")
2388                 \DWATtype(reference to "int")
2389         ! Concrete instance for square(9)
2390         ! \addtoindexx{concrete instance!example}
2391 20\$:    \DWTAGinlinedsubroutine
2392             \DWATabstractorigin(reference to 10\$)
2393             \DWATconstexpr(present)
2394             \DWATconstvalue(81)
2395             \DWTAGformalparameter
2396                 \DWATabstractorigin(reference to 11\$)
2397                 \DWATconstvalue(9)
2398         ! Anonymous array type for arr
2399         !
2400 30\$:    \DWTAGarraytype
2401             \DWATtype(reference to "float")
2402             \DWATbytesize(324) ! 81*4
2403             \DWTAGsubrangetype
2404                 \DWATtype(reference to "int")
2405                 \DWATupperbound(reference to 20\$)
2406         ! Variable arr
2407         !
2408 40\$:    \DWTAGvariable
2409             \DWATname("arr")
2410             \DWATtype(reference to 30\$)
2411 \end{alltt}
2412 \end{dwflisting}
2413 \caption{Constant expressions: DWARF description}
2414 \label{fig:constantexpressionsdwarfdescription}
2415 \end{figure}
2416
2417 \section{Unicode Character Example}
2418 \label{app:unicodecharacterexample}
2419 \addtoindexx{Unicode|see {\textit{also} UTF-8}}
2420 The \addtoindex{Unicode} character encodings in
2421 Figure \refersec{fig:unicodecharacterexamplesource}
2422 can be described in DWARF as illustrated in 
2423 Figure \refersec{fig:unicodecharacterexampledwarfdescription}.
2424
2425 \begin{figure}[!h]
2426 \begin{lstlisting}[numbers=none]
2427 // C++ source
2428 //
2429 char16_t chr_a = u'h';
2430 char32_t chr_b = U'h';
2431 \end{lstlisting}
2432 \caption{Unicode character example: source}
2433 \label{fig:unicodecharacterexamplesource}
2434 \end{figure}
2435
2436 \begin{figure}[h]
2437 \begin{dwflisting}
2438 \begin{alltt}
2439
2440 ! DWARF description
2441 !
2442 1\$: \DWTAGbasetype
2443         \DWATname("char16\_t")
2444         \DWATencoding(\DWATEUTF)
2445         \DWATbytesize(2)
2446 2\$: \DWTAGbasetype
2447         \DWATname("char32\_t")
2448         \DWATencoding(\DWATEUTF)
2449         \DWATbytesize(4)
2450 3\$: \DWTAGvariable
2451         \DWATname("chr\_a")
2452         \DWATtype(reference to 1\$)
2453 4\$: \DWTAGvariable
2454         \DWATname("chr\_b")
2455         \DWATtype(reference to 2\$)
2456 \end{alltt}
2457 \end{dwflisting}
2458 \caption{Unicode character example: DWARF description}
2459 \label{fig:unicodecharacterexampledwarfdescription}
2460 \end{figure}
2461
2462
2463 \section{Type-Safe Enumeration Example}
2464 \label{app:typesafeenumerationexample}
2465
2466 The \addtoindex{C++} type\dash safe enumerations in
2467 \addtoindexx{type-safe enumeration}
2468 Figure \refersec{fig:ctypesafeenumerationexamplesource}
2469 can be described in DWARF as illustrated in 
2470 Figure \refersec{fig:ctypesafeenumerationexampledwarf}.
2471
2472 \clearpage      % Get following source and DWARF on same page
2473
2474 \begin{figure}[H]
2475 \begin{lstlisting}[numbers=none]
2476 // C++ source
2477 //
2478 enum class E { E1, E2=100 };
2479 E e1;
2480 \end{lstlisting}
2481 \caption{Type-safe enumeration example: source}
2482 \label{fig:ctypesafeenumerationexamplesource}
2483 \end{figure}
2484
2485 \begin{figure}[H]
2486 \begin{dwflisting}
2487 \begin{alltt}
2488 ! DWARF description
2489 !
2490 11\$:  \DWTAGenumerationtype
2491           \DWATname("E")
2492           \DWATtype(reference to "int")
2493           \DWATenumclass(present)
2494 12\$:      \DWTAGenumerator
2495               \DWATname("E1")
2496               \DWATconstvalue(0)
2497 13\$:      \DWTAGenumerator
2498               \DWATname("E2")
2499               \DWATconstvalue(100)
2500 14\$:  \DWTAGvariable
2501          \DWATname("e1")
2502          \DWATtype(reference to 11\$)
2503 \end{alltt}
2504 \end{dwflisting}
2505 \caption{Type-safe enumeration example: DWARF description}
2506 \label{fig:ctypesafeenumerationexampledwarf}
2507 \end{figure}
2508
2509
2510 \clearpage
2511 \section{Template Examples}
2512 \label{app:templateexample}
2513
2514 The \addtoindex{C++} template example in
2515 Figure \refersec{fig:ctemplateexample1source}
2516 can be described in DWARF as illustrated in 
2517 Figure \refersec{fig:ctemplateexample1dwarf}.
2518
2519 \begin{figure}[h]
2520 \begin{lstlisting}
2521 // C++ source
2522 //
2523 template<class T>
2524 struct wrapper {
2525     T comp;
2526 };
2527 wrapper<int> obj;
2528 \end{lstlisting}
2529 \caption{C++ template example \#1: source}
2530 \label{fig:ctemplateexample1source}
2531 \end{figure}
2532
2533 \begin{figure}[h]
2534 \begin{dwflisting}
2535 \begin{alltt}
2536 ! DWARF description
2537 !
2538 11\$: \DWTAGstructuretype
2539         \DWATname("wrapper")
2540 12\$:    \DWTAGtemplatetypeparameter
2541             \DWATname("T")
2542             \DWATtype(reference to "int")
2543 13\$:    \DWTAGmember
2544             \DWATname("comp")
2545             \DWATtype(reference to 12\$)
2546 14\$: \DWTAGvariable
2547         \DWATname("obj")
2548         \DWATtype(reference to 11\$)
2549 \end{alltt}
2550 \end{dwflisting}
2551 \caption{C++ template example \#1: DWARF description}
2552 \label{fig:ctemplateexample1dwarf}
2553 \end{figure}
2554
2555 The actual type of the component \texttt{comp} is \texttt{int}, but in the DWARF
2556 the type references the
2557 \DWTAGtemplatetypeparameter{}
2558 for \texttt{T}, which in turn references \texttt{int}. This implies that in the
2559 original template comp was of type \texttt{T} and that was replaced
2560 with \texttt{int} in the instance. 
2561
2562 \needlines{10}
2563 There exist situations where it is
2564 not possible for the DWARF to imply anything about the nature
2565 of the original template. 
2566 Consider the \addtoindex{C++} template source in
2567 Figure \refersec{fig:ctemplateexample2source}
2568 and the DWARF that can describe it in
2569 Figure \refersec{fig:ctemplateexample2dwarf}.
2570
2571 \begin{figure}[!h]
2572 \begin{lstlisting}
2573 // C++ source
2574 //
2575     template<class T>
2576     struct wrapper {
2577         T comp;
2578     };
2579     template<class U>
2580     void consume(wrapper<U> formal)
2581     {
2582         ...
2583     }
2584     wrapper<int> obj;
2585     consume(obj);
2586 \end{lstlisting}
2587 \caption{C++ template example \#2: source}
2588 \label{fig:ctemplateexample2source}
2589 \end{figure}
2590
2591 \begin{figure}[h]
2592 \begin{dwflisting}
2593 \begin{alltt}
2594 ! DWARF description
2595 !
2596 11\$:  \DWTAGstructuretype
2597           \DWATname("wrapper")
2598 12\$:      \DWTAGtemplatetypeparameter
2599               \DWATname("T")
2600               \DWATtype(reference to "int")
2601 13\$:      \DWTAGmember
2602               \DWATname("comp")
2603               \DWATtype(reference to 12\$)
2604 14\$:  \DWTAGvariable
2605           \DWATname("obj")
2606           \DWATtype(reference to 11\$)
2607 21\$:  \DWTAGsubprogram
2608           \DWATname("consume")
2609 22\$:      \DWTAGtemplatetypeparameter
2610               \DWATname("U")
2611               \DWATtype(reference to "int")
2612 23\$:      \DWTAGformalparameter
2613               \DWATname("formal")
2614               \DWATtype(reference to 11\$)
2615 \end{alltt}
2616 \end{dwflisting}
2617 \caption{C++ template example \#2: DWARF description}
2618 \label{fig:ctemplateexample2dwarf}
2619 \end{figure}
2620
2621 In the \DWTAGsubprogram{} 
2622 entry for the instance of consume, \texttt{U} is described as \texttt{int}. 
2623 The type of formal is \texttt{wrapper\textless U\textgreater} in
2624 the source. DWARF only represents instantiations of templates;
2625 there is no entry which represents \texttt{wrapper\textless U\textgreater} 
2626 which is neither
2627 a template parameter nor a template instantiation. The type
2628 of formal is described as \texttt{wrapper\textless int\textgreater},
2629 the instantiation of \texttt{wrapper\textless U\textgreater},
2630 in the \DWATtype{} attribute at 
2631 23\$. 
2632 There is no
2633 description of the relationship between template type parameter
2634 \texttt{T} at 12\$ and \texttt{U} at 22\$ which was used to instantiate
2635 \texttt{wrapper\textless U\textgreater}.
2636
2637 A consequence of this is that the DWARF information would
2638 not distinguish between the existing example and one where
2639 the formal parameter of \texttt{consume} were declared in the source to be
2640 \texttt{wrapper\textless int\textgreater}.
2641
2642
2643 \section{Template Alias Examples}
2644 \label{app:templatealiasexample}
2645
2646 The \addtoindex{C++} template alias shown in
2647 Figure \refersec{fig:ctemplatealiasexample1source}
2648 can be described in DWARF as illustrated 
2649 \addtoindexx{template alias example} in 
2650 Figure \refersec{fig:ctemplatealiasexample1dwarf}.
2651
2652 \begin{figure}[h]
2653 \begin{lstlisting}
2654 // C++ source, template alias example 1
2655 //
2656 template<typename T, typename U>
2657 struct Alpha {
2658     T tango;
2659     U uniform;
2660 };
2661 template<typename V> using Beta = Alpha<V,V>;
2662 Beta<long> b;
2663 \end{lstlisting}
2664 \caption{C++ template alias example \#1: source}
2665 \label{fig:ctemplatealiasexample1source}
2666 \end{figure}
2667
2668 \begin{figure}[h]
2669 \addtoindexx{template alias example 1}
2670 \begin{dwflisting}
2671 \begin{alltt}
2672 ! DWARF representation for variable 'b'
2673 !
2674 20\$:  \DWTAGstructuretype
2675           \DWATname("Alpha")
2676 21\$:      \DWTAGtemplatetypeparameter
2677               \DWATname("T")
2678               \DWATtype(reference to "long")
2679 22\$:      \DWTAGtemplatetypeparameter
2680               \DWATname("U")
2681               \DWATtype(reference to "long")
2682 23\$:      \DWTAGmember
2683               \DWATname("tango")
2684               \DWATtype(reference to 21\$)
2685 24\$:      \DWTAGmember
2686               \DWATname("uniform")
2687               \DWATtype(reference to 22\$)
2688 25\$:  \DWTAGtemplatealias
2689           \DWATname("Beta")
2690           \DWATtype(reference to 20\$)
2691 26\$:      \DWTAGtemplatetypeparameter
2692               \DWATname("V")
2693               \DWATtype(reference to "long")
2694 27\$:  \DWTAGvariable
2695           \DWATname("b")
2696           \DWATtype(reference to 25\$)
2697 \end{alltt}
2698 \end{dwflisting}
2699 \caption{C++ template alias example \#1: DWARF description}
2700 \label{fig:ctemplatealiasexample1dwarf}
2701 \end{figure}
2702
2703 Similarly, the \addtoindex{C++} template alias shown in
2704 Figure \refersec{fig:ctemplatealiasexample2source}
2705 can be described in DWARF as illustrated 
2706 \addtoindexx{template alias example} in 
2707 Figure \refersec{fig:ctemplatealiasexample2dwarf}.
2708
2709 \begin{figure}[h]
2710 \begin{lstlisting}
2711 // C++ source, template alias example 2
2712 //
2713 template<class TX> struct X { };
2714 template<class TY> struct Y { };
2715 template<class T> using Z = Y<T>;
2716 X<Y<int>> y;
2717 X<Z<int>> z;
2718 \end{lstlisting}
2719 \caption{C++ template alias example \#2: source}
2720 \label{fig:ctemplatealiasexample2source}
2721 \end{figure}
2722
2723 \begin{figure}[h]
2724 \addtoindexx{template alias example 2}
2725 \begin{dwflisting}
2726 \begin{alltt}
2727 ! DWARF representation for X<Y<int>>
2728 !
2729 30\$:  \DWTAGstructuretype
2730           \DWATname("Y")
2731 31\$:      \DWTAGtemplatetypeparameter
2732               \DWATname("TY")
2733               \DWATtype(reference to "int")
2734 32\$:  \DWTAGstructuretype
2735           \DWATname("X")
2736 33\$:      \DWTAGtemplatetypeparameter
2737               \DWATname("TX")
2738               \DWATtype(reference to 30\$)
2739 !
2740 ! DWARF representation for X<Z<int>>
2741 !
2742 40\$:  \DWTAGtemplatealias
2743           \DWATname("Z")
2744           \DWATtype(reference to 30\$)
2745 41\$:      \DWTAGtemplatetypeparameter
2746               \DWATname("T")
2747               \DWATtype(reference to "int")
2748 42\$:  \DWTAGstructuretype
2749           \DWATname("X")
2750 43\$:      \DWTAGtemplatetypeparameter
2751               \DWATname("TX")
2752               \DWATtype(reference to 40\$)
2753 !
2754 ! Note that 32\$ and 42\$ are actually the same type
2755 !
2756 50\$:  \DWTAGvariable
2757           \DWATname("y")
2758           \DWATtype(reference to \$32)
2759 51\$:  \DWTAGvariable
2760           \DWATname("z")
2761           \DWATtype(reference to \$42)
2762 \end{alltt}
2763 \end{dwflisting}
2764 \caption{C++ template alias example \#2: DWARF description}
2765 \label{fig:ctemplatealiasexample2dwarf}
2766 \end{figure}
2767
2768 \clearpage
2769 \section{Implicit Pointer Examples}
2770 \label{app:implicitpointerexamples}
2771 If the compiler determines that the value of an object is
2772 constant (either throughout the program, or within a specific
2773 range), it may choose to materialize that constant only when
2774 used, rather than store it in memory or in a register. The
2775 \DWOPimplicitvalue{} operation can be used to describe such a
2776 value. Sometimes, the value may not be constant, but still can be
2777 easily rematerialized when needed. A DWARF expression terminating
2778 in \DWOPstackvalue{} can be used for this case. The compiler may
2779 also eliminate a pointer value where the target of the pointer
2780 resides in memory, and the \DWOPstackvalue{} operator may be used
2781 to rematerialize that pointer value. In other cases, the compiler
2782 will eliminate a pointer to an object that itself needs to be
2783 materialized. Since the location of such an object cannot be
2784 represented as a memory address, a DWARF expression cannot give
2785 either the location or the actual value or a pointer variable
2786 that would refer to that object. The \DWOPimplicitpointer{}
2787 operation can be used to describe the pointer, and the debugging
2788 information entry to which its first operand refers describes the
2789 value of the dereferenced object. A DWARF consumer will not be
2790 able to show the location or the value of the pointer variable,
2791 but it will be able to show the value of the dereferenced
2792 pointer.
2793
2794 Consider the \addtoindex{C} source shown in 
2795 Figure \refersec{fig:cimplicitpointerexample1source}.
2796 Assume that the function \texttt{foo} is not inlined,
2797 that the argument x is passed in register 5, and that the
2798 function \texttt{foo} is optimized by the compiler into just 
2799 an increment of the volatile variable \texttt{v}. Given these
2800 assumptions a possible DWARF description is shown in
2801 Figure \refersec{fig:cimplicitpointerexample1dwarf}.
2802
2803 \begin{figure}[h]
2804 \begin{lstlisting}
2805 struct S { short a; char b, c; };
2806 volatile int v;
2807 void foo (int x)
2808 {
2809     struct S s = { x, x + 2, x + 3 };
2810     char *p = &s.b;
2811     s.a++;
2812     v++;
2813 }
2814 int main ()
2815 {
2816     foo (v+1);
2817     return 0;
2818 }
2819 \end{lstlisting}
2820 \caption{C implicit pointer example \#1: source}
2821 \label{fig:cimplicitpointerexample1source}
2822 \end{figure}
2823
2824 \begin{figure}[h]
2825 \addtoindexx{implicit pointer example \#1}
2826 \begin{dwflisting}
2827 \begin{alltt}
2828 1\$: \DWTAGstructuretype
2829         \DWATname("S")
2830         \DWATbytesize(4)
2831 10\$:    \DWTAGmember
2832             \DWATname("a")
2833             \DWATtype(reference to "short int")
2834             \DWATdatamemberlocation(constant 0)
2835 11\$:    \DWTAGmember
2836             \DWATname("b")
2837             \DWATtype(reference to "char")
2838             \DWATdatamemberlocation(constant 2)
2839 12\$:    \DWTAGmember
2840             \DWATname("c")
2841             \DWATtype(reference to "char")
2842             \DWATdatamemberlocation(constant 3)
2843 2\$: \DWTAGsubprogram
2844         \DWATname("foo")
2845 20\$:    \DWTAGformalparameter
2846             \DWATname("x")
2847             \DWATtype(reference to "int")
2848             \DWATlocation(\DWOPregfive)
2849 21\$:    \DWTAGvariable
2850             \DWATname("s")
2851             \DWATlocation(expression=
2852                 \DWOPbregfive(1) \DWOPstackvalue \DWOPpiece(2)
2853                 \DWOPbregfive(2) \DWOPstackvalue \DWOPpiece(1)
2854                 \DWOPbregfive(3) \DWOPstackvalue \DWOPpiece(1))
2855 22\$:    \DWTAGvariable
2856             \DWATname("p")
2857             \DWATtype(reference to "char *")
2858             \DWATlocation(expression=
2859             \DWOPimplicitpointer(reference to 21\$, 2))
2860 \end{alltt}
2861 \end{dwflisting}
2862 \caption{C implicit pointer example \#1: DWARF description}
2863 \label{fig:cimplicitpointerexample1dwarf}
2864 \end{figure}
2865
2866 In Figure \refersec{fig:cimplicitpointerexample1dwarf},
2867 even though variables \texttt{s} and \texttt{p} are both optimized 
2868 away completely, this DWARF description still allows a debugger to 
2869 print the value of the variable \texttt{s}, namely \texttt{(2, 3, 4)}. 
2870 Similarly, because the variable \texttt{s} does not live in
2871 memory, there is nothing to print for the value of \texttt{p}, but the 
2872 debugger should still be able to show that \texttt{p[0]} is 3, 
2873 \texttt{p[1]} is 4, \texttt{p[-1]} is 0 and \texttt{p[-2]} is 2.
2874
2875 \needlines{6}
2876 As a further example, consider the C source 
2877 shown in Figure \refersec{fig:cimplicitpointerexample2source}. Make
2878 the following assumptions about how the code is compiled:
2879 \begin{itemize}
2880 \item The function \texttt{foo} is inlined
2881 into function \texttt{main}
2882 \item The body of the main function is optimized to just
2883 three blocks of instructions which each increment the volatile
2884 variable \texttt{v}, followed by a block of instructions to return 0 from
2885 the function
2886 \item Label \texttt{label0} is at the start of the main
2887 function, \texttt{label1} follows the first \texttt{v++} block, 
2888 \texttt{label2} follows the second \texttt{v++} block and 
2889 \texttt{label3} is at the end of the main function
2890 \item Variable \texttt{b} is optimized away completely, as it isn't used
2891 \item The string literal \texttt{"opq"} is optimized away as well
2892 \end{itemize}
2893 Given these assumptions a possible DWARF description is shown in
2894 Figure \refersec{fig:cimplicitpointerexample2dwarf}.
2895
2896 \begin{figure}[h]
2897 \begin{lstlisting}
2898 static const char *b = "opq";
2899 volatile int v;
2900 static inline void foo (int *p)
2901 {
2902     (*p)++;
2903     v++;
2904     p++;
2905     (*p)++;
2906     v++;
2907 }
2908 int main ()
2909 {
2910     int a[2] = { 1, 2 };
2911     v++;
2912     foo (a);
2913     return a[0] + a[1] - 5;
2914 }
2915 \end{lstlisting}
2916 \caption{C implicit pointer example \#2: source}
2917 \label{fig:cimplicitpointerexample2source}
2918 \end{figure}
2919
2920 \begin{figure}[h]
2921 \addtoindexx{implicit pointer example \#2}
2922 \begin{dwflisting}
2923 \begin{alltt}
2924 1\$: \DWTAGvariable
2925         \DWATname("b")
2926         \DWATtype(reference to "const char *")
2927         \DWATlocation(expression=
2928             \DWOPimplicitpointer(reference to 2$, 0))
2929 2\$: \DWTAGdwarfprocedure
2930         \DWATlocation(expression=
2931             \DWOPimplicitvalue(4, \{'o', 'p', 'q', '\slash0'\}))
2932 3\$: \DWTAGsubprogram
2933         \DWATname("foo")
2934         \DWATinline(\DWINLdeclaredinlined)
2935 30\$:    \DWTAGformalparameter
2936             \DWATname("p")
2937             \DWATtype(reference to "int *")
2938 4\$: \DWTAGsubprogram
2939         \DWATname("main")
2940 40\$:   \DWTAGvariable
2941             \DWATname("a")
2942             \DWATtype(reference to "int[2]")
2943             \DWATlocation(location list 98$)
2944 41\$:    \DWTAGinlinedsubroutine
2945             \DWATabstractorigin(reference to 3$)
2946 42\$:        \DWTAGformalparameter
2947             \DWATabstractorigin(reference to 30$)
2948             \DWATlocation(location list 99$)
2949
2950 ! .debug_loc section
2951 98\$:<label0 in main> .. <label1 in main>
2952         \DWOPlitone \DWOPstackvalue \DWOPpiece(4)
2953         \DWOPlittwo \DWOPstackvalue \DWOPpiece(4)
2954     <label1 in main> .. <label2 in main>
2955         \DWOPlittwo \DWOPstackvalue \DWOPpiece(4)
2956         \DWOPlittwo \DWOPstackvalue \DWOPpiece(4)
2957     <label2 in main> .. <label3 in main>
2958         \DWOPlittwo \DWOPstackvalue \DWOPpiece(4)
2959         \DWOPlitthree \DWOPstackvalue \DWOPpiece(4)
2960     0 .. 0
2961 99\$:<label1 in main> .. <label2 in main>
2962         \DWOPimplicitpointer(reference to 40\$, 0)
2963     <label2 in main> .. <label3 in main>
2964         \DWOPimplicitpointer(reference to 40\$, 4)
2965     0 .. 0
2966 \end{alltt}
2967 \end{dwflisting}
2968 \caption{C implicit pointer example \#2: DWARF description}
2969 \label{fig:cimplicitpointerexample2dwarf}
2970 \end{figure}
2971
2972 \clearpage
2973 \section{String Type Examples}
2974 \label{app:stringtypeexamples}
2975 Consider the \addtoindex{Fortran 2003} string type example source in
2976 Figure \referfol{fig:stringtypeexamplesource}. The DWARF representation in
2977 Figure \refersec{fig:stringtypeexampledwarf} is appropriate.
2978
2979 \begin{figure}[h]
2980 \begin{lstlisting}
2981         program character_kind
2982             use iso_fortran_env
2983             implicit none
2984             integer, parameter :: ascii = selected_char_kind ("ascii")
2985             integer, parameter :: ucs4  = selected_char_kind ('ISO_10646')
2986               
2987             character(kind=ascii, len=26) :: alphabet
2988             character(kind=ucs4,  len=30) :: hello_world
2989             character (len=*), parameter :: all_digits="0123456789"
2990               
2991             alphabet = ascii_"abcdefghijklmnopqrstuvwxyz"
2992             hello_world = ucs4_'Hello World and Ni Hao -- ' &
2993                           // char (int (z'4F60'), ucs4)     &
2994                           // char (int (z'597D'), ucs4)
2995               
2996             write (*,*) alphabet
2997             write (*,*) all_digits
2998               
2999             open (output_unit, encoding='UTF-8')
3000             write (*,*) trim (hello_world)
3001         end program character_kind
3002 \end{lstlisting}
3003 \caption{String type example: source}
3004 \label{fig:stringtypeexamplesource}
3005 \end{figure}
3006
3007 \begin{figure}[h]
3008 \begin{dwflisting}
3009 \begin{alltt}
3010
3011 1\$: \DWTAGbasetype
3012         \DWATencoding (\DWATEASCII)
3013
3014 2\$: \DWTAGbasetype
3015         \DWATencoding (\DWATEUCS)
3016         \DWATbytesize (4)
3017
3018 3\$: \DWTAGstringtype
3019         \DWATbytesize (10)
3020
3021 4\$: \DWTAGconsttype
3022         \DWATtype (reference to 3\$)
3023       
3024 5\$: \DWTAGstringtype
3025         \DWATtype (1\$)
3026         \DWATstringlength ( ... )
3027         \DWATstringlengthbytesize ( ... )
3028         \DWATdatalocation ( ... )
3029       
3030 6\$: \DWTAGstringtype
3031         \DWATtype (2\$)
3032         \DWATstringlength ( ... )
3033         \DWATstringlengthbytesize ( ... )
3034         \DWATdatalocation ( ... )
3035
3036 7\$: \DWTAGvariable
3037         \DWATname (alphabet)
3038         \DWATtype (5\$)
3039         \DWATlocation ( ... )
3040
3041 8\$: \DWTAGconstant
3042         \DWATname (all\_digits)
3043         \DWATtype (4\$)
3044         \DWATconstvalue ( ... )
3045
3046 9\$: \DWTAGvariable
3047         \DWATname (hello\_world)
3048         \DWATtype (6\$)
3049         \DWATlocation ( ... )
3050         
3051 \end{alltt}
3052 \end{dwflisting}
3053 \caption{String type example: DWARF representation}
3054 \label{fig:stringtypeexampledwarf}
3055 \end{figure}
3056
3057 \clearpage
3058 \section{Call Site Examples}
3059 \label{app:callsiteexamples}
3060 The following examples use a hypothetical machine which: 
3061 \begin{itemize}
3062 \item
3063 Passes the first argument in register 0, the second in register 1, and the third in register 2.
3064 \item
3065 Keeps the stack pointer is register 3.
3066 \item
3067 Has one call preserved register 4.
3068 \item
3069 Returns a function value in register 0.
3070 \end{itemize}
3071
3072 \subsection{Call Site Example \#1 (C)}
3073 Consider the \addtoindex{C} source in Figure \referfol{fig:callsiteexample1source}.
3074
3075 \begin{figure}[h]
3076 \begin{lstlisting}
3077
3078 extern void fn1 (long int, long int, long int);
3079
3080 long int
3081 fn2 (long int a, long int b, long int c) 
3082 {
3083     long int q = 2 * a;
3084     fn1 (5, 6, 7); 
3085     return 0;
3086 }
3087  
3088 long int
3089 fn3 (long int x, long int (*fn4) (long int *))
3090 {
3091     long int v, w, w2, z;
3092     w = (*fn4) (&w2);
3093     v = (*fn4) (&w2);
3094     z = fn2 (1, v + 1, w);
3095     {
3096         int v1 = v + 4;
3097         z += fn2 (w, v * 2, x);
3098     }
3099     return z;
3100 }
3101 \end{lstlisting}
3102 \caption{Call Site Example \#1: Source}
3103 \label{fig:callsiteexample1source}
3104 \end{figure}
3105
3106 Possible generated code for this source is shown using a suggestive 
3107 pseudo-\linebreak[0]assembly notation in Figure \refersec{fig:callsiteexample1code}.
3108
3109 \begin{figure}[ht]
3110 \begin{lstlisting}
3111 fn2:
3112 L1:
3113     %reg2 = 7   ! Load the 3rd argument to fn1
3114     %reg1 = 6   ! Load the 2nd argument to fn1
3115     %reg0 = 5   ! Load the 1st argument to fn1
3116 L2:
3117     call fn1
3118     %reg0 = 0   ! Load the return value from the function
3119     return
3120 L3:
3121 fn3:
3122     ! Decrease stack pointer to reserve local stack frame
3123     %reg3 = %reg3 - 32
3124     [%reg3] = %reg4       ! Save the call preserved register to
3125                           !   stack
3126     [%reg3 + 8] = %reg0   ! Preserve the x argument value
3127     [%reg3 + 16] = %reg1  ! Preserve the fn4 argument value
3128     %reg0 = %reg3 + 24    ! Load address of w2 as argument
3129     call %reg1            ! Call fn4 (indirect call)
3130 L6:
3131     %reg2 = [%reg3 + 16]  ! Load the fn4 argument value
3132     [%reg3 + 16] = %reg0  ! Save the result of the first call (w)
3133     %reg0 = %reg3 + 24    ! Load address of w2 as argument
3134     call %reg2            ! Call fn4 (indirect call)
3135 L7:
3136     %reg4 = %reg0         ! Save the result of the second call (v) 
3137                           !   into register.
3138     %reg2 = [%reg3 + 16]  ! Load 3rd argument to fn2 (w)
3139     %reg1 = %reg4 + 1     ! Compute 2nd argument to fn2 (v + 1)
3140     %reg0 = 1             ! Load 1st argument to fn2
3141     call fn2
3142 L4:
3143     %reg2 = [%reg3 + 8]   ! Load the 3rd argument to fn2 (x)
3144     [%reg3 + 8] = %reg0   ! Save the result of the 3rd call (z)
3145     %reg0 = [%reg3 + 16]  ! Load the 1st argument to fn2 (w)
3146     %reg1 = %reg4 + %reg4 ! Compute the 2nd argument to fn2 (v * 2)
3147     call fn2
3148 L5:
3149     %reg2 = [%reg3 + 8]   ! Load the value of z from the stack
3150     %reg0 = %reg0 + %reg2 ! Add result from the 4th call to it
3151 L8:
3152     %reg4 = [%reg3]       ! Restore original value of call preserved 
3153                           !   register
3154     %reg3 = %reg3 + 32    ! Leave stack frame
3155     return
3156 \end{lstlisting}
3157 \caption{Call Site Example \#1: Code}
3158 \label{fig:callsiteexample1code}
3159 \end{figure}
3160
3161 \clearpage
3162 The location list for variable \texttt{a} in function \texttt{fn2}
3163 might look like:
3164 %\begin{figure}[h]
3165 \begin{lstlisting}
3166
3167 ! Before the call to fn1 the argument a is live in the register 0
3168 !
3169 <L1, L2> DW_OP_reg0
3170
3171 ! Afterwards it is not, the call could have clobbered the register,
3172 ! and it is not saved in the fn2 function stack frame either, but 
3173 ! perhap scan be looked up in the caller
3174 !
3175 <L2, L3> DW_OP_entry_value 1 DW_OP_reg0 DW_OP_stack_value
3176 <0, 0>
3177
3178 \end{lstlisting}
3179 %\end{figure}
3180 (where the notation \doublequote{\texttt{<m, n>}} specifies the address
3181 range over which the following location description applies).
3182
3183 Similarly, the variable q in fn2 then might have location list:
3184 \begin{lstlisting}
3185
3186 ! Before the call to fn1 the value of q can be computed as two times
3187 ! the value of register 0
3188 !
3189 <L1, L2> DW_OP_lit2 DW_OP_breg0 0 DW_OP_mul DW_OP_stack_value
3190
3191 ! Afterwards it can be computed from the original value of the first
3192 ! parameter, multiplied by two
3193 !
3194 <L2, L3> DW_OP_lit2 DW_OP_entry_value 1 DW_OP_reg0 DW_OP_mul DW_OP_stack_value
3195 <0, 0>
3196
3197 \end{lstlisting}
3198
3199 Variables \texttt{b} and \texttt{c} each have a location list similar to 
3200 that for variable \texttt{a},
3201 except for a different label between the two ranges and they
3202 use \DWOPregone{} and \DWOPregtwo{}, respectively, instead of \DWOPregzero.
3203
3204
3205 The call sites for all the calls in function \texttt{fn3} are children of the
3206 \DWTAGsubprogram{} entry for \texttt{fn3} (or of its \DWTAGlexicalblock{} entry
3207 if there is any for the whole function). 
3208 This is shown in Figure \refersec{fig:callsiteexample1dwarf}.
3209
3210 \begin{figure}[h]
3211 \figurepart{1}{2}
3212 \begin{dwflisting}
3213 \begin{alltt}
3214     \DWTAGcallsite
3215         \DWATcallreturnpc(L6) ! First indirect call to (*fn4) in fn3.
3216         ! The address of the call is preserved across the call in memory at
3217         ! stack pointer + 16 bytes.
3218         \DWATcalltarget(\DWOPbregthree{} 16 \DWOPderef)
3219         \DWTAGcallsiteparameter
3220             \DWATlocation(\DWOPregzero)
3221             ! Value of the first parameter is equal to stack pointer + 24 bytes.
3222             \DWATcallvalue(\DWOPbregthree{} 24)
3223     \DWTAGcallsite
3224         \DWATcallreturnpc(L7) ! Second indirect call to (*fn4) in fn3.
3225         ! The address of the call is not preserved across the call anywhere, but
3226         ! could be perhaps looked up in fn3's caller.
3227         \DWATcalltarget(\DWOPentryvalue{} 1 \DWOPregone)
3228         \DWTAGcallsiteparameter
3229             \DWATlocation(\DWOPregzero)
3230             \DWATcallvalue(\DWOPbregthree{} 24)
3231     \DWTAGcallsite
3232         \DWATcallreturnpc(L4) ! 3rd call in fn3, direct call to fn2
3233         \DWATcallorigin(reference to fn2 DW_TAG_subprogram)
3234         \DWTAGcallsiteparameter
3235             \DWATcallparameter(reference to formal parameter a in subprogram fn2)
3236             \DWATlocation(\DWOPregzero)
3237             ! First parameter to fn2 is constant 1
3238             \DWATcallvalue(\DWOPlitone)
3239         \DWTAGcallsiteparameter
3240             \DWATcallparameter(reference to formal parameter b in subprogram fn2)
3241             \DWATlocation(\DWOPregone)
3242             ! Second parameter to fn2 can be computed as the value of the call
3243             !   preserved register 4 in the fn3 function plus one
3244             \DWATcallvalue(\DWOPbregfour{} 1)
3245         \DWTAGcallsiteparameter
3246             \DWATcallparameter(reference to formal parameter c in subprogram fn2)
3247             \DWATlocation(\DWOPregtwo)
3248             ! Third parameter's value is preserved in memory at fn3's stack pointer
3249             !   plus 16 bytes
3250             \DWATcallvalue(\DWOPbregthree{} 16 \DWOPderef)
3251 \end{alltt}
3252 \end{dwflisting}
3253 \caption{Call Site Example \#1: DWARF Encoding}
3254 \label{fig:callsiteexample1dwarf}
3255 \end{figure}
3256
3257 \begin{figure}
3258 \figurepart{2}{2}
3259 \begin{dwflisting}
3260 \begin{alltt}
3261 \DWTAGlexicalblock
3262     \DWATlowpc(L4)
3263     \DWAThighpc(L8)
3264     \DWTAGvariable
3265         \DWATname("v1")
3266         \DWATtype(reference to int)
3267         ! Value of the v1 variable can be computed as value of register 4 plus 4
3268         \DWATlocation(\DWOPbregfour{} 4 \DWOPstackvalue)
3269     \DWTAGcallsite
3270         \DWATcallreturnpc(L5) ! 4th call in fn3, direct call to fn2
3271         \DWATcalltarget(reference to subprogram fn2)
3272         \DWTAGcallsiteparameter
3273             \DWATcallparameter(reference to formal parameter a in subprogram fn2)
3274             \DWATlocation(\DWOPregzero)
3275             ! Value of the 1st argument is preserved in memory at fn3's stack 
3276             !   pointer + 16 bytes.
3277             \DWATcallvalue(\DWOPbregthree{} 16 \DWOPderef)
3278         \DWTAGcallsiteparameter
3279             \DWATcallparameter(reference to formal parameter b in subprogram fn2)
3280             \DWATlocation(\DWOPregone)
3281             ! Value of the 2nd argument can be computed using the preserved 
3282             !   register 4 multiplied by 2
3283             \DWATcallvalue(\DWOPlittwo{} \DWOPregfour{} 0 \DWOPmul)
3284         \DWTAGcallsiteparameter
3285             \DWATcallparameter(reference to formal parameter c in subprogram fn2)
3286             \DWATlocation(\DWOPregtwo)
3287             ! Value of the 3rd argument is not preserved, but could be perhaps 
3288             ! computed from the value passed fn3's caller.
3289             \DWATcallvalue(\DWOPentryvalue{} 1 \DWOPregzero)
3290 \end{alltt}
3291 \end{dwflisting}
3292 \begin{center}
3293 \vspace{0.4cm}
3294 Figure~\ref{fig:callsiteexample1dwarf} Call Site Example \#1: DWARF Encoding \textit{(concluded)}
3295 \end{center}
3296 \end{figure}
3297
3298 \clearpage
3299 \subsection{Call Site Example \#2 (Fortran)}
3300 Consider the \addtoindex{Fortran} source in 
3301 Figure \refersec{fig:callsiteexample2source}
3302 which is used to illustrate how Fortran's \doublequote{pass by reference}
3303 parameters can be handled.
3304
3305 \begin{figure}[h]
3306 \begin{lstlisting}
3307 subroutine fn4 (n)
3308     integer :: n, x
3309     x = n
3310     n = n / 2
3311     call fn6
3312 end subroutine
3313 subroutine fn5 (n)
3314     interface fn4
3315         subroutine fn4 (n)
3316             integer :: n
3317         end subroutine
3318     end interface fn4
3319     integer :: n, x
3320     call fn4 (n)
3321     x = 5
3322     call fn4 (x)
3323 end subroutine fn5
3324 \end{lstlisting}
3325 \caption{Call Site Example \#2: Source}
3326 \label{fig:callsiteexample2source}
3327 \end{figure}
3328
3329 Possible generated code for this source is shown using a suggestive 
3330 pseudo-\linebreak[0]assembly notation in Figure \refersec{fig:callsiteexample2code}.
3331 \begin{figure}[h]
3332 \begin{lstlisting}
3333
3334 fn4:
3335     %reg2 = [%reg0]   ! Load value of n (passed by reference)
3336     %reg2 = %reg2 / 2 ! Divide by 2
3337     [%reg0] = %reg2   ! Update value of n
3338     call fn6          ! Call some other function
3339     return
3340
3341 fn5:
3342     %reg3 = %reg3 - 8 ! Decrease stack pointer to create stack frame
3343     call fn4          ! Call fn4 with the same argument by reference 
3344                       !   as fn5 has been called with
3345 L9:
3346     [%reg3] = 5       ! Pass value of 5 by reference to fn4
3347     %reg0 = %reg3     ! Put address of the value 5 on the stack
3348                       !   into 1st argument register
3349     call fn4
3350 L10:
3351     %reg3 = %reg3 + 8 ! Leave stack frame
3352     return
3353     
3354 \end{lstlisting}
3355 \caption{Call Site Example \#2: Code}
3356 \label{fig:callsiteexample2code}
3357 \end{figure}
3358
3359 The location description for variable \texttt{x} in function 
3360 \texttt{f}n4 might be:
3361 \begin{lstlisting}
3362 DW_OP_entry_value 4 DW_OP_breg0 0 DW_OP_deref_size 4 DW_OP_stack_value
3363 \end{lstlisting}
3364
3365 The call sites in (just) function \texttt{fn5} might be as shown in 
3366 Figure \refersec{fig:callsiteexample2dwarf}.
3367
3368 \begin{figure}[h]
3369 \begin{dwflisting}
3370 \begin{alltt}
3371
3372 \DWTAGcallsite
3373     \DWATcallreturnpc(L9) ! First call to fn4
3374     \DWATcallorigin(reference to subprogram fn4)
3375     \DWTAGcallsiteparameter
3376         \DWATcallparameter(reference to formal parameter n in subprogram fn4)
3377         \DWATlocation(\DWOPregzero)
3378         ! The value of register 0 at the time of the call can be perhaps 
3379         !   looked up in fn5's caller
3380         \DWATcallvalue(\DWOPentryvalue{} 1 \DWOPregzero)
3381         ! DW_AT_call_data_location(DW_OP_push_object_address) ! left out, implicit
3382         ! And the actual value of the parameter can be also perhaps looked up in
3383         ! fn5's caller
3384         \DWATcalldatavalue(\DWOPentryvalue{} 4 \DWOPbregzero{} 0 \DWOPderefsize 4)
3385         
3386 \DWTAGcallsite
3387     \DWATcallreturnpc(L10) ! Second call to fn4
3388     \DWATcallorigin(reference to subprogram fn4)
3389     \DWTAGcallsiteparameter
3390         \DWATcallparameter(reference to formal parameter n in subprogram fn4)
3391         \DWATlocation(\DWOPregzero)
3392         ! The value of register 0 at the time of the call is equal to the stack
3393         ! pointer value in fn5
3394         \DWATcallvalue(\DWOPbregthree{} 0)
3395         ! DW_AT_call_data_location(DW_OP_push_object_address) ! left out, implicit
3396         ! And the value passed by reference is constant 5
3397         \DWATcalldatavalue(\DWOPlitfive)
3398         
3399 \end{alltt}
3400 \end{dwflisting}
3401 \caption{Call Site Example \#2: DWARF Encoding}
3402 \label{fig:callsiteexample2dwarf}
3403 \end{figure}