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