projects / deliverable / binutils-gdb.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
* gdbtypes.h (TYPE_OBJFILE_OWNED, TYPE_OWNER): New macros.
[deliverable/binutils-gdb.git] / gdb / value.h
... / ...
CommitLineData
1/* Definitions for values of C expressions, for GDB.
2
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, 2009 Free Software Foundation, Inc.
6
7 This file is part of GDB.
8
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.
13
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.
18
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/>. */
21
22#if !defined (VALUE_H)
23#define VALUE_H 1
24
25#include "doublest.h"
26#include "frame.h" /* For struct frame_id. */
27
28struct block;
29struct expression;
30struct regcache;
31struct symbol;
32struct type;
33struct ui_file;
34struct language_defn;
35struct value_print_options;
36
37/* The structure which defines the type of a value. It should never
38 be possible for a program lval value to survive over a call to the
39 inferior (i.e. to be put into the history list or an internal
40 variable). */
41
42struct value;
43
44/* Needed if another module needs to maintain its own list of values. */
45
46void value_prepend_to_list (struct value **head, struct value *val);
47void value_remove_from_list (struct value **head, struct value *val);
48
49/* Values are stored in a chain, so that they can be deleted easily
50 over calls to the inferior. Values assigned to internal variables,
51 put into the value history or exposed to Python are taken off this
52 list. */
53
54struct value *value_next (struct value *);
55
56/* Type of the value. */
57
58extern struct type *value_type (struct value *);
59
60/* This is being used to change the type of an existing value, that
61 code should instead be creating a new value with the changed type
62 (but possibly shared content). */
63
64extern void deprecated_set_value_type (struct value *value,
65 struct type *type);
66
67/* Only used for bitfields; number of bits contained in them. */
68
69extern int value_bitsize (struct value *);
70extern void set_value_bitsize (struct value *, int bit);
71
72/* Only used for bitfields; position of start of field. For
73 gdbarch_bits_big_endian=0 targets, it is the position of the LSB. For
74 gdbarch_bits_big_endian=1 targets, it is the position of the MSB. */
75
76extern int value_bitpos (struct value *);
77extern void set_value_bitpos (struct value *, int bit);
78
79/* Describes offset of a value within lval of a structure in bytes.
80 If lval == lval_memory, this is an offset to the address. If lval
81 == lval_register, this is a further offset from location.address
82 within the registers structure. Note also the member
83 embedded_offset below. */
84
85extern int value_offset (struct value *);
86extern void set_value_offset (struct value *, int offset);
87
88/* The comment from "struct value" reads: ``Is it modifiable? Only
89 relevant if lval != not_lval.''. Shouldn't the value instead be
90 not_lval and be done with it? */
91
92extern int deprecated_value_modifiable (struct value *value);
93extern void deprecated_set_value_modifiable (struct value *value,
94 int modifiable);
95
96/* If a value represents a C++ object, then the `type' field gives the
97 object's compile-time type. If the object actually belongs to some
98 class derived from `type', perhaps with other base classes and
99 additional members, then `type' is just a subobject of the real
100 thing, and the full object is probably larger than `type' would
101 suggest.
102
103 If `type' is a dynamic class (i.e. one with a vtable), then GDB can
104 actually determine the object's run-time type by looking at the
105 run-time type information in the vtable. When this information is
106 available, we may elect to read in the entire object, for several
107 reasons:
108
109 - When printing the value, the user would probably rather see the
110 full object, not just the limited portion apparent from the
111 compile-time type.
112
113 - If `type' has virtual base classes, then even printing `type'
114 alone may require reaching outside the `type' portion of the
115 object to wherever the virtual base class has been stored.
116
117 When we store the entire object, `enclosing_type' is the run-time
118 type -- the complete object -- and `embedded_offset' is the offset
119 of `type' within that larger type, in bytes. The value_contents()
120 macro takes `embedded_offset' into account, so most GDB code
121 continues to see the `type' portion of the value, just as the
122 inferior would.
123
124 If `type' is a pointer to an object, then `enclosing_type' is a
125 pointer to the object's run-time type, and `pointed_to_offset' is
126 the offset in bytes from the full object to the pointed-to object
127 -- that is, the value `embedded_offset' would have if we followed
128 the pointer and fetched the complete object. (I don't really see
129 the point. Why not just determine the run-time type when you
130 indirect, and avoid the special case? The contents don't matter
131 until you indirect anyway.)
132
133 If we're not doing anything fancy, `enclosing_type' is equal to
134 `type', and `embedded_offset' is zero, so everything works
135 normally. */
136
137extern struct type *value_enclosing_type (struct value *);
138extern struct value *value_change_enclosing_type (struct value *val,
139 struct type *new_type);
140extern int value_pointed_to_offset (struct value *value);
141extern void set_value_pointed_to_offset (struct value *value, int val);
142extern int value_embedded_offset (struct value *value);
143extern void set_value_embedded_offset (struct value *value, int val);
144
145/* For lval_computed values, this structure holds functions used to
146 retrieve and set the value (or portions of the value).
147
148 For each function, 'V' is the 'this' pointer: an lval_funcs
149 function F may always assume that the V it receives is an
150 lval_computed value, and has F in the appropriate slot of its
151 lval_funcs structure. */
152
153struct lval_funcs
154{
155 /* Fill in VALUE's contents. This is used to "un-lazy" values. If
156 a problem arises in obtaining VALUE's bits, this function should
157 call 'error'. */
158 void (*read) (struct value *v);
159
160 /* Handle an assignment TOVAL = FROMVAL by writing the value of
161 FROMVAL to TOVAL's location. The contents of TOVAL have not yet
162 been updated. If a problem arises in doing so, this function
163 should call 'error'. */
164 void (*write) (struct value *toval, struct value *fromval);
165
166 /* Return a duplicate of VALUE's closure, for use in a new value.
167 This may simply return the same closure, if VALUE's is
168 reference-counted or statically allocated.
169
170 This may be NULL, in which case VALUE's closure is re-used in the
171 new value. */
172 void *(*copy_closure) (struct value *v);
173
174 /* Drop VALUE's reference to its closure. Maybe this frees the
175 closure; maybe this decrements a reference count; maybe the
176 closure is statically allocated and this does nothing.
177
178 This may be NULL, in which case no action is taken to free
179 VALUE's closure. */
180 void (*free_closure) (struct value *v);
181};
182
183/* Create a computed lvalue, with type TYPE, function pointers FUNCS,
184 and closure CLOSURE. */
185
186extern struct value *allocate_computed_value (struct type *type,
187 struct lval_funcs *funcs,
188 void *closure);
189
190/* If VALUE is lval_computed, return its lval_funcs structure. */
191
192extern struct lval_funcs *value_computed_funcs (struct value *value);
193
194/* If VALUE is lval_computed, return its closure. The meaning of the
195 returned value depends on the functions VALUE uses. */
196
197extern void *value_computed_closure (struct value *value);
198
199/* If zero, contents of this value are in the contents field. If
200 nonzero, contents are in inferior. If the lval field is lval_memory,
201 the contents are in inferior memory at location.address plus offset.
202 The lval field may also be lval_register.
203
204 WARNING: This field is used by the code which handles watchpoints
205 (see breakpoint.c) to decide whether a particular value can be
206 watched by hardware watchpoints. If the lazy flag is set for some
207 member of a value chain, it is assumed that this member of the
208 chain doesn't need to be watched as part of watching the value
209 itself. This is how GDB avoids watching the entire struct or array
210 when the user wants to watch a single struct member or array
211 element. If you ever change the way lazy flag is set and reset, be
212 sure to consider this use as well! */
213
214extern int value_lazy (struct value *);
215extern void set_value_lazy (struct value *value, int val);
216
217/* value_contents() and value_contents_raw() both return the address
218 of the gdb buffer used to hold a copy of the contents of the lval.
219 value_contents() is used when the contents of the buffer are needed
220 -- it uses value_fetch_lazy() to load the buffer from the process
221 being debugged if it hasn't already been loaded
222 (value_contents_writeable() is used when a writeable but fetched
223 buffer is required).. value_contents_raw() is used when data is
224 being stored into the buffer, or when it is certain that the
225 contents of the buffer are valid.
226
227 Note: The contents pointer is adjusted by the offset required to
228 get to the real subobject, if the value happens to represent
229 something embedded in a larger run-time object. */
230
231extern gdb_byte *value_contents_raw (struct value *);
232
233/* Actual contents of the value. For use of this value; setting it
234 uses the stuff above. Not valid if lazy is nonzero. Target
235 byte-order. We force it to be aligned properly for any possible
236 value. Note that a value therefore extends beyond what is
237 declared here. */
238
239extern const gdb_byte *value_contents (struct value *);
240extern gdb_byte *value_contents_writeable (struct value *);
241
242/* The ALL variants of the above two macros do not adjust the returned
243 pointer by the embedded_offset value. */
244
245extern gdb_byte *value_contents_all_raw (struct value *);
246extern const gdb_byte *value_contents_all (struct value *);
247
248extern int value_fetch_lazy (struct value *val);
249extern int value_contents_equal (struct value *val1, struct value *val2);
250
251/* If nonzero, this is the value of a variable which does not actually
252 exist in the program. */
253extern int value_optimized_out (struct value *value);
254extern void set_value_optimized_out (struct value *value, int val);
255
256/* Set or return field indicating whether a variable is initialized or
257 not, based on debugging information supplied by the compiler.
258 1 = initialized; 0 = uninitialized. */
259extern int value_initialized (struct value *);
260extern void set_value_initialized (struct value *, int);
261
262/* Set COMPONENT's location as appropriate for a component of WHOLE
263 --- regardless of what kind of lvalue WHOLE is. */
264extern void set_value_component_location (struct value *component,
265 struct value *whole);
266
267/* While the following fields are per- VALUE .CONTENT .PIECE (i.e., a
268 single value might have multiple LVALs), this hacked interface is
269 limited to just the first PIECE. Expect further change. */
270/* Type of value; either not an lval, or one of the various different
271 possible kinds of lval. */
272extern enum lval_type *deprecated_value_lval_hack (struct value *);
273#define VALUE_LVAL(val) (*deprecated_value_lval_hack (val))
274
275/* If lval == lval_memory, return the address in the inferior. If
276 lval == lval_register, return the byte offset into the registers
277 structure. Otherwise, return 0. The returned address
278 includes the offset, if any. */
279extern CORE_ADDR value_address (struct value *);
280
281/* Like value_address, except the result does not include value's
282 offset. */
283extern CORE_ADDR value_raw_address (struct value *);
284
285/* Set the address of a value. */
286extern void set_value_address (struct value *, CORE_ADDR);
287
288/* Pointer to internal variable. */
289extern struct internalvar **deprecated_value_internalvar_hack (struct value *);
290#define VALUE_INTERNALVAR(val) (*deprecated_value_internalvar_hack (val))
291
292/* Frame register value is relative to. This will be described in the
293 lval enum above as "lval_register". */
294extern struct frame_id *deprecated_value_frame_id_hack (struct value *);
295#define VALUE_FRAME_ID(val) (*deprecated_value_frame_id_hack (val))
296
297/* Register number if the value is from a register. */
298extern short *deprecated_value_regnum_hack (struct value *);
299#define VALUE_REGNUM(val) (*deprecated_value_regnum_hack (val))
300
301/* Convert a REF to the object referenced. */
302
303extern struct value *coerce_ref (struct value *value);
304
305/* If ARG is an array, convert it to a pointer.
306 If ARG is a function, convert it to a function pointer.
307
308 References are dereferenced. */
309
310extern struct value *coerce_array (struct value *value);
311
312\f
313
314#include "symtab.h"
315#include "gdbtypes.h"
316#include "expression.h"
317
318struct frame_info;
319struct fn_field;
320
321extern void print_address_demangle (CORE_ADDR, struct ui_file *, int);
322
323extern LONGEST value_as_long (struct value *val);
324extern DOUBLEST value_as_double (struct value *val);
325extern CORE_ADDR value_as_address (struct value *val);
326
327extern LONGEST unpack_long (struct type *type, const gdb_byte *valaddr);
328extern DOUBLEST unpack_double (struct type *type, const gdb_byte *valaddr,
329 int *invp);
330extern CORE_ADDR unpack_pointer (struct type *type, const gdb_byte *valaddr);
331extern LONGEST unpack_field_as_long (struct type *type,
332 const gdb_byte *valaddr,
333 int fieldno);
334
335extern void pack_long (gdb_byte *buf, struct type *type, LONGEST num);
336
337extern struct value *value_from_longest (struct type *type, LONGEST num);
338extern struct value *value_from_pointer (struct type *type, CORE_ADDR addr);
339extern struct value *value_from_double (struct type *type, DOUBLEST num);
340extern struct value *value_from_decfloat (struct type *type,
341 const gdb_byte *decbytes);
342
343extern struct value *value_at (struct type *type, CORE_ADDR addr);
344extern struct value *value_at_lazy (struct type *type, CORE_ADDR addr);
345
346extern struct value *value_from_contents_and_address (struct type *,
347 const gdb_byte *,
348 CORE_ADDR);
349
350extern struct value *default_value_from_register (struct type *type,
351 int regnum,
352 struct frame_info *frame);
353
354extern struct value *value_from_register (struct type *type, int regnum,
355 struct frame_info *frame);
356
357extern CORE_ADDR address_from_register (struct type *type, int regnum,
358 struct frame_info *frame);
359
360extern struct value *value_of_variable (struct symbol *var, struct block *b);
361
362extern struct value *address_of_variable (struct symbol *var, struct block *b);
363
364extern struct value *value_of_register (int regnum, struct frame_info *frame);
365
366struct value *value_of_register_lazy (struct frame_info *frame, int regnum);
367
368extern int symbol_read_needs_frame (struct symbol *);
369
370extern struct value *read_var_value (struct symbol *var,
371 struct frame_info *frame);
372
373extern struct value *allocate_value (struct type *type);
374extern struct value *allocate_value_lazy (struct type *type);
375extern void allocate_value_contents (struct value *value);
376
377extern struct value *allocate_repeat_value (struct type *type, int count);
378
379extern struct value *value_mark (void);
380
381extern void value_free_to_mark (struct value *mark);
382
383extern struct value *value_cstring (char *ptr, int len,
384 struct type *char_type);
385extern struct value *value_string (char *ptr, int len,
386 struct type *char_type);
387extern struct value *value_bitstring (char *ptr, int len,
388 struct type *index_type);
389
390extern struct value *value_array (int lowbound, int highbound,
391 struct value **elemvec);
392
393extern struct value *value_concat (struct value *arg1, struct value *arg2);
394
395extern struct value *value_binop (struct value *arg1, struct value *arg2,
396 enum exp_opcode op);
397
398extern struct value *value_ptradd (struct value *arg1, LONGEST arg2);
399
400extern LONGEST value_ptrdiff (struct value *arg1, struct value *arg2);
401
402extern int value_must_coerce_to_target (struct value *arg1);
403
404extern struct value *value_coerce_to_target (struct value *arg1);
405
406extern struct value *value_coerce_array (struct value *arg1);
407
408extern struct value *value_coerce_function (struct value *arg1);
409
410extern struct value *value_ind (struct value *arg1);
411
412extern struct value *value_addr (struct value *arg1);
413
414extern struct value *value_ref (struct value *arg1);
415
416extern struct value *value_assign (struct value *toval,
417 struct value *fromval);
418
419extern struct value *value_pos (struct value *arg1);
420
421extern struct value *value_neg (struct value *arg1);
422
423extern struct value *value_complement (struct value *arg1);
424
425extern struct value *value_struct_elt (struct value **argp,
426 struct value **args,
427 char *name, int *static_memfuncp,
428 char *err);
429
430extern struct value *value_aggregate_elt (struct type *curtype,
431 char *name,
432 int want_address,
433 enum noside noside);
434
435extern struct value *value_static_field (struct type *type, int fieldno);
436
437extern struct fn_field *value_find_oload_method_list (struct value **, char *,
438 int, int *,
439 struct type **, int *);
440
441extern int find_overload_match (struct type **arg_types, int nargs,
442 char *name, int method, int lax,
443 struct value **objp, struct symbol *fsym,
444 struct value **valp, struct symbol **symp,
445 int *staticp);
446
447extern struct value *value_field (struct value *arg1, int fieldno);
448
449extern struct value *value_primitive_field (struct value *arg1, int offset,
450 int fieldno,
451 struct type *arg_type);
452
453
454extern struct type *value_rtti_target_type (struct value *, int *, int *,
455 int *);
456
457extern struct value *value_full_object (struct value *, struct type *, int,
458 int, int);
459
460extern struct value *value_cast_pointers (struct type *, struct value *);
461
462extern struct value *value_cast (struct type *type, struct value *arg2);
463
464extern struct value *value_zero (struct type *type, enum lval_type lv);
465
466extern struct value *value_one (struct type *type, enum lval_type lv);
467
468extern struct value *value_repeat (struct value *arg1, int count);
469
470extern struct value *value_subscript (struct value *array, LONGEST index);
471
472extern struct value *value_bitstring_subscript (struct type *type,
473 struct value *bitstring,
474 LONGEST index);
475
476extern struct value *register_value_being_returned (struct type *valtype,
477 struct regcache *retbuf);
478
479extern int value_in (struct value *element, struct value *set);
480
481extern int value_bit_index (struct type *type, const gdb_byte *addr,
482 int index);
483
484extern int using_struct_return (struct gdbarch *gdbarch,
485 struct type *func_type,
486 struct type *value_type);
487
488extern struct value *evaluate_expression (struct expression *exp);
489
490extern struct value *evaluate_type (struct expression *exp);
491
492extern struct value *evaluate_subexp (struct type *expect_type,
493 struct expression *exp,
494 int *pos, enum noside noside);
495
496extern struct value *evaluate_subexpression_type (struct expression *exp,
497 int subexp);
498
499extern char *extract_field_op (struct expression *exp, int *subexp);
500
501extern struct value *evaluate_subexp_with_coercion (struct expression *,
502 int *, enum noside);
503
504extern struct value *parse_and_eval (char *exp);
505
506extern struct value *parse_to_comma_and_eval (char **expp);
507
508extern struct type *parse_and_eval_type (char *p, int length);
509
510extern CORE_ADDR parse_and_eval_address (char *exp);
511
512extern CORE_ADDR parse_and_eval_address_1 (char **expptr);
513
514extern LONGEST parse_and_eval_long (char *exp);
515
516extern void unop_promote (const struct language_defn *language,
517 struct gdbarch *gdbarch,
518 struct value **arg1);
519
520extern void binop_promote (const struct language_defn *language,
521 struct gdbarch *gdbarch,
522 struct value **arg1, struct value **arg2);
523
524extern struct value *access_value_history (int num);
525
526extern struct value *value_of_internalvar (struct gdbarch *gdbarch,
527 struct internalvar *var);
528
529extern int get_internalvar_integer (struct internalvar *var, LONGEST *l);
530
531extern void set_internalvar (struct internalvar *var, struct value *val);
532
533extern void set_internalvar_integer (struct internalvar *var, LONGEST l);
534
535extern void set_internalvar_string (struct internalvar *var,
536 const char *string);
537
538extern void clear_internalvar (struct internalvar *var);
539
540extern void set_internalvar_component (struct internalvar *var,
541 int offset,
542 int bitpos, int bitsize,
543 struct value *newvalue);
544
545extern struct internalvar *lookup_only_internalvar (const char *name);
546
547extern struct internalvar *create_internalvar (const char *name);
548
549typedef struct value * (*internalvar_make_value) (struct gdbarch *,
550 struct internalvar *);
551extern struct internalvar *
552 create_internalvar_type_lazy (char *name, internalvar_make_value fun);
553
554extern struct internalvar *lookup_internalvar (const char *name);
555
556extern int value_equal (struct value *arg1, struct value *arg2);
557
558extern int value_less (struct value *arg1, struct value *arg2);
559
560extern int value_logical_not (struct value *arg1);
561
562/* C++ */
563
564extern struct value *value_of_this (int complain);
565
566extern struct value *value_x_binop (struct value *arg1, struct value *arg2,
567 enum exp_opcode op,
568 enum exp_opcode otherop,
569 enum noside noside);
570
571extern struct value *value_x_unop (struct value *arg1, enum exp_opcode op,
572 enum noside noside);
573
574extern struct value *value_fn_field (struct value **arg1p, struct fn_field *f,
575 int j, struct type *type, int offset);
576
577extern int binop_user_defined_p (enum exp_opcode op, struct value *arg1,
578 struct value *arg2);
579
580extern int unop_user_defined_p (enum exp_opcode op, struct value *arg1);
581
582extern int destructor_name_p (const char *name, const struct type *type);
583
584extern void value_free (struct value *val);
585
586extern void free_all_values (void);
587
588extern void release_value (struct value *val);
589
590extern int record_latest_value (struct value *val);
591
592extern void modify_field (gdb_byte *addr, LONGEST fieldval, int bitpos,
593 int bitsize);
594
595extern void type_print (struct type *type, char *varstring,
596 struct ui_file *stream, int show);
597
598extern char *type_to_string (struct type *type);
599
600extern gdb_byte *baseclass_addr (struct type *type, int index,
601 gdb_byte *valaddr,
602 struct value **valuep, int *errp);
603
604extern void print_longest (struct ui_file *stream, int format,
605 int use_local, LONGEST val);
606
607extern void print_floating (const gdb_byte *valaddr, struct type *type,
608 struct ui_file *stream);
609
610extern void print_decimal_floating (const gdb_byte *valaddr, struct type *type,
611 struct ui_file *stream);
612
613extern int value_print (struct value *val, struct ui_file *stream,
614 const struct value_print_options *options);
615
616extern void value_print_array_elements (struct value *val,
617 struct ui_file *stream, int format,
618 enum val_prettyprint pretty);
619
620extern struct value *value_release_to_mark (struct value *mark);
621
622extern int val_print (struct type *type, const gdb_byte *valaddr,
623 int embedded_offset, CORE_ADDR address,
624 struct ui_file *stream, int recurse,
625 const struct value_print_options *options,
626 const struct language_defn *language);
627
628extern int common_val_print (struct value *val,
629 struct ui_file *stream, int recurse,
630 const struct value_print_options *options,
631 const struct language_defn *language);
632
633extern int val_print_string (struct type *elttype, CORE_ADDR addr, int len,
634 struct ui_file *stream,
635 const struct value_print_options *options);
636
637extern void print_variable_and_value (const char *name,
638 struct symbol *var,
639 struct frame_info *frame,
640 struct ui_file *stream,
641 int indent);
642
643extern int check_field (struct type *, const char *);
644
645extern void typedef_print (struct type *type, struct symbol *news,
646 struct ui_file *stream);
647
648extern char *internalvar_name (struct internalvar *var);
649
650extern void preserve_values (struct objfile *);
651
652/* From values.c */
653
654extern struct value *value_copy (struct value *);
655
656/* From valops.c */
657
658extern struct value *varying_to_slice (struct value *);
659
660extern struct value *value_slice (struct value *, int, int);
661
662extern struct value *value_literal_complex (struct value *, struct value *,
663 struct type *);
664
665extern struct value *find_function_in_inferior (const char *,
666 struct objfile **);
667
668extern struct value *value_allocate_space_in_inferior (int);
669
670extern struct value *value_of_local (const char *name, int complain);
671
672extern struct value *value_subscripted_rvalue (struct value *array,
673 LONGEST index, int lowerbound);
674
675/* User function handler. */
676
677typedef struct value *(*internal_function_fn) (void *cookie,
678 int argc,
679 struct value **argv);
680
681void add_internal_function (const char *name, const char *doc,
682 internal_function_fn handler,
683 void *cookie);
684
685struct value *call_internal_function (struct value *function,
686 int argc, struct value **argv);
687
688char *value_internal_function_name (struct value *);
689
690#endif /* !defined (VALUE_H) */
GDB Binutils - Deliverables
This page took 0.025746 seconds and 4 git commands to generate.