gdb/value.h

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