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