Merge branch 'HEAD' of dwarfgit@dwarfstd.org:dwarf-doc.git
[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
13 \addtoindexx{unit|see {compilation unit, partial unit \textit{or} type unit}} 
14 \addtoindexx{compilation unit}
15 three kinds: 
16 \addtoindexx{normal compilation unit}
17 \addtoindexx{normal compilation unit|see {compilation unit}}
18 normal compilation units,
19 partial compilation units and 
20 \addtoindexx{type unit}
21 type units. A 
22 \addtoindex{partial compilation unit}
23 is related to one or more other compilation units that
24 import it. A 
25 \addtoindex{type unit} represents 
26 a single complete type in a
27 separate unit. Either a normal compilation unit or a 
28 \addtoindex{partial compilation unit}
29 may be logically incorporated into another
30 compilation unit using an 
31 \addtoindex{imported unit entry}.
32
33
34 \subsection[Normal and Partial CU Entries]{Normal and Partial Compilation Unit Entries}
35 \label{chap:normalandpartialcompilationunitentries}
36
37 A \addtoindex{normal compilation unit} is represented by a debugging
38 information entry with the 
39 tag \DWTAGcompileunitTARG. 
40 A \addtoindex{partial compilation unit} is represented by a debugging information
41 entry with the 
42 tag \DWTAGpartialunitTARG.
43
44 In a simple normal compilation, a single compilation unit with
45 the tag 
46 \DWTAGcompileunit{} represents a complete object file
47 and the tag 
48 \DWTAGpartialunit{} is not used. 
49 In a compilation
50 employing the DWARF space compression and duplicate elimination
51 techniques from 
52 Appendix \refersec{app:usingcompilationunits}, 
53 multiple compilation units using
54 the tags 
55 \DWTAGcompileunit{} and/or 
56 \DWTAGpartialunit{} are
57 used to represent portions of an object file.
58
59 \textit{A normal compilation unit typically represents the text and
60 data contributed to an executable by a single relocatable
61 object file. It may be derived from several source files,
62 including pre\dash processed \doublequote{include files.} 
63 A \addtoindex{partial compilation unit} typically represents a part of the text
64 and data of a relocatable object file, in a manner that can
65 potentially be shared with the results of other compilations
66 to save space. It may be derived from an \doublequote{include file,}
67 template instantiation, or other implementation\dash dependent
68 portion of a compilation. A normal compilation unit can also
69 function in a manner similar to a partial compilation unit
70 in some cases.}
71
72 A compilation unit entry owns debugging information
73 entries that represent all or part of the declarations
74 made in the corresponding compilation. In the case of a
75 partial compilation unit, the containing scope of its owned
76 declarations is indicated by imported unit entries in one
77 or more other compilation unit entries that refer to that
78 partial compilation unit (see 
79 Section \refersec{chap:importedunitentries}).
80
81
82 Compilation unit entries may have the following 
83 attributes:
84 \begin{enumerate}[1. ]
85 \item Either a \DWATlowpc{} and 
86 \DWAThighpc{} pair of
87 \addtoindexx{high PC attribute}
88 attributes 
89 \addtoindexx{low PC attribute}
90 or 
91 \addtoindexx{ranges attribute}
92
93 \DWATranges{} attribute
94 \addtoindexx{ranges attribute}
95 whose values encode 
96 \addtoindexx{discontiguous address ranges|see{non-contiguous address ranges}}
97 the
98 contiguous or 
99 non\dash contiguous address ranges, respectively,
100 of the machine instructions generated for the compilation
101 unit (see Section \refersec{chap:codeaddressesandranges}).
102   
103 A \DWATlowpc{} attribute 
104 may also
105 be specified 
106 in combination 
107 \addtoindexx{ranges attribute}
108 with 
109 \DWATranges{} to specify the
110 \addtoindexx{ranges attribute}
111 default base address for use in 
112 \addtoindexx{location list}
113 location lists (see Section
114 \refersec{chap:locationlists}) and range lists 
115 \addtoindexx{range list}
116 (see Section \refersec{chap:noncontiguousaddressranges}).
117
118 \item A \DWATname{} attribute 
119 \addtoindexx{name attribute}
120 whose value is a null\dash terminated
121 string 
122 \hypertarget{chap:DWATnamepathnameofcompilationsource}{}
123 containing the full or relative path name of the primary
124 source file from which the compilation unit was derived.
125
126 \item A \DWATlanguage{} attribute 
127 \addtoindexx{language attribute}
128 whose constant value is an
129 \hypertarget{chap:DWATlanguageprogramminglanguage}{}
130 integer code 
131 \addtoindexx{language attribute}
132 indicating the source language of the compilation
133 unit. The set of language names and their meanings are given
134 in Table \refersec{tab:languagenames}.
135
136 \begin{table}[t]
137 \centering
138 \caption{Language names}
139 \label{tab:languagenames}
140 \begin{tabular}{l|l}
141 \hline
142 Language name & Meaning\\ \hline
143 \addtoindexx{ISO-defined language names}
144 \DWLANGAdaeightythreeTARG{} \dag & ISO Ada:1983 \addtoindexx{Ada:1983 (ISO)} \\
145 \DWLANGAdaninetyfiveTARG{}  \dag & ISO Ada:1995 \addtoindexx{Ada:1995 (ISO)} \\
146 \DWLANGCTARG & Non-standardized C, such as K\&R \addtoindexx{C!non-standard}\\
147 \DWLANGCeightynineTARG & ISO C:1989 \addtoindexx{C:1989 (ISO)} \\
148 \DWLANGCninetynineTARG & ISO C:1999 \addtoindexx{C:1999 (ISO)} \\
149 \DWLANGCelevenTARG     & ISO C:2011 \addtoindexx{C:2011 (ISO)} \\
150 \DWLANGCplusplusTARG          & ISO C++:1998 \addtoindexx{C++:1998 (ISO)} \\
151 \DWLANGCpluspluszerothreeTARG & ISO C++:2003 \addtoindexx{C++:2003 (ISO)} \\
152 \DWLANGCpluspluselevenTARG    & ISO C++:2011 \addtoindexx{C++:2011 (ISO)} \\
153 \DWLANGCobolseventyfourTARG & ISO COBOL:1974 \addtoindexx{COBOL:1974 (ISO)} \\
154 \DWLANGCoboleightyfiveTARG  & ISO COBOL:1985 \addtoindexx{COBOL:1985 (ISO)} \\
155 \DWLANGDTARG{} \dag & D \addtoindexx{D language} \\
156 \DWLANGFortranseventysevenTARG & ISO FORTRAN:1977 \addtoindexx{FORTRAN:1977 (ISO)} \\
157 \DWLANGFortranninetyTARG       & ISO Fortran:1990 \addtoindexx{Fortran:1990 (ISO)} \\
158 \DWLANGFortranninetyfiveTARG   & ISO Fortran:1995 \addtoindexx{Fortran:1995 (ISO)} \\
159 \DWLANGGoTARG{} \dag & \addtoindex{Go} \\
160 \DWLANGHaskellTARG{} \dag & \addtoindex{Haskell} \\
161 \DWLANGJavaTARG{} & \addtoindex{Java}\\
162 \DWLANGModulatwoTARG   & ISO Modula\dash 2:1996 \addtoindexx{Modula-2:1996 (ISO)} \\
163 \DWLANGModulathreeTARG & \addtoindex{Modula-3} \\
164 \DWLANGObjCTARG{}         & \addtoindex{Objective C} \\
165 \DWLANGObjCplusplusTARG{} & \addtoindex{Objective C++} \\
166 \DWLANGOCamlTARG{} \dag  & \addtoindex{OCaml}\index{Objective Caml|see{OCaml}} \\
167 \DWLANGOpenCLTARG{} \dag & \addtoindex{OpenCL} \\
168 \DWLANGPascaleightythreeTARG & ISO Pascal:1983 \addtoindexx{Pascal:1983 (ISO)} \\
169 \DWLANGPLITARG{} \dag & ANSI PL/I:1976 \addtoindexx{PL/I:1976 (ANSI)} \\
170 \DWLANGPythonTARG{} \dag & \addtoindex{Python} \\
171 \DWLANGRustTARG{} \dag & \addtoindex{Rust} \\
172 \DWLANGUPCTARG{} & UPC (Unified Parallel C) \addtoindexx{UPC}  
173                          \index{Unified Parallel C|see{UPC}} \\ 
174 \hline
175 \dag \ \ \textit{Support for these languages is limited.}& \\
176 \end{tabular}
177 \end{table}
178
179 \item A \DWATstmtlist{}
180 attribute whose value is 
181 \addtoindexx{statement list attribute}
182
183 \addtoindexx{section offset!in statement list attribute}
184 section
185 \hypertarget{chap:DWATstmtlistlinenumberinformationforunit}{}
186 offset to the line number information for this compilation
187 unit.
188
189 This information is placed in a separate object file
190 section from the debugging information entries themselves. The
191 value of the statement list attribute is the offset in the
192 \dotdebugline{} section of the first byte of the line number
193 information for this compilation unit 
194 (see Section \refersec{chap:linenumberinformation}).
195
196 \clearpage
197
198 \needlines{6}
199 \item A \DWATmacros{} attribute 
200 \addtoindexx{macro information attribute}
201 whose value is a 
202 \addtoindexx{section offset!in macro information attribute}
203 section
204 \hypertarget{chap:DWATmacrosmacroinformation}{}
205 offset to the macro information for this compilation unit.
206
207 This information is placed in a separate object file section
208 from the debugging information entries themselves. The
209 value of the macro information attribute is the offset in
210 the \dotdebugmacro{} section of the first byte of the macro
211 information for this compilation unit 
212 (see Section \refersec{chap:macroinformation}).
213
214 \textit{The \DWATmacros{} attribute is new in \DWARFVersionV, 
215 and supersedes the 
216 \DWATmacroinfo{} attribute of earlier DWARF versions.
217 \livetarg{chap:DWATmacroinfomacroinformation}{}
218 While \DWATmacros{} and \DWATmacroinfo{} attributes cannot both occur in the same
219 compilation unit, both may be found in the set of units that make up an executable
220 or shared object. The two attributes have distinct encodings to facilitate such
221 coexistence.}
222
223 \needlines{6}
224 \item  A 
225 \DWATcompdir{} 
226 attribute 
227 \hypertarget{chap:DWATcompdircompilationdirectory}{}
228 whose value is a
229 null\dash terminated string containing the current working directory
230 of the compilation command that produced this compilation
231 unit in whatever form makes sense for the host system.
232
233 \item  A \DWATproducer{} attribute 
234 \addtoindexx{producer attribute}
235 whose value is a null\dash
236 terminated string containing information about the compiler
237 \hypertarget{chap:DWATproducercompileridentification}{}
238 that produced the compilation unit. The actual contents of
239 the string will be specific to each producer, but should
240 begin with the name of the compiler vendor or some other
241 identifying character sequence that should avoid confusion
242 with other producer values.
243
244 \needlines{4}
245 \item  A \DWATidentifiercase{} 
246 attribute 
247 \addtoindexx{identifier case attribute}
248 whose integer
249 \hypertarget{chap:DWATidentifiercaseidentifiercaserule}{}
250 constant value is a code describing the treatment
251 of identifiers within this compilation unit. The
252 set of identifier case codes is given in
253 Table \refersec{tab:identifiercasecodes}.
254
255 \begin{simplenametable}{Identifier case codes}{tab:identifiercasecodes}
256 \DWIDcasesensitive{}      \\
257 \DWIDupcase{}             \\
258 \DWIDdowncase{}           \\
259 \DWIDcaseinsensitive{}    \\
260 \end{simplenametable}
261
262 \DWIDcasesensitiveTARG{} is the default for all compilation units
263 that do not have this attribute.  It indicates that names given
264 as the values of \DWATname{} attributes 
265 \addtoindexx{name attribute}
266 in debugging information
267 entries for the compilation unit reflect the names as they
268 appear in the source program. The debugger should be sensitive
269 to the case of identifier names when doing identifier lookups.
270
271 \needlines{4}
272 \DWIDupcaseTARG{} means that the 
273 producer of the debugging
274 information for this compilation unit converted all source
275 names to upper case. The values of the name attributes may not
276 reflect the names as they appear in the source program. The
277 debugger should convert all names to upper case when doing
278 lookups.
279
280 \DWIDdowncaseTARG{} means that 
281 the producer of the debugging
282 information for this compilation unit converted all source
283 names to lower case. The values of the name attributes may not
284 reflect the names as they appear in the source program. The
285 debugger should convert all names to lower case when doing
286 lookups.
287
288 \needlines{4}
289 \DWIDcaseinsensitiveTARG{} means that the values of the name
290 attributes reflect the names as they appear in the source
291 program but that a case insensitive lookup should be used to
292 access those names.
293
294 \needlines{5}
295 \item A \DWATbasetypes{} attribute whose value is a 
296 \livelink{chap:classreference}{reference}.
297
298 This 
299 \hypertarget{chap:DWATbasetypesprimitivedatatypesofcompilationunit}{}
300 attribute 
301 \addtoindexx{base types attribute}
302 points to a debugging information entry
303 representing another compilation unit.  It may be used
304 to specify the compilation unit containing the base type
305 entries used by entries in the current compilation unit
306 (see Section \refersec{chap:basetypeentries}).
307
308 \needlines{6}
309 This attribute provides a consumer a way to find the definition
310 of base types for a compilation unit that does not itself
311 contain such definitions. This allows a consumer, for example,
312 to interpret a type conversion to a base type 
313 % getting this link target at the right spot is tricky.
314 \hypertarget{chap:DWATuseUTF8compilationunitusesutf8strings}{}
315 correctly.
316
317 \item A \DWATuseUTFeight{} attribute,
318 \addtoindexx{use UTF8 attribute}\addtoindexx{UTF-8} 
319 which is a \livelink{chap:classflag}{flag} whose
320 presence indicates that all strings (such as the names of
321 declared entities in the source program, or file names in the line table) 
322 are represented using the UTF\dash 8 representation. 
323
324 \item A \DWATmainsubprogram{} attribute, which is a \livelink{chap:classflag}{flag}
325 \addtoindexx{main subprogram attribute}
326 whose presence indicates 
327 \hypertarget{chap:DWATmainsubprogramunitcontainingmainorstartingsubprogram}{}
328 that the compilation unit contains a
329 subprogram that has been identified as the starting function
330 of the program. If more than one compilation unit contains
331 this \nolink{flag}, any one of them may contain the starting function.
332
333 \textit{\addtoindex{Fortran} has a \addtoindex{PROGRAM statement}
334 which is used
335 to specify and provide a user\dash specified name for the main
336 subroutine of a program. 
337 \addtoindex{C} uses the name \doublequote{main} to identify
338 the main subprogram of a program. Some other languages provide
339 similar or other means to identify the main subprogram of
340 a program.}
341
342 \item A \DWATentrypc{} attribute whose value is the address of the first
343 \hypertarget{chap:DWATentrypcofcompileunit}{}
344 \hypertarget{chap:DWATentrypcofpartialunit}{}
345 \addtoindexx{entry pc attribute!for normal compilation unit}
346 \addtoindexx{entry pc attribute!for partial compilation unit}
347 executable instruction of the unit (see 
348 Section \refersec{chap:entryaddress}).
349
350 \item A \DWATstroffsetsbaseNAME\addtoindexx{string offset base attribute}
351 \hypertarget{chap:DWATstroffsetbaseforindirectstringtable}{} 
352 attribute, whose value is a reference. 
353 This attribute points to the first string
354 offset of the compilation unit's contribution to the
355 \dotdebugstroffsets{} (or \dotdebugstroffsetsdwo{}) section. 
356 Indirect string references
357 (using \DWFORMstrx) within the compilation unit are
358 interpreted as indices relative to this base.
359
360 \needlines{6}
361 \item A \DWATaddrbaseNAME\addtoindexx{address table base attribute}
362 \hypertarget{chap:DWATaddrbaseforaddresstable}{}
363 attribute, whose value is a reference.
364 This attribute points to the beginning of the compilation
365 unit's contribution to the \dotdebugaddr{} section.
366 Indirect references (using \DWFORMaddrx, \DWOPaddrx, 
367 \DWOPconstx, \DWLLEbaseaddressselectionentry{}, 
368 \DWLLEstartendentry, or \DWLLEstartlengthentry) within the compilation unit are
369 interpreted as indices relative to this base.
370
371 \needlines{5}
372 \item A \DWATrangesbaseNAME\addtoindexx{ranges table base attribute}
373 \hypertarget{chap:DWATrangesbaseforrangelists}{}
374 attribute, whose value is a reference.
375 This attribute points to the beginning of the compilation
376 unit's contribution to the \dotdebugranges{} section.
377 References to range lists (using \DWFORMsecoffset)
378 within the compilation unit are
379 interpreted as offsets relative to this base.
380
381
382 \end{enumerate}
383
384 The  base address of a compilation unit is defined as the
385 value of the \DWATlowpc{} attribute, if present; otherwise,
386 it is undefined. If the base address is undefined, then any
387 DWARF entry or structure defined in terms of the base address
388 of that compilation unit is not valid.
389
390 \subsection{Skeleton Compilation Unit Entries}
391 \label{chap:skeletoncompilationunitentries}
392 When generating a split DWARF object (see 
393 Section \refersec{datarep:splitdwarfobjects}), the
394 compilation unit in the \dotdebuginfo{} section is a "skeleton"
395 compilation unit, which contains only a subset of the
396 attributes of the full compilation unit. In general, it
397 contains those attributes that are necessary for the consumer
398 to locate the DWARF object where the full compilation unit
399 can be found, and for the consumer to interpret references to
400 addresses in the program. 
401
402 A skeleton compilation unit has no
403 children, and may have the following attributes:
404 \begin{enumerate}[1. ]
405
406 \item
407 Either a \DWATlowpc{} and \DWAThighpc{} pair of attributes
408 or a \DWATranges{} attribute (the same as for regular
409 compilation unit entries).
410
411 \item
412 A \DWATstmtlist{} attribute (the same as for regular
413 compilation unit entries).
414
415 \item
416 A \DWATcompdir{} attribute (the same as for regular
417 compilation unit entries).
418
419 \item
420 \livetarg{chap:DWATdwonameforunit}{}
421 A \DWATdwonameNAME{} attribute whose value is a
422 null-terminated string containing the full or relative
423 path name of the DWARF object file that contains the full
424 compilation unit.
425
426 \item
427 \livetarg{chap:DWATdwoidforunit}{}
428 A \DWATdwoidNAME{} attribute whose value is an 8-byte
429 unsigned hash of the full compilation unit.  This hash
430 value is computed by the method described in 
431 Section \refersec{datarep:typesignaturecomputation}.
432
433 \needlines{6}
434 \item
435 A \DWATuseUTFeight{} attribute (the same as for regular compilation unit
436 entries).
437
438 \textit{This attribute applies to strings referred to by the skeleton
439 compilation unit entry itself, and strings in the associated line
440 number information.
441 The representation for strings in the DWARF object file is determined
442 by the presence of a \DWATuseUTFeight{} attribute in the full compilation
443 unit.}
444
445 \item
446 A \DWATstroffsetsbase{} attribute, for indirect strings references 
447 from the skeleton compilation unit (the same as for regular 
448 compilation unit entries).
449
450 \item
451 A \DWATaddrbase{} attribute (the same as for regular
452 compilation unit entries).
453
454 \item
455 A \DWATrangesbase{} attribute (the same as for regular
456 compilation unit entries).
457
458 \end{enumerate}
459
460 All other attributes of a compilation unit entry (described
461 in Section \refersec{chap:normalandpartialcompilationunitentries}) 
462 should be placed in the full compilation
463 unit entry in the \dotdebuginfodwo{} section of the split DWARF
464 object. The attributes provided by the skeleton compilation
465 unit entry do not need to be repeated in the full compilation
466 unit entry, except for \DWATdwoid, which should appear in
467 both entries so that the consumer can verify that it has
468 found the correct DWARF object.
469
470
471 \subsection{Imported Unit Entries}
472 \label{chap:importedunitentries}
473 The 
474 \hypertarget{chap:DWATimportimportedunit}{}
475 place where a normal or partial unit is imported is
476 represented by a debugging information entry with the 
477 \addtoindexx{imported unit entry}
478 tag \DWTAGimportedunitTARG. 
479 An imported unit entry contains 
480 \addtoindexx{import attribute}
481 a
482 \DWATimport{} attribute 
483 whose value is a \livelink{chap:classreference}{reference} to the
484 normal or partial compilation unit whose declarations logically
485 belong at the place of the imported unit entry.
486
487 \textit{An imported unit entry does not necessarily correspond to
488 any entity or construct in the source program. It is merely
489 \doublequote{glue} used to relate a partial unit, or a compilation
490 unit used as a partial unit, to a place in some other
491 compilation unit.}
492
493 \needlines{6}
494 \subsection{Separate Type Unit Entries}
495 \label{chap:separatetypeunitentries}
496 An object file may contain any number of separate type
497 unit entries, each representing a single complete type
498 definition. 
499 Each \addtoindex{type unit} must be uniquely identified by
500 a 64\dash bit signature, stored as part of the type unit, which
501 can be used to reference the type definition from debugging
502 information entries in other compilation units and type units.
503
504 A type unit is represented by a debugging information entry
505 with the tag \DWTAGtypeunitTARG. 
506 A \addtoindex{type unit entry} owns debugging
507 information entries that represent the definition of a single
508 type, plus additional debugging information entries that may
509 be necessary to include as part of the definition of the type.
510
511 A type unit entry may have a 
512 \DWATlanguage{} attribute, 
513 whose
514 \addtoindexx{language attribute}
515 constant value is an integer code indicating the source
516 language used to define the type. The set of language names
517 and their meanings are given in Table \refersec{tab:languagenames}.
518
519 A type unit entry may have a 
520 \DWATstroffsetsbase\addtoindexx{string base offset attribute}
521 attribute, whose value is a reference. This attribute points
522 to the first string offset of the type unit's contribution to
523 the \dotdebugstroffsets{} section. Indirect string references
524 (using \DWFORMstrx) within the type unit must be interpreted
525 as indices relative to this base.
526
527 A type unit entry may have a \DWATstmtlist{} attribute, whose
528 value is a section offset to a line number table for this
529 type unit. Because type units do not describe any code, they
530 do not actually need a line number table, but the line number
531 tables also contain a list of directories and file names that
532 may be referenced by the \DWATdeclfile{} attribute. In a
533 normal object file with a regular compilation unit entry, the
534 type unit entries can simply refer to the line number table
535 used by the compilation unit. In a split DWARF object, where
536 the type units are located in a separate DWARF object file,
537 the \DWATstmtlist{} attribute refers to a "skeleton"
538 line number table in the \dotdebuglinedwo{} section, which
539 contains only the list of directories and file names. All
540 type unit entries in a split DWARF object may (but are not
541 required to) refer to the same skeleton line number table.
542
543 A type unit entry may have a \DWATuseUTFeight{} attribute, which is a flag
544 whose presence indicates that all strings referred to by this type
545 unit entry, its children, and the skeleton line number table, are
546 represented using the UTF-8 representation.
547
548 A \addtoindex{type unit} entry for a given type T owns a debugging
549 information entry that represents a defining declaration
550 of type T. If the type is nested within enclosing types or
551 namespaces, the debugging information entry for T is nested
552 within debugging information entries describing its containers;
553 otherwise, T is a direct child of the type unit entry.
554
555 A type unit entry may also own additional debugging information
556 entries that represent declarations of additional types that
557 are referenced by type T and have not themselves been placed in
558 separate type units. Like T, if an additional type U is nested
559 within enclosing types or namespaces, the debugging information
560 entry for U is nested within entries describing its containers;
561 otherwise, U is a direct child of the type unit entry.
562
563 The containing entries for types T and U are declarations,
564 and the outermost containing entry for any given type T or
565 U is a direct child of the type unit entry. The containing
566 entries may be shared among the additional types and between
567 T and the additional types.
568
569 \textit{Types are not required to be placed in type units. In general,
570 only large types such as structure, class, enumeration, and
571 union types included from header files should be considered
572 for separate type units. Base types and other small types
573 are not usually worth the overhead of placement in separate
574 type units. Types that are unlikely to be replicated, such
575 as those defined in the main source file, are also better
576 left in the main compilation unit.}
577
578 \section{Module, Namespace and Importing Entries}
579 \textit{Modules and namespaces provide a means to collect related
580 entities into a single entity and to manage the names of
581 those entities.}
582
583 \subsection{Module Entries}
584 \label{chap:moduleentries}
585 \textit{Several languages have the concept of a \doublequote{module.}
586 \addtoindexx{Modula-2}
587 A Modula\dash 2 definition module 
588 \addtoindexx{Modula-2!definition module}
589 may be represented by a module
590 entry containing a 
591 \addtoindex{declaration attribute}
592 (\DWATdeclaration). A
593 \addtoindex{Fortran 90} module 
594 \addtoindexx{Fortran!module (Fortran 90)}
595 may also be represented by a module entry
596 (but no declaration attribute is warranted because \addtoindex{Fortran}
597 has no concept of a corresponding module body).}
598
599 A module is represented by a debugging information entry
600 with the 
601 tag \DWTAGmoduleTARG.  
602 Module entries may own other
603 debugging information entries describing program entities
604 whose declaration scopes end at the end of the module itself.
605
606 If the module has a name, the module entry has a 
607 \DWATname{} attribute 
608 \addtoindexx{name attribute}
609 whose value is a null\dash terminated string containing
610 the module name as it appears in the source program.
611
612 The \addtoindex{module entry} may have either a 
613 \DWATlowpc{} and
614 \DWAThighpc{} 
615 pair 
616 \addtoindexx{high PC attribute}
617 of 
618 \addtoindexx{low PC attribute}
619 attributes or a 
620 \DWATranges{} attribute
621 \addtoindexx{ranges attribute}
622 whose values encode the contiguous or non\dash contiguous address
623 ranges, respectively, of the machine instructions generated for
624 the module initialization code 
625 (see Section \refersec{chap:codeaddressesandranges}). 
626 \hypertarget{chap:DWATentrypcentryaddressofmoduleinitialization}{}
627 It may also
628 \addtoindexx{entry pc attribute!for module initialization}
629 have a 
630 \DWATentrypc{} attribute whose value is the address of
631 the first executable instruction of that initialization code
632 (see Section \refersec{chap:entryaddress}).
633
634 If 
635 \hypertarget{chap:DWATprioritymodulepriority}{}
636 the module has been assigned a priority, it may have 
637 \addtoindexx{priority attribute}
638 a
639 \DWATpriority{} attribute. 
640 The value of this attribute is a
641 reference to another debugging information entry describing
642 a variable with a constant value. The value of this variable
643 is the actual constant value of the module\textquoteright s priority,
644 represented as it would be on the target architecture.
645
646 \subsection{Namespace Entries}
647 \label{chap:namespaceentries}
648 \textit{\addtoindex{C++} has the notion of a namespace, which provides a way to
649 \addtoindexx{namespace (C++)}
650 implement name hiding, so that names of unrelated things
651 do not accidentally clash in the 
652 \addtoindex{global namespace} when an
653 application is linked together.}
654
655 A namespace is represented by a debugging information entry
656 with the 
657 tag \DWTAGnamespaceTARG. 
658 A namespace extension is
659 \hypertarget{chap:DWATextensionpreviousnamespaceextensionororiginalnamespace}{}
660 represented by a 
661 \DWTAGnamespace{} entry 
662 with 
663 \addtoindexx{extension attribute}
664
665 \DWATextension{}
666 attribute referring to the previous extension, or if there
667 is no previous extension, to the original 
668 \DWTAGnamespace{}
669 entry. A namespace extension entry does not need to duplicate
670 information in a previous extension entry of the namespace
671 nor need it duplicate information in the original namespace
672 entry. (Thus, for a namespace with a name, 
673 a \DWATname{} attribute 
674 \addtoindexx{name attribute}
675 need only be attached directly to the original
676 \DWTAGnamespace{} entry.)
677
678 \needlines{4}
679 Namespace and namespace extension entries may own 
680 \addtoindexx{namespace extension entry}
681 other
682 \addtoindexx{namespace declaration entry}
683 debugging information entries describing program entities
684 whose declarations occur in the namespace.
685
686 \textit{For \addtoindex{C++}, such 
687 owned program entities may be declarations,
688 including certain declarations that are also object or
689 function definitions.}
690
691 If a type, variable, or function declared in a namespace is
692 defined outside of the body of the namespace declaration,
693 that type, variable, or function definition entry has a
694 \DWATspecification{} attribute 
695 \addtoindexx{specification attribute}
696 whose value is a \livelink{chap:classreference}{reference} to the
697 debugging information entry representing the declaration of
698 the type, variable or function. Type, variable, or function
699 entries with a 
700 \DWATspecification{} attribute 
701 \addtoindexx{specification attribute}
702 do not need
703 to duplicate information provided by the declaration entry
704 referenced by the specification attribute.
705
706 \textit{The \addtoindex{C++} \addtoindex{global namespace}
707 (the 
708 \addtoindexx{global namespace|see{namespace (C++), global}}
709 namespace 
710 \addtoindexx{namespace (C++)!global}
711 referred to by
712 \texttt{::f}, for example) is not explicitly represented in
713 DWARF with a namespace entry (thus mirroring the situation
714 in \addtoindex{C++} source).  
715 Global items may be simply declared with no
716 reference to a namespace.}
717
718 \textit{The \addtoindex{C++} 
719 compilation unit specific \doublequote{unnamed namespace} may
720 \addtoindexx{namespace (C++)!unnamed}
721 \addtoindexx{unnamed namespace|see {namespace (C++), unnamed}}
722 be represented by a namespace entry with no name attribute in
723 the original namespace declaration entry (and therefore no name
724 attribute in any namespace extension entry of this namespace).
725 }
726
727 \textit{A compiler emitting namespace information may choose to
728 explicitly represent namespace extensions, or to represent the
729 final namespace declaration of a compilation unit; this is a
730 quality\dash of\dash implementation issue and no specific requirements
731 are given here. If only the final namespace is represented,
732 \addtoindexx{namespace (C++)!using declaration}
733 it is impossible for a debugger to interpret using declaration
734 references in exactly the manner defined by the 
735 \addtoindex{C++} language.
736 }
737
738 \textit{Emitting all namespace declaration information in all
739 compilation units can result in a significant increase in the
740 size of the debug information and significant duplication of
741 information across compilation units. 
742 The \addtoindex{C++} namespace std,
743 for example, 
744 \addtoindexx{namespace (C++)!std}
745 is large and will probably be referenced in
746 every \addtoindex{C++} compilation unit.
747 }
748
749 \textit{For a \addtoindex{C++} namespace example, 
750 see Appendix \refersec{app:namespaceexample}.
751 }
752
753
754
755 \subsection{Imported (or Renamed) Declaration Entries} 
756 \label{chap:importedorrenameddeclarationentries}
757 \textit{Some languages support the concept of importing into or making
758 accessible in a given unit declarations made in a different
759 module or scope. An imported declaration may sometimes be
760 given another name.
761 }
762
763 An 
764 imported declaration is represented by one or
765 \addtoindexx{imported declaration entry}
766 more debugging information entries with the 
767 tag \DWTAGimporteddeclarationTARG. 
768 When 
769 \hypertarget{chap:DWATimportimporteddeclaration}{}
770 an overloaded entity
771 is imported, there is one imported declaration entry for
772 each overloading. 
773 \addtoindexx{import attribute}
774 Each imported declaration entry has a
775 \DWATimport{} attribute,
776 whose value is a \livelink{chap:classreference}{reference} to the
777 debugging information entry representing the declaration that
778 is being imported.
779
780 An imported declaration may also have a 
781 \DWATname{}
782 attribute
783 \addtoindexx{name attribute}
784 whose value is a null\dash terminated string containing the
785 name, as it appears in the source program, by which the
786 imported entity is to be known in the context of the imported
787 declaration entry (which may be different than the name of
788 the entity being imported). If no name is present, then the
789 name by which the entity is to be known is the same as the
790 name of the entity being imported.
791
792 An imported declaration entry with a name attribute may be
793 used as a general means to rename or provide an alias for
794 \addtoindexx{alias declaration|see{imported declaration entry}}
795 an entity, regardless of the context in which the importing
796 declaration or the imported entity occurs.
797
798 \textit{A \addtoindex{C++} namespace alias may be represented by an imported
799 \hypertarget{chap:DWATimportnamespacealias}{}
800 declaration entry 
801 \addtoindexx{namespace (C++)!alias}
802 with a name attribute whose value is
803 a null\dash terminated string containing the alias name as it
804 appears in the source program and an import attribute whose
805 value is a \livelink{chap:classreference}{reference} to the applicable original namespace or
806 namespace extension entry.
807 }
808
809 \textit{A \addtoindex{C++} using declaration may be represented by one or more
810 \hypertarget{chap:DWATimportnamespaceusingdeclaration}{}
811 imported 
812 \addtoindexx{namespace (C++)!using declaration}
813 declaration entries.  When the using declaration
814 refers to an overloaded function, there is one imported
815 declaration entry corresponding to each overloading. Each
816 imported declaration entry has no name attribute but it does
817 have an import attribute that refers to the entry for the
818 entity being imported. (\addtoindex{C++} 
819 provides no means to \doublequote{rename}
820 an imported entity, other than a namespace).
821 }
822
823 \textit{A \addtoindex{Fortran} use statement 
824 \addtoindexx{Fortran!use statement}
825 \addtoindexx{use statement|see {Fortran, use statement}}
826 with an \doublequote{only list} may be
827 represented by a series of imported declaration entries,
828 one (or more) for each entity that is imported. An entity
829 \addtoindexx{renamed declaration|see{imported declaration entry}}
830 that is renamed in the importing context may be represented
831 by an imported declaration entry with a name attribute that
832 specifies the new local name.
833 }
834
835 \subsection{Imported Module Entries}
836 \label{chap:importedmoduleentries}
837
838 \textit{Some languages support the concept of importing into or making
839 accessible in a given unit all of the declarations contained
840 within a separate module or namespace.
841 }
842
843 An imported module declaration is represented by a debugging
844 information entry with 
845 \addtoindexx{imported module attribute}
846 the 
847 \addtoindexx{imported module entry}
848 tag \DWTAGimportedmoduleTARG.
849 An
850 imported module entry contains a 
851 \DWATimport{} attribute
852 \addtoindexx{import attribute}
853 whose value is a \livelink{chap:classreference}{reference} 
854 to the module or namespace entry
855 containing the definition and/or declaration entries for
856 the entities that are to be imported into the context of the
857 imported module entry.
858
859 An imported module declaration may own a set of imported
860 declaration entries, each of which refers to an entry in the
861 module whose corresponding entity is to be known in the context
862 of the imported module declaration by a name other than its
863 name in that module. Any entity in the module that is not
864 renamed in this way is known in the context of the imported
865 module entry by the same name as it is declared in the module.
866
867 \textit{A \addtoindex{C++} using directive
868 \addtoindexx{namespace (C++)!using directive}
869 \addtoindexx{using directive|see {namespace (C++), using directive}} 
870 may be represented by an imported module
871 \hypertarget{chap:DWATimportnamespaceusingdirective}{}
872 entry, with an import attribute referring to the namespace
873 entry of the appropriate extension of the namespace (which
874 might be the original namespace entry) and no owned entries.
875 }
876
877 \textit{A \addtoindex{Fortran} use statement 
878 \addtoindexx{Fortran!use statement}
879 with a \doublequote{rename list} may be
880 represented by an imported module entry with an import
881 attribute referring to the module and owned entries
882 corresponding to those entities that are renamed as part of
883 being imported.
884 }
885
886 \textit{A \addtoindex{Fortran} use statement
887 \addtoindexx{Fortran!use statement}
888 with neither a \doublequote{rename list} nor
889 an \doublequote{only list} may be represented by an imported module
890 entry with an import attribute referring to the module and
891 no owned child entries.
892 }
893
894 \textit{A use statement with an \doublequote{only list} is represented by a
895 series of individual imported declaration entries as described
896 in Section \refersec{chap:importedorrenameddeclarationentries}.
897 }
898
899 \textit{A \addtoindex{Fortran} use statement for an entity in a module that is
900 \addtoindexx{Fortran!use statement}
901 itself imported by a use statement without an explicit mention
902 may be represented by an imported declaration entry that refers
903 to the original debugging information entry. For example, given
904 }
905
906 \begin{lstlisting}
907 module A
908 integer X, Y, Z
909 end module
910
911 module B
912 use A
913 end module
914
915 module C
916 use B, only Q => X
917 end module
918 \end{lstlisting}
919
920 \textit{the imported declaration entry for Q within module C refers
921 directly to the variable declaration entry for X in module A
922 because there is no explicit representation for X in module B.
923 }
924
925 \textit{A similar situation arises for a \addtoindex{C++} using declaration
926 \addtoindexx{namespace (C++)!using declaration}
927 \addtoindexx{using declaration|see {namespace (C++), using declaration}}
928 that imports an entity in terms of a namespace alias. See 
929 Appendix  \refersec{app:namespaceexample}
930 for an example.
931 }
932
933 \section{Subroutine and Entry Point Entries}
934 \label{chap:subroutineandentrypointentries}
935
936 The following tags exist to describe 
937 debugging information entries 
938 \addtoindexx{function entry|see{subroutine entry}}
939 for 
940 \addtoindexx{subroutine entry}
941 subroutines 
942 \addtoindexx{subprogram entry}
943 and entry
944 % FIXME: is entry point entry the right index 'entry'?
945 \addtoindexx{entry point entry}
946 points:
947
948 \begin{tabular}{lp{9.0cm}}
949 \DWTAGsubprogramTARG{} & A subroutine or function \\
950 \DWTAGinlinedsubroutine{} & A particular inlined 
951 \addtoindexx{inlined subprogram entry}
952 instance of a subroutine or function \\
953 \DWTAGentrypointTARG{} & An alternate entry point \\
954 \end{tabular}
955
956
957 \needlines{6}
958 \subsection{General Subroutine and Entry Point Information}
959 \label{chap:generalsubroutineandentrypointinformation}
960 The subroutine or entry point entry has a \DWATname{} 
961 attribute whose value is a null-terminated string containing the 
962 subroutine or entry point name as it appears in the source program.
963 It may also have a \DWATlinkagename{} attribute as
964 described in Section \refersec{chap:linkagenames}.
965
966 If the name of the subroutine described by an entry with the
967 \addtoindexx{subprogram entry}
968 tag \DWTAGsubprogram{}
969 is visible outside of its containing
970 \hypertarget{chap:DWATexternalexternalsubroutine}{}
971 compilation unit, that entry has 
972 \addtoindexx{external attribute}
973
974 \DWATexternalNAME{} attribute,
975 which is a \livelink{chap:classflag}{flag}.
976
977 \textit{Additional attributes for functions that are members of a
978 class or structure are described in 
979 Section \refersec{chap:memberfunctionentries}.
980 }
981
982
983 \hypertarget{chap:DWATmainsubprogrammainorstartingsubprogram}{}
984 subroutine entry 
985 may contain a 
986 \DWATmainsubprogramNAME{}
987 attribute 
988 \addtoindexx{main subprogram attribute}
989 which is 
990 a \CLASSflag whose presence indicates that the
991 subroutine has been identified as the starting function of
992 the program.  If more than one subprogram contains this 
993 \nolink{flag},
994 any one of them may be the starting subroutine of the program.
995
996 \textit{\addtoindex{Fortran} has a \addtoindex{PROGRAM statement} 
997 which is used to specify
998 and provide a user\dash supplied name for the main subroutine of
999 a program.
1000 }
1001
1002 \textit{A common debugger feature is to allow the debugger user to call
1003 a subroutine within the subject program. In certain cases,
1004 however, the generated code for a subroutine will not obey
1005 the standard calling conventions for the target architecture
1006 and will therefore not be safe to call from within a debugger.
1007 }
1008
1009 A subroutine entry may 
1010 \hypertarget{chap:DWATcallingconventionsubprogramcallingconvention}{}
1011 contain a 
1012 \DWATcallingconventionNAME{}
1013 attribute, whose value is an 
1014 \livelink{chap:classconstant}{integer constant}. The set of
1015 calling convention codes is given in 
1016 Table \refersec{tab:callingconventioncodes}.
1017
1018 \begin{simplenametable}[1.4in]{Calling convention codes}{tab:callingconventioncodes}
1019 \DWCCnormal        \\
1020 \DWCCprogram       \\
1021 \DWCCnocall        \\
1022 \end{simplenametable}
1023
1024 If this attribute is not present, or its value is the constant
1025 \DWCCnormalTARG, then the subroutine may be safely called by
1026 obeying the \doublequote{standard} calling conventions of the target
1027 architecture. If the value of the calling convention attribute
1028 is the constant \DWCCnocallTARG, the subroutine does not obey
1029 standard calling conventions, and it may not be safe for the
1030 debugger to call this subroutine.
1031
1032 If the semantics of the language of the compilation unit
1033 containing the subroutine entry distinguishes between ordinary
1034 subroutines and subroutines that can serve as the \doublequote{main
1035 program,} that is, subroutines that cannot be called
1036 directly according to the ordinary calling conventions,
1037 then the debugging information entry for such a subroutine
1038 may have a calling convention attribute whose value is the
1039 constant \DWCCprogramTARG.
1040
1041 \textit{The \DWCCprogram{} 
1042 value is intended to support \addtoindex{Fortran} main
1043 \addtoindexx{Fortran!main program}
1044 programs which in some implementations may not be callable
1045 or which must be invoked in a special way. It is not intended
1046 as a way of finding the entry address for the program.
1047 }
1048
1049 \textit{In \addtoindex{C}
1050 there is a difference between the types of functions
1051 declared using function prototype style declarations and
1052 those declared using non\dash prototype declarations.
1053 }
1054
1055 A subroutine entry declared with a function prototype style
1056 declaration may have 
1057 \addtoindexx{prototyped attribute}
1058
1059 \DWATprototypedNAME{} attribute, which is
1060 a \CLASSflag.
1061
1062 \textit{The \addtoindex{Fortran} 
1063 language allows the keywords \texttt{elemental}, \texttt{pure}
1064 and \texttt{recursive} to be included as part of the declaration of
1065 a subroutine; these attributes reflect that usage. These
1066 attributes are not relevant for languages that do not support
1067 similar keywords or syntax. In particular, the \DWATrecursiveNAME{}
1068 attribute is neither needed nor appropriate in languages such
1069 as \addtoindex{C} 
1070 where functions support recursion by default.
1071 }
1072
1073 A subprogram entry 
1074 \hypertarget{chap:DWATelementalelementalpropertyofasubroutine}{}
1075 may have 
1076 \addtoindexx{elemental attribute}
1077
1078 \DWATelementalNAME{} attribute, which
1079 is a \livelink{chap:classflag}{flag}. 
1080 The attribute indicates whether the subroutine
1081 or entry point was declared with the \doublequote{elemental} keyword
1082 or property.
1083
1084
1085 \hypertarget{chap:DWATpurepurepropertyofasubroutine}{}
1086 subprogram entry may have 
1087 \addtoindexx{pure attribute}
1088
1089 \DWATpureNAME{} attribute, which is
1090 a \livelink{chap:classflag}{flag}. 
1091 The attribute indicates whether the subroutine was
1092 declared with the \doublequote{pure} keyword or property.
1093
1094
1095 \hypertarget{chap:DWATrecursiverecursivepropertyofasubroutine}{}
1096 subprogram entry may have a 
1097 \DWATrecursiveNAME{} attribute, which
1098 is a \livelink{chap:classflag}{flag}. 
1099 The attribute indicates whether the subroutine
1100 or entry point was declared with the \doublequote{recursive} keyword
1101 or property.
1102
1103 A subprogram entry may have a 
1104 \DWATnoreturnNAME
1105 \livetargi{chap:DWATnoreturnofsubprogram}{ attribute}{noreturn attribute}, 
1106 which is a \CLASSflag. The attribute 
1107 indicates whether the subprogram was declared with the \doublequote{noreturn} keyword or property 
1108 indicating that the subprogram can be called, but will never return to its caller.
1109
1110 \subsubsection{Call Site-Related Attributes}
1111 A subroutine entry may have \DWATcallalltailcalls, \DWATcallallcalls{} 
1112 and/or \DWATcallallsourcecalls{} attributes, each of which is a 
1113 \livelink{chap:classflag}{flag}.
1114 These flags indicate the completeness of the call site information 
1115 within the subprogram.
1116
1117 The \DWATcallalltailcallsNAME{}
1118 \livetargi{chap:DWATcallalltailcallsofasubprogram}{attribute}{all tail calls summary attribute} 
1119 indicates that every tail call 
1120 that occurs in the code for the subprogram is described by a 
1121 \DWTAGcallsite{} entry. 
1122 (There may or may not be other non-tail calls to some of the same 
1123 target subprograms.)
1124
1125 The \DWATcallallcallsNAME{}
1126 \livetargi{chap:DWATcallallcallsofasubprogram}{attribute}{all calls summary attribute} 
1127 indicates that every non-inlined call
1128 (either a tail call or a normal call) that occurs in the code for the subprogram
1129 is described by a \DWTAGcallsite{} entry.
1130
1131 The \DWATcallallsourcecallsNAME{}
1132 \livetargi{chap:DWATcallallsourcecallsofasubprogram}{attribute}{all source calls summary attribute} 
1133 indicates that every call that occurs in the
1134 code for the subprogram, including every call inlined into it, is described by either a 
1135 \DWTAGcallsite{} entry or a \DWTAGinlinedsubroutine{} entry; further, any call
1136 that is optimized out is nonetheless also described using a \DWTAGcallsite{} entry 
1137 that has neither a \DWATcallpc{} nor \DWATcallreturnpc{} attribute.
1138
1139 \textit{The \DWATcallallsourcecallsNAME{} attribute is intended for debugging 
1140 information format consumers that analyse call graphs.}
1141
1142 If the value of the \DWATcallallsourcecalls{} attribute is true then the values of the
1143 \DWATcallallcalls{} and \DWATcallallcalls{} attributes are necessarily also true, and 
1144 those attributes need not be present. Similarly, if the value of the 
1145 \DWATcallallcalls{} attribute is true then the value of the \DWATcallalltailcalls{} 
1146 attribute is also true and the latter attribute need not be present.
1147
1148 \subsection{Subroutine and Entry Point Return Types}
1149 \label{chap:subroutineandentrypointreturntypes}
1150
1151 If 
1152 \hypertarget{chap:DWATtypetypeofsubroutinereturn}{}
1153 the subroutine or entry point 
1154 \addtoindexx{return type of subroutine}
1155 is a function that returns a
1156 value, then its debugging information entry has 
1157 \addtoindexx{type attribute}
1158 a \DWATtype{} attribute 
1159 to denote the type returned by that function.
1160
1161 \textit{Debugging information entries for 
1162 \addtoindex{C} void functions should
1163 not have an attribute for the return type.  }
1164
1165 \textit{Debugging information entries for declarations of \addtoindex{C++} 
1166 member functions with an 
1167 \addtoindex{\texttt{auto} return type} specifier should use an unspecified 
1168 type entry (see 
1169 Section \refersec{chap:unspecifiedtypeentries}). 
1170 The debugging information entry for the corresponding definition
1171 should provide the deduced return type.  This practice causes the description of
1172 the containing class to be consistent across compilation units, allowing the class
1173 declaration to be placed into a separate type unit if desired.}
1174
1175
1176 \subsection{Subroutine and Entry Point Locations}
1177 \label{chap:subroutineandentrypointlocations}
1178
1179 A subroutine entry may have either a \DWATlowpc{} and
1180 \DWAThighpc{} pair of attributes or a \DWATranges{} attribute
1181 \addtoindexx{ranges attribute}
1182 whose 
1183 \addtoindexx{high PC attribute}
1184 values 
1185 \addtoindexx{low PC attribute}
1186 encode the contiguous or non\dash contiguous address
1187 ranges, respectively, of the machine instructions generated
1188 for the subroutine (see 
1189 Section \refersec{chap:codeaddressesandranges}).
1190
1191
1192 \hypertarget{chap:DWATentrypcentryaddressofsubprogram}{}
1193 subroutine entry may also have 
1194 \addtoindexx{entry pc attribute!for subroutine}
1195
1196 \DWATentrypc{} attribute
1197 whose value is the address of the first executable instruction
1198 of the subroutine (see 
1199 Section \refersec{chap:entryaddress}).
1200
1201 An entry point has a \DWATlowpc{} attribute whose value is the
1202 relocated address of the first machine instruction generated
1203 for the entry point.
1204
1205 \textit{While the 
1206 \DWATentrypc{} attribute 
1207 \addtoindexx{entry pc attribute!for subroutine}
1208 might 
1209 also seem appropriate
1210 for this purpose, historically the 
1211 \DWATlowpc{} attribute
1212 was used before the 
1213 \DWATentrypc{} was introduced (in
1214 \addtoindex{DWARF Version 3}). 
1215 There is insufficient reason to change this.}
1216
1217
1218 Subroutines 
1219 and 
1220 entry
1221 \addtoindexx{address class!attribute}
1222 points 
1223 \hypertarget{chap:DWATaddressclasssubroutineorsubroutinetype}{}
1224 may also have 
1225 \DWATsegment{} 
1226 and
1227 \DWATaddressclass{} attributes,
1228 as appropriate, to specify
1229 which segments the code for the subroutine resides in and
1230 the addressing mode to be used in calling that subroutine.
1231
1232 A subroutine entry representing a subroutine declaration
1233 that is not also a definition does not have code address or
1234 range attributes.
1235
1236
1237 \subsection{Declarations Owned by Subroutines and Entry Points} 
1238 \label{chap:declarationsownedbysubroutinesandentrypoints}
1239
1240 The declarations enclosed by a subroutine or entry point are
1241 represented by debugging information entries that are owned
1242 by the subroutine or entry point entry. Entries representing
1243 \addtoindexx{formal parameter}
1244 the formal parameters of the subroutine or entry point appear
1245 in the same order as the corresponding declarations in the
1246 source program.
1247
1248 \needlines{5}
1249 \textit{There is no ordering requirement for entries for declarations
1250 that are children of subroutine or entry point entries but
1251 that do not represent formal parameters. The formal parameter
1252 entries may be interspersed with other entries used by formal
1253 parameter entries, such as type entries.}
1254
1255 The unspecified parameters of a variable parameter list are
1256 represented by a debugging information entry\addtoindexx{unspecified parameters entry}
1257 with the tag
1258 \DWTAGunspecifiedparametersTARG.
1259
1260 The entry for a subroutine that includes a
1261 \addtoindex{Fortran}
1262 \addtoindexx{Fortran!common block}
1263 \livelink{chap:fortrancommonblock}{common} 
1264 \livelink{chap:commonblockentry}{block}
1265 \addtoindexx{common block|see{Fortran common block}}
1266 has a child entry with the 
1267 tag \DWTAGcommoninclusionTARG. 
1268 The
1269 \hypertarget{chap:commonreferencecommonblockusage}{}
1270 common inclusion entry has a 
1271 \DWATcommonreference{} attribute
1272 whose value is a \livelink{chap:classreference}{reference} 
1273 to the debugging information entry
1274 for the common \nolink{block} being included 
1275 (see Section \refersec{chap:commonblockentries}).
1276
1277 \subsection{Low-Level Information}
1278 \label{chap:lowlevelinformation}
1279
1280
1281 \hypertarget{chap:DWATreturnaddrsubroutinereturnaddresssavelocation}{}
1282 subroutine or entry point entry may have 
1283 \addtoindexx{return address attribute}
1284
1285 \DWATreturnaddr{}
1286 attribute, whose value is a location description. The location
1287 calculated is the place where the return address for the
1288 subroutine or entry point is stored.
1289
1290
1291 \hypertarget{chap:DWATframebasesubroutineframebaseaddress}{}
1292 subroutine or entry point entry may also have 
1293 \addtoindexx{frame base attribute}
1294 a
1295 \DWATframebase{} attribute, whose value is a location
1296 description that computes the \doublequote{frame base} for the
1297 subroutine or entry point. If the location description is
1298 a simple register location description, the given register
1299 contains the frame base address. If the location description is
1300 a DWARF expression, the result of evaluating that expression
1301 is the frame base address. Finally, for a 
1302 \addtoindex{location list},
1303 this interpretation applies to each location description
1304 contained in the list of \addtoindex{location list} entries.
1305
1306 \textit{The use of one of the \DWOPregn{} 
1307 operations in this
1308 context is equivalent to using 
1309 \DWOPbregn(0) 
1310 but more
1311 compact. However, these are not equivalent in general.}
1312
1313 \needlines{5}
1314 \textit{The frame base for a procedure is typically an address fixed
1315 relative to the first unit of storage allocated for the
1316 procedure\textquoteright s stack frame. The \DWATframebase{} attribute
1317 can be used in several ways:}
1318 \begin{enumerate}[1. ]
1319 \item \textit{In procedures that need 
1320 \addtoindexx{location list}
1321 location lists to locate local
1322 variables, the \DWATframebase{} can hold the needed location
1323 list, while all variables\textquoteright\  location descriptions can be
1324 simpler ones involving the frame base.}
1325
1326 \item \textit{It can be used in resolving \doublequote{up\dash level} addressing
1327 within nested routines. 
1328 (See also \DWATstaticlink, below)}
1329 \end{enumerate}
1330
1331 \needlines{5}
1332 \textit{Some languages support nested subroutines. In such languages,
1333 it is possible to reference the local variables of an
1334 outer subroutine from within an inner subroutine. The
1335 \DWATstaticlink{} and \DWATframebase{} attributes allow
1336 debuggers to support this same kind of referencing.}
1337
1338 If 
1339 \hypertarget{chap:DWATstaticlinklocationofuplevelframe}{}
1340
1341 \addtoindexx{address!uplevel|see {static link attribute}}
1342 \addtoindexx{uplevel address|see {static link attribute}}
1343 subroutine or entry point is nested, it may have a
1344 \DWATstaticlink{}
1345 attribute, whose value is a location
1346 description that computes the frame base of the relevant
1347 instance of the subroutine that immediately encloses the
1348 subroutine or entry point.
1349
1350 In the context of supporting nested subroutines, the
1351 \DWATframebase{} attribute value should obey the following
1352 constraints:
1353
1354 \begin{enumerate}[1. ]
1355 \item It should compute a value that does not change during the
1356 life of the procedure, and
1357
1358 \item The computed value should be unique among instances of
1359 the same subroutine. (For typical \DWATframebase{} use, this
1360 means that a recursive subroutine\textquoteright s stack frame must have
1361 non\dash zero size.)
1362 \end{enumerate}
1363
1364 \textit{If a debugger is attempting to resolve an up\dash level reference
1365 to a variable, it uses the nesting structure of DWARF to
1366 determine which subroutine is the lexical parent and the
1367 \DWATstaticlink{} value to identify the appropriate active
1368 frame of the parent. It can then attempt to find the reference
1369 within the context of the parent.}
1370
1371
1372 \needlines{8}
1373 \subsection{Types Thrown by Exceptions}
1374 \label{chap:typesthrownbyexceptions}
1375
1376 \textit{In \addtoindex{C++} a subroutine may declare a set of types which
1377 it may validly throw.}
1378
1379 If a subroutine explicitly declares that it may throw
1380 \addtoindexx{exception thrown|see{thrown type entry}}
1381 an 
1382 \addtoindexx{thrown exception|see{thrown type entry}}
1383 exception of one or more types, each such type is
1384 represented by a debugging information entry with 
1385 \addtoindexx{thrown type entry}
1386 the tag
1387 \DWTAGthrowntypeTARG.  
1388 Each such entry is a child of the entry
1389 representing the subroutine that may throw this type. Each
1390 thrown type entry contains 
1391 \addtoindexx{type attribute}
1392 a \DWATtype{} attribute, whose
1393 value is a \livelink{chap:classreference}{reference} 
1394 to an entry describing the type of the
1395 exception that may be thrown.
1396
1397 \subsection{Function Template Instantiations}
1398 \label{chap:functiontemplateinstantiations}
1399
1400 \textit{In \addtoindex{C++}, a function template is a generic definition of
1401 a function that is instantiated differently for calls with
1402 values of different types. DWARF does not represent the generic
1403 template definition, but does represent each instantiation.}
1404
1405 \needlines{4}
1406 A \addtoindex{template instantiation} is represented by a debugging
1407 information entry with the 
1408 \addtoindexx{subprogram entry!use for template instantiation}
1409 tag \DWTAGsubprogram. 
1410 With the following
1411 exceptions, such an entry will contain the same attributes and
1412 will have the same types of child entries as would an entry
1413 for a subroutine defined explicitly using the instantiation
1414 types and values. The exceptions are:
1415
1416 \begin{enumerate}[1. ]
1417 \item Template parameters are described and referenced as specified in
1418 Section \refersec{chap:templateparameters}.
1419
1420 \item If the compiler has generated a special compilation unit
1421 to hold the template instantiation and that compilation unit
1422 has a different name from the compilation unit containing
1423 the template definition, the name attribute for the debugging
1424 information entry representing that compilation unit is empty
1425 or omitted.
1426
1427 \item If the subprogram entry representing the template
1428 instantiation or any of its child entries contain declaration
1429 coordinate attributes, those attributes refer to the source
1430 for the template definition, not to any source generated
1431 artificially by the compiler for this instantiation.
1432 \end{enumerate}
1433
1434
1435 \needlines{8}
1436 \subsection{Inlinable and Inlined Subroutines}
1437 \label{chap:inlinedsubroutines}
1438 A declaration or a definition of an inlinable subroutine
1439 is represented by a debugging information entry with the
1440 tag 
1441 \DWTAGsubprogram.
1442 The entry for a 
1443 \addtoindexx{subprogram entry!use in inlined subprogram}
1444 subroutine that is
1445 \hypertarget{chap:DWATinlineinlinedsubroutine}{}
1446 explicitly declared to be available for inline expansion or
1447 that was expanded inline implicitly by the compiler has 
1448 \addtoindexx{inline attribute}
1449 a
1450 \DWATinline{} attribute whose value is an 
1451 \livelink{chap:classconstant}{integer constant}. The
1452 set of values for the \DWATinline{} attribute is given in
1453 Table \refersec{tab:inlinecodes}.
1454
1455 \begin{table}[here]
1456 \centering
1457 \caption{Inline codes}
1458 \label{tab:inlinecodes}
1459 \begin{tabular}{l|p{8cm}}
1460 \hline
1461 Name&Meaning\\ \hline
1462 \DWINLnotinlinedTARG{} & Not declared inline nor inlined by the
1463   \mbox{compiler} (equivalent to the absence of the
1464   containing \DWATinline{} attribute) \\
1465 \DWINLinlinedTARG{} & Not declared inline but inlined by the \mbox{compiler} \\
1466 \DWINLdeclarednotinlinedTARG{} & Declared inline but 
1467   not inlined by the \mbox{compiler} \\
1468 \DWINLdeclaredinlinedTARG{} & Declared inline and inlined by the 
1469   \mbox{compiler} \\
1470 \hline
1471 \end{tabular}
1472 \end{table}
1473
1474 \textit{In \addtoindex{C++}, a function or a constructor declared with
1475 \addttindex{constexpr} is implicitly declared inline. The abstract inline
1476 instance (see below) is represented by a debugging information
1477 entry with the tag \DWTAGsubprogram. Such an entry has a
1478 \DWATinline{} attribute whose value is \DWINLinlined.}
1479
1480
1481 \subsubsection{Abstract Instances}
1482 \label{chap:abstractinstances}
1483 Any debugging information entry that is owned (either
1484 \hypertarget{chap:DWATinlineabstracttinstance}{}
1485 directly or indirectly) by a debugging information entry
1486 that contains the 
1487 \DWATinline{} attribute is referred to
1488 \addtoindexx{abstract instance!entry}
1489 as an \doublequote{abstract instance entry.} 
1490 Any subroutine entry
1491 that contains 
1492 \addtoindexx{inline attribute}
1493 a \DWATinline{} attribute whose value is other
1494 than \DWINLnotinlined{}
1495 is known as 
1496 \addtoindexx{abstract instance!root}
1497 an \doublequote{abstract instance root.} 
1498 Any set of abstract instance entries that are all
1499 children (either directly or indirectly) of some abstract
1500 instance root, together with the root itself, is known as
1501 \addtoindexx{abstract instance!tree}
1502 an \doublequote{abstract instance tree.} However, in the case where
1503 an abstract instance tree is nested within another abstract
1504 instance tree, the entries in the 
1505 \addtoindex{nested abstract instance}
1506 tree are not considered to be entries in the outer abstract
1507 instance tree.
1508
1509 Each abstract instance root is either part of a larger
1510 \addtoindexx{abstract instance!root}
1511 tree (which gives a context for the root) or 
1512 \addtoindexx{specification attribute}
1513 uses
1514 \DWATspecification{} 
1515 to refer to the declaration in context.
1516
1517 \textit{For example, in \addtoindex{C++} the context might be a namespace
1518 declaration or a class declaration.}
1519
1520 \textit{Abstract instance trees are defined so that no entry is part
1521 of more than one abstract instance tree. This simplifies the
1522 following descriptions.}
1523
1524 A debugging information entry that is a member of an abstract
1525 instance tree should not contain any attributes which describe
1526 aspects of the subroutine which vary between distinct inlined
1527 expansions or distinct out\dash of\dash line expansions. For example,
1528 \addtoindexx{entry pc attribute!and abstract instance}
1529 the \DWATlowpc,
1530 \DWAThighpc, 
1531 \DWATranges, 
1532 \DWATentrypc, 
1533 \DWATlocation,
1534 \DWATreturnaddr, 
1535 \DWATstartscope, 
1536 and 
1537 \DWATsegment{}
1538 attributes 
1539 \addtoindexx{location attribute!and abstract instance}
1540 typically 
1541 \addtoindexx{ranges attribute!and abstract instance}
1542 should 
1543 \addtoindexx{high PC attribute!and abstract instance}
1544 be 
1545 \addtoindexx{low PC attribute!and abstract instance}
1546 omitted; 
1547 \addtoindexx{segment attribute!and abstract instance}
1548 however, 
1549 \addtoindexx{return address attribute!and abstract instance}
1550 this 
1551 \addtoindexx{segment attribute!and abstract instance}
1552 list
1553 \addtoindexx{start scope attribute!and abstract instance}
1554 is not exhaustive.
1555
1556 \needlines{5}
1557 \textit{It would not make sense normally to put these attributes into
1558 abstract instance entries since such entries do not represent
1559 actual (concrete) instances and thus do not actually exist at
1560 run\dash time.  However, 
1561 see Appendix \refersec{app:inlineouteronenormalinner} 
1562 for a contrary example.}
1563
1564 The rules for the relative location of entries belonging to
1565 abstract instance trees are exactly the same as for other
1566 similar types of entries that are not abstract. Specifically,
1567 the rule that requires that an entry representing a declaration
1568 be a direct child of the entry representing the scope of the
1569 declaration applies equally to both abstract and non\dash abstract
1570 entries. Also, the ordering rules for formal parameter entries,
1571 member entries, and so on, all apply regardless of whether
1572 or not a given entry is abstract.
1573
1574 \needlines{5}
1575 \subsubsection{Concrete Inlined Instances}
1576 \label{chap:concreteinlinedinstances}
1577
1578 Each inline expansion of a subroutine is represented
1579 by a debugging information entry with the 
1580 tag \DWTAGinlinedsubroutineTARG. 
1581 Each such entry should be a direct
1582 child of the entry that represents the scope within which
1583 the inlining occurs.
1584
1585 Each inlined subroutine entry may have either a 
1586 \DWATlowpc{}
1587 and \DWAThighpc{} pair 
1588 of 
1589 \addtoindexx{high PC attribute}
1590 attributes 
1591 \addtoindexx{low PC attribute}
1592 or 
1593 \addtoindexx{ranges attribute}
1594
1595 \DWATranges{}
1596 attribute whose values encode the contiguous or non\dash contiguous
1597 address ranges, respectively, of the machine instructions
1598 generated for the inlined subroutine (see 
1599 Section \referfol{chap:codeaddressesandranges}). 
1600 An
1601 \hypertarget{chap:DWATentrypcentryaddressofinlinedsubprogram}{}
1602 inlined subroutine entry may 
1603 \addtoindexx{inlined subprogram entry!in concrete instance}
1604 also 
1605 \addtoindexx{inlined subprogram entry}
1606 contain 
1607 \addtoindexx{entry pc attribute!for inlined subprogram}
1608
1609 \DWATentrypc{}
1610 attribute, representing the first executable instruction of
1611 the inline expansion (see 
1612 Section \refersec{chap:entryaddress}).
1613
1614 % Positions of the 3 targets here is a bit arbitrary.
1615 An inlined 
1616 \hypertarget{chap:DWATcalllinelinenumberofinlinedsubroutinecall}{}
1617 subroutine 
1618 \hypertarget{chap:DWATcallcolumncolumnpositionofinlinedsubroutinecall}{}
1619 entry 
1620 \hypertarget{chap:DWATcallfilefilecontaininginlinedsubroutinecall}{}
1621 may also have \DWATcallfile,
1622 \DWATcallline{} and \DWATcallcolumn{} attributes, 
1623 each of whose
1624 value is an \livelink{chap:classconstant}{integer constant}. 
1625 These attributes represent the
1626 source file, source line number, and source column number,
1627 respectively, of the first character of the statement or
1628 expression that caused the inline expansion. The call file,
1629 call line, and call column attributes are interpreted in
1630 the same way as the declaration file, declaration line, and
1631 declaration column attributes, respectively (see 
1632 Section \refersec{chap:declarationcoordinates}).
1633
1634 \textit{The call file, call line and call column coordinates do not
1635 describe the coordinates of the subroutine declaration that
1636 was inlined, rather they describe the coordinates of the call.
1637 }
1638
1639 An inlined subroutine entry 
1640 \hypertarget{chap:DWATconstexprcompiletimeconstantfunction}{}
1641 may have a 
1642 \DWATconstexpr{}
1643 attribute, which is a \livelink{chap:classflag}{flag} 
1644 whose presence indicates that the
1645 subroutine has been evaluated as a compile\dash time constant. Such
1646 an entry may also have a \DWATconstvalue{} attribute,
1647 whose value may be of any form that is appropriate for the
1648 representation of the subroutine's return value. The value of
1649 this attribute is the actual return value of the subroutine,
1650 represented as it would be on the target architecture.
1651
1652 \textit{In \addtoindex{C++}, if a function or a constructor declared with 
1653 \addttindex{constexpr}
1654 is called with constant expressions, then the corresponding
1655 concrete inlined instance has a 
1656 \DWATconstexpr{} attribute,
1657 as well as a \DWATconstvalue{} attribute whose value represents
1658 the actual return value of the concrete inlined instance.}
1659
1660 Any debugging information entry that is owned (either
1661 directly or indirectly) by a debugging information entry
1662 with the tag \DWTAGinlinedsubroutine{} is referred to as a
1663 \doublequote{concrete inlined instance entry.} Any entry that has
1664 the tag 
1665 \DWTAGinlinedsubroutine{} 
1666 is known as a \doublequote{concrete inlined instance root.} 
1667 Any set of concrete inlined instance
1668 entries that are all children (either directly or indirectly)
1669 of some concrete inlined instance root, together with the root
1670 itself, is known as a \doublequote{concrete inlined instance tree.}
1671 However, in the case where a concrete inlined instance tree
1672 is nested within another concrete instance tree, the entries
1673 in the \addtoindex{nested concrete inline instance} tree 
1674 are not considered to
1675 be entries in the outer concrete instance tree.
1676
1677 \textit{Concrete inlined instance trees are defined so that no entry
1678 is part of more than one concrete inlined instance tree. This
1679 simplifies later descriptions.}
1680
1681 Each concrete inlined instance tree is uniquely associated
1682 with one (and only one) abstract instance tree.
1683
1684 \textit{Note, however, that the reverse is not true. Any given abstract
1685 instance tree may be associated with several different concrete
1686 inlined instance trees, or may even be associated with zero
1687 concrete inlined instance trees.}
1688
1689 Concrete inlined instance entries may omit attributes that
1690 are not specific to the concrete instance (but present in
1691 the abstract instance) and need include only attributes that
1692 are specific to the concrete instance (but omitted in the
1693 abstract instance). In place of these omitted attributes, each
1694 \hypertarget{chap:DWATabstractorigininlineinstance}{}
1695 concrete inlined instance entry 
1696 \addtoindexx{abstract origin attribute}
1697 has a 
1698 \DWATabstractorigin{}
1699 attribute that may be used to obtain the missing information
1700 (indirectly) from the associated abstract instance entry. The
1701 value of the abstract origin attribute is a reference to the
1702 associated abstract instance entry.
1703
1704 If an entry within a concrete inlined instance tree contains
1705 attributes describing the 
1706 \addtoindexx{declaration coordinates!in concrete instance}
1707 \livelink{chap:declarationcoordinates}{declaration coordinates} 
1708 of that entry, then those attributes should refer to the file, line
1709 and column of the original declaration of the subroutine,
1710 not to the point at which it was inlined. As a consequence,
1711 they may usually be omitted from any entry that has an abstract
1712 origin attribute.
1713
1714 \needlines{4}
1715 For each pair of entries that are associated via a
1716 \addtoindexx{abstract origin attribute}
1717 \DWATabstractorigin{} attribute, both members of the pair
1718 have the same tag. So, for example, an entry with the tag
1719 \DWTAGvariable{} can only be associated with another entry
1720 that also has the tag \DWTAGvariable. The only exception
1721 to this rule is that the root of a concrete instance tree
1722 (which must always have the tag \DWTAGinlinedsubroutine)
1723 can only be associated with the root of its associated abstract
1724 instance tree (which must have the tag \DWTAGsubprogram).
1725
1726 \needlines{6}
1727 In general, the structure and content of any given concrete
1728 inlined instance tree will be closely analogous to the
1729 structure and content of its associated abstract instance
1730 tree. There are a few exceptions:
1731
1732 \begin{enumerate}[1. ]
1733 \item An entry in the concrete instance tree may be omitted if
1734 it contains only a 
1735 \addtoindexx{abstract origin attribute}
1736 \DWATabstractorigin{} attribute and either
1737 has no children, or its children are omitted. Such entries
1738 would provide no useful information. In C\dash like languages,
1739 such entries frequently include types, including structure,
1740 union, class, and interface types; and members of types. If any
1741 entry within a concrete inlined instance tree needs to refer
1742 to an entity declared within the scope of the relevant inlined
1743 subroutine and for which no concrete instance entry exists,
1744 the reference should refer to the abstract instance entry.
1745
1746 \item Entries in the concrete instance tree which are associated
1747 with entries in the abstract instance tree such that neither
1748 has a \DWATname{} attribute,
1749 \addtoindexx{name attribute}
1750 and neither is referenced by
1751 any other debugging information entry, may be omitted. This
1752 may happen for debugging information entries in the abstract
1753 instance trees that became unnecessary in the concrete instance
1754 tree because of additional information available there. For
1755 example, an anonymous variable might have been created and
1756 described in the abstract instance tree, but because of
1757 the actual parameters for a particular inlined expansion,
1758 it could be described as a constant value without the need
1759 for that separate debugging information entry.
1760
1761 \item A concrete instance tree may contain entries which do
1762 not correspond to entries in the abstract instance tree
1763 to describe new entities that are specific to a particular
1764 inlined expansion. In that case, they will not have associated
1765 entries in the abstract instance tree, should not contain
1766 \addtoindexx{abstract origin attribute}
1767 \DWATabstractorigin{} attributes, and must contain all their
1768 own attributes directly. This allows an abstract instance tree
1769 to omit debugging information entries for anonymous entities
1770 that are unlikely to be needed in most inlined expansions. In
1771 any expansion which deviates from that expectation, the
1772 entries can be described in its concrete inlined instance tree.
1773
1774 \end{enumerate}
1775
1776 \subsubsection{Out-of-Line Instances of Inlined Subroutines}
1777 \label{chap:outoflineinstancesofinlinedsubroutines}
1778 Under some conditions, compilers may need to generate concrete
1779 executable instances of inlined subroutines other than at
1780 points where those subroutines are actually called. Such
1781 concrete instances of inlined subroutines are referred to as
1782 \doublequote{concrete out\dash of\dash line instances.}
1783
1784 \textit{In \addtoindex{C++}, for example, 
1785 taking the address of a function declared
1786 to be inline can necessitate the generation of a concrete
1787 out\dash of\dash line instance of the given function.}
1788
1789 The DWARF representation of a concrete out\dash of\dash line instance
1790 of an inlined subroutine is essentially the same as for a
1791 concrete inlined instance of that subroutine (as described in
1792 the preceding section). The representation of such a concrete
1793 % It is critical that the hypertarget and livelink be
1794 % separated to avoid problems with latex.
1795 out\dash of\dash line 
1796 \addtoindexx{abstract origin attribute}
1797 instance 
1798 \hypertarget{chap:DWATabstractoriginoutoflineinstance}{}
1799 makes use of 
1800 \DWATabstractorigin{}
1801 attributes in exactly the same way as they are used for
1802 a concrete inlined instance (that is, as references to
1803 corresponding entries within the associated abstract instance
1804 tree).
1805
1806 The differences between the DWARF representation of a
1807 concrete out\dash of\dash line instance of a given subroutine and the
1808 representation of a concrete inlined instance of that same
1809 subroutine are as follows:
1810
1811 \begin{enumerate}[1. ]
1812 \item  The root entry for a concrete out\dash of\dash line instance
1813 of a given inlined subroutine has the same tag as does its
1814 associated (abstract) inlined subroutine entry (that is, tag
1815 \DWTAGsubprogram{} rather than \DWTAGinlinedsubroutine).
1816
1817 \item The root entry for a concrete out\dash of\dash line instance tree
1818 is normally owned by the same parent entry that also owns
1819 the root entry of the associated abstract instance. However,
1820 it is not required that the abstract and out\dash of\dash line instance
1821 trees be owned by the same parent entry.
1822
1823 \end{enumerate}
1824
1825 \subsubsection{Nested Inlined Subroutines}
1826 \label{nestedinlinedsubroutines}
1827 Some languages and compilers may permit the logical nesting of
1828 a subroutine within another subroutine, and may permit either
1829 the outer or the nested subroutine, or both, to be inlined.
1830
1831 For a non\dash inlined subroutine nested within an inlined
1832 subroutine, the nested subroutine is described normally in
1833 both the abstract and concrete inlined instance trees for
1834 the outer subroutine. All rules pertaining to the abstract
1835 and concrete instance trees for the outer subroutine apply
1836 also to the abstract and concrete instance entries for the
1837 nested subroutine.
1838
1839 \needlines{5}
1840 For an inlined subroutine nested within another inlined
1841 subroutine, the following rules apply to their abstract and
1842 \addtoindexx{abstract instance!nested}
1843 \addtoindexx{concrete instance!nested}
1844 concrete instance trees:
1845
1846 \begin{enumerate}[1. ]
1847 \item The abstract instance tree for the nested subroutine is
1848 described within the abstract instance tree for the outer
1849 subroutine according to the rules in 
1850 Section \refersec{chap:abstractinstances}, and
1851 without regard to the fact that it is within an outer abstract
1852 instance tree.
1853
1854 \item Any abstract instance tree for a nested subroutine is
1855 always omitted within the concrete instance tree for an
1856 outer subroutine.
1857
1858 \item  A concrete instance tree for a nested subroutine is
1859 always omitted within the abstract instance tree for an
1860 outer subroutine.
1861
1862 \item The concrete instance tree for any inlined or 
1863 \addtoindexx{out-of-line instance}
1864 out-of-line
1865 \addtoindexx{out-of-line-instance|see{concrete out-of-line-instance}}
1866 expansion of the nested subroutine is described within a
1867 concrete instance tree for the outer subroutine according
1868 to the rules in 
1869 Sections \refersec{chap:concreteinlinedinstances} or 
1870 \referfol{chap:outoflineinstancesofinlinedsubroutines}
1871 , respectively,
1872 and without regard to the fact that it is within an outer
1873 concrete instance tree.
1874 \end{enumerate}
1875
1876 See Appendix \refersec{app:inliningexamples} 
1877 for discussion and examples.
1878
1879 \subsection{Trampolines}
1880 \label{chap:trampolines}
1881
1882 \textit{A trampoline is a compiler\dash generated subroutine that serves as
1883 \hypertarget{chap:DWATtrampolinetargetsubroutine}{}
1884 an intermediary in making a call to another subroutine. It may
1885 adjust parameters and/or the result (if any) as appropriate
1886 to the combined calling and called execution contexts.}
1887
1888 A trampoline is represented by a debugging information entry
1889 \addtoindexx{trampoline (subprogram) entry}
1890 with the tag \DWTAGsubprogram{} or \DWTAGinlinedsubroutine{}
1891 that has 
1892 \addtoindexx{trampoline attribute}
1893 a \DWATtrampoline{} attribute. 
1894 The value of that
1895 attribute indicates the target subroutine of the trampoline,
1896 that is, the subroutine to which the trampoline passes
1897 control. (A trampoline entry may but need not also have a
1898 \DWATartificial{} attribute.)
1899
1900 \needlines{5}
1901 The value of the trampoline attribute may be represented
1902 using any of the following forms, which are listed in order
1903 of preference:
1904
1905 \begin{itemize}
1906 \item If the value is of class reference, then the value
1907 specifies the debugging information entry of the target
1908 subprogram.
1909
1910 \item If the value is of class address, then the value is
1911 the relocated address of the target subprogram.
1912
1913 \item If the value is of class string, then the value is the
1914 (possibly mangled) \addtoindexx{mangled names}
1915 name of the target subprogram.
1916
1917 \item If the value is of class \livelink{chap:classflag}{flag}, then the value true
1918 indicates that the containing subroutine is a trampoline but
1919 that the target subroutine is not known.
1920 \end{itemize}
1921
1922
1923 The target subprogram may itself be a trampoline. (A sequence
1924 of trampolines necessarily ends with a non\dash trampoline
1925 subprogram.)
1926
1927 \textit{In \addtoindex{C++}, trampolines may be used 
1928 to implement derived virtual
1929 member functions; such trampolines typically adjust the
1930 \addtoindexx{this parameter}
1931 implicit this pointer parameter in the course of passing
1932 control.  
1933 Other languages and environments may use trampolines
1934 in a manner sometimes known as transfer functions or transfer
1935 vectors.}
1936
1937 \textit{Trampolines may sometimes pass control to the target
1938 subprogram using a branch or jump instruction instead of a
1939 call instruction, thereby leaving no trace of their existence
1940 in the subsequent execution context. }
1941
1942 \textit{This attribute helps make it feasible for a debugger to arrange
1943 that stepping into a trampoline or setting a breakpoint in
1944 a trampoline will result in stepping into or setting the
1945 breakpoint in the target subroutine instead. This helps to
1946 hide the compiler generated subprogram from the user. }
1947
1948 \textit{If the target subroutine is not known, a debugger may choose
1949 to repeatedly step until control arrives in a new subroutine
1950 which can be assumed to be the target subroutine. }
1951
1952 \subsection{Call Site Entries}
1953 \label{chap:callsiteentries}
1954 \textit{
1955 A call site entry provides a way to represent the static or dynamic 
1956 call graph of a program in the debugging information. It also provides
1957 information about how parameters are passed so that they may be more
1958 easily accessed by a debugger. Together with the \DWOPentryvalue{} opcode,
1959 call site entries can be also useful for computing values of variables 
1960 and expressions where some value is no longer present in the current 
1961 subroutine's registers or local stack frame, but it is known that the 
1962 values are equal to some parameter passed to the function.  
1963 The consumer can then use unwind
1964 information to find the caller and in the call site information sometimes
1965 find how to compute the value passed in a particular parameter.}
1966
1967 A call site is represented by a debugging information entry with the tag
1968 \DWTAGcallsiteTARG{}.  The entry for a call site is owned by the innermost
1969 debugging information entry representing the scope within which the
1970 call is present in the source program.
1971
1972 \textit{A scope entry (for example, for a lexical block) that would not 
1973 otherwise be present in the debugging information of a subroutine
1974 need not be introduced solely to represent the immediately containing scope
1975 of a call. The call site entry is owned by the innermost scope entry that
1976 is present.}
1977
1978 A source call can be compiled into different types of machine code:
1979 \begin{itemize}
1980 \item
1981 A \textit{normal call} uses a call-like instruction which transfers control to the start
1982 of some subprogram and leaves the call site location address somewhere where
1983 unwind information can find it.  
1984 \item
1985 A \textit{tail call} uses a jump-like instruction which
1986 transfers control to the start of some subprogram, but the call site location
1987 address is not preserved (and thus not available using the unwind information).  
1988 \item
1989 A \textit{tail recursion call} is a call
1990 to the current subroutine which is compiled as a loop into the middle of the
1991 current subroutine.
1992 \item
1993 An \textit{inline (or inlined) call} is a call to an inlined subprogram,
1994 where at least one instruction has the location of the inlined subprogram
1995 or any of its blocks or inlined subprograms. 
1996 \end{itemize}
1997
1998 There are also different types of \doublequote{optimized out} calls:
1999 \begin{itemize}
2000 \item
2001 An \textit{optimized out (normal) call} is a call that is in unreachable code that 
2002 has not been emitted (such as, for example, the call to \texttt{foo} in 
2003 \texttt{if (0) foo();}).  
2004 \item
2005 An \textit{optimized out inline call}
2006 is a call to an inlined subprogram which either did not expand to any instructions
2007 or only parts of instructions belong to it and for debug information purposes those
2008 instructions are given a location in the caller.
2009 \end{itemize}
2010
2011 \DWTAGcallsite{} entries describe normal and tail calls but not tail recursion calls,
2012 while \DWTAGinlinedsubroutine{} entries describe inlined calls 
2013 (see Section \refersec{chap:inlinedsubroutines}).
2014
2015 The call site entry has a 
2016 \DWATcallreturnpcNAME{}
2017 \livetargi{chap:DWATcallreturnpcofcallsite}{attribute}{call return pc attribute} 
2018 which is the return address after the call.  
2019 The value of this attribute corresponds to the return address computed by 
2020 call frame information in the called subprogram 
2021 (see Section \refersec{datarep:callframeinformation}).
2022
2023 \textit{On many architectures the return address is the address immediately following the
2024 call instruction, but on architectures with delay slots it might
2025 be an address after the delay slot of the call.}
2026
2027 The call site entry may have a 
2028 \DWATcallpcNAME{}
2029 \livetargi{chap:DWATcallpcofcallsite}{attribute}{call pc attribute} which is the
2030 address of the call instruction.
2031
2032 If the call site entry corresponds to a tail call, it has the 
2033 \DWATcalltailcallNAME{}
2034 \livetargi{chap:DWATcalltailcallofcallsite}{attribute}{call tail call attribute},
2035 which is a \CLASSflag.
2036
2037 The call site entry may have a 
2038 \DWATcalloriginNAME{}
2039 \livetargi{chap:DWATcalloriginofcallsite}{attribute}{call origin attribute}
2040 which is a \CLASSreference.  For direct calls or jumps where the called subprogram is
2041 known it is a reference to the called subprogram's debugging
2042 information entry.  For indirect calls it may be a reference to a
2043 \DWTAGvariable{}, \DWTAGformalparameter{} or \DWTAGmember{} entry representing
2044 the subroutine pointer that is called.
2045
2046 The call site may have a 
2047 \DWATcalltargetNAME{}
2048 \livetargi{dwatcalltargetofcallsite}{attribute}{call target attribute} which is
2049 a DWARF expression.  For indirect calls or jumps where it is unknown at
2050 compile time which subprogram will be called the expression computes the
2051 address of the subprogram that will be called.  The DWARF expression should
2052 not use register or memory locations that might be clobbered by the call.
2053
2054 The call site entry may have a 
2055 \DWATcalltargetclobberedNAME{}
2056 \livetargi{chap:DWATcalltargetclobbered}{attribute}{call target clobbered attribute}
2057 which is a DWARF expression.  For indirect calls or jumps where the
2058 address is not computable without use of registers or memory locations that
2059 might be clobbered by the call the \DWATcalltargetclobberedNAME{}
2060 attribute is used instead of the \DWATcalltarget{} attribute.
2061
2062 The call site entry may have a \DWATtypeNAME{}
2063 \livetargi{chap:DWATtypeofcallsite}{attribute}{type attribute!of call site entry}
2064 referencing a debugging information entry for the type of the called function.  
2065 When \DWATcallorigin{} is present, \DWATtypeNAME{} is usually omitted.
2066
2067 The call site entry may have 
2068 \DWATcallfileNAME{}, \DWATcalllineNAME{} and \DWATcallcolumnNAME{} 
2069 \livetargi{chap:DWATcallfileofcallsite}{attributes,}{call file attribute!of call site entry}
2070 \livetargi{chap:DWATcalllineofcallsite}{}{call line attribute!of call site entry}
2071 \livetargi{chap:DWATcallcolumnofcallsite}{}{call column attribute!of call site entry}
2072 each of whose value is an integer constant.
2073 These attributes represent the source file, source line number, and source
2074 column number, respectively, of the first character of the call statement or
2075 expression.  The call file, call line, and call column attributes are
2076 interpreted in the same way as the declaration file, declaration
2077 line, and declaration column attributes, respectively 
2078 (see Section \refersec{chap:declarationcoordinates}).
2079
2080 \textit{The call file, call line and call column coordinates do not describe the
2081 coordinates of the subroutine declaration that was inlined, rather they describe
2082 the coordinates of the call.}
2083
2084 The call site entry may own \DWTAGcallsiteparameterTARG{} debugging information
2085 entries\index{call site parameter entry} representing the parameters passed to the call.
2086 Each such entry has a \DWATlocation{} attribute which is a location expression.
2087 This location expression describes where the parameter is passed
2088 (usually either some register, or a memory location expressible as the
2089 contents of the stack register plus some offset).
2090
2091 Each \DWTAGcallsiteparameter{} entry may have a 
2092 \DWATcallvalueNAME{}
2093 \livetargi{chap:DWATcallvalueofcallparameter}{attribute}{call value attribute}
2094 which is a DWARF expression.  This expression computes the value
2095 passed for that parameter.  The expression should not use registers or memory
2096 locations that might be clobbered by the call, as it might be evaluated after
2097 unwinding from the called function back to the caller.  If it is not
2098 possible to avoid registers or memory locations that might be clobbered by
2099 the call in the expression, then the \DWATcallvalueNAME{} attribute should
2100 not be provided.
2101
2102 \textit{The reason for the restriction is that the value of the parameter may be
2103 needed in the middle of the callee, where the call clobbered registers or
2104 memory might be already clobbered, and if the consumer was not assured by
2105 the producer it can safely use those values, the consumer could not safely
2106 use the values at all.}
2107
2108 For parameters passed by reference, where the code passes a pointer to
2109 a location which contains the parameter, or for reference type parameters
2110 the \DWTAGcallsiteparameter{} entry may also have 
2111 \DWATcalldatalocationNAME{}
2112 \livetargi{chap:DWATcalldatalocationofcallparameter}{attribute}{call data location attribute}
2113 whose value is a location expression and a
2114 \DWATcalldatavalueNAME{}
2115 \livetargi{chap:DWATcalldatavalueofcallparameter}{attribute}{call data value attribute}
2116 whose value is a DWARF expression.  The \DWATcalldatalocationNAME{} attribute 
2117 describes where the referenced value lives during the call.  If it is just 
2118 \DWOPpushobjectaddress{}, it may be left out.  The 
2119 \DWATcalldatavalueNAME{} attribute describes the value in that location. 
2120 The expression should not use registers or memory
2121 locations that might be clobbered by the call, as it might be evaluated after
2122 unwinding from the called function back to the caller.
2123
2124 Each call site parameter entry may also have a 
2125 \DWATcallparameter{}
2126 \livetargi{chap:DWATcallparameterofcallparameter}{attribute}{call parameter attribute}
2127 which contains a reference to a \DWTAGformalparameter{} entry,
2128 \DWATtype{} attribute referencing the type of the parameter or \DWATname{}
2129 attribute describing the parameter's name.
2130
2131
2132
2133 \section{Lexical Block Entries}
2134 \label{chap:lexicalblockentries}
2135
2136 \textit{A 
2137 lexical \livetargi{chap:lexicalblock}{block}{lexical block} 
2138 is 
2139 \addtoindexx{lexical block}
2140 a bracketed sequence of source statements
2141 that may contain any number of declarations. In some languages
2142 (including \addtoindex{C} and \addtoindex{C++}),
2143 \nolink{blocks} can be nested within other
2144 \nolink{blocks} to any depth.}
2145
2146 % We do not need to link to the preceding paragraph.
2147 A lexical \nolink{block} is represented by a debugging information
2148 entry with the 
2149 tag \DWTAGlexicalblockTARG.
2150
2151 The lexical \livetargi{chap:lexicalblockentry}{block}{lexical block entry} 
2152 entry may have 
2153 either a \DWATlowpc{} and
2154 \DWAThighpc{} pair of 
2155 attributes 
2156 \addtoindexx{high PC attribute}
2157 or 
2158 \addtoindexx{low PC attribute}
2159
2160 \DWATranges{} attribute
2161 \addtoindexx{ranges attribute}
2162 whose values encode the contiguous or non-contiguous address
2163 ranges, respectively, of the machine instructions generated
2164 for the lexical \nolink{block} 
2165 (see Section \refersec{chap:codeaddressesandranges}).
2166
2167
2168 \hypertarget{chap:DWATentrypcoflexicalblock}{}
2169 lexical block entry may also have 
2170 \addtoindexx{entry pc attribute!for lexical block}
2171
2172 \DWATentrypc{} attribute
2173 whose value is the address of the first executable instruction
2174 of the lexical block (see 
2175 Section \refersec{chap:entryaddress}).
2176
2177 If a name has been given to the 
2178 lexical \nolink{block} 
2179 in the source
2180 program, then the corresponding 
2181 lexical \nolink{block} entry has a
2182 \DWATname{} attribute whose 
2183 \addtoindexx{name attribute}
2184 value is a null\dash terminated string
2185 containing the name of the lexical \nolink{block} 
2186 as it appears in
2187 the source program.
2188
2189 \textit{This is not the same as a \addtoindex{C} or 
2190 \addtoindex{C++} label (see below).}
2191
2192 The lexical \nolink{block} entry owns 
2193 debugging information entries that
2194 describe the declarations within that lexical \nolink{block}. 
2195 There is
2196 one such debugging information entry for each local declaration
2197 of an identifier or inner lexical \nolink{block}.
2198
2199 \section{Label Entries}
2200 \label{chap:labelentries}
2201 \textit{A label is a way of identifying a source statement. A labeled
2202 statement is usually the target of one or more \doublequote{go to}
2203 statements.
2204 }
2205
2206 \needlines{4}
2207 A label is represented by a debugging information entry with
2208 \addtoindexx{label entry}
2209 the 
2210 tag \DWTAGlabelTARG. 
2211 The entry for a label should be owned by
2212 the debugging information entry representing the scope within
2213 which the name of the label could be legally referenced within
2214 the source program.
2215
2216 The label entry has a \DWATlowpc{} attribute whose value
2217 is the relocated address of the first machine instruction
2218 generated for the statement identified by the label in
2219 the source program.  The label entry also has a 
2220 \DWATname{} attribute 
2221 \addtoindexx{name attribute}
2222 whose value is a null-terminated string containing
2223 the name of the label as it appears in the source program.
2224
2225
2226 \section{With Statement Entries}
2227 \label{chap:withstatemententries}
2228
2229 \textit{Both \addtoindex{Pascal} and 
2230 \addtoindexx{Modula-2}
2231 Modula\dash 2 support the concept of a \doublequote{with}
2232 statement. The with statement specifies a sequence of
2233 executable statements within which the fields of a record
2234 variable may be referenced, unqualified by the name of the
2235 record variable.}
2236
2237 A with statement is represented by a
2238 \addtoindexi{debugging information entry}{with statement entry}
2239 with the tag \DWTAGwithstmtTARG.
2240
2241 A with statement entry may have either a 
2242 \DWATlowpc{} and
2243 \DWAThighpc{} pair of attributes 
2244 \addtoindexx{high PC attribute}
2245 or 
2246 \addtoindexx{low PC attribute}
2247 a \DWATranges{} attribute
2248 \addtoindexx{ranges attribute}
2249 whose values encode the contiguous or non\dash contiguous address
2250 ranges, respectively, of the machine instructions generated
2251 for the with statement 
2252 (see Section \refersec{chap:codeaddressesandranges}).
2253
2254
2255 \hypertarget{chap:DWATentrypcofwithstmt}{}
2256 with statement entry may also have 
2257 \addtoindexx{entry pc attribute!for with statement}
2258
2259 \DWATentrypc{} attribute
2260 whose value is the address of the first executable instruction
2261 of the with statement (see 
2262 Section \refersec{chap:entryaddress}).
2263
2264 \needlines{5}
2265 The with statement entry has 
2266 \addtoindexx{type attribute}
2267 a \DWATtype{} attribute, denoting
2268 the type of record whose fields may be referenced without full
2269 qualification within the body of the statement. It also has
2270 \addtoindexx{location attribute}
2271 a \DWATlocation{} attribute, describing how to find the base
2272 address of the record object referenced within the body of
2273 the with statement.
2274
2275 \needlines{6}
2276 \section{Try and Catch Block Entries}
2277 \label{chap:tryandcatchblockentries}
2278
2279 \textit{In \addtoindex{C++} a lexical \livelink{chap:lexicalblock}{block} may be 
2280 designated as a \doublequote{catch \nolink{block}.} 
2281 A catch \livetargi{chap:catchblock}{block}{catch block} is an 
2282 exception handler that handles
2283 exceptions thrown by an immediately 
2284 preceding \doublequote{try \livelink{chap:tryblock}{block}.}
2285 A catch \livelink{chap:catchblock}{block} 
2286 designates the type of the exception that it
2287 can handle.}
2288
2289 A try \livetargi{chap:tryblock}{block}{try block} is represented 
2290 by a debugging information entry
2291 \addtoindexx{try block entry}
2292 with the tag \DWTAGtryblockTARG.  
2293 A catch \livelink{chap:catchblock}{block} is represented by
2294 a debugging information entry with 
2295 \addtoindexx{catch block entry}
2296 the tag \DWTAGcatchblockTARG.
2297
2298 % nolink as we have links just above and do not have a combo link for both
2299 Both try and catch \nolink{block} entries may have either a
2300 \DWATlowpc{} and 
2301 \DWAThighpc{} pair of attributes 
2302 \addtoindexx{high PC attribute}
2303 or 
2304 \addtoindexx{low PC attribute}
2305 a
2306 \DWATranges{} attribute 
2307 \addtoindexx{ranges attribute}
2308 whose values encode the contiguous
2309 or non\dash contiguous address ranges, respectively, of the
2310 machine instructions generated for the \livelink{chap:lexicalblock}{block}
2311 (see Section
2312 \refersec{chap:codeaddressesandranges}).
2313
2314
2315 \hypertarget{chap:DWATentrypcoftryblock}{}
2316 \hypertarget{chap:DWATentrypcofcatchblock}{}
2317 try or catch block entry may also have 
2318 \addtoindexx{entry pc attribute!for try block}
2319 \addtoindexx{entry pc attribute!for catch block}
2320
2321 \DWATentrypc{} attribute
2322 whose value is the address of the first executable instruction
2323 of the try or catch block (see 
2324 Section \refersec{chap:entryaddress}).
2325
2326 Catch \livelink{chap:catchblock}{block} entries have at 
2327 least one child entry, an
2328 entry representing the type of exception accepted by
2329 that catch \livelink{chap:catchblock}{block}. 
2330 This child entry has one of 
2331 \addtoindexx{formal parameter entry!in catch block}
2332 the 
2333 \addtoindexx{unspecified parameters entry!in catch block}
2334 tags
2335 \DWTAGformalparameter{} or
2336 \DWTAGunspecifiedparameters,
2337 and will have the same form as other parameter entries.
2338
2339 The siblings immediately following 
2340 a try \livelink{chap:tryblock}{block} entry are its
2341 corresponding catch \livelink{chap:catchblock}{block} entries.
2342