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