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