Working update reflecting many changes based on full
[dwarf-doc.git] / dwarf5 / latexdoc / dataobject.tex
1 \chapter[Data Object and Object List]{Data Object and Object List Entries}
2 \label{chap:dataobjectandobjectlistentries}
3
4 This section presents the debugging information entries that
5 describe individual data objects: variables, parameters and
6 constants, and lists of those objects that may be grouped in
7 a single declaration, such as a 
8 \livelink{chap:commonblockentry}{common block}.
9
10 \section{Data Object Entries}
11 \label{chap:dataobjectentries}
12 \addtoindexx{data object entries}
13
14 Program variables, 
15 \addtoindexx{formal parameter entry}
16 formal parameters and constants are
17 represented by debugging information entries with the tags
18 \DWTAGvariableTARG\addtoindexx{variable entry}, 
19 \DWTAGformalparameterTARG\addtoindexx{formal parameter entry} and 
20 \DWTAGconstantTARG\addtoindexx{constant (data) entry},
21 respectively.
22
23 \textit{The tag \DWTAGconstant{} is used for languages that
24 have true named constants.}
25
26 The debugging information entry for a program variable,
27 formal parameter or constant may have the following attributes:
28 \begin{enumerate}[1. ]
29 \item A \DWATname{} attribute,
30 \addtoindexx{name attribute}
31 whose value of class \CLASSstring{} describes a null-terminated
32 string for the data object name as it appears in the
33 source program.
34
35 If a variable entry describes an 
36 \addtoindex{anonymous union},
37 the name attribute is omitted or its value describes a single
38 zero byte.
39
40 \item A \DWATexternal{} attribute, 
41 \hypertarget{chap:DWATexternalexternalvariable}{}
42 which 
43 \addtoindexx{external attribute}
44 is a \livelink{chap:classflag}{flag}, if the name
45 of a variable is visible outside of its enclosing compilation
46 unit.  
47
48 \textit{The definitions of \addtoindex{C++} static data members of structures
49 or classes are represented by variable entries \nolink{flagged} as
50 external. Both file static and local variables in \addtoindex{C} and \addtoindex{C++}
51 are represented by non-external variable entries.
52 }
53
54 \item A \DWATdeclaration{} attribute, 
55 \addtoindexx{declaration attribute}
56 which is a \livelink{chap:classflag}{flag} that
57 indicates whether this entry represents a non-defining
58 declaration of an object.
59
60 \item A \DWATlocation{} attribute,
61 \addtoindexx{location attribute}
62 whose value describes the location of a variable or parameter at run-time.
63
64 If no location attribute is present in a variable 
65 entry representing the definition of a variable (that is,
66 \addtoindexx{declaration attribute}
67 with no 
68 \DWATdeclaration{} attribute),
69 or if the location attribute is present but has
70 an empty location description (as described in Section \refersec{chap:locationdescriptions}),
71 \addtoindexx{unallocated variable}
72 the variable is assumed to exist in the source code but not
73 in the executable program (but see number 10, below).
74
75 In a variable entry representing a non-defining declaration of a variable, the location
76 specified modifies the location specified by the defining declaration and only applies for the
77 scope of the variable entry; if no location is specified, then the location specified in the
78 defining declaration applies.
79
80 The location of a variable may be further specified with 
81 \addtoindexx{segment attribute!and data segment}
82
83 \DWATsegment{} attribute, if
84 appropriate.
85
86 \item A \DWATtype{} attribute describing the type of the variable,
87 constant or formal parameter.
88
89 \item If the variable entry represents the defining declaration
90 for a C++ static data member of a structure, class or union,
91 the entry has a \DWATspecification{} attribute, whose value is a
92 \livelink{chap:classreference}{reference} to the debugging information entry representing the
93 declaration of this data member. The referenced entry has the
94 tag \DWTAGmember{} and will be a child of some class, structure
95 or union type entry.
96
97 If the variable entry represents a
98 non-defining declaration, \DWATspecification{} may be used
99 to reference the defining declaration of the variable. If
100 no \DWATspecification{} attribute is present, the defining
101 declaration may be found as a global definition either in the
102 current compilation unit or in another compilation unit with
103 the \DWATexternal{} attribute.  
104
105 Variable entries containing
106 the \DWATspecification{} attribute do not need to duplicate
107 information provided by the declaration entry referenced by
108 the specification attribute. In particular, such variable
109 entries do not need to contain attributes for the name or
110 type of the data member whose definition they 
111 % Getting the link target in a good spot is tricky. So putting
112 %this one a little early.
113 \hypertarget{chap:DWATvariableparameternonconstantparameterflag}{}
114 represent.
115
116 \item A \DWATvariableparameter{}
117 attribute\addtoindexx{variable parameter attribute}, 
118 which is a \livelink{chap:classflag}{flag},
119 if a formal parameter entry represents a parameter whose
120 value in the calling function may be modified by the callee.
121 The absence of this attribute implies that the parameter\textquoteright s
122 value in the calling function cannot be modified by the callee.
123
124 \item A \DWATisoptional{} attribute, 
125 \hypertarget{chap:DWATisoptionaloptionalparameter}{}
126 which 
127 \addtoindexx{is optional attribute}
128 is a \livelink{chap:classflag}{flag}, if a
129 parameter entry represents an \addtoindex{optional parameter}.
130
131 \item A \DWATdefaultvalue{} attribute 
132 \addtoindexx{default value attribute}
133 for 
134 \addtoindexx{formal parameter entry!with default value}
135 a formal parameter
136 \hypertarget{chap:DWATdefaultvaluedefaultvalueofparameter}{}
137 entry. The value of this attribute may be a constant, or a reference to the
138 debugging information entry for a variable, or a reference to a
139 debugging information entry containing a DWARF procedure.  If the
140 attribute form is of class constant, that constant is interpreted as
141 a default value of the type of the formal parameter. If the attribute
142 form is of class reference, and the referenced entry is for a
143 variable, the default value of the parameter is the value of the
144 referenced variable.  If the reference value is 0, no default value
145 has been specified.  Otherwise, the attribute represents an implicit
146 \DWOPcallref{} to the referenced debugging information entry, and
147 the default value of the parameter is the value returned by that
148 DWARF procedure, interpreted as a value of the type of the formal
149 parameter.
150
151 \textit{For a constant form there is no way to 
152 express the absence of a default value.}
153
154 \item A \DWATconstvalue{} attribute 
155 for 
156 \hypertarget{chap:DWATconstvalueconstantobject}{}
157 an entry describing a
158 variable or formal parameter whose value is constant and not
159 represented by an object in the address space of the program,
160 or an entry describing a named constant. (Note that such
161 an entry does not have a location attribute.) The value of
162 this attribute may be a string or any of the constant data
163 or data block forms, 
164 as appropriate for the representation
165 of the variable's value. The value is the actual constant
166 value of the variable, represented as it would be on the
167 target architecture.  
168
169 \textit{One way in which a formal parameter
170 with a constant value and no location can arise is for a
171 formal parameter of an inlined subprogram that corresponds
172 to a constant actual parameter of a call that is inlined.
173 }
174
175 \item A \DWATstartscope{} 
176 attribute if the scope of 
177 \addtoindexx{start scope attribute}
178 an
179 \hypertarget{chap:DWATstartscopeobjectdeclaration}{}
180 object is smaller than (that is, is a subset of the addresses
181 of) the scope most closely enclosing the object. There are
182 two cases:
183 \begin{enumerate}[a) ]
184 \item If the scope of the object entry includes all of the
185 containing scope except for a contiguous sequence of bytes at
186 the beginning of that containing scope, then the scope of the
187 object is specified using a value of class constant. If the
188 containing scope is contiguous, the value of this attribute
189 is the offset in bytes of the beginning of the scope for the
190 object from the low pc value of the debugging information
191 entry that defines its scope. If the containing scope
192 is non-contiguous 
193 (see \refersec{chap:noncontiguousaddressranges})
194 the value of this
195 attribute is the offset in bytes of the beginning of the scope
196 for the object from the beginning of the first \addtoindex{range list} entry
197 that is not a base selection entry, a default selection entry or an end-of-list entry.
198
199 \needlines{4}
200 \item Otherwise, the scope of the object is specified using
201 a value of class \livelink{chap:classrangelistptr}{rangelistptr}. 
202 This value indicates the
203 beginning of a \addtoindex{range list}
204 (see \ref{chap:noncontiguousaddressranges}).
205 \end{enumerate}
206
207
208 \textit{The scope of a variable may begin somewhere in the middle of
209 a lexical \livelink{chap:lexicalblock}{block} in a language 
210 that allows executable code in a
211 \nolink{block} before a variable declaration, or where one declaration
212 containing initialization code may change the scope of a
213 subsequent declaration.  For example, in the following \addtoindex{C} code:}
214
215 \begin{lstlisting}
216 float x = 99.99;
217 int myfunc()
218 {
219     float f = x;
220     float x = 88.99;
221     return 0;
222 }
223 \end{lstlisting}
224
225 \textit{\addtoindex{C} scoping rules require that the value of the variable x
226 assigned to the variable f in the initialization sequence is
227 the value of the global variable x, rather than the local x,
228 because the scope of the local variable x only starts after
229 the full declarator for the local x.}
230
231 \textit{Due to optimization, the scope of an object may be
232 non-contiguous and require use of a \addtoindex{range list} even when
233 the containing scope is contiguous. Conversely, the scope of
234 an object may not require its own \addtoindex{range list} even when the
235 containing scope is non\dash contiguous.}
236
237 \item A \DWATendianity{} attribute, 
238 whose value 
239 \hypertarget{chap:DWATendianityendianityofdata}{}
240 is a constant
241 \addtoindexx{endianity attribute}
242 that 
243 \addtoindexx{big-endian encoding|see{endianity attribute}}
244 specifies 
245 the endianity of the object. The value of
246 this attribute specifies an ABI\dash defined 
247 byte ordering \addtoindexx{ordering attribute} for
248 the value of the object. If omitted, the default endianity
249 of data for the given type is assumed.  
250
251 The set of values
252 and their meaning for this attribute is given in 
253 Table \ref{tab:endianityattributevalues}.
254
255 \begin{table}[here]
256 \caption{Endianity attribute values}
257 \label{tab:endianityattributevalues}
258 \centering
259 \begin{tabular}{l|p{9cm}}
260 \hline
261 Name&Meaning\\ \hline
262 \DWENDdefaultTARG{} &  Default endian encoding
263   (equivalent to the \mbox{absence} of a 
264   \DWATendianity{} attribute) \\
265 \DWENDbigTARG{} & Big\dash endian encoding \\
266 \DWENDlittleTARG& Little-endian encoding \\
267 \hline
268 \end{tabular}
269 \end{table}
270
271
272 These represent the default encoding formats as defined by
273 the target architecture's ABI or processor definition. The
274 exact definition of these formats may differ in subtle ways
275 for different architectures.
276
277
278 \item A \DWATconstexpr{} attribute, 
279 which 
280 \hypertarget{chap:DWATconstexprcompiletimeconstantobject}{}
281 is a \livelink{chap:classflag}{flag}, if a
282 variable entry represents a \addtoindex{C++} object declared with the
283 \texttt{constexpr} specifier. This attribute indicates that the
284 variable can be evaluated as a compile\dash time constant.  
285
286 \textit{In \addtoindex{C++},
287 a variable declared with \texttt{constexpr} is implicitly \texttt{const}. Such a
288 variable has a \DWATtype{} attribute whose value is a 
289 \livelink{chap:classreference}{reference}
290 to a debugging information entry describing a const qualified type.}
291
292 \item A \DWATlinkagename{} attribute for a 
293 variable or constant entry as described in 
294 Section \refersec{chap:linkagenames}.
295
296 \end{enumerate}
297
298 \section{Common Block Entries}
299 \label{chap:commonblockentries}
300 A Fortran \livetargi{chap:fortrancommonblock}{common}{Fortran!common block} \livetargi{chap:commonblockentry}{block}{common block entry} 
301 may 
302 \addtoindexx{Fortran!common block}
303 be described by a debugging
304 information entry with the 
305 tag \DWTAGcommonblockTARG. 
306
307 The common \nolink{block} 
308 entry has a \DWATname{} attribute 
309 \addtoindexx{name attribute}
310 whose value of class \CLASSstring{} describes a null-terminated
311 string for the
312 \livetargi{chap:commonblockreferenceattribute}{common}{common block reference attribute} 
313 \nolink{block}
314 name as it appears in the source program. It may also have a
315 \DWATlinkagename{} attribute as described in 
316 Section \refersec{chap:linkagenames}. 
317
318 A common block entry also has a \DWATlocation{} attribute
319 \addtoindexx{location attribute}
320 whose value describes the
321 location of the beginning of the common \nolink{block}. 
322
323 The common
324 \nolink{block} entry owns debugging information entries describing
325 the variables contained within the common \nolink{block}.
326
327 \textit{\addtoindex{Fortran} allows each declarer of a common block 
328 to independently define its contents; thus, common blocks are not types.}
329
330 \section{Namelist Entries}
331 \label{chap:namelistentries}
332 \textit{At least one language, Fortran 90, has the concept of a
333 namelist. A namelist is an ordered list of the names of some
334 set of declared objects. The namelist object itself may be used
335 as a replacement for the list of names in various contexts.}
336
337 A namelist is represented by a debugging information entry
338 with the 
339 tag \DWTAGnamelistTARG. 
340 \addtoindexx{namelist entry}
341 If the namelist itself has a
342 name, the namelist entry has a \DWATname{} attribute,
343 \addtoindexx{name attribute}
344 whose value of class \CLASSstring{} describes a null-terminated
345 string for the namelist\textquoteright s
346 name as it appears in the source program.
347
348 Each 
349 \hypertarget{chap:DWATnamelistitemnamelistitem}{}
350 name that is part of the namelist is represented
351 by a debugging information entry with the tag
352 \DWTAGnamelistitemTARG. 
353 Each such entry is a child of the
354 namelist entry, and all of the 
355 namelist item entries for a
356 \addtoindexx{namelist item entry}
357 given namelist are ordered as were the list of names they
358 correspond to in the source program.
359
360 Each namelist item entry contains a 
361 \DWATnamelistitem{} attribute
362 \addtoindexx{namelist item attribute}
363 whose 
364 \addtoindexx{namelist item entry}
365 value is a \livelink{chap:classreference}{reference} to the debugging
366 information entry representing the declaration of the item
367 whose name appears in the namelist.
368
369