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