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