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