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