gdb/value.h

   1 /* Definitions for values of C expressions, for GDB.
   2
   3    Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994,
   4    1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
   5    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 2 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, write to the Free Software
  21    Foundation, Inc., 59 Temple Place - Suite 330,
  22    Boston, MA 02111-1307, USA.  */
  23
  24 #if !defined (VALUE_H)
  25 #define VALUE_H 1
  26
  27 #include "doublest.h"
  28 #include "frame.h"              /* For struct frame_id.  */
  29
  30 struct block;
  31 struct expression;
  32 struct regcache;
  33 struct symbol;
  34 struct type;
  35 struct ui_file;
  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
  42 struct value
  43 {
  44   /* Type of value; either not an lval, or one of the various
  45      different possible kinds of lval.  */
  46   enum lval_type lval;
  47
  48   /* Is it modifiable?  Only relevant if lval != not_lval.  */
  49   int modifiable;
  50
  51   /* Location of value (if lval).  */
  52   union
  53   {
  54     /* If lval == lval_memory, this is the address in the inferior.
  55        If lval == lval_register, this is the byte offset into the
  56        registers structure.  */
  57     CORE_ADDR address;
  58
  59     /* Pointer to internal variable.  */
  60     struct internalvar *internalvar;
  61
  62     /* Number of register.  Only used with lval_reg_frame_relative.  */
  63     int regnum;
  64   } location;
  65
  66   /* Describes offset of a value within lval of a structure in bytes.
  67      If lval == lval_memory, this is an offset to the address.
  68      If lval == lval_register, this is a further offset from
  69      location.address within the registers structure.
  70      Note also the member embedded_offset below.  */
  71   int offset;
  72
  73   /* Only used for bitfields; number of bits contained in them.  */
  74   int bitsize;
  75
  76   /* Only used for bitfields; position of start of field.
  77      For BITS_BIG_ENDIAN=0 targets, it is the position of the LSB.
  78      For BITS_BIG_ENDIAN=1 targets, it is the position of the MSB. */
  79     int bitpos;
  80
  81   /* Frame value is relative to.  In practice, this ID is only used if
  82      the value is stored in several registers in other than the
  83      current frame, and these registers have not all been saved at the
  84      same place in memory.  This will be described in the lval enum
  85      above as "lval_reg_frame_relative".  */
  86   struct frame_id frame_id;
  87
  88   /* Type of the value.  */
  89   struct type *type;
  90
  91   /* If a value represents a C++ object, then the `type' field gives
  92      the object's compile-time type.  If the object actually belongs
  93      to some class derived from `type', perhaps with other base
  94      classes and additional members, then `type' is just a subobject
  95      of the real thing, and the full object is probably larger than
  96      `type' would suggest.
  97
  98      If `type' is a dynamic class (i.e. one with a vtable), then GDB
  99      can actually determine the object's run-time type by looking at
 100      the run-time type information in the vtable.  When this
 101      information is available, we may elect to read in the entire
 102      object, for several reasons:
 103
 104      - When printing the value, the user would probably rather see the
 105        full object, not just the limited portion apparent from the
 106        compile-time type.
 107
 108      - If `type' has virtual base classes, then even printing `type'
 109        alone may require reaching outside the `type' portion of the
 110        object to wherever the virtual base class has been stored.
 111
 112      When we store the entire object, `enclosing_type' is the run-time
 113      type -- the complete object -- and `embedded_offset' is the
 114      offset of `type' within that larger type, in bytes.  The
 115      VALUE_CONTENTS macro takes `embedded_offset' into account, so
 116      most GDB code continues to see the `type' portion of the value,
 117      just as the inferior would.
 118
 119      If `type' is a pointer to an object, then `enclosing_type' is a
 120      pointer to the object's run-time type, and `pointed_to_offset' is
 121      the offset in bytes from the full object to the pointed-to object
 122      -- that is, the value `embedded_offset' would have if we
 123      followed the pointer and fetched the complete object.  (I don't
 124      really see the point.  Why not just determine the run-time type
 125      when you indirect, and avoid the special case?  The contents
 126      don't matter until you indirect anyway.)
 127
 128      If we're not doing anything fancy, `enclosing_type' is equal to
 129      `type', and `embedded_offset' is zero, so everything works
 130      normally.  */
 131     struct type *enclosing_type;
 132     int embedded_offset;
 133     int pointed_to_offset;
 134
 135     /* Values are stored in a chain, so that they can be deleted
 136        easily over calls to the inferior.  Values assigned to internal
 137        variables or put into the value history are taken off this
 138        list.  */
 139     struct value *next;
 140
 141     /* Register number if the value is from a register.  */
 142     short regno;
 143
 144     /* If zero, contents of this value are in the contents field.  If
 145        nonzero, contents are in inferior memory at address in the
 146        location.address field plus the offset field (and the lval
 147        field should be lval_memory).
 148
 149        WARNING: This field is used by the code which handles
 150        watchpoints (see breakpoint.c) to decide whether a particular
 151        value can be watched by hardware watchpoints.  If the lazy flag
 152        is set for some member of a value chain, it is assumed that
 153        this member of the chain doesn't need to be watched as part of
 154        watching the value itself.  This is how GDB avoids watching the
 155        entire struct or array when the user wants to watch a single
 156        struct member or array element.  If you ever change the way
 157        lazy flag is set and reset, be sure to consider this use as
 158        well!  */
 159     char lazy;
 160
 161     /* If nonzero, this is the value of a variable which does not
 162        actually exist in the program.  */
 163     char optimized_out;
 164
 165     /* Actual contents of the value.  For use of this value; setting
 166        it uses the stuff above.  Not valid if lazy is nonzero.
 167        Target byte-order.  We force it to be aligned properly for any
 168        possible value.  Note that a value therefore extends beyond
 169        what is declared here.  */
 170     union
 171     {
 172       long contents[1];
 173       DOUBLEST force_doublest_align;
 174       LONGEST force_longest_align;
 175       CORE_ADDR force_core_addr_align;
 176       void *force_pointer_align;
 177     } aligner;
 178     /* Do not add any new members here -- contents above will trash them.  */
 179 };
 180
 181
 182 extern struct type *value_type (struct value *);
 183 extern int value_bitsize (struct value *);
 184 extern int value_bitpos (struct value *);
 185 extern int value_offset (struct value *);
 186
 187 #define VALUE_ENCLOSING_TYPE(val) (val)->enclosing_type
 188 #define VALUE_LAZY(val) (val)->lazy
 189
 190 /* VALUE_CONTENTS and VALUE_CONTENTS_RAW both return the address of
 191    the gdb buffer used to hold a copy of the contents of the lval.
 192    VALUE_CONTENTS is used when the contents of the buffer are needed
 193    -- it uses value_fetch_lazy() to load the buffer from the process
 194    being debugged if it hasn't already been loaded.
 195    VALUE_CONTENTS_RAW is used when data is being stored into the
 196    buffer, or when it is certain that the contents of the buffer are
 197    valid.
 198
 199    Note: The contents pointer is adjusted by the offset required to
 200    get to the real subobject, if the value happens to represent
 201    something embedded in a larger run-time object.  */
 202
 203 #define VALUE_CONTENTS_RAW(val) \
 204  ((char *) (val)->aligner.contents + (val)->embedded_offset)
 205 #define VALUE_CONTENTS(val) \
 206  ((void)(VALUE_LAZY(val) && value_fetch_lazy(val)), VALUE_CONTENTS_RAW(val))
 207
 208 /* The ALL variants of the above two macros do not adjust the returned
 209    pointer by the embedded_offset value.  */
 210
 211 #define VALUE_CONTENTS_ALL_RAW(val) ((char *) (val)->aligner.contents)
 212 #define VALUE_CONTENTS_ALL(val) \
 213   ((void) (VALUE_LAZY(val) && value_fetch_lazy(val)), \
 214    VALUE_CONTENTS_ALL_RAW(val))
 215
 216 extern int value_fetch_lazy (struct value *val);
 217
 218 #define VALUE_LVAL(val) (val)->lval
 219 #define VALUE_ADDRESS(val) (val)->location.address
 220 #define VALUE_INTERNALVAR(val) (val)->location.internalvar
 221 #define VALUE_FRAME_REGNUM(val) ((val)->location.regnum)
 222 #define VALUE_FRAME_ID(val) ((val)->frame_id)
 223 #define VALUE_REGNO(val) (val)->regno
 224 #define VALUE_OPTIMIZED_OUT(val) ((val)->optimized_out)
 225 #define VALUE_EMBEDDED_OFFSET(val) ((val)->embedded_offset)
 226 #define VALUE_POINTED_TO_OFFSET(val) ((val)->pointed_to_offset)
 227
 228 /* Convert a REF to the object referenced.  */
 229
 230 extern struct value *coerce_ref (struct value *value);
 231
 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.
 235
 236    References are dereferenced.  */
 237
 238 extern struct value *coerce_array (struct value *value);
 239 extern struct value *coerce_number (struct value *value);
 240
 241 /* If ARG is an enum, convert it to an integer.  */
 242
 243 extern struct value *coerce_enum (struct value *value);
 244
 245 /* Internal variables (variables for convenience of use of debugger)
 246    are recorded as a chain of these structures.  */
 247
 248 struct internalvar
 249 {
 250   struct internalvar *next;
 251   char *name;
 252   struct value *value;
 253 };
 254
 255 /* Pointer to member function.  Depends on compiler implementation.  */
 256
 257 #define METHOD_PTR_IS_VIRTUAL(ADDR)  ((ADDR) & 0x80000000)
 258 #define METHOD_PTR_FROM_VOFFSET(OFFSET) (0x80000000 + (OFFSET))
 259 #define METHOD_PTR_TO_VOFFSET(ADDR) (~0x80000000 & (ADDR))
 260 \f
 261
 262 #include "symtab.h"
 263 #include "gdbtypes.h"
 264 #include "expression.h"
 265
 266 struct frame_info;
 267 struct fn_field;
 268
 269 extern void print_address_demangle (CORE_ADDR, struct ui_file *, int);
 270
 271 extern LONGEST value_as_long (struct value *val);
 272 extern DOUBLEST value_as_double (struct value *val);
 273 extern CORE_ADDR value_as_address (struct value *val);
 274
 275 extern LONGEST unpack_long (struct type *type, const char *valaddr);
 276 extern DOUBLEST unpack_double (struct type *type, const char *valaddr,
 277                                int *invp);
 278 extern CORE_ADDR unpack_pointer (struct type *type, const char *valaddr);
 279 extern LONGEST unpack_field_as_long (struct type *type, const char *valaddr,
 280                                      int fieldno);
 281
 282 extern struct value *value_from_longest (struct type *type, LONGEST num);
 283 extern struct value *value_from_pointer (struct type *type, CORE_ADDR addr);
 284 extern struct value *value_from_double (struct type *type, DOUBLEST num);
 285 extern struct value *value_from_string (char *string);
 286
 287 extern struct value *value_at (struct type *type, CORE_ADDR addr);
 288 extern struct value *value_at_lazy (struct type *type, CORE_ADDR addr);
 289
 290 extern struct value *value_from_register (struct type *type, int regnum,
 291                                           struct frame_info *frame);
 292
 293 extern struct value *value_of_variable (struct symbol *var, struct block *b);
 294
 295 extern struct value *value_of_register (int regnum,
 296                                         struct frame_info *frame);
 297
 298 extern int symbol_read_needs_frame (struct symbol *);
 299
 300 extern struct value *read_var_value (struct symbol *var,
 301                                      struct frame_info *frame);
 302
 303 extern struct value *locate_var_value (struct symbol *var,
 304                                        struct frame_info *frame);
 305
 306 extern struct value *allocate_value (struct type *type);
 307
 308 extern struct value *allocate_repeat_value (struct type *type, int count);
 309
 310 extern struct value *value_change_enclosing_type (struct value *val,
 311                                                   struct type *new_type);
 312
 313 extern struct value *value_mark (void);
 314
 315 extern void value_free_to_mark (struct value *mark);
 316
 317 extern struct value *value_string (char *ptr, int len);
 318 extern struct value *value_bitstring (char *ptr, int len);
 319
 320 extern struct value *value_array (int lowbound, int highbound,
 321                                   struct value ** elemvec);
 322
 323 extern struct value *value_concat (struct value *arg1, struct value *arg2);
 324
 325 extern struct value *value_binop (struct value *arg1, struct value *arg2,
 326                                   enum exp_opcode op);
 327
 328 extern struct value *value_add (struct value *arg1, struct value *arg2);
 329
 330 extern struct value *value_sub (struct value *arg1, struct value *arg2);
 331
 332 extern struct value *value_coerce_array (struct value *arg1);
 333
 334 extern struct value *value_coerce_function (struct value *arg1);
 335
 336 extern struct value *value_ind (struct value *arg1);
 337
 338 extern struct value *value_addr (struct value *arg1);
 339
 340 extern struct value *value_assign (struct value *toval, struct value *fromval);
 341
 342 extern struct value *value_neg (struct value *arg1);
 343
 344 extern struct value *value_complement (struct value *arg1);
 345
 346 extern struct value *value_struct_elt (struct value **argp,
 347                                        struct value **args,
 348                                        char *name, int *static_memfuncp,
 349                                        char *err);
 350
 351 extern struct value *value_aggregate_elt (struct type *curtype,
 352                                           char *name,
 353                                           enum noside noside);
 354
 355 extern struct value *value_static_field (struct type *type, int fieldno);
 356
 357 extern struct fn_field *value_find_oload_method_list (struct value **, char *,
 358                                                       int, int *,
 359                                                       struct type **, int *);
 360
 361 extern int find_overload_match (struct type **arg_types, int nargs,
 362                                 char *name, int method, int lax,
 363                                 struct value **objp, struct symbol *fsym,
 364                                 struct value **valp, struct symbol **symp,
 365                                 int *staticp);
 366
 367 extern struct value *value_field (struct value *arg1, int fieldno);
 368
 369 extern struct value *value_primitive_field (struct value *arg1, int offset,
 370                                             int fieldno,
 371                                             struct type *arg_type);
 372
 373
 374 extern struct type *value_rtti_target_type (struct value *, int *, int *,
 375                                             int *);
 376
 377 extern struct value *value_full_object (struct value *, struct type *, int,
 378                                         int, int);
 379
 380 extern struct value *value_cast (struct type *type, struct value *arg2);
 381
 382 extern struct value *value_zero (struct type *type, enum lval_type lv);
 383
 384 extern struct value *value_repeat (struct value *arg1, int count);
 385
 386 extern struct value *value_subscript (struct value *array, struct value *idx);
 387
 388 extern struct value *register_value_being_returned (struct type *valtype,
 389                                                     struct regcache *retbuf);
 390
 391 extern struct value *value_in (struct value *element, struct value *set);
 392
 393 extern int value_bit_index (struct type *type, char *addr, int index);
 394
 395 extern int using_struct_return (struct type *value_type, int gcc_p);
 396
 397 extern struct value *evaluate_expression (struct expression *exp);
 398
 399 extern struct value *evaluate_type (struct expression *exp);
 400
 401 extern struct value *evaluate_subexp_with_coercion (struct expression *,
 402                                                     int *, enum noside);
 403
 404 extern struct value *parse_and_eval (char *exp);
 405
 406 extern struct value *parse_to_comma_and_eval (char **expp);
 407
 408 extern struct type *parse_and_eval_type (char *p, int length);
 409
 410 extern CORE_ADDR parse_and_eval_address (char *exp);
 411
 412 extern CORE_ADDR parse_and_eval_address_1 (char **expptr);
 413
 414 extern LONGEST parse_and_eval_long (char *exp);
 415
 416 extern struct value *access_value_history (int num);
 417
 418 extern struct value *value_of_internalvar (struct internalvar *var);
 419
 420 extern void set_internalvar (struct internalvar *var, struct value *val);
 421
 422 extern void set_internalvar_component (struct internalvar *var,
 423                                        int offset,
 424                                        int bitpos, int bitsize,
 425                                        struct value *newvalue);
 426
 427 extern struct internalvar *lookup_internalvar (char *name);
 428
 429 extern int value_equal (struct value *arg1, struct value *arg2);
 430
 431 extern int value_less (struct value *arg1, struct value *arg2);
 432
 433 extern int value_logical_not (struct value *arg1);
 434
 435 /* C++ */
 436
 437 extern struct value *value_of_this (int complain);
 438
 439 extern struct value *value_x_binop (struct value *arg1, struct value *arg2,
 440                                     enum exp_opcode op,
 441                                     enum exp_opcode otherop,
 442                                     enum noside noside);
 443
 444 extern struct value *value_x_unop (struct value *arg1, enum exp_opcode op,
 445                                    enum noside noside);
 446
 447 extern struct value *value_fn_field (struct value ** arg1p, struct fn_field *f,
 448                                      int j, struct type *type, int offset);
 449
 450 extern int binop_user_defined_p (enum exp_opcode op, struct value *arg1,
 451                                  struct value *arg2);
 452
 453 extern int unop_user_defined_p (enum exp_opcode op, struct value *arg1);
 454
 455 extern int destructor_name_p (const char *name, const struct type *type);
 456
 457 #define value_free(val) xfree (val)
 458
 459 extern void free_all_values (void);
 460
 461 extern void release_value (struct value *val);
 462
 463 extern int record_latest_value (struct value *val);
 464
 465 extern void modify_field (char *addr, LONGEST fieldval, int bitpos,
 466                           int bitsize);
 467
 468 extern void type_print (struct type * type, char *varstring,
 469                         struct ui_file * stream, int show);
 470
 471 extern char *baseclass_addr (struct type *type, int index, char *valaddr,
 472                              struct value **valuep, int *errp);
 473
 474 extern void print_longest (struct ui_file * stream, int format,
 475                            int use_local, LONGEST val);
 476
 477 extern void print_floating (char *valaddr, struct type * type,
 478                             struct ui_file * stream);
 479
 480 extern int value_print (struct value *val, struct ui_file *stream, int format,
 481                         enum val_prettyprint pretty);
 482
 483 extern void value_print_array_elements (struct value *val,
 484                                         struct ui_file *stream, int format,
 485                                         enum val_prettyprint pretty);
 486
 487 extern struct value *value_release_to_mark (struct value *mark);
 488
 489 extern int val_print (struct type * type, char *valaddr,
 490                       int embedded_offset, CORE_ADDR address,
 491                       struct ui_file * stream, int format,
 492                       int deref_ref, int recurse,
 493                       enum val_prettyprint pretty);
 494
 495 extern int val_print_string (CORE_ADDR addr, int len, int width, struct ui_file *stream);
 496
 497 extern void print_variable_value (struct symbol * var,
 498                                   struct frame_info * frame,
 499                                   struct ui_file *stream);
 500
 501 extern int check_field (struct value *, const char *);
 502
 503 extern void typedef_print (struct type * type, struct symbol * news,
 504                              struct ui_file * stream);
 505
 506 extern char *internalvar_name (struct internalvar *var);
 507
 508 extern void clear_value_history (void);
 509
 510 extern void clear_internalvars (void);
 511
 512 /* From values.c */
 513
 514 extern struct value *value_copy (struct value *);
 515
 516 /* From valops.c */
 517
 518 extern struct value *varying_to_slice (struct value *);
 519
 520 extern struct value *value_slice (struct value *, int, int);
 521
 522 extern struct value *value_literal_complex (struct value *, struct value *,
 523                                             struct type *);
 524
 525 extern void find_rt_vbase_offset (struct type *, struct type *, char *, int,
 526                                   int *, int *);
 527
 528 extern struct value *find_function_in_inferior (const char *);
 529
 530 extern struct value *value_allocate_space_in_inferior (int);
 531
 532 extern struct value *value_of_local (const char *name, int complain);
 533
 534 #endif /* !defined (VALUE_H) */