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