1 /* Definitions for values of C expressions, for GDB.
3 Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
4 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
5 2008 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #if !defined (VALUE_H)
26 #include "frame.h" /* For struct frame_id. */
36 /* The structure which defines the type of a value. It should never
37 be possible for a program lval value to survive over a call to the
38 inferior (i.e. to be put into the history list or an internal
43 /* Values are stored in a chain, so that they can be deleted easily
44 over calls to the inferior. Values assigned to internal variables
45 or put into the value history are taken off this list. */
47 struct value
*value_next (struct value
*);
49 /* Type of the value. */
51 extern struct type
*value_type (struct value
*);
53 /* This is being used to change the type of an existing value, that
54 code should instead be creating a new value with the changed type
55 (but possibly shared content). */
57 extern void deprecated_set_value_type (struct value
*value
,
60 /* Only used for bitfields; number of bits contained in them. */
62 extern int value_bitsize (struct value
*);
63 extern void set_value_bitsize (struct value
*, int bit
);
65 /* Only used for bitfields; position of start of field. For
66 gdbarch_bits_big_endian=0 targets, it is the position of the LSB. For
67 gdbarch_bits_big_endian=1 targets, it is the position of the MSB. */
69 extern int value_bitpos (struct value
*);
70 extern void set_value_bitpos (struct value
*, int bit
);
72 /* Describes offset of a value within lval of a structure in bytes.
73 If lval == lval_memory, this is an offset to the address. If lval
74 == lval_register, this is a further offset from location.address
75 within the registers structure. Note also the member
76 embedded_offset below. */
78 extern int value_offset (struct value
*);
79 extern void set_value_offset (struct value
*, int offset
);
81 /* The comment from "struct value" reads: ``Is it modifiable? Only
82 relevant if lval != not_lval.''. Shouldn't the value instead be
83 not_lval and be done with it? */
85 extern int deprecated_value_modifiable (struct value
*value
);
86 extern void deprecated_set_value_modifiable (struct value
*value
,
89 /* If a value represents a C++ object, then the `type' field gives the
90 object's compile-time type. If the object actually belongs to some
91 class derived from `type', perhaps with other base classes and
92 additional members, then `type' is just a subobject of the real
93 thing, and the full object is probably larger than `type' would
96 If `type' is a dynamic class (i.e. one with a vtable), then GDB can
97 actually determine the object's run-time type by looking at the
98 run-time type information in the vtable. When this information is
99 available, we may elect to read in the entire object, for several
102 - When printing the value, the user would probably rather see the
103 full object, not just the limited portion apparent from the
106 - If `type' has virtual base classes, then even printing `type'
107 alone may require reaching outside the `type' portion of the
108 object to wherever the virtual base class has been stored.
110 When we store the entire object, `enclosing_type' is the run-time
111 type -- the complete object -- and `embedded_offset' is the offset
112 of `type' within that larger type, in bytes. The value_contents()
113 macro takes `embedded_offset' into account, so most GDB code
114 continues to see the `type' portion of the value, just as the
117 If `type' is a pointer to an object, then `enclosing_type' is a
118 pointer to the object's run-time type, and `pointed_to_offset' is
119 the offset in bytes from the full object to the pointed-to object
120 -- that is, the value `embedded_offset' would have if we followed
121 the pointer and fetched the complete object. (I don't really see
122 the point. Why not just determine the run-time type when you
123 indirect, and avoid the special case? The contents don't matter
124 until you indirect anyway.)
126 If we're not doing anything fancy, `enclosing_type' is equal to
127 `type', and `embedded_offset' is zero, so everything works
130 extern struct type
*value_enclosing_type (struct value
*);
131 extern struct value
*value_change_enclosing_type (struct value
*val
,
132 struct type
*new_type
);
133 extern int value_pointed_to_offset (struct value
*value
);
134 extern void set_value_pointed_to_offset (struct value
*value
, int val
);
135 extern int value_embedded_offset (struct value
*value
);
136 extern void set_value_embedded_offset (struct value
*value
, int val
);
138 /* If zero, contents of this value are in the contents field. If
139 nonzero, contents are in inferior. If the lval field is lval_memory,
140 the contents are in inferior memory at location.address plus offset.
141 The lval field may also be lval_register.
143 WARNING: This field is used by the code which handles watchpoints
144 (see breakpoint.c) to decide whether a particular value can be
145 watched by hardware watchpoints. If the lazy flag is set for some
146 member of a value chain, it is assumed that this member of the
147 chain doesn't need to be watched as part of watching the value
148 itself. This is how GDB avoids watching the entire struct or array
149 when the user wants to watch a single struct member or array
150 element. If you ever change the way lazy flag is set and reset, be
151 sure to consider this use as well! */
153 extern int value_lazy (struct value
*);
154 extern void set_value_lazy (struct value
*value
, int val
);
156 /* value_contents() and value_contents_raw() both return the address
157 of the gdb buffer used to hold a copy of the contents of the lval.
158 value_contents() is used when the contents of the buffer are needed
159 -- it uses value_fetch_lazy() to load the buffer from the process
160 being debugged if it hasn't already been loaded
161 (value_contents_writeable() is used when a writeable but fetched
162 buffer is required).. value_contents_raw() is used when data is
163 being stored into the buffer, or when it is certain that the
164 contents of the buffer are valid.
166 Note: The contents pointer is adjusted by the offset required to
167 get to the real subobject, if the value happens to represent
168 something embedded in a larger run-time object. */
170 extern gdb_byte
*value_contents_raw (struct value
*);
172 /* Actual contents of the value. For use of this value; setting it
173 uses the stuff above. Not valid if lazy is nonzero. Target
174 byte-order. We force it to be aligned properly for any possible
175 value. Note that a value therefore extends beyond what is
178 extern const gdb_byte
*value_contents (struct value
*);
179 extern gdb_byte
*value_contents_writeable (struct value
*);
181 /* The ALL variants of the above two macros do not adjust the returned
182 pointer by the embedded_offset value. */
184 extern gdb_byte
*value_contents_all_raw (struct value
*);
185 extern const gdb_byte
*value_contents_all (struct value
*);
187 extern int value_fetch_lazy (struct value
*val
);
188 extern int value_contents_equal (struct value
*val1
, struct value
*val2
);
190 /* If nonzero, this is the value of a variable which does not actually
191 exist in the program. */
192 extern int value_optimized_out (struct value
*value
);
193 extern void set_value_optimized_out (struct value
*value
, int val
);
195 /* Set or return field indicating whether a variable is initialized or
196 not, based on debugging information supplied by the compiler.
197 1 = initialized; 0 = uninitialized. */
198 extern int value_initialized (struct value
*);
199 extern void set_value_initialized (struct value
*, int);
201 /* While the following fields are per- VALUE .CONTENT .PIECE (i.e., a
202 single value might have multiple LVALs), this hacked interface is
203 limited to just the first PIECE. Expect further change. */
204 /* Type of value; either not an lval, or one of the various different
205 possible kinds of lval. */
206 extern enum lval_type
*deprecated_value_lval_hack (struct value
*);
207 #define VALUE_LVAL(val) (*deprecated_value_lval_hack (val))
209 /* If lval == lval_memory, this is the address in the inferior. If
210 lval == lval_register, this is the byte offset into the registers
212 extern CORE_ADDR
*deprecated_value_address_hack (struct value
*);
213 #define VALUE_ADDRESS(val) (*deprecated_value_address_hack (val))
215 /* Pointer to internal variable. */
216 extern struct internalvar
**deprecated_value_internalvar_hack (struct value
*);
217 #define VALUE_INTERNALVAR(val) (*deprecated_value_internalvar_hack (val))
219 /* Frame register value is relative to. This will be described in the
220 lval enum above as "lval_register". */
221 extern struct frame_id
*deprecated_value_frame_id_hack (struct value
*);
222 #define VALUE_FRAME_ID(val) (*deprecated_value_frame_id_hack (val))
224 /* Register number if the value is from a register. */
225 extern short *deprecated_value_regnum_hack (struct value
*);
226 #define VALUE_REGNUM(val) (*deprecated_value_regnum_hack (val))
228 /* Convert a REF to the object referenced. */
230 extern struct value
*coerce_ref (struct value
*value
);
232 /* If ARG is an array, convert it to a pointer.
233 If ARG is an enum, convert it to an integer.
234 If ARG is a function, convert it to a function pointer.
236 References are dereferenced. */
238 extern struct value
*coerce_array (struct value
*value
);
239 extern struct value
*coerce_number (struct value
*value
);
241 /* If ARG is an enum, convert it to an integer. */
243 extern struct value
*coerce_enum (struct value
*value
);
245 /* Internal variables (variables for convenience of use of debugger)
246 are recorded as a chain of these structures. */
250 struct internalvar
*next
;
259 #include "gdbtypes.h"
260 #include "expression.h"
265 extern void print_address_demangle (CORE_ADDR
, struct ui_file
*, int);
267 extern LONGEST
value_as_long (struct value
*val
);
268 extern DOUBLEST
value_as_double (struct value
*val
);
269 extern CORE_ADDR
value_as_address (struct value
*val
);
271 extern LONGEST
unpack_long (struct type
*type
, const gdb_byte
*valaddr
);
272 extern DOUBLEST
unpack_double (struct type
*type
, const gdb_byte
*valaddr
,
274 extern CORE_ADDR
unpack_pointer (struct type
*type
, const gdb_byte
*valaddr
);
275 extern LONGEST
unpack_field_as_long (struct type
*type
,
276 const gdb_byte
*valaddr
,
279 extern void pack_long (gdb_byte
*buf
, struct type
*type
, LONGEST num
);
281 extern struct value
*value_from_longest (struct type
*type
, LONGEST num
);
282 extern struct value
*value_from_pointer (struct type
*type
, CORE_ADDR addr
);
283 extern struct value
*value_from_double (struct type
*type
, DOUBLEST num
);
284 extern struct value
*value_from_decfloat (struct type
*type
,
285 const gdb_byte
*decbytes
);
286 extern struct value
*value_from_string (char *string
);
288 extern struct value
*value_at (struct type
*type
, CORE_ADDR addr
);
289 extern struct value
*value_at_lazy (struct type
*type
, CORE_ADDR addr
);
291 extern struct value
*default_value_from_register (struct type
*type
,
293 struct frame_info
*frame
);
295 extern struct value
*value_from_register (struct type
*type
, int regnum
,
296 struct frame_info
*frame
);
298 extern CORE_ADDR
address_from_register (struct type
*type
, int regnum
,
299 struct frame_info
*frame
);
301 extern struct value
*value_of_variable (struct symbol
*var
, struct block
*b
);
303 extern struct value
*value_of_register (int regnum
, struct frame_info
*frame
);
305 struct value
*value_of_register_lazy (struct frame_info
*frame
, int regnum
);
307 extern int symbol_read_needs_frame (struct symbol
*);
309 extern struct value
*read_var_value (struct symbol
*var
,
310 struct frame_info
*frame
);
312 extern struct value
*locate_var_value (struct symbol
*var
,
313 struct frame_info
*frame
);
315 extern struct value
*allocate_value (struct type
*type
);
317 extern struct value
*allocate_repeat_value (struct type
*type
, int count
);
319 extern struct value
*value_mark (void);
321 extern void value_free_to_mark (struct value
*mark
);
323 extern struct value
*value_string (char *ptr
, int len
);
324 extern struct value
*value_bitstring (char *ptr
, int len
);
326 extern struct value
*value_array (int lowbound
, int highbound
,
327 struct value
**elemvec
);
329 extern struct value
*value_concat (struct value
*arg1
, struct value
*arg2
);
331 extern struct value
*value_binop (struct value
*arg1
, struct value
*arg2
,
334 extern struct value
*value_add (struct value
*arg1
, struct value
*arg2
);
336 extern struct value
*value_sub (struct value
*arg1
, struct value
*arg2
);
338 extern int value_must_coerce_to_target (struct value
*arg1
);
340 extern struct value
*value_coerce_to_target (struct value
*arg1
);
342 extern struct value
*value_coerce_array (struct value
*arg1
);
344 extern struct value
*value_coerce_function (struct value
*arg1
);
346 extern struct value
*value_ind (struct value
*arg1
);
348 extern struct value
*value_addr (struct value
*arg1
);
350 extern struct value
*value_ref (struct value
*arg1
);
352 extern struct value
*value_assign (struct value
*toval
,
353 struct value
*fromval
);
355 extern struct value
*value_pos (struct value
*arg1
);
357 extern struct value
*value_neg (struct value
*arg1
);
359 extern struct value
*value_complement (struct value
*arg1
);
361 extern struct value
*value_struct_elt (struct value
**argp
,
363 char *name
, int *static_memfuncp
,
366 extern struct value
*value_aggregate_elt (struct type
*curtype
,
371 extern struct value
*value_static_field (struct type
*type
, int fieldno
);
373 extern struct fn_field
*value_find_oload_method_list (struct value
**, char *,
375 struct type
**, int *);
377 extern int find_overload_match (struct type
**arg_types
, int nargs
,
378 char *name
, int method
, int lax
,
379 struct value
**objp
, struct symbol
*fsym
,
380 struct value
**valp
, struct symbol
**symp
,
383 extern struct value
*value_field (struct value
*arg1
, int fieldno
);
385 extern struct value
*value_primitive_field (struct value
*arg1
, int offset
,
387 struct type
*arg_type
);
390 extern struct type
*value_rtti_target_type (struct value
*, int *, int *,
393 extern struct value
*value_full_object (struct value
*, struct type
*, int,
396 extern struct value
*value_cast_pointers (struct type
*, struct value
*);
398 extern struct value
*value_cast (struct type
*type
, struct value
*arg2
);
400 extern struct value
*value_zero (struct type
*type
, enum lval_type lv
);
402 extern struct value
*value_one (struct type
*type
, enum lval_type lv
);
404 extern struct value
*value_repeat (struct value
*arg1
, int count
);
406 extern struct value
*value_subscript (struct value
*array
, struct value
*idx
);
408 extern struct value
*register_value_being_returned (struct type
*valtype
,
409 struct regcache
*retbuf
);
411 extern struct value
*value_in (struct value
*element
, struct value
*set
);
413 extern int value_bit_index (struct type
*type
, const gdb_byte
*addr
,
416 extern int using_struct_return (struct type
*func_type
,
417 struct type
*value_type
);
419 extern struct value
*evaluate_expression (struct expression
*exp
);
421 extern struct value
*evaluate_type (struct expression
*exp
);
423 extern struct value
*evaluate_subexp_with_coercion (struct expression
*,
426 extern struct value
*parse_and_eval (char *exp
);
428 extern struct value
*parse_to_comma_and_eval (char **expp
);
430 extern struct type
*parse_and_eval_type (char *p
, int length
);
432 extern CORE_ADDR
parse_and_eval_address (char *exp
);
434 extern CORE_ADDR
parse_and_eval_address_1 (char **expptr
);
436 extern LONGEST
parse_and_eval_long (char *exp
);
438 extern struct value
*access_value_history (int num
);
440 extern struct value
*value_of_internalvar (struct internalvar
*var
);
442 extern void set_internalvar (struct internalvar
*var
, struct value
*val
);
444 extern void set_internalvar_component (struct internalvar
*var
,
446 int bitpos
, int bitsize
,
447 struct value
*newvalue
);
449 extern struct internalvar
*lookup_only_internalvar (char *name
);
451 extern struct internalvar
*create_internalvar (char *name
);
453 extern struct internalvar
*lookup_internalvar (char *name
);
455 extern int value_equal (struct value
*arg1
, struct value
*arg2
);
457 extern int value_less (struct value
*arg1
, struct value
*arg2
);
459 extern int value_logical_not (struct value
*arg1
);
463 extern struct value
*value_of_this (int complain
);
465 extern struct value
*value_x_binop (struct value
*arg1
, struct value
*arg2
,
467 enum exp_opcode otherop
,
470 extern struct value
*value_x_unop (struct value
*arg1
, enum exp_opcode op
,
473 extern struct value
*value_fn_field (struct value
**arg1p
, struct fn_field
*f
,
474 int j
, struct type
*type
, int offset
);
476 extern int binop_user_defined_p (enum exp_opcode op
, struct value
*arg1
,
479 extern int unop_user_defined_p (enum exp_opcode op
, struct value
*arg1
);
481 extern int destructor_name_p (const char *name
, const struct type
*type
);
483 #define value_free(val) xfree (val)
485 extern void free_all_values (void);
487 extern void release_value (struct value
*val
);
489 extern int record_latest_value (struct value
*val
);
491 extern void modify_field (gdb_byte
*addr
, LONGEST fieldval
, int bitpos
,
494 extern void type_print (struct type
*type
, char *varstring
,
495 struct ui_file
*stream
, int show
);
497 extern gdb_byte
*baseclass_addr (struct type
*type
, int index
,
499 struct value
**valuep
, int *errp
);
501 extern void print_longest (struct ui_file
*stream
, int format
,
502 int use_local
, LONGEST val
);
504 extern void print_floating (const gdb_byte
*valaddr
, struct type
*type
,
505 struct ui_file
*stream
);
507 extern void print_decimal_floating (const gdb_byte
*valaddr
, struct type
*type
,
508 struct ui_file
*stream
);
510 extern int value_print (struct value
*val
, struct ui_file
*stream
, int format
,
511 enum val_prettyprint pretty
);
513 extern void value_print_array_elements (struct value
*val
,
514 struct ui_file
*stream
, int format
,
515 enum val_prettyprint pretty
);
517 extern struct value
*value_release_to_mark (struct value
*mark
);
519 extern int val_print (struct type
*type
, const gdb_byte
*valaddr
,
520 int embedded_offset
, CORE_ADDR address
,
521 struct ui_file
*stream
, int format
,
522 int deref_ref
, int recurse
,
523 enum val_prettyprint pretty
,
524 const struct language_defn
*language
);
526 extern int common_val_print (struct value
*val
,
527 struct ui_file
*stream
, int format
,
528 int deref_ref
, int recurse
,
529 enum val_prettyprint pretty
,
530 const struct language_defn
*language
);
532 extern int val_print_string (CORE_ADDR addr
, int len
, int width
,
533 struct ui_file
*stream
);
535 extern void print_variable_value (struct symbol
*var
,
536 struct frame_info
*frame
,
537 struct ui_file
*stream
);
539 extern int check_field (struct type
*, const char *);
541 extern void typedef_print (struct type
*type
, struct symbol
*news
,
542 struct ui_file
*stream
);
544 extern char *internalvar_name (struct internalvar
*var
);
546 extern void preserve_values (struct objfile
*);
550 extern struct value
*value_copy (struct value
*);
554 extern struct value
*varying_to_slice (struct value
*);
556 extern struct value
*value_slice (struct value
*, int, int);
558 extern struct value
*value_literal_complex (struct value
*, struct value
*,
561 extern struct value
*find_function_in_inferior (const char *);
563 extern struct value
*value_allocate_space_in_inferior (int);
565 extern struct value
*value_of_local (const char *name
, int complain
);
567 extern struct value
* value_subscripted_rvalue (struct value
*array
, struct value
*idx
, int lowerbound
);
568 #endif /* !defined (VALUE_H) */
This page took 0.040285 seconds and 4 git commands to generate.