1e5c0cc658ecf3003de3c56d92089f6b9e10345e
[dwarf-doc.git] / dwarf5 / latexdoc / programscope.tex
1 \chapter{Program Scope Entries}
2 \label{chap:programscopeentries} 
3 This section describes debugging information entries that
4 relate to different levels of program scope: compilation,
5 module, subprogram, and so on. Except for separate type
6 entries (see Section \refersec{chap:separatetypeunitentries}), 
7 these entries may be thought of
8 as bounded by ranges of text addresses within the program.
9
10 \section{Unit Entries}
11 An object file may contain one or more compilation units,
12 of which there are
13 \addtoindexx{unit|see {compilation unit, partial unit \textit{or} type unit}} 
14 \addtoindexx{compilation unit}
15 three kinds: 
16 \addtoindexx{normal compilation unit}
17 \addtoindexx{normal compilation unit|see {compilation unit}}
18 normal compilation units,
19 partial compilation units and 
20 \addtoindexx{type unit}
21 type units. A 
22 \addtoindex{partial compilation unit}
23 is related to one or more other compilation units that
24 import it. A 
25 \addtoindex{type unit} represents 
26 a single complete type in a
27 separate unit. Either a normal compilation unit or a 
28 \addtoindex{partial compilation unit}
29 may be logically incorporated into another
30 compilation unit using an 
31 \addtoindex{imported unit entry}.
32
33
34 \subsection[Normal and Partial CU Entries]{Normal and Partial Compilation Unit Entries}
35 \label{chap:normalandpartialcompilationunitentries}
36
37 A \addtoindex{normal compilation unit} is represented by a debugging
38 information entry with the 
39 tag \DWTAGcompileunitTARG. 
40 A \addtoindex{partial compilation unit} is represented by a debugging information
41 entry with the 
42 tag \DWTAGpartialunitTARG.
43
44 In a simple normal compilation, a single compilation unit with
45 the tag 
46 \DWTAGcompileunit{} represents a complete object file
47 and the tag 
48 \DWTAGpartialunit{} is not used. 
49 In a compilation
50 employing the DWARF space compression and duplicate elimination
51 techniques from 
52 Appendix \refersec{app:usingcompilationunits}, 
53 multiple compilation units using
54 the tags 
55 \DWTAGcompileunit{} and/or 
56 \DWTAGpartialunit{} are
57 used to represent portions of an object file.
58
59 \textit{A normal compilation unit typically represents the text and
60 data contributed to an executable by a single relocatable
61 object file. It may be derived from several source files,
62 including pre\dash processed \doublequote{include files.} 
63 A \addtoindex{partial compilation unit} typically represents a part of the text
64 and data of a relocatable object file, in a manner that can
65 potentially be shared with the results of other compilations
66 to save space. It may be derived from an \doublequote{include file,}
67 template instantiation, or other implementation\dash dependent
68 portion of a compilation. A normal compilation unit can also
69 function in a manner similar to a partial compilation unit
70 in some cases.}
71
72 A compilation unit entry owns debugging information
73 entries that represent all or part of the declarations
74 made in the corresponding compilation. In the case of a
75 partial compilation unit, the containing scope of its owned
76 declarations is indicated by imported unit entries in one
77 or more other compilation unit entries that refer to that
78 partial compilation unit (see 
79 Section \refersec{chap:importedunitentries}).
80
81
82 Compilation unit entries may have the following 
83 attributes:
84 \begin{enumerate}[1. ]
85 \item Either a \DWATlowpc{} and 
86 \DWAThighpc{} pair of
87 \addtoindexx{high PC attribute}
88 attributes 
89 \addtoindexx{low PC attribute}
90 or 
91 \addtoindexx{ranges attribute}
92
93 \DWATranges{} attribute
94 \addtoindexx{ranges attribute}
95 whose values encode 
96 \addtoindexx{discontiguous address ranges|see{non-contiguous address ranges}}
97 the
98 contiguous or 
99 non\dash contiguous address ranges, respectively,
100 of the machine instructions generated for the compilation
101 unit (see Section \refersec{chap:codeaddressesandranges}).
102   
103 A \DWATlowpc{} attribute 
104 may also
105 be specified 
106 in combination 
107 \addtoindexx{ranges attribute}
108 with 
109 \DWATranges{} to specify the
110 \addtoindexx{ranges attribute}
111 default base address for use in 
112 \addtoindexx{location list}
113 location lists (see Section
114 \refersec{chap:locationlists}) and range lists 
115 \addtoindexx{range list}
116 (see Section \refersec{chap:noncontiguousaddressranges}).
117
118 \item A \DWATname{} attribute 
119 \addtoindexx{name attribute}
120 whose value is a null\dash terminated
121 string 
122 \hypertarget{chap:DWATnamepathnameofcompilationsource}{}
123 containing the full or relative path name of the primary
124 source file from which the compilation unit was derived.
125
126 \item A \DWATlanguage{} attribute 
127 \addtoindexx{language attribute}
128 whose constant value is an
129 \hypertarget{chap:DWATlanguageprogramminglanguage}{}
130 integer code 
131 \addtoindexx{language attribute}
132 indicating the source language of the compilation
133 unit. The set of language names and their meanings are given
134 in Table \refersec{tab:languagenames}.
135
136 \begin{table}[t]
137 \centering
138 \caption{Language names}
139 \label{tab:languagenames}
140 \begin{tabular}{l|l}
141 \hline
142 Language name & Meaning\\ \hline
143 \DWLANGAdaeightythreeTARG{} \dag & ISO \addtoindex{Ada}:1983 \addtoindexx{Ada} \\
144 \DWLANGAdaninetyfiveTARG{} \dag & ISO Ada:1995 \addtoindexx{Ada} \\
145 \DWLANGCTARG & Non-standardized C, such as K\&R \\
146 \DWLANGCeightynineTARG & ISO C:1989 \\
147 \DWLANGCninetynineTARG & ISO \addtoindex{C}:1999 \\
148 \DWLANGCplusplusTARG & ISO \addtoindex{C++}:1998 \\
149 \DWLANGCpluspluszerothreeTARG & ISO \addtoindex{C++}:2003 \\
150 \DWLANGCpluspluselevenTARG & ISO \addtoindex{C++}:2011 \\
151 \DWLANGCobolseventyfourTARG & ISO \addtoindex{COBOL}:1974 \\
152 \DWLANGCoboleightyfiveTARG & ISO \addtoindex{COBOL}:1985 \\
153 \DWLANGDTARG{} \dag & D \addtoindexx{D language} \\
154 \DWLANGFortranseventysevenTARG &ISO \addtoindex{FORTRAN} 77\\
155 \DWLANGFortranninetyTARG & ISO \addtoindex{Fortran 90}\\
156 \DWLANGFortranninetyfiveTARG & ISO \addtoindex{Fortran 95}\\
157 \DWLANGGoTARG{} \dag & \addtoindex{Go}\\
158 \DWLANGHaskellTARG{} \dag & \addtoindex{Haskell}\\
159 \DWLANGJavaTARG{} & \addtoindex{Java}\\
160 \DWLANGModulatwoTARG & ISO Modula\dash 2:1996 \addtoindexx{Modula-2}\\
161 \DWLANGModulathreeTARG & \addtoindex{Modula-3}\\
162 \DWLANGObjCTARG{} & \addtoindex{Objective C}\\
163 \DWLANGObjCplusplusTARG{} & \addtoindex{Objective C++}\\
164 \DWLANGOCamlTARG{} \dag & \addtoindex{OCaml}\index{Objective Caml|see{OCaml}}\\
165 \DWLANGOpenCLTARG{} \dag & \addtoindex{OpenCL}\\
166 \DWLANGPascaleightythreeTARG & ISO \addtoindex{Pascal}:1983\\
167 \DWLANGPLITARG{} \dag & ANSI \addtoindex{PL/I}:1976\\
168 \DWLANGPythonTARG{} \dag & \addtoindex{Python}\\
169 \DWLANGUPCTARG{} & \addtoindex{Unified Parallel C}\addtoindexx{UPC}\\ \hline
170 \dag \ \ \textit{Support for these languages is limited.}& \\
171 \end{tabular}
172 \end{table}
173
174 \item A \DWATstmtlist{}
175 attribute whose value is 
176 \addtoindexx{statement list attribute}
177
178 \addtoindexx{section offset!in statement list attribute}
179 section
180 \hypertarget{chap:DWATstmtlistlinenumberinformationforunit}{}
181 offset to the line number information for this compilation
182 unit.
183
184 This information is placed in a separate object file
185 section from the debugging information entries themselves. The
186 value of the statement list attribute is the offset in the
187 \dotdebugline{} section of the first byte of the line number
188 information for this compilation unit 
189 (see Section \refersec{chap:linenumberinformation}).
190
191 \clearpage
192
193 \needlines{6}
194 \item A \DWATmacroinfo{} attribute 
195 \addtoindexx{macro information attribute}
196 whose value is a 
197 \addtoindexx{section offset!in macro information attribute}
198 section
199 \hypertarget{chap:DWATmacroinfomacroinformation}{}
200 offset to the macro information for this compilation unit.
201
202 This information is placed in a separate object file section
203 from the debugging information entries themselves. The
204 value of the macro information attribute is the offset in
205 the \dotdebugmacinfo{} section of the first byte of the macro
206 information for this compilation unit 
207 (see Section \refersec{chap:macroinformation}).
208
209 \needlines{6}
210 \item  A 
211 \DWATcompdir{} 
212 attribute 
213 \hypertarget{chap:DWATcompdircompilationdirectory}{}
214 whose value is a
215 null\dash terminated string containing the current working directory
216 of the compilation command that produced this compilation
217 unit in whatever form makes sense for the host system.
218
219 \item  A \DWATproducer{} attribute 
220 \addtoindexx{producer attribute}
221 whose value is a null\dash
222 terminated string containing information about the compiler
223 \hypertarget{chap:DWATproducercompileridentification}{}
224 that produced the compilation unit. The actual contents of
225 the string will be specific to each producer, but should
226 begin with the name of the compiler vendor or some other
227 identifying character sequence that should avoid confusion
228 with other producer values.
229
230 \needlines{4}
231 \item  A \DWATidentifiercase{} 
232 attribute 
233 \addtoindexx{identifier case attribute}
234 whose integer
235 \hypertarget{chap:DWATidentifiercaseidentifiercaserule}{}
236 constant value is a code describing the treatment
237 of identifiers within this compilation unit. The
238 set of identifier case codes is given in
239 Table \refersec{tab:identifiercasecodes}.
240
241 \begin{simplenametable}{Identifier case codes}{tab:identifiercasecodes}
242 \DWIDcasesensitive{}      \\
243 \DWIDupcase{}             \\
244 \DWIDdowncase{}           \\
245 \DWIDcaseinsensitive{}    \\
246 \end{simplenametable}
247
248 \DWIDcasesensitiveTARG{} is the default for all compilation units
249 that do not have this attribute.  It indicates that names given
250 as the values of \DWATname{} attributes 
251 \addtoindexx{name attribute}
252 in debugging information
253 entries for the compilation unit reflect the names as they
254 appear in the source program. The debugger should be sensitive
255 to the case of identifier names when doing identifier lookups.
256
257 \DWIDupcaseTARG{} means that the 
258 producer of the debugging
259 information for this compilation unit converted all source
260 names to upper case. The values of the name attributes may not
261 reflect the names as they appear in the source program. The
262 debugger should convert all names to upper case when doing
263 lookups.
264
265 \DWIDdowncaseTARG{} means that 
266 the producer of the debugging
267 information for this compilation unit converted all source
268 names to lower case. The values of the name attributes may not
269 reflect the names as they appear in the source program. The
270 debugger should convert all names to lower case when doing
271 lookups.
272
273 \needlines{4}
274 \DWIDcaseinsensitiveTARG{} means that the values of the name
275 attributes reflect the names as they appear in the source
276 program but that a case insensitive lookup should be used to
277 access those names.
278
279 \needlines{5}
280 \item A \DWATbasetypes{} attribute whose value is a 
281 \livelink{chap:classreference}{reference}.
282
283 This 
284 \hypertarget{chap:DWATbasetypesprimitivedatatypesofcompilationunit}{}
285 attribute 
286 \addtoindexx{base types attribute}
287 points to a debugging information entry
288 representing another compilation unit.  It may be used
289 to specify the compilation unit containing the base type
290 entries used by entries in the current compilation unit
291 (see Section \refersec{chap:basetypeentries}).
292
293 \needlines{6}
294 This attribute provides a consumer a way to find the definition
295 of base types for a compilation unit that does not itself
296 contain such definitions. This allows a consumer, for example,
297 to interpret a type conversion to a base type 
298 % getting this link target at the right spot is tricky.
299 \hypertarget{chap:DWATuseUTF8compilationunitusesutf8strings}{}
300 correctly.
301
302 \item A \DWATuseUTFeight{} attribute,
303 \addtoindexx{use UTF8 attribute}\addtoindexx{UTF-8} 
304 which is a \livelink{chap:classflag}{flag} whose
305 presence indicates that all strings (such as the names of
306 declared entities in the source program, or file names in the line table) 
307 are represented using the UTF\dash 8 representation. 
308
309 \item A \DWATmainsubprogram{} attribute, which is a \livelink{chap:classflag}{flag}
310 \addtoindexx{main subprogram attribute}
311 whose presence indicates 
312 \hypertarget{chap:DWATmainsubprogramunitcontainingmainorstartingsubprogram}{}
313 that the compilation unit contains a
314 subprogram that has been identified as the starting function
315 of the program. If more than one compilation unit contains
316 this \nolink{flag}, any one of them may contain the starting function.
317
318 \textit{\addtoindex{Fortran} has a \addtoindex{PROGRAM statement}
319 which is used
320 to specify and provide a user\dash specified name for the main
321 subroutine of a program. 
322 \addtoindex{C} uses the name \doublequote{main} to identify
323 the main subprogram of a program. Some other languages provide
324 similar or other means to identify the main subprogram of
325 a program.}
326
327 \item A \DWATentrypc{} attribute whose value is the address of the first
328 \hypertarget{chap:DWATentrypcofcompileunit}{}
329 \hypertarget{chap:DWATentrypcofpartialunit}{}
330 \addtoindexx{entry pc attribute!for normal compilation unit}
331 \addtoindexx{entry pc attribute!for partial compilation unit}
332 executable instruction of the unit (see 
333 Section \refersec{chap:entryaddress}).
334
335 \item A \DWATstroffsetsbaseNAME\addtoindexx{string offset base attribute}
336 \hypertarget{chap:DWATstroffsetbaseforindirectstringtable}{} 
337 attribute, whose value is a reference. 
338 This attribute points to the first string
339 offset of the compilation unit's contribution to the
340 \dotdebugstroffsets{} (or \dotdebugstroffsetsdwo{}) section. 
341 Indirect string references
342 (using \DWFORMstrx) within the compilation unit are
343 interpreted as indices relative to this base.
344
345 \needlines{6}
346 \item A \DWATaddrbaseNAME\addtoindexx{address table base attribute}
347 \hypertarget{chap:DWATaddrbaseforaddresstable}{}
348 attribute, whose value is a reference.
349 This attribute points to the beginning of the compilation
350 unit's contribution to the \dotdebugaddr{} section.
351 Indirect references (using \DWFORMaddrx, \DWOPaddrx, 
352 \DWOPconstx, \DWLLEbaseaddressselectionentry{}, 
353 \DWLLEstartendentry, or \DWLLEstartlengthentry) within the compilation unit are
354 interpreted as indices relative to this base.
355
356 \needlines{5}
357 \item A \DWATrangesbaseNAME\addtoindexx{ranges table base attribute}
358 \hypertarget{chap:DWATrangesbaseforrangelists}{}
359 attribute, whose value is a reference.
360 This attribute points to the beginning of the compilation
361 unit's contribution to the \dotdebugranges{} section.
362 References to range lists (using \DWFORMsecoffset)
363 within the compilation unit are
364 interpreted as offsets relative to this base.
365
366
367 \end{enumerate}
368
369 The  base address of a compilation unit is defined as the
370 value of the \DWATlowpc{} attribute, if present; otherwise,
371 it is undefined. If the base address is undefined, then any
372 DWARF entry or structure defined in terms of the base address
373 of that compilation unit is not valid.
374
375 \subsection{Skeleton Compilation Unit Entries}
376 \label{chap:skeletoncompilationunitentries}
377 When generating a split DWARF object (see 
378 Section \refersec{datarep:splitdwarfobjects}), the
379 compilation unit in the \dotdebuginfo{} section is a "skeleton"
380 compilation unit, which contains only a subset of the
381 attributes of the full compilation unit. In general, it
382 contains those attributes that are necessary for the consumer
383 to locate the DWARF object where the full compilation unit
384 can be found, and for the consumer to interpret references to
385 addresses in the program. 
386
387 A skeleton compilation unit has no
388 children, and may have the following attributes:
389 \begin{enumerate}[1. ]
390
391 \item
392 Either a \DWATlowpc{} and \DWAThighpc{} pair of attributes
393 or a \DWATranges{} attribute (the same as for regular
394 compilation unit entries).
395
396 \item
397 A \DWATstmtlist{} attribute (the same as for regular
398 compilation unit entries).
399
400 \item
401 A \DWATcompdir{} attribute (the same as for regular
402 compilation unit entries).
403
404 \item
405 \livetarg{chap:DWATdwoidforunit}{}
406 A \DWATdwonameNAME{} attribute whose value is a
407 null-terminated string containing the full or relative
408 path name of the DWARF object file that contains the full
409 compilation unit.
410
411 \item
412 \livetarg{chap:DWATdwoidforunit}{}
413 A \DWATdwoidNAME{} attribute whose value is an 8-byte
414 unsigned hash of the full compilation unit.  This hash
415 value is computed by the method described in 
416 Section \refersec{datarep:typesignaturecomputation}.
417
418 \needlines{6}
419 \item
420 A \DWATuseUTFeight{} attribute (the same as for regular compilation unit
421 entries).
422
423 \textit{This attribute applies to strings referred to by the skeleton
424 compilation unit entry itself, and strings in the associated line
425 number information.
426 The representation for strings in the DWARF object file is determined
427 by the presence of a \DWATuseUTFeight{} attribute in the full compilation
428 unit.}
429
430 \item
431 A \DWATstroffsetsbase{} attribute, for indirect strings references 
432 from the skeleton compilation unit (the same as for regular 
433 compilation unit entries).
434
435 \item
436 A \DWATaddrbase{} attribute (the same as for regular
437 compilation unit entries).
438
439 \item
440 A \DWATrangesbase{} attribute (the same as for regular
441 compilation unit entries).
442
443 \end{enumerate}
444
445 All other attributes of a compilation unit entry (described
446 in Section \refersec{chap:normalandpartialcompilationunitentries}) 
447 should be placed in the full compilation
448 unit entry in the \dotdebuginfodwo{} section of the split DWARF
449 object. The attributes provided by the skeleton compilation
450 unit entry do not need to be repeated in the full compilation
451 unit entry, except for \DWATdwoid, which should appear in
452 both entries so that the consumer can verify that it has
453 found the correct DWARF object.
454
455
456 \subsection{Imported Unit Entries}
457 \label{chap:importedunitentries}
458 The 
459 \hypertarget{chap:DWATimportimportedunit}{}
460 place where a normal or partial unit is imported is
461 represented by a debugging information entry with the 
462 \addtoindexx{imported unit entry}
463 tag \DWTAGimportedunitTARG. 
464 An imported unit entry contains 
465 \addtoindexx{import attribute}
466 a
467 \DWATimport{} attribute 
468 whose value is a \livelink{chap:classreference}{reference} to the
469 normal or partial compilation unit whose declarations logically
470 belong at the place of the imported unit entry.
471
472 \textit{An imported unit entry does not necessarily correspond to
473 any entity or construct in the source program. It is merely
474 \doublequote{glue} used to relate a partial unit, or a compilation
475 unit used as a partial unit, to a place in some other
476 compilation unit.}
477
478 \needlines{6}
479 \subsection{Separate Type Unit Entries}
480 \label{chap:separatetypeunitentries}
481 An object file may contain any number of separate type
482 unit entries, each representing a single complete type
483 definition. 
484 Each \addtoindex{type unit} must be uniquely identified by
485 a 64\dash bit signature, stored as part of the type unit, which
486 can be used to reference the type definition from debugging
487 information entries in other compilation units and type units.
488
489 A type unit is represented by a debugging information entry
490 with the tag \DWTAGtypeunitTARG. 
491 A \addtoindex{type unit entry} owns debugging
492 information entries that represent the definition of a single
493 type, plus additional debugging information entries that may
494 be necessary to include as part of the definition of the type.
495
496 A type unit entry may have a 
497 \DWATlanguage{} attribute, 
498 whose
499 \addtoindexx{language attribute}
500 constant value is an integer code indicating the source
501 language used to define the type. The set of language names
502 and their meanings are given in Table \refersec{tab:languagenames}.
503
504 A type unit entry may have a 
505 \DWATstroffsetsbase\addtoindexx{string base offset attribute}
506 attribute, whose value is a reference. This attribute points
507 to the first string offset of the type unit's contribution to
508 the \dotdebugstroffsets{} section. Indirect string references
509 (using \DWFORMstrx) within the type unit must be interpreted
510 as indices relative to this base.
511
512 A type unit entry may have a \DWATstmtlist{} attribute, whose
513 value is a section offset to a line number table for this
514 type unit. Because type units do not describe any code, they
515 do not actually need a line number table, but the line number
516 tables also contain a list of directories and file names that
517 may be referenced by the \DWATdeclfile{} attribute. In a
518 normal object file with a regular compilation unit entry, the
519 type unit entries can simply refer to the line number table
520 used by the compilation unit. In a split DWARF object, where
521 the type units are located in a separate DWARF object file,
522 the \DWATstmtlist{} attribute refers to a "skeleton"
523 line number table in the \dotdebuglinedwo{} section, which
524 contains only the list of directories and file names. All
525 type unit entries in a split DWARF object may (but are not
526 required to) refer to the same skeleton line number table.
527
528 A type unit entry may have a \DWATuseUTFeight{} attribute, which is a flag
529 whose presence indicates that all strings referred to by this type
530 unit entry, its children, and the skeleton line number table, are
531 represented using the UTF-8 representation.
532
533 A \addtoindex{type unit} entry for a given type T owns a debugging
534 information entry that represents a defining declaration
535 of type T. If the type is nested within enclosing types or
536 namespaces, the debugging information entry for T is nested
537 within debugging information entries describing its containers;
538 otherwise, T is a direct child of the type unit entry.
539
540 A type unit entry may also own additional debugging information
541 entries that represent declarations of additional types that
542 are referenced by type T and have not themselves been placed in
543 separate type units. Like T, if an additional type U is nested
544 within enclosing types or namespaces, the debugging information
545 entry for U is nested within entries describing its containers;
546 otherwise, U is a direct child of the type unit entry.
547
548 The containing entries for types T and U are declarations,
549 and the outermost containing entry for any given type T or
550 U is a direct child of the type unit entry. The containing
551 entries may be shared among the additional types and between
552 T and the additional types.
553
554 \textit{Types are not required to be placed in type units. In general,
555 only large types such as structure, class, enumeration, and
556 union types included from header files should be considered
557 for separate type units. Base types and other small types
558 are not usually worth the overhead of placement in separate
559 type units. Types that are unlikely to be replicated, such
560 as those defined in the main source file, are also better
561 left in the main compilation unit.}
562
563 \section{Module, Namespace and Importing Entries}
564 \textit{Modules and namespaces provide a means to collect related
565 entities into a single entity and to manage the names of
566 those entities.}
567
568 \subsection{Module Entries}
569 \label{chap:moduleentries}
570 \textit{Several languages have the concept of a \doublequote{module.}
571 \addtoindexx{Modula-2}
572 A Modula\dash 2 definition module 
573 \addtoindexx{Modula-2!definition module}
574 may be represented by a module
575 entry containing a 
576 \addtoindex{declaration attribute}
577 (\DWATdeclaration). A
578 \addtoindex{Fortran 90} module 
579 \addtoindexx{Fortran!module (Fortran 90)}
580 may also be represented by a module entry
581 (but no declaration attribute is warranted because \addtoindex{Fortran}
582 has no concept of a corresponding module body).}
583
584 A module is represented by a debugging information entry
585 with the 
586 tag \DWTAGmoduleTARG.  
587 Module entries may own other
588 debugging information entries describing program entities
589 whose declaration scopes end at the end of the module itself.
590
591 If the module has a name, the module entry has a 
592 \DWATname{} attribute 
593 \addtoindexx{name attribute}
594 whose value is a null\dash terminated string containing
595 the module name as it appears in the source program.
596
597 The \addtoindex{module entry} may have either a 
598 \DWATlowpc{} and
599 \DWAThighpc{} 
600 pair 
601 \addtoindexx{high PC attribute}
602 of 
603 \addtoindexx{low PC attribute}
604 attributes or a 
605 \DWATranges{} attribute
606 \addtoindexx{ranges attribute}
607 whose values encode the contiguous or non\dash contiguous address
608 ranges, respectively, of the machine instructions generated for
609 the module initialization code 
610 (see Section \refersec{chap:codeaddressesandranges}). 
611 \hypertarget{chap:DWATentrypcentryaddressofmoduleinitialization}{}
612 It may also
613 \addtoindexx{entry pc attribute!for module initialization}
614 have a 
615 \DWATentrypc{} attribute whose value is the address of
616 the first executable instruction of that initialization code
617 (see Section \refersec{chap:entryaddress}).
618
619 If 
620 \hypertarget{chap:DWATprioritymodulepriority}{}
621 the module has been assigned a priority, it may have 
622 \addtoindexx{priority attribute}
623 a
624 \DWATpriority{} attribute. 
625 The value of this attribute is a
626 reference to another debugging information entry describing
627 a variable with a constant value. The value of this variable
628 is the actual constant value of the module\textquoteright s priority,
629 represented as it would be on the target architecture.
630
631 \subsection{Namespace Entries}
632 \label{chap:namespaceentries}
633 \textit{\addtoindex{C++} has the notion of a namespace, which provides a way to
634 \addtoindexx{namespace (C++)}
635 implement name hiding, so that names of unrelated things
636 do not accidentally clash in the 
637 \addtoindex{global namespace} when an
638 application is linked together.}
639
640 A namespace is represented by a debugging information entry
641 with the 
642 tag \DWTAGnamespaceTARG. 
643 A namespace extension is
644 \hypertarget{chap:DWATextensionpreviousnamespaceextensionororiginalnamespace}{}
645 represented by a 
646 \DWTAGnamespace{} entry 
647 with 
648 \addtoindexx{extension attribute}
649
650 \DWATextension{}
651 attribute referring to the previous extension, or if there
652 is no previous extension, to the original 
653 \DWTAGnamespace{}
654 entry. A namespace extension entry does not need to duplicate
655 information in a previous extension entry of the namespace
656 nor need it duplicate information in the original namespace
657 entry. (Thus, for a namespace with a name, 
658 a \DWATname{} attribute 
659 \addtoindexx{name attribute}
660 need only be attached directly to the original
661 \DWTAGnamespace{} entry.)
662
663 \needlines{4}
664 Namespace and namespace extension entries may own 
665 \addtoindexx{namespace extension entry}
666 other
667 \addtoindexx{namespace declaration entry}
668 debugging information entries describing program entities
669 whose declarations occur in the namespace.
670
671 \textit{For \addtoindex{C++}, such 
672 owned program entities may be declarations,
673 including certain declarations that are also object or
674 function definitions.}
675
676 If a type, variable, or function declared in a namespace is
677 defined outside of the body of the namespace declaration,
678 that type, variable, or function definition entry has a
679 \DWATspecification{} attribute 
680 \addtoindexx{specification attribute}
681 whose value is a \livelink{chap:classreference}{reference} to the
682 debugging information entry representing the declaration of
683 the type, variable or function. Type, variable, or function
684 entries with a 
685 \DWATspecification{} attribute 
686 \addtoindexx{specification attribute}
687 do not need
688 to duplicate information provided by the declaration entry
689 referenced by the specification attribute.
690
691 \textit{The \addtoindex{C++} \addtoindex{global namespace}
692 (the 
693 \addtoindexx{global namespace|see{namespace (C++), global}}
694 namespace 
695 \addtoindexx{namespace (C++)!global}
696 referred to by
697 \texttt{::f}, for example) is not explicitly represented in
698 DWARF with a namespace entry (thus mirroring the situation
699 in \addtoindex{C++} source).  
700 Global items may be simply declared with no
701 reference to a namespace.}
702
703 \textit{The \addtoindex{C++} 
704 compilation unit specific \doublequote{unnamed namespace} may
705 \addtoindexx{namespace (C++)!unnamed}
706 \addtoindexx{unnamed namespace|see {namespace (C++), unnamed}}
707 be represented by a namespace entry with no name attribute in
708 the original namespace declaration entry (and therefore no name
709 attribute in any namespace extension entry of this namespace).
710 }
711
712 \textit{A compiler emitting namespace information may choose to
713 explicitly represent namespace extensions, or to represent the
714 final namespace declaration of a compilation unit; this is a
715 quality\dash of\dash implementation issue and no specific requirements
716 are given here. If only the final namespace is represented,
717 \addtoindexx{namespace (C++)!using declaration}
718 it is impossible for a debugger to interpret using declaration
719 references in exactly the manner defined by the 
720 \addtoindex{C++} language.
721 }
722
723 \textit{Emitting all namespace declaration information in all
724 compilation units can result in a significant increase in the
725 size of the debug information and significant duplication of
726 information across compilation units. 
727 The \addtoindex{C++} namespace std,
728 for example, 
729 \addtoindexx{namespace (C++)!std}
730 is large and will probably be referenced in
731 every \addtoindex{C++} compilation unit.
732 }
733
734 \textit{For a \addtoindex{C++} namespace example, 
735 see Appendix \refersec{app:namespaceexample}.
736 }
737
738
739
740 \subsection{Imported (or Renamed) Declaration Entries} 
741 \label{chap:importedorrenameddeclarationentries}
742 \textit{Some languages support the concept of importing into or making
743 accessible in a given unit declarations made in a different
744 module or scope. An imported declaration may sometimes be
745 given another name.
746 }
747
748 An 
749 imported declaration is represented by one or
750 \addtoindexx{imported declaration entry}
751 more debugging information entries with the 
752 tag \DWTAGimporteddeclarationTARG. 
753 When 
754 \hypertarget{chap:DWATimportimporteddeclaration}{}
755 an overloaded entity
756 is imported, there is one imported declaration entry for
757 each overloading. 
758 \addtoindexx{import attribute}
759 Each imported declaration entry has a
760 \DWATimport{} attribute,
761 whose value is a \livelink{chap:classreference}{reference} to the
762 debugging information entry representing the declaration that
763 is being imported.
764
765 An imported declaration may also have a 
766 \DWATname{}
767 attribute
768 \addtoindexx{name attribute}
769 whose value is a null\dash terminated string containing the
770 name, as it appears in the source program, by which the
771 imported entity is to be known in the context of the imported
772 declaration entry (which may be different than the name of
773 the entity being imported). If no name is present, then the
774 name by which the entity is to be known is the same as the
775 name of the entity being imported.
776
777 An imported declaration entry with a name attribute may be
778 used as a general means to rename or provide an alias for
779 \addtoindexx{alias declaration|see{imported declaration entry}}
780 an entity, regardless of the context in which the importing
781 declaration or the imported entity occurs.
782
783 \textit{A \addtoindex{C++} namespace alias may be represented by an imported
784 \hypertarget{chap:DWATimportnamespacealias}{}
785 declaration entry 
786 \addtoindexx{namespace (C++)!alias}
787 with a name attribute whose value is
788 a null\dash terminated string containing the alias name as it
789 appears in the source program and an import attribute whose
790 value is a \livelink{chap:classreference}{reference} to the applicable original namespace or
791 namespace extension entry.
792 }
793
794 \textit{A \addtoindex{C++} using declaration may be represented by one or more
795 \hypertarget{chap:DWATimportnamespaceusingdeclaration}{}
796 imported 
797 \addtoindexx{namespace (C++)!using declaration}
798 declaration entries.  When the using declaration
799 refers to an overloaded function, there is one imported
800 declaration entry corresponding to each overloading. Each
801 imported declaration entry has no name attribute but it does
802 have an import attribute that refers to the entry for the
803 entity being imported. (\addtoindex{C++} 
804 provides no means to \doublequote{rename}
805 an imported entity, other than a namespace).
806 }
807
808 \textit{A \addtoindex{Fortran} use statement 
809 \addtoindexx{Fortran!use statement}
810 \addtoindexx{use statement|see {Fortran, use statement}}
811 with an \doublequote{only list} may be
812 represented by a series of imported declaration entries,
813 one (or more) for each entity that is imported. An entity
814 \addtoindexx{renamed declaration|see{imported declaration entry}}
815 that is renamed in the importing context may be represented
816 by an imported declaration entry with a name attribute that
817 specifies the new local name.
818 }
819
820 \subsection{Imported Module Entries}
821 \label{chap:importedmoduleentries}
822
823 \textit{Some languages support the concept of importing into or making
824 accessible in a given unit all of the declarations contained
825 within a separate module or namespace.
826 }
827
828 An imported module declaration is represented by a debugging
829 information entry with 
830 \addtoindexx{imported module attribute}
831 the 
832 \addtoindexx{imported module entry}
833 tag \DWTAGimportedmoduleTARG.
834 An
835 imported module entry contains a 
836 \DWATimport{} attribute
837 \addtoindexx{import attribute}
838 whose value is a \livelink{chap:classreference}{reference} 
839 to the module or namespace entry
840 containing the definition and/or declaration entries for
841 the entities that are to be imported into the context of the
842 imported module entry.
843
844 An imported module declaration may own a set of imported
845 declaration entries, each of which refers to an entry in the
846 module whose corresponding entity is to be known in the context
847 of the imported module declaration by a name other than its
848 name in that module. Any entity in the module that is not
849 renamed in this way is known in the context of the imported
850 module entry by the same name as it is declared in the module.
851
852 \textit{A \addtoindex{C++} using directive
853 \addtoindexx{namespace (C++)!using directive}
854 \addtoindexx{using directive|see {namespace (C++), using directive}} 
855 may be represented by an imported module
856 \hypertarget{chap:DWATimportnamespaceusingdirective}{}
857 entry, with an import attribute referring to the namespace
858 entry of the appropriate extension of the namespace (which
859 might be the original namespace entry) and no owned entries.
860 }
861
862 \textit{A \addtoindex{Fortran} use statement 
863 \addtoindexx{Fortran!use statement}
864 with a \doublequote{rename list} may be
865 represented by an imported module entry with an import
866 attribute referring to the module and owned entries
867 corresponding to those entities that are renamed as part of
868 being imported.
869 }
870
871 \textit{A \addtoindex{Fortran} use statement
872 \addtoindexx{Fortran!use statement}
873 with neither a \doublequote{rename list} nor
874 an \doublequote{only list} may be represented by an imported module
875 entry with an import attribute referring to the module and
876 no owned child entries.
877 }
878
879 \textit{A use statement with an \doublequote{only list} is represented by a
880 series of individual imported declaration entries as described
881 in Section \refersec{chap:importedorrenameddeclarationentries}.
882 }
883
884 \textit{A \addtoindex{Fortran} use statement for an entity in a module that is
885 \addtoindexx{Fortran!use statement}
886 itself imported by a use statement without an explicit mention
887 may be represented by an imported declaration entry that refers
888 to the original debugging information entry. For example, given
889 }
890
891 \begin{lstlisting}
892 module A
893 integer X, Y, Z
894 end module
895
896 module B
897 use A
898 end module
899
900 module C
901 use B, only Q => X
902 end module
903 \end{lstlisting}
904
905 \textit{the imported declaration entry for Q within module C refers
906 directly to the variable declaration entry for X in module A
907 because there is no explicit representation for X in module B.
908 }
909
910 \textit{A similar situation arises for a \addtoindex{C++} using declaration
911 \addtoindexx{namespace (C++)!using declaration}
912 \addtoindexx{using declaration|see {namespace (C++), using declaration}}
913 that imports an entity in terms of a namespace alias. See 
914 Appendix  \refersec{app:namespaceexample}
915 for an example.
916 }
917
918 \section{Subroutine and Entry Point Entries}
919 \label{chap:subroutineandentrypointentries}
920
921 The following tags exist to describe 
922 debugging information entries 
923 \addtoindexx{function entry|see{subroutine entry}}
924 for 
925 \addtoindexx{subroutine entry}
926 subroutines 
927 \addtoindexx{subprogram entry}
928 and entry
929 % FIXME: is entry point entry the right index 'entry'?
930 \addtoindexx{entry point entry}
931 points:
932
933 \begin{tabular}{lp{9.0cm}}
934 \DWTAGsubprogramTARG{} & A subroutine or function \\
935 \DWTAGinlinedsubroutine{} & A particular inlined 
936 \addtoindexx{inlined subprogram entry}
937 instance of a subroutine or function \\
938 \DWTAGentrypointTARG{} & An alternate entry point \\
939 \end{tabular}
940
941
942 \needlines{6}
943 \subsection{General Subroutine and Entry Point Information}
944 \label{chap:generalsubroutineandentrypointinformation}
945 The subroutine or entry point entry has a \DWATname{} 
946 attribute whose value is a null-terminated string containing the 
947 subroutine or entry point name as it appears in the source program.
948 It may also have a \DWATlinkagename{} attribute as
949 described in Section \refersec{chap:linkagenames}.
950
951 If the name of the subroutine described by an entry with the
952 \addtoindexx{subprogram entry}
953 tag \DWTAGsubprogram{}
954 is visible outside of its containing
955 \hypertarget{chap:DWATexternalexternalsubroutine}{}
956 compilation unit, that entry has 
957 \addtoindexx{external attribute}
958
959 \DWATexternal{} attribute,
960 which is a \livelink{chap:classflag}{flag}.
961
962 \textit{Additional attributes for functions that are members of a
963 class or structure are described in 
964 Section \refersec{chap:memberfunctionentries}.
965 }
966
967
968 \hypertarget{chap:DWATmainsubprogrammainorstartingsubprogram}{}
969 subroutine entry 
970 may contain a 
971 \DWATmainsubprogram{}
972 attribute 
973 \addtoindexx{main subprogram attribute}
974 which is 
975 a \livelink{chap:classflag}{flag} whose presence indicates that the
976 subroutine has been identified as the starting function of
977 the program.  If more than one subprogram contains this 
978 \nolink{flag},
979 any one of them may be the starting subroutine of the program.
980
981 \textit{\addtoindex{Fortran} has a \addtoindex{PROGRAM statement} 
982 which is used to specify
983 and provide a user\dash supplied name for the main subroutine of
984 a program.
985 }
986
987 \textit{A common debugger feature is to allow the debugger user to call
988 a subroutine within the subject program. In certain cases,
989 however, the generated code for a subroutine will not obey
990 the standard calling conventions for the target architecture
991 and will therefore not be safe to call from within a debugger.
992 }
993
994 A subroutine entry may 
995 \hypertarget{chap:DWATcallingconventionsubprogramcallingconvention}{}
996 contain a 
997 \DWATcallingconvention{}
998 attribute, whose value is an 
999 \livelink{chap:classconstant}{integer constant}. The set of
1000 calling convention codes is given in 
1001 Table \refersec{tab:callingconventioncodes}.
1002
1003 \begin{simplenametable}[1.4in]{Calling convention codes}{tab:callingconventioncodes}
1004 \DWCCnormalINDX        \\
1005 \DWCCprogramINDX       \\
1006 \DWCCnocallINDX        \\
1007 \end{simplenametable}
1008
1009 If this attribute is not present, or its value is the constant
1010 \DWCCnormalTARG, then the subroutine may be safely called by
1011 obeying the \doublequote{standard} calling conventions of the target
1012 architecture. If the value of the calling convention attribute
1013 is the constant \DWCCnocallTARG, the subroutine does not obey
1014 standard calling conventions, and it may not be safe for the
1015 debugger to call this subroutine.
1016
1017 If the semantics of the language of the compilation unit
1018 containing the subroutine entry distinguishes between ordinary
1019 subroutines and subroutines that can serve as the \doublequote{main
1020 program,} that is, subroutines that cannot be called
1021 directly according to the ordinary calling conventions,
1022 then the debugging information entry for such a subroutine
1023 may have a calling convention attribute whose value is the
1024 constant \DWCCprogramTARG.
1025
1026 \textit{The \DWCCprogram{} 
1027 value is intended to support \addtoindex{Fortran} main
1028 \addtoindexx{Fortran!main program}
1029 programs which in some implementations may not be callable
1030 or which must be invoked in a special way. It is not intended
1031 as a way of finding the entry address for the program.
1032 }
1033
1034 \textit{In \addtoindex{C}
1035 there is a difference between the types of functions
1036 declared using function prototype style declarations and
1037 those declared using non\dash prototype declarations.
1038 }
1039
1040 A subroutine entry declared with a function prototype style
1041 declaration may have 
1042 \addtoindexx{prototyped attribute}
1043
1044 \DWATprototyped{} attribute, which is
1045 a \livelink{chap:classflag}{flag}.
1046
1047 \textit{The \addtoindex{Fortran} 
1048 language allows the keywords \texttt{elemental}, \texttt{pure}
1049 and \texttt{recursive} to be included as part of the declaration of
1050 a subroutine; these attributes reflect that usage. These
1051 attributes are not relevant for languages that do not support
1052 similar keywords or syntax. In particular, the \DWATrecursive{}
1053 attribute is neither needed nor appropriate in languages such
1054 as \addtoindex{C} 
1055 where functions support recursion by default.
1056 }
1057
1058 A subprogram entry 
1059 \hypertarget{chap:DWATelementalelementalpropertyofasubroutine}{}
1060 may have 
1061 \addtoindexx{elemental attribute}
1062
1063 \DWATelemental{} attribute, which
1064 is a \livelink{chap:classflag}{flag}. 
1065 The attribute indicates whether the subroutine
1066 or entry point was declared with the \doublequote{elemental} keyword
1067 or property.
1068
1069
1070 \hypertarget{chap:DWATpurepurepropertyofasubroutine}{}
1071 subprogram entry may have 
1072 \addtoindexx{pure attribute}
1073
1074 \DWATpure{} attribute, which is
1075 a \livelink{chap:classflag}{flag}. 
1076 The attribute indicates whether the subroutine was
1077 declared with the \doublequote{pure} keyword or property.
1078
1079
1080 \hypertarget{chap:DWATrecursiverecursivepropertyofasubroutine}
1081 subprogram entry may have a 
1082 \DWATrecursive{} attribute, which
1083 is a \livelink{chap:classflag}{flag}. 
1084 The attribute indicates whether the subroutine
1085 or entry point was declared with the \doublequote{recursive} keyword
1086 or property.
1087
1088
1089
1090 \subsection{Subroutine and Entry Point Return Types}
1091 \label{chap:subroutineandentrypointreturntypes}
1092
1093 If 
1094 \hypertarget{chap:DWATtypetypeofsubroutinereturn}{}
1095 the subroutine or entry point 
1096 \addtoindexx{return type of subroutine}
1097 is a function that returns a
1098 value, then its debugging information entry has 
1099 \addtoindexx{type attribute}
1100 a \DWATtype{} attribute 
1101 to denote the type returned by that function.
1102
1103 \textit{Debugging information entries for 
1104 \addtoindex{C} void functions should
1105 not have an attribute for the return type.  }
1106
1107 \textit{Debugging information entries for declarations of \addtoindex{C++} 
1108 member functions with an 
1109 \addtoindex{\texttt{auto} return type} specifier should use an unspecified 
1110 type entry (see 
1111 Section \refersec{chap:unspecifiedtypeentries}). 
1112 The debugging information entry for the corresponding definition
1113 should provide the deduced return type.  This practice causes the description of
1114 the containing class to be consistent across compilation units, allowing the class
1115 declaration to be placed into a separate type unit if desired.}
1116
1117
1118 \subsection{Subroutine and Entry Point Locations}
1119 \label{chap:subroutineandentrypointlocations}
1120
1121 A subroutine entry may have either a \DWATlowpc{} and
1122 \DWAThighpc{} pair of attributes or a \DWATranges{} attribute
1123 \addtoindexx{ranges attribute}
1124 whose 
1125 \addtoindexx{high PC attribute}
1126 values 
1127 \addtoindexx{low PC attribute}
1128 encode the contiguous or non\dash contiguous address
1129 ranges, respectively, of the machine instructions generated
1130 for the subroutine (see 
1131 Section \refersec{chap:codeaddressesandranges}).
1132
1133
1134 \hypertarget{chap:DWATentrypcentryaddressofsubprogram}{}
1135 subroutine entry may also have 
1136 \addtoindexx{entry pc attribute!for subroutine}
1137
1138 \DWATentrypc{} attribute
1139 whose value is the address of the first executable instruction
1140 of the subroutine (see 
1141 Section \refersec{chap:entryaddress}).
1142
1143 An entry point has a \DWATlowpc{} attribute whose value is the
1144 relocated address of the first machine instruction generated
1145 for the entry point.
1146
1147 \textit{While the 
1148 \DWATentrypc{} attribute 
1149 \addtoindexx{entry pc attribute!for subroutine}
1150 might 
1151 also seem appropriate
1152 for this purpose, historically the 
1153 \DWATlowpc{} attribute
1154 was used before the 
1155 \DWATentrypc{} was introduced (in
1156 \addtoindex{DWARF Version 3}). 
1157 There is insufficient reason to change this.}
1158
1159
1160 Subroutines 
1161 and 
1162 entry
1163 \addtoindexx{address class!attribute}
1164 points 
1165 \hypertarget{chap:DWATaddressclasssubroutineorsubroutinetype}{}
1166 may also have 
1167 \DWATsegment{} 
1168 and
1169 \DWATaddressclass{} attributes,
1170 as appropriate, to specify
1171 which segments the code for the subroutine resides in and
1172 the addressing mode to be used in calling that subroutine.
1173
1174 A subroutine entry representing a subroutine declaration
1175 that is not also a definition does not have code address or
1176 range attributes.
1177
1178
1179 \subsection{Declarations Owned by Subroutines and Entry Points} 
1180 \label{chap:declarationsownedbysubroutinesandentrypoints}
1181
1182 The declarations enclosed by a subroutine or entry point are
1183 represented by debugging information entries that are owned
1184 by the subroutine or entry point entry. Entries representing
1185 \addtoindexx{formal parameter}
1186 the formal parameters of the subroutine or entry point appear
1187 in the same order as the corresponding declarations in the
1188 source program.
1189
1190 \needlines{5}
1191 \textit{There is no ordering requirement for entries for declarations
1192 that are children of subroutine or entry point entries but
1193 that do not represent formal parameters. The formal parameter
1194 entries may be interspersed with other entries used by formal
1195 parameter entries, such as type entries.}
1196
1197 The unspecified parameters of a variable parameter list are
1198 represented by a debugging information entry\addtoindexx{unspecified parameters entry}
1199 with the tag
1200 \DWTAGunspecifiedparametersTARG.
1201
1202 The entry for a subroutine that includes a
1203 \addtoindex{Fortran}
1204 \addtoindexx{Fortran!common block}
1205 \livelink{chap:fortrancommonblock}{common} 
1206 \livelink{chap:commonblockentry}{block}
1207 \addtoindexx{common block|see{Fortran common block}}
1208 has a child entry with the 
1209 tag \DWTAGcommoninclusionTARG. 
1210 The
1211 \hypertarget{chap:commonreferencecommonblockusage}{}
1212 common inclusion entry has a 
1213 \DWATcommonreference{} attribute
1214 whose value is a \livelink{chap:classreference}{reference} 
1215 to the debugging information entry
1216 for the common \nolink{block} being included 
1217 (see Section \refersec{chap:commonblockentries}).
1218
1219 \subsection{Low-Level Information}
1220 \label{chap:lowlevelinformation}
1221
1222
1223 \hypertarget{chap:DWATreturnaddrsubroutinereturnaddresssavelocation}{}
1224 subroutine or entry point entry may have 
1225 \addtoindexx{return address attribute}
1226
1227 \DWATreturnaddr{}
1228 attribute, whose value is a location description. The location
1229 calculated is the place where the return address for the
1230 subroutine or entry point is stored.
1231
1232
1233 \hypertarget{chap:DWATframebasesubroutineframebaseaddress}{}
1234 subroutine or entry point entry may also have 
1235 \addtoindexx{frame base attribute}
1236 a
1237 \DWATframebase{} attribute, whose value is a location
1238 description that computes the \doublequote{frame base} for the
1239 subroutine or entry point. If the location description is
1240 a simple register location description, the given register
1241 contains the frame base address. If the location description is
1242 a DWARF expression, the result of evaluating that expression
1243 is the frame base address. Finally, for a 
1244 \addtoindex{location list},
1245 this interpretation applies to each location description
1246 contained in the list of \addtoindex{location list} entries.
1247
1248 \textit{The use of one of the \DWOPregn{} 
1249 operations in this
1250 context is equivalent to using 
1251 \DWOPbregn(0) 
1252 but more
1253 compact. However, these are not equivalent in general.}
1254
1255 \needlines{5}
1256 \textit{The frame base for a procedure is typically an address fixed
1257 relative to the first unit of storage allocated for the
1258 procedure\textquoteright s stack frame. The \DWATframebase{} attribute
1259 can be used in several ways:}
1260 \begin{enumerate}[1. ]
1261 \item \textit{In procedures that need 
1262 \addtoindexx{location list}
1263 location lists to locate local
1264 variables, the \DWATframebase{} can hold the needed location
1265 list, while all variables\textquoteright\  location descriptions can be
1266 simpler ones involving the frame base.}
1267
1268 \item \textit{It can be used in resolving \doublequote{up\dash level} addressing
1269 within nested routines. 
1270 (See also \DWATstaticlink, below)}
1271 \end{enumerate}
1272
1273 \needlines{5}
1274 \textit{Some languages support nested subroutines. In such languages,
1275 it is possible to reference the local variables of an
1276 outer subroutine from within an inner subroutine. The
1277 \DWATstaticlink{} and \DWATframebase{} attributes allow
1278 debuggers to support this same kind of referencing.}
1279
1280 If 
1281 \hypertarget{chap:DWATstaticlinklocationofuplevelframe}{}
1282
1283 \addtoindexx{address!uplevel|see {static link attribute}}
1284 \addtoindexx{uplevel address|see {static link attribute}}
1285 subroutine or entry point is nested, it may have a
1286 \DWATstaticlink{}
1287 attribute, whose value is a location
1288 description that computes the frame base of the relevant
1289 instance of the subroutine that immediately encloses the
1290 subroutine or entry point.
1291
1292 In the context of supporting nested subroutines, the
1293 \DWATframebase{} attribute value should obey the following
1294 constraints:
1295
1296 \begin{enumerate}[1. ]
1297 \item It should compute a value that does not change during the
1298 life of the procedure, and
1299
1300 \item The computed value should be unique among instances of
1301 the same subroutine. (For typical \DWATframebase{} use, this
1302 means that a recursive subroutine\textquoteright s stack frame must have
1303 non\dash zero size.)
1304 \end{enumerate}
1305
1306 \textit{If a debugger is attempting to resolve an up\dash level reference
1307 to a variable, it uses the nesting structure of DWARF to
1308 determine which subroutine is the lexical parent and the
1309 \DWATstaticlink{} value to identify the appropriate active
1310 frame of the parent. It can then attempt to find the reference
1311 within the context of the parent.}
1312
1313
1314 \needlines{8}
1315 \subsection{Types Thrown by Exceptions}
1316 \label{chap:typesthrownbyexceptions}
1317
1318 \textit{In \addtoindex{C++} a subroutine may declare a set of types which
1319 it may validly throw.}
1320
1321 If a subroutine explicitly declares that it may throw
1322 \addtoindexx{exception thrown|see{thrown type entry}}
1323 an 
1324 \addtoindexx{thrown exception|see{thrown type entry}}
1325 exception of one or more types, each such type is
1326 represented by a debugging information entry with 
1327 \addtoindexx{thrown type entry}
1328 the tag
1329 \DWTAGthrowntypeTARG.  
1330 Each such entry is a child of the entry
1331 representing the subroutine that may throw this type. Each
1332 thrown type entry contains 
1333 \addtoindexx{type attribute}
1334 a \DWATtype{} attribute, whose
1335 value is a \livelink{chap:classreference}{reference} 
1336 to an entry describing the type of the
1337 exception that may be thrown.
1338
1339 \subsection{Function Template Instantiations}
1340 \label{chap:functiontemplateinstantiations}
1341
1342 \textit{In \addtoindex{C++}, a function template is a generic definition of
1343 a function that is instantiated differently for calls with
1344 values of different types. DWARF does not represent the generic
1345 template definition, but does represent each instantiation.}
1346
1347 A \addtoindex{template instantiation} is represented by a debugging
1348 information entry with the 
1349 \addtoindexx{subprogram entry!use for template instantiation}
1350 tag \DWTAGsubprogram. 
1351 With the following
1352 exceptions, such an entry will contain the same attributes and
1353 will have the same types of child entries as would an entry
1354 for a subroutine defined explicitly using the instantiation
1355 types and values. The exceptions are:
1356
1357 \begin{enumerate}[1. ]
1358 \item Template parameters are described and referenced as specified in
1359 Section \refersec{chap:templateparameters}.
1360
1361 \item If the compiler has generated a special compilation unit
1362 to hold the template instantiation and that compilation unit
1363 has a different name from the compilation unit containing
1364 the template definition, the name attribute for the debugging
1365 information entry representing that compilation unit is empty
1366 or omitted.
1367
1368 \item If the subprogram entry representing the template
1369 instantiation or any of its child entries contain declaration
1370 coordinate attributes, those attributes refer to the source
1371 for the template definition, not to any source generated
1372 artificially by the compiler for this instantiation.
1373 \end{enumerate}
1374
1375
1376 \needlines{8}
1377 \subsection{Inlinable and Inlined Subroutines}
1378 A declaration or a definition of an inlinable subroutine
1379 is represented by a debugging information entry with the
1380 tag 
1381 \DWTAGsubprogram.
1382 The entry for a 
1383 \addtoindexx{subprogram entry!use in inlined subprogram}
1384 subroutine that is
1385 \hypertarget{chap:DWATinlineinlinedsubroutine}{}
1386 explicitly declared to be available for inline expansion or
1387 that was expanded inline implicitly by the compiler has 
1388 \addtoindexx{inline attribute}
1389 a
1390 \DWATinline{} attribute whose value is an 
1391 \livelink{chap:classconstant}{integer constant}. The
1392 set of values for the \DWATinline{} attribute is given in
1393 Table \refersec{tab:inlinecodes}.
1394
1395 \begin{table}[here]
1396 \centering
1397 \caption{Inline codes}
1398 \label{tab:inlinecodes}
1399 \begin{tabular}{l|p{8cm}}
1400 \hline
1401 Name&Meaning\\ \hline
1402 \DWINLnotinlinedTARG{} & Not declared inline nor inlined by the
1403   \mbox{compiler} (equivalent to the absence of the
1404   containing \DWATinline{} attribute) \\
1405 \DWINLinlinedTARG{} & Not declared inline but inlined by the \mbox{compiler} \\
1406 \DWINLdeclarednotinlinedTARG{} & Declared inline but 
1407   not inlined by the \mbox{compiler} \\
1408 \DWINLdeclaredinlinedTARG{} & Declared inline and inlined by the 
1409   \mbox{compiler} \\
1410 \hline
1411 \end{tabular}
1412 \end{table}
1413
1414 \textit{In \addtoindex{C++}, a function or a constructor declared with
1415 \addttindex{constexpr} is implicitly declared inline. The abstract inline
1416 instance (see below) is represented by a debugging information
1417 entry with the tag \DWTAGsubprogram. Such an entry has a
1418 \DWATinline{} attribute whose value is \DWINLinlined.}
1419
1420
1421 \subsubsection{Abstract Instances}
1422 \label{chap:abstractinstances}
1423 Any debugging information entry that is owned (either
1424 \hypertarget{chap:DWATinlineabstracttinstance}{}
1425 directly or indirectly) by a debugging information entry
1426 that contains the 
1427 \DWATinline{} attribute is referred to
1428 \addtoindexx{abstract instance!entry}
1429 as an \doublequote{abstract instance entry.} 
1430 Any subroutine entry
1431 that contains 
1432 \addtoindexx{inline attribute}
1433 a \DWATinline{} attribute whose value is other
1434 than \DWINLnotinlined{}
1435 is known as 
1436 \addtoindexx{abstract instance!root}
1437 an \doublequote{abstract instance root.} 
1438 Any set of abstract instance entries that are all
1439 children (either directly or indirectly) of some abstract
1440 instance root, together with the root itself, is known as
1441 \addtoindexx{abstract instance!tree}
1442 an \doublequote{abstract instance tree.} However, in the case where
1443 an abstract instance tree is nested within another abstract
1444 instance tree, the entries in the 
1445 \addtoindex{nested abstract instance}
1446 tree are not considered to be entries in the outer abstract
1447 instance tree.
1448
1449 Each abstract instance root is either part of a larger
1450 \addtoindexx{abstract instance!root}
1451 tree (which gives a context for the root) or 
1452 \addtoindexx{specification attribute}
1453 uses
1454 \DWATspecification{} 
1455 to refer to the declaration in context.
1456
1457 \textit{For example, in \addtoindex{C++} the context might be a namespace
1458 declaration or a class declaration.}
1459
1460 \textit{Abstract instance trees are defined so that no entry is part
1461 of more than one abstract instance tree. This simplifies the
1462 following descriptions.}
1463
1464 A debugging information entry that is a member of an abstract
1465 instance tree should not contain any attributes which describe
1466 aspects of the subroutine which vary between distinct inlined
1467 expansions or distinct out\dash of\dash line expansions. For example,
1468 \addtoindexx{entry pc attribute!and abstract instance}
1469 the \DWATlowpc,
1470 \DWAThighpc, 
1471 \DWATranges, 
1472 \DWATentrypc, 
1473 \DWATlocation,
1474 \DWATreturnaddr, 
1475 \DWATstartscope, 
1476 and 
1477 \DWATsegment{}
1478 attributes 
1479 \addtoindexx{location attribute!and abstract instance}
1480 typically 
1481 \addtoindexx{ranges attribute!and abstract instance}
1482 should 
1483 \addtoindexx{high PC attribute!and abstract instance}
1484 be 
1485 \addtoindexx{low PC attribute!and abstract instance}
1486 omitted; 
1487 \addtoindexx{segment attribute!and abstract instance}
1488 however, 
1489 \addtoindexx{return address attribute!and abstract instance}
1490 this 
1491 \addtoindexx{segment attribute!and abstract instance}
1492 list
1493 \addtoindexx{start scope attribute!and abstract instance}
1494 is not exhaustive.
1495
1496 \needlines{5}
1497 \textit{It would not make sense normally to put these attributes into
1498 abstract instance entries since such entries do not represent
1499 actual (concrete) instances and thus do not actually exist at
1500 run\dash time.  However, 
1501 see Appendix \refersec{app:inlineouteronenormalinner} 
1502 for a contrary example.}
1503
1504 The rules for the relative location of entries belonging to
1505 abstract instance trees are exactly the same as for other
1506 similar types of entries that are not abstract. Specifically,
1507 the rule that requires that an entry representing a declaration
1508 be a direct child of the entry representing the scope of the
1509 declaration applies equally to both abstract and non\dash abstract
1510 entries. Also, the ordering rules for formal parameter entries,
1511 member entries, and so on, all apply regardless of whether
1512 or not a given entry is abstract.
1513
1514 \needlines{5}
1515 \subsubsection{Concrete Inlined Instances}
1516 \label{chap:concreteinlinedinstances}
1517
1518 Each inline expansion of a subroutine is represented
1519 by a debugging information entry with the 
1520 tag \DWTAGinlinedsubroutineTARG. 
1521 Each such entry should be a direct
1522 child of the entry that represents the scope within which
1523 the inlining occurs.
1524
1525 Each inlined subroutine entry may have either a 
1526 \DWATlowpc{}
1527 and \DWAThighpc{} pair 
1528 of 
1529 \addtoindexx{high PC attribute}
1530 attributes 
1531 \addtoindexx{low PC attribute}
1532 or 
1533 \addtoindexx{ranges attribute}
1534
1535 \DWATranges{}
1536 attribute whose values encode the contiguous or non\dash contiguous
1537 address ranges, respectively, of the machine instructions
1538 generated for the inlined subroutine (see 
1539 Section \referfol{chap:codeaddressesandranges}). 
1540 An
1541 \hypertarget{chap:DWATentrypcentryaddressofinlinedsubprogram}{}
1542 inlined subroutine entry may 
1543 \addtoindexx{inlined subprogram entry!in concrete instance}
1544 also 
1545 \addtoindexx{inlined subprogram entry}
1546 contain 
1547 \addtoindexx{entry pc attribute!for inlined subprogram}
1548
1549 \DWATentrypc{}
1550 attribute, representing the first executable instruction of
1551 the inline expansion (see 
1552 Section \refersec{chap:entryaddress}).
1553
1554 % Positions of the 3 targets here is a bit arbitrary.
1555 An inlined 
1556 \hypertarget{chap:DWATcalllinelinenumberofinlinedsubroutinecall}{}
1557 subroutine 
1558 \hypertarget{chap:DWATcallcolumncolumnpositionofinlinedsubroutinecall}{}
1559 entry 
1560 \hypertarget{chap:DWATcallfilefilecontaininginlinedsubroutinecall}{}
1561 may also have \DWATcallfile,
1562 \DWATcallline{} and \DWATcallcolumn{} attributes, 
1563 each of whose
1564 value is an \livelink{chap:classconstant}{integer constant}. 
1565 These attributes represent the
1566 source file, source line number, and source column number,
1567 respectively, of the first character of the statement or
1568 expression that caused the inline expansion. The call file,
1569 call line, and call column attributes are interpreted in
1570 the same way as the declaration file, declaration line, and
1571 declaration column attributes, respectively (see 
1572 Section \refersec{chap:declarationcoordinates}).
1573
1574 \textit{The call file, call line and call column coordinates do not
1575 describe the coordinates of the subroutine declaration that
1576 was inlined, rather they describe the coordinates of the call.
1577 }
1578
1579 An inlined subroutine entry 
1580 \hypertarget{chap:DWATconstexprcompiletimeconstantfunction}{}
1581 may have a 
1582 \DWATconstexpr{}
1583 attribute, which is a \livelink{chap:classflag}{flag} 
1584 whose presence indicates that the
1585 subroutine has been evaluated as a compile\dash time constant. Such
1586 an entry may also have a \DWATconstvalue{} attribute,
1587 whose value may be of any form that is appropriate for the
1588 representation of the subroutine's return value. The value of
1589 this attribute is the actual return value of the subroutine,
1590 represented as it would be on the target architecture.
1591
1592 \textit{In \addtoindex{C++}, if a function or a constructor declared with 
1593 \addttindex{constexpr}
1594 is called with constant expressions, then the corresponding
1595 concrete inlined instance has a 
1596 \DWATconstexpr{} attribute,
1597 as well as a \DWATconstvalue{} attribute whose value represents
1598 the actual return value of the concrete inlined instance.}
1599
1600 Any debugging information entry that is owned (either
1601 directly or indirectly) by a debugging information entry
1602 with the tag \DWTAGinlinedsubroutine{} is referred to as a
1603 \doublequote{concrete inlined instance entry.} Any entry that has
1604 the tag 
1605 \DWTAGinlinedsubroutine{} 
1606 is known as a \doublequote{concrete inlined instance root.} 
1607 Any set of concrete inlined instance
1608 entries that are all children (either directly or indirectly)
1609 of some concrete inlined instance root, together with the root
1610 itself, is known as a \doublequote{concrete inlined instance tree.}
1611 However, in the case where a concrete inlined instance tree
1612 is nested within another concrete instance tree, the entries
1613 in the \addtoindex{nested concrete inline instance} tree 
1614 are not considered to
1615 be entries in the outer concrete instance tree.
1616
1617 \textit{Concrete inlined instance trees are defined so that no entry
1618 is part of more than one concrete inlined instance tree. This
1619 simplifies later descriptions.}
1620
1621 Each concrete inlined instance tree is uniquely associated
1622 with one (and only one) abstract instance tree.
1623
1624 \textit{Note, however, that the reverse is not true. Any given abstract
1625 instance tree may be associated with several different concrete
1626 inlined instance trees, or may even be associated with zero
1627 concrete inlined instance trees.}
1628
1629 Concrete inlined instance entries may omit attributes that
1630 are not specific to the concrete instance (but present in
1631 the abstract instance) and need include only attributes that
1632 are specific to the concrete instance (but omitted in the
1633 abstract instance). In place of these omitted attributes, each
1634 \hypertarget{chap:DWATabstractorigininlineinstance}{}
1635 concrete inlined instance entry 
1636 \addtoindexx{abstract origin attribute}
1637 has a 
1638 \DWATabstractorigin{}
1639 attribute that may be used to obtain the missing information
1640 (indirectly) from the associated abstract instance entry. The
1641 value of the abstract origin attribute is a reference to the
1642 associated abstract instance entry.
1643
1644 If an entry within a concrete inlined instance tree contains
1645 attributes describing the 
1646 \addtoindexx{declaration coordinates!in concrete instance}
1647 \livelink{chap:declarationcoordinates}{declaration coordinates} 
1648 of that entry, then those attributes should refer to the file, line
1649 and column of the original declaration of the subroutine,
1650 not to the point at which it was inlined. As a consequence,
1651 they may usually be omitted from any entry that has an abstract
1652 origin attribute.
1653
1654 \needlines{4}
1655 For each pair of entries that are associated via a
1656 \addtoindexx{abstract origin attribute}
1657 \DWATabstractorigin{} attribute, both members of the pair
1658 have the same tag. So, for example, an entry with the tag
1659 \DWTAGvariable{} can only be associated with another entry
1660 that also has the tag \DWTAGvariable. The only exception
1661 to this rule is that the root of a concrete instance tree
1662 (which must always have the tag \DWTAGinlinedsubroutine)
1663 can only be associated with the root of its associated abstract
1664 instance tree (which must have the tag \DWTAGsubprogram).
1665
1666 \needlines{6}
1667 In general, the structure and content of any given concrete
1668 inlined instance tree will be closely analogous to the
1669 structure and content of its associated abstract instance
1670 tree. There are a few exceptions:
1671
1672 \begin{enumerate}[1. ]
1673 \item An entry in the concrete instance tree may be omitted if
1674 it contains only a 
1675 \addtoindexx{abstract origin attribute}
1676 \DWATabstractorigin{} attribute and either
1677 has no children, or its children are omitted. Such entries
1678 would provide no useful information. In C\dash like languages,
1679 such entries frequently include types, including structure,
1680 union, class, and interface types; and members of types. If any
1681 entry within a concrete inlined instance tree needs to refer
1682 to an entity declared within the scope of the relevant inlined
1683 subroutine and for which no concrete instance entry exists,
1684 the reference should refer to the abstract instance entry.
1685
1686 \item Entries in the concrete instance tree which are associated
1687 with entries in the abstract instance tree such that neither
1688 has a \DWATname{} attribute,
1689 \addtoindexx{name attribute}
1690 and neither is referenced by
1691 any other debugging information entry, may be omitted. This
1692 may happen for debugging information entries in the abstract
1693 instance trees that became unnecessary in the concrete instance
1694 tree because of additional information available there. For
1695 example, an anonymous variable might have been created and
1696 described in the abstract instance tree, but because of
1697 the actual parameters for a particular inlined expansion,
1698 it could be described as a constant value without the need
1699 for that separate debugging information entry.
1700
1701 \item A concrete instance tree may contain entries which do
1702 not correspond to entries in the abstract instance tree
1703 to describe new entities that are specific to a particular
1704 inlined expansion. In that case, they will not have associated
1705 entries in the abstract instance tree, should not contain
1706 \addtoindexx{abstract origin attribute}
1707 \DWATabstractorigin{} attributes, and must contain all their
1708 own attributes directly. This allows an abstract instance tree
1709 to omit debugging information entries for anonymous entities
1710 that are unlikely to be needed in most inlined expansions. In
1711 any expansion which deviates from that expectation, the
1712 entries can be described in its concrete inlined instance tree.
1713
1714 \end{enumerate}
1715
1716 \subsubsection{Out-of-Line Instances of Inlined Subroutines}
1717 \label{chap:outoflineinstancesofinlinedsubroutines}
1718 Under some conditions, compilers may need to generate concrete
1719 executable instances of inlined subroutines other than at
1720 points where those subroutines are actually called. Such
1721 concrete instances of inlined subroutines are referred to as
1722 \doublequote{concrete out\dash of\dash line instances.}
1723
1724 \textit{In \addtoindex{C++}, for example, 
1725 taking the address of a function declared
1726 to be inline can necessitate the generation of a concrete
1727 out\dash of\dash line instance of the given function.}
1728
1729 The DWARF representation of a concrete out\dash of\dash line instance
1730 of an inlined subroutine is essentially the same as for a
1731 concrete inlined instance of that subroutine (as described in
1732 the preceding section). The representation of such a concrete
1733 % It is critical that the hypertarget and livelink be
1734 % separated to avoid problems with latex.
1735 out\dash of\dash line 
1736 \addtoindexx{abstract origin attribute}
1737 instance 
1738 \hypertarget{chap:DWATabstractoriginoutoflineinstance}{}
1739 makes use of 
1740 \DWATabstractorigin{}
1741 attributes in exactly the same way as they are used for
1742 a concrete inlined instance (that is, as references to
1743 corresponding entries within the associated abstract instance
1744 tree).
1745
1746 The differences between the DWARF representation of a
1747 concrete out\dash of\dash line instance of a given subroutine and the
1748 representation of a concrete inlined instance of that same
1749 subroutine are as follows:
1750
1751 \begin{enumerate}[1. ]
1752 \item  The root entry for a concrete out\dash of\dash line instance
1753 of a given inlined subroutine has the same tag as does its
1754 associated (abstract) inlined subroutine entry (that is, tag
1755 \DWTAGsubprogram{} rather than \DWTAGinlinedsubroutine).
1756
1757 \item The root entry for a concrete out\dash of\dash line instance tree
1758 is normally owned by the same parent entry that also owns
1759 the root entry of the associated abstract instance. However,
1760 it is not required that the abstract and out\dash of\dash line instance
1761 trees be owned by the same parent entry.
1762
1763 \end{enumerate}
1764
1765 \subsubsection{Nested Inlined Subroutines}
1766 \label{nestedinlinedsubroutines}
1767 Some languages and compilers may permit the logical nesting of
1768 a subroutine within another subroutine, and may permit either
1769 the outer or the nested subroutine, or both, to be inlined.
1770
1771 For a non\dash inlined subroutine nested within an inlined
1772 subroutine, the nested subroutine is described normally in
1773 both the abstract and concrete inlined instance trees for
1774 the outer subroutine. All rules pertaining to the abstract
1775 and concrete instance trees for the outer subroutine apply
1776 also to the abstract and concrete instance entries for the
1777 nested subroutine.
1778
1779 \needlines{5}
1780 For an inlined subroutine nested within another inlined
1781 subroutine, the following rules apply to their abstract and
1782 \addtoindexx{abstract instance!nested}
1783 \addtoindexx{concrete instance!nested}
1784 concrete instance trees:
1785
1786 \begin{enumerate}[1. ]
1787 \item The abstract instance tree for the nested subroutine is
1788 described within the abstract instance tree for the outer
1789 subroutine according to the rules in 
1790 Section \refersec{chap:abstractinstances}, and
1791 without regard to the fact that it is within an outer abstract
1792 instance tree.
1793
1794 \item Any abstract instance tree for a nested subroutine is
1795 always omitted within the concrete instance tree for an
1796 outer subroutine.
1797
1798 \item  A concrete instance tree for a nested subroutine is
1799 always omitted within the abstract instance tree for an
1800 outer subroutine.
1801
1802 \item The concrete instance tree for any inlined or 
1803 \addtoindexx{out-of-line instance}
1804 out-of-line
1805 \addtoindexx{out-of-line-instance|see{concrete out-of-line-instance}}
1806 expansion of the nested subroutine is described within a
1807 concrete instance tree for the outer subroutine according
1808 to the rules in 
1809 Sections \refersec{chap:concreteinlinedinstances} or 
1810 \referfol{chap:outoflineinstancesofinlinedsubroutines}
1811 , respectively,
1812 and without regard to the fact that it is within an outer
1813 concrete instance tree.
1814 \end{enumerate}
1815
1816 See Appendix \refersec{app:inliningexamples} 
1817 for discussion and examples.
1818
1819 \subsection{Trampolines}
1820 \label{chap:trampolines}
1821
1822 \textit{A trampoline is a compiler\dash generated subroutine that serves as
1823 \hypertarget{chap:DWATtrampolinetargetsubroutine}{}
1824 an intermediary in making a call to another subroutine. It may
1825 adjust parameters and/or the result (if any) as appropriate
1826 to the combined calling and called execution contexts.}
1827
1828 A trampoline is represented by a debugging information entry
1829 \addtoindexx{trampoline (subprogam) entry}
1830 with the tag \DWTAGsubprogram{} or \DWTAGinlinedsubroutine{}
1831 that has 
1832 \addtoindexx{trampoline attribute}
1833 a \DWATtrampoline{} attribute. 
1834 The value of that
1835 attribute indicates the target subroutine of the trampoline,
1836 that is, the subroutine to which the trampoline passes
1837 control. (A trampoline entry may but need not also have a
1838 \DWATartificial{} attribute.)
1839
1840 \needlines{5}
1841 The value of the trampoline attribute may be represented
1842 using any of the following forms, which are listed in order
1843 of preference:
1844
1845 \begin{itemize}
1846 \item If the value is of class reference, then the value
1847 specifies the debugging information entry of the target
1848 subprogram.
1849
1850 \item If the value is of class address, then the value is
1851 the relocated address of the target subprogram.
1852
1853 \item If the value is of class string, then the value is the
1854 (possibly mangled) \addtoindexx{mangled names}
1855 name of the target subprogram.
1856
1857 \item If the value is of class \livelink{chap:classflag}{flag}, then the value true
1858 indicates that the containing subroutine is a trampoline but
1859 that the target subroutine is not known.
1860 \end{itemize}
1861
1862
1863 The target subprogram may itself be a trampoline. (A sequence
1864 of trampolines necessarily ends with a non\dash trampoline
1865 subprogram.)
1866
1867 \textit{In \addtoindex{C++}, trampolines may be used 
1868 to implement derived virtual
1869 member functions; such trampolines typically adjust the
1870 \addtoindexx{this parameter}
1871 implicit this pointer parameter in the course of passing
1872 control.  
1873 Other languages and environments may use trampolines
1874 in a manner sometimes known as transfer functions or transfer
1875 vectors.}
1876
1877 \textit{Trampolines may sometimes pass control to the target
1878 subprogram using a branch or jump instruction instead of a
1879 call instruction, thereby leaving no trace of their existence
1880 in the subsequent execution context. }
1881
1882 \textit{This attribute helps make it feasible for a debugger to arrange
1883 that stepping into a trampoline or setting a breakpoint in
1884 a trampoline will result in stepping into or setting the
1885 breakpoint in the target subroutine instead. This helps to
1886 hide the compiler generated subprogram from the user. }
1887
1888 \textit{If the target subroutine is not known, a debugger may choose
1889 to repeatedly step until control arrives in a new subroutine
1890 which can be assumed to be the target subroutine. }
1891
1892
1893
1894 \section{Lexical Block Entries}
1895 \label{chap:lexicalblockentries}
1896
1897 \textit{A 
1898 lexical \livetargi{chap:lexicalblock}{block}{lexical block} 
1899 is 
1900 \addtoindexx{lexical block}
1901 a bracketed sequence of source statements
1902 that may contain any number of declarations. In some languages
1903 (including \addtoindex{C} and \addtoindex{C++}),
1904 \nolink{blocks} can be nested within other
1905 \nolink{blocks} to any depth.}
1906
1907 % We do not need to link to the preceding paragraph.
1908 A lexical \nolink{block} is represented by a debugging information
1909 entry with the 
1910 tag \DWTAGlexicalblockTARG.
1911
1912 The lexical \livetargi{chap:lexicalblockentry}{block}{lexical block entry} 
1913 entry may have 
1914 either a \DWATlowpc{} and
1915 \DWAThighpc{} pair of 
1916 attributes 
1917 \addtoindexx{high PC attribute}
1918 or 
1919 \addtoindexx{low PC attribute}
1920
1921 \DWATranges{} attribute
1922 \addtoindexx{ranges attribute}
1923 whose values encode the contiguous or non-contiguous address
1924 ranges, respectively, of the machine instructions generated
1925 for the lexical \nolink{block} 
1926 (see Section \refersec{chap:codeaddressesandranges}).
1927
1928
1929 \hypertarget{chap:DWATentrypcoflexicalblock}{}
1930 lexical block entry may also have 
1931 \addtoindexx{entry pc attribute!for lexical block}
1932
1933 \DWATentrypc{} attribute
1934 whose value is the address of the first executable instruction
1935 of the lexical block (see 
1936 Section \refersec{chap:entryaddress}).
1937
1938 If a name has been given to the 
1939 lexical \nolink{block} 
1940 in the source
1941 program, then the corresponding 
1942 lexical \nolink{block} entry has a
1943 \DWATname{} attribute whose 
1944 \addtoindexx{name attribute}
1945 value is a null\dash terminated string
1946 containing the name of the lexical \nolink{block} 
1947 as it appears in
1948 the source program.
1949
1950 \textit{This is not the same as a \addtoindex{C} or 
1951 \addtoindex{C++} label (see below).}
1952
1953 The lexical \nolink{block} entry owns 
1954 debugging information entries that
1955 describe the declarations within that lexical \nolink{block}. 
1956 There is
1957 one such debugging information entry for each local declaration
1958 of an identifier or inner lexical \nolink{block}.
1959
1960 \section{Label Entries}
1961 \label{chap:labelentries}
1962 \textit{A label is a way of identifying a source statement. A labeled
1963 statement is usually the target of one or more \doublequote{go to}
1964 statements.
1965 }
1966
1967 A label is represented by a debugging information entry with
1968 \addtoindexx{label entry}
1969 the 
1970 tag \DWTAGlabelTARG. 
1971 The entry for a label should be owned by
1972 the debugging information entry representing the scope within
1973 which the name of the label could be legally referenced within
1974 the source program.
1975
1976 The label entry has a \DWATlowpc{} attribute whose value
1977 is the relocated address of the first machine instruction
1978 generated for the statement identified by the label in
1979 the source program.  The label entry also has a 
1980 \DWATname{} attribute 
1981 \addtoindexx{name attribute}
1982 whose value is a null-terminated string containing
1983 the name of the label as it appears in the source program.
1984
1985
1986 \section{With Statement Entries}
1987 \label{chap:withstatemententries}
1988
1989 \textit{Both \addtoindex{Pascal} and 
1990 \addtoindexx{Modula-2}
1991 Modula\dash 2 support the concept of a \doublequote{with}
1992 statement. The with statement specifies a sequence of
1993 executable statements within which the fields of a record
1994 variable may be referenced, unqualified by the name of the
1995 record variable.}
1996
1997 A with statement is represented by a
1998 \addtoindexi{debugging information entry}{with statement entry}
1999 with the tag \DWTAGwithstmtTARG.
2000
2001 A with statement entry may have either a 
2002 \DWATlowpc{} and
2003 \DWAThighpc{} pair of attributes 
2004 \addtoindexx{high PC attribute}
2005 or 
2006 \addtoindexx{low PC attribute}
2007 a \DWATranges{} attribute
2008 \addtoindexx{ranges attribute}
2009 whose values encode the contiguous or non\dash contiguous address
2010 ranges, respectively, of the machine instructions generated
2011 for the with statement 
2012 (see Section \refersec{chap:codeaddressesandranges}).
2013
2014
2015 \hypertarget{chap:DWATentrypcofwithstmt}{}
2016 with statement entry may also have 
2017 \addtoindexx{entry pc attribute!for with statement}
2018
2019 \DWATentrypc{} attribute
2020 whose value is the address of the first executable instruction
2021 of the with statement (see 
2022 Section \refersec{chap:entryaddress}).
2023
2024 \needlines{5}
2025 The with statement entry has 
2026 \addtoindexx{type attribute}
2027 a \DWATtype{} attribute, denoting
2028 the type of record whose fields may be referenced without full
2029 qualification within the body of the statement. It also has
2030 \addtoindexx{location attribute}
2031 a \DWATlocation{} attribute, describing how to find the base
2032 address of the record object referenced within the body of
2033 the with statement.
2034
2035 \section{Try and Catch Block Entries}
2036 \label{chap:tryandcatchblockentries}
2037
2038 \textit{In \addtoindex{C++} a lexical \livelink{chap:lexicalblock}{block} may be 
2039 designated as a \doublequote{catch \nolink{block}.} 
2040 A catch \livetargi{chap:catchblock}{block}{catch block} is an 
2041 exception handler that handles
2042 exceptions thrown by an immediately 
2043 preceding \doublequote{try \livelink{chap:tryblock}{block}.}
2044 A catch \livelink{chap:catchblock}{block} 
2045 designates the type of the exception that it
2046 can handle.}
2047
2048 A try \livetargi{chap:tryblock}{block}{try block} is represented 
2049 by a debugging information entry
2050 \addtoindexx{try block entry}
2051 with the tag \DWTAGtryblockTARG.  
2052 A catch \livelink{chap:catchblock}{block} is represented by
2053 a debugging information entry with 
2054 \addtoindexx{catch block entry}
2055 the tag \DWTAGcatchblockTARG.
2056
2057 % nolink as we have links just above and do not have a combo link for both
2058 Both try and catch \nolink{block} entries may have either a
2059 \DWATlowpc{} and 
2060 \DWAThighpc{} pair of attributes 
2061 \addtoindexx{high PC attribute}
2062 or 
2063 \addtoindexx{low PC attribute}
2064 a
2065 \DWATranges{} attribute 
2066 \addtoindexx{ranges attribute}
2067 whose values encode the contiguous
2068 or non\dash contiguous address ranges, respectively, of the
2069 machine instructions generated for the \livelink{chap:lexicalblock}{block}
2070 (see Section
2071 \refersec{chap:codeaddressesandranges}).
2072
2073
2074 \hypertarget{chap:DWATentrypcoftryblock}{}
2075 \hypertarget{chap:DWATentrypcofcatchblock}{}
2076 try or catch block entry may also have 
2077 \addtoindexx{entry pc attribute!for try block}
2078 \addtoindexx{entry pc attribute!for catch block}
2079
2080 \DWATentrypc{} attribute
2081 whose value is the address of the first executable instruction
2082 of the try or catch block (see 
2083 Section \refersec{chap:entryaddress}).
2084
2085 Catch \livelink{chap:catchblock}{block} entries have at 
2086 least one child entry, an
2087 entry representing the type of exception accepted by
2088 that catch \livelink{chap:catchblock}{block}. 
2089 This child entry has one of 
2090 \addtoindexx{formal parameter entry!in catch block}
2091 the 
2092 \addtoindexx{unspecified parameters entry!in catch block}
2093 tags
2094 \DWTAGformalparameter{} or
2095 \DWTAGunspecifiedparameters,
2096 and will have the same form as other parameter entries.
2097
2098 The siblings immediately following 
2099 a try \livelink{chap:tryblock}{block} entry are its
2100 corresponding catch \livelink{chap:catchblock}{block} entries.
2101
2102
2103
2104
2105
2106
2107