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