]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - gdb/value.h
import gdb-1999-07-07 post reformat
[thirdparty/binutils-gdb.git] / gdb / value.h
1 /* Definitions for values of C expressions, for GDB.
2 Copyright 1986, 1987, 1989, 1992, 1993, 1994, 1995, 1996
3 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
21
22 #if !defined (VALUE_H)
23 #define VALUE_H 1
24
25 /*
26 * The structure which defines the type of a value. It should never
27 * be possible for a program lval value to survive over a call to the inferior
28 * (ie to be put into the history list or an internal variable).
29 */
30 enum lval_type
31 {
32 /* Not an lval. */
33 not_lval,
34 /* In memory. Could be a saved register. */
35 lval_memory,
36 /* In a register. */
37 lval_register,
38 /* In a gdb internal variable. */
39 lval_internalvar,
40 /* Part of a gdb internal variable (structure field). */
41 lval_internalvar_component,
42 /* In a register series in a frame not the current one, which may have been
43 partially saved or saved in different places (otherwise would be
44 lval_register or lval_memory). */
45 lval_reg_frame_relative
46 };
47
48 struct value
49 {
50 /* Type of value; either not an lval, or one of the various
51 different possible kinds of lval. */
52 enum lval_type lval;
53 /* Is it modifiable? Only relevant if lval != not_lval. */
54 int modifiable;
55 /* Location of value (if lval). */
56 union
57 {
58 /* Address in inferior or byte of registers structure. */
59 CORE_ADDR address;
60 /* Pointer to internal variable. */
61 struct internalvar *internalvar;
62 /* Number of register. Only used with
63 lval_reg_frame_relative. */
64 int regnum;
65 }
66 location;
67 /* Describes offset of a value within lval of a structure in bytes.
68 This is used in retrieving contents from target memory. [Note also
69 the member embedded_offset below.] */
70 int offset;
71 /* Only used for bitfields; number of bits contained in them. */
72 int bitsize;
73 /* Only used for bitfields; position of start of field.
74 For BITS_BIG_ENDIAN=0 targets, it is the position of the LSB.
75 For BITS_BIG_ENDIAN=1 targets, it is the position of the MSB. */
76 int bitpos;
77 /* Frame value is relative to. In practice, this address is only
78 used if the value is stored in several registers in other than
79 the current frame, and these registers have not all been saved
80 at the same place in memory. This will be described in the
81 lval enum above as "lval_reg_frame_relative". */
82 CORE_ADDR frame_addr;
83 /* Type of the value. */
84 struct type *type;
85 /* Type of the enclosing object if this is an embedded subobject.
86 The member embedded_offset gives the real position of the subobject
87 if type is not the same as enclosing_type.
88
89 If the type field is a pointer type, then enclosing_type is
90 a pointer type pointing to the real (enclosing) type of the target
91 object. */
92 struct type *enclosing_type;
93 /* Values are stored in a chain, so that they can be deleted
94 easily over calls to the inferior. Values assigned to internal
95 variables or put into the value history are taken off this
96 list. */
97 struct value *next;
98
99 /* ??? When is this used? */
100 union
101 {
102 CORE_ADDR memaddr;
103 char *myaddr;
104 }
105 substring_addr;
106
107 /* Register number if the value is from a register. Is not kept
108 if you take a field of a structure that is stored in a
109 register. Shouldn't it be? */
110 short regno;
111 /* If zero, contents of this value are in the contents field.
112 If nonzero, contents are in inferior memory at address
113 in the location.address field plus the offset field
114 (and the lval field should be lval_memory). */
115 char lazy;
116 /* If nonzero, this is the value of a variable which does not
117 actually exist in the program. */
118 char optimized_out;
119 /* If this value represents an object that is embedded inside a
120 larger object (e.g., a base subobject in C++), this gives the
121 offset (in bytes) from the start of the contents buffer where
122 the embedded object begins. This is required because some C++
123 runtime implementations lay out objects (especially virtual bases
124 with possibly negative offsets to ancestors).
125 Note: This may be positive or negative! Also note that this offset
126 is not used when retrieving contents from target memory; the entire
127 enclosing object has to be retrieved always, and the offset for
128 that is given by the member offset above. */
129 int embedded_offset;
130 /* If this value represents a pointer to an object that is embedded
131 in another object, this gives the embedded_offset of the object
132 that is pointed to. */
133 int pointed_to_offset;
134 /* The BFD section associated with this value. */
135 asection *bfd_section;
136 /* Actual contents of the value. For use of this value; setting
137 it uses the stuff above. Not valid if lazy is nonzero.
138 Target byte-order. We force it to be aligned properly for any
139 possible value. Note that a value therefore extends beyond
140 what is declared here. */
141 union
142 {
143 long contents[1];
144 double force_double_align;
145 LONGEST force_longlong_align;
146 char *literal_data;
147 }
148 aligner;
149 /* Do not add any new members here -- contents above will trash them */
150 };
151
152 typedef struct value *value_ptr;
153
154 #define VALUE_TYPE(val) (val)->type
155 #define VALUE_ENCLOSING_TYPE(val) (val)->enclosing_type
156 #define VALUE_LAZY(val) (val)->lazy
157 /* VALUE_CONTENTS and VALUE_CONTENTS_RAW both return the address of
158 the gdb buffer used to hold a copy of the contents of the lval.
159 VALUE_CONTENTS is used when the contents of the buffer are needed --
160 it uses value_fetch_lazy() to load the buffer from the process being
161 debugged if it hasn't already been loaded. VALUE_CONTENTS_RAW is
162 used when data is being stored into the buffer, or when it is
163 certain that the contents of the buffer are valid.
164 Note: The contents pointer is adjusted by the offset required to
165 get to the real subobject, if the value happens to represent
166 something embedded in a larger run-time object. */
167
168 #define VALUE_CONTENTS_RAW(val) ((char *) (val)->aligner.contents + (val)->embedded_offset)
169 #define VALUE_CONTENTS(val) ((void)(VALUE_LAZY(val) && value_fetch_lazy(val)),\
170 VALUE_CONTENTS_RAW(val))
171
172 /* The ALL variants of the above two macros do not adjust the returned
173 pointer by the embedded_offset value. */
174
175 #define VALUE_CONTENTS_ALL_RAW(val) ((char *) (val)->aligner.contents)
176 #define VALUE_CONTENTS_ALL(val) ((void) (VALUE_LAZY(val) && value_fetch_lazy(val)),\
177 VALUE_CONTENTS_ALL_RAW(val))
178
179
180 extern int value_fetch_lazy PARAMS ((value_ptr val));
181
182 #define VALUE_LVAL(val) (val)->lval
183 #define VALUE_ADDRESS(val) (val)->location.address
184 #define VALUE_INTERNALVAR(val) (val)->location.internalvar
185 #define VALUE_FRAME_REGNUM(val) ((val)->location.regnum)
186 #define VALUE_FRAME(val) ((val)->frame_addr)
187 #define VALUE_OFFSET(val) (val)->offset
188 #define VALUE_BITSIZE(val) (val)->bitsize
189 #define VALUE_BITPOS(val) (val)->bitpos
190 #define VALUE_NEXT(val) (val)->next
191 #define VALUE_REGNO(val) (val)->regno
192 #define VALUE_OPTIMIZED_OUT(val) ((val)->optimized_out)
193 #define VALUE_EMBEDDED_OFFSET(val) ((val)->embedded_offset)
194 #define VALUE_POINTED_TO_OFFSET(val) ((val)->pointed_to_offset)
195 #define VALUE_BFD_SECTION(val) ((val)->bfd_section)
196
197 /* Convert a REF to the object referenced. */
198
199 #define COERCE_REF(arg) \
200 do { struct type *value_type_arg_tmp = check_typedef (VALUE_TYPE (arg));\
201 if (TYPE_CODE (value_type_arg_tmp) == TYPE_CODE_REF) \
202 arg = value_at_lazy (TYPE_TARGET_TYPE (value_type_arg_tmp), \
203 unpack_long (VALUE_TYPE (arg), \
204 VALUE_CONTENTS (arg)), \
205 VALUE_BFD_SECTION (arg)); \
206 } while (0)
207
208 /* If ARG is an array, convert it to a pointer.
209 If ARG is an enum, convert it to an integer.
210 If ARG is a function, convert it to a function pointer.
211
212 References are dereferenced. */
213
214 #define COERCE_ARRAY(arg) \
215 do { COERCE_REF(arg); \
216 if (current_language->c_style_arrays \
217 && TYPE_CODE (VALUE_TYPE (arg)) == TYPE_CODE_ARRAY) \
218 arg = value_coerce_array (arg); \
219 if (TYPE_CODE (VALUE_TYPE (arg)) == TYPE_CODE_FUNC) \
220 arg = value_coerce_function (arg); \
221 } while (0)
222
223 #define COERCE_NUMBER(arg) \
224 do { COERCE_ARRAY(arg); COERCE_ENUM(arg); } while (0)
225
226 #define COERCE_VARYING_ARRAY(arg, real_arg_type) \
227 { if (chill_varying_type (real_arg_type)) \
228 arg = varying_to_slice (arg), real_arg_type = VALUE_TYPE (arg); }
229
230 /* If ARG is an enum, convert it to an integer. */
231
232 #define COERCE_ENUM(arg) { \
233 if (TYPE_CODE (check_typedef (VALUE_TYPE (arg))) == TYPE_CODE_ENUM) \
234 arg = value_cast (builtin_type_unsigned_int, arg); \
235 }
236
237 /* Internal variables (variables for convenience of use of debugger)
238 are recorded as a chain of these structures. */
239
240 struct internalvar
241 {
242 struct internalvar *next;
243 char *name;
244 value_ptr value;
245 };
246
247 /* Pointer to member function. Depends on compiler implementation. */
248
249 #define METHOD_PTR_IS_VIRTUAL(ADDR) ((ADDR) & 0x80000000)
250 #define METHOD_PTR_FROM_VOFFSET(OFFSET) (0x80000000 + (OFFSET))
251 #define METHOD_PTR_TO_VOFFSET(ADDR) (~0x80000000 & (ADDR))
252 \f
253
254 #include "symtab.h"
255 #include "gdbtypes.h"
256 #include "expression.h"
257
258 #ifdef __STDC__
259 struct frame_info;
260 struct fn_field;
261 #endif
262
263 extern void
264 print_address_demangle PARAMS ((CORE_ADDR, GDB_FILE *, int));
265
266 extern LONGEST value_as_long PARAMS ((value_ptr val));
267
268 extern DOUBLEST value_as_double PARAMS ((value_ptr val));
269
270 extern CORE_ADDR value_as_pointer PARAMS ((value_ptr val));
271
272 extern LONGEST unpack_long PARAMS ((struct type * type, char *valaddr));
273
274 extern DOUBLEST unpack_double PARAMS ((struct type * type, char *valaddr,
275 int *invp));
276
277 extern CORE_ADDR unpack_pointer PARAMS ((struct type * type, char *valaddr));
278
279 extern LONGEST unpack_field_as_long PARAMS ((struct type * type, char *valaddr,
280 int fieldno));
281
282 extern value_ptr value_from_longest PARAMS ((struct type * type, LONGEST num));
283
284 extern value_ptr value_from_double PARAMS ((struct type * type, DOUBLEST num));
285
286 extern value_ptr value_from_string PARAMS ((char *string));
287
288 extern value_ptr value_at PARAMS ((struct type * type, CORE_ADDR addr, asection * sect));
289
290 extern value_ptr value_at_lazy PARAMS ((struct type * type, CORE_ADDR addr, asection * sect));
291
292 extern value_ptr value_from_register PARAMS ((struct type * type, int regnum,
293 struct frame_info * frame));
294
295 extern value_ptr value_of_variable PARAMS ((struct symbol * var,
296 struct block * b));
297
298 extern value_ptr value_of_register PARAMS ((int regnum));
299
300 extern int symbol_read_needs_frame PARAMS ((struct symbol *));
301
302 extern value_ptr read_var_value PARAMS ((struct symbol * var,
303 struct frame_info * frame));
304
305 extern value_ptr locate_var_value PARAMS ((struct symbol * var,
306 struct frame_info * frame));
307
308 extern value_ptr allocate_value PARAMS ((struct type * type));
309
310 extern value_ptr allocate_repeat_value PARAMS ((struct type * type, int count));
311
312 extern value_ptr value_mark PARAMS ((void));
313
314 extern void value_free_to_mark PARAMS ((value_ptr mark));
315
316 extern value_ptr value_string PARAMS ((char *ptr, int len));
317 extern value_ptr value_bitstring PARAMS ((char *ptr, int len));
318
319 extern value_ptr value_array PARAMS ((int lowbound, int highbound,
320 value_ptr * elemvec));
321
322 extern value_ptr value_concat PARAMS ((value_ptr arg1, value_ptr arg2));
323
324 extern value_ptr value_binop PARAMS ((value_ptr arg1, value_ptr arg2,
325 enum exp_opcode op));
326
327 extern value_ptr value_add PARAMS ((value_ptr arg1, value_ptr arg2));
328
329 extern value_ptr value_sub PARAMS ((value_ptr arg1, value_ptr arg2));
330
331 extern value_ptr value_coerce_array PARAMS ((value_ptr arg1));
332
333 extern value_ptr value_coerce_function PARAMS ((value_ptr arg1));
334
335 extern value_ptr value_ind PARAMS ((value_ptr arg1));
336
337 extern value_ptr value_addr PARAMS ((value_ptr arg1));
338
339 extern value_ptr value_assign PARAMS ((value_ptr toval, value_ptr fromval));
340
341 extern value_ptr value_neg PARAMS ((value_ptr arg1));
342
343 extern value_ptr value_complement PARAMS ((value_ptr arg1));
344
345 extern value_ptr value_struct_elt PARAMS ((value_ptr * argp, value_ptr * args,
346 char *name,
347 int *static_memfuncp, char *err));
348
349 extern value_ptr value_struct_elt_for_reference PARAMS ((struct type * domain,
350 int offset,
351 struct type * curtype,
352 char *name,
353 struct type * intype));
354
355 extern value_ptr value_static_field PARAMS ((struct type * type, int fieldno));
356
357 extern struct fn_field *value_find_oload_method_list PARAMS ((value_ptr *, char *, int, int *, int *, struct type **, int *));
358
359 extern int find_overload_match PARAMS ((struct type ** arg_types, int nargs, char *name, int method, int lax, value_ptr obj, struct symbol * fsym, value_ptr * valp, struct symbol ** symp, int *staticp));
360
361 extern value_ptr value_field PARAMS ((value_ptr arg1, int fieldno));
362
363 extern value_ptr value_primitive_field PARAMS ((value_ptr arg1, int offset,
364 int fieldno,
365 struct type * arg_type));
366
367 extern struct type *
368 value_rtti_type PARAMS ((value_ptr, int *, int *, int *));
369
370 extern struct type *
371 value_rtti_target_type PARAMS ((value_ptr, int *, int *, int *));
372
373 extern value_ptr
374 value_full_object PARAMS ((value_ptr, struct type *, int, int, int));
375
376 extern value_ptr value_cast PARAMS ((struct type * type, value_ptr arg2));
377
378 extern value_ptr value_zero PARAMS ((struct type * type, enum lval_type lv));
379
380 extern value_ptr value_repeat PARAMS ((value_ptr arg1, int count));
381
382 extern value_ptr value_subscript PARAMS ((value_ptr array, value_ptr idx));
383
384 extern value_ptr value_from_vtable_info PARAMS ((value_ptr arg,
385 struct type * type));
386
387 extern value_ptr value_being_returned PARAMS ((struct type * valtype,
388 char *retbuf,
389 int struct_return));
390
391 extern value_ptr value_in PARAMS ((value_ptr element, value_ptr set));
392
393 extern int value_bit_index PARAMS ((struct type * type, char *addr, int index));
394
395 extern int using_struct_return PARAMS ((value_ptr function, CORE_ADDR funcaddr,
396 struct type * value_type, int gcc_p));
397
398 extern void set_return_value PARAMS ((value_ptr val));
399
400 extern value_ptr evaluate_expression PARAMS ((struct expression * exp));
401
402 extern value_ptr evaluate_type PARAMS ((struct expression * exp));
403
404 extern value_ptr evaluate_subexp_with_coercion PARAMS ((struct expression *,
405 int *, enum noside));
406
407 extern value_ptr parse_and_eval PARAMS ((char *exp));
408
409 extern value_ptr parse_to_comma_and_eval PARAMS ((char **expp));
410
411 extern struct type *parse_and_eval_type PARAMS ((char *p, int length));
412
413 extern CORE_ADDR parse_and_eval_address PARAMS ((char *exp));
414
415 extern CORE_ADDR parse_and_eval_address_1 PARAMS ((char **expptr));
416
417 extern value_ptr access_value_history PARAMS ((int num));
418
419 extern value_ptr value_of_internalvar PARAMS ((struct internalvar * var));
420
421 extern void set_internalvar PARAMS ((struct internalvar * var, value_ptr val));
422
423 extern void set_internalvar_component PARAMS ((struct internalvar * var,
424 int offset,
425 int bitpos, int bitsize,
426 value_ptr newvalue));
427
428 extern struct internalvar *lookup_internalvar PARAMS ((char *name));
429
430 extern int value_equal PARAMS ((value_ptr arg1, value_ptr arg2));
431
432 extern int value_less PARAMS ((value_ptr arg1, value_ptr arg2));
433
434 extern int value_logical_not PARAMS ((value_ptr arg1));
435
436 /* C++ */
437
438 extern value_ptr value_of_this PARAMS ((int complain));
439
440 extern value_ptr value_x_binop PARAMS ((value_ptr arg1, value_ptr arg2,
441 enum exp_opcode op,
442 enum exp_opcode otherop,
443 enum noside noside));
444
445 extern value_ptr value_x_unop PARAMS ((value_ptr arg1, enum exp_opcode op,
446 enum noside noside));
447
448 extern value_ptr value_fn_field PARAMS ((value_ptr * arg1p, struct fn_field * f,
449 int j,
450 struct type * type, int offset));
451
452 extern value_ptr value_virtual_fn_field PARAMS ((value_ptr * arg1p,
453 struct fn_field * f, int j,
454 struct type * type,
455 int offset));
456
457 extern int binop_user_defined_p PARAMS ((enum exp_opcode op,
458 value_ptr arg1, value_ptr arg2));
459
460 extern int unop_user_defined_p PARAMS ((enum exp_opcode op, value_ptr arg1));
461
462 extern int destructor_name_p PARAMS ((const char *name,
463 const struct type * type));
464
465 #define value_free(val) free ((PTR)val)
466
467 extern void free_all_values PARAMS ((void));
468
469 extern void release_value PARAMS ((value_ptr val));
470
471 extern int record_latest_value PARAMS ((value_ptr val));
472
473 extern void registers_changed PARAMS ((void));
474
475 extern void read_register_bytes PARAMS ((int regbyte, char *myaddr, int len));
476
477 extern void write_register_bytes PARAMS ((int regbyte, char *myaddr, int len));
478
479 extern void
480 read_register_gen PARAMS ((int regno, char *myaddr));
481
482 extern CORE_ADDR
483 read_register PARAMS ((int regno));
484
485 extern CORE_ADDR
486 read_register_pid PARAMS ((int regno, int pid));
487
488 extern void
489 write_register PARAMS ((int regno, LONGEST val));
490
491 extern void
492 write_register_pid PARAMS ((int regno, CORE_ADDR val, int pid));
493
494 extern void
495 supply_register PARAMS ((int regno, char *val));
496
497 extern void get_saved_register PARAMS ((char *raw_buffer, int *optimized,
498 CORE_ADDR * addrp,
499 struct frame_info * frame,
500 int regnum, enum lval_type * lval));
501
502 extern void
503 modify_field PARAMS ((char *addr, LONGEST fieldval, int bitpos, int bitsize));
504
505 extern void
506 type_print PARAMS ((struct type * type, char *varstring, GDB_FILE * stream,
507 int show));
508
509 extern char *baseclass_addr PARAMS ((struct type * type, int index,
510 char *valaddr,
511 value_ptr * valuep, int *errp));
512
513 extern void
514 print_longest PARAMS ((GDB_FILE * stream, int format, int use_local,
515 LONGEST val));
516
517 extern void
518 print_floating PARAMS ((char *valaddr, struct type * type, GDB_FILE * stream));
519
520 extern int value_print PARAMS ((value_ptr val, GDB_FILE * stream, int format,
521 enum val_prettyprint pretty));
522
523 extern void
524 value_print_array_elements PARAMS ((value_ptr val, GDB_FILE * stream,
525 int format, enum val_prettyprint pretty));
526
527 extern value_ptr
528 value_release_to_mark PARAMS ((value_ptr mark));
529
530 extern int
531 val_print PARAMS ((struct type * type, char *valaddr, int embedded_offset, CORE_ADDR address,
532 GDB_FILE * stream, int format, int deref_ref,
533 int recurse, enum val_prettyprint pretty));
534
535 extern int
536 val_print_string PARAMS ((CORE_ADDR addr, int len, int width, GDB_FILE * stream));
537
538 extern void
539 print_variable_value PARAMS ((struct symbol * var, struct frame_info * frame,
540 GDB_FILE * stream));
541
542 extern int check_field PARAMS ((value_ptr, const char *));
543
544 extern void
545 c_typedef_print PARAMS ((struct type * type, struct symbol * news, GDB_FILE * stream));
546
547 extern char *
548 internalvar_name PARAMS ((struct internalvar * var));
549
550 extern void
551 clear_value_history PARAMS ((void));
552
553 extern void
554 clear_internalvars PARAMS ((void));
555
556 /* From values.c */
557
558 extern value_ptr value_copy PARAMS ((value_ptr));
559
560 extern int baseclass_offset PARAMS ((struct type *, int, char *, CORE_ADDR));
561
562 /* From valops.c */
563
564 extern value_ptr varying_to_slice PARAMS ((value_ptr));
565
566 extern value_ptr value_slice PARAMS ((value_ptr, int, int));
567
568 extern value_ptr call_function_by_hand PARAMS ((value_ptr, int, value_ptr *));
569
570 extern value_ptr value_literal_complex PARAMS ((value_ptr, value_ptr, struct type *));
571
572 extern void find_rt_vbase_offset PARAMS ((struct type *, struct type *, char *, int, int *, int *));
573
574 extern value_ptr find_function_in_inferior PARAMS ((char *));
575
576 extern value_ptr value_allocate_space_in_inferior PARAMS ((int));
577
578 extern CORE_ADDR default_push_arguments PARAMS ((int nargs, value_ptr * args,
579 CORE_ADDR sp,
580 int struct_return,
581 CORE_ADDR struct_addr));
582
583 #endif /* !defined (VALUE_H) */