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