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