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