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